summaryrefslogtreecommitdiff
path: root/data/en_us/dataworks-public/2020-05-18
diff options
context:
space:
mode:
authorZhineng Li <[email protected]>2026-02-13 10:54:11 +0800
committerZhineng Li <[email protected]>2026-02-13 10:54:11 +0800
commit7347bac4ab7e136157fc94777e6cf87ef9e08599 (patch)
tree0dec367dac6e152161a6f7cc0dba6ebbef1f34a2 /data/en_us/dataworks-public/2020-05-18
downloadacs-metadata-full-main.tar.gz
acs-metadata-full-main.zip
first commitHEADv1.0.0+20260212main
Diffstat (limited to 'data/en_us/dataworks-public/2020-05-18')
-rw-r--r--data/en_us/dataworks-public/2020-05-18/api-docs.php66744
1 files changed, 66744 insertions, 0 deletions
diff --git a/data/en_us/dataworks-public/2020-05-18/api-docs.php b/data/en_us/dataworks-public/2020-05-18/api-docs.php
new file mode 100644
index 0000000..62f9b7a
--- /dev/null
+++ b/data/en_us/dataworks-public/2020-05-18/api-docs.php
@@ -0,0 +1,66744 @@
+<?php return [
+ 'version' => '1.0',
+ 'info' => [
+ 'style' => 'RPC',
+ 'product' => 'dataworks-public',
+ 'version' => '2020-05-18',
+ ],
+ 'directories' => [
+ [
+ 'id' => 120438,
+ 'title' => 'Tenant',
+ 'type' => 'directory',
+ 'children' => [
+ 'ListCalcEngines',
+ 'CreateDataSource',
+ 'ListDataSources',
+ 'UpdateDataSource',
+ 'DeleteDataSource',
+ 'ListResourceGroups',
+ 'GetProject',
+ 'AddProjectMemberToRole',
+ 'CreateProjectMember',
+ 'DeleteProjectMember',
+ 'ListProjectRoles',
+ 'RemoveProjectMemberFromRole',
+ 'ListProjectMembers',
+ 'ListProjects',
+ 'ListProjectIds',
+ 'CreateProject',
+ 'ChangeResourceManagerResourceGroup',
+ 'ListMeasureData',
+ ],
+ ],
+ [
+ 'id' => 120453,
+ 'title' => 'Metadata',
+ 'type' => 'directory',
+ 'children' => [
+ 'ListTables',
+ 'GetMetaDBInfo',
+ 'GetMetaDBTableList',
+ 'CheckMetaTable',
+ 'CheckMetaPartition',
+ 'SearchMetaTables',
+ 'GetMetaTableBasicInfo',
+ 'GetMetaTableColumn',
+ 'GetMetaTablePartition',
+ 'GetMetaTableOutput',
+ 'GetMetaTableChangeLog',
+ 'GetMetaTableIntroWiki',
+ 'CreateMetaCategory',
+ 'DeleteMetaCategory',
+ 'UpdateMetaCategory',
+ 'GetMetaCategory',
+ 'GetMetaTableListByCategory',
+ 'AddToMetaCategory',
+ 'DeleteFromMetaCategory',
+ 'UpdateMetaTable',
+ 'UpdateMetaTableIntroWiki',
+ 'ListMetaDB',
+ 'UpdateTableModelInfo',
+ 'CreateTableTheme',
+ 'DeleteTableTheme',
+ 'UpdateTableTheme',
+ 'ListTableTheme',
+ 'GetMetaTableThemeLevel',
+ 'CreateTableLevel',
+ 'UpdateTableLevel',
+ 'DeleteTableLevel',
+ 'ListTableLevel',
+ 'UpdateMetaCollection',
+ 'ListMetaCollections',
+ 'ListMetaCollectionEntities',
+ 'DeleteMetaCollection',
+ 'GetMetaCollectionDetail',
+ 'DeleteMetaCollectionEntity',
+ 'AddMetaCollectionEntity',
+ 'CreateMetaCollection',
+ 'ListLineage',
+ 'DeleteLineageRelation',
+ 'RegisterLineageRelation',
+ 'GetMetaTableLineage',
+ 'GetMetaColumnLineage',
+ ],
+ ],
+ [
+ 'id' => 120493,
+ 'title' => 'Data Development',
+ 'type' => 'directory',
+ 'children' => [
+ 'CreateFile',
+ 'CreateUdfFile',
+ 'CreateBusiness',
+ 'DeleteBusiness',
+ 'CreateFolder',
+ 'UpdateBusiness',
+ 'ListFiles',
+ 'EstablishRelationTableToBusiness',
+ 'SubmitFile',
+ 'ListBusiness',
+ 'GetFileVersion',
+ 'DeleteFolder',
+ 'DeleteFile',
+ 'GetDeployment',
+ 'UpdateFile',
+ 'GetFolder',
+ 'ListFileVersions',
+ 'GetFile',
+ 'ListFolders',
+ 'DeployFile',
+ 'UpdateUdfFile',
+ 'GetBusiness',
+ 'UpdateFolder',
+ 'ListDeployments',
+ 'UpdateIDEEventResult',
+ 'GetIDEEventDetail',
+ 'CreateResourceFile',
+ ],
+ ],
+ [
+ 'id' => 120518,
+ 'title' => 'Data Integration',
+ 'type' => 'directory',
+ 'children' => [
+ 'CreateDISyncTask',
+ 'DeleteDISyncTask',
+ 'UpdateDISyncTask',
+ 'TestNetworkConnection',
+ 'GetDataSourceMeta',
+ 'ListDIProjectConfig',
+ 'UpdateDIProjectConfig',
+ 'GetDISyncTask',
+ 'DeployDISyncTask',
+ 'GetDISyncInstanceInfo',
+ 'TerminateDISyncInstance',
+ 'GenerateDISyncTaskConfigForCreating',
+ 'GenerateDISyncTaskConfigForUpdating',
+ 'StartDISyncInstance',
+ 'StopDISyncInstance',
+ 'QueryDISyncTaskConfigProcessResult',
+ 'CreateDIJob',
+ 'DeleteDIJob',
+ 'GetDIJob',
+ 'ListDIJobs',
+ 'StartDIJob',
+ 'StopDIJob',
+ 'UpdateDIJob',
+ 'CreateDIAlarmRule',
+ 'DeleteDIAlarmRule',
+ 'GetDIAlarmRule',
+ 'ListDIAlarmRules',
+ 'UpdateDIAlarmRule',
+ ],
+ ],
+ [
+ 'id' => 191818,
+ 'title' => 'Data Modeling',
+ 'type' => 'directory',
+ 'children' => [
+ 'QueryPublicModelEngine',
+ ],
+ ],
+ [
+ 'id' => 120540,
+ 'title' => 'Operation Center',
+ 'type' => 'directory',
+ 'children' => [
+ 'GetAlertMessage',
+ 'ListAlertMessages',
+ 'GetBaselineConfig',
+ 'ListNodesByBaseline',
+ 'ListBaselineConfigs',
+ 'GetBaselineKeyPath',
+ 'GetBaselineStatus',
+ 'ListBaselineStatuses',
+ 'DeleteRemind',
+ 'UpdateRemind',
+ 'CreateRemind',
+ 'GetRemind',
+ 'ListReminds',
+ 'ListTopics',
+ 'GetTopic',
+ 'GetTopicInfluence',
+ 'GetNode',
+ 'ListNodeInputOrOutput',
+ 'ListNodes',
+ 'GetNodeCode',
+ 'GetInstance',
+ 'ListInstances',
+ 'GetInstanceLog',
+ 'StopInstance',
+ 'RestartInstance',
+ 'SetSuccessInstance',
+ 'SuspendInstance',
+ 'ResumeInstance',
+ 'RunCycleDagNodes',
+ 'RunSmokeTest',
+ 'ListSuccessInstanceAmount',
+ 'ListInstanceAmount',
+ 'TopTenElapsedTimeInstance',
+ 'TopTenErrorTimesInstance',
+ 'GetFileTypeStatistic',
+ 'GetInstanceStatusStatistic',
+ 'ListFileType',
+ 'RunManualDagNodes',
+ 'ListManualDagInstances',
+ 'GetDag',
+ 'ListDags',
+ 'ListNodesByOutput',
+ 'RunTriggerNode',
+ 'GetNodeParents',
+ 'GetNodeChildren',
+ 'UpdateNodeRunMode',
+ 'UpdateNodeOwner',
+ 'UpdateWorkbenchEventResult',
+ 'ListShiftPersonnels',
+ 'ListShiftSchedules',
+ 'ListInstanceHistory',
+ 'ListInnerNodes',
+ 'OfflineNode',
+ 'GetBaseline',
+ 'DeleteBaseline',
+ 'ListBaselines',
+ 'CreateBaseline',
+ 'UpdateBaseline',
+ ],
+ ],
+ [
+ 'id' => 120587,
+ 'title' => 'Data Quality',
+ 'type' => 'directory',
+ 'children' => [
+ 'UpdateQualityFollower',
+ 'UpdateQualityRule',
+ 'GetQualityRule',
+ 'ListQualityRules',
+ 'CreateQualityRule',
+ 'DeleteQualityFollower',
+ 'DeleteQualityRule',
+ 'GetQualityFollower',
+ 'CreateQualityFollower',
+ 'DeleteQualityEntity',
+ 'GetQualityEntity',
+ 'CreateQualityEntity',
+ 'CreateQualityRelativeNode',
+ 'DeleteQualityRelativeNode',
+ 'ListQualityResultsByEntity',
+ 'ListQualityResultsByRule',
+ ],
+ ],
+ [
+ 'id' => 120604,
+ 'title' => 'DataService Studio',
+ 'type' => 'directory',
+ 'children' => [
+ 'CreateDataServiceApi',
+ 'PublishDataServiceApi',
+ 'DeleteDataServiceApi',
+ 'ListDataServiceApis',
+ 'GetDataServiceApi',
+ 'UpdateDataServiceApi',
+ 'GetDataServicePublishedApi',
+ 'ListDataServicePublishedApis',
+ 'ListDataServiceApiAuthorities',
+ 'ListDataServiceAuthorizedApis',
+ 'AbolishDataServiceApi',
+ 'GetDataServiceApplication',
+ 'ListDataServiceApplications',
+ 'CreateDataServiceFolder',
+ 'GetDataServiceFolder',
+ 'ListDataServiceFolders',
+ 'CreateDataServiceGroup',
+ 'GetDataServiceGroup',
+ 'ListDataServiceGroups',
+ 'CreateDataServiceApiAuthority',
+ 'DeleteDataServiceApiAuthority',
+ 'ListDataServiceApiTest',
+ 'TestDataServiceApi',
+ 'GetDataServiceApiTest',
+ 'SubmitDataServiceApi',
+ 'SaveDataServiceApiTestResult',
+ ],
+ ],
+ [
+ 'id' => 191820,
+ 'title' => 'Data Security Guard',
+ 'type' => 'directory',
+ 'children' => [
+ 'GetOpSensitiveData',
+ 'DesensitizeData',
+ 'GetOpRiskData',
+ 'GetSensitiveData',
+ 'ScanSensitiveData',
+ 'DsgQuerySensResult',
+ 'QueryDefaultTemplate',
+ 'DsgStopSensIdentify',
+ 'QuerySensClassification',
+ 'QuerySensLevel',
+ 'QueryRecognizeRulesType',
+ 'DsgRunSensIdentify',
+ 'DeleteRecognizeRule',
+ 'QuerySensNodeInfo',
+ 'AddRecognizeRule',
+ 'EditRecognizeRule',
+ 'QueryRecognizeDataByRuleType',
+ 'QueryRecognizeRuleDetail',
+ 'DsgUserGroupGetOdpsRoleGroups',
+ 'DsgDesensPlanAddOrUpdate',
+ 'DsgPlatformQueryProjectsAndSchemaFromMeta',
+ 'DsgUserGroupDelete',
+ 'DsgWhiteListDeleteList',
+ 'DsgScenedDeleteScene',
+ 'DsgDesensPlanDelete',
+ 'DsgDesensPlanUpdateStatus',
+ 'DsgWhiteListQueryList',
+ 'DsgSceneAddOrUpdateScene',
+ 'DsgSceneQuerySceneListByName',
+ 'DsgUserGroupAddOrUpdate',
+ 'DsgUserGroupQueryList',
+ 'DsgUserGroupQueryUserList',
+ 'DsgDesensPlanQueryList',
+ 'DsgWhiteListAddOrUpdate',
+ 'DsgQueryDefaultTemplates',
+ ],
+ ],
+ [
+ 'id' => 166717,
+ 'title' => 'Migration Assistant',
+ 'type' => 'directory',
+ 'children' => [
+ 'CreateImportMigration',
+ 'GetMigrationProcess',
+ 'StartMigration',
+ 'CreateExportMigration',
+ 'GetMigrationSummary',
+ 'ListMigrations',
+ ],
+ ],
+ [
+ 'id' => 191821,
+ 'title' => 'Security Center',
+ 'type' => 'directory',
+ 'children' => [
+ 'CreatePermissionApplyOrder',
+ 'GetPermissionApplyOrderDetail',
+ 'ListPermissionApplyOrders',
+ 'ApprovePermissionApplyOrder',
+ 'RevokeTablePermission',
+ 'RevokeTablePermission',
+ ],
+ ],
+ [
+ 'id' => 166724,
+ 'title' => 'Open platform',
+ 'type' => 'directory',
+ 'children' => [
+ 'ListExtensions',
+ 'GetExtension',
+ 'GetOptionValueForProject',
+ 'ListEnabledExtensionsForProject',
+ 'CallbackExtension',
+ 'ListCheckProcesses',
+ 'ListCheckProcesses',
+ ],
+ ],
+ [
+ 'id' => 191836,
+ 'title' => 'Others',
+ 'type' => 'directory',
+ 'children' => [
+ 'UpdateTableAddColumn',
+ 'GetMetaTableFullInfo',
+ 'GetDDLJobStatus',
+ 'DeleteTable',
+ 'UpdateTable',
+ 'CreateTable',
+ 'CheckFileDeployment',
+ 'ListRefDISyncTasks',
+ 'ExportDataSources',
+ 'ImportDataSources',
+ 'UpdateClusterConfigs',
+ 'ListClusterConfigs',
+ 'ListClusters',
+ ],
+ ],
+ [
+ 'id' => 120626,
+ 'title' => 'Abandoned API',
+ 'type' => 'directory',
+ 'children' => [
+ 'ListEntitiesByTags',
+ 'RemoveEntityTags',
+ 'SetEntityTags',
+ 'ListEntityTags',
+ 'SetDataSourceShare',
+ 'CreateConnection',
+ 'CreateDagComplement',
+ 'CreateDagTest',
+ 'CreateManualDag',
+ 'DeleteConnection',
+ 'UpdateConnection',
+ 'ListConnections',
+ 'GetProjectDetail',
+ 'ListNodeIO',
+ 'GetInstanceStatusCount',
+ 'ListProgramTypeCount',
+ 'GetManualDagInstances',
+ 'SearchNodesByOutput',
+ 'GetNodeTypeListInfo',
+ 'GetNodeOnBaseline',
+ 'GetSuccessInstanceTrend',
+ 'GetInstanceCountTrend',
+ 'GetInstanceConsumeTimeRank',
+ 'GetInstanceErrorRank',
+ ],
+ ],
+ ],
+ 'components' => [
+ 'schemas' => [
+ 'Cluster' => [
+ 'title' => 'Cluster Information',
+ 'description' => 'The information about the cluster associated with DataWorks.'."\n",
+ 'visibility' => 'Public',
+ 'type' => 'object',
+ 'properties' => [
+ 'ClusterId' => [
+ 'title' => 'Cluster ID Generated by DataWorks',
+ 'description' => 'The ID of the cluster associated with DataWorks.'."\n",
+ 'visibility' => 'Public',
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => true,
+ 'example' => '1234',
+ 'backendName' => 'id',
+ ],
+ 'ClusterBizId' => [
+ 'title' => 'Cluster Business Identifier',
+ 'description' => 'The unique business identifier of the cluster.'."\n",
+ 'visibility' => 'Public',
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => 'c-d8a7523****',
+ 'backendName' => 'clusterIdentifier',
+ ],
+ ],
+ ],
+ 'ClusterConfig' => [
+ 'title' => 'Cluster config',
+ 'description' => 'The configuration information of the cluster.'."\n",
+ 'visibility' => 'Public',
+ 'type' => 'object',
+ 'properties' => [
+ 'ModuleName' => [
+ 'title' => 'DataWorks module name',
+ 'description' => 'The module in which the cluster is configured. Valid values:'."\n"
+ ."\n"
+ .'* ide: DataStudio.'."\n"
+ .'* da: DataAnalysis.'."\n"
+ .'* scheduler.auto: Operation Center - auto triggered instances.'."\n"
+ .'* scheduler.backfill: Operation Center - data backfill instances.'."\n"
+ .'* scheduler.test: Operation Center - test instances.'."\n"
+ .'* scheduler.manual: Operation Center - manually triggered instances.',
+ 'visibility' => 'Public',
+ 'type' => 'string',
+ 'enumValueTitles' => [],
+ 'example' => 'ide',
+ 'backendName' => 'module',
+ ],
+ 'ConfigValue' => [
+ 'title' => 'Config value',
+ 'description' => 'The configuration value.'."\n",
+ 'visibility' => 'Public',
+ 'type' => 'string',
+ 'example' => '{"spark.driver.memory":"1g"}',
+ 'backendName' => 'value',
+ ],
+ 'EnableOverwrite' => [
+ 'title' => 'Whether to overwrite node config',
+ 'description' => 'Specifies whether to overwrite the advanced settings of nodes in DataStudio. Valid values:'."\n"
+ ."\n"
+ .'* true'."\n"
+ .'* false'."\n",
+ 'visibility' => 'Public',
+ 'type' => 'boolean',
+ 'enumValueTitles' => [],
+ 'example' => 'false',
+ 'backendName' => 'enableOverwrite',
+ ],
+ ],
+ ],
+ 'Collection' => [
+ 'title' => 'Definition of Collection',
+ 'description' => 'The collection definition.'."\n",
+ 'visibility' => 'public',
+ 'type' => 'object',
+ 'properties' => [
+ 'QualifiedName' => [
+ 'title' => 'Unique identifier of identity',
+ 'description' => 'The unique identifier of the collection.'."\n",
+ 'visibility' => 'public',
+ 'type' => 'string',
+ 'example' => 'album.12334',
+ 'backendName' => 'qualifiedName',
+ ],
+ 'CollectionType' => [
+ 'title' => 'Collection Type',
+ 'description' => 'The type of the collection. Valid values:'."\n"
+ ."\n"
+ .'* **ALBUM**: data album'."\n"
+ .'* **ALBUM_CATEGORY**: category in a data album'."\n",
+ 'visibility' => 'public',
+ 'type' => 'string',
+ 'example' => 'album',
+ 'backendName' => 'collectionType',
+ ],
+ 'Name' => [
+ 'title' => 'The name of the collection',
+ 'description' => 'The name of the collection.'."\n",
+ 'visibility' => 'public',
+ 'type' => 'string',
+ 'example' => 'collectionName',
+ 'backendName' => 'name',
+ ],
+ 'Comment' => [
+ 'title' => 'The comment of the collection',
+ 'description' => 'The remarks.'."\n",
+ 'visibility' => 'public',
+ 'type' => 'string',
+ 'example' => 'comment',
+ 'backendName' => 'comment',
+ ],
+ 'OwnerId' => [
+ 'title' => 'The ownerId of the collection',
+ 'description' => 'The ID of the Alibaba Cloud account that is used by the collection owner.'."\n",
+ 'visibility' => 'public',
+ 'type' => 'string',
+ 'example' => '1234444',
+ 'backendName' => 'ownerId',
+ ],
+ 'OwnerName' => [
+ 'title' => 'The name of the collection owner',
+ 'description' => 'The name of the collection owner.'."\n",
+ 'visibility' => 'public',
+ 'type' => 'string',
+ 'example' => 'owner',
+ 'backendName' => 'ownerName',
+ ],
+ 'CreateTime' => [
+ 'title' => 'The create timestamp of the collection',
+ 'description' => 'The creation time.'."\n",
+ 'visibility' => 'public',
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '1668600147617',
+ 'backendName' => 'createTime',
+ ],
+ 'UpdateTime' => [
+ 'title' => 'The update timestamp of the collection',
+ 'description' => 'The update time.'."\n",
+ 'visibility' => 'public',
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '1668600148617',
+ 'backendName' => 'updateTime',
+ ],
+ 'Level' => [
+ 'title' => 'The level of the collection',
+ 'description' => 'The level of the collection. This parameter takes effect only if the CollectionType parameter is set to ALBUM_CATEGORY. Maximum value: 4.'."\n",
+ 'visibility' => 'public',
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '1',
+ 'backendName' => 'level',
+ ],
+ ],
+ ],
+ 'Entity' => [
+ 'title' => 'Definition of Entity',
+ 'description' => 'The entity definition.'."\n",
+ 'visibility' => 'public',
+ 'type' => 'object',
+ 'properties' => [
+ 'QualifiedName' => [
+ 'title' => 'Unique identifier of identity',
+ 'description' => 'The unique identifier of the entity. Example: maxcompute-table.projectA.tableB.'."\n",
+ 'visibility' => 'public',
+ 'type' => 'string',
+ 'example' => 'maxcompute_table.563f0357118d05ef145d6bddf2966cc23e86ca8f2f013f915e565afdf09f7a23',
+ 'backendName' => 'qualifiedName',
+ ],
+ 'TenantId' => [
+ 'title' => 'Identifier of tenant',
+ 'description' => 'The tenant ID.'."\n",
+ 'visibility' => 'public',
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '12345',
+ 'backendName' => 'tenantId',
+ ],
+ 'EntityContent' => [
+ 'title' => 'Attribute map',
+ 'description' => 'The properties of the entity, including:'."\n"
+ ."\n"
+ .'* **entityType**: The type of the entity. Examples: maxcompute-table and emr-table.'."\n"
+ .'* **name**: the name of the entity.'."\n"
+ .'* **projectName**: the name of the MaxCompute project.'."\n",
+ 'visibility' => 'public',
+ 'type' => 'object',
+ 'backendName' => 'entityContent',
+ ],
+ ],
+ ],
+ 'LineageEntityVO' => [
+ 'title' => 'Definition of entity in lineage',
+ 'description' => '',
+ 'visibility' => 'public',
+ 'type' => 'object',
+ 'properties' => [
+ 'QualifiedName' => [
+ 'title' => 'Unique identifier of entity',
+ 'description' => 'Unique identifier of entity',
+ 'visibility' => 'public',
+ 'type' => 'string',
+ 'example' => 'maxcompute-table.projectName.tablename',
+ 'backendName' => 'qualifiedName',
+ ],
+ 'Name' => [
+ 'title' => 'Name of entity',
+ 'description' => 'Name of entity',
+ 'visibility' => 'public',
+ 'type' => 'string',
+ 'example' => 'tableName',
+ 'backendName' => 'name',
+ ],
+ 'ParentName' => [
+ 'title' => 'Parent name of entity',
+ 'description' => 'Parent name of entity',
+ 'visibility' => 'public',
+ 'type' => 'string',
+ 'example' => 'dbName',
+ 'backendName' => 'parentName',
+ ],
+ 'DetailUrl' => [
+ 'title' => 'Detail url of entity',
+ 'description' => 'Detail url of entity',
+ 'visibility' => 'public',
+ 'type' => 'string',
+ 'example' => 'http://domain.test.url/entity',
+ 'backendName' => 'detailUrl',
+ ],
+ ],
+ ],
+ 'LineageRelationRegisterVO' => [
+ 'title' => 'Lineage relation register struct',
+ 'description' => '',
+ 'visibility' => 'public',
+ 'type' => 'object',
+ 'properties' => [
+ 'SrcEntity' => [
+ 'title' => 'The source entity in lineage relation',
+ 'description' => 'The source entity in lineage relation',
+ 'visibility' => 'public',
+ 'backendName' => 'srcEntity',
+ '$ref' => '#/components/schemas/LineageEntityVO',
+ ],
+ 'DestEntity' => [
+ 'title' => 'The destination entity in lineage relation',
+ 'description' => 'The destination entity in lineage relation',
+ 'visibility' => 'public',
+ 'backendName' => 'destEntity',
+ '$ref' => '#/components/schemas/LineageEntityVO',
+ ],
+ 'Relationship' => [
+ 'title' => 'The relationship between entities',
+ 'description' => 'The relationship between entities',
+ 'visibility' => 'public',
+ 'backendName' => 'relationship',
+ '$ref' => '#/components/schemas/RelationshipVO',
+ ],
+ 'CreateTimestamp' => [
+ 'title' => 'The time of lineage relation generation',
+ 'description' => 'The time of lineage relation generation',
+ 'visibility' => 'public',
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '1684327487964',
+ 'backendName' => 'createTimestamp',
+ ],
+ ],
+ ],
+ 'RelationshipVO' => [
+ 'title' => 'relationship info',
+ 'description' => '',
+ 'visibility' => 'public',
+ 'type' => 'object',
+ 'properties' => [
+ 'Type' => [
+ 'title' => 'Type name of relationship',
+ 'description' => 'Type name of relationship',
+ 'visibility' => 'public',
+ 'type' => 'string',
+ 'example' => 'sql',
+ 'backendName' => 'type',
+ ],
+ ],
+ ],
+ 'UserEntityTag' => [
+ 'title' => '',
+ 'description' => 'The tags.',
+ 'visibility' => 'public',
+ 'type' => 'object',
+ 'properties' => [
+ 'TagKey' => [
+ 'title' => '',
+ 'description' => 'The tag key.',
+ 'visibility' => 'public',
+ 'type' => 'string',
+ 'example' => 'priority',
+ 'backendName' => 'tagKey',
+ ],
+ 'TagValue' => [
+ 'title' => '',
+ 'description' => 'The tag value.',
+ 'visibility' => 'public',
+ 'type' => 'string',
+ 'example' => 'p1',
+ 'backendName' => 'tagValue',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'apis' => [
+ 'ListCalcEngines' => [
+ 'methods' => [
+ 'post',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'get',
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'ProjectId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the DataWorks workspace with which the compute engine is associated.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => '27',
+ ],
+ ],
+ [
+ 'name' => 'Name',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The name of the compute engine, which must be exactly matched.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'docRequired' => false,
+ 'example' => 'abc',
+ ],
+ ],
+ [
+ 'name' => 'CalcEngineType',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The type of the compute engine. The value of this parameter is not case-sensitive. Valid values:'."\n"
+ ."\n"
+ .'* **ODPS**'."\n"
+ .'* **EMR**'."\n"
+ .'* **BLINK**'."\n"
+ .'* **HOLO**'."\n"
+ .'* **MaxGraph**'."\n"
+ .'* **HYBRIDDB_FOR_POSTGRESQL**'."\n"
+ .'* **ADB_MYSQL**'."\n"
+ .'* **HADOOP_CDH**'."\n"
+ .'* **CLICKHOUSE**'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'ODPS',
+ ],
+ ],
+ [
+ 'name' => 'EnvType',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The environment in which the compute engine is used. Valid values:'."\n"
+ ."\n"
+ .'* **DEV**'."\n"
+ .'* **PRD**'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'PRD',
+ ],
+ ],
+ [
+ 'name' => 'PageSize',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The number of entries per page. Default value: 10. Maximum value: 100.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => false,
+ 'example' => '10',
+ ],
+ ],
+ [
+ 'name' => 'PageNumber',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The page number. Pages start from page 1. Default value: 1.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => false,
+ 'example' => '1',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'description' => 'The response parameters.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'HttpStatusCode' => [
+ 'description' => 'The HTTP status code.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '200',
+ ],
+ 'RequestId' => [
+ 'description' => 'The request ID.'."\n",
+ 'type' => 'string',
+ 'example' => '0bc1ec92159376****',
+ ],
+ 'Success' => [
+ 'description' => 'Indicates whether the request was successful. Valid values:'."\n"
+ ."\n"
+ .'* **true**'."\n"
+ .'* **false**'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'Data' => [
+ 'description' => 'The query results for compute engines that are returned on multiple pages.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'PageNumber' => [
+ 'description' => 'The page number of the returned page.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '1',
+ ],
+ 'PageSize' => [
+ 'description' => 'The number of entries per page.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '20',
+ ],
+ 'TotalCount' => [
+ 'description' => 'The total number of compute engine instances.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '1',
+ ],
+ 'CalcEngines' => [
+ 'description' => 'The compute engines.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The returned data.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'BindingProjectName' => [
+ 'description' => 'The name of the workspace with which the compute engine is associated.'."\n",
+ 'type' => 'string',
+ 'example' => 'abc',
+ ],
+ 'IsDefault' => [
+ 'description' => 'Indicates whether the compute engine is the default engine of the current type.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'EngineId' => [
+ 'description' => 'The compute engine ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '35',
+ ],
+ 'DwRegion' => [
+ 'description' => 'The region where the DataWorks workspace with which the compute engine is associated resides.'."\n",
+ 'type' => 'string',
+ 'example' => 'cn-zhangjiakou',
+ ],
+ 'TaskAuthType' => [
+ 'description' => 'The identity that is used to access the compute engine. Valid values:'."\n"
+ ."\n"
+ .'* **USER**: the current user'."\n"
+ .'* **PROJECT**: the workspace executor'."\n"
+ .'* **SUBACCOUNT**: a RAM user'."\n"
+ .'* **STS_ROLE**: the Security Token Service (STS) role'."\n",
+ 'type' => 'string',
+ 'example' => 'PROJECT',
+ ],
+ 'CalcEngineType' => [
+ 'description' => 'The type of the compute engine.'."\n",
+ 'type' => 'string',
+ 'example' => 'ODPS',
+ ],
+ 'EngineInfo' => [
+ 'description' => 'The details of the compute engine.'."\n"
+ ."\n"
+ .'* ODPS'."\n"
+ ."\n"
+ .' {'."\n"
+ .' "pubEndpoint": "service.cn.maxcompute.aliyun.com/api",'."\n"
+ .' "endpoint": "service.cn.maxcompute.aliyun-inc.com/api",'."\n"
+ .' "initProperties": " '."\n"
+ .' {\\"odpsTypeMode\\":\\"STANDARD\\",\\"openPai\\":false,\\"openPaiGpu\\":false}",'."\n"
+ .' "resourceGroupType": "ODPS",'."\n"
+ .' "resourceGroupId": "361826516****",'."\n"
+ .' "vpcEndpoint": "service.cn.maxcompute.aliyun-inc.com/api",'."\n"
+ .' "projectName": "onefall_test_zjk",'."\n"
+ .' "taskSameAsOwner": "true"'."\n"
+ .' }'."\n"
+ ."\n"
+ .'* EMR'."\n"
+ ."\n"
+ .' {'."\n"
+ .' "emrClusterId": "C-xxx",'."\n"
+ .' "specs": "{\\"emrClusterId\\":\\"C-xxx\\",\\"emrAccessMode\\":\\"simple\\",\\"emrResourceQueueName\\":\\"default\\",\\"emrProjectId\\":\\"FP-xxx\\"}",'."\n"
+ .' "endpoint": "emr.aliyuncs.com",'."\n"
+ .' "emrResourceQueueName": "default",'."\n"
+ .' "emrAccessMode": "simple",'."\n"
+ .' "resourceGroupType": "DW",'."\n"
+ .' "projectName": "xx-xxxx",'."\n"
+ .' "emrProjectId": "FP-xxxx",'."\n"
+ .' "taskSameAsOwner": "false"'."\n"
+ .' } '."\n"
+ ."\n"
+ .'* BLINK'."\n"
+ ."\n"
+ .' {'."\n"
+ .' "bayesProjectId": "xxxx",'."\n"
+ .' "bayesProjectName": "xc_blxxixxxnk_1",'."\n"
+ .' "cluster": "xxxssxsx",'."\n"
+ .' "endpoint": "https://stream.console.aliyun.com",'."\n"
+ .' "engineType": "BLINK",'."\n"
+ .' "name": "xsxsxxxxx",'."\n"
+ .' "projectName": "xc_blxxxsxink_1",'."\n"
+ .' "queue": "root.xc_blxsxxxxxxink_1",'."\n"
+ .' "resourceGroupType": "DW",'."\n"
+ .' "specs": "{\\"cluster\\":\\"xxxxxx\\",\\"bayesProjectName\\":\\"xc_blxxixxxnk_1\\",\\"bayesProjectId\\":\\"ssxxxsa\\",\\"name\\":\\"sxsxsxxx\\",\\"queue\\":\\"root.sxxsxxsx\\"}",'."\n"
+ .' "taskSameAsOwner": false'."\n"
+ .' }'."\n"
+ ."\n"
+ .'* HOLO'."\n"
+ ."\n"
+ .' {'."\n"
+ .' "endpoint": "hgprecn-cn-xsxssxsx-cn-shanghai-internal.hologres.aliyuncs.com:80",'."\n"
+ .' "engineType": "ODPS",'."\n"
+ .' "odpsEndpoint": "hgprecn-cn-xsxssxxs-cn-shanghai-internal.hologres.aliyuncs.com:80",'."\n"
+ .' "odpsProjectName": "xsxssxsxsx",'."\n"
+ .' "projectName": "xsxssxsxsx",'."\n"
+ .' "resourceGroupType": "DW",'."\n"
+ .' "specs": "{\\"pubEndpoint\\":\\"hgprecn-cn-xsxssxsxs-cn-shanghai.hologres.aliyuncs.com:80\\",\\"commonBuyInstanceId\\":\\"hgprecn-cn-xsxsxsxs\\",\\"project\\":\\"holo_upxsxgrade1\\",\\"common_buy_instance_id\\":\\"hgprecn-cn-xsxsxs\\",\\"endpoint\\":\\"hgprecn-cn-xsxxsxs-cn-shanghai-internal.hologres.aliyuncs.com:80\\",\\"port\\":\\"80\\",\\"host\\":\\"hgprecn-cn-xsxsxsxs-cn-shanghai-internal.hologres.aliyuncs.com\\",\\"vpcEndpoint\\":\\"hgprecn-cn-xsxsxsxs-cn-shanghai-vpc.hologres.aliyuncs.com:80\\",\\"authType\\":2,\\"region\\":\\"cn-shanghai\\"}",'."\n"
+ .' "taskSameAsOwner": false'."\n"
+ .' }'."\n"
+ ."\n"
+ .'* MaxGraph'."\n"
+ ."\n"
+ .' {'."\n"
+ .' "endpoint": "http://pre-graphcompute.aliyuncs.com",'."\n"
+ .' "engineType": "ODPS",'."\n"
+ .' "odpsEndpoint": "http://pre-graphcompute.aliyuncs.com",'."\n"
+ .' "odpsProjectName": "xsxsxsxs",'."\n"
+ .' "projectName": "xsxsxsxs",'."\n"
+ .' "resourceGroupType": "DW",'."\n"
+ .' "taskSameAsOwner": false'."\n"
+ .' }'."\n"
+ ."\n"
+ .'* HYBRIDDB_FOR_POSTGRESQL'."\n"
+ ."\n"
+ .' {'."\n"
+ .' "endpoint": "hybriddb_for_postgresql_mo12121ck_endpoint",'."\n"
+ .' "engineType": "ODPS",'."\n"
+ .' "odpsEndpoint": "hybriddb_for_postgresql_m121212ock_endpoint",'."\n"
+ .' "odpsProjectName": "sxasaxsaxaxas",'."\n"
+ .' "projectName": "sxasaxsaxaxas",'."\n"
+ .' "resourceGroupType": "DW",'."\n"
+ .' "specs": "{\\"connectionString\\":\\"gp-xsxsxsxxs.gpdb.rds.aliyuncs.com\\",\\"database\\":\\"xsxsxxsxs\\",\\"password\\":\\"xxxxxxx\\",\\"instanceId\\":\\"gp-cdcdacdacda\\",\\"port\\":\\"3432\\",\\"ownerId\\":\\"12121212\\",\\"username\\":\\"sdasaddsa\\"}",'."\n"
+ .' "taskSameAsOwner": false'."\n"
+ .' }'."\n"
+ ."\n"
+ .'* ADB_MYSQL'."\n"
+ ."\n"
+ .' {'."\n"
+ .' "endpoint": "adb_mysql_mock_endpoint",'."\n"
+ .' "engineType": "ODPS",'."\n"
+ .' "odpsEndpoint": "adb_mysql_mock_endpoint",'."\n"
+ .' "odpsProjectName": "am-xsaxaxa",'."\n"
+ .' "projectName": "am-xsxsaxa",'."\n"
+ .' "resourceGroupType": "DW",'."\n"
+ .' "specs": "{\\"connectionString\\":\\"am-xsaxsa.ads.aliyuncs.com:3306\\",\\"database\\":\\"xsaxsaxa\\",\\"password\\":\\"xsaxsaxassxsa\\",\\"instanceId\\":\\"am-xsaxsasx\\",\\"username\\":\\"xsaxsadsd\\"}",'."\n"
+ .' "taskSameAsOwner": false'."\n"
+ .' }'."\n"
+ ."\n"
+ .'* HADOOP_CDH'."\n"
+ ."\n"
+ .' {'."\n"
+ .' "bindingBaseId": "xsaxsaxs",'."\n"
+ .' "endpoint": "xsaaaaa",'."\n"
+ .' "engineType": "ODPS",'."\n"
+ .' "odpsEndpoint": "axsxaxssxs",'."\n"
+ .' "odpsProjectName": "ssxxax",'."\n"
+ .' "projectName": "xsaxsaxsa",'."\n"
+ .' "resourceGroupId": 45208xxxxxx,'."\n"
+ .' "resourceGroupType": "GATEWAY",'."\n"
+ .' "specs": "{\\"cluster\\":{\\"hive\\":{\\"hiveServer2Url\\":\\"jdbc:hive2://xxxxxxer-1-cn-shanghai-pre-kerberos-1:10000\\",\\"hiveMetastore\\":\\"thrift://xxxxxxxr-1-cn-shanghai-pre-kerberos-1:9083\\",\\"version\\":\\"2.1.1\\"},\\"configFiles\\":{\\"coreSite\\":\\"4534574xxxxxx\\",\\"hdfsSite\\":\\"453457919xxxxxxx\\",\\"mapredSite\\":\\"45345750xxxxxx\\",\\"yarnSite\\":\\"4534575xxxxx\\",\\"krb5Conf\\":\\"4534576xxxxx1\\",\\"hiveSite\\":\\"453457xxxxx20\\"},\\"spark\\":{\\"version\\":\\"2.4.0\\"},\\"cdh\\":{\\"version\\":\\"6.3.2\\"},\\"hdfs\\":{\\"version\\":\\"3.0.0\\"},\\"impala\\":{\\"impalaUrl\\":\\"jdbc:impala://cdh-xsxssxxsx-1-cn-shanghai-pre-kerberos-1:21050\\",\\"version\\":\\"3.2.0\\"},\\"yarn\\":{\\"YarnUrl\\":\\"http://cdh-xsxsxsxsxs-1-cn-shanghai-pre-kerberos-1:8032\\",\\"webUrl\\":\\"http://cdh-xsxsxssxxssx-1-cn-shanghai-pre-kerberos-1:8088\\",\\"version\\":\\"3.0.0\\"},\\"presto\\":{\\"prestoUrl\\":\\"jdbc:presto://cdh-xssxsxxsxsxs-1-cn-shanghai-pre-kerberos-1:8080/hive/default\\",\\"version\\":\\"0.244.1\\"}},\\"instanceId\\":161sdads733,\\"authDetail\\":{\\"principal\\":\\"[email protected]\\",\\"keytabFileId\\":\\"45345815xsxsxs3\\",\\"type\\":\\"kerberos\\",\\"username\\":\\"[email protected]\\"},\\"resGroupStatus\\":\\"\\",\\"hadoopAuthType\\":\\"kerberos\\",\\"clusterIdentifier\\":\\"xssxsxsxsx\\",\\"clusterId\\":xsxsx,\\"resGroupId\\":4520870619xsxssxxs,\\"accessMode\\":\\"security\\",\\"authType\\":2}",'."\n"
+ .' "taskSameAsOwner": false'."\n"
+ .' }'."\n",
+ 'type' => 'object',
+ 'example' => '{"pubEndpoint":"http://service.cn.maxcompute.aliyun.com/api","endpoint":"http://service.cn.maxcompute.aliyun-inc.com/api","resourceGroupType":"ODPS","resourceGroupId":"361826516****","vpcEndpoint":"http://service.cn.maxcompute.aliyun-inc.com/api","projectName":"onefall_test_zjk","taskSameAsOwner":"true"}',
+ ],
+ 'EnvType' => [
+ 'description' => 'The environment in which the compute engine is used. Valid values:'."\n"
+ ."\n"
+ .'* **DEV**'."\n"
+ .'* **PRD**'."\n",
+ 'type' => 'string',
+ 'example' => 'PRD',
+ ],
+ 'Region' => [
+ 'description' => 'The region where the compute engine resides.'."\n",
+ 'type' => 'string',
+ 'example' => 'cn-zhangjiakou',
+ ],
+ 'GmtCreate' => [
+ 'description' => 'The time when the compute engine was created.'."\n",
+ 'type' => 'string',
+ 'example' => 'Oct 10, 2019 3:42:44 PM',
+ ],
+ 'BindingProjectId' => [
+ 'description' => 'The ID of the workspace with which the compute engine is associated.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '27',
+ ],
+ 'Name' => [
+ 'description' => 'The display name of the compute engine.'."\n",
+ 'type' => 'string',
+ 'example' => 'abc',
+ ],
+ 'TenantId' => [
+ 'description' => 'The tenant ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '1234567',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'errorCodes' => [
+ 400 => [
+ [
+ 'errorCode' => 'Invalid.Tenant.ConnectionNotExists',
+ 'errorMessage' => 'The connection does not exist.',
+ ],
+ [
+ 'errorCode' => 'Invalid.Tenant.ProjectNotExists',
+ 'errorMessage' => 'The project does not exist.',
+ ],
+ [
+ 'errorCode' => 'Invalid.Tenant.UserNotInProject',
+ 'errorMessage' => 'The user is not in the project.',
+ ],
+ [
+ 'errorCode' => 'Invalid.CalcEngineEnvType',
+ 'errorMessage' => 'The specified envType %s is invalid.',
+ ],
+ [
+ 'errorCode' => 'Invalid.CalcEngineType',
+ 'errorMessage' => 'The specified calcEngineType %s is invalid.',
+ ],
+ ],
+ 403 => [
+ [
+ 'errorCode' => 'Invalid.Tenant.UserIsNotProjectOwnerOrAdmin',
+ 'errorMessage' => 'The user is not a project administrator or owner.',
+ ],
+ [
+ 'errorCode' => 'Invalid.Tenant.UserNotInTenant',
+ 'errorMessage' => 'The user is not in tenant.',
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"1AFAE64E-D1BE-432B-A9****\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 20,\\n \\"TotalCount\\": 1,\\n \\"CalcEngines\\": [\\n {\\n \\"BindingProjectName\\": \\"test_project\\",\\n \\"IsDefault\\": true,\\n \\"EngineId\\": 35,\\n \\"DwRegion\\": \\"cn-zhangjiakou\\",\\n \\"TaskAuthType\\": \\"PROJECT\\",\\n \\"CalcEngineType\\": \\"ODPS\\",\\n \\"EngineInfo\\": {\\n \\"pubEndpoint\\": \\"service.cn.maxcompute.aliyun.com/api\\",\\n \\"endpoint\\": \\"service.cn.maxcompute.aliyun-inc.com/api\\",\\n \\"initProperties\\": \\" {\\\\\\"odpsTypeMode\\\\\\":\\\\\\"STANDARD\\\\\\",\\\\\\"openPai\\\\\\":false,\\\\\\"openPaiGpu\\\\\\":false}\\",\\n \\"resourceGroupType\\": \\"ODPS\\",\\n \\"resourceGroupId\\": \\"361826516****\\",\\n \\"vpcEndpoint\\": \\"service.cn.maxcompute.aliyun-inc.com/api\\",\\n \\"projectName\\": \\"onefall_test_zjk\\",\\n \\"taskSameAsOwner\\": \\"true\\"\\n },\\n \\"EnvType\\": \\"PRD\\",\\n \\"Region\\": \\"cn-zhangjiakou\\",\\n \\"GmtCreate\\": \\"Oct 10, 2019 3:42:44 PM\\",\\n \\"BindingProjectId\\": 466230,\\n \\"Name\\": \\"test_mc\\",\\n \\"TenantId\\": 1234567\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<ListCalcEnginesResponse>\\n <HttpStatusCode>200</HttpStatusCode>\\n <RequestId>0bc1ec92159376****</RequestId>\\n <Success>true</Success>\\n <Data>\\n <PageNumber>1</PageNumber>\\n <PageSize>20</PageSize>\\n <TotalCount>1</TotalCount>\\n <CalcEngines>\\n <BindingProjectName>abc</BindingProjectName>\\n <IsDefault>true</IsDefault>\\n <EngineId>35</EngineId>\\n <DwRegion>cn-zhangjiakou</DwRegion>\\n <TaskAuthType>PROJECT</TaskAuthType>\\n <CalcEngineType>ODPS</CalcEngineType>\\n <EnvType>PRD</EnvType>\\n <Region>cn-zhangjiakou</Region>\\n <GmtCreate>Oct 10, 2019 3:42:44 PM</GmtCreate>\\n <BindingProjectId>27</BindingProjectId>\\n <Name>abc</Name>\\n <TenantId>1234567</TenantId>\\n </CalcEngines>\\n </Data>\\n</ListCalcEnginesResponse>","errorExample":""}]',
+ 'title' => 'ListCalcEngines',
+ 'summary' => 'Queries a list of compute engines that are associated with a DataWorks workspace.',
+ 'requestParamsDescription' => ' ',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ ],
+ 'CreateDataSource' => [
+ 'summary' => 'Adds a data source to DataWorks.',
+ 'methods' => [
+ 'post',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'write',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'create',
+ 'riskType' => 'high',
+ 'chargeType' => 'free',
+ 'abilityTreeNodes' => [
+ 'FEATUREdide7FTVFZ',
+ ],
+ 'tenantRelevance' => 'tenant',
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'ProjectId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the DataWorks workspace to which the data source belongs. You can call the [ListProjects](~~2780068~~) operation to query the ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => '1',
+ ],
+ ],
+ [
+ 'name' => 'Name',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The name of the data source.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'abc',
+ ],
+ ],
+ [
+ 'name' => 'Description',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The description of the data source.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'abc',
+ ],
+ ],
+ [
+ 'name' => 'DataSourceType',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The type of the data source. Valid values:'."\n"
+ ."\n"
+ .'* odps'."\n"
+ .'* mysql'."\n"
+ .'* rds'."\n"
+ .'* oss'."\n"
+ .'* sqlserver'."\n"
+ .'* polardb'."\n"
+ .'* oracle'."\n"
+ .'* mongodb'."\n"
+ .'* emr'."\n"
+ .'* postgresql'."\n"
+ .'* analyticdb_for_mysql'."\n"
+ .'* hybriddb_for_postgresql'."\n"
+ .'* holo'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'rds',
+ ],
+ ],
+ [
+ 'name' => 'SubType',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The subtype of the data source.'."\n"
+ ."\n"
+ .'* This parameter takes effect only if you set the DataSourceType parameter to rds.'."\n"
+ .'* If the DataSourceType parameter is set to rds, this parameter can be set to mysql, sqlserver, or postgresql.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'mysql',
+ ],
+ ],
+ [
+ 'name' => 'EnvType',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The environment in which the data source is used. Valid values: 0 and 1. The value 0 indicates the development environment. The value 1 indicates the production environment.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => '1',
+ ],
+ ],
+ [
+ 'name' => 'Content',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The details of the data source. Examples of details of some common data sources:'."\n"
+ ."\n"
+ .'* odps'."\n"
+ ."\n"
+ .' {'."\n"
+ .' "accessId": "*****",'."\n"
+ .' "accessKey": "*****",'."\n"
+ .' "authType": 2,'."\n"
+ .' "endpoint": "http://service.odps.aliyun.com/api",'."\n"
+ .' "project": "xsaxsax",'."\n"
+ .' "tag": "public"'."\n"
+ .' }'."\n"
+ ."\n"
+ .'* mysql'."\n"
+ ."\n"
+ .' {'."\n"
+ .' "database": "xsaxsa",'."\n"
+ .' "instanceName": "rm-xsaxsa",'."\n"
+ .' "password": "xsaxsa",'."\n"
+ .' "rdsOwnerId": "xasxsa",'."\n"
+ .' "regionId": "cn-shanghai",'."\n"
+ .' "tag": "rds",'."\n"
+ .' "username": "xsaxsa"'."\n"
+ .' }'."\n"
+ ."\n"
+ .'* rds'."\n"
+ ."\n"
+ .' {'."\n"
+ .' "configType": 1,'."\n"
+ .' "tag": "rds",'."\n"
+ .' "database": "xsaxsa",'."\n"
+ .' "username": "xsaxsa",'."\n"
+ .' "password": "xssaxsa$32050",'."\n"
+ .' "instanceName": "rm-xsaxs",'."\n"
+ .' "rdsOwnerId": "11111111"'."\n"
+ .' }'."\n"
+ ."\n"
+ .'* oss'."\n"
+ ."\n"
+ .' {'."\n"
+ .' "accessId": "*****",'."\n"
+ .' "accessKey": "*****",'."\n"
+ .' "bucket": "xsa-xs-xs",'."\n"
+ .' "endpoint": "http://oss-cn-shanghai.aliyuncs.com",'."\n"
+ .' "tag": "public"'."\n"
+ .' }'."\n"
+ ."\n"
+ .'* sqlserver'."\n"
+ ."\n"
+ .' {'."\n"
+ .' "jdbcUrl": "jdbc:sqlserver://xsaxsa-xsaxsa.database.xxx.cn:123;DatabaseName=xsxs-xsxs",'."\n"
+ .' "password": "sdasda$fs",'."\n"
+ .' "tag": "public",'."\n"
+ .' "username": "sxaxacdacdd"'."\n"
+ .' }'."\n"
+ ."\n"
+ .'* polardb'."\n"
+ ."\n"
+ .' {'."\n"
+ .' "clusterId": "pc-sdadsadsa",'."\n"
+ .' "database": "dsadsadsa",'."\n"
+ .' "ownerId": "121212122",'."\n"
+ .' "password": "sdasdafssa",'."\n"
+ .' "region": "cn-shanghai",'."\n"
+ .' "tag": "polardb",'."\n"
+ .' "username": "asdadsads"'."\n"
+ .' }'."\n"
+ ."\n"
+ .'* redis'."\n"
+ ."\n"
+ .' { '."\n"
+ .' "password": "xxxxxx", '."\n"
+ .' "address":"[{\\"host\\":\\"xxxxxxx.redis.rds.aliyuncs.com\\",\\"port\\":6379}]", '."\n"
+ .' "tag": "public"'."\n"
+ .' }'."\n"
+ ."\n"
+ .'* oracle'."\n"
+ ."\n"
+ .' {'."\n"
+ .' "jdbcUrl": "jdbc:oracle:saaa:@xxxxx:1521:PROD",'."\n"
+ .' "password": "sxasaxsa",'."\n"
+ .' "tag": "public",'."\n"
+ .' "username": "sasfadfa"'."\n"
+ .' }'."\n"
+ ."\n"
+ .'* mongodb'."\n"
+ ."\n"
+ .' {'."\n"
+ .' "address": "[\\"xsaxxsa.mongodb.rds.aliyuncs.com:3717\\"]",'."\n"
+ .' "database": "admin",'."\n"
+ .' "password": "sadsda@",'."\n"
+ .' "tag": "public",'."\n"
+ .' "username": "dsadsadas"'."\n"
+ .' }'."\n"
+ ."\n"
+ .'* emr'."\n"
+ ."\n"
+ .' {'."\n"
+ .' "accessId": "*****",'."\n"
+ .' "emrClusterId": "C-dsads",'."\n"
+ .' "emrResourceQueueName": "default",'."\n"
+ .' "emrEndpoint": "emr.aliyuncs.com",'."\n"
+ .' "accessKey": "*****",'."\n"
+ .' "emrUserId": "224833315798889783",'."\n"
+ .' "name": "sasdsadsa",'."\n"
+ .' "emrAccessMode": "simple",'."\n"
+ .' "region": "cn-shanghai",'."\n"
+ .' "authType": "2",'."\n"
+ .' "emrProjectId": "FP-sdadsad"'."\n"
+ .' }'."\n"
+ ."\n"
+ .'* postgresql'."\n"
+ ."\n"
+ .' {'."\n"
+ .' "jdbcUrl": "jdbc:postgresql://xxxx:1921/ssss",'."\n"
+ .' "password": "sdadsads",'."\n"
+ .' "tag": "public",'."\n"
+ .' "username": "sdsasda"'."\n"
+ .' }'."\n"
+ ."\n"
+ .'* analyticdb_for_mysql'."\n"
+ ."\n"
+ .' {'."\n"
+ .' "instanceId": "am-sadsada",'."\n"
+ .' "database": "xsxsx",'."\n"
+ .' "username": "xsxsa",'."\n"
+ .' "password": "asdadsa",'."\n"
+ .' "connectionString": "am-xssxsxs.ads.aliyuncs.com:3306"'."\n"
+ .' }'."\n"
+ ."\n"
+ .'* hybriddb_for_postgresql'."\n"
+ ."\n"
+ .' {'."\n"
+ .' "connectionString": "gp-xsaxsaxa-master.gpdbmaster.rds.aliyuncs.com",'."\n"
+ .' "database": "xsaxsaxas",'."\n"
+ .' "password": "xsaxsaxsa@11",'."\n"
+ .' "instanceId": "gp-xsaxsaxsa",'."\n"
+ .' "port": "541132",'."\n"
+ .' "ownerId": "xsaxsaxsas",'."\n"
+ .' "username": "sadsad"'."\n"
+ .' }'."\n"
+ ."\n"
+ .'* holo'."\n"
+ ."\n"
+ .' {'."\n"
+ .' "accessId": "*****",'."\n"
+ .' "accessKey": "*****",'."\n"
+ .' "database": "xsaxsaxsa",'."\n"
+ .' "instanceId": "xsaxa",'."\n"
+ .' "tag": "aliyun"'."\n"
+ .' }'."\n"
+ ."\n"
+ .'* kafka'."\n"
+ ."\n"
+ .' {'."\n"
+ .' "instanceId": "xsax-cn-xsaxsa",'."\n"
+ .' "regionId": "cn-shanghai",'."\n"
+ .' "tag": "aliyun",'."\n"
+ .' "ownerId": "1212121212112"'."\n"
+ .' }'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => '{"database":"dbname","instanceName":"instancename","password":"password","rdsOwnerId":"123","username":"username"}',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'description' => 'The response parameters.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'HttpStatusCode' => [
+ 'description' => 'The HTTP status code.'."\n",
+ 'type' => 'string',
+ 'example' => '200',
+ ],
+ 'Data' => [
+ 'description' => 'The data source ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '123',
+ ],
+ 'RequestId' => [
+ 'description' => 'The request ID.'."\n",
+ 'type' => 'string',
+ 'example' => '0bc141151593763****',
+ ],
+ 'Success' => [
+ 'description' => 'Indicates whether the request was successful.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'errorCodes' => [
+ 400 => [
+ [
+ 'errorCode' => 'Invalid.Tenant.ConnectionNotExists',
+ 'errorMessage' => 'The connection does not exist.',
+ ],
+ [
+ 'errorCode' => 'Invalid.Tenant.ProjectNotExists',
+ 'errorMessage' => 'The project does not exist.',
+ ],
+ [
+ 'errorCode' => 'Invalid.Tenant.UserNotInProject',
+ 'errorMessage' => 'The user is not in the project.',
+ ],
+ [
+ 'errorCode' => 'ConnectionAlreadyExist',
+ 'errorMessage' => 'The connection with envType %s and name %s already exists.',
+ ],
+ [
+ 'errorCode' => 'DataSource.CheckRamRoleFailure',
+ 'errorMessage' => 'Failed to check the RAM role. AccountId %s. roleArn %s.',
+ ],
+ [
+ 'errorCode' => 'DataSource.ConnectionStrProperty.PatternNotMatch',
+ 'errorMessage' => 'The pattern value %s is invalid. The correct pattern is %s.',
+ ],
+ [
+ 'errorCode' => 'Invalid.DataSource.DataSourceTypeNotSupport',
+ 'errorMessage' => 'The dataSourceType %s and subType %s are not supported.',
+ ],
+ [
+ 'errorCode' => 'Invalid.Param.Odps.EngineIdOrConnectStrEmpty',
+ 'errorMessage' => 'Either the compute engine ID or the connection string must be specified when data source type is ODPS.',
+ ],
+ [
+ 'errorCode' => 'MissingParam.ConnectionStr.Property',
+ 'errorMessage' => 'You must specify property %s required by the data source connection string.',
+ ],
+ [
+ 'errorCode' => 'Invalid.DataSource.DataSourceTypeNotExist',
+ 'errorMessage' => 'The data source type %s does not exist.',
+ ],
+ ],
+ 403 => [
+ [
+ 'errorCode' => 'Invalid.Tenant.UserIsNotProjectOwnerOrAdmin',
+ 'errorMessage' => 'The user is not a project administrator or owner.',
+ ],
+ [
+ 'errorCode' => 'Invalid.Tenant.UserNotInTenant',
+ 'errorMessage' => 'The user is not in tenant.',
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": \\"200\\",\\n \\"Data\\": 123,\\n \\"RequestId\\": \\"0bc141151593763****\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<CreateDataSourceResponse>\\n <HttpStatusCode>200</HttpStatusCode>\\n <Data>123</Data>\\n <RequestId>0bc141151593763****</RequestId>\\n <Success>true</Success>\\n</CreateDataSourceResponse>","errorExample":""}]',
+ 'title' => 'CreateDataSource',
+ 'requestParamsDescription' => ' ',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ ],
+ 'ListDataSources' => [
+ 'summary' => 'Queries the data sources added to a DataWorks workspace.',
+ 'methods' => [
+ 'get',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'list',
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'ProjectId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the DataWorks workspace to which the data sources belong. You can call the [ListProjects](~~2780068~~) operation to query the ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => '1',
+ ],
+ ],
+ [
+ 'name' => 'Name',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The name of the data source that you want to query.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'docRequired' => false,
+ 'example' => 'test',
+ ],
+ ],
+ [
+ 'name' => 'DataSourceType',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The type of the data source. Valid values:'."\n"
+ ."\n"
+ .'* odps'."\n"
+ .'* mysql'."\n"
+ .'* rds'."\n"
+ .'* oss'."\n"
+ .'* sqlserver'."\n"
+ .'* polardb'."\n"
+ .'* oracle'."\n"
+ .'* mongodb'."\n"
+ .'* emr'."\n"
+ .'* postgresql'."\n"
+ .'* analyticdb_for_mysql'."\n"
+ .'* hybriddb_for_postgresql'."\n"
+ .'* holo'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'rds',
+ ],
+ ],
+ [
+ 'name' => 'SubType',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The subtype of the data source. This parameter takes effect only when the DataSourceType parameter is set to rds.'."\n"
+ ."\n"
+ .'If the value of the DataSourceType parameter is rds, the value of this parameter can be mysql, sqlserver, or postgresql.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'mysql',
+ ],
+ ],
+ [
+ 'name' => 'Status',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The status of the data source. Valid values:'."\n"
+ ."\n"
+ .'* ENABLED'."\n"
+ .'* DISABLED'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'ENABLED',
+ ],
+ ],
+ [
+ 'name' => 'EnvType',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The environment in which the data source is used. Valid values: 0 and 1. The value 0 indicates development environment. The value 1 indicates production environment.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => false,
+ 'example' => '1',
+ ],
+ ],
+ [
+ 'name' => 'PageSize',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The number of entries per page. Default value: 10. Maximum value: 100.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => false,
+ 'example' => '10',
+ ],
+ ],
+ [
+ 'name' => 'PageNumber',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The page number. Pages start from page 1.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => false,
+ 'example' => '1',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'description' => 'The response parameters.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'HttpStatusCode' => [
+ 'description' => 'The HTTP status code.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '200',
+ ],
+ 'RequestId' => [
+ 'description' => 'The request ID.'."\n",
+ 'type' => 'string',
+ 'example' => '0bc14115159376359****',
+ ],
+ 'Success' => [
+ 'description' => 'Indicates whether the request was successful.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'Data' => [
+ 'description' => 'The query result returned.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'PageNumber' => [
+ 'description' => 'The page number.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '1',
+ ],
+ 'PageSize' => [
+ 'description' => 'The number of entries per page.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '20',
+ ],
+ 'TotalCount' => [
+ 'description' => 'The total number of data sources.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '233',
+ ],
+ 'DataSources' => [
+ 'description' => 'The data sources.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The information about the data source.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'Status' => [
+ 'description' => 'The status of the data source. Valid values:'."\n"
+ ."\n"
+ .'* 1: The data source is accessible.'."\n"
+ .'* 2: The data source is inaccessible.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '1',
+ ],
+ 'ProjectId' => [
+ 'description' => 'The ID of the workspace to which the data source belongs.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '123',
+ ],
+ 'SubType' => [
+ 'description' => 'The subtype of the data source. This parameter takes effect only when the DataSourceType parameter is set to rds.'."\n",
+ 'type' => 'string',
+ 'example' => 'mysql',
+ ],
+ 'GmtModified' => [
+ 'description' => 'The time when the data source was last modified. Example: Mar 17, 2021 4:09:32 PM.'."\n",
+ 'type' => 'string',
+ 'example' => 'Mar 17, 2021 4:09:32 PM',
+ ],
+ 'EnvType' => [
+ 'description' => 'The environment in which the data source is used. Valid values:'."\n"
+ ."\n"
+ .'* 0: development environment'."\n"
+ .'* 1: production environment'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '1',
+ ],
+ 'ConnectStatus' => [
+ 'description' => 'The status of the data source. Valid values:'."\n"
+ ."\n"
+ .'* 1: The data source is accessible.'."\n"
+ .'* 2: The data source is inaccessible.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '1',
+ ],
+ 'Sequence' => [
+ 'description' => 'The sequence number of the data source. Data sources are sorted in descending order based on the value of this parameter.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '300',
+ ],
+ 'Description' => [
+ 'description' => 'The description of the data source.'."\n",
+ 'type' => 'string',
+ 'example' => 'a connection',
+ ],
+ 'DataSourceType' => [
+ 'description' => 'The type of the data source. Valid values:'."\n"
+ ."\n"
+ .'* odps'."\n"
+ .'* mysql'."\n"
+ .'* rds'."\n"
+ .'* oss'."\n"
+ .'* sqlserver'."\n"
+ .'* polardb'."\n"
+ .'* oracle'."\n"
+ .'* mongodb'."\n"
+ .'* emr'."\n"
+ .'* postgresql'."\n"
+ .'* analyticdb_for_mysql'."\n"
+ .'* hybriddb_for_postgresql'."\n"
+ .'* holo'."\n",
+ 'type' => 'string',
+ 'example' => 'rds',
+ ],
+ 'GmtCreate' => [
+ 'description' => 'The time when the data source was created. Example: Mar 17, 2021 4:09:32 PM.'."\n",
+ 'type' => 'string',
+ 'example' => 'Mar 17, 2021 4:09:32 PM',
+ ],
+ 'DefaultEngine' => [
+ 'description' => 'Indicates whether the compute engine that is associated with the data source is the default compute engine used by data sources of the same type.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'false',
+ ],
+ 'Shared' => [
+ 'description' => 'Indicates whether the data source is a shared data source.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'false',
+ ],
+ 'Operator' => [
+ 'description' => 'The ID of the Alibaba Cloud account that is used to last modify the data source.'."\n",
+ 'type' => 'string',
+ 'example' => '193543050****',
+ ],
+ 'Name' => [
+ 'description' => 'The name of the data source.'."\n",
+ 'type' => 'string',
+ 'example' => 'abc',
+ ],
+ 'Content' => [
+ 'description' => 'The data connection string. The value of this parameter is in the JSON format. Examples of connection strings of common data sources:'."\n"
+ ."\n"
+ .'* MaxCompute'."\n"
+ ."\n"
+ .' {'."\n"
+ .' "pubEndpoint": "http://service.cn.maxcompute.aliyun.com/api",'."\n"
+ .' "accessId": "xxxxxxx",'."\n"
+ .' "securityToken": null,'."\n"
+ .' "endpoint": "http://service.cn.maxcompute.aliyun-inc.com/api",'."\n"
+ .' "accessKey": "***",'."\n"
+ .' "name": "PRE_PROJECT_A_engine",'."\n"
+ .' "project": "PRE_PROJECT_A",'."\n"
+ .' "vpcEndpoint": "http://service.cn.maxcompute.aliyun-inc.com/api",'."\n"
+ .' "region": "cn-shanghai",'."\n"
+ .' "authType": "2"'."\n"
+ .' }'."\n"
+ ."\n"
+ .'* mysql'."\n"
+ ."\n"
+ .' {'."\n"
+ .' "configType": "1",'."\n"
+ .' "database": "mysql_d111b",'."\n"
+ .' "instanceName": "rm-xxxxxx",'."\n"
+ .' "password": "***",'."\n"
+ .' "rdsOwnerId": "12133xxxxxx",'."\n"
+ .' "tag": "rds",'."\n"
+ .' "username": "mysql_db111"'."\n"
+ .' }'."\n"
+ ."\n"
+ .'* sqlserver'."\n"
+ ."\n"
+ .' {'."\n"
+ .' "configType": "1",'."\n"
+ .' "jdbcUrl": "jdbc:sqlserver://rm-xxxxx.sqlserver.rds.aliyuncs.com:1433;DatabaseName=sqlserver_db1",'."\n"
+ .' "password": "***",'."\n"
+ .' "tag": "public",'."\n"
+ .' "username": "sqlserver_db111"'."\n"
+ .' }'."\n"
+ ."\n"
+ .'* oss'."\n"
+ ."\n"
+ .' {'."\n"
+ .' "accessId": "***********",'."\n"
+ .' "accessKey": "***********",'."\n"
+ .' "bucket": "bigxxx1223",'."\n"
+ .' "configType": "1",'."\n"
+ .' "endpoint": "http://oss-cn-hangzhou.aliyuncs.com",'."\n"
+ .' "tag": "public"'."\n"
+ .' }'."\n"
+ ."\n"
+ .'* postgresql'."\n"
+ ."\n"
+ .' {'."\n"
+ .' "configType": "1",'."\n"
+ .' "database": "cdp_xxx",'."\n"
+ .' "instanceName": "rm-xxxx",'."\n"
+ .' "password": "***",'."\n"
+ .' "rdsOwnerId": "121xxxxx",'."\n"
+ .' "tag": "rds",'."\n"
+ .' "username": "cdp_xxx"'."\n"
+ .' }'."\n"
+ ."\n"
+ .'* ads'."\n"
+ ."\n"
+ .' {'."\n"
+ .' "configType": "1",'."\n"
+ .' "password": "***",'."\n"
+ .' "schema": "ads_demo",'."\n"
+ .' "tag": "public",'."\n"
+ .' "url": "ads-xxx-xxxx.cn-hangzhou-1.ads.aliyuncs.com:3029",'."\n"
+ .' "username": "lslslsls"'."\n"
+ .' }'."\n",
+ 'type' => 'string',
+ 'example' => '{"pubEndpoint":"http://service.cn.maxcompute.aliyun.com/api","accessId":"TMP.3KecGjvzy3i8MYfn2BGHgF7EHGyBFZcHm7GgngrABVRyvvKQrfF5kskR36xP361C3dqwbGo7SGYptAeGyiTwHXqLaBUvYC","securityToken":null,"endpoint":"http://service.cn.maxcompute.aliyun-inc.com/api","accessKey":"***","name":"PRE_PROJECT_A_engine","project":"PRE_PROJECT_A","vpcEndpoint":"http://service.cn.maxcompute.aliyun-inc.com/api","region":"cn-shanghai","authType":"2"}',
+ ],
+ 'Id' => [
+ 'description' => 'The data source ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '1',
+ ],
+ 'BindingCalcEngineId' => [
+ 'description' => 'The ID of the compute engine with which the data source is associated.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '123',
+ ],
+ 'TenantId' => [
+ 'description' => 'The tenant ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '1234567',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'errorCodes' => [
+ 400 => [
+ [
+ 'errorCode' => 'Invalid.Tenant.ConnectionNotExists',
+ 'errorMessage' => 'The connection does not exist.',
+ ],
+ [
+ 'errorCode' => 'Invalid.Tenant.ProjectNotExists',
+ 'errorMessage' => 'The project does not exist.',
+ ],
+ [
+ 'errorCode' => 'Invalid.Tenant.UserNotInProject',
+ 'errorMessage' => 'The user is not in the project.',
+ ],
+ ],
+ 403 => [
+ [
+ 'errorCode' => 'Invalid.Tenant.UserIsNotProjectOwnerOrAdmin',
+ 'errorMessage' => 'The user is not a project administrator or owner.',
+ ],
+ [
+ 'errorCode' => 'Invalid.Tenant.UserNotInTenant',
+ 'errorMessage' => 'The user is not in tenant.',
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"0bc14115159376359****\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 20,\\n \\"TotalCount\\": 233,\\n \\"DataSources\\": [\\n {\\n \\"Status\\": 1,\\n \\"ProjectId\\": 123,\\n \\"SubType\\": \\"mysql\\",\\n \\"GmtModified\\": \\"Mar 17, 2021 4:09:32 PM\\",\\n \\"EnvType\\": 1,\\n \\"ConnectStatus\\": 1,\\n \\"Sequence\\": 300,\\n \\"Description\\": \\"a connection\\",\\n \\"DataSourceType\\": \\"rds\\",\\n \\"GmtCreate\\": \\"Mar 17, 2021 4:09:32 PM\\",\\n \\"DefaultEngine\\": false,\\n \\"Shared\\": false,\\n \\"Operator\\": \\"193543050****\\",\\n \\"Name\\": \\"abc\\",\\n \\"Content\\": \\"{\\\\\\"pubEndpoint\\\\\\":\\\\\\"http://service.cn.maxcompute.aliyun.com/api\\\\\\",\\\\\\"accessId\\\\\\":\\\\\\"TMP.3KecGjvzy3i8MYfn2BGHgF7EHGyBFZcHm7GgngrABVRyvvKQrfF5kskR36xP361C3dqwbGo7SGYptAeGyiTwHXqLaBUvYC\\\\\\",\\\\\\"securityToken\\\\\\":null,\\\\\\"endpoint\\\\\\":\\\\\\"http://service.cn.maxcompute.aliyun-inc.com/api\\\\\\",\\\\\\"accessKey\\\\\\":\\\\\\"***\\\\\\",\\\\\\"name\\\\\\":\\\\\\"PRE_PROJECT_A_engine\\\\\\",\\\\\\"project\\\\\\":\\\\\\"PRE_PROJECT_A\\\\\\",\\\\\\"vpcEndpoint\\\\\\":\\\\\\"http://service.cn.maxcompute.aliyun-inc.com/api\\\\\\",\\\\\\"region\\\\\\":\\\\\\"cn-shanghai\\\\\\",\\\\\\"authType\\\\\\":\\\\\\"2\\\\\\"}\\",\\n \\"Id\\": 1,\\n \\"BindingCalcEngineId\\": 123,\\n \\"TenantId\\": 1234567\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<RequestId>0bc14115159376359****</RequestId>\\n<HttpStatusCode>200</HttpStatusCode>\\n<Data>\\n <TotalCount>233</TotalCount>\\n <PageSize>20</PageSize>\\n <PageNumber>1</PageNumber>\\n <DataSources>\\n <Status>1</Status>\\n <Operator>193543050****</Operator>\\n <ConnectStatus>1</ConnectStatus>\\n <SubType>mysql</SubType>\\n <Description>a connection</Description>\\n <BindingCalcEngineId>123</BindingCalcEngineId>\\n <ProjectId>123</ProjectId>\\n <GmtModified>Mar 17, 2021 4:09:32 PM</GmtModified>\\n <Sequence>300</Sequence>\\n <Shared>false</Shared>\\n <EnvType>1</EnvType>\\n <Name>abc</Name>\\n <DefaultEngine>false</DefaultEngine>\\n <TenantId>1234567</TenantId>\\n <GmtCreate>Mar 17, 2021 4:09:32 PM</GmtCreate>\\n <Content>{\\"pubEndpoint\\":\\"http://service.cn.maxcompute.aliyun.com/api\\",\\"accessId\\":\\"TMP.3KecGjvzy3i8MYfn2BGHgF7EHGyBFZcHm7GgngrABVRyvvKQrfF5kskR36xP361C3dqwbGo7SGYptAeGyiTwHXqLaBUvYC\\",\\"securityToken\\":null,\\"endpoint\\":\\"http://service.cn.maxcompute.aliyun-inc.com/api\\",\\"accessKey\\":\\"***\\",\\"name\\":\\"PRE_PROJECT_A_engine\\",\\"project\\":\\"PRE_PROJECT_A\\",\\"vpcEndpoint\\":\\"http://service.cn.maxcompute.aliyun-inc.com/api\\",\\"region\\":\\"cn-shanghai\\",\\"authType\\":\\"2\\"}</Content>\\n <DataSourceType>rds</DataSourceType>\\n <Id>1</Id>\\n </DataSources>\\n</Data>\\n<Success>true</Success>","errorExample":""}]',
+ 'title' => 'ListDataSources',
+ 'requestParamsDescription' => ' ',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ ],
+ 'UpdateDataSource' => [
+ 'summary' => 'Updates a data source.',
+ 'methods' => [
+ 'put',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'write',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'get',
+ 'riskType' => 'high',
+ 'chargeType' => 'free',
+ 'abilityTreeCode' => '78369',
+ 'abilityTreeNodes' => [
+ 'FEATUREdideRWC5F7',
+ ],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'Description',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The description of the data source.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'xxx',
+ ],
+ ],
+ [
+ 'name' => 'EnvType',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The environment in which the data source resides. Valid values:'."\n"
+ ."\n"
+ .'* 0: development environment'."\n"
+ .'* 1: production environment'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => false,
+ 'docRequired' => true,
+ 'example' => '1',
+ ],
+ ],
+ [
+ 'name' => 'Content',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The details about the data source. You are not allowed to change the type of the data source. For example, you are not allowed to change the data source type from MaxCompute to MySQL. Examples of details of some common data sources:'."\n"
+ ."\n"
+ .'* odps'."\n"
+ ."\n"
+ .' {'."\n"
+ .' "accessId": "*****",'."\n"
+ .' "accessKey": "*****",'."\n"
+ .' "authType": 2,'."\n"
+ .' "endpoint": "http://service.odps.aliyun.com/api",'."\n"
+ .' "project": "xsaxsax",'."\n"
+ .' "tag": "public"'."\n"
+ .' }'."\n"
+ ."\n"
+ .'* mysql'."\n"
+ ."\n"
+ .' {'."\n"
+ .' "database": "xsaxsa",'."\n"
+ .' "instanceName": "rm-xsaxsa",'."\n"
+ .' "password": "xsaxsa",'."\n"
+ .' "rdsOwnerId": "xasxsa",'."\n"
+ .' "regionId": "cn-shanghai",'."\n"
+ .' "tag": "rds",'."\n"
+ .' "username": "xsaxsa"'."\n"
+ .' }'."\n"
+ ."\n"
+ .'* rds'."\n"
+ ."\n"
+ .' {'."\n"
+ .' "configType": 1,'."\n"
+ .' "tag": "rds",'."\n"
+ .' "database": "xsaxsa",'."\n"
+ .' "username": "xsaxsa",'."\n"
+ .' "password": "xssaxsa$32050",'."\n"
+ .' "instanceName": "rm-xsaxs",'."\n"
+ .' "rdsOwnerId": "11111111"'."\n"
+ .' }'."\n"
+ ."\n"
+ .'* oss'."\n"
+ ."\n"
+ .' {'."\n"
+ .' "accessId": "*****",'."\n"
+ .' "accessKey": "*****",'."\n"
+ .' "bucket": "xsa-xs-xs",'."\n"
+ .' "endpoint": "http://oss-cn-shanghai.aliyuncs.com",'."\n"
+ .' "tag": "public"'."\n"
+ .' }'."\n"
+ ."\n"
+ .'* sqlserver'."\n"
+ ."\n"
+ .' {'."\n"
+ .' "jdbcUrl": "jdbc:sqlserver://xsaxsa-xsaxsa.database.xxx.cn:123;DatabaseName=xsxs-xsxs",'."\n"
+ .' "password": "sdasda$fs",'."\n"
+ .' "tag": "public",'."\n"
+ .' "username": "sxaxacdacdd"'."\n"
+ .' }'."\n"
+ ."\n"
+ .'* polardb'."\n"
+ ."\n"
+ .' {'."\n"
+ .' "clusterId": "pc-sdadsadsa",'."\n"
+ .' "database": "dsadsadsa",'."\n"
+ .' "ownerId": "121212122",'."\n"
+ .' "password": "sdasdafssa",'."\n"
+ .' "region": "cn-shanghai",'."\n"
+ .' "tag": "polardb",'."\n"
+ .' "username": "asdadsads"'."\n"
+ .' }'."\n"
+ ."\n"
+ .'* oracle'."\n"
+ ."\n"
+ .' {'."\n"
+ .' "jdbcUrl": "jdbc:oracle:saaa:@xxxxx:1521:PROD",'."\n"
+ .' "password": "sxasaxsa",'."\n"
+ .' "tag": "public",'."\n"
+ .' "username": "sasfadfa"'."\n"
+ .' }'."\n"
+ ."\n"
+ .'* mongodb'."\n"
+ ."\n"
+ .' {'."\n"
+ .' "address": "[\\"xsaxxsa.mongodb.rds.aliyuncs.com:3717\\"]",'."\n"
+ .' "database": "admin",'."\n"
+ .' "password": "sadsda@",'."\n"
+ .' "tag": "public",'."\n"
+ .' "username": "dsadsadas"'."\n"
+ .' }'."\n"
+ ."\n"
+ .'* emr'."\n"
+ ."\n"
+ .' {'."\n"
+ .' "accessId": "*****",'."\n"
+ .' "emrClusterId": "C-dsads",'."\n"
+ .' "emrResourceQueueName": "default",'."\n"
+ .' "emrEndpoint": "emr.aliyuncs.com",'."\n"
+ .' "accessKey": "*****",'."\n"
+ .' "emrUserId": "224833315798889783",'."\n"
+ .' "name": "sasdsadsa",'."\n"
+ .' "emrAccessMode": "simple",'."\n"
+ .' "region": "cn-shanghai",'."\n"
+ .' "authType": "2",'."\n"
+ .' "emrProjectId": "FP-sdadsad"'."\n"
+ .' }'."\n"
+ ."\n"
+ .'* postgresql'."\n"
+ ."\n"
+ .' {'."\n"
+ .' "jdbcUrl": "jdbc:postgresql://xxxx:1921/ssss",'."\n"
+ .' "password": "sdadsads",'."\n"
+ .' "tag": "public",'."\n"
+ .' "username": "sdsasda"'."\n"
+ .' }'."\n"
+ ."\n"
+ .'* analyticdb_for_mysql'."\n"
+ ."\n"
+ .' {'."\n"
+ .' "instanceId": "am-sadsada",'."\n"
+ .' "database": "xsxsx",'."\n"
+ .' "username": "xsxsa",'."\n"
+ .' "password": "asdadsa",'."\n"
+ .' "connectionString": "am-xssxsxs.ads.aliyuncs.com:3306"'."\n"
+ .' }'."\n"
+ ."\n"
+ .'* hybriddb_for_postgresql'."\n"
+ ."\n"
+ .' {'."\n"
+ .' "connectionString": "gp-xsaxsaxa-master.gpdbmaster.rds.aliyuncs.com",'."\n"
+ .' "database": "xsaxsaxas",'."\n"
+ .' "password": "xsaxsaxsa@11",'."\n"
+ .' "instanceId": "gp-xsaxsaxsa",'."\n"
+ .' "port": "541132",'."\n"
+ .' "ownerId": "xsaxsaxsas",'."\n"
+ .' "username": "sadsad"'."\n"
+ .' }'."\n"
+ ."\n"
+ .'* holo'."\n"
+ ."\n"
+ .' {'."\n"
+ .' "accessId": "*****",'."\n"
+ .' "accessKey": "*****",'."\n"
+ .' "database": "xsaxsaxsa",'."\n"
+ .' "instanceId": "xsaxa",'."\n"
+ .' "tag": "aliyun"'."\n"
+ .' }'."\n"
+ ."\n"
+ .'* kafka'."\n"
+ ."\n"
+ .' {'."\n"
+ .' "instanceId": "xsax-cn-xsaxsa",'."\n"
+ .' "regionId": "cn-shanghai",'."\n"
+ .' "tag": "aliyun",'."\n"
+ .' "ownerId": "1212121212112"'."\n"
+ .' }'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'docRequired' => true,
+ 'example' => '{"accessId":"xssssss","accessKey":"xsaxsaxsa","authType":2,"endpoint":"http://service.odps.aliyun.com/api","project":"xsaxsax","tag":"public"}',
+ ],
+ ],
+ [
+ 'name' => 'Status',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The status of the data source. This parameter is deprecated. Do not use this parameter.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'ENABLED',
+ ],
+ ],
+ [
+ 'name' => 'DataSourceId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the data source. You can call the [ListDataSources](~~2780072~~) operation to query the ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => '1',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'description' => 'The response parameters.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'HttpStatusCode' => [
+ 'description' => 'The HTTP status code.'."\n",
+ 'type' => 'string',
+ 'example' => '200',
+ ],
+ 'Data' => [
+ 'description' => 'Indicates whether the data source is updated.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'RequestId' => [
+ 'description' => 'The request ID.'."\n",
+ 'type' => 'string',
+ 'example' => '0bc14115159376359****',
+ ],
+ 'Success' => [
+ 'description' => 'Indicates whether the request was successful.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'errorCodes' => [
+ 400 => [
+ [
+ 'errorCode' => 'Invalid.Tenant.ConnectionNotExists',
+ 'errorMessage' => 'The connection does not exist.',
+ ],
+ [
+ 'errorCode' => 'Invalid.Tenant.ProjectNotExists',
+ 'errorMessage' => 'The project does not exist.',
+ ],
+ [
+ 'errorCode' => 'Invalid.Tenant.UserNotInProject',
+ 'errorMessage' => 'The user is not in the project.',
+ ],
+ [
+ 'errorCode' => 'MissingParam.ConnectionStr.Property',
+ 'errorMessage' => 'You must specify property %s required by the data source connection string.',
+ ],
+ [
+ 'errorCode' => 'DataSource.CheckRamRoleFailure',
+ 'errorMessage' => 'Failed to check the RAM role. AccountId %s. roleArn %s.',
+ ],
+ [
+ 'errorCode' => 'DataSource.ConnectionStrProperty.PatternNotMatch',
+ 'errorMessage' => 'The pattern value %s is invalid. The correct pattern is %s.',
+ ],
+ [
+ 'errorCode' => 'DataSource.NotFound',
+ 'errorMessage' => 'The specified data source ID %s does not exist.',
+ ],
+ [
+ 'errorCode' => 'Invalid.Connection.Empty',
+ 'errorMessage' => 'You must specify the connection parameter.',
+ ],
+ [
+ 'errorCode' => 'Invalid.DataSource.DataSourceTypeNotExist',
+ 'errorMessage' => 'The data source type %s does not exist.',
+ ],
+ [
+ 'errorCode' => 'Invalid.DataSource.DataSourceTypeNotSupport',
+ 'errorMessage' => 'The dataSourceType %s and subType %s are not supported.',
+ ],
+ [
+ 'errorCode' => 'Invalid.Operation',
+ 'errorMessage' => 'You cannot delete the bindingCalcEngine that is bound to the data source.',
+ ],
+ [
+ 'errorCode' => 'Invalid.Param.Odps.EngineIdOrConnectStrEmpty',
+ 'errorMessage' => 'Either the compute engine ID or the connection string must be specified when data source type is ODPS.',
+ ],
+ [
+ 'errorCode' => 'Required.Parameter.Empty',
+ 'errorMessage' => 'You must specify the parameter %s.',
+ ],
+ ],
+ 403 => [
+ [
+ 'errorCode' => 'Invalid.Tenant.UserIsNotProjectOwnerOrAdmin',
+ 'errorMessage' => 'The user is not a project administrator or owner.',
+ ],
+ [
+ 'errorCode' => 'Invalid.Tenant.UserNotInTenant',
+ 'errorMessage' => 'The user is not in tenant.',
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": \\"200\\",\\n \\"Data\\": true,\\n \\"RequestId\\": \\"0bc14115159376359****\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<UpdateDataSourceResponse>\\n <HttpStatusCode>200</HttpStatusCode>\\n <Data>true</Data>\\n <RequestId>0bc14115159376359****</RequestId>\\n <Success>true</Success>\\n</UpdateDataSourceResponse>","errorExample":""}]',
+ 'title' => 'UpdateDataSource',
+ 'requestParamsDescription' => ' ',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ ],
+ 'DeleteDataSource' => [
+ 'methods' => [
+ 'post',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'write',
+ 'deprecated' => false,
+ 'systemTags' => [],
+ 'parameters' => [
+ [
+ 'name' => 'DataSourceId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The data source ID. You can call the [ListDataSources](~~211431~~) operation to query the ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => '1',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'description' => 'The response parameters.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'HttpStatusCode' => [
+ 'description' => 'The HTTP status code.'."\n",
+ 'type' => 'string',
+ 'example' => '200',
+ ],
+ 'Data' => [
+ 'description' => 'Indicates whether the data source was removed.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'RequestId' => [
+ 'description' => 'The request ID.'."\n",
+ 'type' => 'string',
+ 'example' => '0bc1411515937635****',
+ ],
+ 'Success' => [
+ 'description' => 'Indicates whether the request was successful.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'errorCodes' => [
+ 400 => [
+ [
+ 'errorCode' => 'Invalid.Tenant.ConnectionNotExists',
+ 'errorMessage' => 'The connection does not exist.',
+ ],
+ [
+ 'errorCode' => 'Invalid.Tenant.ProjectNotExists',
+ 'errorMessage' => 'The project does not exist.',
+ ],
+ [
+ 'errorCode' => 'Invalid.Tenant.UserNotInProject',
+ 'errorMessage' => 'The user is not in the project.',
+ ],
+ [
+ 'errorCode' => 'Invalid.Operation',
+ 'errorMessage' => 'You cannot delete the bindingCalcEngine that is bound to the data source.',
+ ],
+ ],
+ 403 => [
+ [
+ 'errorCode' => 'Invalid.Tenant.UserIsNotProjectOwnerOrAdmin',
+ 'errorMessage' => 'The user is not a project administrator or owner.',
+ ],
+ [
+ 'errorCode' => 'Invalid.Tenant.UserNotInTenant',
+ 'errorMessage' => 'The user is not in tenant.',
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": \\"200\\",\\n \\"Data\\": true,\\n \\"RequestId\\": \\"0bc1411515937635****\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<RequestId>0bc1411515937635****</RequestId>\\n<HttpStatusCode>200</HttpStatusCode>\\n<Data>true</Data>\\n<Success>true</Success>","errorExample":""}]',
+ 'title' => 'DeleteDataSource',
+ 'summary' => 'Removes a data source.',
+ 'requestParamsDescription' => ' ',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ ],
+ 'ListResourceGroups' => [
+ 'summary' => 'Queries a list of resource groups of a specific type.',
+ 'methods' => [
+ 'post',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'get',
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'ResourceGroupType',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The type of the resource group that you want to query. Valid values:'."\n"
+ ."\n"
+ .'* 0: DataWorks'."\n"
+ .'* 1: scheduling'."\n"
+ .'* 2: MaxCompute'."\n"
+ .'* 3: Platform for AI (PAI)'."\n"
+ .'* 4: Data Integration'."\n"
+ .'* 7: exclusive resource group for scheduling (An ID is generated for the purchased resource when you purchase an exclusive resource group for scheduling.)'."\n"
+ .'* 9: DataService Studio'."\n"
+ .'* Default value: 1'."\n"
+ ."\n"
+ .'If the value indicates a compute engine, the resource groups to query are the ones that were created when you purchased the compute engine.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => false,
+ 'docRequired' => true,
+ 'example' => '3',
+ ],
+ ],
+ [
+ 'name' => 'Keyword',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The keyword that is used for fuzzy match by resource group name and identifier.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'abc',
+ ],
+ ],
+ [
+ 'name' => 'BizExtKey',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The category of the resource group. Valid values:'."\n"
+ ."\n"
+ .'* default (default): shared resource group'."\n"
+ .'* single: exclusive resource group'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'default',
+ ],
+ ],
+ [
+ 'name' => 'ResourceManagerResourceGroupId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The resource group ID.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'rg-acfmzbn7pti3zfa',
+ ],
+ ],
+ [
+ 'name' => 'Tags',
+ 'in' => 'query',
+ 'style' => 'json',
+ 'schema' => [
+ 'description' => 'The tags.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '',
+ 'type' => 'object',
+ 'properties' => [
+ 'Key' => [
+ 'description' => 'The tag key.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'Env',
+ ],
+ 'Value' => [
+ 'description' => 'The tag value.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'Test',
+ ],
+ ],
+ 'required' => false,
+ ],
+ 'required' => false,
+ 'maxItems' => 20,
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'description' => 'The response parameters.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'HttpStatusCode' => [
+ 'description' => 'The HTTP status code.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '200',
+ ],
+ 'RequestId' => [
+ 'description' => 'The request ID.'."\n",
+ 'type' => 'string',
+ 'example' => '0bc1411515937635973****',
+ ],
+ 'Success' => [
+ 'description' => 'Indicates whether the request was successful.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'Data' => [
+ 'description' => 'The resource groups.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '',
+ 'type' => 'object',
+ 'properties' => [
+ 'Status' => [
+ 'description' => 'The status of the resource group. Valid values:'."\n"
+ ."\n"
+ .'* 0: NORMAL, which indicates that the resource group is running or in service.'."\n"
+ .'* 1: STOP, which indicates that the resource group has expired and is frozen.'."\n"
+ .'* 2: DELETED, which indicates that the resource group is released or destroyed.'."\n"
+ .'* 3: CREATING, which indicates that the resource group is being created or started.'."\n"
+ .'* 4: CREATE_FAILED, which indicates that the resource group fails to be created or started.'."\n"
+ .'* 5: UPDATING, which indicates that the resource group is being scaled out or upgraded.'."\n"
+ .'* 6: UPDATE_FAILED, which indicates that the resource group fails to be scaled out or upgraded.'."\n"
+ .'* 7: DELETING, which indicates that the resource group is being released or destroyed.'."\n"
+ .'* 8: DELETE_FAILED, which indicates that the resource group fails to be released or destroyed.'."\n"
+ .'* 9: TIMEOUT, which indicates that the operation performed on the resource group times out. All operations may time out. This value is temporarily available only for DataService Studio.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '0',
+ ],
+ 'UpdateTime' => [
+ 'description' => 'The time when the resource group was last updated.'."\n",
+ 'type' => 'string',
+ 'example' => 'Jul 9, 2018 2:43:37 PM',
+ ],
+ 'IsDefault' => [
+ 'description' => 'Indicates whether the resource group is the default resource group. Valid values:'."\n"
+ ."\n"
+ .'* true: The resource group is the default resource group.'."\n"
+ .'* false: The resource group is not the default resource group.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'Cluster' => [
+ 'description' => 'The name of the cluster. This parameter is returned only if the type of the resource group is MaxCompute or PAI.'."\n",
+ 'type' => 'string',
+ 'example' => 'AY18G',
+ ],
+ 'EnableKp' => [
+ 'description' => 'Indicates whether the UID of an Alibaba Cloud account is used for access. Valid values:'."\n"
+ ."\n"
+ .'* true: The MaxCompute compute engine uses the UID of the Alibaba Cloud account as the display name of the account for access.'."\n"
+ .'* false: The MaxCompute compute engine uses the name of the Alibaba Cloud account as the display name of the account for access. The remaining values are useless. This parameter is returned only if the type of the resource group is MaxCompute.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'false',
+ ],
+ 'ResourceGroupType' => [
+ 'description' => 'The type of the resource group. Valid values:'."\n"
+ ."\n"
+ .'* 0: DataWorks'."\n"
+ .'* 2: MaxCompute'."\n"
+ .'* 3: PAI'."\n"
+ .'* 4: Data Integration'."\n"
+ .'* 7: scheduling'."\n"
+ .'* 9: DataService Studio'."\n",
+ 'type' => 'string',
+ 'example' => '3',
+ ],
+ 'CreateTime' => [
+ 'description' => 'The time when the cluster was created. Example: Jul 9, 2018 2:43:37 PM.'."\n",
+ 'type' => 'string',
+ 'example' => 'Jul 9, 2018 2:43:37 PM',
+ ],
+ 'Identifier' => [
+ 'description' => 'The identifier of the resource group.'."\n",
+ 'type' => 'string',
+ 'example' => 'e1815577-2f4e-4c5e-b29****',
+ ],
+ 'Mode' => [
+ 'description' => 'The mode of the resource group. Valid values:'."\n"
+ ."\n"
+ .'* ISOLATE: exclusive resource group that adopts the subscription billing method'."\n"
+ .'* SHARE: shared resource group that adopts the pay-as-you-go billing method'."\n"
+ .'* DEVELOP: resource group for developers'."\n",
+ 'type' => 'string',
+ 'example' => 'SHARE',
+ ],
+ 'BizExtKey' => [
+ 'description' => 'The category of the resource group. Valid values:'."\n"
+ ."\n"
+ .'* default: shared resource group'."\n"
+ .'* single: exclusive resource group'."\n",
+ 'type' => 'string',
+ 'example' => 'default',
+ ],
+ 'Sequence' => [
+ 'description' => 'The sequence number of the resource group. Created resource groups are sorted in ascending order by sequence number.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '300',
+ ],
+ 'Specs' => [
+ 'description' => 'The details of the resource group. The content enclosed in braces {} is the details of the resource group.'."\n",
+ 'type' => 'object',
+ 'example' => '{}',
+ ],
+ 'Name' => [
+ 'description' => 'The name of the resource group.'."\n",
+ 'type' => 'string',
+ 'example' => 'abc',
+ ],
+ 'Id' => [
+ 'description' => 'The resource group ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '1234567',
+ ],
+ 'TenantId' => [
+ 'description' => 'The tenant ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '1234567',
+ ],
+ 'ResourceManagerResourceGroupId' => [
+ 'description' => 'The ID of your Alibaba Cloud resource group.'."\n",
+ 'type' => 'string',
+ 'example' => 'rg-acfmzbn7pti3zfa',
+ ],
+ 'Tags' => [
+ 'description' => 'The tags.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '',
+ 'type' => 'object',
+ 'properties' => [
+ 'Key' => [
+ 'description' => 'The tag key.'."\n",
+ 'type' => 'string',
+ 'example' => 'Env',
+ ],
+ 'Value' => [
+ 'description' => 'The tag value.'."\n",
+ 'type' => 'string',
+ 'example' => 'Test',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'errorCodes' => [
+ 400 => [
+ [
+ 'errorCode' => 'Invalid.Tenant.ConnectionNotExists',
+ 'errorMessage' => 'The connection does not exist.',
+ ],
+ [
+ 'errorCode' => 'Invalid.Tenant.ProjectNotExists',
+ 'errorMessage' => 'The project does not exist.',
+ ],
+ [
+ 'errorCode' => 'Invalid.Tenant.UserNotInProject',
+ 'errorMessage' => 'The user is not in the project.',
+ ],
+ ],
+ 403 => [
+ [
+ 'errorCode' => 'Invalid.Tenant.UserIsNotProjectOwnerOrAdmin',
+ 'errorMessage' => 'The user is not a project administrator or owner.',
+ ],
+ [
+ 'errorCode' => 'Invalid.Tenant.UserNotInTenant',
+ 'errorMessage' => 'The user is not in tenant.',
+ ],
+ ],
+ ],
+ 'staticInfo' => [],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"0bc1411515937635973****\\",\\n \\"Success\\": true,\\n \\"Data\\": [\\n {\\n \\"Status\\": 0,\\n \\"UpdateTime\\": \\"Jul 9, 2018 2:43:37 PM\\",\\n \\"IsDefault\\": true,\\n \\"Cluster\\": \\"AY18G\\",\\n \\"EnableKp\\": false,\\n \\"ResourceGroupType\\": \\"3\\",\\n \\"CreateTime\\": \\"Jul 9, 2018 2:43:37 PM\\",\\n \\"Identifier\\": \\"e1815577-2f4e-4c5e-b29****\\",\\n \\"Mode\\": \\"SHARE\\",\\n \\"BizExtKey\\": \\"default\\",\\n \\"Sequence\\": 300,\\n \\"Specs\\": {},\\n \\"Name\\": \\"abc\\",\\n \\"Id\\": 1234567,\\n \\"TenantId\\": 1234567,\\n \\"ResourceManagerResourceGroupId\\": \\"rg-acfmzbn7pti3zfa\\",\\n \\"Tags\\": [\\n {\\n \\"Key\\": \\"Env\\",\\n \\"Value\\": \\"Test\\"\\n }\\n ]\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<ListResourceGroupsResponse>\\n <HttpStatusCode>200</HttpStatusCode>\\n <RequestId>0bc1411515937635973****</RequestId>\\n <Success>true</Success>\\n <Data>\\n <Status>0</Status>\\n <UpdateTime>Jul 9, 2018 2:43:37 PM</UpdateTime>\\n <IsDefault>true</IsDefault>\\n <Cluster>AY18G</Cluster>\\n <EnableKp>false</EnableKp>\\n <ResourceGroupType>3</ResourceGroupType>\\n <CreateTime>Jul 9, 2018 2:43:37 PM</CreateTime>\\n <Identifier>e1815577-2f4e-4c5e-b29****</Identifier>\\n <Mode>SHARE</Mode>\\n <BizExtKey>default</BizExtKey>\\n <Sequence>300</Sequence>\\n <Name>abc</Name>\\n <Id>1234567</Id>\\n <TenantId>1234567</TenantId>\\n <ResourceManagerResourceGroupId>rg-acfmzbn7pti3zfa</ResourceManagerResourceGroupId>\\n <Tags>\\n <Key>Env</Key>\\n <Value>Test</Value>\\n </Tags>\\n </Data>\\n</ListResourceGroupsResponse>","errorExample":""}]',
+ 'title' => 'ListResourceGroups',
+ 'requestParamsDescription' => ' ',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ ],
+ 'GetProject' => [
+ 'summary' => 'Queries the information about a DataWorks workspace.',
+ 'methods' => [
+ 'post',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'get',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'ProjectId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the DataWorks workspace. You can call the [ListProjects](~~2780068~~) operation to query the ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'docRequired' => true,
+ 'example' => '27',
+ ],
+ ],
+ [
+ 'name' => 'ProjectIdentifier',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The name of the DataWorks workspace. You can call the [ListProjects](~~2780068~~) operation to query the name.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'test_project',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'description' => 'The returned result.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'HttpStatusCode' => [
+ 'description' => 'The HTTP status code.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '200',
+ ],
+ 'RequestId' => [
+ 'description' => 'The request ID.'."\n",
+ 'type' => 'string',
+ 'example' => '0bc1411515937635973****',
+ ],
+ 'Success' => [
+ 'description' => 'Indicates whether the request was successful. Valid values:'."\n"
+ ."\n"
+ .'* **true**'."\n"
+ .'* **false**'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'Data' => [
+ 'description' => 'The information about the workspace.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'Status' => [
+ 'description' => 'The status of the workspace. Valid values:'."\n"
+ ."\n"
+ .'* **0**: AVAILABLE, which indicates that the workspace runs as expected.'."\n"
+ .'* **1**: DELETED, which indicates that the workspace is deleted.'."\n"
+ .'* **2**: INITIALIZING, which indicates that the workspace is being initialized.'."\n"
+ .'* **3**: INIT_FAILED, which indicates that the workspace fails to be initialized.'."\n"
+ .'* **4**: FORBIDDEN, which indicates that the workspace is manually disabled.'."\n"
+ .'* **5**: DELETING, which indicates that the workspace is being deleted.'."\n"
+ .'* **6**: DEL_FAILED, which indicates that the workspace fails to be deleted.'."\n"
+ .'* **7**: FROZEN, which indicates that the workspace is frozen due to overdue payments.'."\n"
+ .'* **8**: UPDATING, which indicates that the workspace is being updated. The workspace enters this state after you associate a new compute engine with the workspace and the compute engine is initialized.'."\n"
+ .'* **9**: UPDATE_FAILED, which indicates that the workspace fails to be updated.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '0',
+ ],
+ 'MaxFlowNode' => [
+ 'description' => 'This parameter is deprecated.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '1',
+ ],
+ 'ProjectId' => [
+ 'description' => 'The ID of the workspace.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '27',
+ ],
+ 'IsAllowDownload' => [
+ 'description' => 'Indicates whether you are allowed to download the query result from DataStudio. Valid values:'."\n"
+ ."\n"
+ .'* **1**: You are allowed to download the query result from DataStudio.'."\n"
+ .'* **0**: You are not allowed to download the query result from DataStudio.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '1',
+ ],
+ 'ProjectMode' => [
+ 'description' => 'The mode of the workspace. Valid values:'."\n"
+ ."\n"
+ .'* **2**: The workspace is in basic mode.'."\n"
+ .'* **3**: The workspace is in standard mode.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '2',
+ ],
+ 'GmtModified' => [
+ 'description' => 'The time when the workspace was last modified. Example: `Dec 3, 2019 9:12:20 PM`.'."\n",
+ 'type' => 'string',
+ 'example' => 'Dec 3, 2019 9:12:20 PM',
+ ],
+ 'ProdStorageQuota' => [
+ 'description' => 'This parameter is deprecated.'."\n",
+ 'type' => 'string',
+ 'example' => ' 1',
+ ],
+ 'ProjectDescription' => [
+ 'description' => 'The description of the workspace.'."\n",
+ 'type' => 'string',
+ 'example' => 'abc',
+ ],
+ 'DevelopmentType' => [
+ 'description' => 'This parameter is deprecated.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '4',
+ ],
+ 'TablePrivacyMode' => [
+ 'description' => 'Indicates whether the MaxCompute tables in the workspace are visible to the users within a tenant. Valid values:'."\n"
+ ."\n"
+ .'* **0**: invisible'."\n"
+ .'* **1**: visible'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '1',
+ ],
+ 'DefaultDiResourceGroupIdentifier' => [
+ 'description' => 'The ID of the resource group that was allocated by default when you purchased an exclusive resource group for MaxCompute.'."\n",
+ 'type' => 'string',
+ 'example' => 'group_280749521****',
+ ],
+ 'SchedulerMaxRetryTimes' => [
+ 'description' => 'The default maximum number of automatic reruns that are allowed after an error occurs.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '3',
+ ],
+ 'ProtectedMode' => [
+ 'description' => 'Indicates whether the workspace protection feature is enabled. Valid values:'."\n"
+ ."\n"
+ .'* **1**: enabled'."\n"
+ .'* **0**: disabled'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '1',
+ ],
+ 'SchedulerRetryInterval' => [
+ 'description' => 'The default interval between automatic reruns after an error occurs. Unit: milliseconds. The maximum interval is 30 minutes. You must pay attention to the conversion between units.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '120000',
+ ],
+ 'Appkey' => [
+ 'description' => 'This parameter is deprecated.'."\n",
+ 'type' => 'string',
+ 'example' => '0',
+ ],
+ 'DevStorageQuota' => [
+ 'description' => 'This parameter is deprecated.'."\n",
+ 'type' => 'string',
+ 'example' => '0',
+ ],
+ 'ResidentArea' => [
+ 'description' => 'The type of the workspace. Valid values:'."\n"
+ ."\n"
+ .'* **private**'."\n"
+ .'* **swap**'."\n",
+ 'type' => 'string',
+ 'example' => 'private',
+ ],
+ 'IsDefault' => [
+ 'description' => 'Indicates whether the workspace is a default workspace. Valid values:'."\n"
+ ."\n"
+ .'* **1**: The workspace is a default workspace.'."\n"
+ .'* **0**: The workspace is not a default workspace.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '1',
+ ],
+ 'Destination' => [
+ 'description' => 'This parameter is deprecated.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '0',
+ ],
+ 'ProjectName' => [
+ 'description' => 'The display name of the workspace.'."\n",
+ 'type' => 'string',
+ 'example' => 'abc',
+ ],
+ 'ProjectIdentifier' => [
+ 'description' => 'The name of the workspace.'."\n",
+ 'type' => 'string',
+ 'example' => 'abc',
+ ],
+ 'DisableDevelopment' => [
+ 'description' => 'Indicates whether the Develop role is disabled. Valid values:'."\n"
+ ."\n"
+ .'* **false** (default)'."\n"
+ .'* **true**'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'ProjectOwnerBaseId' => [
+ 'description' => 'The ID of the Alibaba Cloud account used by the workspace owner.'."\n",
+ 'type' => 'string',
+ 'example' => '18229311****',
+ ],
+ 'BaseProject' => [
+ 'description' => 'This parameter is deprecated.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'false',
+ ],
+ 'UseProxyOdpsAccount' => [
+ 'description' => 'Indicates whether a proxy account is used to access the MaxCompute compute engine associated with the workspace.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'GmtCreate' => [
+ 'description' => 'The time when the workspace was created. Example: `Dec 3, 2019 9:12:20 PM`.'."\n",
+ 'type' => 'string',
+ 'example' => 'Oct 10, 2019 3:42:53 PM',
+ ],
+ 'TenantId' => [
+ 'description' => 'The tenant ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '280749521',
+ ],
+ 'EnvTypes' => [
+ 'description' => 'The environment information of the workspace.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The environment of the workspace. Valid values: PROD and DEV.'."\n"
+ ."\n"
+ .'* The value **PROD** indicates the production environment. Workspaces in basic mode provide only the production environment.'."\n"
+ .'* The value **DEV** indicates the development environment. Workspaces in standard mode provide both the development environment and the production environment.'."\n",
+ 'type' => 'string',
+ 'example' => '["PROD"]',
+ ],
+ ],
+ 'ResourceManagerResourceGroupId' => [
+ 'description' => 'The resource group ID.'."\n",
+ 'type' => 'string',
+ 'example' => 'rg-acfmzbn7pti3zfa',
+ ],
+ 'Tags' => [
+ 'description' => 'The tags added to the workspace.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '',
+ 'type' => 'object',
+ 'properties' => [
+ 'Key' => [
+ 'description' => 'The tag key.'."\n",
+ 'type' => 'string',
+ 'example' => 'Env',
+ ],
+ 'Value' => [
+ 'description' => 'The tag value.'."\n",
+ 'type' => 'string',
+ 'example' => 'Test',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'errorCodes' => [
+ 400 => [
+ [
+ 'errorCode' => 'Invalid.Tenant.ProjectNotExists',
+ 'errorMessage' => 'The project does not exist.',
+ ],
+ [
+ 'errorCode' => 'Invalid.Tenant.UserNotInProject',
+ 'errorMessage' => 'The user is not in the project.',
+ ],
+ ],
+ 403 => [
+ [
+ 'errorCode' => 'Invalid.Tenant.UserIsNotProjectOwnerOrAdmin',
+ 'errorMessage' => 'The user is not a project administrator or owner.',
+ ],
+ [
+ 'errorCode' => 'Invalid.Tenant.UserNotInTenant',
+ 'errorMessage' => 'The user is not in tenant.',
+ ],
+ ],
+ ],
+ 'staticInfo' => [
+ 'returnType' => 'synchronous',
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"1AFAE64E-D1BE-432B-A9****\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"Status\\": 0,\\n \\"MaxFlowNode\\": 1,\\n \\"ProjectId\\": 466230,\\n \\"IsAllowDownload\\": 1,\\n \\"ProjectMode\\": 2,\\n \\"GmtModified\\": \\"Dec 3, 2019 9:12:20 PM\\",\\n \\"ProdStorageQuota\\": \\" 1\\",\\n \\"ProjectDescription\\": \\"test_describe\\",\\n \\"DevelopmentType\\": 4,\\n \\"TablePrivacyMode\\": 1,\\n \\"DefaultDiResourceGroupIdentifier\\": \\"group_280749521****\\",\\n \\"SchedulerMaxRetryTimes\\": 3,\\n \\"ProtectedMode\\": 1,\\n \\"SchedulerRetryInterval\\": 120000,\\n \\"Appkey\\": \\"0\\",\\n \\"DevStorageQuota\\": \\"0\\",\\n \\"ResidentArea\\": \\"private\\",\\n \\"IsDefault\\": 1,\\n \\"Destination\\": 0,\\n \\"ProjectName\\": \\"test_project\\",\\n \\"ProjectIdentifier\\": \\"test_project\\",\\n \\"DisableDevelopment\\": true,\\n \\"ProjectOwnerBaseId\\": \\"18229311****\\",\\n \\"BaseProject\\": false,\\n \\"UseProxyOdpsAccount\\": true,\\n \\"GmtCreate\\": \\"Oct 10, 2019 3:42:53 PM\\",\\n \\"TenantId\\": 280749521,\\n \\"EnvTypes\\": [\\n \\"[\\\\\\"PROD\\\\\\"]\\"\\n ],\\n \\"ResourceManagerResourceGroupId\\": \\"rg-acfmzbn7****\\",\\n \\"Tags\\": [\\n {\\n \\"Key\\": \\"key\\",\\n \\"Value\\": \\"value\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<GetProjectResponse>\\n <HttpStatusCode>200</HttpStatusCode>\\n <RequestId>0bc1411515937635973****</RequestId>\\n <Success>true</Success>\\n <Data>\\n <Status>0</Status>\\n <MaxFlowNode>1</MaxFlowNode>\\n <ProjectId>27</ProjectId>\\n <IsAllowDownload>1</IsAllowDownload>\\n <ProjectMode>2</ProjectMode>\\n <GmtModified>Dec 3, 2019 9:12:20 PM</GmtModified>\\n <ProdStorageQuota> 1</ProdStorageQuota>\\n <ProjectDescription>abc</ProjectDescription>\\n <DevelopmentType>4</DevelopmentType>\\n <TablePrivacyMode>1</TablePrivacyMode>\\n <DefaultDiResourceGroupIdentifier>group_280749521****</DefaultDiResourceGroupIdentifier>\\n <SchedulerMaxRetryTimes>3</SchedulerMaxRetryTimes>\\n <ProtectedMode>1</ProtectedMode>\\n <SchedulerRetryInterval>120000</SchedulerRetryInterval>\\n <Appkey>0</Appkey>\\n <DevStorageQuota>0</DevStorageQuota>\\n <ResidentArea>private</ResidentArea>\\n <IsDefault>1</IsDefault>\\n <Destination>0</Destination>\\n <ProjectName>abc</ProjectName>\\n <ProjectIdentifier>abc</ProjectIdentifier>\\n <DisableDevelopment>true</DisableDevelopment>\\n <ProjectOwnerBaseId>18229311****</ProjectOwnerBaseId>\\n <BaseProject>false</BaseProject>\\n <UseProxyOdpsAccount>true</UseProxyOdpsAccount>\\n <GmtCreate>Oct 10, 2019 3:42:53 PM</GmtCreate>\\n <TenantId>280749521</TenantId>\\n <EnvTypes>[\\"PROD\\"]</EnvTypes>\\n <ResourceManagerResourceGroupId>rg-acfmzbn7pti3zfa</ResourceManagerResourceGroupId>\\n <Tags>\\n <Key>Env</Key>\\n <Value>Test</Value>\\n </Tags>\\n </Data>\\n</GetProjectResponse>","errorExample":""}]',
+ 'title' => 'GetProject',
+ 'requestParamsDescription' => ' ',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ ],
+ 'AddProjectMemberToRole' => [
+ 'methods' => [
+ 'post',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'write',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'create',
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'ProjectId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The DataWorks workspace ID. You can call the [ListProjects](~~2780068~~) operation to query the ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => true,
+ 'docRequired' => true,
+ 'maximum' => '10000000',
+ 'minimum' => '0',
+ 'example' => '27',
+ ],
+ ],
+ [
+ 'name' => 'UserId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The Alibaba Cloud account ID. You can log on to the [DataWorks console](https://workbench.data.aliyun.com/console) and move the pointer over the profile picture in the upper-right corner to view the ID.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => '1234',
+ ],
+ ],
+ [
+ 'name' => 'RoleCode',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The code of the role that you want to assign to a member of the DataWorks workspace. You can call the [ListProjectRoles](~~2780079~~) operation to query the codes of all roles in a DataWorks workspace.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'role_project_guest',
+ ],
+ ],
+ [
+ 'name' => 'ClientToken',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The client token that is used to ensure the idempotence of the request. We recommend that you set this parameter to a UUID. This parameter is used to uniquely identify the API operation call.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => '1AFAE64E-D1BE-432B-A9*****',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'description' => 'The response parameters.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'description' => 'The request ID.'."\n",
+ 'type' => 'string',
+ 'example' => '1AFAE64E-D1BE-432B-A9****',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'errorCodes' => [
+ 400 => [
+ [
+ 'errorCode' => 'Invalid.Tenant.ConnectionNotExists',
+ 'errorMessage' => 'The connection does not exist.',
+ ],
+ [
+ 'errorCode' => 'Invalid.Tenant.ProjectNotExists',
+ 'errorMessage' => 'The project does not exist.',
+ ],
+ [
+ 'errorCode' => 'Invalid.Tenant.UserNotInProject',
+ 'errorMessage' => 'The user is not in the project.',
+ ],
+ ],
+ 403 => [
+ [
+ 'errorCode' => 'Invalid.Tenant.UserIsNotProjectOwnerOrAdmin',
+ 'errorMessage' => 'The user is not a project administrator or owner.',
+ ],
+ [
+ 'errorCode' => 'Invalid.Tenant.UserNotInTenant',
+ 'errorMessage' => 'The user is not in tenant.',
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"1AFAE64E-D1BE-432B-A9****\\"\\n}","errorExample":""},{"type":"xml","example":"<AddProjectMemberToRoleResponse>\\n <RequestId>1AFAE64E-D1BE-432B-A9****</RequestId>\\n</AddProjectMemberToRoleResponse>","errorExample":""}]',
+ 'title' => 'AddProjectMemberToRole',
+ 'summary' => 'Assigns a role to a member of a DataWorks workspace. Before you call this operation, you must add your account to a DataWorks workspace as a member.',
+ 'description' => '* For information about how to add an account to a DataWorks workspace as a member, see [Add workspace members and assign roles to them](~~136941~~).'."\n"
+ .'* If you assign a built-in workspace-level role to a member of a DataWorks workspace, the member is automatically granted the permissions of the mapped role of the MaxCompute compute engine in the development environment. For more information, see [Appendix: Mappings between the built-in workspace-level roles of DataWorks and the roles of MaxCompute](~~449397~~).'."\n",
+ 'requestParamsDescription' => ' ',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ ],
+ 'CreateProjectMember' => [
+ 'methods' => [
+ 'post',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'write',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'create',
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'ProjectId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The DataWorks workspace ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => true,
+ 'docRequired' => true,
+ 'maximum' => '100000000',
+ 'minimum' => '0',
+ 'example' => '27',
+ ],
+ ],
+ [
+ 'name' => 'UserId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the user to be added.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => '1234',
+ ],
+ ],
+ [
+ 'name' => 'ClientToken',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The client token that is used to ensure the idempotence of the request. We recommend that you set this parameter to a UUID.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => '1AFAE64E-D1BE-432B-A9****',
+ ],
+ ],
+ [
+ 'name' => 'RoleCode',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The code of the role. This parameter is optional. If you configure the RoleCode parameter, the user is assigned the role.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'role_project_guest',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'description' => 'The response parameters.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'description' => 'The request ID.'."\n",
+ 'type' => 'string',
+ 'example' => '1AFAE64E-D1BE-432B-A9****',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'errorCodes' => [
+ 400 => [
+ [
+ 'errorCode' => 'Invalid.Tenant.ConnectionNotExists',
+ 'errorMessage' => 'The connection does not exist.',
+ ],
+ [
+ 'errorCode' => 'Invalid.Tenant.ProjectNotExists',
+ 'errorMessage' => 'The project does not exist.',
+ ],
+ [
+ 'errorCode' => 'Invalid.Tenant.UserNotInProject',
+ 'errorMessage' => 'The user is not in the project.',
+ ],
+ [
+ 'errorCode' => 'Invalid.Tenant.UserAlreadyInProject',
+ 'errorMessage' => 'The user already exists in the project.',
+ ],
+ [
+ 'errorCode' => 'Invalid.Tenant.UserNotInTenant',
+ 'errorMessage' => 'The user is not in the tenant.',
+ ],
+ ],
+ 403 => [
+ [
+ 'errorCode' => 'Invalid.Tenant.UserIsNotProjectOwnerOrAdmin',
+ 'errorMessage' => 'The user is not a project administrator or owner.',
+ ],
+ [
+ 'errorCode' => 'Invalid.Tenant.UserNotInTenant',
+ 'errorMessage' => 'The user is not in tenant.',
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"1AFAE64E-D1BE-432B-A9****\\"\\n}","errorExample":""},{"type":"xml","example":"<CreateProjectMemberResponse>\\n <RequestId>1AFAE64E-D1BE-432B-A9****</RequestId>\\n</CreateProjectMemberResponse>","errorExample":""}]',
+ 'title' => 'CreateProjectMember',
+ 'summary' => 'Adds a user to a DataWorks workspace.',
+ 'requestParamsDescription' => ' ',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ ],
+ 'DeleteProjectMember' => [
+ 'methods' => [
+ 'post',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'write',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'delete',
+ 'abilityTreeCode' => '78212',
+ 'abilityTreeNodes' => [
+ 'FEATUREdideZ4P4R1',
+ ],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'ProjectId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the DataWorks workspace. You can log on to the [DataWorks console](https://workbench.data.aliyun.com/console) and go to the Workspace page to obtain the workspace ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => true,
+ 'docRequired' => true,
+ 'maximum' => '100000000',
+ 'minimum' => '0',
+ 'example' => '27',
+ ],
+ ],
+ [
+ 'name' => 'UserId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The user ID.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => '1234',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'description' => 'The response parameters.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'description' => 'The request ID.'."\n",
+ 'type' => 'string',
+ 'example' => '1AFAE64E-D1BE-432B-A9****',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'errorCodes' => [
+ 400 => [
+ [
+ 'errorCode' => 'Invalid.Tenant.ConnectionNotExists',
+ 'errorMessage' => 'The connection does not exist.',
+ ],
+ [
+ 'errorCode' => 'Invalid.Tenant.ProjectNotExists',
+ 'errorMessage' => 'The project does not exist.',
+ ],
+ [
+ 'errorCode' => 'Invalid.Tenant.UserAlreadyInProject',
+ 'errorMessage' => 'The user already exists in the project.',
+ ],
+ [
+ 'errorCode' => 'Invalid.Tenant.UserNotInTenant',
+ 'errorMessage' => 'The user is not in the tenant.',
+ ],
+ ],
+ 403 => [
+ [
+ 'errorCode' => 'Invalid.Tenant.UserIsNotProjectOwnerOrAdmin',
+ 'errorMessage' => 'The user is not a project administrator or owner.',
+ ],
+ [
+ 'errorCode' => 'Invalid.Tenant.UserNotInTenant',
+ 'errorMessage' => 'The user is not in tenant.',
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"1AFAE64E-D1BE-432B-A9****\\"\\n}","errorExample":""},{"type":"xml","example":"<DeleteProjectMemberResponse>\\n <RequestId>1AFAE64E-D1BE-432B-A9****</RequestId>\\n</DeleteProjectMemberResponse>","errorExample":""}]',
+ 'title' => 'DeleteProjectMember',
+ 'summary' => 'Removes a user from a DataWorks workspace.',
+ 'requestParamsDescription' => ' ',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ ],
+ 'ListProjectRoles' => [
+ 'methods' => [
+ 'post',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'get',
+ 'abilityTreeCode' => '78327',
+ 'abilityTreeNodes' => [
+ 'FEATUREdideL60QLN',
+ ],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'ProjectId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the DataWorks workspace.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => true,
+ 'docRequired' => true,
+ 'maximum' => '1000000',
+ 'minimum' => '0',
+ 'example' => '27',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'description' => 'The response parameters.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'description' => 'The request ID.'."\n",
+ 'type' => 'string',
+ 'example' => '1AFAE64E-D1BE-432B-A9****',
+ ],
+ 'ProjectRoleList' => [
+ 'description' => 'The roles in the DataWorks workspace.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '',
+ 'type' => 'object',
+ 'properties' => [
+ 'ProjectRoleId' => [
+ 'description' => 'The ID of the role in the DataWorks workspace.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '1',
+ ],
+ 'ProjectRoleType' => [
+ 'description' => 'The type of the role in the DataWorks workspace.'."\n",
+ 'type' => 'string',
+ 'example' => '0',
+ ],
+ 'ProjectRoleName' => [
+ 'description' => 'The name of the role in the DataWorks workspace.'."\n",
+ 'type' => 'string',
+ 'example' => 'visitor',
+ ],
+ 'ProjectRoleCode' => [
+ 'description' => 'The code of the role in the DataWorks workspace.'."\n",
+ 'type' => 'string',
+ 'example' => 'role_project_guest',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'errorCodes' => [
+ 400 => [
+ [
+ 'errorCode' => 'Invalid.Tenant.ConnectionNotExists',
+ 'errorMessage' => 'The connection does not exist.',
+ ],
+ [
+ 'errorCode' => 'Invalid.Tenant.ProjectNotExists',
+ 'errorMessage' => 'The project does not exist.',
+ ],
+ [
+ 'errorCode' => 'Invalid.Tenant.UserNotInProject',
+ 'errorMessage' => 'The user is not in the project.',
+ ],
+ ],
+ 403 => [
+ [
+ 'errorCode' => 'Invalid.Tenant.UserIsNotProjectOwnerOrAdmin',
+ 'errorMessage' => 'The user is not a project administrator or owner.',
+ ],
+ [
+ 'errorCode' => 'Invalid.Tenant.UserNotInTenant',
+ 'errorMessage' => 'The user is not in tenant.',
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"1AFAE64E-D1BE-432B-A9****\\",\\n \\"ProjectRoleList\\": [\\n {\\n \\"ProjectRoleId\\": 1,\\n \\"ProjectRoleType\\": \\"0\\",\\n \\"ProjectRoleName\\": \\"访客\\",\\n \\"ProjectRoleCode\\": \\"role_project_guest\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<ListProjectRolesResponse>\\n <RequestId>1AFAE64E-D1BE-432B-A9****</RequestId>\\n <ProjectRoleList>\\n <ProjectRoleId>1</ProjectRoleId>\\n <ProjectRoleType>0</ProjectRoleType>\\n <ProjectRoleName>访客</ProjectRoleName>\\n <ProjectRoleCode>role_project_guest</ProjectRoleCode>\\n </ProjectRoleList>\\n</ListProjectRolesResponse>","errorExample":""}]',
+ 'title' => 'ListProjectRoles',
+ 'summary' => 'Queries a list of roles in a DataWorks workspace.',
+ 'description' => '## Debugging'."\n"
+ ."\n"
+ .'[OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.](https://api.aliyun.com/#product=dataworks-public\\&api=ListProjectRoles\\&type=RPC\\&version=2020-05-18)'."\n",
+ 'requestParamsDescription' => ' ',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ ],
+ 'RemoveProjectMemberFromRole' => [
+ 'methods' => [
+ 'post',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'write',
+ 'deprecated' => false,
+ 'systemTags' => [],
+ 'parameters' => [
+ [
+ 'name' => 'ProjectId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The DataWorks workspace ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => true,
+ 'docRequired' => true,
+ 'maximum' => '10000000',
+ 'minimum' => '0',
+ 'example' => '27',
+ ],
+ ],
+ [
+ 'name' => 'UserId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The user ID.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => '1234',
+ ],
+ ],
+ [
+ 'name' => 'RoleCode',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The code of the role in the DataWorks workspace. You can call the ListProjectRoles operation to query the codes of all roles in a DataWorks workspace. Valid values:'."\n"
+ ."\n"
+ .'* role_project_owner: workspace owner'."\n"
+ .'* role_project_admin: workspace administrator'."\n"
+ .'* role_project_dev: developer'."\n"
+ .'* role_project_pe: O\\&M engineer'."\n"
+ .'* role_project_deploy: deployment expert'."\n"
+ .'* role_project_guest: visitor'."\n"
+ .'* role_project_security: security administrator'."\n"
+ .'* role_project_tester: experiencer'."\n"
+ .'* role_project_erd: model designer'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'role_project_guest',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'description' => 'The response parameters.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'description' => 'The request ID.'."\n",
+ 'type' => 'string',
+ 'example' => '1AFAE64E-D1BE-432B-A9****',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'errorCodes' => [
+ 400 => [
+ [
+ 'errorCode' => 'Invalid.Tenant.ConnectionNotExists',
+ 'errorMessage' => 'The connection does not exist.',
+ ],
+ [
+ 'errorCode' => 'Invalid.Tenant.ProjectNotExists',
+ 'errorMessage' => 'The project does not exist.',
+ ],
+ [
+ 'errorCode' => 'Invalid.Tenant.UserNotInProject',
+ 'errorMessage' => 'The user is not in the project.',
+ ],
+ ],
+ 403 => [
+ [
+ 'errorCode' => 'Invalid.Tenant.UserIsNotProjectOwnerOrAdmin',
+ 'errorMessage' => 'The user is not a project administrator or owner.',
+ ],
+ [
+ 'errorCode' => 'Invalid.Tenant.UserNotInTenant',
+ 'errorMessage' => 'The user is not in tenant.',
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"1AFAE64E-D1BE-432B-A9****\\"\\n}","errorExample":""},{"type":"xml","example":"<RemoveProjectMemberFromRoleResponse>\\n <RequestId>1AFAE64E-D1BE-432B-A9****</RequestId>\\n</RemoveProjectMemberFromRoleResponse>","errorExample":""}]',
+ 'title' => 'RemoveProjectMemberFromRole',
+ 'summary' => 'Removes a role from a user in a DataWorks workspace.',
+ 'requestParamsDescription' => ' ',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ ],
+ 'ListProjectMembers' => [
+ 'methods' => [
+ 'post',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'get',
+ 'abilityTreeCode' => '78326',
+ 'abilityTreeNodes' => [
+ 'FEATUREdideL60QLN',
+ ],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'ProjectId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the DataWorks workspace.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => true,
+ 'docRequired' => true,
+ 'maximum' => '10000000',
+ 'minimum' => '0',
+ 'example' => '27',
+ ],
+ ],
+ [
+ 'name' => 'PageNumber',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The page number. Valid values: 1 to 30. Default value: 1.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => false,
+ 'maximum' => '10000',
+ 'minimum' => '1',
+ 'example' => '1',
+ 'default' => '1',
+ ],
+ ],
+ [
+ 'name' => 'PageSize',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The number of entries per page. Default value: 10. Maximum value: 100.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => false,
+ 'maximum' => '20',
+ 'minimum' => '5',
+ 'example' => '10',
+ 'default' => '10',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'description' => 'The response parameters.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'description' => 'The request ID.'."\n",
+ 'type' => 'string',
+ 'example' => '1AFAE64E-D1BE-432B-A9****',
+ ],
+ 'Data' => [
+ 'description' => 'The returned results.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'PageNumber' => [
+ 'description' => 'The page number.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '1',
+ ],
+ 'PageSize' => [
+ 'description' => 'The number of entries per page.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '10',
+ ],
+ 'TotalCount' => [
+ 'description' => 'The total number of entries returned.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '3',
+ ],
+ 'ProjectMemberList' => [
+ 'description' => 'The information about members in the DataWorks workspace.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '',
+ 'type' => 'object',
+ 'properties' => [
+ 'Status' => [
+ 'description' => 'The status of the member. Valid values:'."\n"
+ ."\n"
+ .'* 0: NORMAL, which indicates that the member is in a normal state.'."\n"
+ .'* 1: FORBIDDEN, which indicates that the member is disabled.'."\n"
+ .'* 2: DELETED, which indicates that the member is deleted.'."\n",
+ 'type' => 'string',
+ 'example' => '0',
+ ],
+ 'ProjectMemberId' => [
+ 'description' => 'The member ID.'."\n",
+ 'type' => 'string',
+ 'example' => '121',
+ ],
+ 'Nick' => [
+ 'description' => 'The nickname of the member.'."\n",
+ 'type' => 'string',
+ 'example' => 'zhangsan',
+ ],
+ 'ProjectMemberName' => [
+ 'description' => 'The name of the member.'."\n",
+ 'type' => 'string',
+ 'example' => 'zhangsan',
+ ],
+ 'ProjectMemberType' => [
+ 'description' => 'The type of the member. Valid values:'."\n"
+ ."\n"
+ .'* 1: USER_ALIYUN, which indicates that the member is an Alibaba Cloud account.'."\n"
+ .'* 5: USER_UBACCOUNT, which indicates that the member is a RAM user.'."\n"
+ .'* 6: USER_STS_ROLE, which indicates that the member is a RAM role.'."\n",
+ 'type' => 'string',
+ 'example' => '1',
+ ],
+ 'ProjectRoleList' => [
+ 'description' => 'The roles that are assigned to the member.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '',
+ 'type' => 'object',
+ 'properties' => [
+ 'ProjectRoleId' => [
+ 'description' => 'The role ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '1',
+ ],
+ 'ProjectRoleType' => [
+ 'description' => 'The type of the role. Valid values:'."\n"
+ ."\n"
+ .'* 0: SYSTEM, which indicates that the role is a built-in role.'."\n"
+ .'* 2: USER_CUSTOM, which indicates that the role is a custom role.'."\n",
+ 'type' => 'string',
+ 'example' => '0',
+ ],
+ 'ProjectRoleName' => [
+ 'description' => 'The name of the role. DataWorks provides built-in roles and allows you to create custom roles based on your business requirements. For more information about roles, see [Overview of users, roles, and permissions](~~295463~~).'."\n",
+ 'type' => 'string',
+ 'example' => 'test',
+ ],
+ 'ProjectRoleCode' => [
+ 'description' => 'The code of the role. DataWorks provides built-in roles and allows you to create custom roles based on your business requirements. For more information about roles, see [Overview of users, roles, and permissions](~~295463~~).'."\n",
+ 'type' => 'string',
+ 'example' => 'role_project_guest',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'errorCodes' => [
+ 400 => [
+ [
+ 'errorCode' => 'Invalid.Tenant.ConnectionNotExists',
+ 'errorMessage' => 'The connection does not exist.',
+ ],
+ [
+ 'errorCode' => 'Invalid.Tenant.ProjectNotExists',
+ 'errorMessage' => 'The project does not exist.',
+ ],
+ [
+ 'errorCode' => 'Invalid.Tenant.UserNotInProject',
+ 'errorMessage' => 'The user is not in the project.',
+ ],
+ ],
+ 403 => [
+ [
+ 'errorCode' => 'Invalid.Tenant.UserIsNotProjectOwnerOrAdmin',
+ 'errorMessage' => 'The user is not a project administrator or owner.',
+ ],
+ [
+ 'errorCode' => 'Invalid.Tenant.UserNotInTenant',
+ 'errorMessage' => 'The user is not in tenant.',
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"1AFAE64E-D1BE-432B-A9****\\",\\n \\"Data\\": {\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 3,\\n \\"ProjectMemberList\\": [\\n {\\n \\"Status\\": \\"0\\",\\n \\"ProjectMemberId\\": \\"121\\",\\n \\"Nick\\": \\"zhangsan\\",\\n \\"ProjectMemberName\\": \\"张三\\",\\n \\"ProjectMemberType\\": \\"1\\",\\n \\"ProjectRoleList\\": [\\n {\\n \\"ProjectRoleId\\": 1,\\n \\"ProjectRoleType\\": \\"0\\",\\n \\"ProjectRoleName\\": \\"访客\\",\\n \\"ProjectRoleCode\\": \\"role_project_guest\\"\\n }\\n ]\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<ListProjectMembersResponse>\\n <RequestId>1AFAE64E-D1BE-432B-A9****</RequestId>\\n <Data>\\n <PageNumber>1</PageNumber>\\n <PageSize>10</PageSize>\\n <TotalCount>3</TotalCount>\\n <ProjectMemberList>\\n <Status>0</Status>\\n <ProjectMemberId>121</ProjectMemberId>\\n <Nick>zhangsan</Nick>\\n <ProjectMemberName>张三</ProjectMemberName>\\n <ProjectMemberType>1</ProjectMemberType>\\n <ProjectRoleList>\\n <ProjectRoleId>1</ProjectRoleId>\\n <ProjectRoleType>0</ProjectRoleType>\\n <ProjectRoleName>访客</ProjectRoleName>\\n <ProjectRoleCode>role_project_guest</ProjectRoleCode>\\n </ProjectRoleList>\\n </ProjectMemberList>\\n </Data>\\n</ListProjectMembersResponse>","errorExample":""}]',
+ 'title' => 'ListProjectMembers',
+ 'summary' => 'Queries a list of existing members in a DataWorks workspace.',
+ 'requestParamsDescription' => ' ',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ ],
+ 'ListProjects' => [
+ 'summary' => 'Queries a list of DataWorks workspaces of the tenant to which a user belongs.',
+ 'methods' => [
+ 'post',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'get',
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'PageNumber',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The page number. Valid values: 1 to 100.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => false,
+ 'docRequired' => true,
+ 'maximum' => '10000000',
+ 'minimum' => '1',
+ 'example' => '1',
+ 'default' => '1',
+ ],
+ ],
+ [
+ 'name' => 'PageSize',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The number of entries per page. Default value: 10. Maximum value: 100.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => false,
+ 'maximum' => '10000000',
+ 'minimum' => '1',
+ 'example' => '10',
+ 'default' => '10',
+ ],
+ ],
+ [
+ 'name' => 'ResourceManagerResourceGroupId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The resource group ID.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'rg-acfmzbn7pti3zfa',
+ ],
+ ],
+ [
+ 'name' => 'Tags',
+ 'in' => 'query',
+ 'style' => 'json',
+ 'schema' => [
+ 'description' => 'The tags to add to the workspace.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '',
+ 'type' => 'object',
+ 'properties' => [
+ 'Key' => [
+ 'description' => 'The key of tag N to add to the workspace.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'Env',
+ ],
+ 'Value' => [
+ 'description' => 'The value of tag N to add to the workspace.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'Test',
+ ],
+ ],
+ 'required' => false,
+ ],
+ 'required' => false,
+ 'maxItems' => 20,
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'description' => 'The response parameters.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'description' => 'The request ID.'."\n",
+ 'type' => 'string',
+ 'example' => '20658801***',
+ ],
+ 'PageResult' => [
+ 'description' => 'The results that are returned.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'PageNumber' => [
+ 'description' => 'The page number.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '1',
+ ],
+ 'PageSize' => [
+ 'description' => 'The number of entries per page. Default value: 10. Maximum value: 100.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '10',
+ ],
+ 'TotalCount' => [
+ 'description' => 'The total number of entries returned.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '123',
+ ],
+ 'ProjectList' => [
+ 'description' => 'The DataWorks workspaces.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '',
+ 'type' => 'object',
+ 'properties' => [
+ 'ProjectStatusCode' => [
+ 'description' => 'The status code of the workspace. Valid values:'."\n"
+ ."\n"
+ .'* AVAILABLE: 0, which indicates that the workspace is running as expected.'."\n"
+ .'* DELETED: 1, which indicates that the workspace is deleted.'."\n"
+ .'* INITIALIZING: 2, which indicates that the workspace is being initialized.'."\n"
+ .'* INIT_FAILED: 3, which indicates that the workspace fails to be initialized.'."\n"
+ .'* FORBIDDEN: 4, which indicates that the workspace is manually disabled.'."\n"
+ .'* DELETING: 5, which indicates that the workspace is being deleted.'."\n"
+ .'* DEL_FAILED: 6, which indicates that the workspace fails to be deleted.'."\n"
+ .'* FROZEN: 7, which indicates that the workspace is frozen due to overdue payments.'."\n"
+ .'* UPDATING: 8, which indicates that the workspace is being updated. After you associate a compute engine with the workspace, the system initializes the compute engine and updates the workspace.'."\n"
+ .'* UPDATE_FAILED: 9, which indicates that the workspace fails to be updated.'."\n",
+ 'type' => 'string',
+ 'example' => 'AVAILABLE',
+ ],
+ 'ProjectStatus' => [
+ 'description' => 'The status of the workspace. Valid values:'."\n"
+ ."\n"
+ .'* 0: AVAILABLE, which indicates that the workspace is running as expected.'."\n"
+ .'* 1: DELETED, which indicates that the workspace is deleted.'."\n"
+ .'* 2: INITIALIZING, which indicates that the workspace is being initialized.'."\n"
+ .'* 3: INIT_FAILED, which indicates that the workspace fails to be initialized.'."\n"
+ .'* 4: FORBIDDEN, which indicates that the workspace is manually disabled.'."\n"
+ .'* 5: DELETING, which indicates that the workspace is being deleted.'."\n"
+ .'* 6: DEL_FAILED, which indicates that the workspace fails to be deleted.'."\n"
+ .'* 7: FROZEN, which indicates that the workspace is frozen due to overdue payments.'."\n"
+ .'* 8: UPDATING, which indicates that the workspace is being updated. After you associate a compute engine with the workspace, the system initializes the compute engine and updates the workspace.'."\n"
+ .'* 9: UPDATE_FAILED, which indicates that the workspace fails to be updated.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '0',
+ ],
+ 'ProjectName' => [
+ 'description' => 'The display name of the workspace.'."\n",
+ 'type' => 'string',
+ 'example' => 'test_project',
+ ],
+ 'ProjectIdentifier' => [
+ 'description' => 'The name of the workspace.'."\n",
+ 'type' => 'string',
+ 'example' => 'test',
+ ],
+ 'ProjectId' => [
+ 'description' => 'The workspace ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '1212',
+ ],
+ 'ProjectDescription' => [
+ 'description' => 'The description of the workspace.'."\n",
+ 'type' => 'string',
+ 'example' => 'test_describe',
+ ],
+ 'ProjectOwnerBaseId' => [
+ 'description' => 'The ID of the user used by the workspace owner.'."\n",
+ 'type' => 'string',
+ 'example' => '122222',
+ ],
+ 'ResourceManagerResourceGroupId' => [
+ 'description' => 'The resource group ID.'."\n",
+ 'type' => 'string',
+ 'example' => 'rg-acfmzbn7pti3zfa',
+ ],
+ 'Tags' => [
+ 'description' => 'The tags added to the workspace.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '',
+ 'type' => 'object',
+ 'properties' => [
+ 'Key' => [
+ 'description' => 'The key of tag N added to the workspace.'."\n",
+ 'type' => 'string',
+ 'example' => 'Env',
+ ],
+ 'Value' => [
+ 'description' => 'The value of tag N added to the workspace.'."\n",
+ 'type' => 'string',
+ 'example' => 'Test',
+ ],
+ ],
+ ],
+ ],
+ 'DisableDevelopment' => [
+ 'description' => 'Indicates whether the Development role is disabled. Valid values:'."\n"
+ ."\n"
+ .'* **false**: enabled'."\n"
+ .'* **true**: disabled'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'UseProxyOdpsAccount' => [
+ 'description' => 'Indicates whether a proxy account is used to access the MaxCompute compute engine associated with the workspace. Valid values:'."\n"
+ ."\n"
+ .'* **false**'."\n"
+ .'* **true**'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'TablePrivacyMode' => [
+ 'description' => 'Indicates whether the MaxCompute tables in the workspace are visible to the users within a tenant. Valid values:'."\n"
+ ."\n"
+ .'* **0**: invisible'."\n"
+ .'* **1**: visible'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '1',
+ ],
+ 'IsDefault' => [
+ 'description' => 'Indicates whether the workspace is a default workspace. Valid values:'."\n"
+ ."\n"
+ .'* **1**: The workspace is a default workspace.'."\n"
+ .'* **0**: The workspace is not a default workspace.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '1',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'errorCodes' => [
+ 400 => [
+ [
+ 'errorCode' => 'Invalid.Tenant.ConnectionNotExists',
+ 'errorMessage' => 'The connection does not exist.',
+ ],
+ [
+ 'errorCode' => 'Invalid.Tenant.ProjectNotExists',
+ 'errorMessage' => 'The project does not exist.',
+ ],
+ [
+ 'errorCode' => 'Invalid.Tenant.UserAlreadyInProject',
+ 'errorMessage' => 'The user already exists in the project.',
+ ],
+ [
+ 'errorCode' => 'Invalid.Tenant.UserNotInProject',
+ 'errorMessage' => 'The user is not in the project.',
+ ],
+ ],
+ 403 => [
+ [
+ 'errorCode' => 'Invalid.Tenant.UserIsNotProjectOwnerOrAdmin',
+ 'errorMessage' => 'The user is not a project administrator or owner.',
+ ],
+ [
+ 'errorCode' => 'Invalid.Tenant.UserNotInTenant',
+ 'errorMessage' => 'The user is not in tenant.',
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"20658801****\\",\\n \\"PageResult\\": {\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 68,\\n \\"ProjectList\\": [\\n {\\n \\"ProjectStatusCode\\": \\"AVAILABLE\\",\\n \\"ProjectStatus\\": 0,\\n \\"ProjectName\\": \\"test_project\\",\\n \\"ProjectIdentifier\\": \\"test_project\\",\\n \\"ProjectId\\": 466230,\\n \\"ProjectDescription\\": \\"test_describe\\",\\n \\"ProjectOwnerBaseId\\": \\"13969939245****\\",\\n \\"ResourceManagerResourceGroupId\\": \\"rg-acfmzbn7****\\",\\n \\"Tags\\": [\\n {\\n \\"Key\\": \\"key\\",\\n \\"Value\\": \\"value\\"\\n }\\n ],\\n \\"DisableDevelopment\\": true,\\n \\"UseProxyOdpsAccount\\": true,\\n \\"TablePrivacyMode\\": 1,\\n \\"IsDefault\\": 1\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<ListProjectsResponse>\\n <RequestId>20658801***</RequestId>\\n <PageResult>\\n <PageNumber>1</PageNumber>\\n <PageSize>10</PageSize>\\n <TotalCount>123</TotalCount>\\n <ProjectList>\\n <ProjectStatusCode>AVAILABLE</ProjectStatusCode>\\n <ProjectStatus>0</ProjectStatus>\\n <ProjectName>测试空间</ProjectName>\\n <ProjectIdentifier>test</ProjectIdentifier>\\n <ProjectId>1212</ProjectId>\\n <ProjectDescription>测试空间</ProjectDescription>\\n <ProjectOwnerBaseId>122222</ProjectOwnerBaseId>\\n <ResourceManagerResourceGroupId>rg-acfmzbn7pti3zfa</ResourceManagerResourceGroupId>\\n <Tags>\\n <Key>Env</Key>\\n <Value>Test</Value>\\n </Tags>\\n <DisableDevelopment>true</DisableDevelopment>\\n <UseProxyOdpsAccount>true</UseProxyOdpsAccount>\\n <TablePrivacyMode>1</TablePrivacyMode>\\n <IsDefault>1</IsDefault>\\n </ProjectList>\\n </PageResult>\\n</ListProjectsResponse>","errorExample":""}]',
+ 'title' => 'ListProjects',
+ 'requestParamsDescription' => ' ',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ ],
+ 'ListProjectIds' => [
+ 'methods' => [
+ 'post',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'get',
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'UserId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the desired Alibaba Cloud account.'."\n"
+ ."\n"
+ .'You can log on to the [DataWorks](https://workbench.data.aliyun.com/console) console and move the pointer over the profile picture in the upper-right corner to view the ID.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => '171111',
+ 'maxLength' => 10000000,
+ 'minLength' => 0,
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'description' => 'The response parameters.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'description' => 'The request ID.'."\n",
+ 'type' => 'string',
+ 'example' => '0b57ff7216278945532771749d****',
+ ],
+ 'ProjectIds' => [
+ 'description' => 'The IDs of the DataWorks workspaces. The IDs of the workspaces on which the desired Alibaba Cloud account has permissions were returned.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The ID of the DataWorks workspace.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '75777',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'errorCodes' => [
+ 400 => [
+ [
+ 'errorCode' => 'Invalid.Tenant.ConnectionNotExists',
+ 'errorMessage' => 'The connection does not exist.',
+ ],
+ [
+ 'errorCode' => 'Invalid.Tenant.ProjectNotExists',
+ 'errorMessage' => 'The project does not exist.',
+ ],
+ [
+ 'errorCode' => 'Invalid.Tenant.UserNotInProject',
+ 'errorMessage' => 'The user is not in the project.',
+ ],
+ ],
+ 403 => [
+ [
+ 'errorCode' => 'Invalid.Tenant.UserIsNotProjectOwnerOrAdmin',
+ 'errorMessage' => 'The user is not a project administrator or owner.',
+ ],
+ [
+ 'errorCode' => 'Invalid.Tenant.UserNotInTenant',
+ 'errorMessage' => 'The user is not in tenant.',
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"0b57ff7216278945532771749d****\\",\\n \\"ProjectIds\\": [\\n 466230\\n ]\\n}","errorExample":""},{"type":"xml","example":"<ListProjectIdsResponse>\\n <RequestId>0b57ff7216278945532771749d****</RequestId>\\n <ProjectIds>466230</ProjectIds>\\n</ListProjectIdsResponse>","errorExample":""}]',
+ 'title' => 'ListProjectIds',
+ 'summary' => 'Queries the IDs of the workspaces on which a specific Alibaba Cloud account or RAM user has permissions in a specific region.',
+ 'description' => 'An Alibaba Cloud account can assume a role such as the developer, O\\&M engineer, or workspace administrator role in a workspace. For more information, see [Manage members and roles](~~136941~~).'."\n",
+ 'requestParamsDescription' => ' ',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ ],
+ 'CreateProject' => [
+ 'summary' => 'Creates a DataWorks workspace.',
+ 'methods' => [
+ 'post',
+ 'get',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'create',
+ 'abilityTreeCode' => '158574',
+ 'abilityTreeNodes' => [
+ 'FEATUREdideYNK30F',
+ ],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'ClientToken',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The client token that is used to ensure the idempotence of the request. This parameter can be left empty.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'ABFUOEUOTRTRJKE',
+ ],
+ ],
+ [
+ 'name' => 'ProjectName',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The display name of the workspace.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => 'test_project',
+ ],
+ ],
+ [
+ 'name' => 'ProjectDescription',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The description of the workspace.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'test_describe',
+ ],
+ ],
+ [
+ 'name' => 'DisableDevelopment',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'Specifies whether to disable the Develop role. Valid values:'."\n"
+ ."\n"
+ .'* **false** (default)'."\n"
+ .'* **true**'."\n",
+ 'type' => 'boolean',
+ 'required' => false,
+ 'example' => 'false',
+ ],
+ ],
+ [
+ 'name' => 'IsAllowDownload',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'Specifies whether to allow you to download the query result from DataStudio. Valid values:'."\n"
+ ."\n"
+ .'* **1** (default): allows you to download the query result from DataStudio.'."\n"
+ .'* **0**: does not allow you to download the query result from DataStudio.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => false,
+ 'example' => '1',
+ ],
+ ],
+ [
+ 'name' => 'ProjectMode',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The mode of the workspace. For more information about the differences between the modes of workspaces, see [Differences between workspaces in basic mode and workspaces in standard mode](~~85772~~).'."\n"
+ ."\n"
+ .'Valid values:'."\n"
+ ."\n"
+ .'* **2** (default): basic mode'."\n"
+ .'* **3**: standard mode'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => false,
+ 'example' => '3',
+ ],
+ ],
+ [
+ 'name' => 'ProjectIdentifier',
+ 'in' => 'query',
+ 'allowEmptyValue' => false,
+ 'schema' => [
+ 'description' => 'The name of the workspace. The name can contain only letters, digits, and underscores (\\_) and must start with a letter or digit.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => 'test_project',
+ ],
+ ],
+ [
+ 'name' => 'ResourceManagerResourceGroupId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The resource group ID.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'rg-acfmzbn7pti3****',
+ ],
+ ],
+ [
+ 'name' => 'Tags',
+ 'in' => 'query',
+ 'style' => 'json',
+ 'schema' => [
+ 'description' => 'The tags added to the workspace.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The tags.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'Key' => [
+ 'description' => 'The tag key.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => 'key',
+ ],
+ 'Value' => [
+ 'description' => 'The tag value.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => 'value',
+ ],
+ ],
+ 'required' => false,
+ ],
+ 'required' => false,
+ 'maxItems' => 21,
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'description' => 'The response parameters.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'HttpStatusCode' => [
+ 'description' => 'The HTTP status code.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '200',
+ ],
+ 'RequestId' => [
+ 'description' => 'The request ID.'."\n",
+ 'type' => 'string',
+ 'example' => '1AFAE64E-D1BE-432B-A9****',
+ ],
+ 'Success' => [
+ 'description' => 'Indicates whether the request was successful. Valid values:'."\n"
+ ."\n"
+ .'* **true**'."\n"
+ .'* **false**'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'Data' => [
+ 'description' => 'The workspace ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '466230',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'errorCodes' => [
+ 400 => [
+ [
+ 'errorCode' => 'Invalid.Tenant.ConnectionNotExists',
+ 'errorMessage' => 'The connection does not exist.',
+ ],
+ [
+ 'errorCode' => 'Invalid.Tenant.ProjectNotExists',
+ 'errorMessage' => 'The project does not exist.',
+ ],
+ [
+ 'errorCode' => 'Invalid.Tenant.UserNotInProject',
+ 'errorMessage' => 'The user is not in the project.',
+ ],
+ ],
+ 403 => [
+ [
+ 'errorCode' => 'Invalid.Tenant.UserIsNotProjectOwnerOrAdmin',
+ 'errorMessage' => 'The user is not a project administrator or owner.',
+ ],
+ [
+ 'errorCode' => 'Invalid.Tenant.UserNotInTenant',
+ 'errorMessage' => 'The user is not in tenant.',
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"1AFAE64E-D1BE-432B-A9****\\",\\n \\"Success\\": true,\\n \\"Data\\": 466230\\n}","errorExample":""},{"type":"xml","example":"<CreateProjectResponse>\\n <HttpStatusCode>200</HttpStatusCode>\\n <RequestId>1AFAE64E-D1BE-432B-A9****</RequestId>\\n <Success>true</Success>\\n <Data>25</Data>\\n</CreateProjectResponse>","errorExample":""}]',
+ 'title' => 'CreateProject',
+ ],
+ 'ChangeResourceManagerResourceGroup' => [
+ 'summary' => 'Changes the resource group to which a resource belongs.',
+ 'methods' => [
+ 'post',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'readAndWrite',
+ 'deprecated' => false,
+ 'systemTags' => [],
+ 'parameters' => [
+ [
+ 'name' => 'ResourceType',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The HTTP status code.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => 'project',
+ ],
+ ],
+ [
+ 'name' => 'ResourceId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'Indicates whether the request was successful.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => 'test_project',
+ ],
+ ],
+ [
+ 'name' => 'ResourceManagerResourceGroupId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'ChangeResourceManagerResourceGroup',
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => 'rg-bp67acfmxazb4p****',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'description' => '',
+ 'type' => 'object',
+ 'properties' => [
+ 'Data' => [
+ 'description' => '',
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'RequestId' => [
+ 'description' => '',
+ 'type' => 'string',
+ 'example' => '1AFAE64E-D1BE-432B-A9****',
+ ],
+ 'HttpStatusCode' => [
+ 'description' => '',
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '200',
+ ],
+ 'Success' => [
+ 'description' => '',
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"Data\\": true,\\n \\"RequestId\\": \\"1AFAE64E-D1BE-432B-A9****\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<ChangeResourceManagerResourceGroupResponse>\\n <RequestId>1AFAE64E-D1BE-432B-A9****</RequestId>\\n <HttpStatusCode>200</HttpStatusCode>\\n <Data>true</Data>\\n <Success>true</Success>\\n</ChangeResourceManagerResourceGroupResponse>","errorExample":""}]',
+ 'title' => 'ChangeResourceManagerResourceGroup',
+ ],
+ 'ListMeasureData' => [
+ 'summary' => 'Queries the statistics on the number of phone call-based alerts or text message-based alerts reported within the tenant to which your account belongs during the previous 30 days.',
+ 'methods' => [
+ 'post',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'list',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeCode' => '215284',
+ 'abilityTreeNodes' => [
+ 'FEATUREdideD3SWSQ',
+ ],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'DomainCode',
+ 'in' => 'query',
+ 'allowEmptyValue' => false,
+ 'schema' => [
+ 'title' => '计量项，取值如下：'."\n"
+ .'- DideAlarmPhone：电话告警'."\n"
+ .'- DideAlarmSms：短信告警',
+ 'description' => 'The measurement item. Valid values:'."\n"
+ ."\n"
+ .'* DideAlarmPhone: phone call-based alerts'."\n"
+ .'* DideAlarmSms: text message-based alerts'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'DideAlarmPhone',
+ ],
+ ],
+ [
+ 'name' => 'ComponentCode',
+ 'in' => 'query',
+ 'schema' => [
+ 'title' => '计量组件,取值如下:'."\n"
+ .'- Count：DideAlarmPhone电话告警条数、DideAlarmSms短信告警条数。',
+ 'description' => 'The metering component. Valid values:'."\n"
+ ."\n"
+ .'* Count: The number of DideAlarmPhone (telephone/call) alerts, and the number of DideAlarmSms (SMS/text message) alerts.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'Count',
+ ],
+ ],
+ [
+ 'name' => 'StartTime',
+ 'in' => 'query',
+ 'schema' => [
+ 'title' => '计量周期开始时间戳(毫秒),计量周期是按照天统计，EndTime - StartTime仅能查询最近30天的数据。',
+ 'description' => 'The start timestamp of the metering cycle, in milliseconds. The metering data is aggregated by day. The time range between EndTime and StartTime cannot exceed 30 days.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => '1717344000000',
+ ],
+ ],
+ [
+ 'name' => 'EndTime',
+ 'in' => 'query',
+ 'schema' => [
+ 'title' => '计量周期截止时间戳(毫秒),计量周期是按照天统计，EndTime - StartTime仅能查询最近30天的数据。',
+ 'description' => 'The end timestamp of the metering cycle, in milliseconds. The metering data is aggregated by day. The time range between EndTime and StartTime cannot exceed 30 days.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => '1717430400000',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => '返回结果。',
+ 'description' => 'The returned result.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'title' => '请求ID。',
+ 'description' => 'The request ID.'."\n",
+ 'type' => 'string',
+ 'example' => '1AFAE64E-D1BE-432B-A9****',
+ ],
+ 'MeasureDatas' => [
+ 'title' => '查询计量结果列表。',
+ 'description' => 'The metering results.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'DomainCode' => [
+ 'title' => '计量项。',
+ 'description' => 'The item that is measured.'."\n",
+ 'type' => 'string',
+ 'example' => 'DideAlarmPhone',
+ ],
+ 'ComponentCode' => [
+ 'title' => '计量组件。',
+ 'description' => 'The measurement component.'."\n",
+ 'type' => 'string',
+ 'example' => 'Count',
+ ],
+ 'StartTime' => [
+ 'title' => '计量周期开始时间戳(毫秒)。',
+ 'description' => 'The start timestamp of the metering cycle, in milliseconds.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '1717344000000',
+ ],
+ 'EndTime' => [
+ 'title' => '计量周期结束时间戳(毫秒)。',
+ 'description' => 'The end timestamp of the metering cycle, in milliseconds.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '1717430400000',
+ ],
+ 'Usage' => [
+ 'title' => '计量周期内使用总量。'."\n",
+ 'description' => 'The total quantity used within the measurement period.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '10',
+ ],
+ ],
+ 'description' => '',
+ ],
+ ],
+ 'Success' => [
+ 'title' => '请求是否成功，取值如下：'."\n"
+ .'- true：请求成功。'."\n"
+ .'- false：请求失败。',
+ 'description' => 'Indicates whether the request was successful. Valid values:'."\n"
+ ."\n"
+ .'* true'."\n"
+ .'* false'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'ErrorCode' => [
+ 'title' => '请求错误码。',
+ 'description' => 'The error code.'."\n",
+ 'type' => 'string',
+ 'example' => '100001001',
+ ],
+ 'ErrorMessage' => [
+ 'title' => '请求报错信息。',
+ 'description' => 'The error message.'."\n",
+ 'type' => 'string',
+ 'example' => 'The user is not in tenant.',
+ ],
+ 'HttpStatusCode' => [
+ 'title' => '请求返回码。',
+ 'description' => 'The HTTP status code.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '200',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'errorCodes' => [
+ 403 => [
+ [
+ 'errorCode' => 'Invalid.Tenant.UserNotInTenant',
+ 'errorMessage' => 'The user is not in tenant.',
+ ],
+ ],
+ ],
+ 'staticInfo' => [
+ 'returnType' => 'synchronous',
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1AFAE64E-D1BE-432B-A9****\\",\\n \\"MeasureDatas\\": [\\n {\\n \\"DomainCode\\": \\"DideAlarmPhone\\",\\n \\"ComponentCode\\": \\"Count\\",\\n \\"StartTime\\": 1717344000000,\\n \\"EndTime\\": 1717430400000,\\n \\"Usage\\": 10\\n }\\n ],\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"100001001\\",\\n \\"ErrorMessage\\": \\"The user is not in tenant.\\",\\n \\"HttpStatusCode\\": 200\\n}","type":"json"}]',
+ 'title' => 'ListMeasureData',
+ ],
+ 'ListTables' => [
+ 'summary' => 'Obtains tables of different data source types within a tenant by page.',
+ 'methods' => [
+ 'get',
+ 'post',
+ ],
+ 'schemes' => [
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'get',
+ 'abilityTreeCode' => '234146',
+ 'abilityTreeNodes' => [
+ 'FEATUREdideE9XYA6',
+ ],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'PageSize',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The number of entries displayed on each page. The default value is 10 and the maximum value is 100.',
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => false,
+ 'example' => '10',
+ ],
+ ],
+ [
+ 'name' => 'DataSourceType',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The type of the data source. Valid values: ODPS, emr, mysql, holo, analyticdb_for_mysql, oracle, postgresql, sqlserver, clickhouse, and starrocks.',
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => 'odps'."\n"
+ .'emr'."\n"
+ .'mysql'."\n"
+ .'holo',
+ ],
+ ],
+ [
+ 'name' => 'NextToken',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'Pagination information, which specifies the starting point of this read.',
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => '12222',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => 'Schema of Response',
+ 'description' => 'The response parameters.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'title' => 'Id of the request',
+ 'description' => 'The request ID.'."\n",
+ 'type' => 'string',
+ 'example' => 'E25887B7-579C-54A5-9C4F-83A0DE367DD',
+ ],
+ 'Data' => [
+ 'description' => 'The returned data.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'Total' => [
+ 'description' => 'The total number.',
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '100',
+ ],
+ 'TableEntityList' => [
+ 'description' => 'An array of entities.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The information about the table.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'EntityQualifiedName' => [
+ 'description' => 'The unique identifier of the table entity.',
+ 'type' => 'string',
+ 'example' => 'maxcompute-table.project.table',
+ ],
+ 'EntityContent' => [
+ 'description' => 'The information about the table.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'TableName' => [
+ 'description' => 'The name of the table.',
+ 'type' => 'string',
+ 'example' => 'table',
+ ],
+ 'DataSourceQualifiedName' => [
+ 'description' => 'The unique identifier of the data source.',
+ 'type' => 'string',
+ 'example' => 'accountId:cn-shanghai:odps:project',
+ ],
+ 'DataSourceUniqueId' => [
+ 'description' => 'The unique ID of the data source identifier.',
+ 'type' => 'string',
+ 'example' => 'e70f92239d491057f6a2563b545bdaf8cc6b537d9dc55ec84c55f7cfefg',
+ ],
+ 'DatabaseName' => [
+ 'description' => 'The name of the database.',
+ 'type' => 'string',
+ 'example' => 'database',
+ ],
+ 'ProjectName' => [
+ 'description' => 'The name of the ODPS project.',
+ 'type' => 'string',
+ 'example' => 'project',
+ ],
+ 'InstanceId' => [
+ 'description' => 'The ID of the data source instance.',
+ 'type' => 'string',
+ 'example' => 'rm-uf6rn0123',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'NextToken' => [
+ 'description' => 'Pagination information, which specifies the starting point of the next read.',
+ 'type' => 'string',
+ 'example' => 'AAAAAVY3rYiv9VoUJQSiCitgjgSwg+byk0FIjirFkm4zfM4G0xYwM/FQvOhgrTHsCPIZ5yqXYu2NG6qRCRC52HvwbOA=',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'staticInfo' => [
+ 'returnType' => 'synchronous',
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"E25887B7-579C-54A5-9C4F-83A****\\",\\n \\"Data\\": {\\n \\"Total\\": 100,\\n \\"TableEntityList\\": [\\n {\\n \\"EntityQualifiedName\\": \\"maxcompute-table.project.table\\",\\n \\"EntityContent\\": {\\n \\"TableName\\": \\"table\\",\\n \\"DataSourceQualifiedName\\": \\"accountId:cn-shanghai:odps:project\\",\\n \\"DataSourceUniqueId\\": \\"e70f92239d491057f6a2563b545bdaf8cc6b537d9dc55ec84c55f7cfefg\\",\\n \\"DatabaseName\\": \\"database\\",\\n \\"ProjectName\\": \\"project\\",\\n \\"InstanceId\\": \\"rm-uf6rn0123\\"\\n }\\n }\\n ],\\n \\"NextToken\\": \\"AAAAAVY3rYiv9VoUJQSiCitgjgSwg+byk0FIjirFkm4zfM4G0xYwM/FQvOhgrTHsCPIZ5yqXYu2NG6qRCRC52HvwbOA=\\"\\n }\\n}","type":"json"}]',
+ 'title' => 'ListTables',
+ ],
+ 'GetMetaDBInfo' => [
+ 'methods' => [
+ 'get',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'get',
+ 'abilityTreeCode' => '78259',
+ 'abilityTreeNodes' => [
+ 'FEATUREdideE9XYA6',
+ ],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'AppGuid',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The compute engine instance ID. Specify the ID in the `Engine type.Engine name` format.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'docRequired' => false,
+ 'example' => 'odps.some_engine_name',
+ ],
+ ],
+ [
+ 'name' => 'ClusterId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The E-MapReduce (EMR) cluster ID.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'abc',
+ ],
+ ],
+ [
+ 'name' => 'DatabaseName',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The name of the metadatabase of the EMR cluster.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'abc',
+ ],
+ ],
+ [
+ 'name' => 'DataSourceType',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The type of the data source. Valid values: odps and emr.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'emr',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'description' => 'The response parameters.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'description' => 'The request ID.'."\n",
+ 'type' => 'string',
+ 'example' => '0bc1411515937****',
+ ],
+ 'Data' => [
+ 'description' => 'The basic metadata information.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'Type' => [
+ 'description' => 'The type of the metadatabase.'."\n",
+ 'type' => 'string',
+ 'example' => 'hive',
+ ],
+ 'Comment' => [
+ 'description' => 'The comment.'."\n",
+ 'type' => 'string',
+ 'example' => 'The ID of the compute engine instance. The ID is in the Engine type.Engine name format.'."\n",
+ ],
+ 'CreateTime' => [
+ 'description' => 'The time when the compute engine instance was created.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '1541576644000',
+ ],
+ 'ProjectId' => [
+ 'description' => 'The workspace ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '22',
+ ],
+ 'ProjectName' => [
+ 'description' => 'The name of the workspace.'."\n",
+ 'type' => 'string',
+ 'example' => 'test',
+ ],
+ 'AppGuid' => [
+ 'description' => 'The compute engine instance ID. Specify the ID in the `Engine type.Engine name` format.'."\n",
+ 'type' => 'string',
+ 'example' => 'odps.engine_name',
+ ],
+ 'OwnerName' => [
+ 'description' => 'The name of the workspace owner.'."\n",
+ 'type' => 'string',
+ 'example' => '323',
+ ],
+ 'OwnerId' => [
+ 'description' => 'The ID of the Alibaba Cloud account used by the workspace owner.'."\n",
+ 'type' => 'string',
+ 'example' => '23',
+ ],
+ 'EnvType' => [
+ 'description' => 'The type of the environment. Valid values: 0 and 1. The value 0 indicates the development environment. The value 1 indicates the production environment.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '1',
+ ],
+ 'ProjectNameCn' => [
+ 'description' => 'The display name of the workspace.'."\n",
+ 'type' => 'string',
+ 'example' => 'The storage path of the metadatabase of the EMR cluster.'."\n",
+ ],
+ 'Endpoint' => [
+ 'description' => 'The endpoint of the service.'."\n",
+ 'type' => 'string',
+ 'example' => 'http://service.odpsstg.aliyun-inc.com/',
+ ],
+ 'ClusterBizId' => [
+ 'description' => 'The EMR cluster ID.'."\n",
+ 'type' => 'string',
+ 'example' => 'abc',
+ ],
+ 'Name' => [
+ 'description' => 'The name of the database.'."\n",
+ 'type' => 'string',
+ 'example' => 'abc',
+ ],
+ 'Location' => [
+ 'description' => 'The storage path of the metadatabase of the EMR cluster.'."\n",
+ 'type' => 'string',
+ 'example' => 'hdfs://',
+ ],
+ 'TenantId' => [
+ 'description' => 'The tenant ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '233',
+ ],
+ 'ModifyTime' => [
+ 'description' => 'The time when the compute engine instance was modified.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '1541576644000',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'errorCodes' => [
+ 400 => [
+ [
+ 'errorCode' => 'Invalid.Meta.AppNotExist',
+ 'errorMessage' => 'The MaxCompute project does not exist.',
+ ],
+ [
+ 'errorCode' => 'InvalidParameter.Meta.CommonError',
+ 'errorMessage' => 'The specified parameter is invalid.',
+ ],
+ [
+ 'errorCode' => 'InvalidParameter.Meta.Illegal',
+ 'errorMessage' => 'The app guid parameter is invalid.',
+ ],
+ [
+ 'errorCode' => 'InvalidParameter.Meta.IllegalDate',
+ 'errorMessage' => 'The date format is invalid.',
+ ],
+ [
+ 'errorCode' => 'InvalidParameter.Meta.IllegalPageError',
+ 'errorMessage' => 'The parameter for paging is invalid.',
+ ],
+ [
+ 'errorCode' => 'InternalError.UserId.Missing',
+ 'errorMessage' => 'An internal system error occurred. Try again later.',
+ ],
+ [
+ 'errorCode' => 'InternalError.Meta.NoCalcEngine',
+ 'errorMessage' => 'An error occurred while retrieving the compute engine based on the MaxCompute project.',
+ ],
+ [
+ 'errorCode' => 'InvalidParameter.Meta.NotExist',
+ 'errorMessage' => 'The data does not exist.',
+ ],
+ ],
+ 403 => [
+ [
+ 'errorCode' => 'Forbidden.Meta.NoTenant',
+ 'errorMessage' => 'The user is not the owner of any tenants.',
+ ],
+ [
+ 'errorCode' => 'Forbidden.Access',
+ 'errorMessage' => 'Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.',
+ ],
+ ],
+ 429 => [
+ [
+ 'errorCode' => 'Throttling.Api',
+ 'errorMessage' => 'The request for this resource has exceeded your available limit.',
+ ],
+ [
+ 'errorCode' => 'Throttling.Api.Risk',
+ 'errorMessage' => 'The request for this resource has exceeded your daily available limit.',
+ ],
+ [
+ 'errorCode' => 'Throttling.System',
+ 'errorMessage' => 'The DataWorks system is busy. Try again later.',
+ ],
+ [
+ 'errorCode' => 'Throttling.User',
+ 'errorMessage' => 'Your request is too frequent. Try again later.',
+ ],
+ ],
+ 500 => [
+ [
+ 'errorCode' => 'InternalError.System',
+ 'errorMessage' => 'An internal system error occurred. Try again later.',
+ ],
+ [
+ 'errorCode' => 'InternalError.Meta.TenantTimeOut',
+ 'errorMessage' => 'Failed to connect to the interface network.',
+ ],
+ [
+ 'errorCode' => 'InternalError.Meta.Unknown',
+ 'errorMessage' => 'An unknown error occurred while processing your request.',
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"0bc1411515937****\\",\\n \\"Data\\": {\\n \\"Type\\": \\"hive\\",\\n \\"Comment\\": \\"备注\\",\\n \\"CreateTime\\": 1541576644000,\\n \\"ProjectId\\": 22,\\n \\"ProjectName\\": \\"test\\",\\n \\"AppGuid\\": \\"odps.engine_name\\",\\n \\"OwnerName\\": \\"my_name\\",\\n \\"OwnerId\\": \\"userId\\",\\n \\"EnvType\\": 1,\\n \\"ProjectNameCn\\": \\"测试项目\\",\\n \\"Endpoint\\": \\"http://service.odpsstg.aliyun-inc.com/\\",\\n \\"ClusterBizId\\": \\"abc\\",\\n \\"Name\\": \\"abc\\",\\n \\"Location\\": \\"hdfs://\\",\\n \\"TenantId\\": 233,\\n \\"ModifyTime\\": 1541576644000\\n }\\n}","errorExample":""},{"type":"xml","example":"<GetMetaDBInfoResponse>\\n <RequestId>0bc1411515937****</RequestId>\\n <Data>\\n <Type>hive</Type>\\n <Comment>备注</Comment>\\n <CreateTime>1541576644000</CreateTime>\\n <ProjectId>22</ProjectId>\\n <ProjectName>test</ProjectName>\\n <AppGuid>odps.engine_name</AppGuid>\\n <OwnerName>323</OwnerName>\\n <OwnerId>23</OwnerId>\\n <EnvType>1</EnvType>\\n <ProjectNameCn>测试项目</ProjectNameCn>\\n <Endpoint>http://service.odpsstg.aliyun-inc.com/</Endpoint>\\n <ClusterBizId>abc</ClusterBizId>\\n <Name>abc</Name>\\n <Location>hdfs://</Location>\\n <TenantId>233</TenantId>\\n <ModifyTime>1541576644000</ModifyTime>\\n </Data>\\n</GetMetaDBInfoResponse>","errorExample":""}]',
+ 'title' => 'GetMetaDBInfo',
+ 'summary' => 'Queries the basic metadata information about a compute engine instance.',
+ 'description' => 'The ID of the EMR cluster. This parameter is required only if you set the DataSourceType parameter to emr.'."\n"
+ ."\n"
+ .'You can log on to the [EMR console](https://emr.console.aliyun.com/?spm=a2c4g.11186623.0.0.965cc5c2GeiHet#/cn-hangzhou) to obtain the ID of the EMR cluster.'."\n",
+ 'requestParamsDescription' => ' ',
+ 'responseParamsDescription' => ' ',
+ ],
+ 'GetMetaDBTableList' => [
+ 'summary' => 'Queries metatables in a compute engine instance.',
+ 'methods' => [
+ 'post',
+ 'get',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'get',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeCode' => '78260',
+ 'abilityTreeNodes' => [
+ 'FEATUREdideE9XYA6',
+ ],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'PageNumber',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The page number.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => false,
+ 'example' => '1',
+ ],
+ ],
+ [
+ 'name' => 'PageSize',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The number of entries per page. Default value: 10. Maximum value: 100.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => false,
+ 'example' => '10',
+ 'maximum' => '1000',
+ 'minimum' => '1',
+ 'exclusiveMinimum' => false,
+ ],
+ ],
+ [
+ 'name' => 'AppGuid',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The GUID of the MaxCompute project. Specify the GUID in the `odps.{projectName}` format. You must configure this parameter only if you set the DataSourceType parameter to odps.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'odps.testProjectName',
+ ],
+ ],
+ [
+ 'name' => 'ClusterId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The E-MapReduce (EMR) cluster ID. You must configure this parameter only if you set the DataSourceType parameter to emr.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'abc',
+ ],
+ ],
+ [
+ 'name' => 'DatabaseName',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The name of the metadatabase.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'abc',
+ ],
+ ],
+ [
+ 'name' => 'DataSourceType',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The type of the data source. Valid values: odps and emr.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'odps',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'description' => 'The response parameters.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'description' => 'The request ID.'."\n",
+ 'type' => 'string',
+ 'example' => '0bc1ec92159376',
+ ],
+ 'Data' => [
+ 'description' => 'The metatable information in a compute engine instance.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'PageNumber' => [
+ 'description' => 'The page number.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '1',
+ ],
+ 'PageSize' => [
+ 'description' => 'The number of entries per page. Default value: 10. Maximum value: 100.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '10',
+ ],
+ 'TotalCount' => [
+ 'description' => 'The total number of compute engine instances returned.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '20',
+ ],
+ 'TableEntityList' => [
+ 'description' => 'The list of metatables in the compute engine instance.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '',
+ 'type' => 'object',
+ 'properties' => [
+ 'TableName' => [
+ 'description' => 'The name of the metatable.'."\n",
+ 'type' => 'string',
+ 'example' => 'tname',
+ ],
+ 'TableGuid' => [
+ 'description' => 'The GUID of the metatable.'."\n",
+ 'type' => 'string',
+ 'example' => 'odps.engine_name.tname',
+ ],
+ 'DatabaseName' => [
+ 'description' => 'The name of the metadatabase.'."\n",
+ 'type' => 'string',
+ 'example' => 'abc',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'errorCodes' => [
+ 400 => [
+ [
+ 'errorCode' => 'Invalid.Meta.AppNotExist',
+ 'errorMessage' => 'The MaxCompute project does not exist.',
+ ],
+ [
+ 'errorCode' => 'InvalidParameter.Meta.CommonError',
+ 'errorMessage' => 'The specified parameter is invalid.',
+ ],
+ [
+ 'errorCode' => 'InvalidParameter.Meta.Illegal',
+ 'errorMessage' => 'The app guid parameter is invalid.',
+ ],
+ [
+ 'errorCode' => 'InvalidParameter.Meta.IllegalPageError',
+ 'errorMessage' => 'The parameter for paging is invalid.',
+ ],
+ [
+ 'errorCode' => 'InvalidParameter.Meta.NotExist',
+ 'errorMessage' => 'The object does not exist.',
+ ],
+ [
+ 'errorCode' => 'InternalError.UserId.Missing',
+ 'errorMessage' => 'An internal system error occurred. Try again later.',
+ ],
+ [
+ 'errorCode' => 'InternalError.Meta.NoCalcEngine',
+ 'errorMessage' => 'An error occurred while retrieving the compute engine based on the MaxCompute project.',
+ ],
+ ],
+ 403 => [
+ [
+ 'errorCode' => 'Forbidden.Meta.NoTenant',
+ 'errorMessage' => 'The user is not the owner of any tenants.',
+ ],
+ [
+ 'errorCode' => 'Forbidden.Access',
+ 'errorMessage' => 'Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.',
+ ],
+ ],
+ 429 => [
+ [
+ 'errorCode' => 'Throttling.Api',
+ 'errorMessage' => 'The request for this resource has exceeded your available limit.',
+ ],
+ [
+ 'errorCode' => 'Throttling.Api.Risk',
+ 'errorMessage' => 'The request for this resource has exceeded your daily available limit.',
+ ],
+ [
+ 'errorCode' => 'Throttling.System',
+ 'errorMessage' => 'The DataWorks system is busy. Try again later.',
+ ],
+ [
+ 'errorCode' => 'Throttling.User',
+ 'errorMessage' => 'Your request is too frequent. Try again later.',
+ ],
+ ],
+ 500 => [
+ [
+ 'errorCode' => 'InternalError.System',
+ 'errorMessage' => 'An internal system error occurred. Try again later.',
+ ],
+ [
+ 'errorCode' => 'InternalError.Meta.TenantTimeOut',
+ 'errorMessage' => 'Failed to connect to the interface network.',
+ ],
+ [
+ 'errorCode' => 'InternalError.Meta.Unknown',
+ 'errorMessage' => 'An unknown error occurred while processing your request.',
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"0bc1ec92159376\\",\\n \\"Data\\": {\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 20,\\n \\"TableEntityList\\": [\\n {\\n \\"TableName\\": \\"tname\\",\\n \\"TableGuid\\": \\"odps.engine_name.tname\\",\\n \\"DatabaseName\\": \\"abc\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<GetMetaDBTableListResponse>\\n <RequestId>0bc1ec92159376</RequestId>\\n <Data>\\n <PageNumber>1</PageNumber>\\n <PageSize>10</PageSize>\\n <TotalCount>20</TotalCount>\\n <TableEntityList>\\n <TableName>tname</TableName>\\n <TableGuid>odps.engine_name.tname</TableGuid>\\n <DatabaseName>abc</DatabaseName>\\n </TableEntityList>\\n </Data>\\n</GetMetaDBTableListResponse>","errorExample":""}]',
+ 'title' => 'GetMetaDBTableList',
+ 'requestParamsDescription' => ' ',
+ 'responseParamsDescription' => ' ',
+ ],
+ 'CheckMetaTable' => [
+ 'methods' => [
+ 'post',
+ 'get',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'get',
+ 'abilityTreeCode' => '78173',
+ 'abilityTreeNodes' => [
+ 'FEATUREdideYZD64M',
+ ],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'TableGuid',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The GUID of the metatable.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'docRequired' => true,
+ 'example' => 'odps.engine_name.table_name',
+ ],
+ ],
+ [
+ 'name' => 'ClusterId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The E-MapReduce (EMR) cluster ID.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'abc',
+ ],
+ ],
+ [
+ 'name' => 'DatabaseName',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The name of the metadatabase of the EMR cluster.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'abc',
+ ],
+ ],
+ [
+ 'name' => 'TableName',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The name of the EMR metatable.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'abc',
+ ],
+ ],
+ [
+ 'name' => 'DataSourceType',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The type of the data source. Valid values: odps and emr.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'emr',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'description' => 'The returned results.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'Data' => [
+ 'description' => 'Indicates whether the metatable exists.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'RequestId' => [
+ 'description' => 'The request ID.'."\n",
+ 'type' => 'string',
+ 'example' => '0bc1ec92159376',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'errorCodes' => [
+ 400 => [
+ [
+ 'errorCode' => 'Invalid.Meta.TableNotExist',
+ 'errorMessage' => 'The table does not exist.',
+ ],
+ [
+ 'errorCode' => 'InvalidParameter.Meta.Illegal',
+ 'errorMessage' => 'The app guid parameter is invalid.',
+ ],
+ [
+ 'errorCode' => 'InvalidParameter.Meta.NotExist',
+ 'errorMessage' => 'The object does not exist.',
+ ],
+ [
+ 'errorCode' => 'InternalError.UserId.Missing',
+ 'errorMessage' => 'An internal system error occurred. Try again later.',
+ ],
+ [
+ 'errorCode' => 'InternalError.Meta.NoCalcEngine',
+ 'errorMessage' => 'An error occurred while retrieving the compute engine based on the MaxCompute project.',
+ ],
+ ],
+ 403 => [
+ [
+ 'errorCode' => 'Forbidden.Meta.NoTenant',
+ 'errorMessage' => 'The user is not the owner of any tenants.',
+ ],
+ [
+ 'errorCode' => 'Forbidden.Access',
+ 'errorMessage' => 'Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.',
+ ],
+ ],
+ 429 => [
+ [
+ 'errorCode' => 'Throttling.Api',
+ 'errorMessage' => 'The request for this resource has exceeded your available limit.',
+ ],
+ [
+ 'errorCode' => 'Throttling.Api.Risk',
+ 'errorMessage' => 'The request for this resource has exceeded your daily available limit.',
+ ],
+ [
+ 'errorCode' => 'Throttling.System',
+ 'errorMessage' => 'The DataWorks system is busy. Try again later.',
+ ],
+ [
+ 'errorCode' => 'Throttling.User',
+ 'errorMessage' => 'Your request is too frequent. Try again later.',
+ ],
+ ],
+ 500 => [
+ [
+ 'errorCode' => 'InternalError.System',
+ 'errorMessage' => 'An internal system error occurred. Try again later.',
+ ],
+ [
+ 'errorCode' => 'InternalError.Meta.TenantTimeOut',
+ 'errorMessage' => 'Failed to connect to the interface network.',
+ ],
+ [
+ 'errorCode' => 'InternalError.Meta.Unknown',
+ 'errorMessage' => 'An unknown error occurred while processing your request.',
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"Data\\": true,\\n \\"RequestId\\": \\"0bc1ec92159376\\"\\n}","errorExample":""},{"type":"xml","example":"<CheckMetaTableResponse>\\n <Data>true</Data>\\n <RequestId>0bc1ec92159376</RequestId>\\n</CheckMetaTableResponse>","errorExample":""}]',
+ 'title' => 'CheckMetaTable',
+ 'summary' => 'Checks whether a metatable exists.',
+ 'requestParamsDescription' => ' ',
+ 'responseParamsDescription' => ' ',
+ ],
+ 'CheckMetaPartition' => [
+ 'methods' => [
+ 'post',
+ 'get',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'get',
+ 'abilityTreeCode' => '78172',
+ 'abilityTreeNodes' => [
+ 'FEATUREdideYZD64M',
+ ],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'TableGuid',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The GUID of the MaxCompute metatable.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'docRequired' => true,
+ 'example' => 'odps.engine_name.table_name',
+ ],
+ ],
+ [
+ 'name' => 'Partition',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The name of the partition in the MaxCompute metatable.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'ds=202005',
+ ],
+ ],
+ [
+ 'name' => 'ClusterId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'This parameter is deprecated.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'abc',
+ ],
+ ],
+ [
+ 'name' => 'DatabaseName',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The name of the metadatabase.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'abc',
+ ],
+ ],
+ [
+ 'name' => 'TableName',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The name of the metatable.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'abc',
+ ],
+ ],
+ [
+ 'name' => 'DataSourceType',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The type of the data source. Set the value to odps.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'emr',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'description' => 'The response parameters.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'HttpStatusCode' => [
+ 'description' => 'The HTTP status code.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '200',
+ ],
+ 'Data' => [
+ 'description' => 'Indicates whether the partition in the MaxCompute metatable exists. Valid values:'."\n"
+ ."\n"
+ .'* true'."\n"
+ .'* false'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'RequestId' => [
+ 'description' => 'The request ID.'."\n",
+ 'type' => 'string',
+ 'example' => '0bc1ec92159376',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message.'."\n",
+ 'type' => 'string',
+ 'example' => 'The connection does not exist.',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code.'."\n",
+ 'type' => 'string',
+ 'example' => 'Invalid.Tenant.ConnectionNotExists',
+ ],
+ 'Success' => [
+ 'description' => 'Indicates whether the request was successful.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'errorCodes' => [
+ 400 => [
+ [
+ 'errorCode' => 'Invalid.Meta.TableNotExist',
+ 'errorMessage' => 'The table does not exist.',
+ ],
+ [
+ 'errorCode' => 'InvalidParameter.Meta.CommonError',
+ 'errorMessage' => 'The specified parameter is invalid.',
+ ],
+ [
+ 'errorCode' => 'InvalidParameter.Meta.Illegal',
+ 'errorMessage' => 'The app guid parameter is invalid.',
+ ],
+ [
+ 'errorCode' => 'InvalidParameter.Meta.NotExist',
+ 'errorMessage' => 'The object does not exist.',
+ ],
+ [
+ 'errorCode' => 'InternalError.UserId.Missing',
+ 'errorMessage' => 'An internal system error occurred. Try again later.',
+ ],
+ [
+ 'errorCode' => 'InternalError.Meta.NoCalcEngine',
+ 'errorMessage' => 'An error occurred while retrieving the compute engine based on the MaxCompute project.',
+ ],
+ ],
+ 403 => [
+ [
+ 'errorCode' => 'Forbidden.Meta.NoTenant',
+ 'errorMessage' => 'The user is not the owner of any tenants.',
+ ],
+ [
+ 'errorCode' => 'Forbidden.Access',
+ 'errorMessage' => 'Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.',
+ ],
+ ],
+ 429 => [
+ [
+ 'errorCode' => 'Throttling.Api',
+ 'errorMessage' => 'The request for this resource has exceeded your available limit.',
+ ],
+ [
+ 'errorCode' => 'Throttling.Api.Risk',
+ 'errorMessage' => 'The request for this resource has exceeded your daily available limit.',
+ ],
+ [
+ 'errorCode' => 'Throttling.System',
+ 'errorMessage' => 'The DataWorks system is busy. Try again later.',
+ ],
+ [
+ 'errorCode' => 'Throttling.User',
+ 'errorMessage' => 'Your request is too frequent. Try again later.',
+ ],
+ ],
+ 500 => [
+ [
+ 'errorCode' => 'InternalError.System',
+ 'errorMessage' => 'An internal system error occurred. Try again later.',
+ ],
+ [
+ 'errorCode' => 'InternalError.Meta.TenantTimeOut',
+ 'errorMessage' => 'Failed to connect to the interface network.',
+ ],
+ [
+ 'errorCode' => 'InternalError.Meta.Unknown',
+ 'errorMessage' => 'An unknown error occurred while processing your request.',
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Data\\": true,\\n \\"RequestId\\": \\"0bc1ec92159376\\",\\n \\"ErrorMessage\\": \\"The connection does not exist.\\",\\n \\"ErrorCode\\": \\"Invalid.Tenant.ConnectionNotExists\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<CheckMetaPartitionResponse>\\n <HttpStatusCode>200</HttpStatusCode>\\n <Data>true</Data>\\n <RequestId>0bc1ec92159376</RequestId>\\n <ErrorMessage>The connection does not exist.</ErrorMessage>\\n <ErrorCode>Invalid.Tenant.ConnectionNotExists</ErrorCode>\\n <Success>true</Success>\\n</CheckMetaPartitionResponse>","errorExample":""}]',
+ 'title' => 'CheckMetaPartition',
+ 'summary' => 'Checks whether a partition in a MaxCompute metatable exists.',
+ 'requestParamsDescription' => ' ',
+ 'responseParamsDescription' => ' ',
+ ],
+ 'SearchMetaTables' => [
+ 'summary' => 'Queries metatables based on specific conditions.',
+ 'methods' => [
+ 'get',
+ 'post',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'get',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeCode' => '78351',
+ 'abilityTreeNodes' => [
+ 'FEATUREdideE9OA4H',
+ ],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'PageNumber',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The page number.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => false,
+ 'example' => '1',
+ ],
+ ],
+ [
+ 'name' => 'PageSize',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The number of entries per page. Default value: 10. Maximum value: 100.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => false,
+ 'example' => '10',
+ ],
+ ],
+ [
+ 'name' => 'AppGuid',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The GUID of the workspace where the metatables reside.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'docRequired' => true,
+ 'example' => 'odps.engine_name',
+ ],
+ ],
+ [
+ 'name' => 'Keyword',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The keyword based on which metatables are queried. During the query, the system tokenizes the names of metatables and matches the names with the keyword. If no name is matched, the value null is returned. By default, the system uses underscores (\\_) to tokenize the names.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'test',
+ ],
+ ],
+ [
+ 'name' => 'EntityType',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The type of the metatables. Valid values: 0 and 1. The value 0 indicates that tables are queried. The value 1 indicates that views are queried. If you do not configure this parameter, all types of metatables are queried.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => false,
+ 'example' => '0',
+ ],
+ ],
+ [
+ 'name' => 'ClusterId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the EMR cluster. This parameter is required only if you set the DataSourceType parameter to emr.'."\n"
+ ."\n"
+ .'You can log on to the [EMR console](https://emr.console.aliyun.com/?spm=a2c4g.11186623.0.0.965cc5c2GeiHet#/cn-hangzhou) to obtain the ID.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'abc',
+ ],
+ ],
+ [
+ 'name' => 'DataSourceType',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The type of the data source. Valid values: odps and emr.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'docRequired' => true,
+ 'example' => 'emr',
+ ],
+ ],
+ [
+ 'name' => 'Schema',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The schema information of the table. You must configure this parameter if you enable the three-layer model of MaxCompute.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'default',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'description' => 'The response parameters.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'HttpStatusCode' => [
+ 'description' => 'The HTTP status code.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '200',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message.'."\n",
+ 'type' => 'string',
+ 'example' => 'The specified parameters are invalid.',
+ ],
+ 'RequestId' => [
+ 'description' => 'The request ID.'."\n",
+ 'type' => 'string',
+ 'example' => '0bc1ec92159376****',
+ ],
+ 'Success' => [
+ 'description' => 'Indicates whether the request was successful.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code.'."\n",
+ 'type' => 'string',
+ 'example' => '1031203110005',
+ ],
+ 'Data' => [
+ 'description' => 'The search results.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'PageNumber' => [
+ 'description' => 'The page number.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '1',
+ ],
+ 'PageSize' => [
+ 'description' => 'The number of entries per page.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '10',
+ ],
+ 'TotalCount' => [
+ 'description' => 'The total number of metatables.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '100',
+ ],
+ 'DataEntityList' => [
+ 'description' => 'The list of metatables.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '',
+ 'type' => 'object',
+ 'properties' => [
+ 'TableName' => [
+ 'description' => 'The name of the metatable.'."\n",
+ 'type' => 'string',
+ 'example' => 'test_name',
+ ],
+ 'DatabaseName' => [
+ 'description' => 'The name of the metadatabase.'."\n",
+ 'type' => 'string',
+ 'example' => 'abc',
+ ],
+ 'EntityType' => [
+ 'description' => 'The type of the metatable. Valid values:'."\n"
+ ."\n"
+ .'* 0: table'."\n"
+ .'* 1: view'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '0',
+ ],
+ 'ProjectName' => [
+ 'description' => 'The name of the workspace.'."\n",
+ 'type' => 'string',
+ 'example' => 'test',
+ ],
+ 'ProjectId' => [
+ 'description' => 'The ID of the workspace.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '323',
+ ],
+ 'TableGuid' => [
+ 'description' => 'The GUID of the metatable.'."\n",
+ 'type' => 'string',
+ 'example' => 'odps.engine_name.test_name',
+ ],
+ 'OwnerId' => [
+ 'description' => 'The ID of the Alibaba Cloud account used by the workspace owner.'."\n",
+ 'type' => 'string',
+ 'example' => '123',
+ ],
+ 'ClusterId' => [
+ 'description' => 'The ID of the EMR cluster.'."\n",
+ 'type' => 'string',
+ 'example' => 'abc',
+ ],
+ 'EnvType' => [
+ 'description' => 'The type of the environment. Valid values:'."\n"
+ ."\n"
+ .'* 1: production environment'."\n"
+ .'* 0: development environment'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '1',
+ ],
+ 'TenantId' => [
+ 'description' => 'The tenant ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '12345',
+ ],
+ 'Schema' => [
+ 'description' => 'The schema information of the table. You must configure this parameter if you enable the three-layer model of MaxCompute.'."\n",
+ 'type' => 'string',
+ 'example' => 'default',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'errorCodes' => [
+ 400 => [
+ [
+ 'errorCode' => 'Invalid.Meta.TableNotExist',
+ 'errorMessage' => 'The table does not exist.',
+ ],
+ [
+ 'errorCode' => 'InvalidParameter.Meta.CommonError',
+ 'errorMessage' => 'The specified parameter is invalid.',
+ ],
+ [
+ 'errorCode' => 'InvalidParameter.Meta.Illegal',
+ 'errorMessage' => 'The app guid parameter is invalid.',
+ ],
+ [
+ 'errorCode' => 'InvalidParameter.Meta.IllegalDate',
+ 'errorMessage' => 'The date format is invalid.',
+ ],
+ [
+ 'errorCode' => 'InvalidParameter.Meta.IllegalPageError',
+ 'errorMessage' => 'The parameter for paging is invalid.',
+ ],
+ [
+ 'errorCode' => 'InvalidParameter.Meta.NotExist',
+ 'errorMessage' => 'The object does not exist.',
+ ],
+ [
+ 'errorCode' => 'InternalError.UserId.Missing',
+ 'errorMessage' => 'An internal system error occurred. Try again later.',
+ ],
+ [
+ 'errorCode' => 'InternalError.Meta.NoCalcEngine',
+ 'errorMessage' => 'An error occurred while retrieving the compute engine based on the MaxCompute project.',
+ ],
+ ],
+ 403 => [
+ [
+ 'errorCode' => 'ResourceNotAuthorized.Api',
+ 'errorMessage' => 'You are not authorized to access the resources.',
+ ],
+ [
+ 'errorCode' => 'Forbidden.Meta.NoTenant',
+ 'errorMessage' => 'The user is not the owner of any tenants.',
+ ],
+ [
+ 'errorCode' => 'Forbidden.Access',
+ 'errorMessage' => 'Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.',
+ ],
+ ],
+ 429 => [
+ [
+ 'errorCode' => 'Throttling.Api',
+ 'errorMessage' => 'The request for this resource has exceeded your available limit.',
+ ],
+ [
+ 'errorCode' => 'Throttling.Api.Risk',
+ 'errorMessage' => 'The request for this resource has exceeded your daily available limit.',
+ ],
+ [
+ 'errorCode' => 'Throttling.System',
+ 'errorMessage' => 'The DataWorks system is busy. Try again later.',
+ ],
+ [
+ 'errorCode' => 'Throttling.User',
+ 'errorMessage' => 'Your request is too frequent. Try again later.',
+ ],
+ ],
+ 500 => [
+ [
+ 'errorCode' => 'InternalError.System',
+ 'errorMessage' => 'An internal system error occurred. Try again later.',
+ ],
+ [
+ 'errorCode' => 'InternalError.Meta.TenantTimeOut',
+ 'errorMessage' => 'Failed to connect to the interface network.',
+ ],
+ [
+ 'errorCode' => 'InternalError.Meta.Unknown',
+ 'errorMessage' => 'An unknown error occurred while processing your request.',
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"ErrorMessage\\": \\"The specified parameters are invalid.\\",\\n \\"RequestId\\": \\"0bc1ec92159376****\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"1031203110005\\",\\n \\"Data\\": {\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 100,\\n \\"DataEntityList\\": [\\n {\\n \\"TableName\\": \\"test_name\\",\\n \\"DatabaseName\\": \\"abc\\",\\n \\"EntityType\\": 0,\\n \\"ProjectName\\": \\"test\\",\\n \\"ProjectId\\": 323,\\n \\"TableGuid\\": \\"odps.engine_name.test_name\\",\\n \\"OwnerId\\": \\"123\\",\\n \\"ClusterId\\": \\"abc\\",\\n \\"EnvType\\": 1,\\n \\"TenantId\\": 12345,\\n \\"Schema\\": \\"default\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<SearchMetaTablesResponse>\\n <HttpStatusCode>200</HttpStatusCode>\\n <ErrorMessage>The specified parameters are invalid.</ErrorMessage>\\n <RequestId>0bc1ec92159376****</RequestId>\\n <Success>true</Success>\\n <ErrorCode>1031203110005</ErrorCode>\\n <Data>\\n <PageNumber>1</PageNumber>\\n <PageSize>10</PageSize>\\n <TotalCount>100</TotalCount>\\n <DataEntityList>\\n <TableName>test_name</TableName>\\n <DatabaseName>abc</DatabaseName>\\n <EntityType>0</EntityType>\\n <ProjectName>test</ProjectName>\\n <ProjectId>323</ProjectId>\\n <TableGuid>odps.engine_name.test_name</TableGuid>\\n <OwnerId>123</OwnerId>\\n <ClusterId>abc</ClusterId>\\n <EnvType>1</EnvType>\\n <TenantId>12345</TenantId>\\n <Schema>default</Schema>\\n </DataEntityList>\\n </Data>\\n</SearchMetaTablesResponse>","errorExample":""}]',
+ 'title' => 'SearchMetaTables',
+ 'description' => 'You can call this operation to query only metatables in a MaxCompute or E-MapReduce (EMR) compute engine.'."\n",
+ 'requestParamsDescription' => ' ',
+ 'responseParamsDescription' => ' ',
+ ],
+ 'GetMetaTableBasicInfo' => [
+ 'methods' => [
+ 'get',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'get',
+ 'abilityTreeCode' => '78261',
+ 'abilityTreeNodes' => [
+ 'FEATUREdideRZEBFC',
+ ],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'TableGuid',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The GUID of the MaxCompute table. Specify the GUID in the odps.projectName.tableName format.'."\n"
+ ."\n"
+ .'> This parameter is optional for E-MapReduce (EMR) tables.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'docRequired' => true,
+ 'example' => 'odps.engine_name.table_name',
+ ],
+ ],
+ [
+ 'name' => 'ClusterId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the EMR cluster. This parameter is required only if you set the DataSourceType parameter to emr.'."\n"
+ ."\n"
+ .'You can log on to the [EMR console](https://emr.console.aliyun.com/?spm=a2c4g.11186623.0.0.965cc5c2GeiHet#/cn-hangzhou) to query the ID.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'abc',
+ ],
+ ],
+ [
+ 'name' => 'DatabaseName',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The name of the metadatabase. This parameter is required only if you set the DataSourceType parameter to emr.'."\n"
+ ."\n"
+ .'You can call the [ListMetaDB](~~2780105~~) operation to query the name.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'abc',
+ ],
+ ],
+ [
+ 'name' => 'TableName',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The name of the metatable in the EMR cluster. This parameter is required only if you set the DataSourceType parameter to emr.'."\n"
+ ."\n"
+ .'You can call the [GetMetaDBTableList](~~2780086~~) operation to query the name.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'abc',
+ ],
+ ],
+ [
+ 'name' => 'DataSourceType',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The type of the data source. Valid values: odps and emr.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'emr',
+ ],
+ ],
+ [
+ 'name' => 'Extension',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'Specifies whether to include extended fields in query results. The extended fields include ReadCount, FavoriteCount, and ViewCount. This parameter takes effect only if you set the DataSourceType parameter to odps.'."\n",
+ 'type' => 'boolean',
+ 'required' => false,
+ 'example' => 'false',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'description' => 'The response.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'HttpStatusCode' => [
+ 'description' => 'The HTTP status code.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '200',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message.'."\n",
+ 'type' => 'string',
+ 'example' => 'The connection does not exist.',
+ ],
+ 'RequestId' => [
+ 'description' => 'The request ID.'."\n",
+ 'type' => 'string',
+ 'example' => '0bc1411515937',
+ ],
+ 'Success' => [
+ 'description' => 'Indicates whether the request was successful.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code.'."\n",
+ 'type' => 'string',
+ 'example' => 'Invalid.Tenant.ConnectionNotExists',
+ ],
+ 'Data' => [
+ 'description' => 'The business data.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'TableName' => [
+ 'description' => 'The name of the metatable.'."\n",
+ 'type' => 'string',
+ 'example' => 'table_name',
+ ],
+ 'FavoriteCount' => [
+ 'description' => 'The number of times the metatable was added to a favorite list. This parameter is returned only if you set the Extension parameter to true and takes effect only if you set the DataSourceType parameter to odps.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '6',
+ ],
+ 'Comment' => [
+ 'description' => 'The comment of the metatable.'."\n",
+ 'type' => 'string',
+ 'example' => 'test table',
+ ],
+ 'ColumnCount' => [
+ 'description' => 'The number of fields.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '3',
+ ],
+ 'CreateTime' => [
+ 'description' => 'The time when the metatable was created.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '1589870294000',
+ ],
+ 'ProjectId' => [
+ 'description' => 'The workspace ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '232',
+ ],
+ 'OwnerId' => [
+ 'description' => 'The ID of the metatable owner.'."\n",
+ 'type' => 'string',
+ 'example' => '123',
+ ],
+ 'EnvType' => [
+ 'description' => 'The type of the environment. Valid values:'."\n"
+ ."\n"
+ .'* 0: development environment'."\n"
+ .'* 1: production environment'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '1',
+ ],
+ 'DatabaseName' => [
+ 'description' => 'The name of the metadatabase.'."\n",
+ 'type' => 'string',
+ 'example' => 'abc',
+ ],
+ 'IsVisible' => [
+ 'description' => 'The scope in which the metatable is visible. Valid values:'."\n"
+ ."\n"
+ .'* 0: The metatable is visible to workspace members.'."\n"
+ .'* 1: The metatable is visible to users within the tenant.'."\n"
+ .'* 2: The metatable is visible to all tenants.'."\n"
+ .'* 3: The metatable is visible only to the metatable owner.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '1',
+ ],
+ 'TableGuid' => [
+ 'description' => 'The GUID of the metatable.'."\n",
+ 'type' => 'string',
+ 'example' => 'odps.engine_name.table_name',
+ ],
+ 'ReadCount' => [
+ 'description' => 'The number of times the metatable was read. This parameter is returned only if you set the Extension parameter to true and takes effect only if you set the DataSourceType parameter to odps.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '3',
+ ],
+ 'ClusterId' => [
+ 'description' => 'The ID of the EMR cluster.'."\n",
+ 'type' => 'string',
+ 'example' => 'abc',
+ ],
+ 'IsPartitionTable' => [
+ 'description' => 'Indicates whether the metatable is a partitioned table. Valid values:'."\n"
+ ."\n"
+ .'* true'."\n"
+ .'* false'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'IsView' => [
+ 'description' => 'Indicates whether the metatable is a view. Valid values:'."\n"
+ ."\n"
+ .'* true'."\n"
+ .'* false'."\n",
+ 'type' => 'boolean',
+ 'example' => 'false',
+ ],
+ 'LifeCycle' => [
+ 'description' => 'The lifecycle of the table. Unit: day.'."\n"
+ ."\n"
+ .'> If the lifecycle is not set for a MaxCompute table, the return value is 0, indicating that the table is permanently valid.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '5',
+ ],
+ 'ProjectName' => [
+ 'description' => 'The name of the workspace.'."\n",
+ 'type' => 'string',
+ 'example' => 'test',
+ ],
+ 'ViewCount' => [
+ 'description' => 'The number of times the metatable was viewed. This parameter is returned only if you set the Extension parameter to true and takes effect only if you set the DataSourceType parameter to odps.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '2',
+ ],
+ 'LastAccessTime' => [
+ 'description' => 'The time when the metatable was last accessed.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '1589870294000',
+ ],
+ 'DataSize' => [
+ 'description' => 'The size of storage space that is occupied by the metatable. Unit: bytes.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '10',
+ ],
+ 'LastModifyTime' => [
+ 'description' => 'The time when the metatable was last updated.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '1589870294000',
+ ],
+ 'LastDdlTime' => [
+ 'description' => 'The time when the schema of the metatable was last changed.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '1589870294000',
+ ],
+ 'PartitionKeys' => [
+ 'description' => 'The partition key of the Hive metatable.'."\n",
+ 'type' => 'string',
+ 'example' => 'ab',
+ ],
+ 'Location' => [
+ 'description' => 'The storage path of the Hive metadatabase.'."\n",
+ 'type' => 'string',
+ 'example' => 'hdfs://',
+ ],
+ 'Caption' => [
+ 'description' => 'The display name of the metatable.'."\n",
+ 'type' => 'string',
+ 'example' => 'test',
+ ],
+ 'TenantId' => [
+ 'description' => 'The tenant ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '12345',
+ ],
+ 'Schema' => [
+ 'description' => 'The schema information of the metatable. This parameter is returned if the three-layer model of MaxCompute is enabled.'."\n",
+ 'type' => 'string',
+ 'example' => 'default',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'errorCodes' => [
+ 400 => [
+ [
+ 'errorCode' => 'Invalid.Meta.TableNotExist',
+ 'errorMessage' => 'The table does not exist.',
+ ],
+ [
+ 'errorCode' => 'InvalidParameter.Meta.CommonError',
+ 'errorMessage' => 'The specified parameter is invalid.',
+ ],
+ [
+ 'errorCode' => 'InvalidParameter.Meta.Illegal',
+ 'errorMessage' => 'The app guid parameter is invalid.',
+ ],
+ [
+ 'errorCode' => 'InvalidParameter.Meta.IllegalDate',
+ 'errorMessage' => 'The date format is invalid.',
+ ],
+ [
+ 'errorCode' => 'InvalidParameter.Meta.IllegalPageError',
+ 'errorMessage' => 'The parameter for paging is invalid.',
+ ],
+ [
+ 'errorCode' => 'InvalidParameter.Meta.NotExist',
+ 'errorMessage' => 'The object does not exist.',
+ ],
+ [
+ 'errorCode' => 'InternalError.UserId.Missing',
+ 'errorMessage' => 'An internal system error occurred. Try again later.',
+ ],
+ [
+ 'errorCode' => 'InternalError.Meta.NoCalcEngine',
+ 'errorMessage' => 'An error occurred while retrieving the compute engine based on the MaxCompute project.',
+ ],
+ ],
+ 403 => [
+ [
+ 'errorCode' => 'Forbidden.Meta.NoTenant',
+ 'errorMessage' => 'The user is not the owner of any tenants.',
+ ],
+ [
+ 'errorCode' => 'Forbidden.Access',
+ 'errorMessage' => 'Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.',
+ ],
+ ],
+ 429 => [
+ [
+ 'errorCode' => 'Throttling.Api',
+ 'errorMessage' => 'The request for this resource has exceeded your available limit.',
+ ],
+ [
+ 'errorCode' => 'Throttling.Api.Risk',
+ 'errorMessage' => 'The request for this resource has exceeded your daily available limit.',
+ ],
+ [
+ 'errorCode' => 'Throttling.System',
+ 'errorMessage' => 'The DataWorks system is busy. Try again later.',
+ ],
+ [
+ 'errorCode' => 'Throttling.User',
+ 'errorMessage' => 'Your request is too frequent. Try again later.',
+ ],
+ ],
+ 500 => [
+ [
+ 'errorCode' => 'InternalError.System',
+ 'errorMessage' => 'An internal system error occurred. Try again later.',
+ ],
+ [
+ 'errorCode' => 'InternalError.Meta.TenantTimeOut',
+ 'errorMessage' => 'Failed to connect to the interface network.',
+ ],
+ [
+ 'errorCode' => 'InternalError.Meta.Unknown',
+ 'errorMessage' => 'An unknown error occurred while processing your request.',
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"ErrorMessage\\": \\"The connection does not exist.\\",\\n \\"RequestId\\": \\"0bc1411515937\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"Invalid.Tenant.ConnectionNotExists\\",\\n \\"Data\\": {\\n \\"TableName\\": \\"table_name\\",\\n \\"FavoriteCount\\": 6,\\n \\"Comment\\": \\"test table\\",\\n \\"ColumnCount\\": 3,\\n \\"CreateTime\\": 1589870294000,\\n \\"ProjectId\\": 232,\\n \\"OwnerId\\": \\"123\\",\\n \\"EnvType\\": 1,\\n \\"DatabaseName\\": \\"abc\\",\\n \\"IsVisible\\": 1,\\n \\"TableGuid\\": \\"odps.engine_name.table_name\\",\\n \\"ReadCount\\": 3,\\n \\"ClusterId\\": \\"abc\\",\\n \\"IsPartitionTable\\": true,\\n \\"IsView\\": false,\\n \\"LifeCycle\\": 5,\\n \\"ProjectName\\": \\"test\\",\\n \\"ViewCount\\": 2,\\n \\"LastAccessTime\\": 1589870294000,\\n \\"DataSize\\": 10,\\n \\"LastModifyTime\\": 1589870294000,\\n \\"LastDdlTime\\": 1589870294000,\\n \\"PartitionKeys\\": \\"ab\\",\\n \\"Location\\": \\"hdfs://\\",\\n \\"Caption\\": \\"中文名\\",\\n \\"TenantId\\": 12345,\\n \\"Schema\\": \\"default\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"<GetMetaTableBasicInfoResponse>\\n <HttpStatusCode>200</HttpStatusCode>\\n <ErrorMessage>The connection does not exist.</ErrorMessage>\\n <RequestId>0bc1411515937</RequestId>\\n <Success>true</Success>\\n <ErrorCode>Invalid.Tenant.ConnectionNotExists</ErrorCode>\\n <Data>\\n <TableName>table_name</TableName>\\n <FavoriteCount>6</FavoriteCount>\\n <Comment>test table</Comment>\\n <ColumnCount>3</ColumnCount>\\n <CreateTime>1589870294000</CreateTime>\\n <ProjectId>232</ProjectId>\\n <OwnerId>123</OwnerId>\\n <EnvType>1</EnvType>\\n <DatabaseName>abc</DatabaseName>\\n <IsVisible>1</IsVisible>\\n <TableGuid>odps.engine_name.table_name</TableGuid>\\n <ReadCount>3</ReadCount>\\n <ClusterId>abc</ClusterId>\\n <IsPartitionTable>true</IsPartitionTable>\\n <IsView>false</IsView>\\n <LifeCycle>5</LifeCycle>\\n <ProjectName>test</ProjectName>\\n <ViewCount>2</ViewCount>\\n <LastAccessTime>1589870294000</LastAccessTime>\\n <DataSize>10</DataSize>\\n <LastModifyTime>1589870294000</LastModifyTime>\\n <LastDdlTime>1589870294000</LastDdlTime>\\n <PartitionKeys>ab</PartitionKeys>\\n <Location>hdfs://</Location>\\n <Caption>中文名</Caption>\\n <TenantId>12345</TenantId>\\n <Schema>default</Schema>\\n </Data>\\n</GetMetaTableBasicInfoResponse>","errorExample":""}]',
+ 'title' => 'GetMetaTableBasicInfo',
+ 'summary' => 'Queries the basic information about a metatable.',
+ 'requestParamsDescription' => ' ',
+ 'responseParamsDescription' => ' ',
+ ],
+ 'GetMetaTableColumn' => [
+ 'methods' => [
+ 'get',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'get',
+ 'abilityTreeCode' => '78263',
+ 'abilityTreeNodes' => [
+ 'FEATUREdideE9XYA6',
+ ],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'TableGuid',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The GUID of the metatable. You can call the [GetMetaDBTableList](~~2780086~~) operation to query the GUID.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'docRequired' => true,
+ 'example' => 'odps.engine_name.table_name',
+ ],
+ ],
+ [
+ 'name' => 'PageNum',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The page number.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => false,
+ 'example' => '1',
+ ],
+ ],
+ [
+ 'name' => 'PageSize',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The number of entries per page. Default value: 10. Maximum value: 100.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => false,
+ 'example' => '10',
+ ],
+ ],
+ [
+ 'name' => 'ClusterId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the E-MapReduce (EMR) cluster. You can log on to the EMR console to obtain the ID.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'C-010A704DA760****',
+ ],
+ ],
+ [
+ 'name' => 'DatabaseName',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The name of the metadatabase of the EMR cluster. You can call the [ListMetaDB](~~2780105~~) operation to query the name.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'abc',
+ ],
+ ],
+ [
+ 'name' => 'TableName',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The name of the metatable in the EMR cluster. You can call the [GetMetaDBTableList](~~2780086~~) operation to query the name.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'abc',
+ ],
+ ],
+ [
+ 'name' => 'DataSourceType',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The type of the data source. Set the value to emr.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'emr',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'description' => 'The response parameters.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'HttpStatusCode' => [
+ 'description' => 'The HTTP status code.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '200',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message.'."\n",
+ 'type' => 'string',
+ 'example' => 'The connection does not exist.',
+ ],
+ 'RequestId' => [
+ 'description' => 'The request ID. You can locate logs and troubleshoot issues based on the ID.'."\n",
+ 'type' => 'string',
+ 'example' => '0bc1ec92159376',
+ ],
+ 'Success' => [
+ 'description' => 'Indicates whether the request was successful.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code.'."\n",
+ 'type' => 'string',
+ 'example' => 'Invalid.Tenant.ConnectionNotExists',
+ ],
+ 'Data' => [
+ 'description' => 'The business data.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'PageNum' => [
+ 'description' => 'The page number.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '1',
+ ],
+ 'PageSize' => [
+ 'description' => 'The number of entries per page. Default value: 10. Maximum value: 100.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '10',
+ ],
+ 'TotalCount' => [
+ 'description' => 'The total number of fields.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '100',
+ ],
+ 'ColumnList' => [
+ 'description' => 'The information about fields.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '',
+ 'type' => 'object',
+ 'properties' => [
+ 'ColumnGuid' => [
+ 'description' => 'The GUID of the field.'."\n",
+ 'type' => 'string',
+ 'example' => 'odps.engine_name.table_name.name',
+ ],
+ 'ColumnName' => [
+ 'description' => 'The name of the field.'."\n",
+ 'type' => 'string',
+ 'example' => 'name',
+ ],
+ 'IsPartitionColumn' => [
+ 'description' => 'Indicates whether the field is a partition field. Valid values:'."\n"
+ ."\n"
+ .'* true'."\n"
+ .'* false'."\n",
+ 'type' => 'boolean',
+ 'example' => 'false',
+ ],
+ 'Comment' => [
+ 'description' => 'The remarks of the field.'."\n",
+ 'type' => 'string',
+ 'example' => 'comment ',
+ ],
+ 'ColumnType' => [
+ 'description' => 'The data type of the field.'."\n",
+ 'type' => 'string',
+ 'example' => 'string',
+ ],
+ 'IsPrimaryKey' => [
+ 'description' => 'Indicates whether the field is a primary key. Valid values:'."\n"
+ ."\n"
+ .'* true'."\n"
+ .'* false'."\n",
+ 'type' => 'boolean',
+ 'example' => 'false',
+ ],
+ 'Position' => [
+ 'description' => 'The sequence number of the field.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '1',
+ ],
+ 'Caption' => [
+ 'description' => 'The description of the field.'."\n",
+ 'type' => 'string',
+ 'example' => 'data column',
+ ],
+ 'IsForeignKey' => [
+ 'description' => 'Indicates whether the field is a foreign key. Valid values:'."\n"
+ ."\n"
+ .'* true'."\n"
+ .'* false'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'RelationCount' => [
+ 'description' => 'The number of times the field is read.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '2',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'errorCodes' => [
+ 400 => [
+ [
+ 'errorCode' => 'InvalidParameter.Meta.CommonError',
+ 'errorMessage' => 'The specified parameter is invalid.',
+ ],
+ [
+ 'errorCode' => 'InvalidParameter.Meta.GuidFormat',
+ 'errorMessage' => 'The GUID format is invalid.',
+ ],
+ [
+ 'errorCode' => 'InvalidParameter.Meta.Illegal',
+ 'errorMessage' => 'The app guid parameter is invalid.',
+ ],
+ [
+ 'errorCode' => 'InvalidParameter.Meta.IllegalDate',
+ 'errorMessage' => 'The date format is invalid.',
+ ],
+ [
+ 'errorCode' => 'InvalidParameter.Meta.IllegalPageError',
+ 'errorMessage' => 'The parameter for paging is invalid.',
+ ],
+ [
+ 'errorCode' => 'InvalidParameter.Meta.NotExist',
+ 'errorMessage' => 'The object does not exist.',
+ ],
+ [
+ 'errorCode' => 'InternalError.UserId.Missing',
+ 'errorMessage' => 'An internal system error occurred. Try again later.',
+ ],
+ [
+ 'errorCode' => 'InternalError.Meta.NoCalcEngine',
+ 'errorMessage' => 'An error occurred while retrieving the compute engine based on the MaxCompute project.',
+ ],
+ ],
+ 403 => [
+ [
+ 'errorCode' => 'Forbidden.Meta.NoTenant',
+ 'errorMessage' => 'The user is not the owner of any tenants.',
+ ],
+ [
+ 'errorCode' => 'Forbidden.Access',
+ 'errorMessage' => 'Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.',
+ ],
+ ],
+ 429 => [
+ [
+ 'errorCode' => 'Throttling.Api',
+ 'errorMessage' => 'The request for this resource has exceeded your available limit.',
+ ],
+ [
+ 'errorCode' => 'Throttling.Api.Risk',
+ 'errorMessage' => 'The request for this resource has exceeded your daily available limit.',
+ ],
+ [
+ 'errorCode' => 'Throttling.System',
+ 'errorMessage' => 'The DataWorks system is busy. Try again later.',
+ ],
+ [
+ 'errorCode' => 'Throttling.User',
+ 'errorMessage' => 'Your request is too frequent. Try again later.',
+ ],
+ ],
+ 500 => [
+ [
+ 'errorCode' => 'InternalError.System',
+ 'errorMessage' => 'An internal system error occurred. Try again later.',
+ ],
+ [
+ 'errorCode' => 'InternalError.Meta.TenantTimeOut',
+ 'errorMessage' => 'Failed to connect to the interface network.',
+ ],
+ [
+ 'errorCode' => 'InternalError.Meta.Unknown',
+ 'errorMessage' => 'An unknown error occurred while processing your request.',
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"ErrorMessage\\": \\"The connection does not exist.\\",\\n \\"RequestId\\": \\"0bc1ec92159376\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"Invalid.Tenant.ConnectionNotExists\\",\\n \\"Data\\": {\\n \\"PageNum\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 100,\\n \\"ColumnList\\": [\\n {\\n \\"ColumnGuid\\": \\"odps.engine_name.table_name.name\\",\\n \\"ColumnName\\": \\"name\\",\\n \\"IsPartitionColumn\\": false,\\n \\"Comment\\": \\"comment \\",\\n \\"ColumnType\\": \\"string\\",\\n \\"IsPrimaryKey\\": false,\\n \\"Position\\": 1,\\n \\"Caption\\": \\"data column\\",\\n \\"IsForeignKey\\": true,\\n \\"RelationCount\\": 2\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<GetMetaTableColumnResponse>\\n <HttpStatusCode>200</HttpStatusCode>\\n <ErrorMessage>The connection does not exist.</ErrorMessage>\\n <RequestId>0bc1ec92159376</RequestId>\\n <Success>true</Success>\\n <ErrorCode>Invalid.Tenant.ConnectionNotExists</ErrorCode>\\n <Data>\\n <PageNum>1</PageNum>\\n <PageSize>10</PageSize>\\n <TotalCount>100</TotalCount>\\n <ColumnList>\\n <ColumnGuid>odps.engine_name.table_name.name</ColumnGuid>\\n <ColumnName>name</ColumnName>\\n <IsPartitionColumn>false</IsPartitionColumn>\\n <Comment>comment </Comment>\\n <ColumnType>string</ColumnType>\\n <IsPrimaryKey>false</IsPrimaryKey>\\n <Position>1</Position>\\n <Caption>data column</Caption>\\n <IsForeignKey>true</IsForeignKey>\\n <RelationCount>2</RelationCount>\\n </ColumnList>\\n </Data>\\n</GetMetaTableColumnResponse>","errorExample":""}]',
+ 'title' => 'GetMetaTableColumn',
+ 'summary' => 'Queries the field information of a metatable.',
+ 'requestParamsDescription' => ' ',
+ 'responseParamsDescription' => ' ',
+ ],
+ 'GetMetaTablePartition' => [
+ 'summary' => 'Obtains a list of partitions in a metatable.',
+ 'methods' => [
+ 'post',
+ 'get',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'get',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeCode' => '78269',
+ 'abilityTreeNodes' => [
+ 'FEATUREdideE9XYA6',
+ ],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'PageNumber',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The page number.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => false,
+ 'example' => '1',
+ ],
+ ],
+ [
+ 'name' => 'PageSize',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The number of entries per page. Default value: 10. Maximum value: 100.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => false,
+ 'example' => '10',
+ ],
+ ],
+ [
+ 'name' => 'TableGuid',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The unique identifier of the metatable.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'docRequired' => true,
+ 'example' => 'odps.engine_name.table_name',
+ ],
+ ],
+ [
+ 'name' => 'ClusterId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the EMR cluster. This parameter is required only if you set the DataSourceType parameter to emr.'."\n"
+ ."\n"
+ .'You can log on to the [EMR console](https://emr.console.aliyun.com/?spm=a2c4g.11186623.0.0.965cc5c2GeiHet#/cn-hangzhou) to obtain the ID.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'abc',
+ ],
+ ],
+ [
+ 'name' => 'DatabaseName',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The name of the database. This parameter is required only if you set the DataSourceType parameter to emr.'."\n"
+ ."\n"
+ .'You can call the [ListMetaDB](~~2780105~~) operation to query the name of the metadatabase.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'abc',
+ ],
+ ],
+ [
+ 'name' => 'TableName',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The name of the metatable in the EMR cluster. This parameter is required only if you set the DataSourceType parameter to emr.'."\n"
+ ."\n"
+ .'You can call the [GetMetaDBTableList](~~2780086~~) operation to query the name of the metatable.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'abc',
+ ],
+ ],
+ [
+ 'name' => 'DataSourceType',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The type of the data source. Valid values: odps and emr.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'emr',
+ ],
+ ],
+ [
+ 'name' => 'SortCriterion',
+ 'in' => 'query',
+ 'style' => 'json',
+ 'schema' => [
+ 'description' => 'The logic for sorting partitions in the metatable.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'SortField' => [
+ 'description' => 'The field that is used to sort partitions in the metatable. Valid values: name and modify_time. By default, partitions in the metatable are sorted based on their creation time.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'name',
+ ],
+ 'Order' => [
+ 'description' => 'The order in which partitions in the metatable are sorted. Valid values: asc and desc. Default value: desc.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'desc',
+ ],
+ ],
+ 'required' => false,
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'description' => 'The data returned.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'HttpStatusCode' => [
+ 'description' => 'The HTTP status code returned.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '200',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message returned.'."\n",
+ 'type' => 'string',
+ 'example' => 'The connection does not exist.',
+ ],
+ 'RequestId' => [
+ 'description' => 'The request ID.'."\n",
+ 'type' => 'string',
+ 'example' => '0bc1ec92159376',
+ ],
+ 'Success' => [
+ 'description' => 'Indicates whether the request was successful.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code returned.'."\n",
+ 'type' => 'string',
+ 'example' => 'Invalid.Tenant.ConnectionNotExists',
+ ],
+ 'Data' => [
+ 'description' => 'The returned result.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'PageNumber' => [
+ 'description' => 'The page number.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '1',
+ ],
+ 'PageSize' => [
+ 'description' => 'The number of entries per page. Default value: 10. Maximum value: 100.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '10',
+ ],
+ 'TotalCount' => [
+ 'description' => 'The total number of partitions.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '100',
+ ],
+ 'DataEntityList' => [
+ 'description' => 'The list of partitions.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '',
+ 'type' => 'object',
+ 'properties' => [
+ 'PartitionPath' => [
+ 'description' => 'The path of the partition.'."\n",
+ 'type' => 'string',
+ 'example' => 'abc',
+ ],
+ 'DataSize' => [
+ 'description' => 'The size of the partition. Unit: bytes.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '19',
+ ],
+ 'PartitionName' => [
+ 'description' => 'The name of the partition.'."\n",
+ 'type' => 'string',
+ 'example' => 'pt=20170614',
+ ],
+ 'Comment' => [
+ 'description' => 'The comment.'."\n",
+ 'type' => 'string',
+ 'example' => 'test',
+ ],
+ 'ModifiedTime' => [
+ 'description' => 'The time when the partition was modified. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since the epoch time January 1, 1970, 00:00:00 UTC.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '1590032868000',
+ ],
+ 'CreateTime' => [
+ 'description' => 'The time when the partition was created. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since the epoch time January 1, 1970, 00:00:00 UTC.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '1590032868000',
+ ],
+ 'RecordCount' => [
+ 'description' => 'The number of entries in the partition.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '233',
+ ],
+ 'PartitionType' => [
+ 'description' => 'The type of the partition.'."\n",
+ 'type' => 'string',
+ 'example' => 'abc',
+ ],
+ 'PartitionGuid' => [
+ 'description' => 'The GUID of the partition.'."\n",
+ 'type' => 'string',
+ 'example' => 'odps.engine_name.table_name.pt=20170614',
+ ],
+ 'PartitionLocation' => [
+ 'description' => 'The location of the Hive partition.'."\n",
+ 'type' => 'string',
+ 'example' => 'abc',
+ ],
+ 'TableGuid' => [
+ 'description' => 'The unique identifier of the metatable.'."\n",
+ 'type' => 'string',
+ 'example' => 'odps.engine_name.table_name',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'errorCodes' => [
+ 400 => [
+ [
+ 'errorCode' => 'InvalidParameter.Meta.CommonError',
+ 'errorMessage' => 'The specified parameter is invalid.',
+ ],
+ [
+ 'errorCode' => 'InvalidParameter.Meta.Illegal',
+ 'errorMessage' => 'The app guid parameter is invalid.',
+ ],
+ [
+ 'errorCode' => 'InvalidParameter.Meta.IllegalDate',
+ 'errorMessage' => 'The date format is invalid.',
+ ],
+ [
+ 'errorCode' => 'InvalidParameter.Meta.IllegalPageError',
+ 'errorMessage' => 'The parameter for paging is invalid.',
+ ],
+ [
+ 'errorCode' => 'InvalidParameter.Meta.NotExist',
+ 'errorMessage' => 'The object does not exist.',
+ ],
+ [
+ 'errorCode' => 'InternalError.Meta.NoCalcEngine',
+ 'errorMessage' => 'An error occurred while retrieving the compute engine based on the MaxCompute project.',
+ ],
+ ],
+ 403 => [
+ [
+ 'errorCode' => 'Forbidden.Meta.NoTenant',
+ 'errorMessage' => 'The user is not the owner of any tenants.',
+ ],
+ [
+ 'errorCode' => 'Forbidden.Access',
+ 'errorMessage' => 'Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.',
+ ],
+ ],
+ 429 => [
+ [
+ 'errorCode' => 'Throttling.Api',
+ 'errorMessage' => 'The request for this resource has exceeded your available limit.',
+ ],
+ [
+ 'errorCode' => 'Throttling.Api.Risk',
+ 'errorMessage' => 'The request for this resource has exceeded your daily available limit.',
+ ],
+ [
+ 'errorCode' => 'Throttling.System',
+ 'errorMessage' => 'The DataWorks system is busy. Try again later.',
+ ],
+ [
+ 'errorCode' => 'Throttling.User',
+ 'errorMessage' => 'Your request is too frequent. Try again later.',
+ ],
+ ],
+ 500 => [
+ [
+ 'errorCode' => 'InternalError.System',
+ 'errorMessage' => 'An internal system error occurred. Try again later.',
+ ],
+ [
+ 'errorCode' => 'InternalError.UserId.Missing',
+ 'errorMessage' => 'An internal system error occurred. Try again later.',
+ ],
+ [
+ 'errorCode' => 'InternalError.Meta.TenantTimeOut',
+ 'errorMessage' => 'Failed to connect to the interface network.',
+ ],
+ [
+ 'errorCode' => 'InternalError.Meta.Unknown',
+ 'errorMessage' => 'An unknown error occurred while processing your request.',
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"ErrorMessage\\": \\"The connection does not exist.\\",\\n \\"RequestId\\": \\"0bc1ec92159376\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"Invalid.Tenant.ConnectionNotExists\\",\\n \\"Data\\": {\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 100,\\n \\"DataEntityList\\": [\\n {\\n \\"PartitionPath\\": \\"abc\\",\\n \\"DataSize\\": 19,\\n \\"PartitionName\\": \\"pt=20170614\\",\\n \\"Comment\\": \\"备注\\",\\n \\"ModifiedTime\\": 1590032868000,\\n \\"CreateTime\\": 1590032868000,\\n \\"RecordCount\\": 233,\\n \\"PartitionType\\": \\"abc\\",\\n \\"PartitionGuid\\": \\"odps.engine_name.table_name.pt=20170614\\",\\n \\"PartitionLocation\\": \\"abc\\",\\n \\"TableGuid\\": \\"odps.engine_name.table_name\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<GetMetaTablePartitionResponse>\\n <HttpStatusCode>200</HttpStatusCode>\\n <ErrorMessage>The connection does not exist.</ErrorMessage>\\n <RequestId>0bc1ec92159376</RequestId>\\n <Success>true</Success>\\n <ErrorCode>Invalid.Tenant.ConnectionNotExists</ErrorCode>\\n <Data>\\n <PageNumber>1</PageNumber>\\n <PageSize>10</PageSize>\\n <TotalCount>100</TotalCount>\\n <DataEntityList>\\n <PartitionPath>abc</PartitionPath>\\n <DataSize>19</DataSize>\\n <PartitionName>pt=20170614</PartitionName>\\n <Comment>备注</Comment>\\n <ModifiedTime>1590032868000</ModifiedTime>\\n <CreateTime>1590032868000</CreateTime>\\n <RecordCount>233</RecordCount>\\n <PartitionType>abc</PartitionType>\\n <PartitionGuid>odps.engine_name.table_name.pt=20170614</PartitionGuid>\\n <PartitionLocation>abc</PartitionLocation>\\n <TableGuid>odps.engine_name.table_name</TableGuid>\\n </DataEntityList>\\n </Data>\\n</GetMetaTablePartitionResponse>","errorExample":""}]',
+ 'title' => 'GetMetaTablePartition',
+ 'description' => 'You can call this operation to query only the partitions of a metatable in a MaxCompute or E-MapReduce (EMR) compute engine. If you query partitions of a metatable in an EMR compute engine, only DataLake clusters that use Data Lake Formation (DLF) to manage metadata and Hadoop clusters whose cluster version is earlier than 3.41.0 or 5.7.0 are supported.'."\n",
+ 'requestParamsDescription' => ' ',
+ 'responseParamsDescription' => ' ',
+ ],
+ 'GetMetaTableOutput' => [
+ 'methods' => [
+ 'post',
+ 'get',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'get',
+ 'abilityTreeCode' => '78268',
+ 'abilityTreeNodes' => [
+ 'FEATUREdideE9XYA6',
+ ],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'PageNumber',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The page number. Valid values: 1 to 30. Default value: 1.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => false,
+ 'example' => '1',
+ ],
+ ],
+ [
+ 'name' => 'PageSize',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The number of entries per page. Default value: 10. Maximum value: 100.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => false,
+ 'example' => '10',
+ ],
+ ],
+ [
+ 'name' => 'TableGuid',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The GUID of the metatable.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'odps.sample_project.sample_table',
+ ],
+ ],
+ [
+ 'name' => 'StartDate',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The start date.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => '2020-02-02',
+ ],
+ ],
+ [
+ 'name' => 'EndDate',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The end date.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => '2022-02-15',
+ ],
+ ],
+ [
+ 'name' => 'TaskId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The task ID.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => '1048576',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'HttpStatusCode' => [
+ 'description' => 'The HTTP status code.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '200',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message.'."\n",
+ 'type' => 'string',
+ 'example' => 'SUCCESS',
+ ],
+ 'RequestId' => [
+ 'description' => 'The request ID.'."\n",
+ 'type' => 'string',
+ 'example' => '0000-0000-0000-000',
+ ],
+ 'Success' => [
+ 'description' => 'Indicates whether the request was successful.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code.'."\n",
+ 'type' => 'string',
+ 'example' => '0',
+ ],
+ 'Data' => [
+ 'description' => 'The business data.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'PageNumber' => [
+ 'description' => 'The page number. Valid values: 1 to 30. Default value: 1.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '1',
+ ],
+ 'PageSize' => [
+ 'description' => 'The number of entries per page. Default value: 10. Maximum value: 100.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '10',
+ ],
+ 'TotalCount' => [
+ 'description' => 'The total number of entries returned.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '128',
+ ],
+ 'DataEntityList' => [
+ 'description' => 'The partitions.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'EndTime' => [
+ 'description' => 'The end time.'."\n",
+ 'type' => 'string',
+ 'example' => '2022-02-12 0:32:12',
+ ],
+ 'TaskInstanceId' => [
+ 'description' => 'The instance ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '987654321',
+ ],
+ 'StartTime' => [
+ 'description' => 'The start time.'."\n",
+ 'type' => 'string',
+ 'example' => '2022-02-12 0:34:13',
+ ],
+ 'ProjectId' => [
+ 'description' => 'The workspace ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '128',
+ ],
+ 'WaitTime' => [
+ 'description' => 'The waiting time.'."\n",
+ 'type' => 'string',
+ 'example' => '3',
+ ],
+ 'TableGuid' => [
+ 'description' => 'The GUID of the MaxCompute table.'."\n",
+ 'type' => 'string',
+ 'example' => 'odps.sample_project.sample_table',
+ ],
+ 'TaskId' => [
+ 'description' => 'The task ID.'."\n",
+ 'type' => 'string',
+ 'example' => '1048576',
+ ],
+ ],
+ 'description' => '',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'description' => '',
+ ],
+ ],
+ ],
+ 'errorCodes' => [
+ 400 => [
+ [
+ 'errorCode' => 'InvalidParameter.Meta.CommonError',
+ 'errorMessage' => 'The specified parameter is invalid.',
+ ],
+ [
+ 'errorCode' => 'InvalidParameter.Meta.Illegal',
+ 'errorMessage' => 'The app guid parameter is invalid.',
+ ],
+ [
+ 'errorCode' => 'InvalidParameter.Meta.IllegalDate',
+ 'errorMessage' => 'The date format is invalid.',
+ ],
+ [
+ 'errorCode' => 'InvalidParameter.Meta.IllegalPageError',
+ 'errorMessage' => 'The parameter for paging is invalid.',
+ ],
+ [
+ 'errorCode' => 'InvalidParameter.Meta.NotExist',
+ 'errorMessage' => 'The object does not exist.',
+ ],
+ ],
+ 403 => [
+ [
+ 'errorCode' => 'Forbidden.Meta.NoTenant',
+ 'errorMessage' => 'The user is not the owner of any tenants.',
+ ],
+ [
+ 'errorCode' => 'Forbidden.Access',
+ 'errorMessage' => 'Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.',
+ ],
+ ],
+ 429 => [
+ [
+ 'errorCode' => 'Throttling.Api',
+ 'errorMessage' => 'The request for this resource has exceeded your available limit.',
+ ],
+ [
+ 'errorCode' => 'Throttling.Api.Risk',
+ 'errorMessage' => 'The request for this resource has exceeded your daily available limit.',
+ ],
+ [
+ 'errorCode' => 'Throttling.System',
+ 'errorMessage' => 'The DataWorks system is busy. Try again later.',
+ ],
+ [
+ 'errorCode' => 'Throttling.User',
+ 'errorMessage' => 'Your request is too frequent. Try again later.',
+ ],
+ ],
+ 500 => [
+ [
+ 'errorCode' => 'InternalError.System',
+ 'errorMessage' => 'An internal system error occurred. Try again later.',
+ ],
+ [
+ 'errorCode' => 'InternalError.UserId.Missing',
+ 'errorMessage' => 'An internal system error occurred. Try again later.',
+ ],
+ [
+ 'errorCode' => 'InternalError.Meta.NoCalcEngine',
+ 'errorMessage' => 'An error occurred while retrieving the compute engine based on the MaxCompute project.',
+ ],
+ [
+ 'errorCode' => 'InternalError.Meta.TenantTimeOut',
+ 'errorMessage' => 'Failed to connect to the interface network.',
+ ],
+ [
+ 'errorCode' => 'InternalError.Meta.Unknown',
+ 'errorMessage' => 'An unknown error occurred while processing your request.',
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"ErrorMessage\\": \\"The specified parameters are invalid.\\",\\n \\"RequestId\\": \\"0bc1ec92159376****\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"1031203110005\\",\\n \\"Data\\": {\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 100,\\n \\"DataEntityList\\": [\\n {\\n \\"EndTime\\": \\"2020-01-01 00:01:00\\",\\n \\"TaskInstanceId\\": 3521,\\n \\"StartTime\\": \\"2020-01-01 00:00:00\\",\\n \\"ProjectId\\": 333,\\n \\"WaitTime\\": \\"323\\",\\n \\"TableGuid\\": \\"odps.engine_name.table_name\\",\\n \\"TaskId\\": \\"1048576\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<GetMetaTableOutputResponse>\\n <HttpStatusCode>200</HttpStatusCode>\\n <ErrorMessage>The specified parameters are invalid.</ErrorMessage>\\n <RequestId>0bc1ec92159376****</RequestId>\\n <Success>true</Success>\\n <ErrorCode>1031203110005</ErrorCode>\\n <Data>\\n <PageNumber>1</PageNumber>\\n <PageSize>10</PageSize>\\n <TotalCount>100</TotalCount>\\n <DataEntityList>\\n <EndTime>1511107200000</EndTime>\\n <TaskInstanceId>3521</TaskInstanceId>\\n <StartTime>1511107200000</StartTime>\\n <ProjectId>333</ProjectId>\\n <WaitTime>323</WaitTime>\\n <TableGuid>odps.engine_name.table_name</TableGuid>\\n <TaskId>1048576</TaskId>\\n </DataEntityList>\\n </Data>\\n</GetMetaTableOutputResponse>","errorExample":""}]',
+ 'title' => 'GetMetaTableOutput',
+ 'summary' => 'Queries the output information of a metatable.',
+ 'requestParamsDescription' => ' ',
+ 'responseParamsDescription' => ' ',
+ ],
+ 'GetMetaTableChangeLog' => [
+ 'methods' => [
+ 'post',
+ 'get',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'get',
+ 'abilityTreeCode' => '78262',
+ 'abilityTreeNodes' => [
+ 'FEATUREdideE9XYA6',
+ ],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'PageNumber',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The page number.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => false,
+ 'example' => '1',
+ ],
+ ],
+ [
+ 'name' => 'PageSize',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The number of entries per page. Default value: 10. Maximum value: 100.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => false,
+ 'example' => '10',
+ ],
+ ],
+ [
+ 'name' => 'TableGuid',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The GUID of the table. Specify the GUID in the odps.projectName.tableName format. You can call the [GetMetaDBTableList](~~2780086~~) operation to query the GUID.'."\n"
+ ."\n"
+ .'> To query the change logs of a MaxCompute table, you must call the [GetMetaTableChangeLog](~~2780094~~) operation.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'odps.engine_name.table_name',
+ ],
+ ],
+ [
+ 'name' => 'ChangeType',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The type of the change. Valid values: CREATE_TABLE, ALTER_TABLE, DROP_TABLE, ADD_PARTITION, and DROP_PARTITION.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'ALTER_TABLE',
+ ],
+ ],
+ [
+ 'name' => 'ObjectType',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The entity on which the change is made. Valid values: TABLE and PARTITION.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'TABLE',
+ ],
+ ],
+ [
+ 'name' => 'StartDate',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The beginning of the time range to query. Specify the time in the yyyy-MM-dd HH:mm:ss format.'."\n"
+ ."\n"
+ .'* By default, the system uses the current time as the value of this parameter if the time that you specify is invalid.'."\n"
+ .'* If both the values of the StartDate and EndDate parameters are invalid, the system automatically queries the change logs that are generated within the last 30 days.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => '2020-06-01 00:00:00',
+ ],
+ ],
+ [
+ 'name' => 'EndDate',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The end of the time range to query. Specify the time in the yyyy-MM-dd HH:mm:ss format.'."\n"
+ ."\n"
+ .'* By default, the system uses the current time as the value of this parameter if the time that you specify is invalid.'."\n"
+ .'* If both the values of the StartDate and EndDate parameters are invalid, the system automatically queries the change logs that are generated within the last 30 days.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => '2020-06-02 00:00:00',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'description' => 'The response parameters.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'HttpStatusCode' => [
+ 'description' => 'The HTTP status code.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '200',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message.'."\n",
+ 'type' => 'string',
+ 'example' => 'The connection does not exist.',
+ ],
+ 'RequestId' => [
+ 'description' => 'The request ID.'."\n",
+ 'type' => 'string',
+ 'example' => '0bc1ec92159376',
+ ],
+ 'Success' => [
+ 'description' => 'Indicates whether the request was successful.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code.'."\n",
+ 'type' => 'string',
+ 'example' => 'Invalid.Tenant.ConnectionNotExists',
+ ],
+ 'Data' => [
+ 'description' => 'The business data.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'PageNumber' => [
+ 'description' => 'The page number.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '10',
+ ],
+ 'PageSize' => [
+ 'description' => 'The number of entries per page. Default value: 10. Maximum value: 100.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '1',
+ ],
+ 'TotalCount' => [
+ 'description' => 'The total number of metatables.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '10',
+ ],
+ 'DataEntityList' => [
+ 'description' => 'The list of instances.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '',
+ 'type' => 'object',
+ 'properties' => [
+ 'ObjectType' => [
+ 'description' => 'The entity on which the change was made. Valid values: TABLE and PARTITION.'."\n",
+ 'type' => 'string',
+ 'example' => 'TABLE',
+ ],
+ 'ModifiedTime' => [
+ 'description' => 'The time when the metatable was modified.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '1590722845000',
+ ],
+ 'CreateTime' => [
+ 'description' => 'The time when the metatable was created.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '1590722845000',
+ ],
+ 'ChangeContent' => [
+ 'description' => 'The content of the change.'."\n",
+ 'type' => 'string',
+ 'example' => '"[{\\"action\\":\\"ADD_COLUMN\\",\\"value\\":[{\\"originName\\":\\"\\",\\"originType\\":\\"\\",\\"originComment\\":\\"\\",\\"name\\":\\"id\\",\\"type\\":\\"struct<name:string>\\",\\"comment\\":\\"\\"}]}]",',
+ ],
+ 'Operator' => [
+ 'description' => 'The name of the operator.'."\n",
+ 'type' => 'string',
+ 'example' => 'abc',
+ ],
+ 'ChangeType' => [
+ 'description' => 'The type of the change.'."\n",
+ 'type' => 'string',
+ 'example' => 'CREATE_TABLE',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'errorCodes' => [
+ 400 => [
+ [
+ 'errorCode' => 'InvalidParameter.Meta.CommonError',
+ 'errorMessage' => 'The specified parameter is invalid.',
+ ],
+ [
+ 'errorCode' => 'InvalidParameter.Meta.Illegal',
+ 'errorMessage' => 'The app guid parameter is invalid.',
+ ],
+ [
+ 'errorCode' => 'InvalidParameter.Meta.IllegalDate',
+ 'errorMessage' => 'The date format is invalid.',
+ ],
+ [
+ 'errorCode' => 'InvalidParameter.Meta.IllegalPageError',
+ 'errorMessage' => 'The parameter for paging is invalid.',
+ ],
+ [
+ 'errorCode' => 'InvalidParameter.Meta.NotExist',
+ 'errorMessage' => 'The object does not exist.',
+ ],
+ ],
+ 403 => [
+ [
+ 'errorCode' => 'Forbidden.Meta.NoTenant',
+ 'errorMessage' => 'The user is not the owner of any tenants.',
+ ],
+ [
+ 'errorCode' => 'Forbidden.Access',
+ 'errorMessage' => 'Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.',
+ ],
+ ],
+ 429 => [
+ [
+ 'errorCode' => 'Throttling.Api',
+ 'errorMessage' => 'The request for this resource has exceeded your available limit.',
+ ],
+ [
+ 'errorCode' => 'Throttling.Api.Risk',
+ 'errorMessage' => 'The request for this resource has exceeded your daily available limit.',
+ ],
+ [
+ 'errorCode' => 'Throttling.System',
+ 'errorMessage' => 'The DataWorks system is busy. Try again later.',
+ ],
+ [
+ 'errorCode' => 'Throttling.User',
+ 'errorMessage' => 'Your request is too frequent. Try again later.',
+ ],
+ ],
+ 500 => [
+ [
+ 'errorCode' => 'InternalError.System',
+ 'errorMessage' => 'An internal system error occurred. Try again later.',
+ ],
+ [
+ 'errorCode' => 'InternalError.UserId.Missing',
+ 'errorMessage' => 'An internal system error occurred. Try again later.',
+ ],
+ [
+ 'errorCode' => 'InternalError.Meta.NoCalcEngine',
+ 'errorMessage' => 'An error occurred while retrieving the compute engine based on the MaxCompute project.',
+ ],
+ [
+ 'errorCode' => 'InternalError.Meta.TenantTimeOut',
+ 'errorMessage' => 'Failed to connect to the interface network.',
+ ],
+ [
+ 'errorCode' => 'InternalError.Meta.Unknown',
+ 'errorMessage' => 'An unknown error occurred while processing your request.',
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"ErrorMessage\\": \\"The connection does not exist.\\",\\n \\"RequestId\\": \\"0bc1ec92159376\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"Invalid.Tenant.ConnectionNotExists\\",\\n \\"Data\\": {\\n \\"PageNumber\\": 10,\\n \\"PageSize\\": 1,\\n \\"TotalCount\\": 10,\\n \\"DataEntityList\\": [\\n {\\n \\"ObjectType\\": \\"TABLE\\",\\n \\"ModifiedTime\\": 1590722845000,\\n \\"CreateTime\\": 1590722845000,\\n \\"ChangeContent\\": \\"\\\\\\"[{\\\\\\\\\\\\\\"action\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"ADD_COLUMN\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"value\\\\\\\\\\\\\\":[{\\\\\\\\\\\\\\"originName\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"originType\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"originComment\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"name\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"id\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"type\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"struct<name:string>\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"comment\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"\\\\\\\\\\\\\\"}]}]\\\\\\",\\",\\n \\"Operator\\": \\"abc\\",\\n \\"ChangeType\\": \\"CREATE_TABLE\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<GetMetaTableChangeLogResponse>\\n <RequestId>0bc1ec92159376</RequestId>\\n <HttpStatusCode>200</HttpStatusCode>\\n <Data>\\n <TotalCount>10</TotalCount>\\n <PageSize>1</PageSize>\\n <PageNumber>10</PageNumber>\\n <DataEntityList>\\n <Operator>abc</Operator>\\n <ObjectType>TABLE</ObjectType>\\n <ChangeContent>[{\\"action\\":\\"ADD_COLUMN\\",\\"value\\":[{\\"originName\\":\\"\\",\\"originType\\":\\"\\",\\"originComment\\":\\"\\",\\"name\\":\\"id\\",\\"type\\":\\"struct&lt;name:string&gt;\\",\\"comment\\":\\"\\"}]}]</ChangeContent>\\n <ModifiedTime>1590722845000</ModifiedTime>\\n <ChangeType>CREATE_TABLE</ChangeType>\\n <CreateTime>1590722845000</CreateTime>\\n </DataEntityList>\\n </Data>\\n <ErrorCode>Invalid.Tenant.ConnectionNotExists</ErrorCode>\\n <ErrorMessage>The connection does not exist.</ErrorMessage>\\n <Success>true</Success>\\n</GetMetaTableChangeLogResponse>","errorExample":""}]',
+ 'title' => 'GetMetaTableChangeLog',
+ 'summary' => 'Queries the change logs of a metatable.',
+ 'description' => '> This operation will be replaced soon. We recommend that you do not call this operation.'."\n",
+ 'requestParamsDescription' => ' ',
+ 'responseParamsDescription' => ' ',
+ ],
+ 'GetMetaTableIntroWiki' => [
+ 'methods' => [
+ 'post',
+ 'get',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'get',
+ 'abilityTreeCode' => '78265',
+ 'abilityTreeNodes' => [
+ 'FEATUREdideE9XYA6',
+ ],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'TableGuid',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The GUID of the metatable.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'odps.engine_name.table_name',
+ ],
+ ],
+ [
+ 'name' => 'WikiVersion',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The version of the instructions.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'example' => '1',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'HttpStatusCode' => [
+ 'description' => 'The HTTP status code.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '200',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message.'."\n",
+ 'type' => 'string',
+ 'example' => 'The connection does not exist.',
+ ],
+ 'RequestId' => [
+ 'description' => 'The request ID.'."\n",
+ 'type' => 'string',
+ 'example' => '0bc1ec92159376',
+ ],
+ 'Success' => [
+ 'description' => 'Indicates whether the request was successful.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code.'."\n",
+ 'type' => 'string',
+ 'example' => 'Invalid.Tenant.ConnectionNotExists',
+ ],
+ 'Data' => [
+ 'description' => 'The business data.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'ModifiedTime' => [
+ 'description' => 'The time when the metatable was last modified.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '1584444247000',
+ ],
+ 'Version' => [
+ 'description' => 'The version number.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '1',
+ ],
+ 'CreateTime' => [
+ 'description' => 'The time when the metatable was created.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '1584444247000',
+ ],
+ 'CreatorName' => [
+ 'description' => 'The name of the user who creates the metatable.'."\n",
+ 'type' => 'string',
+ 'example' => 'abc',
+ ],
+ 'Content' => [
+ 'description' => 'The description of the metatable.'."\n",
+ 'type' => 'string',
+ 'example' => '\\# Business requirements\\n\\n\\&lt;a name=\\&quot;xiw5n\\&quot;'."\n",
+ ],
+ 'Creator' => [
+ 'description' => 'The creator of the metatable.'."\n",
+ 'type' => 'string',
+ 'example' => 'abc',
+ ],
+ ],
+ ],
+ ],
+ 'description' => '',
+ ],
+ ],
+ ],
+ 'errorCodes' => [
+ 400 => [
+ [
+ 'errorCode' => 'InvalidParameter.Meta.CommonError',
+ 'errorMessage' => 'The specified parameter is invalid.',
+ ],
+ [
+ 'errorCode' => 'InvalidParameter.Meta.Illegal',
+ 'errorMessage' => 'The app guid parameter is invalid.',
+ ],
+ [
+ 'errorCode' => 'InvalidParameter.Meta.IllegalDate',
+ 'errorMessage' => 'The date format is invalid.',
+ ],
+ [
+ 'errorCode' => 'InvalidParameter.Meta.IllegalPageError',
+ 'errorMessage' => 'The parameter for paging is invalid.',
+ ],
+ [
+ 'errorCode' => 'InvalidParameter.Meta.NotExist',
+ 'errorMessage' => 'The object does not exist.',
+ ],
+ ],
+ 403 => [
+ [
+ 'errorCode' => 'Forbidden.Meta.NoTenant',
+ 'errorMessage' => 'The user is not the owner of any tenants.',
+ ],
+ [
+ 'errorCode' => 'Forbidden.Access',
+ 'errorMessage' => 'Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.',
+ ],
+ ],
+ 429 => [
+ [
+ 'errorCode' => 'Throttling.Api',
+ 'errorMessage' => 'The request for this resource has exceeded your available limit.',
+ ],
+ [
+ 'errorCode' => 'Throttling.Api.Risk',
+ 'errorMessage' => 'The request for this resource has exceeded your daily available limit.',
+ ],
+ [
+ 'errorCode' => 'Throttling.System',
+ 'errorMessage' => 'The DataWorks system is busy. Try again later.',
+ ],
+ [
+ 'errorCode' => 'Throttling.User',
+ 'errorMessage' => 'Your request is too frequent. Try again later.',
+ ],
+ ],
+ 500 => [
+ [
+ 'errorCode' => 'InternalError.System',
+ 'errorMessage' => 'An internal system error occurred. Try again later.',
+ ],
+ [
+ 'errorCode' => 'InternalError.UserId.Missing',
+ 'errorMessage' => 'An internal system error occurred. Try again later.',
+ ],
+ [
+ 'errorCode' => 'InternalError.Meta.NoCalcEngine',
+ 'errorMessage' => 'An error occurred while retrieving the compute engine based on the MaxCompute project.',
+ ],
+ [
+ 'errorCode' => 'InternalError.Meta.TenantTimeOut',
+ 'errorMessage' => 'Failed to connect to the interface network.',
+ ],
+ [
+ 'errorCode' => 'InternalError.Meta.Unknown',
+ 'errorMessage' => 'An unknown error occurred while processing your request.',
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"ErrorMessage\\": \\"The connection does not exist.\\",\\n \\"RequestId\\": \\"0bc1ec92159376\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"Invalid.Tenant.ConnectionNotExists\\",\\n \\"Data\\": {\\n \\"ModifiedTime\\": 1584444247000,\\n \\"Version\\": 1,\\n \\"CreateTime\\": 1584444247000,\\n \\"CreatorName\\": \\"abc\\",\\n \\"Content\\": \\"# 业务需求\\\\\\\\n\\\\\\\\n&lt;a name=&quot;xiw5n&quot;\\",\\n \\"Creator\\": \\"abc\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"<RequestId>0bc1ec92159376****</RequestId>\\n<HttpStatusCode>200</HttpStatusCode>\\n<Data>\\n <ModifiedTime>1584444247000</ModifiedTime>\\n <Version>1</Version>\\n <Content># 业务需求\\\\n\\\\n&amp;lt;a name=&amp;quot;xiw5n&amp;quot;</Content>\\n <CreateTime>1584444247000</CreateTime>\\n <Creator>abc</Creator>\\n <CreatorName>abc</CreatorName>\\n</Data>\\n<ErrorCode>Invalid.Tenant.ConnectionNotExists</ErrorCode>\\n<ErrorMessage>The connection does not exist.</ErrorMessage>\\n<Success>true</Success>","errorExample":""}]',
+ 'title' => 'GetMetaTableIntroWiki',
+ 'summary' => 'Queries the instructions on how to use a table.',
+ 'requestParamsDescription' => ' ',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => 'For information about the example on how to use the GetMetaTableIntroWiki operation, see [Examples of DataWorks API operations](https://developer.aliyun.com/article/780879?groupCode=dataworks).'."\n",
+ ],
+ 'CreateMetaCategory' => [
+ 'methods' => [
+ 'post',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'readAndWrite',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'create',
+ 'abilityTreeCode' => '78189',
+ 'abilityTreeNodes' => [
+ 'FEATUREdideE9XYA6',
+ ],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'Name',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The name of the category.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'category_name',
+ ],
+ ],
+ [
+ 'name' => 'Comment',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The remarks of the category.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'category 1',
+ ],
+ ],
+ [
+ 'name' => 'ParentId',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The ID of the parent category.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'example' => '0',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'HttpStatusCode' => [
+ 'description' => 'The HTTP status code.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '200',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message.'."\n",
+ 'type' => 'string',
+ 'example' => 'The connection does not exist.',
+ ],
+ 'RequestId' => [
+ 'description' => 'The request ID.'."\n",
+ 'type' => 'string',
+ 'example' => '0bc1ec92159376',
+ ],
+ 'Success' => [
+ 'description' => 'Indicates whether the request was successful.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code.'."\n",
+ 'type' => 'string',
+ 'example' => 'Invalid.Tenant.ConnectionNotExists',
+ ],
+ 'Data' => [
+ 'description' => 'The information about the category.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'CategoryId' => [
+ 'description' => 'The category ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '223',
+ ],
+ ],
+ ],
+ ],
+ 'description' => '',
+ ],
+ ],
+ ],
+ 'errorCodes' => [
+ 400 => [
+ [
+ 'errorCode' => 'Invalid.Meta.TableNotExist',
+ 'errorMessage' => 'The table does not exist.',
+ ],
+ [
+ 'errorCode' => 'InvalidParameter.Meta.CommonError',
+ 'errorMessage' => 'The specified parameter is invalid.',
+ ],
+ [
+ 'errorCode' => 'InvalidParameter.Meta.Illegal',
+ 'errorMessage' => 'The app guid parameter is invalid.',
+ ],
+ [
+ 'errorCode' => 'InvalidParameter.Meta.IllegalDate',
+ 'errorMessage' => 'The date format is invalid.',
+ ],
+ [
+ 'errorCode' => 'InvalidParameter.Meta.IllegalPageError',
+ 'errorMessage' => 'The parameter for paging is invalid.',
+ ],
+ [
+ 'errorCode' => 'InvalidParameter.Meta.NotExist',
+ 'errorMessage' => 'The object does not exist.',
+ ],
+ [
+ 'errorCode' => 'Invalid.Meta.CategoryIllegalDepth',
+ 'errorMessage' => 'A category can contain a maximum of 4 levels.',
+ ],
+ [
+ 'errorCode' => 'Invalid.Meta.CategoryNameDuplicate',
+ 'errorMessage' => 'The category name is duplicated at this level.',
+ ],
+ ],
+ 403 => [
+ [
+ 'errorCode' => 'Forbidden.Meta.NoTenant',
+ 'errorMessage' => 'The user is not the owner of any tenants.',
+ ],
+ [
+ 'errorCode' => 'Invalid.Meta.CategoryForbidden',
+ 'errorMessage' => 'Failed to delete the category. The current category is associated with a table and cannot be operated.',
+ ],
+ [
+ 'errorCode' => 'Invalid.Meta.CategoryIllegalTenant',
+ 'errorMessage' => 'The tenant ID is different in the parent and child categories.',
+ ],
+ [
+ 'errorCode' => 'Forbidden.Access',
+ 'errorMessage' => 'Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.',
+ ],
+ ],
+ 429 => [
+ [
+ 'errorCode' => 'Throttling.Api',
+ 'errorMessage' => 'The request for this resource has exceeded your available limit.',
+ ],
+ [
+ 'errorCode' => 'Throttling.Api.Risk',
+ 'errorMessage' => 'The request for this resource has exceeded your daily available limit.',
+ ],
+ [
+ 'errorCode' => 'Throttling.System',
+ 'errorMessage' => 'The DataWorks system is busy. Try again later.',
+ ],
+ [
+ 'errorCode' => 'Throttling.User',
+ 'errorMessage' => 'Your request is too frequent. Try again later.',
+ ],
+ ],
+ 500 => [
+ [
+ 'errorCode' => 'InternalError.System',
+ 'errorMessage' => 'An internal system error occurred. Try again later.',
+ ],
+ [
+ 'errorCode' => 'InternalError.UserId.Missing',
+ 'errorMessage' => 'An internal system error occurred. Try again later.',
+ ],
+ [
+ 'errorCode' => 'InternalError.Meta.NoCalcEngine',
+ 'errorMessage' => 'An error occurred while retrieving the compute engine based on the MaxCompute project.',
+ ],
+ [
+ 'errorCode' => 'InternalError.Meta.TenantTimeOut',
+ 'errorMessage' => 'Failed to connect to the interface network.',
+ ],
+ [
+ 'errorCode' => 'InternalError.Meta.Unknown',
+ 'errorMessage' => 'An unknown error occurred while processing your request.',
+ ],
+ [
+ 'errorCode' => 'Invalid.Meta.CategoryRelationDuplicate"',
+ 'errorMessage' => 'The table is already bound to the category.',
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"ErrorMessage\\": \\"The connection does not exist.\\",\\n \\"RequestId\\": \\"0bc1ec92159376\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"Invalid.Tenant.ConnectionNotExists\\",\\n \\"Data\\": {\\n \\"CategoryId\\": 223\\n }\\n}","errorExample":""},{"type":"xml","example":"<CreateMetaCategoryResponse>\\n <HttpStatusCode>200</HttpStatusCode>\\n <ErrorMessage>The connection does not exist.</ErrorMessage>\\n <RequestId>0bc1ec92159376</RequestId>\\n <Success>true</Success>\\n <ErrorCode>Invalid.Tenant.ConnectionNotExists</ErrorCode>\\n <Data>\\n <CategoryId>223</CategoryId>\\n </Data>\\n</CreateMetaCategoryResponse>","errorExample":""}]',
+ 'title' => 'CreateMetaCategory',
+ 'summary' => 'Creates a category.',
+ 'requestParamsDescription' => ' ',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => 'For information about the example on how to use the CreateMetaCategory operation, see [Examples of DataWorks API operations](https://developer.aliyun.com/article/780879?groupCode=dataworks).'."\n",
+ ],
+ 'DeleteMetaCategory' => [
+ 'methods' => [
+ 'get',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'readAndWrite',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'delete',
+ 'abilityTreeCode' => '78211',
+ 'abilityTreeNodes' => [
+ 'FEATUREdideRZEBFC',
+ ],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'CategoryId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the category.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => '23',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'description' => 'The response parameters.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'HttpStatusCode' => [
+ 'description' => 'The HTTP status code.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '200',
+ ],
+ 'Data' => [
+ 'description' => 'The business data.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'RequestId' => [
+ 'description' => 'The request ID.'."\n",
+ 'type' => 'string',
+ 'example' => '0bc1ec92159376',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message.'."\n",
+ 'type' => 'string',
+ 'example' => 'The connection does not exist.',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code.'."\n",
+ 'type' => 'string',
+ 'example' => 'Invalid.Tenant.ConnectionNotExists',
+ ],
+ 'Success' => [
+ 'description' => 'Indicates whether the request was successful.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'errorCodes' => [
+ 400 => [
+ [
+ 'errorCode' => 'Invalid.Meta.CategoryIllegalDepth',
+ 'errorMessage' => 'A category can contain a maximum of 4 levels.',
+ ],
+ [
+ 'errorCode' => 'Invalid.Meta.CategoryNameDuplicate',
+ 'errorMessage' => 'The category name is duplicated at this level.',
+ ],
+ [
+ 'errorCode' => 'Invalid.Meta.TableNotExist',
+ 'errorMessage' => 'The table does not exist.',
+ ],
+ [
+ 'errorCode' => 'InvalidParameter.Meta.CommonError',
+ 'errorMessage' => 'The specified parameter is invalid.',
+ ],
+ [
+ 'errorCode' => 'InvalidParameter.Meta.Illegal',
+ 'errorMessage' => 'The app guid parameter is invalid.',
+ ],
+ [
+ 'errorCode' => 'InvalidParameter.Meta.IllegalDate',
+ 'errorMessage' => 'The date format is invalid.',
+ ],
+ [
+ 'errorCode' => 'InvalidParameter.Meta.IllegalPageError',
+ 'errorMessage' => 'The parameter for paging is invalid.',
+ ],
+ [
+ 'errorCode' => 'InvalidParameter.Meta.NotExist',
+ 'errorMessage' => 'The object does not exist.',
+ ],
+ ],
+ 403 => [
+ [
+ 'errorCode' => 'Forbidden.Meta.NoTenant',
+ 'errorMessage' => 'The user is not the owner of any tenants.',
+ ],
+ [
+ 'errorCode' => 'Invalid.Meta.CategoryForbidden',
+ 'errorMessage' => 'Failed to delete the category. The current category is associated with a table and cannot be operated.',
+ ],
+ [
+ 'errorCode' => 'Invalid.Meta.CategoryIllegalTenant',
+ 'errorMessage' => 'The tenant ID is different in the parent and child categories.',
+ ],
+ [
+ 'errorCode' => 'Forbidden.Access',
+ 'errorMessage' => 'Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.',
+ ],
+ ],
+ 429 => [
+ [
+ 'errorCode' => 'Throttling.Api',
+ 'errorMessage' => 'The request for this resource has exceeded your available limit.',
+ ],
+ [
+ 'errorCode' => 'Throttling.Api.Risk',
+ 'errorMessage' => 'The request for this resource has exceeded your daily available limit.',
+ ],
+ [
+ 'errorCode' => 'Throttling.System',
+ 'errorMessage' => 'The DataWorks system is busy. Try again later.',
+ ],
+ [
+ 'errorCode' => 'Throttling.User',
+ 'errorMessage' => 'Your request is too frequent. Try again later.',
+ ],
+ ],
+ 500 => [
+ [
+ 'errorCode' => 'InternalError.System',
+ 'errorMessage' => 'An internal system error occurred. Try again later.',
+ ],
+ [
+ 'errorCode' => 'InternalError.UserId.Missing',
+ 'errorMessage' => 'An internal system error occurred. Try again later.',
+ ],
+ [
+ 'errorCode' => 'InternalError.Meta.NoCalcEngine',
+ 'errorMessage' => 'An error occurred while retrieving the compute engine based on the MaxCompute project.',
+ ],
+ [
+ 'errorCode' => 'InternalError.Meta.TenantTimeOut',
+ 'errorMessage' => 'Failed to connect to the interface network.',
+ ],
+ [
+ 'errorCode' => 'InternalError.Meta.Unknown',
+ 'errorMessage' => 'An unknown error occurred while processing your request.',
+ ],
+ [
+ 'errorCode' => 'Invalid.Meta.CategoryRelationDuplicate"',
+ 'errorMessage' => 'The table is already bound to the category.',
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Data\\": true,\\n \\"RequestId\\": \\"0bc1ec92159376\\",\\n \\"ErrorMessage\\": \\"The connection does not exist.\\",\\n \\"ErrorCode\\": \\"Invalid.Tenant.ConnectionNotExists\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<DeleteMetaCategoryResponse>\\n <HttpStatusCode>200</HttpStatusCode>\\n <Data>true</Data>\\n <RequestId>0bc1ec92159376</RequestId>\\n <ErrorMessage>The connection does not exist.</ErrorMessage>\\n <ErrorCode>Invalid.Tenant.ConnectionNotExists</ErrorCode>\\n <Success>true</Success>\\n</DeleteMetaCategoryResponse>","errorExample":""}]',
+ 'title' => 'DeleteMetaCategory',
+ 'summary' => 'Deletes a category.',
+ 'requestParamsDescription' => ' ',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => 'For information about the example on how to use the DeleteMetaCategory operation, see [Examples of DataWorks API operations](https://developer.aliyun.com/article/780879?groupCode=dataworks).'."\n",
+ ],
+ 'UpdateMetaCategory' => [
+ 'methods' => [
+ 'post',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'readAndWrite',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'update',
+ 'abilityTreeCode' => '78374',
+ 'abilityTreeNodes' => [
+ 'FEATUREdideRZEBFC',
+ ],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'Name',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The name of the category.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'docRequired' => true,
+ 'example' => 'category name ',
+ ],
+ ],
+ [
+ 'name' => 'Comment',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The remarks of the category.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'category name',
+ ],
+ ],
+ [
+ 'name' => 'CategoryId',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The ID of the category.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => '2',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'HttpStatusCode' => [
+ 'description' => 'The HTTP status code.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '200',
+ ],
+ 'Data' => [
+ 'description' => 'Indicates whether the category is updated.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'RequestId' => [
+ 'description' => 'The request ID.'."\n",
+ 'type' => 'string',
+ 'example' => '0bc1ec92159376',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message.'."\n",
+ 'type' => 'string',
+ 'example' => 'The connection does not exist.',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code.'."\n",
+ 'type' => 'string',
+ 'example' => 'Invalid.Tenant.ConnectionNotExists',
+ ],
+ 'Success' => [
+ 'description' => 'Indicates whether the request was successful.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ ],
+ 'description' => '',
+ ],
+ ],
+ ],
+ 'errorCodes' => [
+ 400 => [
+ [
+ 'errorCode' => 'Invalid.Meta.CategoryIllegalDepth',
+ 'errorMessage' => 'A category can contain a maximum of 4 levels.',
+ ],
+ [
+ 'errorCode' => 'Invalid.Meta.CategoryNameDuplicate',
+ 'errorMessage' => 'The category name is duplicated at this level.',
+ ],
+ [
+ 'errorCode' => 'Invalid.Meta.TableNotExist',
+ 'errorMessage' => 'The table does not exist.',
+ ],
+ [
+ 'errorCode' => 'InvalidParameter.Meta.CommonError',
+ 'errorMessage' => 'The specified parameter is invalid.',
+ ],
+ [
+ 'errorCode' => 'InvalidParameter.Meta.Illegal',
+ 'errorMessage' => 'The app guid parameter is invalid.',
+ ],
+ [
+ 'errorCode' => 'InvalidParameter.Meta.IllegalDate',
+ 'errorMessage' => 'The date format is invalid.',
+ ],
+ [
+ 'errorCode' => 'InvalidParameter.Meta.IllegalPageError',
+ 'errorMessage' => 'The parameter for paging is invalid.',
+ ],
+ [
+ 'errorCode' => 'InvalidParameter.Meta.NotExist',
+ 'errorMessage' => 'The object does not exist.',
+ ],
+ ],
+ 403 => [
+ [
+ 'errorCode' => 'Forbidden.Meta.NoTenant',
+ 'errorMessage' => 'The user is not the owner of any tenants.',
+ ],
+ [
+ 'errorCode' => 'Invalid.Meta.CategoryForbidden',
+ 'errorMessage' => 'Failed to delete the category. The current category is associated with a table and cannot be operated.',
+ ],
+ [
+ 'errorCode' => 'Invalid.Meta.CategoryIllegalTenant',
+ 'errorMessage' => 'The tenant ID is different in the parent and child categories.',
+ ],
+ [
+ 'errorCode' => 'Forbidden.Access',
+ 'errorMessage' => 'Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.',
+ ],
+ ],
+ 429 => [
+ [
+ 'errorCode' => 'Throttling.Api',
+ 'errorMessage' => 'The request for this resource has exceeded your available limit.',
+ ],
+ [
+ 'errorCode' => 'Throttling.Api.Risk',
+ 'errorMessage' => 'The request for this resource has exceeded your daily available limit.',
+ ],
+ [
+ 'errorCode' => 'Throttling.System',
+ 'errorMessage' => 'The DataWorks system is busy. Try again later.',
+ ],
+ [
+ 'errorCode' => 'Throttling.User',
+ 'errorMessage' => 'Your request is too frequent. Try again later.',
+ ],
+ ],
+ 500 => [
+ [
+ 'errorCode' => 'InternalError.System',
+ 'errorMessage' => 'An internal system error occurred. Try again later.',
+ ],
+ [
+ 'errorCode' => 'InternalError.UserId.Missing',
+ 'errorMessage' => 'An internal system error occurred. Try again later.',
+ ],
+ [
+ 'errorCode' => 'InternalError.Meta.NoCalcEngine',
+ 'errorMessage' => 'An error occurred while retrieving the compute engine based on the MaxCompute project.',
+ ],
+ [
+ 'errorCode' => 'InternalError.Meta.TenantTimeOut',
+ 'errorMessage' => 'Failed to connect to the interface network.',
+ ],
+ [
+ 'errorCode' => 'InternalError.Meta.Unknown',
+ 'errorMessage' => 'An unknown error occurred while processing your request.',
+ ],
+ [
+ 'errorCode' => 'Invalid.Meta.CategoryRelationDuplicate"',
+ 'errorMessage' => 'The table is already bound to the category.',
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Data\\": true,\\n \\"RequestId\\": \\"0bc1ec92159376\\",\\n \\"ErrorMessage\\": \\"The connection does not exist.\\",\\n \\"ErrorCode\\": \\"Invalid.Tenant.ConnectionNotExists\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<RequestId>0bc1ec92159376</RequestId>\\n<HttpStatusCode>200</HttpStatusCode>\\n<Data>true</Data>\\n<Success>true</Success>","errorExample":""}]',
+ 'title' => 'UpdateMetaCategory',
+ 'summary' => 'Updates a category.',
+ 'requestParamsDescription' => ' ',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => 'For information about the example on how to use the UpdateMetaCategory operation, see [Examples of DataWorks API operations](https://developer.aliyun.com/article/780879?groupCode=dataworks).'."\n",
+ ],
+ 'GetMetaCategory' => [
+ 'methods' => [
+ 'post',
+ 'get',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'get',
+ 'abilityTreeCode' => '78257',
+ 'abilityTreeNodes' => [
+ 'FEATUREdideE9XYA6',
+ ],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'ParentCategoryId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The category tree ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'docRequired' => true,
+ 'example' => '333',
+ ],
+ ],
+ [
+ 'name' => 'PageNum',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The number of the page to return.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => false,
+ 'example' => '1',
+ ],
+ ],
+ [
+ 'name' => 'PageSize',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The number of entries to return on each page. Default value: 10. Maximum value: 100.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => false,
+ 'example' => '10',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'description' => 'The response parameters.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'HttpStatusCode' => [
+ 'description' => 'The HTTP status code.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '200',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message.'."\n",
+ 'type' => 'string',
+ 'example' => 'The connection does not exist.',
+ ],
+ 'RequestId' => [
+ 'description' => 'The request ID.'."\n",
+ 'type' => 'string',
+ 'example' => '0bc1ec92159376',
+ ],
+ 'Success' => [
+ 'description' => 'Indicates whether the request was successful.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code.'."\n",
+ 'type' => 'string',
+ 'example' => 'Invalid.Tenant.ConnectionNotExists',
+ ],
+ 'Data' => [
+ 'description' => 'The business data.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'PageNum' => [
+ 'description' => 'The page number.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '1',
+ ],
+ 'PageSize' => [
+ 'description' => 'The number of entries per page. Default value: 10. Maximum value: 100.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '10',
+ ],
+ 'TotalCount' => [
+ 'description' => 'The total number of categories returned.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '10',
+ ],
+ 'DataEntityList' => [
+ 'description' => 'The information about the category tree.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '',
+ 'type' => 'object',
+ 'properties' => [
+ 'Depth' => [
+ 'description' => 'The number of category levels.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '1',
+ ],
+ 'Comment' => [
+ 'description' => 'The remarks of the category.'."\n",
+ 'type' => 'string',
+ 'example' => 'category 1',
+ ],
+ 'ModifiedTime' => [
+ 'description' => 'The time when the category was last modified.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '1541576644000',
+ ],
+ 'CreateTime' => [
+ 'description' => 'The time when the category was created.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '1541576644000',
+ ],
+ 'CategoryId' => [
+ 'description' => 'The category ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '133',
+ ],
+ 'LastOperatorId' => [
+ 'description' => 'The ID of the user that performed the last operation.'."\n",
+ 'type' => 'string',
+ 'example' => '12345',
+ ],
+ 'Name' => [
+ 'description' => 'The name of the category.'."\n",
+ 'type' => 'string',
+ 'example' => 'category 1',
+ ],
+ 'ParentCategoryId' => [
+ 'description' => 'The parent category ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '12',
+ ],
+ 'OwnerId' => [
+ 'description' => 'The category owner ID.'."\n",
+ 'type' => 'string',
+ 'example' => '123',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'errorCodes' => [
+ 400 => [
+ [
+ 'errorCode' => 'Invalid.Meta.CategoryIllegalDepth',
+ 'errorMessage' => 'A category can contain a maximum of 4 levels.',
+ ],
+ [
+ 'errorCode' => 'Invalid.Meta.CategoryNameDuplicate',
+ 'errorMessage' => 'The category name is duplicated at this level.',
+ ],
+ [
+ 'errorCode' => 'Invalid.Meta.TableNotExist',
+ 'errorMessage' => 'The table does not exist.',
+ ],
+ [
+ 'errorCode' => 'InvalidParameter.Meta.CommonError',
+ 'errorMessage' => 'The specified parameter is invalid.',
+ ],
+ [
+ 'errorCode' => 'InvalidParameter.Meta.Illegal',
+ 'errorMessage' => 'The app guid parameter is invalid.',
+ ],
+ [
+ 'errorCode' => 'InvalidParameter.Meta.IllegalDate',
+ 'errorMessage' => 'The date format is invalid.',
+ ],
+ [
+ 'errorCode' => 'InvalidParameter.Meta.IllegalPageError',
+ 'errorMessage' => 'The parameter for paging is invalid.',
+ ],
+ [
+ 'errorCode' => 'InvalidParameter.Meta.NotExist',
+ 'errorMessage' => 'The object does not exist.',
+ ],
+ ],
+ 403 => [
+ [
+ 'errorCode' => 'Forbidden.Meta.NoTenant',
+ 'errorMessage' => 'The user is not the owner of any tenants.',
+ ],
+ [
+ 'errorCode' => 'Invalid.Meta.CategoryForbidden',
+ 'errorMessage' => 'Failed to delete the category. The current category is associated with a table and cannot be operated.',
+ ],
+ [
+ 'errorCode' => 'Invalid.Meta.CategoryIllegalTenant',
+ 'errorMessage' => 'The tenant ID is different in the parent and child categories.',
+ ],
+ [
+ 'errorCode' => 'Forbidden.Access',
+ 'errorMessage' => 'Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.',
+ ],
+ ],
+ 429 => [
+ [
+ 'errorCode' => 'Throttling.Api',
+ 'errorMessage' => 'The request for this resource has exceeded your available limit.',
+ ],
+ [
+ 'errorCode' => 'Throttling.Api.Risk',
+ 'errorMessage' => 'The request for this resource has exceeded your daily available limit.',
+ ],
+ [
+ 'errorCode' => 'Throttling.System',
+ 'errorMessage' => 'The DataWorks system is busy. Try again later.',
+ ],
+ [
+ 'errorCode' => 'Throttling.User',
+ 'errorMessage' => 'Your request is too frequent. Try again later.',
+ ],
+ ],
+ 500 => [
+ [
+ 'errorCode' => 'InternalError.System',
+ 'errorMessage' => 'An internal system error occurred. Try again later.',
+ ],
+ [
+ 'errorCode' => 'InternalError.UserId.Missing',
+ 'errorMessage' => 'An internal system error occurred. Try again later.',
+ ],
+ [
+ 'errorCode' => 'InternalError.Meta.NoCalcEngine',
+ 'errorMessage' => 'An error occurred while retrieving the compute engine based on the MaxCompute project.',
+ ],
+ [
+ 'errorCode' => 'InternalError.Meta.TenantTimeOut',
+ 'errorMessage' => 'Failed to connect to the interface network.',
+ ],
+ [
+ 'errorCode' => 'InternalError.Meta.Unknown',
+ 'errorMessage' => 'An unknown error occurred while processing your request.',
+ ],
+ [
+ 'errorCode' => 'Invalid.Meta.CategoryRelationDuplicate"',
+ 'errorMessage' => 'The table is already bound to the category.',
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"ErrorMessage\\": \\"The connection does not exist.\\",\\n \\"RequestId\\": \\"0bc1ec92159376\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"Invalid.Tenant.ConnectionNotExists\\",\\n \\"Data\\": {\\n \\"PageNum\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 10,\\n \\"DataEntityList\\": [\\n {\\n \\"Depth\\": 1,\\n \\"Comment\\": \\"category 1\\",\\n \\"ModifiedTime\\": 1541576644000,\\n \\"CreateTime\\": 1541576644000,\\n \\"CategoryId\\": 133,\\n \\"LastOperatorId\\": \\"12345\\",\\n \\"Name\\": \\"category 1\\",\\n \\"ParentCategoryId\\": 12,\\n \\"OwnerId\\": \\"123\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<GetMetaCategoryResponse>\\n <HttpStatusCode>200</HttpStatusCode>\\n <ErrorMessage>The connection does not exist.</ErrorMessage>\\n <RequestId>0bc1ec92159376</RequestId>\\n <Success>true</Success>\\n <ErrorCode>Invalid.Tenant.ConnectionNotExists</ErrorCode>\\n <Data>\\n <PageNum>1</PageNum>\\n <PageSize>10</PageSize>\\n <TotalCount>10</TotalCount>\\n <DataEntityList>\\n <Depth>1</Depth>\\n <Comment>category 1</Comment>\\n <ModifiedTime>1541576644000</ModifiedTime>\\n <CreateTime>1541576644000</CreateTime>\\n <CategoryId>133</CategoryId>\\n <LastOperatorId>12345</LastOperatorId>\\n <Name>category 1</Name>\\n <ParentCategoryId>12</ParentCategoryId>\\n <OwnerId>123</OwnerId>\\n </DataEntityList>\\n </Data>\\n</GetMetaCategoryResponse>","errorExample":""}]',
+ 'title' => 'GetMetaCategory',
+ 'summary' => 'Queries the information about a category tree.',
+ 'requestParamsDescription' => ' ',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => 'For information about the example on how to use the GetMetaCategory operation, see [Examples of DataWorks API operations](https://developer.aliyun.com/article/780879?groupCode=dataworks).'."\n",
+ ],
+ 'GetMetaTableListByCategory' => [
+ 'methods' => [
+ 'get',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'get',
+ 'abilityTreeCode' => '78267',
+ 'abilityTreeNodes' => [
+ 'FEATUREdideE9XYA6',
+ ],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'PageNumber',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The number of the page to return.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => false,
+ 'example' => '1',
+ ],
+ ],
+ [
+ 'name' => 'PageSize',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The number of entries to return on each page. Default value: 10. Maximum value: 100.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => false,
+ 'example' => '10',
+ ],
+ ],
+ [
+ 'name' => 'CategoryId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The category ID. You can call the [GetMetaCategory](~~2780099~~) operation to obtain the ID of the category. Categories allow you to efficiently organize and manage tables by category. You can search for the desired table by category.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => true,
+ 'docRequired' => true,
+ 'minimum' => '1',
+ 'example' => '23',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'description' => 'The returned result.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'HttpStatusCode' => [
+ 'description' => 'The HTTP status code returned.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '200',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message returned.'."\n",
+ 'type' => 'string',
+ 'example' => 'The connection does not exist.',
+ ],
+ 'RequestId' => [
+ 'description' => 'The ID of the request.'."\n",
+ 'type' => 'string',
+ 'example' => '0bc1ec92159376',
+ ],
+ 'Success' => [
+ 'description' => 'Indicates whether the request was successful.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code returned.'."\n",
+ 'type' => 'string',
+ 'example' => 'Invalid.Tenant.ConnectionNotExists',
+ ],
+ 'Data' => [
+ 'description' => 'The business data returned.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'PageNumber' => [
+ 'description' => 'The page number of the returned page.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '1',
+ ],
+ 'PageSize' => [
+ 'description' => 'The number of entries returned per page. Default value: 10. Maximum value: 100.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '10',
+ ],
+ 'TotalCount' => [
+ 'description' => 'The total number of metatables.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '20',
+ ],
+ 'TableGuidList' => [
+ 'description' => 'The returned result.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The list of metatables.'."\n",
+ 'type' => 'string',
+ 'example' => 'odps.engine_name.table_name',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'errorCodes' => [
+ 400 => [
+ [
+ 'errorCode' => 'Invalid.Meta.CategoryIllegalDepth',
+ 'errorMessage' => 'A category can contain a maximum of 4 levels.',
+ ],
+ [
+ 'errorCode' => 'Invalid.Meta.CategoryNameDuplicate',
+ 'errorMessage' => 'The category name is duplicated at this level.',
+ ],
+ [
+ 'errorCode' => 'Invalid.Meta.TableNotExist',
+ 'errorMessage' => 'The table does not exist.',
+ ],
+ [
+ 'errorCode' => 'InvalidParameter.Meta.CommonError',
+ 'errorMessage' => 'The specified parameter is invalid.',
+ ],
+ [
+ 'errorCode' => 'InvalidParameter.Meta.Illegal',
+ 'errorMessage' => 'The app guid parameter is invalid.',
+ ],
+ [
+ 'errorCode' => 'InvalidParameter.Meta.IllegalDate',
+ 'errorMessage' => 'The date format is invalid.',
+ ],
+ [
+ 'errorCode' => 'InvalidParameter.Meta.IllegalPageError',
+ 'errorMessage' => 'The parameter for paging is invalid.',
+ ],
+ [
+ 'errorCode' => 'InvalidParameter.Meta.NotExist',
+ 'errorMessage' => 'The object does not exist.',
+ ],
+ ],
+ 403 => [
+ [
+ 'errorCode' => 'Forbidden.Meta.NoTenant',
+ 'errorMessage' => 'The user is not the owner of any tenants.',
+ ],
+ [
+ 'errorCode' => 'Invalid.Meta.CategoryForbidden',
+ 'errorMessage' => 'Failed to delete the category. The current category is associated with a table and cannot be operated.',
+ ],
+ [
+ 'errorCode' => 'Invalid.Meta.CategoryIllegalTenant',
+ 'errorMessage' => 'The tenant ID is different in the parent and child categories.',
+ ],
+ [
+ 'errorCode' => 'Forbidden.Access',
+ 'errorMessage' => 'Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.',
+ ],
+ ],
+ 429 => [
+ [
+ 'errorCode' => 'Throttling.Api',
+ 'errorMessage' => 'The request for this resource has exceeded your available limit.',
+ ],
+ [
+ 'errorCode' => 'Throttling.Api.Risk',
+ 'errorMessage' => 'The request for this resource has exceeded your daily available limit.',
+ ],
+ [
+ 'errorCode' => 'Throttling.System',
+ 'errorMessage' => 'The DataWorks system is busy. Try again later.',
+ ],
+ [
+ 'errorCode' => 'Throttling.User',
+ 'errorMessage' => 'Your request is too frequent. Try again later.',
+ ],
+ ],
+ 500 => [
+ [
+ 'errorCode' => 'InternalError.System',
+ 'errorMessage' => 'An internal system error occurred. Try again later.',
+ ],
+ [
+ 'errorCode' => 'InternalError.UserId.Missing',
+ 'errorMessage' => 'An internal system error occurred. Try again later.',
+ ],
+ [
+ 'errorCode' => 'InternalError.Meta.NoCalcEngine',
+ 'errorMessage' => 'An error occurred while retrieving the compute engine based on the MaxCompute project.',
+ ],
+ [
+ 'errorCode' => 'InternalError.Meta.TenantTimeOut',
+ 'errorMessage' => 'Failed to connect to the interface network.',
+ ],
+ [
+ 'errorCode' => 'InternalError.Meta.Unknown',
+ 'errorMessage' => 'An unknown error occurred while processing your request.',
+ ],
+ [
+ 'errorCode' => 'Invalid.Meta.CategoryRelationDuplicate"',
+ 'errorMessage' => 'The table is already bound to the category.',
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"ErrorMessage\\": \\"The connection does not exist.\\",\\n \\"RequestId\\": \\"0bc1ec92159376\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"Invalid.Tenant.ConnectionNotExists\\",\\n \\"Data\\": {\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 20,\\n \\"TableGuidList\\": [\\n \\"odps.engine_name.table_name\\"\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<GetMetaTableListByCategoryResponse>\\n <HttpStatusCode>200</HttpStatusCode>\\n <ErrorMessage>The connection does not exist.</ErrorMessage>\\n <RequestId>0bc1ec92159376</RequestId>\\n <Success>true</Success>\\n <ErrorCode>Invalid.Tenant.ConnectionNotExists</ErrorCode>\\n <Data>\\n <PageNumber>1</PageNumber>\\n <PageSize>10</PageSize>\\n <TotalCount>20</TotalCount>\\n <TableGuidList>odps.engine_name.table_name</TableGuidList>\\n </Data>\\n</GetMetaTableListByCategoryResponse>","errorExample":""}]',
+ 'title' => 'GetMetaTableListByCategory',
+ 'summary' => 'Queries metatables in a specified category.',
+ 'requestParamsDescription' => ' ',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => 'For more information about the example on how to use the GetMetaTableListByCategory operation, see [Examples of DataWorks API operations](https://developer.aliyun.com/article/780879?groupCode=dataworks).'."\n",
+ ],
+ 'AddToMetaCategory' => [
+ 'methods' => [
+ 'post',
+ 'get',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'readAndWrite',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'create',
+ 'abilityTreeCode' => '78167',
+ 'abilityTreeNodes' => [
+ 'FEATUREdideRZEBFC',
+ ],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'CategoryId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the category.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => '5',
+ ],
+ ],
+ [
+ 'name' => 'TableGuid',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The GUID of the metatable.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'odps.engine_name.table_name',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'HttpStatusCode' => [
+ 'description' => 'The HTTP status code.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '200',
+ ],
+ 'Data' => [
+ 'description' => 'Indicates whether the metatable was added to the specified category.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'RequestId' => [
+ 'description' => 'The request ID.'."\n",
+ 'type' => 'string',
+ 'example' => '0bc1ec92159376',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message.'."\n",
+ 'type' => 'string',
+ 'example' => 'The connection does not exist.',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code.'."\n",
+ 'type' => 'string',
+ 'example' => 'Invalid.Tenant.ConnectionNotExists',
+ ],
+ 'Success' => [
+ 'description' => 'Indicates whether the request was successful.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ ],
+ 'description' => '',
+ ],
+ ],
+ ],
+ 'errorCodes' => [
+ 403 => [
+ [
+ 'errorCode' => 'Forbidden.Access',
+ 'errorMessage' => 'Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.',
+ ],
+ ],
+ 429 => [
+ [
+ 'errorCode' => 'Throttling.Api',
+ 'errorMessage' => 'The request for this resource has exceeded your available limit.',
+ ],
+ [
+ 'errorCode' => 'Throttling.Api.Risk',
+ 'errorMessage' => 'The request for this resource has exceeded your daily available limit.',
+ ],
+ [
+ 'errorCode' => 'Throttling.System',
+ 'errorMessage' => 'The DataWorks system is busy. Try again later.',
+ ],
+ [
+ 'errorCode' => 'Throttling.User',
+ 'errorMessage' => 'Your request is too frequent. Try again later.',
+ ],
+ ],
+ 500 => [
+ [
+ 'errorCode' => 'InternalError.System',
+ 'errorMessage' => 'An internal system error occurred. Try again later.',
+ ],
+ [
+ 'errorCode' => 'InternalError.UserId.Missing',
+ 'errorMessage' => 'An internal system error occurred. Try again later.',
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Data\\": true,\\n \\"RequestId\\": \\"0bc1ec92159376\\",\\n \\"ErrorMessage\\": \\"The connection does not exist.\\",\\n \\"ErrorCode\\": \\"Invalid.Tenant.ConnectionNotExists\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<RequestId>0bc1ec92159376</RequestId>\\n<HttpStatusCode>200</HttpStatusCode>\\n<Data>true</Data>\\n<Success>true</Success>","errorExample":""}]',
+ 'title' => 'AddToMetaCategory',
+ 'summary' => 'Adds a metatable to a specified category.',
+ 'requestParamsDescription' => ' ',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => 'For information about the example on how to use the AddToMetaCategory operation, see [Examples of DataWorks API operations](https://developer.aliyun.com/article/780879?groupCode=dataworks).'."\n",
+ ],
+ 'DeleteFromMetaCategory' => [
+ 'methods' => [
+ 'post',
+ 'get',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'readAndWrite',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'delete',
+ 'abilityTreeCode' => '78210',
+ 'abilityTreeNodes' => [
+ 'FEATUREdideRZEBFC',
+ ],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'CategoryId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the category.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => '5',
+ ],
+ ],
+ [
+ 'name' => 'TableGuid',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The GUID of the metatable.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'odps.engine_name.table_name',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'description' => 'The returned results.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'HttpStatusCode' => [
+ 'description' => 'The HTTP status code returned.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '200',
+ ],
+ 'Data' => [
+ 'description' => 'Indicates whether the table was removed from the specified category.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'RequestId' => [
+ 'description' => 'The request ID.'."\n",
+ 'type' => 'string',
+ 'example' => '0bc1ec92159376',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message returned.'."\n",
+ 'type' => 'string',
+ 'example' => 'The connection does not exist.',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code returned.'."\n",
+ 'type' => 'string',
+ 'example' => 'Invalid.Tenant.ConnectionNotExists',
+ ],
+ 'Success' => [
+ 'description' => 'Indicates whether the request was successful.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'errorCodes' => [
+ 403 => [
+ [
+ 'errorCode' => 'Forbidden.Access',
+ 'errorMessage' => 'Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.',
+ ],
+ ],
+ 429 => [
+ [
+ 'errorCode' => 'Throttling.Api',
+ 'errorMessage' => 'The request for this resource has exceeded your available limit.',
+ ],
+ [
+ 'errorCode' => 'Throttling.Api.Risk',
+ 'errorMessage' => 'The request for this resource has exceeded your daily available limit.',
+ ],
+ [
+ 'errorCode' => 'Throttling.System',
+ 'errorMessage' => 'The DataWorks system is busy. Try again later.',
+ ],
+ [
+ 'errorCode' => 'Throttling.User',
+ 'errorMessage' => 'Your request is too frequent. Try again later.',
+ ],
+ ],
+ 500 => [
+ [
+ 'errorCode' => 'InternalError.System',
+ 'errorMessage' => 'An internal system error occurred. Try again later.',
+ ],
+ [
+ 'errorCode' => 'InternalError.UserId.Missing',
+ 'errorMessage' => 'An internal system error occurred. Try again later.',
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Data\\": true,\\n \\"RequestId\\": \\"0bc1ec92159376\\",\\n \\"ErrorMessage\\": \\"The connection does not exist.\\",\\n \\"ErrorCode\\": \\"Invalid.Tenant.ConnectionNotExists\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<DeleteFromMetaCategoryResponse>\\n <HttpStatusCode>200</HttpStatusCode>\\n <Data>true</Data>\\n <RequestId>0bc1ec92159376</RequestId>\\n <ErrorMessage>The connection does not exist.</ErrorMessage>\\n <ErrorCode>Invalid.Tenant.ConnectionNotExists</ErrorCode>\\n <Success>true</Success>\\n</DeleteFromMetaCategoryResponse>","errorExample":""}]',
+ 'title' => 'DeleteFromMetaCategory',
+ 'summary' => 'Removes a table from a specified category.',
+ 'requestParamsDescription' => ' ',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => 'For information about the example on how to use the DeleteFromMetaCategory operation, see [Examples of DataWorks API operations](https://developer.aliyun.com/article/780879?groupCode=dataworks).'."\n",
+ ],
+ 'UpdateMetaTable' => [
+ 'methods' => [
+ 'post',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'write',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'update',
+ 'abilityTreeCode' => '78375',
+ 'abilityTreeNodes' => [
+ 'FEATUREdideRZEBFC',
+ ],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'ProjectId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The DataWorks workspace ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'docRequired' => true,
+ 'maximum' => '9223372036854775807',
+ 'minimum' => '0',
+ 'example' => '101',
+ ],
+ ],
+ [
+ 'name' => 'TableName',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The name of the table.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'docRequired' => true,
+ 'example' => 'table1',
+ ],
+ ],
+ [
+ 'name' => 'EnvType',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The environment of the DataWorks workspace. Valid values: 0 and 1. The value 0 indicates the development environment. The value 1 indicates the production environment.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => false,
+ 'docRequired' => true,
+ 'example' => '1',
+ ],
+ ],
+ [
+ 'name' => 'TableGuid',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The GUID of the table. Specify the GUID in the format of odps.{projectName}.{tableName}.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'odps.test.table1',
+ ],
+ ],
+ [
+ 'name' => 'NewOwnerId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The new owner ID. If you leave this parameter empty, the owner ID is not updated.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => '12345',
+ ],
+ ],
+ [
+ 'name' => 'AddedLabels',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The names of the labels that you want to add. Separate the labels with commas (,).'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'a,b,c',
+ ],
+ ],
+ [
+ 'name' => 'RemovedLabels',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The names of labels that you want to remove. Separate the labels with commas (,).'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'a,b,c',
+ ],
+ ],
+ [
+ 'name' => 'CategoryId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the category that you want to associate.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'maximum' => '9223372036854775807',
+ 'minimum' => '0',
+ 'example' => '101',
+ ],
+ ],
+ [
+ 'name' => 'Visibility',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The scope in which the table is visible. Valid values: 0, 1, and 2. The value 0 indicates that the table is invisible to all members. The value 1 indicates that the table is visible to all members. The value 2 indicates that the table is visible to workspace members.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => false,
+ 'maximum' => '100',
+ 'minimum' => '0',
+ 'example' => '1',
+ ],
+ ],
+ [
+ 'name' => 'Caption',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The display name of the table.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'test',
+ ],
+ ],
+ [
+ 'name' => 'Schema',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The schema information about the table. You must configure this parameter if you enable the three-layer model of MaxCompute.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'default',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'UpdateResult' => [
+ 'description' => 'Indicates whether the metadata information about the table was updated.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'RequestId' => [
+ 'description' => 'The request ID.'."\n",
+ 'type' => 'string',
+ 'example' => 'abcde',
+ ],
+ ],
+ 'description' => '',
+ ],
+ ],
+ ],
+ 'errorCodes' => [
+ 403 => [
+ [
+ 'errorCode' => 'Forbidden.Access',
+ 'errorMessage' => 'Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.',
+ ],
+ ],
+ 429 => [
+ [
+ 'errorCode' => 'Throttling.Api',
+ 'errorMessage' => 'The request for this resource has exceeded your available limit.',
+ ],
+ [
+ 'errorCode' => 'Throttling.Api.Risk',
+ 'errorMessage' => 'The request for this resource has exceeded your daily available limit.',
+ ],
+ [
+ 'errorCode' => 'Throttling.System',
+ 'errorMessage' => 'The DataWorks system is busy. Try again later.',
+ ],
+ [
+ 'errorCode' => 'Throttling.User',
+ 'errorMessage' => 'Your request is too frequent. Try again later.',
+ ],
+ ],
+ 500 => [
+ [
+ 'errorCode' => 'InternalError.System',
+ 'errorMessage' => 'An internal system error occurred. Try again later.',
+ ],
+ [
+ 'errorCode' => 'InternalError.UserId.Missing',
+ 'errorMessage' => 'An internal system error occurred. Try again later.',
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"UpdateResult\\": true,\\n \\"RequestId\\": \\"abcde\\"\\n}","errorExample":""},{"type":"xml","example":"<UpdateMetaTableResponse>\\n <UpdateResult>true</UpdateResult>\\n <RequestId>abcde</RequestId>\\n</UpdateMetaTableResponse>","errorExample":""}]',
+ 'title' => 'UpdateMetaTable',
+ 'summary' => 'This operation updates the metadata of a table.',
+ 'description' => 'This operation supports MaxCompute tables only.'."\n",
+ 'requestParamsDescription' => ' ',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ ],
+ 'UpdateMetaTableIntroWiki' => [
+ 'methods' => [
+ 'post',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'write',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'update',
+ 'abilityTreeCode' => '78376',
+ 'abilityTreeNodes' => [
+ 'FEATUREdideRZEBFC',
+ ],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'TableGuid',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The GUID of the table. Specify the GUID in the odps.{projectName}.{tableName} format.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'odps.test.table1',
+ ],
+ ],
+ [
+ 'name' => 'Content',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The details of the instructions on how to use the metatable.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'abc',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'description' => 'The returned result.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'UpdateResult' => [
+ 'description' => 'Indicates whether the instructions on how to use the table are updated.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'RequestId' => [
+ 'description' => 'The request ID. You can troubleshoot issues based on the ID.'."\n",
+ 'type' => 'string',
+ 'example' => 'abcde',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'errorCodes' => [
+ 403 => [
+ [
+ 'errorCode' => 'Forbidden.Access',
+ 'errorMessage' => 'Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.',
+ ],
+ ],
+ 429 => [
+ [
+ 'errorCode' => 'Throttling.Api',
+ 'errorMessage' => 'The request for this resource has exceeded your available limit.',
+ ],
+ [
+ 'errorCode' => 'Throttling.Api.Risk',
+ 'errorMessage' => 'The request for this resource has exceeded your daily available limit.',
+ ],
+ [
+ 'errorCode' => 'Throttling.System',
+ 'errorMessage' => 'The DataWorks system is busy. Try again later.',
+ ],
+ [
+ 'errorCode' => 'Throttling.User',
+ 'errorMessage' => 'Your request is too frequent. Try again later.',
+ ],
+ ],
+ 500 => [
+ [
+ 'errorCode' => 'InternalError.System',
+ 'errorMessage' => 'An internal system error occurred. Try again later.',
+ ],
+ [
+ 'errorCode' => 'InternalError.UserId.Missing',
+ 'errorMessage' => 'An internal system error occurred. Try again later.',
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"UpdateResult\\": true,\\n \\"RequestId\\": \\"abcde\\"\\n}","errorExample":""},{"type":"xml","example":"<UpdateMetaTableIntroWikiResponse>\\n <UpdateResult>true</UpdateResult>\\n <RequestId>abcde</RequestId>\\n</UpdateMetaTableIntroWikiResponse>","errorExample":""}]',
+ 'title' => 'UpdateMetaTableIntroWiki',
+ 'summary' => 'Updates the instructions on how to use a table. If no instruction on how to use the table is available, the instructions that are configured by calling this operation are added.',
+ 'requestParamsDescription' => ' ',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ ],
+ 'ListMetaDB' => [
+ 'methods' => [
+ 'get',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'get',
+ 'abilityTreeCode' => '78317',
+ 'abilityTreeNodes' => [
+ 'FEATUREdideE9XYA6',
+ ],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'ProjectId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The DataWorks workspace ID. You can call the [ListProjects](~~178393~~) operation to query the ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => '123',
+ ],
+ ],
+ [
+ 'name' => 'DataSourceType',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The type of the data source. Set the value to emr.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'emr',
+ ],
+ ],
+ [
+ 'name' => 'PageNum',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The page number.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => false,
+ 'maximum' => '10000',
+ 'minimum' => '1',
+ 'example' => '1',
+ ],
+ ],
+ [
+ 'name' => 'PageSize',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The number of entries per page. Default value: 10. Maximum value: 100.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => false,
+ 'maximum' => '100',
+ 'minimum' => '1',
+ 'example' => '10',
+ ],
+ ],
+ [
+ 'name' => 'ClusterId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the E-MapReduce (EMR) cluster. You can log on to the [EMR console](https://emr.console.aliyun.com/?spm=a2c4g.11186623.0.0.965cc5c2GeiHet#/cn-hangzhou) to query the ID.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'abc',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'description' => 'The response parameters.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'description' => 'The request ID.'."\n",
+ 'type' => 'string',
+ 'example' => 'abc',
+ ],
+ 'DatabaseInfo' => [
+ 'description' => 'The information about the metadatabases.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'TotalCount' => [
+ 'description' => 'The total number of the metadatabases returned.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '10',
+ ],
+ 'DbList' => [
+ 'description' => 'The metadatabases.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '',
+ 'type' => 'object',
+ 'properties' => [
+ 'Type' => [
+ 'description' => 'The type of the metadatabase.'."\n",
+ 'type' => 'string',
+ 'example' => 'HIVE',
+ ],
+ 'CreateTimeStamp' => [
+ 'description' => 'The timestamp at which the metadatabase was created. You can convert the timestamp to the date based on the time zone that you use.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '1388776825',
+ ],
+ 'UUID' => [
+ 'description' => 'The UUID of the metadatabase.'."\n",
+ 'type' => 'string',
+ 'example' => '32342',
+ ],
+ 'ModifiedTimeStamp' => [
+ 'description' => 'The timestamp at which the metadatabase was updated.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '1388776837',
+ ],
+ 'Name' => [
+ 'description' => 'The name of the metadatabase.'."\n",
+ 'type' => 'string',
+ 'example' => 'name',
+ ],
+ 'OwnerId' => [
+ 'description' => 'The owner ID.'."\n",
+ 'type' => 'string',
+ 'example' => '1232',
+ ],
+ 'Location' => [
+ 'description' => 'The URL of the metadatabase.'."\n",
+ 'type' => 'string',
+ 'example' => 'hdfs://localhost:777/user/hadoop/test.txt',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'errorCodes' => [
+ 400 => [
+ [
+ 'errorCode' => 'Invalid.Meta.AppNotExist',
+ 'errorMessage' => 'The MaxCompute project does not exist.',
+ ],
+ [
+ 'errorCode' => 'InvalidParameter.Meta.CommonError',
+ 'errorMessage' => 'The specified parameter is invalid.',
+ ],
+ [
+ 'errorCode' => 'InvalidParameter.Meta.Illegal',
+ 'errorMessage' => 'The app guid parameter is invalid.',
+ ],
+ [
+ 'errorCode' => 'InvalidParameter.Meta.IllegalDate',
+ 'errorMessage' => 'The date format is invalid.',
+ ],
+ [
+ 'errorCode' => 'InvalidParameter.Meta.IllegalPageError',
+ 'errorMessage' => 'The parameter for paging is invalid.',
+ ],
+ [
+ 'errorCode' => 'InvalidParameter.Meta.NotExist',
+ 'errorMessage' => 'The object does not exist.',
+ ],
+ ],
+ 403 => [
+ [
+ 'errorCode' => 'Forbidden.Meta.NoTenant',
+ 'errorMessage' => 'The user is not the owner of any tenants.',
+ ],
+ [
+ 'errorCode' => 'Forbidden.Access',
+ 'errorMessage' => 'Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.',
+ ],
+ ],
+ 429 => [
+ [
+ 'errorCode' => 'Throttling.Api',
+ 'errorMessage' => 'The request for this resource has exceeded your available limit.',
+ ],
+ [
+ 'errorCode' => 'Throttling.Api.Risk',
+ 'errorMessage' => 'The request for this resource has exceeded your daily available limit.',
+ ],
+ [
+ 'errorCode' => 'Throttling.System',
+ 'errorMessage' => 'The DataWorks system is busy. Try again later.',
+ ],
+ [
+ 'errorCode' => 'Throttling.User',
+ 'errorMessage' => 'Your request is too frequent. Try again later.',
+ ],
+ ],
+ 500 => [
+ [
+ 'errorCode' => 'InternalError.System',
+ 'errorMessage' => 'An internal system error occurred. Try again later.',
+ ],
+ [
+ 'errorCode' => 'InternalError.UserId.Missing',
+ 'errorMessage' => 'An internal system error occurred. Try again later.',
+ ],
+ [
+ 'errorCode' => 'InternalError.Meta.NoCalcEngine',
+ 'errorMessage' => 'An error occurred while retrieving the compute engine based on the MaxCompute project.',
+ ],
+ [
+ 'errorCode' => 'InternalError.Meta.TenantTimeOut',
+ 'errorMessage' => 'Failed to connect to the interface network.',
+ ],
+ [
+ 'errorCode' => 'InternalError.Meta.Unknown',
+ 'errorMessage' => 'An unknown error occurred while processing your request.',
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"abc\\",\\n \\"DatabaseInfo\\": {\\n \\"TotalCount\\": 10,\\n \\"DbList\\": [\\n {\\n \\"Type\\": \\"HIVE\\",\\n \\"CreateTimeStamp\\": 1388776825,\\n \\"UUID\\": \\"32342\\",\\n \\"ModifiedTimeStamp\\": 1388776837,\\n \\"Name\\": \\"name\\",\\n \\"OwnerId\\": \\"1232\\",\\n \\"Location\\": \\"hdfs://localhost:777/user/hadoop/test.txt\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<ListMetaDBResponse>\\n <RequestId>abc</RequestId>\\n <DatabaseInfo>\\n <TotalCount>10</TotalCount>\\n <DbList>\\n <Type>HIVE</Type>\\n <CreateTimeStamp>1388776825</CreateTimeStamp>\\n <UUID>32342</UUID>\\n <ModifiedTimeStamp>1388776837</ModifiedTimeStamp>\\n <Name>name</Name>\\n <OwnerId>1232</OwnerId>\\n <Location>hdfs://localhost:777/user/hadoop/test.txt</Location>\\n </DbList>\\n </DatabaseInfo>\\n</ListMetaDBResponse>","errorExample":""}]',
+ 'title' => 'ListMetaDB',
+ 'summary' => 'Queries a list of metadatabases.',
+ 'requestParamsDescription' => ' ',
+ 'responseParamsDescription' => ' ',
+ ],
+ 'UpdateTableModelInfo' => [
+ 'methods' => [
+ 'post',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'write',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'update',
+ 'abilityTreeCode' => '78385',
+ 'abilityTreeNodes' => [
+ 'FEATUREdideRZEBFC',
+ ],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'FirstLevelThemeId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the first-level table folder.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'docRequired' => true,
+ 'maximum' => '9223372036854775807',
+ 'minimum' => '0',
+ 'example' => '101',
+ ],
+ ],
+ [
+ 'name' => 'SecondLevelThemeId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the second-level table folder.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'docRequired' => true,
+ 'maximum' => '9223372036854775807',
+ 'minimum' => '0',
+ 'example' => '101',
+ ],
+ ],
+ [
+ 'name' => 'LevelId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The table level ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'docRequired' => true,
+ 'maximum' => '9223372036854775807',
+ 'minimum' => '0',
+ 'example' => '101',
+ ],
+ ],
+ [
+ 'name' => 'TableGuid',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The GUID of the table. Specify the GUID in the odps.{projectName}.{tableName} format.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'odps.test.table1',
+ ],
+ ],
+ [
+ 'name' => 'LevelType',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The type of the table level. Valid values: 1 and 2. The value 1 indicates the logical level. The value 2 indicates the physical level.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => false,
+ 'maximum' => '2147483647',
+ 'minimum' => '0',
+ 'example' => '1',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'UpdateResult' => [
+ 'description' => 'Indicates whether the request was successful.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'RequestId' => [
+ 'description' => 'The request ID.'."\n",
+ 'type' => 'string',
+ 'example' => 'abcde',
+ ],
+ ],
+ 'description' => '',
+ ],
+ ],
+ ],
+ 'errorCodes' => [
+ 403 => [
+ [
+ 'errorCode' => 'Forbidden.Access',
+ 'errorMessage' => 'Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.',
+ ],
+ ],
+ 429 => [
+ [
+ 'errorCode' => 'Throttling.Api',
+ 'errorMessage' => 'The request for this resource has exceeded your available limit.',
+ ],
+ [
+ 'errorCode' => 'Throttling.Api.Risk',
+ 'errorMessage' => 'The request for this resource has exceeded your daily available limit.',
+ ],
+ [
+ 'errorCode' => 'Throttling.System',
+ 'errorMessage' => 'The DataWorks system is busy. Try again later.',
+ ],
+ [
+ 'errorCode' => 'Throttling.User',
+ 'errorMessage' => 'Your request is too frequent. Try again later.',
+ ],
+ ],
+ 500 => [
+ [
+ 'errorCode' => 'InternalError.System',
+ 'errorMessage' => 'An internal system error occurred. Try again later.',
+ ],
+ [
+ 'errorCode' => 'InternalError.UserId.Missing',
+ 'errorMessage' => 'An internal system error occurred. Try again later.',
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"UpdateResult\\": true,\\n \\"RequestId\\": \\"abcde\\"\\n}","errorExample":""},{"type":"xml","example":"<RequestId>abcde</RequestId>\\n<UpdateResult>true</UpdateResult>","errorExample":""}]',
+ 'title' => 'UpdateTableModelInfo',
+ 'summary' => 'Modifies the information about a table, such as the table folder, level, and category.',
+ 'requestParamsDescription' => ' ',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ ],
+ 'CreateTableTheme' => [
+ 'summary' => 'Creates a table theme. This operation will be replaced soon. We recommend that you do not call this operation.',
+ 'methods' => [
+ 'post',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'write',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'create',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeCode' => '78199',
+ 'abilityTreeNodes' => [
+ 'FEATUREdideRZEBFC',
+ ],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'ProjectId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The DataWorks workspace ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'docRequired' => true,
+ 'maximum' => '9223372036854775807',
+ 'minimum' => '1',
+ 'example' => '123',
+ ],
+ ],
+ [
+ 'name' => 'Level',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The level of the table theme. Valid values: 1 and 2. The value 1 indicates the first level. The value 2 indicates the second level.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => true,
+ 'docRequired' => true,
+ 'maximum' => '10',
+ 'minimum' => '1',
+ 'example' => '1',
+ ],
+ ],
+ [
+ 'name' => 'Name',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The name of the table theme.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'test',
+ ],
+ ],
+ [
+ 'name' => 'ParentId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the level of the parent table theme.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'maximum' => '9223372036854775807',
+ 'minimum' => '1',
+ 'example' => '122',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'description' => 'The response parameters.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'HttpStatusCode' => [
+ 'description' => 'The HTTP status code.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '200',
+ ],
+ 'RequestId' => [
+ 'description' => 'The request ID.'."\n",
+ 'type' => 'string',
+ 'example' => 'ABCd',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message.'."\n",
+ 'type' => 'string',
+ 'example' => 'success',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code.'."\n",
+ 'type' => 'string',
+ 'example' => '0',
+ ],
+ 'Success' => [
+ 'description' => 'Indicates whether the request was successful.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'ThemeId' => [
+ 'description' => 'The table theme ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '123',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'errorCodes' => [
+ 403 => [
+ [
+ 'errorCode' => 'Forbidden.Access',
+ 'errorMessage' => 'Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.',
+ ],
+ ],
+ 429 => [
+ [
+ 'errorCode' => 'Throttling.Api',
+ 'errorMessage' => 'The request for this resource has exceeded your available limit.',
+ ],
+ [
+ 'errorCode' => 'Throttling.Api.Risk',
+ 'errorMessage' => 'The request for this resource has exceeded your daily available limit.',
+ ],
+ [
+ 'errorCode' => 'Throttling.System',
+ 'errorMessage' => 'The DataWorks system is busy. Try again later.',
+ ],
+ [
+ 'errorCode' => 'Throttling.User',
+ 'errorMessage' => 'Your request is too frequent. Try again later.',
+ ],
+ ],
+ 500 => [
+ [
+ 'errorCode' => 'InternalError.System',
+ 'errorMessage' => 'An internal system error occurred. Try again later.',
+ ],
+ [
+ 'errorCode' => 'InternalError.UserId.Missing',
+ 'errorMessage' => 'An internal system error occurred. Try again later.',
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"ABCd\\",\\n \\"ErrorMessage\\": \\"success\\",\\n \\"ErrorCode\\": \\"0\\",\\n \\"Success\\": true,\\n \\"ThemeId\\": 123\\n}","errorExample":""},{"type":"xml","example":"<CreateTableThemeResponse>\\n <HttpStatusCode>200</HttpStatusCode>\\n <RequestId>ABCd</RequestId>\\n <ErrorMessage>success</ErrorMessage>\\n <ErrorCode>0</ErrorCode>\\n <Success>true</Success>\\n <ThemeId>123</ThemeId>\\n</CreateTableThemeResponse>","errorExample":""}]',
+ 'title' => 'CreateTableTheme',
+ 'requestParamsDescription' => ' ',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ ],
+ 'DeleteTableTheme' => [
+ 'summary' => 'Deletes a table theme. This operation will be replaced soon. We recommend that you do not call this operation.',
+ 'methods' => [
+ 'post',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'delete',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeCode' => '78220',
+ 'abilityTreeNodes' => [
+ 'FEATUREdideRZEBFC',
+ ],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'ThemeId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the theme.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => true,
+ 'docRequired' => true,
+ 'maximum' => '9223372036854775807',
+ 'minimum' => '1',
+ 'example' => '123',
+ ],
+ ],
+ [
+ 'name' => 'ProjectId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the DataWorks workspace.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'maximum' => '9223372036854775807',
+ 'minimum' => '1',
+ 'example' => '123',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'HttpStatusCode' => [
+ 'description' => 'The HTTP status code.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '200',
+ ],
+ 'RequestId' => [
+ 'description' => 'The request ID.'."\n",
+ 'type' => 'string',
+ 'example' => 'abcdef',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message.'."\n",
+ 'type' => 'string',
+ 'example' => 'The specified parameters are invalid.',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code.'."\n",
+ 'type' => 'string',
+ 'example' => '1031203110005',
+ ],
+ 'Success' => [
+ 'description' => 'Indicates whether the request was successful. Valid values:'."\n"
+ ."\n"
+ .'* true'."\n"
+ .'* false'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'DeleteResult' => [
+ 'description' => 'Indicates whether the theme was deleted.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ ],
+ 'description' => '',
+ ],
+ ],
+ ],
+ 'errorCodes' => [
+ 403 => [
+ [
+ 'errorCode' => 'Forbidden.Access',
+ 'errorMessage' => 'Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.',
+ ],
+ ],
+ 429 => [
+ [
+ 'errorCode' => 'Throttling.Api',
+ 'errorMessage' => 'The request for this resource has exceeded your available limit.',
+ ],
+ [
+ 'errorCode' => 'Throttling.Api.Risk',
+ 'errorMessage' => 'The request for this resource has exceeded your daily available limit.',
+ ],
+ [
+ 'errorCode' => 'Throttling.System',
+ 'errorMessage' => 'The DataWorks system is busy. Try again later.',
+ ],
+ [
+ 'errorCode' => 'Throttling.User',
+ 'errorMessage' => 'Your request is too frequent. Try again later.',
+ ],
+ ],
+ 500 => [
+ [
+ 'errorCode' => 'InternalError.System',
+ 'errorMessage' => 'An internal system error occurred. Try again later.',
+ ],
+ [
+ 'errorCode' => 'InternalError.UserId.Missing',
+ 'errorMessage' => 'An internal system error occurred. Try again later.',
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"abcdef\\",\\n \\"ErrorMessage\\": \\"The specified parameters are invalid.\\",\\n \\"ErrorCode\\": \\"1031203110005\\",\\n \\"Success\\": true,\\n \\"DeleteResult\\": true\\n}","errorExample":""},{"type":"xml","example":"<RequestId>abcdef</RequestId>\\n<HttpStatusCode>200</HttpStatusCode>\\n<ErrorCode>0</ErrorCode>\\n<ErrorMessage>success</ErrorMessage>\\n<Success>true</Success>\\n<DeleteResult>true</DeleteResult>","errorExample":""}]',
+ 'title' => 'DeleteTableTheme',
+ 'requestParamsDescription' => ' ',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ ],
+ 'UpdateTableTheme' => [
+ 'summary' => 'Updates a table theme. This operation will be replaced soon. We recommend that you do not call this operation.',
+ 'methods' => [
+ 'post',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'write',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'update',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeCode' => '78386',
+ 'abilityTreeNodes' => [
+ 'FEATUREdideRZEBFC',
+ ],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'ProjectId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The workspace ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'docRequired' => true,
+ 'maximum' => '9223372036854775807',
+ 'minimum' => '1',
+ 'example' => '123',
+ ],
+ ],
+ [
+ 'name' => 'Name',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The name of the theme.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'table folder name',
+ ],
+ ],
+ [
+ 'name' => 'ThemeId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the theme.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => true,
+ 'docRequired' => true,
+ 'maximum' => '9223372036854775807',
+ 'minimum' => '1',
+ 'example' => '123',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'HttpStatusCode' => [
+ 'description' => 'The HTTP status code.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '200',
+ ],
+ 'RequestId' => [
+ 'description' => 'The request ID.'."\n",
+ 'type' => 'string',
+ 'example' => 'abcd',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message.'."\n",
+ 'type' => 'string',
+ 'example' => 'The specified parameters are invalid.',
+ ],
+ 'UpdateResult' => [
+ 'description' => 'Indicates whether the update result is returned. Valid values:'."\n"
+ ."\n"
+ .'* true'."\n"
+ .'* false'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code.'."\n",
+ 'type' => 'string',
+ 'example' => '1031203110005',
+ ],
+ 'Success' => [
+ 'description' => 'Indicates whether the request was successful. Valid values:'."\n"
+ ."\n"
+ .'* true'."\n"
+ .'* false'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ ],
+ 'description' => '',
+ ],
+ ],
+ ],
+ 'errorCodes' => [
+ 403 => [
+ [
+ 'errorCode' => 'Forbidden.Access',
+ 'errorMessage' => 'Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.',
+ ],
+ ],
+ 429 => [
+ [
+ 'errorCode' => 'Throttling.Api',
+ 'errorMessage' => 'The request for this resource has exceeded your available limit.',
+ ],
+ [
+ 'errorCode' => 'Throttling.Api.Risk',
+ 'errorMessage' => 'The request for this resource has exceeded your daily available limit.',
+ ],
+ [
+ 'errorCode' => 'Throttling.System',
+ 'errorMessage' => 'The DataWorks system is busy. Try again later.',
+ ],
+ [
+ 'errorCode' => 'Throttling.User',
+ 'errorMessage' => 'Your request is too frequent. Try again later.',
+ ],
+ ],
+ 500 => [
+ [
+ 'errorCode' => 'InternalError.System',
+ 'errorMessage' => 'An internal system error occurred. Try again later.',
+ ],
+ [
+ 'errorCode' => 'InternalError.UserId.Missing',
+ 'errorMessage' => 'An internal system error occurred. Try again later.',
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"abcd\\",\\n \\"ErrorMessage\\": \\"The specified parameters are invalid.\\",\\n \\"UpdateResult\\": true,\\n \\"ErrorCode\\": \\"1031203110005\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<RequestId>abcd</RequestId>\\n<HttpStatusCode>200</HttpStatusCode>\\n<ErrorCode>1031203110005</ErrorCode>\\n<ErrorMessage>The specified parameters are invalid.</ErrorMessage>\\n<Success>true</Success>\\n<UpdateResult>true</UpdateResult>","errorExample":""}]',
+ 'title' => 'UpdateTableTheme',
+ 'requestParamsDescription' => ' ',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ ],
+ 'ListTableTheme' => [
+ 'summary' => 'Lists table themes. This operation will be replaced soon. We recommend that you do not call this operation.',
+ 'methods' => [
+ 'get',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'get',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeCode' => '78337',
+ 'abilityTreeNodes' => [
+ 'FEATUREdideRZEBFC',
+ ],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'ProjectId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The DataWorks workspace ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'docRequired' => true,
+ 'maximum' => '9223372036854775807',
+ 'minimum' => '1',
+ 'example' => '123',
+ ],
+ ],
+ [
+ 'name' => 'ParentId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the parent table theme.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'maximum' => '9223372036854775807',
+ 'minimum' => '1',
+ 'example' => '121',
+ ],
+ ],
+ [
+ 'name' => 'PageNum',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The page number.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => false,
+ 'maximum' => '2147483647',
+ 'minimum' => '1',
+ 'example' => '1',
+ ],
+ ],
+ [
+ 'name' => 'PageSize',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The number of entries per page. Default value: 10. Maximum value: 100.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => false,
+ 'maximum' => '100',
+ 'minimum' => '1',
+ 'example' => '10',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'description' => 'The response parameters.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'HttpStatusCode' => [
+ 'description' => 'The HTTP status code.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '200',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message.'."\n",
+ 'type' => 'string',
+ 'example' => 'The specified parameters are invalid.',
+ ],
+ 'RequestId' => [
+ 'description' => 'The request ID.'."\n",
+ 'type' => 'string',
+ 'example' => 'abcde',
+ ],
+ 'Success' => [
+ 'description' => 'Indicates whether the request was successful.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code.'."\n",
+ 'type' => 'string',
+ 'example' => '1031203110005',
+ ],
+ 'Data' => [
+ 'description' => 'The returned result.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'TotalCount' => [
+ 'description' => 'The total number of entries returned.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '10',
+ ],
+ 'ThemeList' => [
+ 'description' => 'The list of table levels.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '',
+ 'type' => 'object',
+ 'properties' => [
+ 'CreateTimeStamp' => [
+ 'description' => 'The time when the table level was created.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '123432343243',
+ ],
+ 'ParentId' => [
+ 'description' => 'The ancestor node ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '122',
+ ],
+ 'ThemeId' => [
+ 'description' => 'The table theme ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '123',
+ ],
+ 'ProjectId' => [
+ 'description' => 'The DataWorks workspace ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '123',
+ ],
+ 'Name' => [
+ 'description' => 'The name of the table level.'."\n",
+ 'type' => 'string',
+ 'example' => 'test',
+ ],
+ 'Level' => [
+ 'description' => 'The level of the table folder. Valid values: 1 and 2. The value 1 indicates the first level. The value 2 indicates the second level.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '1',
+ ],
+ 'Creator' => [
+ 'description' => 'The creator of the table level.'."\n",
+ 'type' => 'string',
+ 'example' => '123455',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'errorCodes' => [
+ 403 => [
+ [
+ 'errorCode' => 'Forbidden.Access',
+ 'errorMessage' => 'Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.',
+ ],
+ ],
+ 429 => [
+ [
+ 'errorCode' => 'Throttling.Api',
+ 'errorMessage' => 'The request for this resource has exceeded your available limit.',
+ ],
+ [
+ 'errorCode' => 'Throttling.Api.Risk',
+ 'errorMessage' => 'The request for this resource has exceeded your daily available limit.',
+ ],
+ [
+ 'errorCode' => 'Throttling.System',
+ 'errorMessage' => 'The DataWorks system is busy. Try again later.',
+ ],
+ [
+ 'errorCode' => 'Throttling.User',
+ 'errorMessage' => 'Your request is too frequent. Try again later.',
+ ],
+ ],
+ 500 => [
+ [
+ 'errorCode' => 'InternalError.System',
+ 'errorMessage' => 'An internal system error occurred. Try again later.',
+ ],
+ [
+ 'errorCode' => 'InternalError.UserId.Missing',
+ 'errorMessage' => 'An internal system error occurred. Try again later.',
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"ErrorMessage\\": \\"The specified parameters are invalid.\\",\\n \\"RequestId\\": \\"abcde\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"1031203110005\\",\\n \\"Data\\": {\\n \\"TotalCount\\": 10,\\n \\"ThemeList\\": [\\n {\\n \\"CreateTimeStamp\\": 123432343243,\\n \\"ParentId\\": 122,\\n \\"ThemeId\\": 123,\\n \\"ProjectId\\": 123,\\n \\"Name\\": \\"层级名称\\",\\n \\"Level\\": 1,\\n \\"Creator\\": \\"123455\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<ListTableThemeResponse>\\n <HttpStatusCode>200</HttpStatusCode>\\n <ErrorMessage>The specified parameters are invalid.</ErrorMessage>\\n <RequestId>abcde</RequestId>\\n <Success>true</Success>\\n <ErrorCode>1031203110005</ErrorCode>\\n <Data>\\n <TotalCount>10</TotalCount>\\n <ThemeList>\\n <CreateTimeStamp>123432343243</CreateTimeStamp>\\n <ParentId>122</ParentId>\\n <ThemeId>123</ThemeId>\\n <ProjectId>123</ProjectId>\\n <Name>层级名称</Name>\\n <Level>1</Level>\\n <Creator>123455</Creator>\\n </ThemeList>\\n </Data>\\n</ListTableThemeResponse>","errorExample":""}]',
+ 'title' => 'ListTableTheme',
+ 'requestParamsDescription' => ' ',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ ],
+ 'GetMetaTableThemeLevel' => [
+ 'methods' => [
+ 'get',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'get',
+ 'abilityTreeCode' => '78270',
+ 'abilityTreeNodes' => [
+ 'FEATUREdideRZEBFC',
+ ],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'TableGuid',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The GUID of the metatable. Specify the GUID in the format of odps.${projectName}.${tableName}.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'odps.project1.name1',
+ ],
+ ],
+ [
+ 'name' => 'DataSourceType',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The type of the data source. Set the value to odps.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'odps',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'description' => 'The response parameters.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'HttpStatusCode' => [
+ 'description' => 'The HTTP status code.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '200',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message.'."\n",
+ 'type' => 'string',
+ 'example' => 'success',
+ ],
+ 'RequestId' => [
+ 'description' => 'The request ID. You can troubleshoot issues based on the ID.'."\n",
+ 'type' => 'string',
+ 'example' => '1324afdsfde',
+ ],
+ 'Success' => [
+ 'description' => 'Indicates whether the request was successful.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code.'."\n",
+ 'type' => 'string',
+ 'example' => '0',
+ ],
+ 'Entity' => [
+ 'description' => 'The returned data.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'Theme' => [
+ 'description' => 'The information about the themes of the metatable.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '',
+ 'type' => 'object',
+ 'properties' => [
+ 'ParentId' => [
+ 'description' => 'The ID of the parent theme.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '0',
+ ],
+ 'Name' => [
+ 'description' => 'The name of the theme.'."\n",
+ 'type' => 'string',
+ 'example' => 'theme1',
+ ],
+ 'ThemeId' => [
+ 'description' => 'The ID of the theme.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '123',
+ ],
+ 'Level' => [
+ 'description' => 'The level of the theme. Valid values:'."\n"
+ ."\n"
+ .'* 1'."\n"
+ .'* 2'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '1',
+ ],
+ ],
+ ],
+ ],
+ 'Level' => [
+ 'description' => 'The information about the levels of the metatable.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '',
+ 'type' => 'object',
+ 'properties' => [
+ 'Type' => [
+ 'description' => 'The type of the level. Valid values:'."\n"
+ ."\n"
+ .'* 1: indicates the logical level.'."\n"
+ .'* 2: indicates the physical level.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '1',
+ ],
+ 'Description' => [
+ 'description' => 'The description of the level.'."\n",
+ 'type' => 'string',
+ 'example' => 'test',
+ ],
+ 'Name' => [
+ 'description' => 'The name of the level.'."\n",
+ 'type' => 'string',
+ 'example' => 'level1',
+ ],
+ 'LevelId' => [
+ 'description' => 'The ID of the level.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '1',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'errorCodes' => [
+ 400 => [
+ [
+ 'errorCode' => 'Invalid.Meta.TableNotExist',
+ 'errorMessage' => 'The table does not exist.',
+ ],
+ [
+ 'errorCode' => 'InvalidParameter.Meta.CommonError',
+ 'errorMessage' => 'The specified parameter is invalid.',
+ ],
+ [
+ 'errorCode' => 'InvalidParameter.Meta.Illegal',
+ 'errorMessage' => 'The app guid parameter is invalid.',
+ ],
+ [
+ 'errorCode' => 'InvalidParameter.Meta.IllegalDate',
+ 'errorMessage' => 'The date format is invalid.',
+ ],
+ [
+ 'errorCode' => 'InvalidParameter.Meta.IllegalPageError',
+ 'errorMessage' => 'The parameter for paging is invalid.',
+ ],
+ [
+ 'errorCode' => 'InvalidParameter.Meta.NotExist',
+ 'errorMessage' => 'The object does not exist.',
+ ],
+ ],
+ 403 => [
+ [
+ 'errorCode' => 'Forbidden.Meta.NoTenant',
+ 'errorMessage' => 'The user is not the owner of any tenants.',
+ ],
+ [
+ 'errorCode' => 'Forbidden.Access',
+ 'errorMessage' => 'Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.',
+ ],
+ ],
+ 429 => [
+ [
+ 'errorCode' => 'Throttling.Api',
+ 'errorMessage' => 'The request for this resource has exceeded your available limit.',
+ ],
+ [
+ 'errorCode' => 'Throttling.Api.Risk',
+ 'errorMessage' => 'The request for this resource has exceeded your daily available limit.',
+ ],
+ [
+ 'errorCode' => 'Throttling.System',
+ 'errorMessage' => 'The DataWorks system is busy. Try again later.',
+ ],
+ [
+ 'errorCode' => 'Throttling.User',
+ 'errorMessage' => 'Your request is too frequent. Try again later.',
+ ],
+ ],
+ 500 => [
+ [
+ 'errorCode' => 'InternalError.System',
+ 'errorMessage' => 'An internal system error occurred. Try again later.',
+ ],
+ [
+ 'errorCode' => 'InternalError.UserId.Missing',
+ 'errorMessage' => 'An internal system error occurred. Try again later.',
+ ],
+ [
+ 'errorCode' => 'InternalError.Meta.NoCalcEngine',
+ 'errorMessage' => 'An error occurred while retrieving the compute engine based on the MaxCompute project.',
+ ],
+ [
+ 'errorCode' => 'InternalError.Meta.TenantTimeOut',
+ 'errorMessage' => 'Failed to connect to the interface network.',
+ ],
+ [
+ 'errorCode' => 'InternalError.Meta.Unknown',
+ 'errorMessage' => 'An unknown error occurred while processing your request.',
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"ErrorMessage\\": \\"success\\",\\n \\"RequestId\\": \\"1324afdsfde\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"0\\",\\n \\"Entity\\": {\\n \\"Theme\\": [\\n {\\n \\"ParentId\\": 0,\\n \\"Name\\": \\"theme1\\",\\n \\"ThemeId\\": 123,\\n \\"Level\\": 1\\n }\\n ],\\n \\"Level\\": [\\n {\\n \\"Type\\": 1,\\n \\"Description\\": \\"描述\\",\\n \\"Name\\": \\"level1\\",\\n \\"LevelId\\": 1\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<GetMetaTableThemeLevelResponse>\\n <HttpStatusCode>200</HttpStatusCode>\\n <ErrorMessage>success</ErrorMessage>\\n <RequestId>1324afdsfde</RequestId>\\n <Success>true</Success>\\n <ErrorCode>0</ErrorCode>\\n <Entity>\\n <Theme>\\n <ParentId>0</ParentId>\\n <Name>theme1</Name>\\n <ThemeId>123</ThemeId>\\n <Level>1</Level>\\n </Theme>\\n <Level>\\n <Type>1</Type>\\n <Description>描述</Description>\\n <Name>level1</Name>\\n <LevelId>1</LevelId>\\n </Level>\\n </Entity>\\n</GetMetaTableThemeLevelResponse>","errorExample":""}]',
+ 'title' => 'GetMetaTableThemeLevel',
+ 'summary' => 'Fetches topics and hierarchy metadata for tables',
+ ],
+ 'CreateTableLevel' => [
+ 'summary' => 'Creates a hierarchy level. This operation will be replaced soon. We recommend that you do not call this operation.',
+ 'methods' => [
+ 'post',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'write',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'create',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeCode' => '78198',
+ 'abilityTreeNodes' => [
+ 'FEATUREdideRZEBFC',
+ ],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'ProjectId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The DataWorks workspace ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'docRequired' => true,
+ 'maximum' => '9223372036854775807',
+ 'minimum' => '1',
+ 'example' => '123',
+ ],
+ ],
+ [
+ 'name' => 'LevelType',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The type of the table level. Valid values: 1 and 2. The value 1 indicates the logical level. The value 2 indicates the physical level.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => true,
+ 'docRequired' => true,
+ 'maximum' => '10',
+ 'minimum' => '1',
+ 'example' => '1',
+ ],
+ ],
+ [
+ 'name' => 'Name',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The name of the table level.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'The description of the table level.'."\n",
+ ],
+ ],
+ [
+ 'name' => 'Description',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The description of the table level.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'The HTTP status code returned.'."\n",
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'description' => 'The response parameters.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'HttpStatusCode' => [
+ 'description' => 'The HTTP status code.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '200',
+ ],
+ 'RequestId' => [
+ 'description' => 'The request ID.'."\n",
+ 'type' => 'string',
+ 'example' => 'The error message returned.'."\n",
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message.'."\n",
+ 'type' => 'string',
+ 'example' => 'The specified parameters are invalid.',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code.'."\n",
+ 'type' => 'string',
+ 'example' => '1031203110005',
+ ],
+ 'Success' => [
+ 'description' => 'Indicates whether the request was successful.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'LevelId' => [
+ 'description' => 'The table level ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '123',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'errorCodes' => [
+ 403 => [
+ [
+ 'errorCode' => 'Forbidden.Access',
+ 'errorMessage' => 'Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.',
+ ],
+ ],
+ 429 => [
+ [
+ 'errorCode' => 'Throttling.Api',
+ 'errorMessage' => 'The request for this resource has exceeded your available limit.',
+ ],
+ [
+ 'errorCode' => 'Throttling.Api.Risk',
+ 'errorMessage' => 'The request for this resource has exceeded your daily available limit.',
+ ],
+ [
+ 'errorCode' => 'Throttling.System',
+ 'errorMessage' => 'The DataWorks system is busy. Try again later.',
+ ],
+ [
+ 'errorCode' => 'Throttling.User',
+ 'errorMessage' => 'Your request is too frequent. Try again later.',
+ ],
+ ],
+ 500 => [
+ [
+ 'errorCode' => 'InternalError.System',
+ 'errorMessage' => 'An internal system error occurred. Try again later.',
+ ],
+ [
+ 'errorCode' => 'InternalError.UserId.Missing',
+ 'errorMessage' => 'An internal system error occurred. Try again later.',
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"请求id\\",\\n \\"ErrorMessage\\": \\"The specified parameters are invalid.\\",\\n \\"ErrorCode\\": \\"1031203110005\\",\\n \\"Success\\": true,\\n \\"LevelId\\": 123\\n}","errorExample":""},{"type":"xml","example":"<CreateTableLevelResponse>\\n <HttpStatusCode>200</HttpStatusCode>\\n <RequestId>请求id</RequestId>\\n <ErrorMessage>The specified parameters are invalid.</ErrorMessage>\\n <ErrorCode>1031203110005</ErrorCode>\\n <Success>true</Success>\\n <LevelId>123</LevelId>\\n</CreateTableLevelResponse>","errorExample":""}]',
+ 'title' => 'CreateTableLevel',
+ 'requestParamsDescription' => ' ',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ ],
+ 'UpdateTableLevel' => [
+ 'summary' => 'Updates a hierarchy level. This operation will be replaced soon. We recommend that you do not call this operation.',
+ 'methods' => [
+ 'post',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'write',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'update',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeCode' => '78384',
+ 'abilityTreeNodes' => [
+ 'FEATUREdideRZEBFC',
+ ],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'ProjectId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the DataWorks workspace.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => true,
+ 'docRequired' => true,
+ 'maximum' => '9223372036854775807',
+ 'minimum' => '1',
+ 'example' => '123',
+ ],
+ ],
+ [
+ 'name' => 'LevelType',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The table level type. Valid values: 1 and 2. The value 1 indicates the logical level. The value 2 indicates the physical level.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => false,
+ 'docRequired' => true,
+ 'maximum' => '10',
+ 'minimum' => '0',
+ 'example' => '1',
+ ],
+ ],
+ [
+ 'name' => 'Name',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The name of the table level.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'docRequired' => true,
+ 'example' => 'level name',
+ ],
+ ],
+ [
+ 'name' => 'Description',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The description of the table level.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'level description',
+ ],
+ ],
+ [
+ 'name' => 'LevelId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the table level. You can call the ListTableLevel operation to query the ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => true,
+ 'docRequired' => true,
+ 'maximum' => '9223372036854775807',
+ 'minimum' => '1',
+ 'example' => '123',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'description' => 'The returned result.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'HttpStatusCode' => [
+ 'description' => 'The HTTP status code.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '200',
+ ],
+ 'RequestId' => [
+ 'description' => 'The request ID.'."\n",
+ 'type' => 'string',
+ 'example' => 'abcde',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message.'."\n",
+ 'type' => 'string',
+ 'example' => 'The specified parameters are invalid.',
+ ],
+ 'UpdateResult' => [
+ 'description' => 'Indicates whether the table level is updated.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code.'."\n",
+ 'type' => 'string',
+ 'example' => '1031203110005',
+ ],
+ 'Success' => [
+ 'description' => 'Indicates whether the request was successful.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'errorCodes' => [
+ 403 => [
+ [
+ 'errorCode' => 'Forbidden.Access',
+ 'errorMessage' => 'Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.',
+ ],
+ ],
+ 429 => [
+ [
+ 'errorCode' => 'Throttling.Api',
+ 'errorMessage' => 'The request for this resource has exceeded your available limit.',
+ ],
+ [
+ 'errorCode' => 'Throttling.Api.Risk',
+ 'errorMessage' => 'The request for this resource has exceeded your daily available limit.',
+ ],
+ [
+ 'errorCode' => 'Throttling.System',
+ 'errorMessage' => 'The DataWorks system is busy. Try again later.',
+ ],
+ [
+ 'errorCode' => 'Throttling.User',
+ 'errorMessage' => 'Your request is too frequent. Try again later.',
+ ],
+ ],
+ 500 => [
+ [
+ 'errorCode' => 'InternalError.System',
+ 'errorMessage' => 'An internal system error occurred. Try again later.',
+ ],
+ [
+ 'errorCode' => 'InternalError.UserId.Missing',
+ 'errorMessage' => 'An internal system error occurred. Try again later.',
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"abcde\\",\\n \\"ErrorMessage\\": \\"The specified parameters are invalid.\\",\\n \\"UpdateResult\\": true,\\n \\"ErrorCode\\": \\"1031203110005\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<UpdateTableLevelResponse>\\n <HttpStatusCode>200</HttpStatusCode>\\n <RequestId>abcde</RequestId>\\n <ErrorMessage>The specified parameters are invalid.</ErrorMessage>\\n <UpdateResult>true</UpdateResult>\\n <ErrorCode>1031203110005</ErrorCode>\\n <Success>true</Success>\\n</UpdateTableLevelResponse>","errorExample":""}]',
+ 'title' => 'UpdateTableLevel',
+ 'requestParamsDescription' => ' ',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ ],
+ 'DeleteTableLevel' => [
+ 'summary' => 'Deletes a hierarchy level. This operation will be replaced soon. We recommend that you do not call this operation.',
+ 'methods' => [
+ 'post',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'write',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'delete',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeCode' => '78219',
+ 'abilityTreeNodes' => [
+ 'FEATUREdideRZEBFC',
+ ],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'LevelId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the table level that you want to delete. You can call the ListTableLevel operation to query the ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => true,
+ 'docRequired' => true,
+ 'maximum' => '9223372036854775807',
+ 'minimum' => '1',
+ 'example' => '123',
+ ],
+ ],
+ [
+ 'name' => 'ProjectId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The DataWorks workspace ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => true,
+ 'docRequired' => true,
+ 'maximum' => '9223372036854775807',
+ 'minimum' => '1',
+ 'example' => '123',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'description' => 'The response parameters.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'DeleteResult' => [
+ 'description' => 'Indicates whether the table level was deleted.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'RequestId' => [
+ 'description' => 'The request ID.'."\n",
+ 'type' => 'string',
+ 'example' => 'abcde',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'errorCodes' => [
+ 403 => [
+ [
+ 'errorCode' => 'Forbidden.Access',
+ 'errorMessage' => 'Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.',
+ ],
+ ],
+ 429 => [
+ [
+ 'errorCode' => 'Throttling.Api',
+ 'errorMessage' => 'The request for this resource has exceeded your available limit.',
+ ],
+ [
+ 'errorCode' => 'Throttling.Api.Risk',
+ 'errorMessage' => 'The request for this resource has exceeded your daily available limit.',
+ ],
+ [
+ 'errorCode' => 'Throttling.System',
+ 'errorMessage' => 'The DataWorks system is busy. Try again later.',
+ ],
+ [
+ 'errorCode' => 'Throttling.User',
+ 'errorMessage' => 'Your request is too frequent. Try again later.',
+ ],
+ ],
+ 500 => [
+ [
+ 'errorCode' => 'InternalError.System',
+ 'errorMessage' => 'An internal system error occurred. Try again later.',
+ ],
+ [
+ 'errorCode' => 'InternalError.UserId.Missing',
+ 'errorMessage' => 'An internal system error occurred. Try again later.',
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"DeleteResult\\": true,\\n \\"RequestId\\": \\"abcde\\"\\n}","errorExample":""},{"type":"xml","example":"<DeleteTableLevelResponse>\\n <DeleteResult>true</DeleteResult>\\n <RequestId>abcde</RequestId>\\n</DeleteTableLevelResponse>","errorExample":""}]',
+ 'title' => 'DeleteTableLevel',
+ 'requestParamsDescription' => ' ',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ ],
+ 'ListTableLevel' => [
+ 'summary' => 'Lists hierarchy levels. This operation will be replaced soon. We recommend that you do not call this operation.',
+ 'methods' => [
+ 'get',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'get',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeCode' => '78336',
+ 'abilityTreeNodes' => [
+ 'FEATUREdideRZEBFC',
+ ],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'ProjectId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the DataWorks workspace. You can log on to the DataWorks console to obtain the workspace ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => true,
+ 'docRequired' => true,
+ 'maximum' => '9223372036854775807',
+ 'minimum' => '1',
+ 'example' => '123',
+ ],
+ ],
+ [
+ 'name' => 'LevelType',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The table level type. Valid values: 1 and 2. The value 1 indicates the logical level. The value 2 indicates the physical level.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => true,
+ 'docRequired' => true,
+ 'maximum' => '10',
+ 'minimum' => '0',
+ 'example' => '1',
+ ],
+ ],
+ [
+ 'name' => 'PageNum',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The page number. Default value: 1.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => false,
+ 'example' => '1',
+ ],
+ ],
+ [
+ 'name' => 'PageSize',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The number of entries per page. Default value: 10.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => false,
+ 'example' => '10',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'description' => 'The returned result.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'HttpStatusCode' => [
+ 'description' => 'The HTTP status code.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '200',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message.'."\n",
+ 'type' => 'string',
+ 'example' => 'The specified parameters are invalid.',
+ ],
+ 'RequestId' => [
+ 'description' => 'The request ID.'."\n",
+ 'type' => 'string',
+ 'example' => 'abc',
+ ],
+ 'Success' => [
+ 'description' => 'Indicates whether the request was successful.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code.'."\n",
+ 'type' => 'string',
+ 'example' => '1031203110005 ',
+ ],
+ 'TableLevelInfo' => [
+ 'description' => 'The information about the table levels.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'TotalCount' => [
+ 'description' => 'The total number of table levels returned.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '10',
+ ],
+ 'LevelList' => [
+ 'description' => 'The list of table levels.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '',
+ 'type' => 'object',
+ 'properties' => [
+ 'LevelType' => [
+ 'description' => 'The table level type. Valid values: 1 and 2. The value 1 indicates the logical level. The value 2 indicates the physical level.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '1',
+ ],
+ 'Description' => [
+ 'description' => 'The description of the table level.'."\n",
+ 'type' => 'string',
+ 'example' => 'test',
+ ],
+ 'Name' => [
+ 'description' => 'The name of the table level.'."\n",
+ 'type' => 'string',
+ 'example' => 'test',
+ ],
+ 'ProjectId' => [
+ 'description' => 'The ID of the DataWorks workspace.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '123',
+ ],
+ 'LevelId' => [
+ 'description' => 'The table level ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '123',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'errorCodes' => [
+ 403 => [
+ [
+ 'errorCode' => 'Forbidden.Access',
+ 'errorMessage' => 'Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.',
+ ],
+ ],
+ 429 => [
+ [
+ 'errorCode' => 'Throttling.Api',
+ 'errorMessage' => 'The request for this resource has exceeded your available limit.',
+ ],
+ [
+ 'errorCode' => 'Throttling.Api.Risk',
+ 'errorMessage' => 'The request for this resource has exceeded your daily available limit.',
+ ],
+ [
+ 'errorCode' => 'Throttling.System',
+ 'errorMessage' => 'The DataWorks system is busy. Try again later.',
+ ],
+ [
+ 'errorCode' => 'Throttling.User',
+ 'errorMessage' => 'Your request is too frequent. Try again later.',
+ ],
+ ],
+ 500 => [
+ [
+ 'errorCode' => 'InternalError.System',
+ 'errorMessage' => 'An internal system error occurred. Try again later.',
+ ],
+ [
+ 'errorCode' => 'InternalError.UserId.Missing',
+ 'errorMessage' => 'An internal system error occurred. Try again later.',
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"ErrorMessage\\": \\"The specified parameters are invalid.\\",\\n \\"RequestId\\": \\"abc\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"1031203110005\\\\t\\",\\n \\"TableLevelInfo\\": {\\n \\"TotalCount\\": 10,\\n \\"LevelList\\": [\\n {\\n \\"LevelType\\": 1,\\n \\"Description\\": \\"层级描述\\",\\n \\"Name\\": \\"层级1\\",\\n \\"ProjectId\\": 123,\\n \\"LevelId\\": 123\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<ListTableLevelResponse>\\n <HttpStatusCode>200</HttpStatusCode>\\n <ErrorMessage>The specified parameters are invalid.</ErrorMessage>\\n <RequestId>abc</RequestId>\\n <Success>true</Success>\\n <ErrorCode>1031203110005\\t</ErrorCode>\\n <TableLevelInfo>\\n <TotalCount>10</TotalCount>\\n <LevelList>\\n <LevelType>1</LevelType>\\n <Description>层级描述</Description>\\n <Name>层级1</Name>\\n <ProjectId>123</ProjectId>\\n <LevelId>123</LevelId>\\n </LevelList>\\n </TableLevelInfo>\\n</ListTableLevelResponse>","errorExample":""}]',
+ 'title' => 'ListTableLevel',
+ 'requestParamsDescription' => ' ',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ ],
+ 'UpdateMetaCollection' => [
+ 'summary' => 'Updates the name and comment of a collection.',
+ 'methods' => [
+ 'put',
+ 'post',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'write',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'update',
+ 'abilityTreeCode' => '163134',
+ 'abilityTreeNodes' => [
+ 'FEATUREdideE9XYA6',
+ ],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'QualifiedName',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The unique identifier of the collection.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => 'album.396397',
+ ],
+ ],
+ [
+ 'name' => 'Name',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The name of the collection.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'myCollectionName',
+ ],
+ ],
+ [
+ 'name' => 'Comment',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The comment of the collection. The comment must be 1 to 64 characters in length.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'this is a comment',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => 'Schema of Response',
+ 'description' => 'The response parameters.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'title' => 'Id of the request',
+ 'description' => 'The request ID. You can locate logs and troubleshoot issues based on the ID.'."\n",
+ 'type' => 'string',
+ 'example' => '0000-ABCD-E****',
+ ],
+ 'Status' => [
+ 'description' => 'The result of the operation. Valid values: true false',
+ 'type' => 'boolean',
+ 'enumValueTitles' => [],
+ 'example' => 'true',
+ ],
+ 'HttpStatusCode' => [
+ 'description' => 'The HTTP status code.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '200',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The returned message.'."\n",
+ 'type' => 'string',
+ 'example' => 'The specified product does not exist.',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code.'."\n",
+ 'type' => 'string',
+ 'example' => '9999',
+ ],
+ 'Success' => [
+ 'description' => 'Indicates whether the request was successful. Valid values:'."\n"
+ ."\n"
+ .'* true: The request was successful.'."\n"
+ .'* false: The request failed.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"0000-ABCD-E****\\",\\n \\"Status\\": true,\\n \\"HttpStatusCode\\": 200,\\n \\"ErrorMessage\\": \\"The specified product does not exist.\\",\\n \\"ErrorCode\\": \\"9999\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<UpdateMetaCollectionResponse>\\n <RequestId>0000-ABCD-E****</RequestId>\\n <Status>true</Status>\\n <HttpStatusCode>200</HttpStatusCode>\\n <ErrorMessage>The specified product does not exist.</ErrorMessage>\\n <ErrorCode>9999</ErrorCode>\\n <Success>true</Success>\\n</UpdateMetaCollectionResponse>","errorExample":""}]',
+ 'title' => 'UpdateMetaCollection',
+ 'description' => 'Only the name and comment of a collection can be updated.'."\n",
+ 'requestParamsDescription' => 'You must configure at least one of the Name and Comment parameters when you update a collection.'."\n",
+ ],
+ 'ListMetaCollections' => [
+ 'summary' => 'Queries information about collections. Collections include data albums that are displayed on the Data Map page and categories that are created in the data albums. You can call this API operation to query collections by type.',
+ 'methods' => [
+ 'get',
+ 'post',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'list',
+ 'abilityTreeCode' => '162854',
+ 'abilityTreeNodes' => [
+ 'FEATUREdideE9XYA6',
+ ],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'ParentQualifiedName',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The unique identifier of the parent collection.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'Album.1234',
+ ],
+ ],
+ [
+ 'name' => 'NextToken',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The pagination token that is used in the next request to retrieve a new page of results.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => '12345',
+ ],
+ ],
+ [
+ 'name' => 'PageSize',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The number of entries per page. Default value: 10. Maximum value: 100.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => false,
+ 'example' => '10',
+ ],
+ ],
+ [
+ 'name' => 'Keyword',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The keyword.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'test',
+ ],
+ ],
+ [
+ 'name' => 'OrderBy',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The name of the sorting field.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'test',
+ ],
+ ],
+ [
+ 'name' => 'CollectionType',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => '- ALBUM: data album '."\n"
+ .'- ALBUM_CATEGORY: category in a data album',
+ 'type' => 'string',
+ 'required' => true,
+ 'enumValueTitles' => [],
+ 'example' => 'ALBUM',
+ ],
+ ],
+ [
+ 'name' => 'Creator',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the collection creator.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => '1200759642363000',
+ ],
+ ],
+ [
+ 'name' => 'Administrator',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the collection administrator.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => '1200759642363000',
+ ],
+ ],
+ [
+ 'name' => 'Follower',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the collection follower.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => '1200759642363000',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => 'Schema of Response',
+ 'description' => 'The response parameters.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'title' => 'Id of the request',
+ 'description' => 'The request ID.'."\n",
+ 'type' => 'string',
+ 'example' => 'E25887B7-579C-54A5-9C4F-83A0DE367DDE',
+ ],
+ 'Data' => [
+ 'description' => 'The returned result.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'NextToken' => [
+ 'description' => 'A pagination token. It can be used in the next request to retrieve a new page of results.'."\n",
+ 'type' => 'string',
+ 'example' => '37ae2053d87d380f28ce0dc0853ca51e',
+ ],
+ 'CollectionList' => [
+ 'description' => 'The collections.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The collection.'."\n",
+ '$ref' => '#/components/schemas/Collection',
+ ],
+ ],
+ ],
+ ],
+ 'Success' => [
+ 'description' => 'Indicates whether the request was successful. Valid values:'."\n"
+ ."\n"
+ .'* true'."\n"
+ .'* false'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code.'."\n",
+ 'type' => 'string',
+ 'example' => 'Invalid.Collection.NotExists',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message.'."\n",
+ 'type' => 'string',
+ 'example' => 'The specified parameters are invalid.',
+ ],
+ 'HttpStatusCode' => [
+ 'description' => 'The HTTP status code.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '200',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'errorCodes' => [
+ 400 => [
+ [
+ 'errorCode' => 'Invalid.Collection.ParamError',
+ 'errorMessage' => 'msg: %s',
+ ],
+ [
+ 'errorCode' => 'Invalid.User.NotExist',
+ 'errorMessage' => 'msg: %s',
+ ],
+ [
+ 'errorCode' => 'Invalid.Collection.QualifiedNameError',
+ 'errorMessage' => 'msg: %s',
+ ],
+ [
+ 'errorCode' => 'Invalid.Collection.CollectionNotCompatible',
+ 'errorMessage' => 'msg: %s',
+ ],
+ [
+ 'errorCode' => 'Invalid.Collection.EntityOverflow',
+ 'errorMessage' => 'msg: %s',
+ ],
+ [
+ 'errorCode' => 'Invalid.Collection.NotExist',
+ 'errorMessage' => 'msg: %s',
+ ],
+ [
+ 'errorCode' => 'Invalid.Collection.AlreadyExist',
+ 'errorMessage' => 'msg: %s',
+ ],
+ [
+ 'errorCode' => 'Invalid.Collection.UnsupportedOperation',
+ 'errorMessage' => 'msg: %s',
+ ],
+ [
+ 'errorCode' => 'InvalidParameter.Meta.Missing',
+ 'errorMessage' => 'msg: %s',
+ ],
+ [
+ 'errorCode' => 'Forbidden.No.Permission',
+ 'errorMessage' => 'msg: %s',
+ ],
+ [
+ 'errorCode' => 'InvalidParameter.Meta.IllegalData',
+ 'errorMessage' => 'msg: %s',
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"E25887B7-579C-54A5-9C4F-83A0DE367DDE\\",\\n \\"Data\\": {\\n \\"NextToken\\": \\"37ae2053d87d380f28ce0dc0853ca51e\\",\\n \\"CollectionList\\": [\\n {\\n \\"QualifiedName\\": \\"album.12334\\",\\n \\"CollectionType\\": \\"album\\",\\n \\"Name\\": \\"collectionName\\",\\n \\"Comment\\": \\"comment\\",\\n \\"OwnerId\\": \\"1234444\\",\\n \\"OwnerName\\": \\"owner\\",\\n \\"CreateTime\\": 1668600147617,\\n \\"UpdateTime\\": 1668600148617,\\n \\"Level\\": 1\\n }\\n ]\\n },\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"Invalid.Collection.NotExists\\",\\n \\"ErrorMessage\\": \\"The specified parameters are invalid.\\",\\n \\"HttpStatusCode\\": 200\\n}","errorExample":""},{"type":"xml","example":"<ListMetaCollectionsResponse>\\n <RequestId>E25887B7-579C-54A5-9C4F-83A0DE367DDE</RequestId>\\n <Data>\\n <NextToken>37ae2053d87d380f28ce0dc0853ca51e</NextToken>\\n <CollectionList>\\n <QualifiedName>album.12334</QualifiedName>\\n <CollectionType>album</CollectionType>\\n <Name>collectionName</Name>\\n <Comment>comment</Comment>\\n <OwnerId>1234444</OwnerId>\\n <OwnerName>owner</OwnerName>\\n <CreateTime>1668600147617</CreateTime>\\n <UpdateTime>1668600148617</UpdateTime>\\n <Level>1</Level>\\n </CollectionList>\\n </Data>\\n <Success>true</Success>\\n <ErrorCode>Invalid.Collection.NotExists</ErrorCode>\\n <ErrorMessage>The specified parameters are invalid.</ErrorMessage>\\n <HttpStatusCode>200</HttpStatusCode>\\n</ListMetaCollectionsResponse>","errorExample":""}]',
+ 'title' => 'ListMetaCollections',
+ 'description' => 'The type can be ALBUM or ALBUM_CATEGORY. ALBUM indicates data albums. ALBUM_CATEGORY indicates categories.'."\n",
+ 'requestParamsDescription' => 'You can configure only one of the Creator, Administrator, and Follower parameters.'."\n",
+ ],
+ 'ListMetaCollectionEntities' => [
+ 'summary' => 'Queries the entities in a collection.',
+ 'methods' => [
+ 'get',
+ 'post',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'list',
+ 'abilityTreeCode' => '163137',
+ 'abilityTreeNodes' => [
+ 'FEATUREdideE9XYA6',
+ ],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'CollectionQualifiedName',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The unique identifier of the collection.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => 'album.12345',
+ ],
+ ],
+ [
+ 'name' => 'EntityType',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The type of the entities.'."\n"
+ ."\n"
+ .'For example, if this parameter is set to maxcompute-table, the entity is a MaxCompute table.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'maxcompute-table',
+ ],
+ ],
+ [
+ 'name' => 'Keyword',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The search keyword.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'test',
+ ],
+ ],
+ [
+ 'name' => 'NextToken',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The pagination token that is used in the next request to retrieve a new page of results.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => '12222',
+ ],
+ ],
+ [
+ 'name' => 'PageSize',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The number of entries per page.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => false,
+ 'example' => '10',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => 'OpenApiMetaResultModel',
+ 'description' => 'OpenApiMetaResultModel'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'Data' => [
+ 'description' => 'The response parameters.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'NextToken' => [
+ 'description' => 'A pagination token. It can be used in the next request to retrieve a new page of results.'."\n",
+ 'type' => 'string',
+ 'example' => '123344',
+ ],
+ 'EntityList' => [
+ 'description' => 'The entities.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The entities.'."\n",
+ '$ref' => '#/components/schemas/Entity',
+ ],
+ ],
+ ],
+ ],
+ 'RequestId' => [
+ 'description' => 'The request ID. You can locate logs and troubleshoot issues based on the ID.'."\n",
+ 'type' => 'string',
+ 'example' => 'E25887B7-579C-54A5-9C4F-83A0DE367DD',
+ ],
+ 'Success' => [
+ 'description' => 'Indicates whether the request was successful. Valid values:'."\n"
+ ."\n"
+ .'true: The request was successful.'."\n"
+ ."\n"
+ .'false: The request failed.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code.'."\n",
+ 'type' => 'string',
+ 'example' => 'Invalid.Collection.NotExists',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message.'."\n",
+ 'type' => 'string',
+ 'example' => 'The specified parameters are invalid.',
+ ],
+ 'HttpStatusCode' => [
+ 'description' => 'The HTTP status code.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '200',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"Data\\": {\\n \\"NextToken\\": \\"123344\\",\\n \\"EntityList\\": [\\n {\\n \\"QualifiedName\\": \\"maxcompute_table.563f0357118d05ef145d6bddf2966cc23e86ca8f2f013f915e565afdf09f7a23\\",\\n \\"TenantId\\": 12345,\\n \\"EntityContent\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n }\\n }\\n ]\\n },\\n \\"RequestId\\": \\"E25887B7-579C-54A5-9C4F-83A0DE367DD\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"Invalid.Collection.NotExists\\",\\n \\"ErrorMessage\\": \\"The specified parameters are invalid.\\",\\n \\"HttpStatusCode\\": 200\\n}","errorExample":""},{"type":"xml","example":"<ListMetaCollectionEntitiesResponse>\\n <Data>\\n <NextToken>12</NextToken>\\n <EntityList>\\n <EntityContent>\\n <entityType>maxcompute-table</entityType>\\n <name>table_name_for_example</name>\\n <projectName>maxcomputeProjectName</projectName>\\n <remark>cui</remark>\\n <addToCollectionTimestamp>1691563804264</addToCollectionTimestamp>\\n </EntityContent>\\n <QualifiedName>maxcompute-table.maxcomputeProjectName.table_name_for_example</QualifiedName>\\n </EntityList>\\n </Data>\\n <RequestId>E25887B7-579C-54A5-9C4F-83A0DE367DD</RequestId>\\n <Success>true</Success>\\n <ErrorCode>Invalid.Collection.NotExists</ErrorCode>\\n <ErrorMessage>The specified parameters are invalid.</ErrorMessage>\\n <HttpStatusCode>200</HttpStatusCode>\\n</ListMetaCollectionEntitiesResponse>","errorExample":""}]',
+ 'title' => 'ListMetaCollectionEntities',
+ ],
+ 'DeleteMetaCollection' => [
+ 'summary' => 'Deletes a collection.',
+ 'methods' => [
+ 'delete',
+ 'post',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'write',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'delete',
+ 'abilityTreeCode' => '163135',
+ 'abilityTreeNodes' => [
+ 'FEATUREdideE9XYA6',
+ ],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'QualifiedName',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The unique identifier of the collection.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => 'album.12333',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => 'Schema of Response',
+ 'description' => 'The response parameters.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'title' => 'Id of the request',
+ 'description' => 'The request ID.'."\n",
+ 'type' => 'string',
+ 'example' => '0000-ABCD-E****',
+ ],
+ 'Status' => [
+ 'description' => 'The result of the operation. Valid values:'."\n"
+ ."\n"
+ .'true: succeeded'."\n"
+ ."\n"
+ .'false: failed'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'HttpStatusCode' => [
+ 'description' => 'The HTTP status code.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '200',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message.'."\n",
+ 'type' => 'string',
+ 'example' => 'The specified product does not exist.',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code.'."\n",
+ 'type' => 'string',
+ 'example' => '999999',
+ ],
+ 'Success' => [
+ 'description' => 'Indicates whether the request was successful. Valid values:'."\n"
+ ."\n"
+ .'true'."\n"
+ ."\n"
+ .'false'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"0000-ABCD-E****\\",\\n \\"Status\\": true,\\n \\"HttpStatusCode\\": 200,\\n \\"ErrorMessage\\": \\"The specified product does not exist.\\",\\n \\"ErrorCode\\": \\"999999\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<DeleteMetaCollectionResponse>\\n <RequestId>0000-ABCD-E****</RequestId>\\n <Status>true</Status>\\n <HttpStatusCode>200</HttpStatusCode>\\n <ErrorMessage>The specified product does not exist.</ErrorMessage>\\n <ErrorCode>999999</ErrorCode>\\n <Success>true</Success>\\n</DeleteMetaCollectionResponse>","errorExample":""}]',
+ 'title' => 'DeleteMetaCollection',
+ ],
+ 'GetMetaCollectionDetail' => [
+ 'summary' => 'Queries the information about a collection.',
+ 'methods' => [
+ 'get',
+ 'post',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'get',
+ 'abilityTreeCode' => '163136',
+ 'abilityTreeNodes' => [
+ 'FEATUREdideE9XYA6',
+ ],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'QualifiedName',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The unique identifier of the collection.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => 'album.12345',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => 'Schema of Response',
+ 'description' => 'The returned result.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'title' => 'Id of the request',
+ 'description' => 'The request ID. You can locate logs and troubleshoot issues based on the ID.'."\n",
+ 'type' => 'string',
+ 'example' => '0000-ABCD-E****',
+ ],
+ 'Collection' => [
+ 'description' => 'The information about the collection.'."\n",
+ '$ref' => '#/components/schemas/Collection',
+ ],
+ 'Success' => [
+ 'description' => 'Indicates whether the request was successful. Valid values:'."\n"
+ ."\n"
+ .'true'."\n"
+ ."\n"
+ .'false'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code.'."\n",
+ 'type' => 'string',
+ 'example' => '9999',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message.'."\n",
+ 'type' => 'string',
+ 'example' => 'album.xxxx does not exist.',
+ ],
+ 'HttpStatusCode' => [
+ 'description' => 'The HTTP status code.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '200',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"0000-ABCD-E****\\",\\n \\"Collection\\": {\\n \\"QualifiedName\\": \\"album.12334\\",\\n \\"CollectionType\\": \\"album\\",\\n \\"Name\\": \\"collectionName\\",\\n \\"Comment\\": \\"comment\\",\\n \\"OwnerId\\": \\"1234444\\",\\n \\"OwnerName\\": \\"owner\\",\\n \\"CreateTime\\": 1668600147617,\\n \\"UpdateTime\\": 1668600148617,\\n \\"Level\\": 1\\n },\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"9999\\",\\n \\"ErrorMessage\\": \\"album.xxxx does not exist.\\",\\n \\"HttpStatusCode\\": 200\\n}","errorExample":""},{"type":"xml","example":"<GetMetaCollectionDetailResponse>\\n <RequestId>0000-ABCD-E****</RequestId>\\n <Collection>\\n <QualifiedName>album.12334</QualifiedName>\\n <CollectionType>album</CollectionType>\\n <Name>collectionName</Name>\\n <Comment>comment</Comment>\\n <OwnerId>1234444</OwnerId>\\n <OwnerName>owner</OwnerName>\\n <CreateTime>1668600147617</CreateTime>\\n <UpdateTime>1668600148617</UpdateTime>\\n <Level>1</Level>\\n </Collection>\\n <Success>true</Success>\\n <ErrorCode>9999</ErrorCode>\\n <ErrorMessage>album.xxxx does not exist.</ErrorMessage>\\n</GetMetaCollectionDetailResponse>","errorExample":""}]',
+ 'title' => 'GetMetaCollectionDetail',
+ ],
+ 'DeleteMetaCollectionEntity' => [
+ 'summary' => 'Deletes an entity from a collection.',
+ 'methods' => [
+ 'delete',
+ 'post',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'write',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'delete',
+ 'abilityTreeCode' => '163139',
+ 'abilityTreeNodes' => [
+ 'FEATUREdideE9XYA6',
+ ],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'CollectionQualifiedName',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The unique identifier of the collection.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => 'album.12345',
+ ],
+ ],
+ [
+ 'name' => 'EntityQualifiedName',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The unique identifier of the entity.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => 'maxcompute.projectA.tableB',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => 'Schema of Response',
+ 'description' => 'Schema of Response'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'title' => 'Id of the request',
+ 'description' => 'Id of the request'."\n",
+ 'type' => 'string',
+ 'example' => '0000-ABCD-E****',
+ ],
+ 'Status' => [
+ 'description' => 'The result of the operation. Valid values:'."\n"
+ ."\n"
+ .'true: succeeded'."\n"
+ ."\n"
+ .'false: failed'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'HttpStatusCode' => [
+ 'description' => 'The HTTP status code.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '200',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message.'."\n",
+ 'type' => 'string',
+ 'example' => 'entity not exist',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code.'."\n",
+ 'type' => 'string',
+ 'example' => '999999',
+ ],
+ 'Success' => [
+ 'description' => 'Indicates whether the request was successful. Valid values:'."\n"
+ ."\n"
+ .'true'."\n"
+ ."\n"
+ .'false'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'errorCodes' => [
+ 400 => [
+ [
+ 'errorCode' => 'Invalid.Entity.NotExist',
+ 'errorMessage' => '%s',
+ ],
+ ],
+ ],
+ 'staticInfo' => [
+ 'returnType' => 'synchronous',
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"0000-ABCD-E****\\",\\n \\"Status\\": true,\\n \\"HttpStatusCode\\": 200,\\n \\"ErrorMessage\\": \\"entity not exist\\",\\n \\"ErrorCode\\": \\"999999\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<DeleteMetaCollectionEntityResponse>\\n <RequestId>0000-ABCD-E****</RequestId>\\n <Status>true</Status>\\n <HttpStatusCode>200</HttpStatusCode>\\n <ErrorMessage>entity not exist</ErrorMessage>\\n <ErrorCode>999999</ErrorCode>\\n <Success>true</Success>\\n</DeleteMetaCollectionEntityResponse>","errorExample":""}]',
+ 'title' => 'DeleteMetaCollectionEntity',
+ ],
+ 'AddMetaCollectionEntity' => [
+ 'summary' => 'Adds an entity to a collection.',
+ 'methods' => [
+ 'post',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'write',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'update',
+ 'abilityTreeCode' => '163138',
+ 'abilityTreeNodes' => [
+ 'FEATUREdideE9XYA6',
+ ],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'CollectionQualifiedName',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The unique identifier of the collection.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => 'album.2222',
+ ],
+ ],
+ [
+ 'name' => 'EntityQualifiedName',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The unique identifier of the entity. Example: maxcompute-table.projectA.tableA.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => 'maxcompute-table.projectA.tableB',
+ ],
+ ],
+ [
+ 'name' => 'Remark',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The remarks of the entity. Example: latest product table.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'this is a remark',
+ 'maxLength' => 50,
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => 'Schema of Response',
+ 'description' => 'The response parameters.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'title' => 'Id of the request',
+ 'description' => 'The request ID. You can use the request ID to query logs and troubleshoot issues.'."\n",
+ 'type' => 'string',
+ 'example' => '0000-ABCD-E****',
+ ],
+ 'Status' => [
+ 'description' => 'The result of the operation. Valid values:'."\n"
+ ."\n"
+ .'* true: succeeded'."\n"
+ .'* false: failed'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'HttpStatusCode' => [
+ 'description' => 'The HTTP status code.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '200',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message.'."\n",
+ 'type' => 'string',
+ 'example' => 'The specified product does not exist.',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code.'."\n",
+ 'type' => 'string',
+ 'example' => '9999',
+ ],
+ 'Success' => [
+ 'description' => 'Indicates whether the request was successful. Valid values:'."\n"
+ ."\n"
+ .'true false'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'errorCodes' => [
+ 400 => [
+ [
+ 'errorCode' => 'Invalid.Entity.NotExist',
+ 'errorMessage' => '%s',
+ ],
+ ],
+ ],
+ 'staticInfo' => [
+ 'returnType' => 'synchronous',
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"0000-ABCD-E****\\",\\n \\"Status\\": true,\\n \\"HttpStatusCode\\": 200,\\n \\"ErrorMessage\\": \\"The specified product does not exist.\\",\\n \\"ErrorCode\\": \\"9999\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<AddMetaCollectionEntityResponse>\\n <RequestId>0000-ABCD-E****</RequestId>\\n <Status>true</Status>\\n <HttpStatusCode>200</HttpStatusCode>\\n <ErrorMessage>The specified product does not exist.</ErrorMessage>\\n <ErrorCode>9999</ErrorCode>\\n <Success>true</Success>\\n</AddMetaCollectionEntityResponse>","errorExample":""}]',
+ 'title' => 'AddMetaCollectionEntity',
+ ],
+ 'CreateMetaCollection' => [
+ 'summary' => 'Creates a collection.',
+ 'methods' => [
+ 'post',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'write',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'create',
+ 'abilityTreeCode' => '163133',
+ 'abilityTreeNodes' => [
+ 'FEATUREdideE9XYA6',
+ ],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'Name',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The name of the collection. The name must be 1 to 32 characters in length.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => 'collection_name',
+ ],
+ ],
+ [
+ 'name' => 'Comment',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The comment of the collection. The comment must be 1 to 64 characters in length.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'this is a comment',
+ ],
+ ],
+ [
+ 'name' => 'ParentQualifiedName',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The unique identifier of the parent collection.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'album.333508',
+ ],
+ ],
+ [
+ 'name' => 'CollectionType',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The type of the collection.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => 'ALBUM',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => 'Schema of Response',
+ 'description' => 'The response parameters.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'title' => 'Id of the request',
+ 'description' => 'The request ID.'."\n",
+ 'type' => 'string',
+ 'example' => 'E6F0DBDD-5AD****',
+ ],
+ 'QualifiedName' => [
+ 'description' => 'The unique identifier of the collection.'."\n",
+ 'type' => 'string',
+ 'example' => 'album.11111',
+ ],
+ 'Success' => [
+ 'description' => 'Indicates whether the request was successful. Valid values:'."\n"
+ ."\n"
+ .'* true'."\n"
+ .'* false'."\n",
+ 'type' => 'string',
+ 'example' => 'true',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code.'."\n",
+ 'type' => 'string',
+ 'example' => 'NoPermission',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message.'."\n",
+ 'type' => 'string',
+ 'example' => 'The specified parameters are invalid.',
+ ],
+ 'HttpStatusCode' => [
+ 'description' => 'The HTTP status code.'."\n",
+ 'type' => 'string',
+ 'example' => '200',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"E6F0DBDD-5AD****\\",\\n \\"QualifiedName\\": \\"album.11111\\",\\n \\"Success\\": \\"true\\",\\n \\"ErrorCode\\": \\"NoPermission\\",\\n \\"ErrorMessage\\": \\"The specified parameters are invalid.\\",\\n \\"HttpStatusCode\\": \\"200\\"\\n}","errorExample":""},{"type":"xml","example":"<CreateMetaCollectionResponse>\\n <RequestId>E6F0DBDD-5AD****</RequestId>\\n <QualifiedName>album.1111</QualifiedName>\\n <Success>true</Success>\\n <ErrorCode>9999</ErrorCode>\\n <ErrorMessage>The specified parameters are invalid.</ErrorMessage>\\n <HttpStatusCode>200</HttpStatusCode>\\n</CreateMetaCollectionResponse>","errorExample":""}]',
+ 'title' => 'CreateMetaCollection',
+ 'description' => 'Collections are classified into various types. The names of collections of the same type must be different.'."\n",
+ 'requestParamsDescription' => 'A category must belong to a data album. You can create a category in a data album only after you create the data album. You can set the parentQualifiedName parameter to the unique identifier of the data album to create the category.'."\n",
+ ],
+ 'ListLineage' => [
+ 'summary' => 'Queries the ancestor or descendant lineage of an entity.',
+ 'methods' => [
+ 'post',
+ 'get',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'list',
+ 'abilityTreeCode' => '178500',
+ 'abilityTreeNodes' => [
+ 'FEATUREdideSYOMAV',
+ ],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'EntityQualifiedName',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The unique identifier of the entity.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => 'maxcompute-table.project.table',
+ ],
+ ],
+ [
+ 'name' => 'NextToken',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The pagination token that is used in the next request to retrieve a new page of results.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'next-token-from-previous-request',
+ ],
+ ],
+ [
+ 'name' => 'Keyword',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The keyword of the entity name.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'name-keyword',
+ ],
+ ],
+ [
+ 'name' => 'Direction',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The lineage type. Valid values:'."\n"
+ ."\n"
+ .'* up: ancestor lineage'."\n"
+ .'* down: descendant lineage'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => 'up',
+ ],
+ ],
+ [
+ 'name' => 'PageSize',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The number of entries per page. Maximum value: 100.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => false,
+ 'example' => '10',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'description' => 'OpenApiMetaResultModel'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'HttpStatusCode' => [
+ 'description' => 'The HTTP status code.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '200',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message.'."\n",
+ 'type' => 'string',
+ 'example' => 'qualifiedName should be in format as entity-table.entity-guid',
+ ],
+ 'RequestId' => [
+ 'description' => 'The request ID.'."\n",
+ 'type' => 'string',
+ 'example' => '64B-587A-8CED-969E1973887FXXX-TT',
+ ],
+ 'Success' => [
+ 'description' => 'Indicates whether the request was successful. Valid values:'."\n"
+ ."\n"
+ .'* true'."\n"
+ .'* false'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code.'."\n",
+ 'type' => 'string',
+ 'example' => '1010040007',
+ ],
+ 'Data' => [
+ 'description' => 'The structure returned.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'NextToken' => [
+ 'description' => 'A pagination token. It can be used in the next request to retrieve a new page of results.'."\n",
+ 'type' => 'string',
+ 'example' => 'nextTokenFromRequest-xxxsd-ff',
+ ],
+ 'DataEntityList' => [
+ 'description' => 'The array of the entity structure.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The entity structure.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'Entity' => [
+ 'description' => 'The information about the entity.'."\n",
+ '$ref' => '#/components/schemas/Entity',
+ ],
+ 'CreateTimestamp' => [
+ 'description' => 'The time when the lineage was generated.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '1686215809269',
+ ],
+ 'RelationList' => [
+ 'description' => 'The array of the relationship structure.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The relationship structure.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'Guid' => [
+ 'description' => 'The unique relationship ID.'."\n",
+ 'type' => 'string',
+ 'example' => 'aaabbccddguid',
+ ],
+ 'Datasource' => [
+ 'description' => 'The data source.'."\n",
+ 'type' => 'string',
+ 'example' => 'mysql',
+ ],
+ 'Type' => [
+ 'description' => 'The task type, which is used to describe the relationship between entities, such as SQL-based calculation, mapping based on report fields, or API operation definition.'."\n",
+ 'type' => 'string',
+ 'example' => 'sql',
+ ],
+ 'Channel' => [
+ 'description' => 'The data channel. Valid values:'."\n"
+ ."\n"
+ .'* **FIRST_PARTY: DataWorks platform**'."\n"
+ .'* **THIRD_PARTY: user registration**'."\n",
+ 'type' => 'string',
+ 'example' => 'THIRD_PARTY',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"ErrorMessage\\": \\"qualifiedName should be in format as entity-table.entity-guid\\",\\n \\"RequestId\\": \\"64B-587A-8CED-969E1973887FXXX-TT\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"1010040007\\",\\n \\"Data\\": {\\n \\"NextToken\\": \\"nextTokenFromRequest-xxxsd-ff\\",\\n \\"DataEntityList\\": [\\n {\\n \\"Entity\\": {\\n \\"QualifiedName\\": \\"maxcompute_table.563f0357118d05ef145d6bddf2966cc23e86ca8f2f013f915e565afdf09f7a23\\",\\n \\"TenantId\\": 12345,\\n \\"EntityContent\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n }\\n },\\n \\"CreateTimestamp\\": 1686215809269,\\n \\"RelationList\\": [\\n {\\n \\"Guid\\": \\"aaabbccddguid\\",\\n \\"Datasource\\": \\"maxcompute,mysql\\",\\n \\"Type\\": \\"sql\\",\\n \\"Channel\\": \\"THIRD_PARTY\\"\\n }\\n ]\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<ListLineageResponse>\\n <HttpStatusCode>200</HttpStatusCode>\\n <ErrorMessage>qualifiedName should be in format as entity-table.entity-guid</ErrorMessage>\\n <RequestId>64B-587A-8CED-969E1973887FXXX-TT</RequestId>\\n <Success>true</Success>\\n <ErrorCode>1010040007</ErrorCode>\\n <Data>\\n <NextToken>nextTokenFromRequest-xxxsd-ff</NextToken>\\n <DataEntityList>\\n <Entity>\\n <QualifiedName>maxcompute_table.563f0357118d05ef145d6bddf2966cc23e86ca8f2f013f915e565afdf09f7a23</QualifiedName>\\n <TenantId>12345</TenantId>\\n </Entity>\\n <CreateTimestamp>1686215809269</CreateTimestamp>\\n <RelationList>\\n <Guid>aaabbccddguid</Guid>\\n <Datasource>mysql</Datasource>\\n <Type>sql</Type>\\n <Channel>THIRD_PARTY</Channel>\\n </RelationList>\\n </DataEntityList>\\n </Data>\\n</ListLineageResponse>","errorExample":""}]',
+ 'title' => 'ListLineage',
+ ],
+ 'DeleteLineageRelation' => [
+ 'summary' => 'Delete lineage, supports deleting user-defined lineage relationships',
+ 'methods' => [
+ 'post',
+ 'get',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'delete',
+ 'abilityTreeCode' => '178630',
+ 'abilityTreeNodes' => [
+ 'FEATUREdideSYOMAV',
+ ],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'SrcEntityQualifiedName',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'Source entity unique identifier',
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => 'maxcompute-table.project.table',
+ ],
+ ],
+ [
+ 'name' => 'DestEntityQualifiedName',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'Destination entity unique identifier',
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => 'custom-report.report123',
+ ],
+ ],
+ [
+ 'name' => 'RelationshipGuid',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'Lineage relationship unique identifier',
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'dfazcdfdfccdedd',
+ ],
+ ],
+ [
+ 'name' => 'RelationshipType',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'Relationship type',
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'sql',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'description' => 'OpenApiMetaResultModel'."\n"
+ ."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'HttpStatusCode' => [
+ 'description' => 'HTTP status code'."\n"
+ ."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '200',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'Error message'."\n"
+ ."\n",
+ 'type' => 'string',
+ 'example' => 'qualifiedName should be in format as entity-table.entity-guid',
+ ],
+ 'RequestId' => [
+ 'description' => 'Request ID: used for locating logs and troubleshooting'."\n"
+ ."\n",
+ 'type' => 'string',
+ 'example' => '64B-587A-8CED-969E1973887FXXX-TT',
+ ],
+ 'Success' => [
+ 'description' => 'Whether the call was successful. Values are as follows:'."\n"
+ ."\n"
+ .'true: success'."\n"
+ ."\n"
+ .'false: failed',
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'Error code'."\n"
+ ."\n",
+ 'type' => 'string',
+ 'example' => '1010040007',
+ ],
+ 'Status' => [
+ 'description' => 'Operation result:'."\n"
+ ."\n"
+ .'true: Success'."\n"
+ ."\n"
+ .'false: Failure'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"ErrorMessage\\": \\"qualifiedName should be in format as entity-table.entity-guid\\",\\n \\"RequestId\\": \\"64B-587A-8CED-969E1973887FXXX-TT\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"1010040007\\",\\n \\"Status\\": true\\n}","type":"json"}]',
+ 'title' => 'DeleteLineageRelation',
+ 'description' => 'This API is currently in the trial phase. Users who wish to experience it can apply, and after the administrator adds them to the trial list, they can call this API.',
+ 'translator' => 'machine',
+ ],
+ 'RegisterLineageRelation' => [
+ 'summary' => 'Registers the lineage between self-managed entities to DataWorks.',
+ 'methods' => [
+ 'post',
+ 'get',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'create',
+ 'abilityTreeCode' => '178589',
+ 'abilityTreeNodes' => [
+ 'FEATUREdideSYOMAV',
+ ],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'LineageRelationRegisterVO',
+ 'in' => 'formData',
+ 'style' => 'json',
+ 'schema' => [
+ 'description' => 'The structure whose lineage you want to register to DataWorks.'."\n",
+ 'required' => true,
+ '$ref' => '#/components/schemas/LineageRelationRegisterVO',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'description' => 'OpenApiMetaResultModel'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'HttpStatusCode' => [
+ 'description' => 'The HTTP status code.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '200',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message.'."\n",
+ 'type' => 'string',
+ 'example' => 'The entity of lineage not exist, xxx',
+ ],
+ 'RequestId' => [
+ 'description' => 'The request ID. You can locate logs and troubleshoot issues based on the ID.'."\n",
+ 'type' => 'string',
+ 'example' => 'EE50E05E-028C-182B-9xxx',
+ ],
+ 'Success' => [
+ 'description' => 'Indicates whether the request was successful. Valid values:'."\n"
+ ."\n"
+ .'* true'."\n"
+ .'* false'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code.'."\n",
+ 'type' => 'string',
+ 'example' => '1010210001',
+ ],
+ 'LineageRelation' => [
+ 'description' => 'The lineage.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'SrcEntityQualifiedName' => [
+ 'description' => 'The unique identifier of the source entity.'."\n",
+ 'type' => 'string',
+ 'example' => 'maxcompute-table.project.table',
+ ],
+ 'DestEntityQualifiedName' => [
+ 'description' => 'The unique identifier of the destination entity.'."\n",
+ 'type' => 'string',
+ 'example' => 'custom-report.month_stat_user',
+ ],
+ 'RelationshipGuid' => [
+ 'description' => 'The ID of the lineage between entities.'."\n",
+ 'type' => 'string',
+ 'example' => 'dfsldfdlsfdsaaaabbbb',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"ErrorMessage\\": \\"The entity of lineage not exist, xxx\\",\\n \\"RequestId\\": \\"EE50E05E-028C-182B-****\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"1010210001\\",\\n \\"LineageRelation\\": {\\n \\"SrcEntityQualifiedName\\": \\"maxcompute-table.project.table\\",\\n \\"DestEntityQualifiedName\\": \\"custom-report.month_stat_user\\",\\n \\"RelationshipGuid\\": \\"dfsldfdlsfdsaaaabbbb\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"<RegisterLineageRelationResponse>\\n <HttpStatusCode>200</HttpStatusCode>\\n <ErrorMessage>The entity of lineage not exist, xxx</ErrorMessage>\\n <RequestId>EE50E05E-028C-182B-9xxx</RequestId>\\n <Success>true</Success>\\n <ErrorCode>1010210001</ErrorCode>\\n <LineageRelation>\\n <SrcEntityQualifiedName>maxcompute-table.project.table</SrcEntityQualifiedName>\\n <DestEntityQualifiedName>custom-report.month_stat_user</DestEntityQualifiedName>\\n <RelationshipGuid>dfsldfdlsfdsaaaabbbb</RelationshipGuid>\\n </LineageRelation>\\n</RegisterLineageRelationResponse>","errorExample":""}]',
+ 'title' => 'RegisterLineageRelation',
+ 'description' => 'This operation is in the trial phase. Users who need to call this operation can apply for it. The users can call this operation after the administrator adds the users to the trial list.'."\n",
+ 'requestParamsDescription' => 'Format of the unique identifier of an entity: EntityType.EntityGuid'."\n"
+ ."\n"
+ .' 1. The EntityType parameter identifies the type of an entity.'."\n"
+ .' 1.1 Existing entity types in DataWorks'."\n"
+ .' (1) MaxCompute table: maxcompute-table'."\n"
+ .' (2) MySQL table: mysql-table'."\n"
+ .' (3) EMR table: emr-table'."\n"
+ .' (4) Hologres table: holodb-table'."\n"
+ ."\n"
+ .' 1.2 Custom entity types: custom-xxx'."\n"
+ .' The following entity types are recommended based on user requirements:'."\n"
+ .' (1) Table: custom-table'."\n"
+ .' (2) API: custom-api'."\n"
+ .' (3) Application: custom-app'."\n"
+ .' (4) Report: custom-report'."\n"
+ .' (5) Dataset: custom-dataset'."\n"
+ .' (6) Data source: custom-datasource'."\n"
+ ."\n"
+ .' 2. The EntityGuid parameter specifies the unique identifier of an entity among multiple entities of the same type.'."\n"
+ .' Users can define the unique ID for a custom entity based on their business requirements.'."\n"
+ ."\n"
+ .' 3. Sample entity:'."\n"
+ .' 3.1 The existing lineage between system entities in DataWorks can be viewed in lineage graphs on the Data Map page.'."\n"
+ .' (1) maxcompute-table.project.tableName specifies the unique ID of a MaxCompute table.'."\n"
+ .' (2) emr-table.kadfdfaccdd4ted specifies the unique ID of an E-MapReduce (EMR) table.'."\n"
+ .' 3.2 Users can define the unique ID for a custom entity based on their business requirements. The unique ID cannot exceed 50 bytes in length.'."\n"
+ .' (1) custom-api.listUser: specifies a custom API entity. The unique identifier of the entity is listUser.'."\n"
+ .' (2) custom-table.db1.table2: specifies a custom table entity. The unique identifier of the entity is db1.table2.'."\n",
+ ],
+ 'GetMetaTableLineage' => [
+ 'methods' => [
+ 'post',
+ 'get',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'get',
+ 'abilityTreeCode' => '78266',
+ 'abilityTreeNodes' => [
+ 'FEATUREdideSYOMAV',
+ ],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'TableGuid',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The unique identifier of the table.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'docRequired' => true,
+ 'example' => 'odps.engine_name.table_name',
+ ],
+ ],
+ [
+ 'name' => 'Direction',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'Specifies the ancestor or descendant lineage that you want to query for a field. Valid values: up and down. The value up indicates the ancestor lineage. The value down indicates the descendant lineage.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'up',
+ ],
+ ],
+ [
+ 'name' => 'NextPrimaryKey',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The logic of paging. Configure this parameter based on the value of the response parameter NextPrimaryKey when the value of the response parameter HasNext is true in the previous request.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'odps.engine_name.table_name1',
+ ],
+ ],
+ [
+ 'name' => 'PageSize',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The number of entries per page. Default value: 10. Maximum value: 100.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => false,
+ 'example' => '10',
+ ],
+ ],
+ [
+ 'name' => 'ClusterId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the E-MapReduce (EMR) cluster. Configure this parameter only if you want to query the lineage of an EMR table.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'abc',
+ ],
+ ],
+ [
+ 'name' => 'DatabaseName',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The name of the database.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'abc',
+ ],
+ ],
+ [
+ 'name' => 'TableName',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The name of the table.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'abc',
+ ],
+ ],
+ [
+ 'name' => 'DataSourceType',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The type of the data source. Valid values: odps and emr.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'emr',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'headers' => [],
+ 'schema' => [
+ 'description' => 'The returned result.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'HttpStatusCode' => [
+ 'description' => 'The HTTP status code.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '200',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message.'."\n",
+ 'type' => 'string',
+ 'example' => 'The connection does not exist.',
+ ],
+ 'RequestId' => [
+ 'description' => 'The request ID.'."\n",
+ 'type' => 'string',
+ 'example' => '0bc1ec92159376',
+ ],
+ 'Success' => [
+ 'description' => 'Indicates whether the request was successful.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code.'."\n",
+ 'type' => 'string',
+ 'example' => 'Invalid.Tenant.ConnectionNotExists',
+ ],
+ 'Data' => [
+ 'description' => 'The business data.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'NextPrimaryKey' => [
+ 'description' => 'The logic of paging. If the value true is returned for the HasNext parameter and a value is returned for the NextPrimaryKey parameter in the response of the previous request, you must use the value of the NextPrimaryKey parameter for the next request.'."\n",
+ 'type' => 'string',
+ 'example' => 'odps | retail_e_commerce_2 | retail_e_commerce_2 | dws_ec_trd__cate_commodity_gmv_kpy_fy',
+ ],
+ 'HasNext' => [
+ 'description' => 'Indicates whether the next page exists.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'DataEntityList' => [
+ 'description' => 'The information about the table.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '',
+ 'type' => 'object',
+ 'properties' => [
+ 'TableName' => [
+ 'description' => 'The name of the table.'."\n",
+ 'type' => 'string',
+ 'example' => 'name',
+ ],
+ 'TableGuid' => [
+ 'description' => 'The unique identifier of the table.'."\n",
+ 'type' => 'string',
+ 'example' => 'odps.tt.name',
+ ],
+ 'CreateTimestamp' => [
+ 'description' => 'The time when the table was created.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '1638720736000',
+ ],
+ 'DatabaseName' => [
+ 'description' => 'The name of the database.'."\n",
+ 'type' => 'string',
+ 'example' => 'db1',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'errorCodes' => [
+ 400 => [
+ [
+ 'errorCode' => 'Invalid.Meta.TableNotExist',
+ 'errorMessage' => 'The table does not exist.',
+ ],
+ [
+ 'errorCode' => 'InvalidParameter.Meta.CommonError',
+ 'errorMessage' => 'The specified parameter is invalid.',
+ ],
+ [
+ 'errorCode' => 'InvalidParameter.Meta.GuidFormat',
+ 'errorMessage' => 'The GUID format is invalid.',
+ ],
+ [
+ 'errorCode' => 'InvalidParameter.Meta.Illegal',
+ 'errorMessage' => 'The app guid parameter is invalid.',
+ ],
+ [
+ 'errorCode' => 'InvalidParameter.Meta.IllegalDate',
+ 'errorMessage' => 'The date format is invalid.',
+ ],
+ [
+ 'errorCode' => 'InvalidParameter.Meta.IllegalPageError',
+ 'errorMessage' => 'The parameter for paging is invalid.',
+ ],
+ [
+ 'errorCode' => 'InvalidParameter.Meta.NotExist',
+ 'errorMessage' => 'The object does not exist.',
+ ],
+ [
+ 'errorCode' => 'InternalError.UserId.Missing',
+ 'errorMessage' => 'An internal system error occurred. Try again later.',
+ ],
+ [
+ 'errorCode' => 'InternalError.Meta.NoCalcEngine',
+ 'errorMessage' => 'An error occurred while retrieving the compute engine based on the MaxCompute project.',
+ ],
+ ],
+ 403 => [
+ [
+ 'errorCode' => 'Forbidden.Access',
+ 'errorMessage' => 'Access is forbidden. Activate DataWorks first.',
+ ],
+ [
+ 'errorCode' => 'ResourceNotAuthorized.Api',
+ 'errorMessage' => 'You are not authorized to access the resources.',
+ ],
+ [
+ 'errorCode' => 'Forbidden.Meta.NoTenant',
+ 'errorMessage' => 'The user is not the owner of any tenants.',
+ ],
+ ],
+ 429 => [
+ [
+ 'errorCode' => 'Throttling.Api',
+ 'errorMessage' => 'The request for this resource has exceeded your available limit.',
+ ],
+ [
+ 'errorCode' => 'Throttling.Api.Risk',
+ 'errorMessage' => 'The request for this resource has exceeded your daily available limit.',
+ ],
+ [
+ 'errorCode' => 'Throttling.System',
+ 'errorMessage' => 'The DataWorks system is busy. Try again later.',
+ ],
+ [
+ 'errorCode' => 'Throttling.User',
+ 'errorMessage' => 'Your request is too frequent. Try again later.',
+ ],
+ ],
+ 500 => [
+ [
+ 'errorCode' => 'InternalError.System',
+ 'errorMessage' => 'An internal system error occurred. Try again later.',
+ ],
+ [
+ 'errorCode' => 'InternalError.Meta.TenantTimeOut',
+ 'errorMessage' => 'Failed to connect to the interface network.',
+ ],
+ [
+ 'errorCode' => 'InternalError.Meta.Unknown',
+ 'errorMessage' => 'An unknown error occurred while processing your request.',
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"ErrorMessage\\": \\"The connection does not exist.\\",\\n \\"RequestId\\": \\"0bc1ec92159376\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"Invalid.Tenant.ConnectionNotExists\\",\\n \\"Data\\": {\\n \\"NextPrimaryKey\\": \\"odps.tt.2\\",\\n \\"HasNext\\": true,\\n \\"DataEntityList\\": [\\n {\\n \\"TableName\\": \\"name\\",\\n \\"TableGuid\\": \\"odps.tt.name\\",\\n \\"CreateTimestamp\\": 1638720736000,\\n \\"DatabaseName\\": \\"db1\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<GetMetaTableLineageResponse>\\n <HttpStatusCode>200</HttpStatusCode>\\n <ErrorMessage>The connection does not exist.</ErrorMessage>\\n <RequestId>0bc1ec92159376</RequestId>\\n <Success>true</Success>\\n <ErrorCode>Invalid.Tenant.ConnectionNotExists</ErrorCode>\\n <Data>\\n <NextPrimaryKey>odps.tt.2</NextPrimaryKey>\\n <HasNext>true</HasNext>\\n <DataEntityList>\\n <TableName>name</TableName>\\n <TableGuid>odps.tt.name</TableGuid>\\n <CreateTimestamp>1638720736000</CreateTimestamp>\\n <DatabaseName>db1</DatabaseName>\\n </DataEntityList>\\n </Data>\\n</GetMetaTableLineageResponse>","errorExample":""}]',
+ 'title' => 'GetMetaTableLineage',
+ 'summary' => 'Queries the lineage of a metatable.',
+ 'requestParamsDescription' => ' ',
+ 'responseParamsDescription' => ' ',
+ ],
+ 'GetMetaColumnLineage' => [
+ 'methods' => [
+ 'post',
+ 'get',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'get',
+ 'abilityTreeCode' => '78258',
+ 'abilityTreeNodes' => [
+ 'FEATUREdideSYOMAV',
+ ],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'ColumnGuid',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The unique identifier of the field.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'docRequired' => true,
+ 'example' => 'odps.engine_name.table_name.column_name',
+ ],
+ ],
+ [
+ 'name' => 'Direction',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'Specifies whether to query the ancestor or descendant lineage of the field. The value up indicates the ancestor lineage. The value down indicates the descendant lineage.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'up',
+ ],
+ ],
+ [
+ 'name' => 'PageNum',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The number of the page to return.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => false,
+ 'example' => '1',
+ ],
+ ],
+ [
+ 'name' => 'PageSize',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The number of entries to return on each page. Default value: 10. Maximum value: 100.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => false,
+ 'example' => '10',
+ ],
+ ],
+ [
+ 'name' => 'ClusterId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the E-MapReduce (EMR) cluster. Configure this parameter only when you query data in an EMR compute engine instance.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'abc',
+ ],
+ ],
+ [
+ 'name' => 'DatabaseName',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The name of the database.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'abc',
+ ],
+ ],
+ [
+ 'name' => 'TableName',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The name of the metatable.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'abc',
+ ],
+ ],
+ [
+ 'name' => 'ColumnName',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The name of the field.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'abc',
+ ],
+ ],
+ [
+ 'name' => 'DataSourceType',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The type of the data source. Valid values: odps and emr.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'emr',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'HttpStatusCode' => [
+ 'description' => 'The HTTP status code.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '200',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message.'."\n",
+ 'type' => 'string',
+ 'example' => 'The connection does not exist.',
+ ],
+ 'RequestId' => [
+ 'description' => 'The request ID.'."\n",
+ 'type' => 'string',
+ 'example' => '0bc1ec92159376',
+ ],
+ 'Success' => [
+ 'description' => 'Indicates whether the request was successful.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code.'."\n",
+ 'type' => 'string',
+ 'example' => 'Invalid.Tenant.ConnectionNotExists',
+ ],
+ 'Data' => [
+ 'description' => 'The business data.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'PageNum' => [
+ 'description' => 'The page number.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '1',
+ ],
+ 'PageSize' => [
+ 'description' => 'The number of entries per page. Default value: 10. Maximum value: 100.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '10',
+ ],
+ 'TotalCount' => [
+ 'description' => 'The total number of fields.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '20',
+ ],
+ 'DataEntityList' => [
+ 'description' => 'The returned result.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'ColumnGuid' => [
+ 'description' => 'The unique identifier of the field.'."\n",
+ 'type' => 'string',
+ 'example' => 'odps.engine_name.table_name.1',
+ ],
+ 'ColumnName' => [
+ 'description' => 'The name of the field.'."\n",
+ 'type' => 'string',
+ 'example' => '1',
+ ],
+ 'TableName' => [
+ 'description' => 'The name of the table.'."\n",
+ 'type' => 'string',
+ 'example' => 'abc',
+ ],
+ 'DatabaseName' => [
+ 'description' => 'The name of the database.'."\n",
+ 'type' => 'string',
+ 'example' => 'abc',
+ ],
+ 'ClusterId' => [
+ 'description' => 'The EMR cluster ID.'."\n",
+ 'type' => 'string',
+ 'example' => 'abc',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'description' => '',
+ ],
+ ],
+ ],
+ 'errorCodes' => [
+ 400 => [
+ [
+ 'errorCode' => 'Invalid.Meta.TableNotExist',
+ 'errorMessage' => 'The table does not exist.',
+ ],
+ [
+ 'errorCode' => 'InvalidParameter.Meta.CommonError',
+ 'errorMessage' => 'The specified parameter is invalid.',
+ ],
+ [
+ 'errorCode' => 'InvalidParameter.Meta.Illegal',
+ 'errorMessage' => 'The app guid parameter is invalid.',
+ ],
+ [
+ 'errorCode' => 'InvalidParameter.Meta.IllegalDate',
+ 'errorMessage' => 'The date format is invalid.',
+ ],
+ [
+ 'errorCode' => 'InvalidParameter.Meta.IllegalPageError',
+ 'errorMessage' => 'The parameter for paging is invalid.',
+ ],
+ [
+ 'errorCode' => 'InvalidParameter.Meta.NotExist',
+ 'errorMessage' => 'The object does not exist.',
+ ],
+ ],
+ 403 => [
+ [
+ 'errorCode' => 'Forbidden.Meta.NoTenant',
+ 'errorMessage' => 'The user is not the owner of any tenants.',
+ ],
+ [
+ 'errorCode' => 'Forbidden.Access',
+ 'errorMessage' => 'Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.',
+ ],
+ ],
+ 429 => [
+ [
+ 'errorCode' => 'Throttling.Api',
+ 'errorMessage' => 'The request for this resource has exceeded your available limit.',
+ ],
+ [
+ 'errorCode' => 'Throttling.Api.Risk',
+ 'errorMessage' => 'The request for this resource has exceeded your daily available limit.',
+ ],
+ [
+ 'errorCode' => 'Throttling.System',
+ 'errorMessage' => 'The DataWorks system is busy. Try again later.',
+ ],
+ [
+ 'errorCode' => 'Throttling.User',
+ 'errorMessage' => 'Your request is too frequent. Try again later.',
+ ],
+ ],
+ 500 => [
+ [
+ 'errorCode' => 'InternalError.System',
+ 'errorMessage' => 'An internal system error occurred. Try again later.',
+ ],
+ [
+ 'errorCode' => 'InternalError.UserId.Missing',
+ 'errorMessage' => 'An internal system error occurred. Try again later.',
+ ],
+ [
+ 'errorCode' => 'InternalError.Meta.NoCalcEngine',
+ 'errorMessage' => 'An error occurred while retrieving the compute engine based on the MaxCompute project.',
+ ],
+ [
+ 'errorCode' => 'InternalError.Meta.TenantTimeOut',
+ 'errorMessage' => 'Failed to connect to the interface network.',
+ ],
+ [
+ 'errorCode' => 'InternalError.Meta.Unknown',
+ 'errorMessage' => 'An unknown error occurred while processing your request.',
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"ErrorMessage\\": \\"The connection does not exist.\\",\\n \\"RequestId\\": \\"0bc1ec92159376\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"Invalid.Tenant.ConnectionNotExists\\",\\n \\"Data\\": {\\n \\"PageNum\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 20,\\n \\"DataEntityList\\": [\\n {\\n \\"ColumnGuid\\": \\"odps.engine_name.table_name.1\\",\\n \\"ColumnName\\": \\"1\\",\\n \\"TableName\\": \\"abc\\",\\n \\"DatabaseName\\": \\"abc\\",\\n \\"ClusterId\\": \\"abc\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<RequestId>0bc1ec92159376</RequestId>\\n<HttpStatusCode>200</HttpStatusCode>\\n<Data>\\n <TotalCount>20</TotalCount>\\n <PageNum>1</PageNum>\\n <PageSize>10</PageSize>\\n <DataEntityList>\\n <ColumnName>1</ColumnName>\\n <TableName>abc</TableName>\\n <ColumnGuid>odps.engine_name.table_name.1</ColumnGuid>\\n <ClusterId>abc</ClusterId>\\n <DatabaseName>abc</DatabaseName>\\n </DataEntityList>\\n</Data>\\n<ErrorCode>Invalid.Tenant.ConnectionNotExists</ErrorCode>\\n<ErrorMessage>The connection does not exist.</ErrorMessage>\\n<Success>true</Success>","errorExample":""}]',
+ 'title' => 'GetMetaColumnLineage',
+ 'summary' => 'Queries the lineage of a field in a metatable.',
+ 'requestParamsDescription' => ' ',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => 'For information about the example on how to use the GetMetaColumnLineage operation, see [Examples of DataWorks API operations](https://developer.aliyun.com/article/780879?groupCode=dataworks).'."\n",
+ ],
+ 'CreateFile' => [
+ 'methods' => [
+ 'post',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'readAndWrite',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'create',
+ 'abilityTreeCode' => '78185',
+ 'abilityTreeNodes' => [
+ 'FEATUREdideHO4TQP',
+ 'FEATUREdide8FM783',
+ ],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'FileFolderPath',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The path of the file.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'docRequired' => true,
+ 'example' => 'Business_process/First_Business_Process/MaxCompute/Folder_1/Folder_2',
+ ],
+ ],
+ [
+ 'name' => 'ProjectId',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The ID of the DataWorks workspace. You can log on to the [DataWorks console](https://workbench.data.aliyun.com/console) and go to the Workspace Management page to obtain the workspace ID.'."\n"
+ ."\n"
+ .'You must configure this parameter or the ProjectIdentifier parameter to determine the DataWorks workspace to which the operation is applied.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'docRequired' => true,
+ 'example' => '10000',
+ ],
+ ],
+ [
+ 'name' => 'FileName',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The name of the file.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'File name',
+ ],
+ ],
+ [
+ 'name' => 'FileDescription',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The description of the file.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'docRequired' => false,
+ 'example' => 'Here is the file description',
+ 'maxLength' => 200,
+ ],
+ ],
+ [
+ 'name' => 'FileType',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The type of the code for the file. The code for files varies based on the file type. For more information, see [DataWorks nodes](~~600169~~).'."\n"
+ ."\n"
+ .'You can call the [ListFileType](~~212428~~) operation to query the type of the code for the file.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => '10',
+ ],
+ ],
+ [
+ 'name' => 'Owner',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The ID of the Alibaba Cloud account used by the file owner. If this parameter is not configured, the ID of the Alibaba Cloud account of the user who calls the operation is used.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => '1000000000001',
+ ],
+ ],
+ [
+ 'name' => 'Content',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The code for the file. The code format varies based on the file type. To view the code format for a specific file type, go to Operation Center, right-click a node of the file type, and then select View Code.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'SHOW TABLES;',
+ ],
+ ],
+ [
+ 'name' => 'AutoRerunTimes',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The number of automatic reruns that are allowed after an error occurs. Maximum value: 10.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => false,
+ 'docRequired' => false,
+ 'example' => '3',
+ ],
+ ],
+ [
+ 'name' => 'AutoRerunIntervalMillis',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The interval between automatic reruns after an error occurs. Unit: milliseconds. Maximum value: 1800000 (30 minutes).'."\n"
+ ."\n"
+ .'This parameter corresponds to the Rerun Interval parameter that is displayed after the Auto Rerun upon Error check box is selected in the Schedule section of the Properties tab in the [DataWorks console](https://workbench.data.aliyun.com/console).'."\n"
+ ."\n"
+ .'The interval that you specify in the DataWorks console is measured in minutes. Pay attention to the conversion between the units of time when you call the operation.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => false,
+ 'example' => '120000',
+ ],
+ ],
+ [
+ 'name' => 'RerunMode',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'Specifies whether the node that corresponds to the file can be rerun. Valid values:'."\n"
+ ."\n"
+ .'* ALL_ALLOWED: The node can be rerun regardless of whether it is successfully run or fails to run.'."\n"
+ .'* FAILURE_ALLOWED: The node can be rerun only after it fails to run.'."\n"
+ .'* ALL_DENIED: The node cannot be rerun regardless of whether it is successfully run or fails to run.'."\n"
+ ."\n"
+ .'This parameter corresponds to the Rerun parameter in the Schedule section of the Properties tab on the DataStudio page in the [DataWorks console](https://workbench.data.aliyun.com/console).'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'enumValueTitles' => [],
+ 'example' => 'ALL_ALLOWED',
+ 'default' => 'ALL_ALLOWED',
+ 'enum' => [
+ 'ALL_ALLOWED',
+ 'FAILURE_ALLOWED',
+ 'ALL_DENIED',
+ ],
+ ],
+ ],
+ [
+ 'name' => 'Stop',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'Specifies whether to suspend the scheduling of the node. Valid values:'."\n"
+ ."\n"
+ .'* true'."\n"
+ .'* false'."\n"
+ ."\n"
+ .'This parameter corresponds to the Recurrence parameter in the Schedule section of the Properties tab on the DataStudio page in the [DataWorks console](https://workbench.data.aliyun.com/console).'."\n",
+ 'type' => 'boolean',
+ 'required' => false,
+ 'example' => 'false',
+ 'default' => 'false',
+ ],
+ ],
+ [
+ 'name' => 'ParaValue',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The scheduling parameters of the node. Separate multiple parameters with spaces.'."\n"
+ ."\n"
+ .'This parameter corresponds to the Parameters section of the Properties tab in the [DataWorks console](https://workbench.data.aliyun.com/console). For more information about the configurations of the scheduling parameters, see [Configure scheduling parameters](~~137548~~).'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'a=x b=y',
+ ],
+ ],
+ [
+ 'name' => 'StartEffectDate',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The start time of automatic scheduling. Set the value to a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.'."\n"
+ ."\n"
+ .'Configuring this parameter is equivalent to specifying a start time for the Validity Period parameter in the Schedule section of the Properties tab on the DataStudio page in the [DataWorks console](https://workbench.data.aliyun.com/console).'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'minimum' => '0',
+ 'example' => '1671608450000',
+ 'default' => '0',
+ ],
+ ],
+ [
+ 'name' => 'EndEffectDate',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The end time of automatic scheduling. Set the value to a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.'."\n"
+ ."\n"
+ .'This parameter corresponds to the Validity Period parameter in the Schedule section of the Properties tab in the [DataWorks console](https://workbench.data.aliyun.com/console).'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'minimum' => '0',
+ 'example' => '1671694850000',
+ ],
+ ],
+ [
+ 'name' => 'CronExpress',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The CRON expression that represents the periodic scheduling policy of the node. This parameter corresponds to the Cron Expression parameter in the Schedule section of the Properties tab on the DataStudio page in the [DataWorks console](https://workbench.data.aliyun.com/console). After you configure the Scheduling Cycle and Scheduled time parameters in the DataWorks console, DataWorks generates the value of the Cron Expression parameter.'."\n"
+ ."\n"
+ .'Examples:'."\n"
+ ."\n"
+ .'* CRON expression for a node that is scheduled to run at 05:30 every day: `00 30 05 * * ?`'."\n"
+ .'* CRON expression for a node that is scheduled to run at the fifteenth minute of each hour: `00 15 00-23/1 * * ?`'."\n"
+ .'* CRON expression for a node that is scheduled to run every 10 minutes: `00 00/10 * * * ?`'."\n"
+ .'* CRON expression for a node that is scheduled to run every 10 minutes from 08:00 to 17:00 every day: `00 00-59/10 8-17 * * * ?`'."\n"
+ .'* CRON expression for a node that is scheduled to run at 00:20 on the first day of each month: `00 20 00 1 * ?`'."\n"
+ .'* CRON expression for a node that is scheduled to run every three months from 00:10 on January 1: `00 10 00 1 1-12/3 ?`'."\n"
+ .'* CRON expression for a node that is scheduled to run at 00:05 every Tuesday and Friday: `00 05 00 * * 2,5`'."\n"
+ ."\n"
+ .'The scheduling system of DataWorks imposes the following limits on CRON expressions:'."\n"
+ ."\n"
+ .'* The minimum interval specified in a CRON expression to schedule a node is 5 minutes.'."\n"
+ .'* The earliest time specified in a CRON expression to schedule a node every day is 00:05.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => '00 05 00 * * ?',
+ 'default' => 'day',
+ ],
+ ],
+ [
+ 'name' => 'CycleType',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The type of the scheduling cycle of the node that corresponds to the file. Valid values: NOT_DAY and DAY. The value NOT_DAY indicates that the node is scheduled to run by minute or hour. The value DAY indicates that the node is scheduled to run by day, week, or month.'."\n"
+ ."\n"
+ .'This parameter corresponds to the Scheduling Cycle parameter in the Schedule section of the Properties tab on the DataStudio page in the [DataWorks console](https://workbench.data.aliyun.com/console).'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'enumValueTitles' => [],
+ 'example' => 'DAY',
+ 'default' => 'DAY',
+ 'enum' => [
+ 'DAY',
+ 'NOT_DAY',
+ ],
+ ],
+ ],
+ [
+ 'name' => 'DependentType',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The type of the cross-cycle scheduling dependency of the node. Valid values:'."\n"
+ ."\n"
+ .'* SELF: The instance generated for the node in the current cycle depends on the instance generated for the node in the previous cycle.'."\n"
+ .'* CHILD: The instance generated for the node in the current cycle depends on the instances generated for the descendant nodes at the nearest level of the node in the previous cycle.'."\n"
+ .'* USER_DEFINE: The instance generated for the node in the current cycle depends on the instances generated for one or more specified nodes in the previous cycle.'."\n"
+ .'* NONE: No cross-cycle scheduling dependency type is selected for the node.'."\n"
+ .'* USER_DEFINE_AND_SELF: The instance generated for the node in the current cycle depends on the instance generated for the node in the previous cycle and the instances generated for one or more specified nodes in the previous cycle.'."\n"
+ .'* CHILD_AND_SELF: The instance generated for the node in the current cycle depends on the instances generated for the descendant nodes at the nearest level of the node in the previous cycle and the instance generated for the node in the previous cycle.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'enumValueTitles' => [],
+ 'example' => 'NONE',
+ 'default' => 'NONE',
+ 'enum' => [
+ 'NONE',
+ 'USER_DEFINE',
+ 'CHILD',
+ 'SELF',
+ 'USER_DEFINE_AND_SELF',
+ 'CHILD_AND_SELF',
+ ],
+ ],
+ ],
+ [
+ 'name' => 'DependentNodeIdList',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The IDs of the nodes that generate instances in the previous cycle on which the current node depends.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'abc',
+ ],
+ ],
+ [
+ 'name' => 'InputList',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The output name of the parent file on which the current file depends. If you specify multiple output names, separate them with commas (,).'."\n"
+ ."\n"
+ .'This parameter corresponds to the Output Name parameter under Parent Nodes in the Dependencies section of the Properties tab in the [DataWorks console](https://workbench.data.aliyun.com/console).'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'docRequired' => true,
+ 'example' => 'project_root,project.file1,project.001_out',
+ ],
+ ],
+ [
+ 'name' => 'ProjectIdentifier',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The name of the DataWorks workspace. You can log on to the [DataWorks console](https://workbench.data.aliyun.com/console) and go to the Workspace Management page to obtain the workspace name.'."\n"
+ ."\n"
+ .'You must configure this parameter or the ProjectId parameter to determine the DataWorks workspace to which the operation is applied.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'docRequired' => false,
+ 'example' => 'dw_project',
+ ],
+ ],
+ [
+ 'name' => 'ResourceGroupIdentifier',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The identifier of the resource group that is used to run the node. You can call the [ListResourceGroups](~~173913~~) operation to query the available resource groups in the workspace. The **Identifier** parameter in the response of the operation indicates the identifier of an available resource group.'."\n"
+ ."\n"
+ .'> You must make sure that the available resource groups in the response of the ListResourceGroups operation are associated with the workspace for which you want to create a file by calling the CreateFile operation.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'group_375827434852437',
+ ],
+ ],
+ [
+ 'name' => 'ResourceGroupId',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'This parameter is deprecated. Do not use this parameter.'."\n"
+ ."\n"
+ .'The identifier of the resource group that is used to run the node. This parameter corresponds to the Resource Group parameter in the Resource Group section of the Properties tab in the DataWorks console. You must configure one of the ResourceGroupId and ResourceGroupIdentifier parameters to determine the resource group that is used to run the node.'."\n"
+ ."\n"
+ .'You can call the [ListResourceGroups](~~173913~~) operation to query the available resource groups in the workspace. When you call the operation, set the ResourceGroupType parameter to 1. The response parameter Id indicates the ID of an available resource group.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'example' => '375827434852437',
+ ],
+ ],
+ [
+ 'name' => 'ConnectionName',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The name of the data source for which the node is run.'."\n"
+ ."\n"
+ .'You can call the [UpdateDataSource](~~211432~~) operation to query the available data sources in the workspace.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'odps_first',
+ ],
+ ],
+ [
+ 'name' => 'AutoParsing',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'Specifies whether to enable the automatic parsing feature for the file. Valid values:'."\n"
+ ."\n"
+ .'* true'."\n"
+ .'* false'."\n"
+ ."\n"
+ .'This parameter corresponds to the Analyze Code parameter that is displayed after Same Cycle is selected in the Dependencies section of the Properties tab on the DataStudio page in the [DataWorks console](https://workbench.data.aliyun.com/console).'."\n",
+ 'type' => 'boolean',
+ 'required' => false,
+ 'docRequired' => false,
+ 'example' => 'true',
+ 'default' => 'true',
+ ],
+ ],
+ [
+ 'name' => 'SchedulerType',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The scheduling type of the node. Valid values:'."\n"
+ ."\n"
+ .'* NORMAL: The node is an auto triggered node.'."\n"
+ .'* MANUAL: The node is a manually triggered node. Manually triggered nodes cannot be automatically triggered. They correspond to the nodes in the Manually Triggered Workflows pane.'."\n"
+ .'* PAUSE: The node is a paused node.'."\n"
+ .'* SKIP: The node is a dry-run node. Dry-run nodes are started as scheduled, but the system sets the status of the nodes to successful when it starts to run them'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'docRequired' => false,
+ 'enumValueTitles' => [],
+ 'example' => 'NORMAL',
+ 'enum' => [
+ 'NORMAL',
+ 'MANUAL',
+ 'PAUSE',
+ 'SKIP',
+ ],
+ ],
+ ],
+ [
+ 'name' => 'AdvancedSettings',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The advanced configurations of the node.'."\n"
+ ."\n"
+ .'This parameter is valid only for an EMR Spark Streaming node or an EMR Streaming SQL node. This parameter corresponds to the Advanced Settings tab of the node in the [DataWorks console](https://workbench.data.aliyun.com/console).'."\n"
+ ."\n"
+ .'The value of this parameter must be in the JSON format.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => '{"queue":"default","SPARK_CONF":"--conf spark.driver.memory=2g"}',
+ ],
+ ],
+ [
+ 'name' => 'StartImmediately',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'Specifies whether to immediately run a node after the node is deployed.'."\n"
+ ."\n"
+ .'This parameter is valid only for an EMR Spark Streaming node or an EMR Streaming SQL node. This parameter corresponds to the Start Method parameter in the Schedule section of the Configure tab in the [DataWorks console](https://workbench.data.aliyun.com/console).'."\n",
+ 'type' => 'boolean',
+ 'required' => false,
+ 'docRequired' => false,
+ 'example' => 'true',
+ 'default' => 'false',
+ ],
+ ],
+ [
+ 'name' => 'InputParameters',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The input parameters of the node. The value of this parameter must be in the JSON format. For more information about the input parameters, see the InputContextParameterList parameter in the Response parameters section of the [GetFile](~~173954~~) operation.'."\n"
+ ."\n"
+ .'This parameter corresponds to the Input Parameters table in the Input and Output Parameters section of the Properties tab in the [DataWorks console](https://workbench.data.aliyun.com/console).'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => '[{"ValueSource": "project_001.first_node:bizdate_param","ParameterName": "bizdate_input"}]',
+ ],
+ ],
+ [
+ 'name' => 'OutputParameters',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The output parameters of the node. The value of this parameter must be in the JSON format. For more information about the output parameters, see the OutputContextParameterList parameter in the Response parameters section of the [GetFile](~~173954~~) operation.'."\n"
+ ."\n"
+ .'This parameter corresponds to the Output Parameters table in the Input and Output Parameters section of the Properties tab in the [DataWorks console](https://workbench.data.aliyun.com/console).'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => '[{"Type": 1,"Value": "${bizdate}","ParameterName": "bizdate_param"}]',
+ ],
+ ],
+ [
+ 'name' => 'IgnoreParentSkipRunningProperty',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'Whether to use the last cycle empty run attribute. The values are as follows:'."\n"
+ .'- true: The empty run attribute of the previous cycle is used.'."\n"
+ .'- false: The empty run attribute of the previous cycle is not used.',
+ 'type' => 'boolean',
+ 'required' => false,
+ 'example' => 'false',
+ ],
+ ],
+ [
+ 'name' => 'CreateFolderIfNotExists',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'Specifies whether to automatically create the directory that is specified by the FileFolderPath parameter if the directory does not exist. Valid values:'."\n"
+ ."\n"
+ .'* true: The system automatically creates the directory if the directory does not exist.'."\n"
+ .'* false: The system does not automatically create the directory if the directory does not exist. In this case, the call fails.'."\n",
+ 'type' => 'boolean',
+ 'required' => false,
+ 'example' => 'false',
+ ],
+ ],
+ [
+ 'name' => 'ApplyScheduleImmediately',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'Specifies whether scheduling configurations immediately take effect after the node is deployed.'."\n",
+ 'type' => 'boolean',
+ 'required' => false,
+ 'example' => 'true',
+ ],
+ ],
+ [
+ 'name' => 'Timeout',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The timeout period.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => false,
+ 'example' => '1',
+ ],
+ ],
+ [
+ 'name' => 'ImageId',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The ID of the custom image.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'm-bp1h4b5a8ogkbll2f3tr',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'description' => '',
+ 'type' => 'object',
+ 'properties' => [
+ 'HttpStatusCode' => [
+ 'description' => 'The HTTP status code returned.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '200',
+ ],
+ 'Data' => [
+ 'description' => 'The ID of the file that was created.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '1000001',
+ ],
+ 'RequestId' => [
+ 'description' => 'The ID of the request. You can use the ID to troubleshoot issues.'."\n",
+ 'type' => 'string',
+ 'example' => '0000-ABCD-EFG',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message returned.'."\n",
+ 'type' => 'string',
+ 'example' => 'The connection does not exist.',
+ ],
+ 'Success' => [
+ 'description' => 'Indicates whether the request was successful. Valid values:'."\n"
+ ."\n"
+ .'* true: The request was successful.'."\n"
+ .'* false: The request failed.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code returned.'."\n",
+ 'type' => 'string',
+ 'example' => 'Invalid.Tenant.ConnectionNotExists',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'errorCodes' => [
+ 403 => [
+ [
+ 'errorCode' => 'Forbidden.Access',
+ 'errorMessage' => 'Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.',
+ ],
+ ],
+ 429 => [
+ [
+ 'errorCode' => 'Throttling.Api',
+ 'errorMessage' => 'The request for this resource has exceeded your available limit.',
+ ],
+ [
+ 'errorCode' => 'Throttling.System',
+ 'errorMessage' => 'The DataWorks system is busy. Try again later.',
+ ],
+ [
+ 'errorCode' => 'Throttling.User',
+ 'errorMessage' => 'Your request is too frequent. Try again later.',
+ ],
+ ],
+ 500 => [
+ [
+ 'errorCode' => 'InternalError.System',
+ 'errorMessage' => 'An internal system error occurred. Try again later.',
+ ],
+ [
+ 'errorCode' => 'InternalError.UserId.Missing',
+ 'errorMessage' => 'An internal system error occurred. Try again later.',
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Data\\": 1000001,\\n \\"RequestId\\": \\"0000-ABCD-EFG\\",\\n \\"ErrorMessage\\": \\"The connection does not exist.\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"Invalid.Tenant.ConnectionNotExists\\"\\n}","errorExample":""},{"type":"xml","example":"<CreateFileResponse>\\n <HttpStatusCode>200</HttpStatusCode>\\n <Data>1000001</Data>\\n <RequestId>0000-ABCD-EFG</RequestId>\\n <ErrorMessage>The connection does not exist.</ErrorMessage>\\n <Success>true</Success>\\n <ErrorCode>Invalid.Tenant.ConnectionNotExists</ErrorCode>\\n</CreateFileResponse>","errorExample":""}]',
+ 'title' => 'CreateFile',
+ 'summary' => 'Creates a file in DataStudio. You cannot call this operation to create files for Data Integration nodes.',
+ 'requestParamsDescription' => ' ',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ ],
+ 'CreateUdfFile' => [
+ 'methods' => [
+ 'post',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'readAndWrite',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'create',
+ 'abilityTreeCode' => '78200',
+ 'abilityTreeNodes' => [
+ 'FEATUREdide8FM783',
+ ],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'FileFolderPath',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The path of the folder in which the file for the function is stored.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'docRequired' => true,
+ 'example' => 'Business_process/First_Business_Process/function/string_processing',
+ ],
+ ],
+ [
+ 'name' => 'ProjectId',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The ID of the DataWorks workspace. You can click the Workspace Manage icon in the upper-right corner of the DataStudio page to go to the Workspace Management page and view the workspace ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'docRequired' => false,
+ 'example' => '10000',
+ ],
+ ],
+ [
+ 'name' => 'FileName',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The name of the file for the function.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'StringConcat',
+ ],
+ ],
+ [
+ 'name' => 'FunctionType',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The type of the function. Valid values: MATH, AGGREGATE, STRING, DATE, ANALYTIC, and OTHER. This parameter corresponds to the Function Type parameter in the Register Function section of the configuration tab of the function on the DataStudio page.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'enumValueTitles' => [],
+ 'example' => 'STRING',
+ 'enum' => [
+ 'MATH',
+ 'AGGREGATE',
+ 'STRING',
+ 'DATE',
+ 'ANALYTIC',
+ 'OTHER',
+ ],
+ ],
+ ],
+ [
+ 'name' => 'ClassName',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The name of the class in which the function is defined. This parameter corresponds to the Class Name parameter in the Register Function section of the configuration tab of the function in the DataWorks console.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'com.alibaba.DataWorks.api.udf.StringConcat',
+ ],
+ ],
+ [
+ 'name' => 'Resources',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The names of the resources that are referenced by the function. This parameter corresponds to the Resources parameter in the Register Function section of the configuration tab of the function in the DataWorks console. Multiple resource names are separated by commas (,).'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'string-concat-1.0.0.jar,commons-lang-2.6.jar',
+ ],
+ ],
+ [
+ 'name' => 'UdfDescription',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The description of the function. This parameter corresponds to the Description parameter in the Register Function section of the configuration tab of the function on the DataStudio page.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'docRequired' => true,
+ 'example' => 'Concatenate several strings to generate a new string',
+ ],
+ ],
+ [
+ 'name' => 'CmdDescription',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The syntax used for calling the function. This parameter corresponds to the Expression Syntax parameter in the Register Function section of the configuration tab of the function in the DataWorks console.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'StringConcat(String... substrs)',
+ ],
+ ],
+ [
+ 'name' => 'ParameterDescription',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The description of the input parameters of the function. This parameter corresponds to the Parameter Description parameter in the Register Function section of the configuration tab of the function on the DataStudio page.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'List of strings to be connected',
+ 'default' => '',
+ ],
+ ],
+ [
+ 'name' => 'ReturnValue',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The description of the return value of the function. This parameter corresponds to the Return Value parameter in the Register Function section of the configuration tab of the function on the DataStudio page.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'New strings generated by concatenating all strings before and after the input order',
+ 'default' => 'false',
+ ],
+ ],
+ [
+ 'name' => 'Example',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The example for calling the function. This parameter corresponds to the Example parameter in the Register Function section of the configuration tab of the function in the DataWorks console.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'StringConcat(\'a\', \'b\', \'c\')',
+ ],
+ ],
+ [
+ 'name' => 'ProjectIdentifier',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The unique identifier of the DataWorks workspace. You can click the identifier in the upper-left corner of the DataStudio page to switch to another workspace.'."\n"
+ ."\n"
+ .'You must specify either this parameter or the projectId parameter to determine the DataWorks workspace to which the operation is called.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'dw_project',
+ ],
+ ],
+ [
+ 'name' => 'CreateFolderIfNotExists',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'Specifies whether to automatically create the directory that is specified by the FileFolderPath parameter if the directory does not exist. Valid values:'."\n"
+ ."\n"
+ .'* true: The system automatically creates the directory if the directory does not exist.'."\n"
+ .'* false: The system does not automatically create the directory if the directory does not exist. In this case, the call fails.'."\n",
+ 'type' => 'boolean',
+ 'required' => false,
+ 'example' => 'false',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'HttpStatusCode' => [
+ 'description' => 'The HTTP status code returned.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '200',
+ ],
+ 'Data' => [
+ 'description' => 'The ID of the file that was created.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '100000002',
+ ],
+ 'RequestId' => [
+ 'description' => 'The ID of the request. You can troubleshoot issues based on the ID.'."\n",
+ 'type' => 'string',
+ 'example' => '0000-ABCD-EFG****',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message returned.'."\n",
+ 'type' => 'string',
+ 'example' => 'The connection does not exist.',
+ ],
+ 'Success' => [
+ 'description' => 'Indicates whether the request is successful.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code returned.'."\n",
+ 'type' => 'string',
+ 'example' => 'Invalid.Tenant.ConnectionNotExists',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'errorCodes' => [
+ 403 => [
+ [
+ 'errorCode' => 'Forbidden.Access',
+ 'errorMessage' => 'Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.',
+ ],
+ ],
+ 429 => [
+ [
+ 'errorCode' => 'Throttling.Api',
+ 'errorMessage' => 'The request for this resource has exceeded your available limit.',
+ ],
+ [
+ 'errorCode' => 'Throttling.System',
+ 'errorMessage' => 'The DataWorks system is busy. Try again later.',
+ ],
+ [
+ 'errorCode' => 'Throttling.User',
+ 'errorMessage' => 'Your request is too frequent. Try again later.',
+ ],
+ ],
+ 500 => [
+ [
+ 'errorCode' => 'InternalError.System',
+ 'errorMessage' => 'An internal system error occurred. Try again later.',
+ ],
+ [
+ 'errorCode' => 'InternalError.UserId.Missing',
+ 'errorMessage' => 'An internal system error occurred. Try again later.',
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Data\\": 100000002,\\n \\"RequestId\\": \\"0000-ABCD-EFG****\\",\\n \\"ErrorMessage\\": \\"The connection does not exist.\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"Invalid.Tenant.ConnectionNotExists\\"\\n}","errorExample":""},{"type":"xml","example":"<CreateUdfFileResponse>\\n <RequestId>0000-ABCD-EFG****</RequestId>\\n <HttpStatusCode>200</HttpStatusCode>\\n <Data>100000002</Data>\\n <Success>true</Success>\\n</CreateUdfFileResponse>","errorExample":""}]',
+ 'title' => 'CreateUdfFile',
+ 'summary' => 'Creates a file for a function in DataStudio.',
+ 'requestParamsDescription' => ' ',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ ],
+ 'CreateBusiness' => [
+ 'methods' => [
+ 'post',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'write',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'create',
+ 'abilityTreeCode' => '78175',
+ 'abilityTreeNodes' => [
+ 'FEATUREdide8FM783',
+ ],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'ProjectId',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The ID of the DataWorks workspace. You can log on to the [DataWorks console](https://workbench.data.aliyun.com/console) and go to the Workspace page to obtain the workspace ID.',
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'docRequired' => false,
+ 'example' => '10000',
+ ],
+ ],
+ [
+ 'name' => 'ProjectIdentifier',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The name of the DataWorks workspace. You can log on to the [DataWorks console](https://workbench.data.aliyun.com/console) and go to the Workspace Management page to obtain the workspace name. You must configure either this parameter or ProjectId parameter to determine the DataWorks workspace to which the operation is applied.',
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'dw_project',
+ ],
+ ],
+ [
+ 'name' => 'BusinessName',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The name of the business process. The name of the business process in the same project must be unique.',
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'My business process',
+ ],
+ ],
+ [
+ 'name' => 'Description',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The description of the business process.',
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'This is a business process created through an interface.',
+ ],
+ ],
+ [
+ 'name' => 'Owner',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The Alibaba Cloud account ID of the owner of the business process. You can log on to the [DataWorks console](https://workbench.data.aliyun.com/console) and hover over the user avatar on the right side of the top menu bar to view the account ID. If this parameter is empty, the caller\'s Alibaba Cloud account ID is used by default.',
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => '1000000000001',
+ ],
+ ],
+ [
+ 'name' => 'UseType',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The module to which the workflow belongs. Valid values:'."\n"
+ ."\n"
+ .'* NORMAL: The workflow belongs to auto triggered workflows.'."\n"
+ .'* MANUAL_BIZ: The workflow belongs to manually triggered workflows.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'docRequired' => false,
+ 'enumValueTitles' => [],
+ 'example' => 'NORMAL',
+ 'default' => 'NORMAL',
+ 'enum' => [
+ 'NORMAL',
+ 'MANUAL_BIZ',
+ ],
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'HttpStatusCode' => [
+ 'description' => 'The HTTP status code.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '200',
+ ],
+ 'RequestId' => [
+ 'description' => 'The request ID.'."\n",
+ 'type' => 'string',
+ 'example' => '0000-ABCD-EFG****',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message.'."\n",
+ 'type' => 'string',
+ 'example' => 'The connection does not exist.',
+ ],
+ 'Success' => [
+ 'description' => 'Indicates whether the request was successful.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code.'."\n",
+ 'type' => 'string',
+ 'example' => 'Invalid.Tenant.ConnectionNotExists',
+ ],
+ 'BusinessId' => [
+ 'description' => 'The workflow ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '100001',
+ ],
+ ],
+ 'description' => '',
+ ],
+ ],
+ ],
+ 'errorCodes' => [
+ 403 => [
+ [
+ 'errorCode' => 'Forbidden.Access',
+ 'errorMessage' => 'Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.',
+ ],
+ ],
+ 429 => [
+ [
+ 'errorCode' => 'Throttling.Api',
+ 'errorMessage' => 'The request for this resource has exceeded your available limit.',
+ ],
+ [
+ 'errorCode' => 'Throttling.System',
+ 'errorMessage' => 'The DataWorks system is busy. Try again later.',
+ ],
+ [
+ 'errorCode' => 'Throttling.User',
+ 'errorMessage' => 'Your request is too frequent. Try again later.',
+ ],
+ ],
+ 500 => [
+ [
+ 'errorCode' => 'InternalError.System',
+ 'errorMessage' => 'An internal system error occurred. Try again later.',
+ ],
+ [
+ 'errorCode' => 'InternalError.UserId.Missing',
+ 'errorMessage' => 'An internal system error occurred. Try again later.',
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"0000-ABCD-EFG****\\",\\n \\"ErrorMessage\\": \\"The connection does not exist.\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"Invalid.Tenant.ConnectionNotExists\\",\\n \\"BusinessId\\": 100001\\n}","errorExample":""},{"type":"xml","example":"<RequestId>0000-ABCD-EFG****</RequestId>\\n<HttpStatusCode>200</HttpStatusCode>\\n<ErrorCode>Invalid.Tenant.ConnectionNotExists</ErrorCode>\\n<ErrorMessage>The connection does not exist.</ErrorMessage>\\n<BusinessId>100001</BusinessId>\\n<Success>true</Success>","errorExample":""}]',
+ 'title' => 'CreateBusiness',
+ 'summary' => 'Creates a workflow in DataStudio.',
+ 'requestParamsDescription' => ' ',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ ],
+ 'DeleteBusiness' => [
+ 'methods' => [
+ 'post',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'write',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'delete',
+ 'abilityTreeCode' => '78202',
+ 'abilityTreeNodes' => [
+ 'FEATUREdide8FM783',
+ ],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'ProjectId',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The ID of the DataWorks workspace. You can log on to the DataWorks console and go to the Workspace Management page to obtain the ID. You must specify either this parameter or ProjectIdentifier to determine the DataWorks workspace to which the operation is applied.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'docRequired' => false,
+ 'example' => '10000',
+ ],
+ ],
+ [
+ 'name' => 'ProjectIdentifier',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The name of the DataWorks workspace. You can log on to the DataWorks console and go to the Workspace Settings panel to obtain the name. You must specify either this parameter or ProjectId to determine the DataWorks workspace to which the operation is applied.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'dw_project',
+ ],
+ ],
+ [
+ 'name' => 'BusinessId',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The ID of the workflow. You can call the [ListBusiness](~~173945~~) operation to query the workflow ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => '1000001',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'HttpStatusCode' => [
+ 'description' => 'The HTTP status code returned.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '200',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message returned.'."\n",
+ 'type' => 'string',
+ 'example' => 'The connection does not exist.',
+ ],
+ 'RequestId' => [
+ 'description' => 'The ID of the request. You can use the ID to troubleshoot issues.'."\n",
+ 'type' => 'string',
+ 'example' => '0000-ABCD-EFG****',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code returned.'."\n",
+ 'type' => 'string',
+ 'example' => 'Invalid.Tenant.ConnectionNotExists',
+ ],
+ 'Success' => [
+ 'description' => 'Indicates whether the request is successful.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'errorCodes' => [
+ 403 => [
+ [
+ 'errorCode' => 'Forbidden.Access',
+ 'errorMessage' => 'Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.',
+ ],
+ ],
+ 429 => [
+ [
+ 'errorCode' => 'Throttling.Api',
+ 'errorMessage' => 'The request for this resource has exceeded your available limit.',
+ ],
+ [
+ 'errorCode' => 'Throttling.System',
+ 'errorMessage' => 'The DataWorks system is busy. Try again later.',
+ ],
+ [
+ 'errorCode' => 'Throttling.User',
+ 'errorMessage' => 'Your request is too frequent. Try again later.',
+ ],
+ ],
+ 500 => [
+ [
+ 'errorCode' => 'InternalError.System',
+ 'errorMessage' => 'An internal system error occurred. Try again later.',
+ ],
+ [
+ 'errorCode' => 'InternalError.UserId.Missing',
+ 'errorMessage' => 'An internal system error occurred. Try again later.',
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"ErrorMessage\\": \\"The connection does not exist.\\",\\n \\"RequestId\\": \\"0000-ABCD-EFG****\\",\\n \\"ErrorCode\\": \\"Invalid.Tenant.ConnectionNotExists\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<RequestId>0000-ABCD-EFG****</RequestId>\\n<HttpStatusCode>200</HttpStatusCode>\\n<ErrorCode>Invalid.Tenant.ConnectionNotExists</ErrorCode>\\n<ErrorMessage>The connection does not exist.</ErrorMessage>\\n<Success>true</Success>","errorExample":""}]',
+ 'title' => 'DeleteBusiness',
+ 'summary' => 'Deletes a workflow.',
+ 'requestParamsDescription' => ' ',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ ],
+ 'CreateFolder' => [
+ 'methods' => [
+ 'post',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'readAndWrite',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'create',
+ 'abilityTreeCode' => '78186',
+ 'abilityTreeNodes' => [
+ 'FEATUREdide8FM783',
+ ],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'ProjectId',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => '$.parameters[4].schema.enumValueTitles',
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'docRequired' => false,
+ 'example' => '10000',
+ ],
+ ],
+ [
+ 'name' => 'ProjectIdentifier',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The DataWorks workspace ID. You can log on to the DataWorks console and go to the Workspace page to query the ID. You must configure either this parameter or the **ProjectIdentifier** parameter to determine the DataWorks workspace to which the operation is applied.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'dw_project',
+ ],
+ ],
+ [
+ 'name' => 'FolderPath',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The name of the DataWorks workspace. You can log on to the DataWorks console and go to the Workspace page to obtain the workspace name. You must configure either this parameter or the **ProjectId** parameter to determine the DataWorks workspace to which the operation is applied.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'Business_process/System_Data/MaxCompute/import_layer',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'HttpStatusCode' => [
+ 'description' => 'The path of the folder.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '200',
+ ],
+ 'Data' => [
+ 'description' => 'The unique identifier of the folder.'."\n",
+ 'type' => 'string',
+ 'example' => 'bdfd68****',
+ ],
+ 'RequestId' => [
+ 'description' => 'The ID of the request. You can use the ID to troubleshoot issues.'."\n",
+ 'type' => 'string',
+ 'example' => '0000-ABCD-EFG',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message returned.'."\n",
+ 'type' => 'string',
+ 'example' => 'The connection does not exist.',
+ ],
+ 'Success' => [
+ 'description' => 'Indicates whether the request was successful.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code returned.'."\n",
+ 'type' => 'string',
+ 'example' => 'Invalid.Tenant.ConnectionNotExists',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'errorCodes' => [
+ 403 => [
+ [
+ 'errorCode' => 'Forbidden.Access',
+ 'errorMessage' => 'Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.',
+ ],
+ ],
+ 429 => [
+ [
+ 'errorCode' => 'Throttling.Api',
+ 'errorMessage' => 'The request for this resource has exceeded your available limit.',
+ ],
+ [
+ 'errorCode' => 'Throttling.System',
+ 'errorMessage' => 'The DataWorks system is busy. Try again later.',
+ ],
+ [
+ 'errorCode' => 'Throttling.User',
+ 'errorMessage' => 'Your request is too frequent. Try again later.',
+ ],
+ ],
+ 500 => [
+ [
+ 'errorCode' => 'InternalError.System',
+ 'errorMessage' => 'An internal system error occurred. Try again later.',
+ ],
+ [
+ 'errorCode' => 'InternalError.UserId.Missing',
+ 'errorMessage' => 'An internal system error occurred. Try again later.',
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Data\\": \\"bdfd68****\\",\\n \\"RequestId\\": \\"0000-ABCD-EFG\\",\\n \\"ErrorMessage\\": \\"The connection does not exist.\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"Invalid.Tenant.ConnectionNotExists\\"\\n}","errorExample":""},{"type":"xml","example":"<CreateFolderResponse>\\n <HttpStatusCode>200</HttpStatusCode>\\n <Data>bdfd68****</Data>\\n <RequestId>0000-ABCD-EFG</RequestId>\\n <ErrorMessage>The connection does not exist.</ErrorMessage>\\n <Success>true</Success>\\n <ErrorCode>Invalid.Tenant.ConnectionNotExists</ErrorCode>\\n</CreateFolderResponse>","errorExample":""}]',
+ 'title' => 'CreateFolder',
+ 'summary' => 'The operation that you want to perform. Set the value to \\\\*\\\\*CreateFolder\\\\*\\\\*.',
+ 'requestParamsDescription' => ' ',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ ],
+ 'UpdateBusiness' => [
+ 'methods' => [
+ 'post',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'readAndWrite',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'update',
+ 'abilityTreeCode' => '78366',
+ 'abilityTreeNodes' => [
+ 'FEATUREdide8FM783',
+ ],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'ProjectId',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The ID of the DataWorks workspace. You can log on to the DataWorks console and go to the Workspace Management page to obtain the workspace ID. You must configure either this parameter or the ProjectIdentifier parameter to determine the DataWorks workspace to which the operation is applied.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'docRequired' => false,
+ 'example' => '10000',
+ ],
+ ],
+ [
+ 'name' => 'ProjectIdentifier',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The name of the DataWorks workspace. You can log on to the DataWorks console and go to the Workspace Management page to obtain the workspace name. You must configure either this parameter or ProjectId parameter to determine the DataWorks workspace to which the operation is applied.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'dw_project',
+ ],
+ ],
+ [
+ 'name' => 'BusinessName',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The name of the workflow. You can call the [ListBusiness](~~173945~~) operation to obtain the workflow name.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'docRequired' => false,
+ 'example' => 'MyBusiness',
+ ],
+ ],
+ [
+ 'name' => 'Description',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The description of the workflow.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'modified from my first business',
+ ],
+ ],
+ [
+ 'name' => 'Owner',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The owner of the workflow. You can call the [ListBusiness](~~173945~~) operation to obtain the workflow owner.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => '348428****',
+ ],
+ ],
+ [
+ 'name' => 'BusinessId',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The ID of the workflow. You can call the [ListBusiness](~~173945~~) operation to obtain the workflow ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => '300000',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'HttpStatusCode' => [
+ 'description' => 'The HTTP status code returned.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '200',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message returned.'."\n",
+ 'type' => 'string',
+ 'example' => 'The connection does not exist.',
+ ],
+ 'RequestId' => [
+ 'description' => 'The ID of the request. You can use the ID to troubleshoot issues.'."\n",
+ 'type' => 'string',
+ 'example' => '0000-ABCD-EFG****',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code returned.'."\n",
+ 'type' => 'string',
+ 'example' => 'Invalid.Tenant.ConnectionNotExists',
+ ],
+ 'Success' => [
+ 'description' => 'Indicates whether the request was successful.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'errorCodes' => [
+ 403 => [
+ [
+ 'errorCode' => 'Forbidden.Access',
+ 'errorMessage' => 'Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.',
+ ],
+ ],
+ 429 => [
+ [
+ 'errorCode' => 'Throttling.Api',
+ 'errorMessage' => 'The request for this resource has exceeded your available limit.',
+ ],
+ [
+ 'errorCode' => 'Throttling.System',
+ 'errorMessage' => 'The DataWorks system is busy. Try again later.',
+ ],
+ [
+ 'errorCode' => 'Throttling.User',
+ 'errorMessage' => 'Your request is too frequent. Try again later.',
+ ],
+ ],
+ 500 => [
+ [
+ 'errorCode' => 'InternalError.System',
+ 'errorMessage' => 'An internal system error occurred. Try again later.',
+ ],
+ [
+ 'errorCode' => 'InternalError.UserId.Missing',
+ 'errorMessage' => 'An internal system error occurred. Try again later.',
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"ErrorMessage\\": \\"The connection does not exist.\\",\\n \\"RequestId\\": \\"0000-ABCD-EFG****\\",\\n \\"ErrorCode\\": \\"Invalid.Tenant.ConnectionNotExists\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<RequestId>0000-ABCD-EFG****</RequestId>\\n<HttpStatusCode>200</HttpStatusCode>\\n<ErrorCode>Invalid.Tenant.ConnectionNotExists</ErrorCode>\\n<ErrorMessage>The connection does not exist.</ErrorMessage>\\n<Success>true</Success>","errorExample":""}]',
+ 'title' => 'UpdateBusiness',
+ 'summary' => 'Updates a workflow.',
+ 'requestParamsDescription' => ' ',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ ],
+ 'ListFiles' => [
+ 'methods' => [
+ 'post',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'get',
+ 'abilityTreeCode' => '78310',
+ 'abilityTreeNodes' => [
+ 'FEATUREdide8FM783',
+ ],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'FileFolderPath',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The path of the folder to which files belong.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'docRequired' => false,
+ 'example' => 'Business_process/my_first_business_process/MaxCompute/ods_layer',
+ ],
+ ],
+ [
+ 'name' => 'ProjectId',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The ID of the DataWorks workspace. You can log on to the [DataWorks console](https://workbench.data.aliyun.com/console) and go to the Workspace Management page to obtain the workspace ID.'."\n"
+ ."\n"
+ .'You must configure either the ProjectId or ProjectIdentifier parameter to determine the DataWorks workspace to which the operation is applied.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'docRequired' => false,
+ 'example' => '10000',
+ ],
+ ],
+ [
+ 'name' => 'Keyword',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The keyword in the file names. The keyword is used to perform a fuzzy match. You can specify a keyword to query all files whose names contain the keyword.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'docRequired' => false,
+ 'example' => 'ods',
+ ],
+ ],
+ [
+ 'name' => 'ProjectIdentifier',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The name of the DataWorks workspace. You can log on to the [DataWorks console](https://workbench.data.aliyun.com/console) and go to the Workspace Management page to obtain the workspace name.'."\n"
+ ."\n"
+ .'You must configure either the ProjectId or ProjectIdentifier parameter to determine the DataWorks workspace to which the operation is applied.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'dw_project',
+ ],
+ ],
+ [
+ 'name' => 'PageNumber',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The page number.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => false,
+ 'minimum' => '1',
+ 'example' => '1',
+ 'default' => '1',
+ ],
+ ],
+ [
+ 'name' => 'PageSize',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The number of entries per page. Default value: 10. Maximum value: 100.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => false,
+ 'docRequired' => false,
+ 'maximum' => '100',
+ 'minimum' => '0',
+ 'example' => '10',
+ 'default' => '10',
+ ],
+ ],
+ [
+ 'name' => 'UseType',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The module to which the files belong. Valid values:'."\n"
+ ."\n"
+ .'* NORMAL: The files are used for DataStudio.'."\n"
+ .'* MANUAL: The files are used for manually triggered nodes.'."\n"
+ .'* MANUAL_BIZ: The files are used for manually triggered workflows.'."\n"
+ .'* SKIP: The files are used for dry-run nodes in DataStudio.'."\n"
+ .'* ADHOCQUERY: The files are used for ad hoc queries.'."\n"
+ .'* COMPONENT: The files are used for snippets.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'NORMAL',
+ ],
+ ],
+ [
+ 'name' => 'FileTypes',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The types of the code in the files.'."\n"
+ ."\n"
+ .'Valid values: 6 (Shell), 10 (ODPS SQL), 11 (ODPS MR), 23 (Data Integration), 24 (ODPS Script), 97 (PAI), 98 (node group), 99 (zero load), 221 (PyODPS 2), 225 (ODPS Spark), 227 (EMR Hive), 228 (EMR Spark), 229 (EMR Spark SQL), 230 (EMR MR), 239 (OSS object inspection), 257 (EMR Shell), 258 (EMR Spark Shell), 259 (EMR Presto), 260 (EMR Impala), 900 (real-time synchronization), 1002 (PAI inner node), 1089 (cross-tenant collaboration), 1091 (Hologres development), 1093 (Hologres SQL), 1100 (assignment), 1106 (for-each), and 1221 (PyODPS 3).'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => '10,23',
+ ],
+ ],
+ [
+ 'name' => 'Owner',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The owner of the files.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => '3726346****',
+ ],
+ ],
+ [
+ 'name' => 'NodeId',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The ID of the node that is scheduled. You can call the [ListNodes](~~173979~~) operation to query the ID of the node.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'example' => '123541234',
+ ],
+ ],
+ [
+ 'name' => 'NeedContent',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'Whether the query results contain file content (for files with more content, there may be a long network transmission delay).',
+ 'type' => 'boolean',
+ 'required' => false,
+ 'example' => 'false',
+ ],
+ ],
+ [
+ 'name' => 'NeedAbsoluteFolderPath',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'Whether the query result contains the path of the folder where the file is located.',
+ 'type' => 'boolean',
+ 'required' => false,
+ 'example' => 'false',
+ ],
+ ],
+ [
+ 'name' => 'ExactFileName',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The exact matching file name. The file name of the query result is exactly the same as this parameter.',
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'ods_create.sql',
+ ],
+ ],
+ [
+ 'name' => 'FileIdIn',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The file ID list. The File ID set of the query result can only be a subset of the list. You can specify up to 50 fileids at a time.',
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => '78237,816123',
+ ],
+ ],
+ [
+ 'name' => 'LastEditUser',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The ID of the Alibaba Cloud account that is used to last modify the file.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => '38748246285727',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'description' => 'The returned data.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'HttpStatusCode' => [
+ 'description' => 'The HTTP status code returned.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '200',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message returned.'."\n",
+ 'type' => 'string',
+ 'example' => 'The connection does not exist.',
+ ],
+ 'RequestId' => [
+ 'description' => 'The request ID. You can troubleshoot issues based on the ID.'."\n",
+ 'type' => 'string',
+ 'example' => '0000-ABCD-EFG',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code returned.'."\n",
+ 'type' => 'string',
+ 'example' => 'Invalid.Tenant.ConnectionNotExists',
+ ],
+ 'Success' => [
+ 'description' => 'Indicates whether the request is successful. Valid values:'."\n"
+ ."\n"
+ .'* true: The request is successful.'."\n"
+ .'* false: The request fails.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'Data' => [
+ 'description' => 'The files returned.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'PageNumber' => [
+ 'description' => 'The page number of the returned page.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '1',
+ ],
+ 'PageSize' => [
+ 'description' => 'The number of entries returned per page.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '10',
+ ],
+ 'TotalCount' => [
+ 'description' => 'The total number of entries returned.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '13',
+ ],
+ 'Files' => [
+ 'description' => 'The details of the files.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The information about the file.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'CommitStatus' => [
+ 'description' => 'Indicates whether the latest code in the file is committed. Valid values: 0 and 1. The value 0 indicates that the latest code in the file is not committed. The value 1 indicates that the latest code in the file is committed.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '1',
+ ],
+ 'AutoParsing' => [
+ 'description' => 'Specifies whether the automatic parsing feature is enabled for the file. Valid values:'."\n"
+ ."\n"
+ .'* true: The automatic parsing feature is enabled for the file.'."\n"
+ .'* false: The automatic parsing feature is not enabled for the file.'."\n"
+ ."\n"
+ .'This parameter is equivalent to the Analyze Code parameter in the Dependencies section of the Properties panel in the [DataWorks console](https://workbench.data.aliyun.com/console).'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'Owner' => [
+ 'description' => 'The ID of the Alibaba Cloud account used by the file owner.'."\n",
+ 'type' => 'string',
+ 'example' => '3872572****',
+ ],
+ 'CreateTime' => [
+ 'description' => 'The time when the file was created. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '1593950832000',
+ ],
+ 'FileType' => [
+ 'description' => 'The type of the code in the file. Valid values: 6 (Shell), 10 (ODPS SQL), 11 (ODPS MR), 23 (Data Integration), 24 (ODPS Script), 99 (zero load), 221 (PyODPS 2), 225 (ODPS Spark), 227 (EMR Hive), 228 (EMR Spark), 229 (EMR Spark SQL), 230 (EMR MR), 239 (OSS object inspection), 257 (EMR Shell), 258 (EMR Spark Shell), 259 (EMR Presto), 260 (EMR Impala), 900 (real-time synchronization), 1089 (cross-tenant collaboration), 1091 (Hologres development), 1093 (Hologres SQL), 1100 (assignment), and 1221 (PyODPS 3).'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '10',
+ ],
+ 'CurrentVersion' => [
+ 'description' => 'The latest version number of the file.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '2',
+ ],
+ 'BizId' => [
+ 'description' => 'The ID of the workflow to which the file belongs. This parameter is deprecated and replaced by the BusinessId parameter.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '300000',
+ ],
+ 'LastEditUser' => [
+ 'description' => 'The ID of the Alibaba Cloud account that is used to last modify the file.'."\n",
+ 'type' => 'string',
+ 'example' => '38748246285727',
+ ],
+ 'FileName' => [
+ 'description' => 'The name of the file.'."\n",
+ 'type' => 'string',
+ 'example' => 'ods_user_info_d',
+ ],
+ 'ConnectionName' => [
+ 'description' => 'The ID of the compute engine instance that is used to run the node that corresponds to the file.'."\n",
+ 'type' => 'string',
+ 'example' => 'odps_first',
+ ],
+ 'UseType' => [
+ 'description' => 'The module to which the file belongs. Valid values:'."\n"
+ ."\n"
+ .'* NORMAL: The file is used for DataStudio.'."\n"
+ .'* MANUAL: The file is used for a manually triggered node.'."\n"
+ .'* MANUAL_BIZ: The file is used for a manually triggered workflow.'."\n"
+ .'* SKIP: The files is used for a dry-run node in DataStudio.'."\n"
+ .'* ADHOCQUERY: The file is used for an ad hoc query.'."\n"
+ .'* COMPONENT: The file is used for a snippet.'."\n",
+ 'type' => 'string',
+ 'example' => 'NORMAL',
+ ],
+ 'FileFolderId' => [
+ 'description' => 'The ID of the folder to which the file belongs.'."\n",
+ 'type' => 'string',
+ 'example' => '2735c2****',
+ ],
+ 'FileId' => [
+ 'description' => 'The ID of the file.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '10000001',
+ ],
+ 'ParentId' => [
+ 'description' => 'The ID of the node group file to which the current file belongs. This parameter is returned only if the current file is an inner file of the node group file.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '-1',
+ ],
+ 'CreateUser' => [
+ 'description' => 'The ID of the Alibaba Cloud account that is used to create the file.'."\n",
+ 'type' => 'string',
+ 'example' => '382762****',
+ ],
+ 'IsMaxCompute' => [
+ 'description' => 'Indicates whether the file needs to be uploaded to MaxCompute if the file is a MaxCompute resource file.'."\n"
+ ."\n"
+ .'This parameter is returned only if the file is a MaxCompute resource file.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'false',
+ ],
+ 'BusinessId' => [
+ 'description' => 'The ID of the workflow to which the file belongs.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '300000',
+ ],
+ 'FileDescription' => [
+ 'description' => 'The description of the file.'."\n",
+ 'type' => 'string',
+ 'example' => 'my test datastudio file',
+ ],
+ 'LastEditTime' => [
+ 'description' => 'The time when the file was last modified. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '1593950832000',
+ ],
+ 'Content' => [
+ 'description' => 'This parameter is deprecated. You can call the [GetFile](~~173954#doc-api-dataworks-public-GetFile~~) operation to query the details of the file.'."\n",
+ 'type' => 'string',
+ 'example' => 'SHOW TABLES;',
+ ],
+ 'NodeId' => [
+ 'description' => 'The ID of the auto triggered node that is generated in the scheduling system after the file is committed.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '300001',
+ ],
+ 'AbsoluteFolderPath' => [
+ 'description' => 'The path of the folder to which the file belongs.'."\n",
+ 'type' => 'string',
+ 'example' => 'Business_process/my_first_business_process/MaxCompute/ods_layer',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'errorCodes' => [
+ 403 => [
+ [
+ 'errorCode' => 'Forbidden.Access',
+ 'errorMessage' => 'Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.',
+ ],
+ ],
+ 429 => [
+ [
+ 'errorCode' => 'Throttling.Api',
+ 'errorMessage' => 'The request for this resource has exceeded your available limit.',
+ ],
+ [
+ 'errorCode' => 'Throttling.System',
+ 'errorMessage' => 'The DataWorks system is busy. Try again later.',
+ ],
+ [
+ 'errorCode' => 'Throttling.User',
+ 'errorMessage' => 'Your request is too frequent. Try again later.',
+ ],
+ ],
+ 500 => [
+ [
+ 'errorCode' => 'InternalError.System',
+ 'errorMessage' => 'An internal system error occurred. Try again later.',
+ ],
+ [
+ 'errorCode' => 'InternalError.UserId.Missing',
+ 'errorMessage' => 'An internal system error occurred. Try again later.',
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"ErrorMessage\\": \\"The connection does not exist.\\",\\n \\"RequestId\\": \\"0000-ABCD-****\\",\\n \\"ErrorCode\\": \\"Invalid.Tenant.ConnectionNotExists\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 13,\\n \\"Files\\": [\\n {\\n \\"CommitStatus\\": 1,\\n \\"AutoParsing\\": true,\\n \\"Owner\\": \\"3872572****\\",\\n \\"CreateTime\\": 1593950832000,\\n \\"FileType\\": 10,\\n \\"CurrentVersion\\": 2,\\n \\"BizId\\": 300000,\\n \\"LastEditUser\\": \\"38748246285727\\",\\n \\"FileName\\": \\"ods_user_info_d\\",\\n \\"ConnectionName\\": \\"odps_source\\",\\n \\"UseType\\": \\"NORMAL\\",\\n \\"FileFolderId\\": \\"2735c2****\\",\\n \\"FileId\\": 10000001,\\n \\"ParentId\\": -1,\\n \\"CreateUser\\": \\"382762****\\",\\n \\"IsMaxCompute\\": false,\\n \\"BusinessId\\": 300000,\\n \\"FileDescription\\": \\"my test datastudio file\\",\\n \\"LastEditTime\\": 1593950832000,\\n \\"Content\\": \\"SHOW TABLES;\\",\\n \\"NodeId\\": 300001,\\n \\"AbsoluteFolderPath\\": \\"Business_process/my_first_business_process/MaxCompute/ods_layer\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<ListFilesResponse>\\n <HttpStatusCode>200</HttpStatusCode>\\n <ErrorMessage>The connection does not exist.</ErrorMessage>\\n <RequestId>0000-ABCD-EFG</RequestId>\\n <ErrorCode>Invalid.Tenant.ConnectionNotExists</ErrorCode>\\n <Success>true</Success>\\n <Data>\\n <PageNumber>1</PageNumber>\\n <PageSize>10</PageSize>\\n <TotalCount>13</TotalCount>\\n <Files>\\n <CommitStatus>1</CommitStatus>\\n <AutoParsing>true</AutoParsing>\\n <Owner>3872572****</Owner>\\n <CreateTime>1593950832000</CreateTime>\\n <FileType>10</FileType>\\n <CurrentVersion>2</CurrentVersion>\\n <BizId>300000</BizId>\\n <LastEditUser>38748246285727</LastEditUser>\\n <FileName>ods_user_info_d</FileName>\\n <ConnectionName>odps_source</ConnectionName>\\n <UseType>NORMAL</UseType>\\n <FileFolderId>2735c2****</FileFolderId>\\n <FileId>10000001</FileId>\\n <ParentId>-1</ParentId>\\n <CreateUser>382762****</CreateUser>\\n <IsMaxCompute>false</IsMaxCompute>\\n <BusinessId>300000</BusinessId>\\n <FileDescription>my test datastudio file</FileDescription>\\n <LastEditTime>1593950832000</LastEditTime>\\n <Content>SHOW TABLES;</Content>\\n <NodeId>300001</NodeId>\\n </Files>\\n </Data>\\n</ListFilesResponse>","errorExample":""}]',
+ 'title' => 'ListFiles',
+ 'summary' => 'Queries a list of files.',
+ 'requestParamsDescription' => ' ',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ ],
+ 'EstablishRelationTableToBusiness' => [
+ 'methods' => [
+ 'post',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'readAndWrite',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'update',
+ 'abilityTreeCode' => '78225',
+ 'abilityTreeNodes' => [
+ 'FEATUREdideEPPSOE',
+ ],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'ProjectId',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The ID of the DataWorks workspace. You can click the Workspace Manage icon in the upper-right corner of the DataStudio page to go to the Workspace Management page and view the workspace ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'docRequired' => false,
+ 'example' => '10000',
+ ],
+ ],
+ [
+ 'name' => 'ProjectIdentifier',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The unique identifier of the DataWorks workspace. You can click the identifier in the upper-left corner of the DataStudio page to switch to another workspace.'."\n"
+ ."\n"
+ .'You must specify either this parameter or ProjectId to determine the DataWorks workspace to which the operation is applied.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'dw',
+ ],
+ ],
+ [
+ 'name' => 'BusinessId',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The ID of the workflow. You can call the [ListBusiness](~~173945~~) operation to query the ID.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => '1000001',
+ ],
+ ],
+ [
+ 'name' => 'TableGuid',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The universally unique identifier (UUID) of the table. You can call the [SearchMetaTables](~~173919~~) operation to query the UUID.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'odps.dw_project.tb1',
+ ],
+ ],
+ [
+ 'name' => 'FolderId',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The ID of the folder. You can call the [GetFolder](~~173952~~) or [ListFolders](~~173955~~) operation to query the ID.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'docRequired' => true,
+ 'example' => '2eb6f9****',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'HttpStatusCode' => [
+ 'description' => 'The HTTP status code returned.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '200',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message returned.'."\n",
+ 'type' => 'string',
+ 'example' => 'The connection does not exist.',
+ ],
+ 'RequestId' => [
+ 'description' => 'The ID of the request. You can troubleshoot issues based on the ID.'."\n",
+ 'type' => 'string',
+ 'example' => '0000-ABCD-EFG',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code returned.'."\n",
+ 'type' => 'string',
+ 'example' => 'Invalid.Tenant.ConnectionNotExists',
+ ],
+ 'Success' => [
+ 'description' => 'Indicates whether the request is successful.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'errorCodes' => [
+ 403 => [
+ [
+ 'errorCode' => 'Forbidden.Access',
+ 'errorMessage' => 'Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.',
+ ],
+ ],
+ 429 => [
+ [
+ 'errorCode' => 'Throttling.Api',
+ 'errorMessage' => 'The request for this resource has exceeded your available limit.',
+ ],
+ [
+ 'errorCode' => 'Throttling.System',
+ 'errorMessage' => 'The DataWorks system is busy. Try again later.',
+ ],
+ [
+ 'errorCode' => 'Throttling.User',
+ 'errorMessage' => 'Your request is too frequent. Try again later.',
+ ],
+ ],
+ 500 => [
+ [
+ 'errorCode' => 'InternalError.System',
+ 'errorMessage' => 'An internal system error occurred. Try again later.',
+ ],
+ [
+ 'errorCode' => 'InternalError.UserId.Missing',
+ 'errorMessage' => 'An internal system error occurred. Try again later.',
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"ErrorMessage\\": \\"The connection does not exist.\\",\\n \\"RequestId\\": \\"0000-ABCD-EFG\\",\\n \\"ErrorCode\\": \\"Invalid.Tenant.ConnectionNotExists\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<RequestId>0000-ABCD-EFG</RequestId>\\n<HttpStatusCode>200</HttpStatusCode>\\n<ErrorCode>Invalid.Tenant.ConnectionNotExists</ErrorCode>\\n<ErrorMessage>The connection does not exist.</ErrorMessage>\\n<Success>true</Success>","errorExample":""}]',
+ 'title' => 'EstablishRelationTableToBusiness',
+ 'summary' => 'Imports a table to a workflow. The call to this API operation is equivalent to performing the following operations: Go to the DataStudio page, find the desired workflow, and then click the workflow name. Right-click Table under the desired folder and select Import Table.',
+ 'requestParamsDescription' => ' ',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ ],
+ 'SubmitFile' => [
+ 'methods' => [
+ 'post',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'readAndWrite',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'update',
+ 'abilityTreeCode' => '78360',
+ 'abilityTreeNodes' => [
+ 'FEATUREdide8FM783',
+ ],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'ProjectId',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The DataWorks workspace ID. You can log on to the DataWorks console and go to the Workspace page to query the ID. You must configure either this parameter or the ProjectIdentifier parameter to determine the DataWorks workspace to which the operation is applied.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'docRequired' => false,
+ 'example' => '10000',
+ ],
+ ],
+ [
+ 'name' => 'ProjectIdentifier',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The name of the DataWorks workspace. You can log on to the DataWorks console and go to the Workspace page to obtain the workspace name. You must configure either this parameter or the ProjectId parameter to determine the DataWorks workspace to which the operation is applied.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'dw_project',
+ ],
+ ],
+ [
+ 'name' => 'FileId',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The file ID. You can call the [ListFiles](~~173942~~) operation to query the file ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => '1000000',
+ ],
+ ],
+ [
+ 'name' => 'Comment',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The description of the commit operation.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'Submit a task for the first time',
+ ],
+ ],
+ [
+ 'name' => 'SkipAllDeployFileExtensions',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'Specifies whether to skip the pre-publish check after the file is committed. Valid values:'."\n"
+ ."\n"
+ .'* false: indicates that the pre-publish check is not skipped. After the file is committed, the pre-publish check is automatically triggered. The file can be deployed only after the file passes the check.'."\n"
+ .'* true: indicates that the pre-publish check is skipped. After the file is submitted, the pre-publish check process is not triggered. You can directly deploy the file.'."\n",
+ 'type' => 'boolean',
+ 'required' => false,
+ 'example' => 'false',
+ 'default' => 'false',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'description' => 'The response parameters.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'HttpStatusCode' => [
+ 'description' => 'The HTTP status code.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '200',
+ ],
+ 'Data' => [
+ 'description' => 'The deployment package ID. The ID is used as the value of a specific request parameter when you call the [GetDeployment](~~173950~~) operation to query the details of the deployment operation.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '3000001',
+ ],
+ 'RequestId' => [
+ 'description' => 'The request ID.'."\n",
+ 'type' => 'string',
+ 'example' => '0000-ABCD-EFG****',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message.'."\n",
+ 'type' => 'string',
+ 'example' => 'The connection does not exist.',
+ ],
+ 'Success' => [
+ 'description' => 'Indicates whether the request was successful.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code.'."\n",
+ 'type' => 'string',
+ 'example' => 'Invalid.Tenant.ConnectionNotExists',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'errorCodes' => [
+ 403 => [
+ [
+ 'errorCode' => 'Forbidden.Access',
+ 'errorMessage' => 'Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.',
+ ],
+ ],
+ 429 => [
+ [
+ 'errorCode' => 'Throttling.Api',
+ 'errorMessage' => 'The request for this resource has exceeded your available limit.',
+ ],
+ [
+ 'errorCode' => 'Throttling.System',
+ 'errorMessage' => 'The DataWorks system is busy. Try again later.',
+ ],
+ [
+ 'errorCode' => 'Throttling.User',
+ 'errorMessage' => 'Your request is too frequent. Try again later.',
+ ],
+ ],
+ 500 => [
+ [
+ 'errorCode' => 'InternalError.System',
+ 'errorMessage' => 'An internal system error occurred. Try again later.',
+ ],
+ [
+ 'errorCode' => 'InternalError.UserId.Missing',
+ 'errorMessage' => 'An internal system error occurred. Try again later.',
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Data\\": 3000001,\\n \\"RequestId\\": \\"0000-ABCD-EFG****\\",\\n \\"ErrorMessage\\": \\"The connection does not exist.\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"Invalid.Tenant.ConnectionNotExists\\"\\n}","errorExample":""},{"type":"xml","example":"<SubmitFileResponse>\\n <HttpStatusCode>200</HttpStatusCode>\\n <Data>3000001</Data>\\n <RequestId>0000-ABCD-EFG****</RequestId>\\n <ErrorMessage>The connection does not exist.</ErrorMessage>\\n <Success>true</Success>\\n <ErrorCode>Invalid.Tenant.ConnectionNotExists</ErrorCode>\\n</SubmitFileResponse>","errorExample":""}]',
+ 'title' => 'SubmitFile',
+ 'summary' => 'Commits a file to the development environment of the scheduling system to generate a task.',
+ 'requestParamsDescription' => ' ',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ ],
+ 'ListBusiness' => [
+ 'methods' => [
+ 'post',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'get',
+ 'abilityTreeCode' => '78297',
+ 'abilityTreeNodes' => [
+ 'FEATUREdide8FM783',
+ ],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'ProjectId',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The ID of the DataWorks workspace. You can log on to the DataWorks console and go to the Workspace Management page to obtain the workspace ID. You must configure either this parameter or the ProjectIdentifier parameter to determine the DataWorks workspace to which the operation is applied.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'docRequired' => false,
+ 'example' => '10000',
+ ],
+ ],
+ [
+ 'name' => 'ProjectIdentifier',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The name of the DataWorks workspace. You can log on to the DataWorks console and go to the Workspace Management page to obtain the workspace name. You must configure either this parameter or ProjectId parameter to determine the DataWorks workspace to which the operation is applied.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'dw_project',
+ ],
+ ],
+ [
+ 'name' => 'PageNumber',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The number of the page to return.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => true,
+ 'docRequired' => true,
+ 'minimum' => '1',
+ 'example' => '1',
+ ],
+ ],
+ [
+ 'name' => 'PageSize',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The number of entries to return on each page. Default value: 10. Maximum value: 100.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => true,
+ 'docRequired' => true,
+ 'maximum' => '100',
+ 'minimum' => '0',
+ 'example' => '10',
+ ],
+ ],
+ [
+ 'name' => 'Keyword',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The keyword that is used to perform a fuzzy match.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'my',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'description' => '',
+ 'type' => 'object',
+ 'properties' => [
+ 'HttpStatusCode' => [
+ 'description' => 'The HTTP status code returned.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '200',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message returned.'."\n",
+ 'type' => 'string',
+ 'example' => 'The connection does not exist.',
+ ],
+ 'RequestId' => [
+ 'description' => 'The ID of the request. You can use the ID to troubleshoot issues.'."\n",
+ 'type' => 'string',
+ 'example' => '0000-ABCD-EFG****',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code returned.'."\n",
+ 'type' => 'string',
+ 'example' => 'Invalid.Tenant.ConnectionNotExists',
+ ],
+ 'Success' => [
+ 'description' => 'Indicates whether the request was successful.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'Data' => [
+ 'description' => 'The information about the workflows returned.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'PageNumber' => [
+ 'description' => 'The page number of the returned page.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '1',
+ ],
+ 'PageSize' => [
+ 'description' => 'The number of entries returned per page.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '10',
+ ],
+ 'TotalCount' => [
+ 'description' => 'The total number of entries returned.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '13',
+ ],
+ 'Business' => [
+ 'description' => 'The details of the workflow.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '',
+ 'type' => 'object',
+ 'properties' => [
+ 'Owner' => [
+ 'description' => 'The owner of the workflow.'."\n",
+ 'type' => 'string',
+ 'example' => '34824327****',
+ ],
+ 'Description' => [
+ 'description' => 'The description of the workflow.'."\n",
+ 'type' => 'string',
+ 'example' => 'My first workflow'."\n",
+ ],
+ 'ProjectId' => [
+ 'description' => 'The ID of the workspace to which the workflow belongs.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '10000',
+ ],
+ 'BusinessId' => [
+ 'description' => 'The ID of the workflow.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '3000001',
+ ],
+ 'BusinessName' => [
+ 'description' => 'The name of the workflow.'."\n",
+ 'type' => 'string',
+ 'example' => 'My first workflow'."\n",
+ ],
+ 'UseType' => [
+ 'description' => 'The module to which the workflow belongs. Valid values: NORMAL and MANUAL_BIZ. The value NORMAL indicates that the workflow belongs to auto triggered workflows. The value MANUAL_BIZ indicates that the workflow belongs to manually triggered workflows.'."\n",
+ 'type' => 'string',
+ 'example' => 'NORMAL',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'errorCodes' => [
+ 403 => [
+ [
+ 'errorCode' => 'Forbidden.Access',
+ 'errorMessage' => 'Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.',
+ ],
+ ],
+ 429 => [
+ [
+ 'errorCode' => 'Throttling.Api',
+ 'errorMessage' => 'The request for this resource has exceeded your available limit.',
+ ],
+ [
+ 'errorCode' => 'Throttling.System',
+ 'errorMessage' => 'The DataWorks system is busy. Try again later.',
+ ],
+ [
+ 'errorCode' => 'Throttling.User',
+ 'errorMessage' => 'Your request is too frequent. Try again later.',
+ ],
+ ],
+ 500 => [
+ [
+ 'errorCode' => 'InternalError.System',
+ 'errorMessage' => 'An internal system error occurred. Try again later.',
+ ],
+ [
+ 'errorCode' => 'InternalError.UserId.Missing',
+ 'errorMessage' => 'An internal system error occurred. Try again later.',
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"ErrorMessage\\": \\"The connection does not exist.\\",\\n \\"RequestId\\": \\"0000-ABCD-EFG****\\",\\n \\"ErrorCode\\": \\"Invalid.Tenant.ConnectionNotExists\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 13,\\n \\"Business\\": [\\n {\\n \\"Owner\\": \\"34824327****\\",\\n \\"Description\\": \\"我的第一个业务流程\\",\\n \\"ProjectId\\": 10000,\\n \\"BusinessId\\": 3000001,\\n \\"BusinessName\\": \\"我的第一个业务流程\\",\\n \\"UseType\\": \\"NORMAL\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<ListBusinessResponse>\\n <HttpStatusCode>200</HttpStatusCode>\\n <ErrorMessage>The connection does not exist.</ErrorMessage>\\n <RequestId>0000-ABCD-EFG****</RequestId>\\n <ErrorCode>Invalid.Tenant.ConnectionNotExists</ErrorCode>\\n <Success>true</Success>\\n <Data>\\n <PageNumber>1</PageNumber>\\n <PageSize>10</PageSize>\\n <TotalCount>13</TotalCount>\\n <Business>\\n <Owner>34824327****</Owner>\\n <Description>我的第一个业务流程</Description>\\n <ProjectId>10000</ProjectId>\\n <BusinessId>3000001</BusinessId>\\n <BusinessName>我的第一个业务流程</BusinessName>\\n <UseType>NORMAL</UseType>\\n </Business>\\n </Data>\\n</ListBusinessResponse>","errorExample":""}]',
+ 'title' => 'ListBusiness',
+ 'summary' => 'Queries a list of workflows.',
+ 'requestParamsDescription' => ' ',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ ],
+ 'GetFileVersion' => [
+ 'methods' => [
+ 'post',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'get',
+ 'abilityTreeCode' => '78247',
+ 'abilityTreeNodes' => [
+ 'FEATUREdide8FM783',
+ ],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'FileId',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The ID of the file. You can call the [ListFiles](~~173942~~) operation to query the ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => '1000001',
+ ],
+ ],
+ [
+ 'name' => 'ProjectId',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The DataWorks workspace ID. You can click the Workspace Manage icon in the upper-right corner of the DataStudio page to go to the Workspace page and view the workspace ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'docRequired' => false,
+ 'example' => '10000',
+ ],
+ ],
+ [
+ 'name' => 'ProjectIdentifier',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The unique identifier of the DataWorks workspace. You can click the identifier in the upper-left corner of the DataStudio page to switch to another workspace.'."\n"
+ ."\n"
+ .'You must specify either this parameter or ProjectId to determine the DataWorks workspace to which the operation is applied.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'dw_project',
+ ],
+ ],
+ [
+ 'name' => 'FileVersion',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The file version whose details you want to query.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => '2',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'description' => 'The returned data.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'HttpStatusCode' => [
+ 'description' => 'The HTTP status code returned.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '200',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message returned.'."\n",
+ 'type' => 'string',
+ 'example' => 'The connection does not exist.',
+ ],
+ 'RequestId' => [
+ 'description' => 'The ID of the request. You can troubleshoot issues based on the ID.'."\n",
+ 'type' => 'string',
+ 'example' => '0000-ABCD-EFG****',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code returned.'."\n",
+ 'type' => 'string',
+ 'example' => 'Invalid.Tenant.ConnectionNotExists',
+ ],
+ 'Success' => [
+ 'description' => 'Indicates whether the request is successful.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'Data' => [
+ 'description' => 'The details of the file version.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'FileContent' => [
+ 'description' => 'The file code.'."\n",
+ 'type' => 'string',
+ 'example' => 'SHOW TABLES;',
+ ],
+ 'IsCurrentProd' => [
+ 'description' => 'Indicates whether the version is the latest version in the production environment.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'Status' => [
+ 'description' => 'The status of the file version. Valid values: COMMITTING, COMMITTED, CHECK_OK, PACKAGED, DEPLOYING, DEPLOYED, and CANCELLED. The value CHECK_OK is equivalent to the value COMMITTED.'."\n",
+ 'type' => 'string',
+ 'example' => 'COMMITTED',
+ ],
+ 'NodeContent' => [
+ 'description' => 'The scheduling configurations of the node that corresponds to the file version.'."\n",
+ 'type' => 'string',
+ 'example' => '{"cycleType":0,"cronExpress":"00 05 00 * * ?"}',
+ ],
+ 'CommitUser' => [
+ 'description' => 'The ID of the Alibaba Cloud account that is used to create the file version.'."\n",
+ 'type' => 'string',
+ 'example' => '7384234****',
+ ],
+ 'Comment' => [
+ 'description' => 'The description of the file version.'."\n",
+ 'type' => 'string',
+ 'example' => 'Second version submission',
+ ],
+ 'FilePropertyContent' => [
+ 'description' => 'The basic information about the file.'."\n",
+ 'type' => 'string',
+ 'example' => '{"fileName":"ods_user_info_d","fileType":10}',
+ ],
+ 'FileName' => [
+ 'description' => 'The file name.'."\n",
+ 'type' => 'string',
+ 'example' => 'ods_user_info_d',
+ ],
+ 'UseType' => [
+ 'description' => 'The functional module to which the file belongs. Valid values: NORMAL, MANUAL, MANUAL_BIZ, SKIP, ADHOCQUERY, and COMPONENT. The value NORMAL indicates DataStudio. The value MANUAL indicates a manually triggered node. The value MANUAL_BIZ indicates a manually triggered workflow. The value SKIP indicates a dry-run DataStudio node. The value ADHOCQUERY indicates an ad hoc query. The value COMPONENT indicates snippets.'."\n",
+ 'type' => 'string',
+ 'example' => 'NORMAL',
+ ],
+ 'ChangeType' => [
+ 'description' => 'The change type of the file version. Valid values: CREATE, UPDATE, and DELETE.'."\n",
+ 'type' => 'string',
+ 'example' => 'UPDATE',
+ ],
+ 'FileVersion' => [
+ 'description' => 'The file version.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '2',
+ ],
+ 'CommitTime' => [
+ 'description' => 'The time when the version was generated. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '1593881265000',
+ ],
+ 'NodeId' => [
+ 'description' => 'The ID of the node that corresponds to the file version.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '3000001',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'errorCodes' => [
+ 403 => [
+ [
+ 'errorCode' => 'Forbidden.Access',
+ 'errorMessage' => 'Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.',
+ ],
+ ],
+ 429 => [
+ [
+ 'errorCode' => 'Throttling.Api',
+ 'errorMessage' => 'The request for this resource has exceeded your available limit.',
+ ],
+ [
+ 'errorCode' => 'Throttling.System',
+ 'errorMessage' => 'The DataWorks system is busy. Try again later.',
+ ],
+ [
+ 'errorCode' => 'Throttling.User',
+ 'errorMessage' => 'Your request is too frequent. Try again later.',
+ ],
+ ],
+ 500 => [
+ [
+ 'errorCode' => 'InternalError.System',
+ 'errorMessage' => 'An internal system error occurred. Try again later.',
+ ],
+ [
+ 'errorCode' => 'InternalError.UserId.Missing',
+ 'errorMessage' => 'An internal system error occurred. Try again later.',
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"ErrorMessage\\": \\"The connection does not exist.\\",\\n \\"RequestId\\": \\"0000-ABCD-EFG****\\",\\n \\"ErrorCode\\": \\"Invalid.Tenant.ConnectionNotExists\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"FileContent\\": \\"SHOW TABLES;\\",\\n \\"IsCurrentProd\\": true,\\n \\"Status\\": \\"COMMITTED\\",\\n \\"NodeContent\\": \\"{\\\\\\"cycleType\\\\\\":0,\\\\\\"cronExpress\\\\\\":\\\\\\"00 05 00 * * ?\\\\\\"}\\",\\n \\"CommitUser\\": \\"7384234****\\",\\n \\"Comment\\": \\"Second version submission\\",\\n \\"FilePropertyContent\\": \\"{\\\\\\"fileName\\\\\\":\\\\\\"ods_user_info_d\\\\\\",\\\\\\"fileType\\\\\\":10}\\",\\n \\"FileName\\": \\"ods_user_info_d\\",\\n \\"UseType\\": \\"0\\",\\n \\"ChangeType\\": \\"UPDATE\\",\\n \\"FileVersion\\": 2,\\n \\"CommitTime\\": 1593881265000,\\n \\"NodeId\\": 3000001\\n }\\n}","errorExample":""},{"type":"xml","example":"<GetFileVersionResponse>\\n <HttpStatusCode>200</HttpStatusCode>\\n <ErrorMessage>The connection does not exist.</ErrorMessage>\\n <RequestId>0000-ABCD-EFG****</RequestId>\\n <ErrorCode>Invalid.Tenant.ConnectionNotExists</ErrorCode>\\n <Success>true</Success>\\n <Data>\\n <FileContent>SHOW TABLES;</FileContent>\\n <IsCurrentProd>true</IsCurrentProd>\\n <Status>COMMITTED</Status>\\n <NodeContent>{\\"cycleType\\":0,\\"cronExpress\\":\\"00 05 00 * * ?\\"}</NodeContent>\\n <CommitUser>7384234****</CommitUser>\\n <Comment>第二次版本提交</Comment>\\n <FilePropertyContent>{\\"fileName\\":\\"ods_user_info_d\\",\\"fileType\\":10}</FilePropertyContent>\\n <FileName>ods_user_info_d</FileName>\\n <UseType>0</UseType>\\n <ChangeType>UPDATE</ChangeType>\\n <FileVersion>2</FileVersion>\\n <CommitTime>1593881265000</CommitTime>\\n <NodeId>3000001</NodeId>\\n </Data>\\n</GetFileVersionResponse>","errorExample":""}]',
+ 'title' => 'GetFileVersion',
+ 'summary' => 'Queries the information about a file version.',
+ 'requestParamsDescription' => ' ',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ ],
+ 'DeleteFolder' => [
+ 'methods' => [
+ 'post',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'readAndWrite',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'delete',
+ 'abilityTreeCode' => '78209',
+ 'abilityTreeNodes' => [
+ 'FEATUREdide8FM783',
+ ],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'ProjectId',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'Indicates whether the request is successful.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'docRequired' => false,
+ 'example' => '10000',
+ ],
+ ],
+ [
+ 'name' => 'ProjectIdentifier',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'http://100.67.165.184/business/api/folders/delete',
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'dw_project',
+ ],
+ ],
+ [
+ 'name' => 'FolderId',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'DeleteFolder',
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => '2eb6f9****',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'HttpStatusCode' => [
+ 'description' => '',
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '200',
+ ],
+ 'ErrorMessage' => [
+ 'description' => '',
+ 'type' => 'string',
+ 'example' => 'The connection does not exist.',
+ ],
+ 'RequestId' => [
+ 'description' => '',
+ 'type' => 'string',
+ 'example' => '0000-ABCD-EFG****',
+ ],
+ 'ErrorCode' => [
+ 'description' => '',
+ 'type' => 'string',
+ 'example' => 'Invalid.Tenant.ConnectionNotExists',
+ ],
+ 'Success' => [
+ 'description' => '',
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'errorCodes' => [
+ 403 => [
+ [
+ 'errorCode' => 'Forbidden.Access',
+ 'errorMessage' => 'Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.',
+ ],
+ ],
+ 429 => [
+ [
+ 'errorCode' => 'Throttling.Api',
+ 'errorMessage' => 'The request for this resource has exceeded your available limit.',
+ ],
+ [
+ 'errorCode' => 'Throttling.System',
+ 'errorMessage' => 'The DataWorks system is busy. Try again later.',
+ ],
+ [
+ 'errorCode' => 'Throttling.User',
+ 'errorMessage' => 'Your request is too frequent. Try again later.',
+ ],
+ ],
+ 500 => [
+ [
+ 'errorCode' => 'InternalError.System',
+ 'errorMessage' => 'An internal system error occurred. Try again later.',
+ ],
+ [
+ 'errorCode' => 'InternalError.UserId.Missing',
+ 'errorMessage' => 'An internal system error occurred. Try again later.',
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"ErrorMessage\\": \\"The connection does not exist.\\",\\n \\"RequestId\\": \\"0000-ABCD-EFG****\\",\\n \\"ErrorCode\\": \\"Invalid.Tenant.ConnectionNotExists\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<RequestId>0000-ABCD-EFG****</RequestId>\\n<HttpStatusCode>200</HttpStatusCode>\\n<ErrorCode>Invalid.Tenant.ConnectionNotExists</ErrorCode>\\n<ErrorMessage>The connection does not exist.</ErrorMessage>\\n<Success>true</Success>","errorExample":""}]',
+ 'title' => 'DeleteFolder',
+ 'summary' => 'Deletes a folder from DataStudio.',
+ 'requestParamsDescription' => ' ',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ ],
+ 'DeleteFile' => [
+ 'methods' => [
+ 'post',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'write',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'delete',
+ 'abilityTreeCode' => '78208',
+ 'abilityTreeNodes' => [
+ 'FEATUREdide8FM783',
+ ],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'ProjectId',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The name of the DataWorks workspace. You can log on to the [DataWorks console](https://workbench.data.aliyun.com/console) and go to the Workspace Management page to view the workspace name.'."\n"
+ ."\n"
+ .'You must specify one of the ProjectId and ProjectIdentifier parameters to determine the DataWorks workspace to which the operation is applied.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'docRequired' => false,
+ 'example' => '10000',
+ ],
+ ],
+ [
+ 'name' => 'ProjectIdentifier',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The ID of the file. You can call the [ListFiles](~~173942~~) operation to query the ID of the file.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'dw_project',
+ ],
+ ],
+ [
+ 'name' => 'FileId',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The file ID. You can call the [ListFiles](~~173942~~) operation to query the file ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => '10000001',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'description' => '',
+ 'type' => 'object',
+ 'properties' => [
+ 'HttpStatusCode' => [
+ 'description' => 'The ID of the deployment task that deploys the file. If the file has been committed, an asynchronous process is triggered to delete the file in the scheduling system. The value of this parameter is used to call the GetDeployment operation to poll the status of the asynchronous process.'."\n"
+ ."\n"
+ .'If this parameter is empty, the file is deleted and the polling is not required.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '200',
+ ],
+ 'DeploymentId' => [
+ 'description' => 'The ID of the request. You can troubleshoot errors based on the ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '1000000001',
+ ],
+ 'RequestId' => [
+ 'description' => 'The error message returned.'."\n",
+ 'type' => 'string',
+ 'example' => '0000-ABCD-EFG****',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'Indicates whether the request is successful. Valid values:'."\n"
+ ."\n"
+ .'* true: The request is successful.'."\n"
+ .'* false: The request fails.'."\n",
+ 'type' => 'string',
+ 'example' => 'The connection does not exist.',
+ ],
+ 'Success' => [
+ 'description' => 'The error code returned.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The ID of the file. You can use the ListFiles interface to query the ID of the corresponding file.',
+ 'type' => 'string',
+ 'example' => 'Invalid.Tenant.ConnectionNotExists',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'errorCodes' => [
+ 403 => [
+ [
+ 'errorCode' => 'Forbidden.Access',
+ 'errorMessage' => 'Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.',
+ ],
+ ],
+ 429 => [
+ [
+ 'errorCode' => 'Throttling.Api',
+ 'errorMessage' => 'The request for this resource has exceeded your available limit.',
+ ],
+ [
+ 'errorCode' => 'Throttling.System',
+ 'errorMessage' => 'The DataWorks system is busy. Try again later.',
+ ],
+ [
+ 'errorCode' => 'Throttling.User',
+ 'errorMessage' => 'Your request is too frequent. Try again later.',
+ ],
+ ],
+ 500 => [
+ [
+ 'errorCode' => 'InternalError.System',
+ 'errorMessage' => 'An internal system error occurred. Try again later.',
+ ],
+ [
+ 'errorCode' => 'InternalError.UserId.Missing',
+ 'errorMessage' => 'An internal system error occurred. Try again later.',
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"DeploymentId\\": 1000000001,\\n \\"RequestId\\": \\"0000-ABCD-EFG****\\",\\n \\"ErrorMessage\\": \\"The connection does not exist.\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"Invalid.Tenant.ConnectionNotExists\\"\\n}","errorExample":""},{"type":"xml","example":"<DeleteFileResponse>\\n <HttpStatusCode>200</HttpStatusCode>\\n <DeploymentId>1000000001</DeploymentId>\\n <RequestId>0000-ABCD-EFG****</RequestId>\\n <ErrorMessage>The connection does not exist.</ErrorMessage>\\n <Success>true</Success>\\n <ErrorCode>Invalid.Tenant.ConnectionNotExists</ErrorCode>\\n</DeleteFileResponse>","errorExample":""}]',
+ 'title' => 'DeleteFile',
+ 'summary' => 'Deletes a file from DataStudio. If the file has been committed, an asynchronous process is triggered to delete the file in the scheduling system. The value of the DeploymentId parameter returned is used to call the GetDeployment operation to poll the status of the asynchronous process.',
+ 'requestParamsDescription' => ' ',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ ],
+ 'GetDeployment' => [
+ 'methods' => [
+ 'post',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'get',
+ 'abilityTreeCode' => '78242',
+ 'abilityTreeNodes' => [
+ 'FEATUREdide8FM783',
+ ],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'ProjectId',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The ID of the DataWorks workspace. You can click the Workspace Manage icon in the upper-right corner of the DataStudio page to go to the Workspace Management page and view the workspace ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'docRequired' => false,
+ 'example' => '10000',
+ ],
+ ],
+ [
+ 'name' => 'ProjectIdentifier',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The GUID of the DataWorks workspace. You can view the GUID in the upper part of the DataStudio page. You can also select another GUID to switch to another workspace.'."\n"
+ ."\n"
+ .'You must specify either this parameter or the ProjectId parameter to determine the DataWorks workspace to which the operation is applied.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'dw_project',
+ ],
+ ],
+ [
+ 'name' => 'DeploymentId',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The ID of the deployment task. A deployment task ID is generated when you call the [SubmitFile](~~173944~~) or [DeployFile](~~173956~~) operation.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => '3000001',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'description' => 'The returned data.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'HttpStatusCode' => [
+ 'description' => 'The HTTP status code returned.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '200',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message returned.'."\n",
+ 'type' => 'string',
+ 'example' => 'The connection does not exist.',
+ ],
+ 'RequestId' => [
+ 'description' => 'The ID of the request. You can troubleshoot errors based on the ID.'."\n",
+ 'type' => 'string',
+ 'example' => '0000-ABCD-EFG****',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code returned.',
+ 'type' => 'string',
+ 'example' => 'Invalid.Tenant.ConnectionNotExists',
+ ],
+ 'Success' => [
+ 'description' => 'Indicates whether the request is successful.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'Data' => [
+ 'description' => 'The details of the deployment package.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'Deployment' => [
+ 'description' => 'The details of the deployment package.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'Status' => [
+ 'description' => 'The status of the deployment task. Valid values: 0, 1, and 2. A value of 0 indicates that the task is ready. A value of 1 indicates that the task was successful. A value of 2 indicates that the task failed.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '1',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message that was returned when the deployment package failed. In this case, the value of the Status parameter is 2.'."\n",
+ 'type' => 'string',
+ 'example' => 'Success',
+ ],
+ 'FromEnvironment' => [
+ 'description' => 'The environment in which the deployment task was run. Valid values: 0 and 1. A value of 0 indicates the on-premises environment. A value of 1 indicates the development environment.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '0',
+ ],
+ 'ToEnvironment' => [
+ 'description' => 'The environment to which the file was deployed. Valid values: 1 and 2. A value of 1 indicates the development environment. A value of 2 indicates the production environment.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '1',
+ ],
+ 'CheckingStatus' => [
+ 'description' => 'The check status of one or more files in the deployment task. If the value of the ToEnvironment parameter is 1, the files can be deployed to the production environment only when the value of the Status parameter is 1 and the CheckingStatus parameter is empty. Valid values:'."\n"
+ ."\n"
+ .'* 7: The file failed the check.'."\n"
+ .'* 8: The file is being checked.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '7',
+ ],
+ 'CreateTime' => [
+ 'description' => 'The time when the deployment task was created. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '1593877765000',
+ ],
+ 'HandlerId' => [
+ 'description' => 'The ID of the Alibaba Cloud account used by the user who ran the deployment task.'."\n",
+ 'type' => 'string',
+ 'example' => '2003****',
+ ],
+ 'CreatorId' => [
+ 'description' => 'The ID of the Alibaba Cloud account used by the user who created the deployment task.'."\n",
+ 'type' => 'string',
+ 'example' => '20030****',
+ ],
+ 'ExecuteTime' => [
+ 'description' => 'The time when the deployment task was run. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '1593877765000',
+ ],
+ 'Name' => [
+ 'description' => 'The name of the deployment task. The value is the same as the name of the specific deployment task that is displayed on the Release Package page in the Deploy module.'."\n",
+ 'type' => 'string',
+ 'example' => 'ods_user_info_d-2020-07-04_20030****',
+ ],
+ ],
+ ],
+ 'DeployedItems' => [
+ 'description' => 'The deployed items.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The details of the deployed item.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'FileId' => [
+ 'description' => 'The file ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '507642378',
+ ],
+ 'FileVersion' => [
+ 'description' => 'The version of the file.',
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '7',
+ ],
+ 'Status' => [
+ 'description' => '- UNPUBLISHED(0): not published'."\n"
+ .'- SUCCESS(1): Published'."\n"
+ .'- ERROR(2): Publishing failed'."\n"
+ .'- CLONED(3): successfully CLONED'."\n"
+ .'- DEPLOY_ERROR(4): Publishing failed'."\n"
+ .'- CLONING(5): CLONING'."\n"
+ .'- REJECT(6): release rejected',
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '1',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'errorCodes' => [
+ 403 => [
+ [
+ 'errorCode' => 'Forbidden.Access',
+ 'errorMessage' => 'Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.',
+ ],
+ ],
+ 429 => [
+ [
+ 'errorCode' => 'Throttling.Api',
+ 'errorMessage' => 'The request for this resource has exceeded your available limit.',
+ ],
+ [
+ 'errorCode' => 'Throttling.System',
+ 'errorMessage' => 'The DataWorks system is busy. Try again later.',
+ ],
+ [
+ 'errorCode' => 'Throttling.User',
+ 'errorMessage' => 'Your request is too frequent. Try again later.',
+ ],
+ ],
+ 500 => [
+ [
+ 'errorCode' => 'InternalError.System',
+ 'errorMessage' => 'An internal system error occurred. Try again later.',
+ ],
+ [
+ 'errorCode' => 'InternalError.UserId.Missing',
+ 'errorMessage' => 'An internal system error occurred. Try again later.',
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"ErrorMessage\\": \\"The connection does not exist.\\",\\n \\"RequestId\\": \\"0000-ABCD-EFG****\\",\\n \\"ErrorCode\\": \\"Invalid.Tenant.ConnectionNotExists\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"Deployment\\": {\\n \\"Status\\": 1,\\n \\"ErrorMessage\\": \\"Success\\",\\n \\"FromEnvironment\\": 0,\\n \\"ToEnvironment\\": 1,\\n \\"CheckingStatus\\": 7,\\n \\"CreateTime\\": 1593877765000,\\n \\"HandlerId\\": \\"2003****\\",\\n \\"CreatorId\\": \\"20030****\\",\\n \\"ExecuteTime\\": 1593877765000,\\n \\"Name\\": \\"ods_user_info_d-2020-07-04_20030****\\"\\n },\\n \\"DeployedItems\\": [\\n {\\n \\"FileId\\": 0,\\n \\"FileVersion\\": 7,\\n \\"Status\\": 1\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<GetDeploymentResponse>\\n <HttpStatusCode>200</HttpStatusCode>\\n <ErrorMessage>The connection does not exist.</ErrorMessage>\\n <RequestId>0000-ABCD-EFG****</RequestId>\\n <ErrorCode>Invalid.Tenant.ConnectionNotExists</ErrorCode>\\n <Success>true</Success>\\n <Data>\\n <Deployment>\\n <Status>1</Status>\\n <ErrorMessage>成功</ErrorMessage>\\n <FromEnvironment>0</FromEnvironment>\\n <ToEnvironment>1</ToEnvironment>\\n <CheckingStatus>7</CheckingStatus>\\n <CreateTime>1593877765000</CreateTime>\\n <HandlerId>2003****</HandlerId>\\n <CreatorId>20030****</CreatorId>\\n <ExecuteTime>1593877765000</ExecuteTime>\\n <Name>ods_user_info_d-2020-07-04_20030****</Name>\\n </Deployment>\\n <DeployedItems>\\n <FileId>507642378</FileId>\\n <FileVersion>7</FileVersion>\\n <Status>1</Status>\\n </DeployedItems>\\n </Data>\\n</GetDeploymentResponse>","errorExample":""}]',
+ 'title' => 'GetDeployment',
+ 'summary' => 'Queries the information about a deployment package.',
+ 'requestParamsDescription' => ' ',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ ],
+ 'UpdateFile' => [
+ 'methods' => [
+ 'post',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'readAndWrite',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'update',
+ 'abilityTreeCode' => '78372',
+ 'abilityTreeNodes' => [
+ 'FEATUREdide8FM783',
+ ],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'FileFolderPath',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The path of the file.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'docRequired' => false,
+ 'example' => 'Business_process/First_Business_Process/data_integration/Folder_1/Folder_2',
+ ],
+ ],
+ [
+ 'name' => 'ProjectId',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The DataWorks workspace ID. You can log on to the [DataWorks console](https://workbench.data.aliyun.com/console) and go to the Workspace page to query the ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'docRequired' => false,
+ 'example' => '10000',
+ ],
+ ],
+ [
+ 'name' => 'FileName',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The name of the file. You can set the FileName parameter to a new value to change the file name.'."\n"
+ ."\n"
+ .'You can call the [ListFiles](~~173942~~) operation to query the ID of the file whose name you want to change. Then, you can set the FileId parameter to the ID and set the FileName parameter to a new value when you call the [UpdateFile](~~173951~~) operation.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'docRequired' => false,
+ 'example' => 'ods_user_info_d',
+ ],
+ ],
+ [
+ 'name' => 'FileDescription',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The description of the file.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'docRequired' => false,
+ 'example' => 'Here is the file description',
+ 'maxLength' => 200,
+ ],
+ ],
+ [
+ 'name' => 'Content',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The code of the file. The code format varies based on the file type. To view the code format for a specific file type, go to Operation Center, right-click a node of the file type, and then select View Code.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'SELECT "1";',
+ ],
+ ],
+ [
+ 'name' => 'AutoRerunTimes',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The number of automatic reruns that are allowed after an error occurs.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => false,
+ 'docRequired' => true,
+ 'example' => '3',
+ ],
+ ],
+ [
+ 'name' => 'AutoRerunIntervalMillis',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The interval between two consecutive automatic reruns after an error occurs. Unit: milliseconds. Maximum value: 1800000 (30 minutes).'."\n"
+ ."\n"
+ .'This parameter corresponds to the Rerun Interval parameter that is displayed after the Auto Rerun upon Error check box is selected in the Schedule section of the Properties tab in the [DataWorks console](https://workbench.data.aliyun.com/console).'."\n"
+ ."\n"
+ .'The interval that you specify in the DataWorks console is measured in minutes. Pay attention to the conversion between the units of time when you call the operation.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => false,
+ 'example' => '120000',
+ ],
+ ],
+ [
+ 'name' => 'RerunMode',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'Specifies whether the node that corresponds to the file can be rerun. Valid values:'."\n"
+ ."\n"
+ .'* ALL_ALLOWED: The node can be rerun regardless of whether it is successfully run or fails to run.'."\n"
+ .'* FAILURE_ALLOWED: The node can be rerun only after it fails to run.'."\n"
+ .'* ALL_DENIED: The node cannot be rerun regardless of whether it is successfully run or fails to run.'."\n"
+ ."\n"
+ .'This parameter corresponds to the Rerun parameter in the Schedule section of the Properties tab in the [DataWorks console](https://workbench.data.aliyun.com/console).'."\n"
+ ."\n"
+ .'Valid values:'."\n"
+ ."\n"
+ .'* ALL_ALLOWD'."\n"
+ .'* FAILURE_ALLOWED'."\n"
+ .'* ALL_DENIED'."\n"
+ .'* ALL_ALLOWED'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'ALL_ALLOWED',
+ 'enum' => [
+ 'ALL_ALLOWD',
+ 'FAILURE_ALLOWED',
+ 'ALL_DENIED',
+ 'ALL_ALLOWED',
+ ],
+ ],
+ ],
+ [
+ 'name' => 'Stop',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'Specifies whether to suspend the scheduling of the node. Valid values:'."\n"
+ ."\n"
+ .'* true: suspends the scheduling of the node.'."\n"
+ .'* false: does not suspend the scheduling of the node.'."\n"
+ ."\n"
+ .'This parameter corresponds to the Recurrence parameter in the Schedule section of the Properties tab in the [DataWorks console](https://workbench.data.aliyun.com/console).'."\n",
+ 'type' => 'boolean',
+ 'required' => false,
+ 'example' => 'false',
+ ],
+ ],
+ [
+ 'name' => 'ParaValue',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The scheduling parameters of the node.'."\n"
+ ."\n"
+ .'This parameter corresponds to the Parameters section of the Properties tab in the [DataWorks console](https://workbench.data.aliyun.com/console). For more information, see [Configure scheduling parameters](~~137548~~).'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'x=a y=b z=c',
+ ],
+ ],
+ [
+ 'name' => 'StartEffectDate',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The start time of automatic scheduling. Set this parameter to a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.'."\n"
+ ."\n"
+ .'This parameter corresponds to the Validity Period parameter in the Schedule section of the Properties tab in the [DataWorks console](https://workbench.data.aliyun.com/console).'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'minimum' => '0',
+ 'example' => '936923400000',
+ ],
+ ],
+ [
+ 'name' => 'EndEffectDate',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The end time of automatic scheduling. Set this parameter to a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.'."\n"
+ ."\n"
+ .'This parameter corresponds to the end time specified for the Validity Period parameter in the Schedule section of the Properties tab in the [DataWorks console](https://workbench.data.aliyun.com/console).'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'minimum' => '0',
+ 'example' => '4155787800000',
+ ],
+ ],
+ [
+ 'name' => 'CronExpress',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The CRON expression that represents the periodic scheduling policy of the node. This parameter corresponds to the Cron Expression parameter in the Schedule section of the Properties tab in the [DataWorks console](https://workbench.data.aliyun.com/console). After you configure the Scheduling Cycle and Run At parameters in the DataWorks console, DataWorks automatically generates a value for the Cron Expression parameter.'."\n"
+ ."\n"
+ .'Examples:'."\n"
+ ."\n"
+ .'* CRON expression for a node that is scheduled to run at 05:30 every day: `00 30 05 * * ?`'."\n"
+ .'* CRON expression for a node that is scheduled to run at the fifteenth minute of each hour: `00 15 * * * ?`'."\n"
+ .'* CRON expression for a node that is scheduled to run every 10 minutes: `00 00/10 * * * ?`'."\n"
+ .'* CRON expression for a node that is scheduled to run every 10 minutes from 08:00 to 17:00 every day: `00 00-59/10 8-23 * * * ?`'."\n"
+ .'* CRON expression for a node that is scheduled to run at 00:20 on the first day of each month: `00 20 00 1 * ?`'."\n"
+ .'* CRON expression for a node that is scheduled to run every three months starting from 00:10 on January 1: `00 10 00 1 1-12/3 ?`'."\n"
+ .'* CRON expression for a node that is scheduled to run at 00:05 every Tuesday and Friday: `00 05 00 * * 2,5`'."\n"
+ ."\n"
+ .'The scheduling system of DataWorks imposes the following limits on CRON expressions:'."\n"
+ ."\n"
+ .'* A node can be scheduled to run at a minimum interval of 5 minutes.'."\n"
+ .'* A node can be scheduled to run at 00:05 every day at the earliest.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => '00 00-59/5 1-23 * * ?',
+ ],
+ ],
+ [
+ 'name' => 'CycleType',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The type of the scheduling cycle of the node that corresponds to the file. Valid values: NOT_DAY and DAY. The value NOT_DAY indicates that the node is scheduled to run by minute or hour. The value DAY indicates that the node is scheduled to run by day, week, or month.'."\n"
+ ."\n"
+ .'This parameter corresponds to the Scheduling Cycle parameter in the Schedule section of the Properties tab in the [DataWorks console](https://workbench.data.aliyun.com/console).'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'NOT_DAY',
+ 'default' => 'DAY',
+ 'enum' => [
+ 'DAY',
+ 'NOT_DAY',
+ ],
+ ],
+ ],
+ [
+ 'name' => 'DependentType',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The type of the cross-cycle scheduling dependency of the node. Valid values:'."\n"
+ ."\n"
+ .'* SELF: The instance generated for the node in the current cycle depends on the instance generated for the node in the previous cycle.'."\n"
+ .'* CHILD: The instance generated for the node in the current cycle depends on the instances generated for the descendant nodes at the nearest level of the node in the previous cycle.'."\n"
+ .'* USER_DEFINE: The instance generated for the node in the current cycle depends on the instances generated for one or more specified nodes in the previous cycle.'."\n"
+ .'* NONE: No cross-cycle scheduling dependency type is selected for the node.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'USER_DEFINE',
+ 'enum' => [
+ 'NONE',
+ 'USER_DEFINE',
+ 'CHILD',
+ 'SELF',
+ 'USER_DEFINE_AND_SELF',
+ 'CHILD_AND_SELF',
+ ],
+ ],
+ ],
+ [
+ 'name' => 'DependentNodeIdList',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The ID of the node on which the node corresponding to the file depends when the DependentType parameter is set to USER_DEFINE. Multiple IDs are separated by commas (,).'."\n"
+ ."\n"
+ .'The value of this parameter corresponds to the ID of the node that you specified after you select Previous Cycle and set Depend On to Other Nodes in the Dependencies section of the Properties tab in the [DataWorks console](https://workbench.data.aliyun.com/console).'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => '5,10,15,20',
+ ],
+ ],
+ [
+ 'name' => 'InputList',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The output name of the parent file on which the current file depends. If you specify multiple output names, separate them with commas (,).'."\n"
+ ."\n"
+ .'This parameter corresponds to the Parent Nodes parameter that is displayed after you select Same Cycle in the Dependencies section of the Properties tab in the [DataWorks console](https://workbench.data.aliyun.com/console).'."\n"
+ ."\n"
+ .'> You must configure this parameter when you call the CreateDISyncTask or UpdateFile operation to create a batch synchronization task.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'docRequired' => false,
+ 'example' => 'project_root,project.file1,project.001_out',
+ ],
+ ],
+ [
+ 'name' => 'ProjectIdentifier',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The name of the DataWorks workspace. You can log on to the [DataWorks console](https://workbench.data.aliyun.com/console) and go to the Workspace Management page to obtain the workspace name.'."\n"
+ ."\n"
+ .'You must configure this parameter or the ProjectId parameter to determine the DataWorks workspace to which the operation is applied.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'dw_project',
+ ],
+ ],
+ [
+ 'name' => 'FileId',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The ID of the file. You can call the [ListFiles](~~173942~~) operation to obtain the ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => '100000001',
+ ],
+ ],
+ [
+ 'name' => 'OutputList',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The output name of the current file.'."\n"
+ ."\n"
+ .'This parameter corresponds to the Output Name parameter in the Dependencies section of the Properties tab in the [DataWorks console](https://workbench.data.aliyun.com/console).'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'dw_project.ods_user_info_d',
+ ],
+ ],
+ [
+ 'name' => 'ResourceGroupIdentifier',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The identifier of the resource group that is used to run the node. You can call the [ListResourceGroups](~~173913~~) operation to query the available resource groups in the workspace.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'default_group',
+ ],
+ ],
+ [
+ 'name' => 'ConnectionName',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The name of the connected data source that is used to run the node. You can call the [ListDataSources](~~211431~~) operation to query the available data sources of the workspace.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'odps_first',
+ ],
+ ],
+ [
+ 'name' => 'Owner',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The ID of the file owner.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => '18023848927592',
+ ],
+ ],
+ [
+ 'name' => 'AutoParsing',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'Specifies whether the automatic parsing feature is enabled for the file. Valid values:'."\n"
+ ."\n"
+ .'* true: The automatic parsing feature is enabled for the file.'."\n"
+ .'* false: The automatic parsing feature is not enabled for the file.'."\n"
+ ."\n"
+ .'This parameter corresponds to the Analyze Code parameter that is displayed after Same Cycle is selected in the Dependencies section of the Properties tab in the [DataWorks console](https://workbench.data.aliyun.com/console).'."\n",
+ 'type' => 'boolean',
+ 'required' => false,
+ 'example' => 'true',
+ ],
+ ],
+ [
+ 'name' => 'SchedulerType',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The scheduling type of the node. Valid values:'."\n"
+ ."\n"
+ .'* NORMAL: The node is an auto triggered node.'."\n"
+ .'* MANUAL: The node is a manually triggered node. Manually triggered nodes cannot be automatically triggered. They correspond to the nodes in the Manually Triggered Workflows pane.'."\n"
+ .'* PAUSE: The node is a paused node.'."\n"
+ .'* SKIP: The node is a dry-run node. Dry-run nodes are started as scheduled, but the system sets the status of the nodes to successful when it starts to run them.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'NORMAL',
+ 'enum' => [
+ 'NORMAL',
+ 'SKIP',
+ 'PAUSE',
+ 'MANUAL',
+ ],
+ ],
+ ],
+ [
+ 'name' => 'AdvancedSettings',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The advanced configurations of the node.'."\n"
+ ."\n"
+ .'This parameter is valid only for an EMR Spark Streaming node or an EMR Streaming SQL node. This parameter corresponds to the Advanced Settings tab of the node in the [DataWorks console](https://workbench.data.aliyun.com/console).'."\n"
+ ."\n"
+ .'This parameter is configured in the JSON format.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => '{"queue":"default","SPARK_CONF":"--conf spark.driver.memory=2g"}',
+ ],
+ ],
+ [
+ 'name' => 'StartImmediately',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'Specifies whether to immediately run a node after the node is deployed to the production environment. Valid values:'."\n"
+ ."\n"
+ .'* true: A node is immediately run after the node is deployed to the production environment.'."\n"
+ .'* false: A node is not immediately run after the node is deployed to the production environment.'."\n"
+ ."\n"
+ .'This parameter is valid only for an EMR Spark Streaming node or an EMR Streaming SQL node. This parameter corresponds to the Start Method parameter in the Schedule section of the Configure tab in the [DataWorks console](https://workbench.data.aliyun.com/console).'."\n",
+ 'type' => 'boolean',
+ 'required' => false,
+ 'example' => 'true',
+ ],
+ ],
+ [
+ 'name' => 'InputParameters',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The input parameters of the node. This parameter is configured in the JSON format. For more information about the input parameters, refer to the InputContextParameterList parameter in the Response parameters section of the [GetFile](~~173954~~) operation.'."\n"
+ ."\n"
+ .'This parameter corresponds to the Input Parameters table in the Input and Output Parameters section of the Properties tab in the [DataWorks console](https://workbench.data.aliyun.com/console).'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => '[{"ValueSource": "project_001.first_node:bizdate_param","ParameterName": "bizdate_input"}]',
+ ],
+ ],
+ [
+ 'name' => 'OutputParameters',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The output parameters of the node. This parameter is configured in the JSON format. For more information about the output parameters, refer to the OutputContextParameterList parameter in the Response parameters section of the [GetFile](~~173954~~) operation.'."\n"
+ ."\n"
+ .'This parameter corresponds to the Output Parameters table in the Input and Output Parameters section of the Properties tab in the [DataWorks console](https://workbench.data.aliyun.com/console).'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => '[{"Type": 1,"Value": "${bizdate}","ParameterName": "bizdate_param"}]',
+ ],
+ ],
+ [
+ 'name' => 'IgnoreParentSkipRunningProperty',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'Specifies whether to skip the dry-run property of the ancestor nodes of the node. This parameter corresponds to the Skip the dry-run property of the ancestor node parameter that is displayed after you configure the Depend On parameter in the Dependencies section of the Properties tab in the DataWorks console.'."\n",
+ 'type' => 'boolean',
+ 'required' => false,
+ 'example' => 'true',
+ ],
+ ],
+ [
+ 'name' => 'ApplyScheduleImmediately',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'Specifies whether scheduling configurations immediately take effect after the node is deployed.'."\n",
+ 'type' => 'boolean',
+ 'required' => false,
+ 'example' => 'true',
+ ],
+ ],
+ [
+ 'name' => 'Timeout',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The timeout period.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => false,
+ 'example' => '1',
+ ],
+ ],
+ [
+ 'name' => 'ImageId',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The ID of the custom image.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'm-uf6d7npxk1hhek8ng0cb',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'description' => '',
+ 'type' => 'object',
+ 'properties' => [
+ 'HttpStatusCode' => [
+ 'description' => 'The HTTP status code returned.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '200',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message returned.'."\n",
+ 'type' => 'string',
+ 'example' => 'The connection does not exist.',
+ ],
+ 'RequestId' => [
+ 'description' => 'The ID of the request. You can use the ID to troubleshoot issues.'."\n",
+ 'type' => 'string',
+ 'example' => '0000-ABCD-EFGH-IJKLMNOPQ',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code returned.'."\n",
+ 'type' => 'string',
+ 'example' => 'Invalid.Tenant.ConnectionNotExists',
+ ],
+ 'Success' => [
+ 'description' => 'Indicates whether the request is successful. Valid values:'."\n"
+ ."\n"
+ .'* true: The request is successful.'."\n"
+ .'* false: The request fails.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'errorCodes' => [
+ 403 => [
+ [
+ 'errorCode' => 'Forbidden.Access',
+ 'errorMessage' => 'Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.',
+ ],
+ ],
+ 429 => [
+ [
+ 'errorCode' => 'Throttling.Api',
+ 'errorMessage' => 'The request for this resource has exceeded your available limit.',
+ ],
+ [
+ 'errorCode' => 'Throttling.System',
+ 'errorMessage' => 'The DataWorks system is busy. Try again later.',
+ ],
+ [
+ 'errorCode' => 'Throttling.User',
+ 'errorMessage' => 'Your request is too frequent. Try again later.',
+ ],
+ ],
+ 500 => [
+ [
+ 'errorCode' => 'InternalError.System',
+ 'errorMessage' => 'An internal system error occurred. Try again later.',
+ ],
+ [
+ 'errorCode' => 'InternalError.UserId.Missing',
+ 'errorMessage' => 'An internal system error occurred. Try again later.',
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"ErrorMessage\\": \\"The connection does not exist.\\",\\n \\"RequestId\\": \\"0000-ABCD-EFGH-IJKLMNOPQ\\",\\n \\"ErrorCode\\": \\"Invalid.Tenant.ConnectionNotExists\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<UpdateFileResponse>\\n <HttpStatusCode>200</HttpStatusCode>\\n <ErrorMessage>The connection does not exist.</ErrorMessage>\\n <RequestId>0000-ABCD-EFGH-IJKLMNOPQ</RequestId>\\n <ErrorCode>Invalid.Tenant.ConnectionNotExists</ErrorCode>\\n <Success>true</Success>\\n</UpdateFileResponse>","errorExample":""}]',
+ 'title' => 'UpdateFile',
+ 'summary' => 'Updates a file.',
+ 'description' => 'When you debug or call this operation, you must specify new values for the specified parameters to ensure that the values are different from the original configurations of the file. For example, if the original value of a parameter is A, you must change the value of this parameter to B before you commit the node. If you set the parameter to A, an exception that indicates invalid data occurs.'."\n",
+ 'requestParamsDescription' => ' ',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ ],
+ 'GetFolder' => [
+ 'methods' => [
+ 'post',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'get',
+ 'abilityTreeCode' => '78248',
+ 'abilityTreeNodes' => [
+ 'FEATUREdide8FM783',
+ ],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'ProjectId',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The request ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'docRequired' => false,
+ 'example' => '1000011',
+ ],
+ ],
+ [
+ 'name' => 'ProjectIdentifier',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The error code.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'dw_project',
+ ],
+ ],
+ [
+ 'name' => 'FolderId',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'Indicates whether the request was successful.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'docRequired' => false,
+ 'example' => '273****',
+ ],
+ ],
+ [
+ 'name' => 'FolderPath',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The details of the folder.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'docRequired' => false,
+ 'example' => 'Business_process/my_first_business_process/MaxCompute/ods_layer',
+ 'minLength' => 1,
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'HttpStatusCode' => [
+ 'description' => 'The path of the folder.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '200',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The folder ID.'."\n",
+ 'type' => 'string',
+ 'example' => 'The connection does not exist.',
+ ],
+ 'RequestId' => [
+ 'description' => 'http://100.67.165.184/business/api/folders/detail',
+ 'type' => 'string',
+ 'example' => '0000-ABCD-EFG****',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'GetFolder',
+ 'type' => 'string',
+ 'example' => 'Invalid.Tenant.ConnectionNotExists',
+ ],
+ 'Success' => [
+ 'description' => '',
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'Data' => [
+ 'description' => '',
+ 'type' => 'object',
+ 'properties' => [
+ 'FolderPath' => [
+ 'description' => '',
+ 'type' => 'string',
+ 'example' => 'Business_process/my_first_business_process/MaxCompute/ods_layer',
+ ],
+ 'FolderId' => [
+ 'description' => '',
+ 'type' => 'string',
+ 'example' => '2735****',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'errorCodes' => [
+ 403 => [
+ [
+ 'errorCode' => 'Forbidden.Access',
+ 'errorMessage' => 'Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.',
+ ],
+ ],
+ 429 => [
+ [
+ 'errorCode' => 'Throttling.Api',
+ 'errorMessage' => 'The request for this resource has exceeded your available limit.',
+ ],
+ [
+ 'errorCode' => 'Throttling.System',
+ 'errorMessage' => 'The DataWorks system is busy. Try again later.',
+ ],
+ [
+ 'errorCode' => 'Throttling.User',
+ 'errorMessage' => 'Your request is too frequent. Try again later.',
+ ],
+ ],
+ 500 => [
+ [
+ 'errorCode' => 'InternalError.System',
+ 'errorMessage' => 'An internal system error occurred. Try again later.',
+ ],
+ [
+ 'errorCode' => 'InternalError.UserId.Missing',
+ 'errorMessage' => 'An internal system error occurred. Try again later.',
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"ErrorMessage\\": \\"The connection does not exist.\\",\\n \\"RequestId\\": \\"0000-ABCD-EFG****\\",\\n \\"ErrorCode\\": \\"Invalid.Tenant.ConnectionNotExists\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"FolderPath\\": \\"Business_process/my_first_business_process/MaxCompute/ods_layer\\",\\n \\"FolderId\\": \\"2735****\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"<RequestId>0000-ABCD-EFG****</RequestId>\\n<HttpStatusCode>200</HttpStatusCode>\\n<Data>\\n <FolderPath>业务流程/我的第一个业务流程/MaxCompute/ods层</FolderPath>\\n <FolderId>2735****</FolderId>\\n</Data>\\n<ErrorCode>Invalid.Tenant.ConnectionNotExists</ErrorCode>\\n<ErrorMessage>The connection does not exist.</ErrorMessage>\\n<Success>true</Success>","errorExample":""}]',
+ 'title' => 'GetFolder',
+ 'summary' => 'Queries the information about a folder.',
+ 'requestParamsDescription' => ' ',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ ],
+ 'ListFileVersions' => [
+ 'methods' => [
+ 'post',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'get',
+ 'abilityTreeCode' => '78312',
+ 'abilityTreeNodes' => [
+ 'FEATUREdide8FM783',
+ ],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'FileId',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The ID of the file. You can call the [ListFiles](~~173942~~) operation to query the ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => '100000001',
+ ],
+ ],
+ [
+ 'name' => 'ProjectId',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The DataWorks workspace ID. You can click the Workspace Manage icon in the upper-right corner of the DataStudio page to go to the Workspace page and view the workspace ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'docRequired' => false,
+ 'example' => '10000',
+ ],
+ ],
+ [
+ 'name' => 'ProjectIdentifier',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The unique identifier of the DataWorks workspace. You can click the identifier in the upper-left corner of the DataStudio page to switch to another workspace.'."\n"
+ ."\n"
+ .'You must specify either this parameter or ProjectId to determine the DataWorks workspace to which the operation is applied.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'dw_project',
+ ],
+ ],
+ [
+ 'name' => 'PageNumber',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The page number.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => false,
+ 'minimum' => '1',
+ 'example' => '1',
+ 'default' => '1',
+ ],
+ ],
+ [
+ 'name' => 'PageSize',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The number of entries per page. Default value: 10. Maximum value: 100.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => false,
+ 'docRequired' => false,
+ 'maximum' => '100',
+ 'minimum' => '0',
+ 'example' => '10',
+ 'default' => '10',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'HttpStatusCode' => [
+ 'description' => 'The HTTP status code returned.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '200',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message returned.'."\n",
+ 'type' => 'string',
+ 'example' => 'The connection does not exist.',
+ ],
+ 'RequestId' => [
+ 'description' => 'The ID of the request.'."\n",
+ 'type' => 'string',
+ 'example' => '0000-ABCD-EFG****',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code returned.'."\n",
+ 'type' => 'string',
+ 'example' => 'Invalid.Tenant.ConnectionNotExists',
+ ],
+ 'Success' => [
+ 'description' => 'Indicates whether the request is successful.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'Data' => [
+ 'description' => 'The file versions.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'PageNumber' => [
+ 'description' => 'The page number of the returned page.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '1',
+ ],
+ 'PageSize' => [
+ 'description' => 'The number of entries returned per page.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '10',
+ ],
+ 'TotalCount' => [
+ 'description' => 'The total number of entries returned.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '13',
+ ],
+ 'FileVersions' => [
+ 'description' => 'The details of file versions.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'FileContent' => [
+ 'description' => 'The code in the file of the current version.'."\n",
+ 'type' => 'string',
+ 'example' => 'SHOW TABLES;',
+ ],
+ 'Status' => [
+ 'description' => 'The status of the file of the current version. Valid values: COMMITTING, COMMITTED, CHECK_OK, PACKAGED, DEPLOYING, DEPLOYED, and CANCELLED.'."\n",
+ 'type' => 'string',
+ 'example' => 'COMMITTED',
+ ],
+ 'IsCurrentProd' => [
+ 'description' => 'Indicates whether the file version is the same as the latest file version in the production environment.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'false',
+ ],
+ 'CommitUser' => [
+ 'description' => 'The ID of the Alibaba Cloud account used to create the file of the current version.'."\n",
+ 'type' => 'string',
+ 'example' => '73842342****',
+ ],
+ 'NodeContent' => [
+ 'description' => 'The scheduling configurations for the node that corresponds to the file of the current version.'."\n",
+ 'type' => 'string',
+ 'example' => '{"cycleType":0,"cronExpress":"00 05 00 * * ?"}',
+ ],
+ 'Comment' => [
+ 'description' => 'The description of the file version.'."\n",
+ 'type' => 'string',
+ 'example' => 'Second version submission',
+ ],
+ 'FilePropertyContent' => [
+ 'description' => 'The basic information about the file of the current version.'."\n",
+ 'type' => 'string',
+ 'example' => '{"fileName":"ods_user_info_d","fileType":10}',
+ ],
+ 'FileName' => [
+ 'description' => 'The name of the file of the current version.'."\n",
+ 'type' => 'string',
+ 'example' => 'ods_user_info_d',
+ ],
+ 'UseType' => [
+ 'description' => 'The functional module to which the file belongs. Valid values: NORMAL, MANUAL, MANUAL_BIZ, SKIP, ADHOCQUERY, and COMPONENT. The value SKIP indicates that the node corresponding to the file is run in dry-run mode.'."\n",
+ 'type' => 'string',
+ 'example' => 'NORMAL',
+ ],
+ 'ChangeType' => [
+ 'description' => 'The type of the change to the file of the current version. Valid values: CREATE, UPDATE, and DELETE.'."\n",
+ 'type' => 'string',
+ 'example' => 'UPDATE',
+ ],
+ 'FileVersion' => [
+ 'description' => 'The version of the file.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '2',
+ ],
+ 'CommitTime' => [
+ 'description' => 'The time when the file version was created. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '1593881265000',
+ ],
+ 'NodeId' => [
+ 'description' => 'The ID of the auto triggered node that corresponds to the file of the current version.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '1234',
+ ],
+ ],
+ 'description' => '',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'description' => '',
+ ],
+ ],
+ ],
+ 'errorCodes' => [
+ 403 => [
+ [
+ 'errorCode' => 'Forbidden.Access',
+ 'errorMessage' => 'Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.',
+ ],
+ ],
+ 429 => [
+ [
+ 'errorCode' => 'Throttling.Api',
+ 'errorMessage' => 'The request for this resource has exceeded your available limit.',
+ ],
+ [
+ 'errorCode' => 'Throttling.System',
+ 'errorMessage' => 'The DataWorks system is busy. Try again later.',
+ ],
+ [
+ 'errorCode' => 'Throttling.User',
+ 'errorMessage' => 'Your request is too frequent. Try again later.',
+ ],
+ ],
+ 500 => [
+ [
+ 'errorCode' => 'InternalError.System',
+ 'errorMessage' => 'An internal system error occurred. Try again later.',
+ ],
+ [
+ 'errorCode' => 'InternalError.UserId.Missing',
+ 'errorMessage' => 'An internal system error occurred. Try again later.',
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"ErrorMessage\\": \\"The connection does not exist.\\",\\n \\"RequestId\\": \\"0000-ABCD-EFG****\\",\\n \\"ErrorCode\\": \\"Invalid.Tenant.ConnectionNotExists\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 13,\\n \\"FileVersions\\": [\\n {\\n \\"FileContent\\": \\"SHOW TABLES;\\",\\n \\"Status\\": \\"COMMITTED\\",\\n \\"IsCurrentProd\\": false,\\n \\"CommitUser\\": \\"73842342****\\",\\n \\"NodeContent\\": \\"{\\\\\\"cycleType\\\\\\":0,\\\\\\"cronExpress\\\\\\":\\\\\\"00 05 00 * * ?\\\\\\"}\\",\\n \\"Comment\\": \\"Second version submission\\",\\n \\"FilePropertyContent\\": \\"{\\\\\\"fileName\\\\\\":\\\\\\"ods_user_info_d\\\\\\",\\\\\\"fileType\\\\\\":10}\\",\\n \\"FileName\\": \\"ods_user_info_d\\",\\n \\"UseType\\": \\"NORMAL\\",\\n \\"ChangeType\\": \\"UPDATE\\",\\n \\"FileVersion\\": 2,\\n \\"CommitTime\\": 1593881265000,\\n \\"NodeId\\": 1234\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<RequestId>0000-ABCD-EFG****Q</RequestId>\\n<HttpStatusCode>200</HttpStatusCode>\\n<Data>\\n <TotalCount>13</TotalCount>\\n <FileVersions>\\n <Status>COMMITTED</Status>\\n <CommitUser>73842342****</CommitUser>\\n <Comment>第二次版本提交</Comment>\\n <CommitTime>1593881265000</CommitTime>\\n <FileName>ods_user_info_d</FileName>\\n <FilePropertyContent>{\\"fileName\\":\\"ods_user_info_d\\",\\"fileType\\":10}</FilePropertyContent>\\n <UseType>NORMAL</UseType>\\n <IsCurrentProd>false</IsCurrentProd>\\n <FileContent>SHOW TABLES;</FileContent>\\n <ChangeType>UPDATE</ChangeType>\\n <FileVersion>2</FileVersion>\\n <NodeId>3000001</NodeId>\\n <NodeContent>{\\"cycleType\\":0,\\"cronExpress\\":\\"00 05 00 * * ?\\"}</NodeContent>\\n </FileVersions>\\n <PageSize>10</PageSize>\\n <PageNumber>1</PageNumber>\\n</Data>\\n<Success>true</Success>","errorExample":""}]',
+ 'title' => 'ListFileVersions',
+ 'summary' => 'Queries a list of file versions.',
+ 'requestParamsDescription' => ' ',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ ],
+ 'GetFile' => [
+ 'methods' => [
+ 'post',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'get',
+ 'abilityTreeCode' => '78245',
+ 'abilityTreeNodes' => [
+ 'FEATUREdide8FM783',
+ ],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'ProjectId',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The ID of the DataWorks workspace. You can log on to the [DataWorks console](https://workbench.data.aliyun.com/console) and go to the Workspace Management page to obtain the workspace ID.'."\n"
+ ."\n"
+ .'You must configure this parameter or the ProjectIdentifier parameter to determine the DataWorks workspace to which the operation is applied.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'docRequired' => false,
+ 'example' => '10000',
+ ],
+ ],
+ [
+ 'name' => 'ProjectIdentifier',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The name of the DataWorks workspace. You can log on to the [DataWorks console](https://workbench.data.aliyun.com/console) and go to the Workspace Management page to obtain the workspace name.'."\n"
+ ."\n"
+ .'You must configure this parameter or the ProjectId parameter to determine the DataWorks workspace to which the operation is applied.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'dw_project',
+ ],
+ ],
+ [
+ 'name' => 'FileId',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The ID of the file. You can call the [ListFiles](~~173942~~) operation to obtain the ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'example' => '100000001',
+ ],
+ ],
+ [
+ 'name' => 'NodeId',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The ID of the node that is scheduled. You can call the [ListFiles](~~173942~~) operation to obtain the node ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'example' => '200000001',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'description' => 'The response parameters.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'HttpStatusCode' => [
+ 'description' => 'The HTTP status code returned.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '200',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message returned.'."\n",
+ 'type' => 'string',
+ 'example' => 'The connection does not exist.',
+ ],
+ 'RequestId' => [
+ 'description' => 'The ID of the request. You can use the ID to troubleshoot issues.'."\n",
+ 'type' => 'string',
+ 'example' => '0000-ABCD-EFG****',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code returned.'."\n",
+ 'type' => 'string',
+ 'example' => 'Invalid.Tenant.ConnectionNotExists',
+ ],
+ 'Success' => [
+ 'description' => 'Indicates whether the request is successful. Valid values:'."\n"
+ ."\n"
+ .'* true: The request is successful.'."\n"
+ .'* false: The request fails.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'Data' => [
+ 'description' => 'The details of the file.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'File' => [
+ 'description' => 'The basic information about the file.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'CommitStatus' => [
+ 'description' => 'Indicates whether the latest code in the file is committed. Valid values: 0 and 1. The value 0 indicates that the latest code in the file is not committed. The value 1 indicates that the latest code in the file is committed.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '0',
+ ],
+ 'AutoParsing' => [
+ 'description' => 'Indicates whether the automatic parsing feature is enabled for the file. Valid values:'."\n"
+ ."\n"
+ .'* true: The automatic parsing feature is enabled for the file.'."\n"
+ .'* false: The automatic parsing feature is not enabled for the file.'."\n"
+ ."\n"
+ .'This parameter corresponds to the Analyze Code parameter that is displayed after Same Cycle is selected in the Dependencies section of the Properties tab in the [DataWorks console](https://workbench.data.aliyun.com/console).'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'Owner' => [
+ 'description' => 'The ID of the Alibaba Cloud account used by the file owner.'."\n",
+ 'type' => 'string',
+ 'example' => '7775674356****',
+ ],
+ 'CreateTime' => [
+ 'description' => 'The time when the file was created. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '1593879116000',
+ ],
+ 'FileType' => [
+ 'description' => 'The type of the code for the file. The code for files varies based on the file type. For more information, see [DataWorks nodes](~~600169~~).'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '10',
+ ],
+ 'CurrentVersion' => [
+ 'description' => 'The latest version number of the file.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '3',
+ ],
+ 'BizId' => [
+ 'description' => 'The ID of the workflow to which the file belongs. This parameter is deprecated and replaced by the BusinessId parameter.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '1000001',
+ ],
+ 'LastEditUser' => [
+ 'description' => 'The ID of the Alibaba Cloud account used to last modify the file.'."\n",
+ 'type' => 'string',
+ 'example' => '62465892****',
+ ],
+ 'FileName' => [
+ 'description' => 'The name of the file.'."\n",
+ 'type' => 'string',
+ 'example' => 'ods_user_info_d',
+ ],
+ 'ConnectionName' => [
+ 'description' => 'The ID of the compute engine instance that is used to run the node that corresponds to the file.'."\n",
+ 'type' => 'string',
+ 'example' => 'odps_first',
+ ],
+ 'UseType' => [
+ 'description' => 'The module to which the file belongs. Valid values:'."\n"
+ ."\n"
+ .'* NORMAL: The file is used for DataStudio.'."\n"
+ .'* MANUAL: The file is used for a manually triggered node.'."\n"
+ .'* MANUAL_BIZ: The file is used for a manually triggered workflow.'."\n"
+ .'* SKIP: The file is used for a dry-run DataStudio node.'."\n"
+ .'* ADHOCQUERY: The file is used for an ad hoc query.'."\n"
+ .'* COMPONENT: The file is used for a snippet.'."\n",
+ 'type' => 'string',
+ 'example' => 'NORMAL',
+ ],
+ 'FileFolderId' => [
+ 'description' => 'The ID of the folder to which the file belongs.'."\n",
+ 'type' => 'string',
+ 'example' => '2735c2****',
+ ],
+ 'ParentId' => [
+ 'description' => 'The ID of the node group file to which the current file belongs. This parameter is returned only if the current file is an inner file of the node group file.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '-1',
+ ],
+ 'CreateUser' => [
+ 'description' => 'The ID of the Alibaba Cloud account used to create the file.'."\n",
+ 'type' => 'string',
+ 'example' => '424732****',
+ ],
+ 'IsMaxCompute' => [
+ 'description' => 'Indicates whether the file needs to be uploaded to MaxCompute.'."\n"
+ ."\n"
+ .'This parameter is returned only if the file is a MaxCompute resource file.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'BusinessId' => [
+ 'description' => 'The ID of the workflow to which the file belongs.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '1000001',
+ ],
+ 'FileDescription' => [
+ 'description' => 'The description of the file.'."\n",
+ 'type' => 'string',
+ 'example' => 'My first DataWorks file',
+ ],
+ 'DeletedStatus' => [
+ 'description' => 'The status of the file. Valid values:'."\n"
+ ."\n"
+ .'* NORMAL: The file is not deleted.'."\n"
+ .'* RECYCLE_BIN: The file is stored in the recycle bin.'."\n"
+ .'* DELETED: The file is deleted.'."\n",
+ 'type' => 'string',
+ 'example' => 'RECYCLE',
+ ],
+ 'LastEditTime' => [
+ 'description' => 'The time when the file was last modified. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '1593879116000',
+ ],
+ 'Content' => [
+ 'description' => 'The code in the file.'."\n",
+ 'type' => 'string',
+ 'example' => 'SHOW TABLES;',
+ ],
+ 'NodeId' => [
+ 'description' => 'The ID of the auto triggered node that is generated in the scheduling system after the file is committed.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '300001',
+ ],
+ 'AdvancedSettings' => [
+ 'description' => 'The advanced configurations of the node.'."\n"
+ ."\n"
+ .'This parameter is valid for an EMR node. This parameter corresponds to the Advanced Settings tab in the right-side navigation pane on the configuration tab of the node in the [DataWorks console](https://workbench.data.aliyun.com/console).'."\n"
+ ."\n"
+ .'> You cannot configure advanced parameters for EMR Shell nodes.'."\n"
+ ."\n"
+ .'For information about the advanced parameters of each type of EMR node, see [Develop EMR tasks](~~473077~~).'."\n",
+ 'type' => 'string',
+ 'example' => '{"queue":"default","SPARK_CONF":"--conf spark.driver.memory=2g"}',
+ ],
+ 'FileId' => [
+ 'description' => 'The ID of the file.',
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '100000001',
+ ],
+ ],
+ ],
+ 'NodeConfiguration' => [
+ 'description' => 'The scheduling configurations of the file.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'RerunMode' => [
+ 'description' => 'Indicates whether the node that corresponds to the file can be rerun. Valid values:'."\n"
+ ."\n"
+ .'* ALL_ALLOWED: The node can be rerun regardless of whether it is successfully run or fails to run.'."\n"
+ .'* FAILURE_ALLOWED: The node can be rerun only after it fails to run.'."\n"
+ .'* ALL_DENIED: The node cannot be rerun regardless of whether it is successfully run or fails to run.'."\n"
+ ."\n"
+ .'This parameter corresponds to the Rerun parameter in the Schedule section of the Properties tab in the [DataWorks console](https://workbench.data.aliyun.com/console).'."\n",
+ 'type' => 'string',
+ 'example' => 'ALL_ALLOWED',
+ ],
+ 'SchedulerType' => [
+ 'description' => 'The scheduling type of the node. Valid values:'."\n"
+ ."\n"
+ .'* NORMAL: The node is an auto triggered node.'."\n"
+ .'* MANUAL: The node is a manually triggered node. Manually triggered nodes cannot be automatically triggered. They correspond to the nodes in the Manually Triggered Workflows pane.'."\n"
+ .'* PAUSE: The node is a paused node.'."\n"
+ .'* SKIP: The node is a dry-run node. Dry-run nodes are started as scheduled but the system sets the status of the nodes to successful when it starts to run them.'."\n",
+ 'type' => 'string',
+ 'example' => 'NORMAL',
+ ],
+ 'Stop' => [
+ 'description' => 'Indicates whether the scheduling for the node is suspended Valid values:'."\n"
+ ."\n"
+ .'* true: The scheduling for the node is suspended.'."\n"
+ .'* false: The scheduling for the node is not suspended.'."\n"
+ ."\n"
+ .'This parameter corresponds to the Recurrence parameter in the Schedule section of the Properties tab in the [DataWorks console](https://workbench.data.aliyun.com/console).'."\n",
+ 'type' => 'boolean',
+ 'example' => 'false',
+ ],
+ 'ParaValue' => [
+ 'description' => 'The scheduling parameters of the node.'."\n"
+ ."\n"
+ .'This parameter corresponds to the Parameters section of the Properties tab in the [DataWorks console](https://workbench.data.aliyun.com/console). For more information about the configurations of the scheduling parameters, see [Configure scheduling parameters](~~137548~~).'."\n",
+ 'type' => 'string',
+ 'example' => 'a=x b=y',
+ ],
+ 'StartEffectDate' => [
+ 'description' => 'The start time of automatic scheduling. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.'."\n"
+ ."\n"
+ .'This parameter corresponds to the Validity Period parameter in the Schedule section of the Properties tab in the [DataWorks console](https://workbench.data.aliyun.com/console).'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '936923400000',
+ ],
+ 'EndEffectDate' => [
+ 'description' => 'The end time of automatic scheduling. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.'."\n"
+ ."\n"
+ .'This parameter corresponds to the Validity Period parameter in the Schedule section of the Properties tab in the [DataWorks console](https://workbench.data.aliyun.com/console).'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '4155787800000',
+ ],
+ 'CycleType' => [
+ 'description' => 'The type of the scheduling cycle. Valid values: NOT_DAY and DAY. The value NOT_DAY indicates that the node is scheduled to run by minute or hour. The value DAY indicates that the node is scheduled to run by day, week, or month.'."\n"
+ ."\n"
+ .'This parameter corresponds to the Scheduling Cycle parameter in the Schedule section of the Properties tab in the [DataWorks console](https://workbench.data.aliyun.com/console).'."\n",
+ 'type' => 'string',
+ 'example' => 'DAY',
+ ],
+ 'DependentNodeIdList' => [
+ 'description' => 'The ID of the node on which the node corresponding to the file depends when the DependentType parameter is set to USER_DEFINE. Multiple IDs are separated by commas (,).'."\n"
+ ."\n"
+ .'The value of this parameter is equivalent to the ID of the node that you specified after you select Previous Cycle and set Depend On to Other Nodes in the Dependencies section of the Properties tab in the [DataWorks console](https://workbench.data.aliyun.com/console).'."\n",
+ 'type' => 'string',
+ 'example' => '5,10,15,20',
+ ],
+ 'ResourceGroupId' => [
+ 'description' => 'The ID of the resource group that is used to run the node. You can call the [ListResourceGroups](~~173913~~) operation to query the available resource groups in the workspace.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '375827434852437',
+ ],
+ 'DependentType' => [
+ 'description' => 'The type of the cross-cycle scheduling dependency of the node. Valid values:'."\n"
+ ."\n"
+ .'* SELF: The instance generated for the node in the current cycle depends on the instance generated for the node in the previous cycle.'."\n"
+ .'* CHILD: The instance generated for the node in the current cycle depends on the instances generated for the descendant nodes at the nearest level of the node in the previous cycle.'."\n"
+ .'* USER_DEFINE: The instance generated for the node in the current cycle depends on the instances generated for one or more specified nodes in the previous cycle.'."\n"
+ .'* NONE: No cross-cycle scheduling dependency type is selected for the node.'."\n",
+ 'type' => 'string',
+ 'example' => 'USER_DEFINE',
+ ],
+ 'AutoRerunTimes' => [
+ 'description' => 'The number of automatic reruns that are allowed after an error occurs.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '3',
+ ],
+ 'AutoRerunIntervalMillis' => [
+ 'description' => 'The interval between automatic reruns after an error occurs. Unit: milliseconds.'."\n"
+ ."\n"
+ .'This parameter corresponds to the Rerun Interval parameter that is displayed after the Auto Rerun upon Error check box is selected in the Schedule section of the Properties tab in the [DataWorks console](https://workbench.data.aliyun.com/console).'."\n"
+ ."\n"
+ .'The interval that you specify in the DataWorks console is measured in minutes. Pay attention to the conversion between the units of time when you call the operation.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '120000',
+ ],
+ 'CronExpress' => [
+ 'description' => 'The CRON expression that represents the periodic scheduling policy of the node.'."\n",
+ 'type' => 'string',
+ 'example' => '00 05 00 * * ?',
+ ],
+ 'InputList' => [
+ 'description' => 'The output names of the parent files on which the current file depends.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '',
+ 'type' => 'object',
+ 'properties' => [
+ 'Input' => [
+ 'description' => 'The output name of the parent file on which the current file depends.'."\n"
+ ."\n"
+ .'This parameter corresponds to the Output Name of Ancestor Node parameter under Parent Nodes after Same Cycle is selected in the Dependencies section of the Properties tab in the [DataWorks console](https://workbench.data.aliyun.com/console).'."\n",
+ 'type' => 'string',
+ 'example' => 'project.001_out',
+ ],
+ 'ParseType' => [
+ 'description' => 'The mode of the configuration file dependency. Valid values:'."\n"
+ ."\n"
+ .'* MANUAL: Scheduling dependencies are manually configured.'."\n"
+ .'* AUTO: Scheduling dependencies are automatically parsed.'."\n",
+ 'type' => 'string',
+ 'example' => 'MANUAL',
+ ],
+ ],
+ ],
+ ],
+ 'OutputList' => [
+ 'description' => 'The output names of the current file.'."\n"
+ ."\n"
+ .'This parameter corresponds to the Output Name parameter under Output after Same Cycle is selected in the Dependencies section of the Properties tab in the [DataWorks console](https://workbench.data.aliyun.com/console).'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '',
+ 'type' => 'object',
+ 'properties' => [
+ 'RefTableName' => [
+ 'description' => 'The output table name of the current file.'."\n"
+ ."\n"
+ .'This parameter corresponds to the Output Table Name parameter under Output after Same Cycle is selected in the Dependencies section of the Properties tab in the [DataWorks console](https://workbench.data.aliyun.com/console).'."\n",
+ 'type' => 'string',
+ 'example' => 'ods_user_info_d',
+ ],
+ 'Output' => [
+ 'description' => 'The output name of the current file.'."\n"
+ ."\n"
+ .'This parameter corresponds to the Output Name parameter under Output after Same Cycle is selected in the Dependencies section of the Properties tab in the [DataWorks console](https://workbench.data.aliyun.com/console).'."\n",
+ 'type' => 'string',
+ 'example' => 'dw_project.002_out',
+ ],
+ ],
+ ],
+ ],
+ 'StartImmediately' => [
+ 'description' => 'Indicates whether a node is immediately run after the node is deployed to the production environment.'."\n"
+ ."\n"
+ .'This parameter is valid only for an EMR Spark Streaming node or an EMR Streaming SQL node. This parameter corresponds to the Start Method parameter in the Schedule section of the Configure tab in the [DataWorks console](https://workbench.data.aliyun.com/console).'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'InputParameters' => [
+ 'description' => 'Input parameters of the node.'."\n"
+ ."\n"
+ .'This parameter corresponds to the Input Parameters table in the Input and Output Parameters section of the Properties tab in the [DataWorks console](https://workbench.data.aliyun.com/console).'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '',
+ 'type' => 'object',
+ 'properties' => [
+ 'ParameterName' => [
+ 'description' => 'The name of the input parameter of the node. In the code, you can use the ${...} method to reference the input parameter of the node.'."\n"
+ ."\n"
+ .'This parameter corresponds to the Parameter Name parameter in the Input Parameters table in the Input and Output Parameters section of the Properties tab in the [DataWorks console](https://workbench.data.aliyun.com/console).'."\n",
+ 'type' => 'string',
+ 'example' => 'input',
+ ],
+ 'ValueSource' => [
+ 'description' => 'The value source of the input parameter of the node.'."\n"
+ ."\n"
+ .'This parameter corresponds to the Value Source parameter in the Input Parameters table in the Input and Output Parameters section of the Properties tab in the [DataWorks console](https://workbench.data.aliyun.com/console).'."\n",
+ 'type' => 'string',
+ 'example' => 'project_001.parent_node:outputs',
+ ],
+ ],
+ ],
+ ],
+ 'OutputParameters' => [
+ 'description' => 'Output parameters of the node.'."\n"
+ ."\n"
+ .'This parameter corresponds to the Output Parameters table in the Input and Output Parameters section of the Properties tab in the [DataWorks console](https://workbench.data.aliyun.com/console).'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '',
+ 'type' => 'object',
+ 'properties' => [
+ 'ParameterName' => [
+ 'description' => 'The name of the output parameter of the node.'."\n"
+ ."\n"
+ .'This parameter corresponds to the Parameter Name parameter in the Output Parameters table in the Input and Output Parameters section of the Properties tab in the [DataWorks console](https://workbench.data.aliyun.com/console).'."\n",
+ 'type' => 'string',
+ 'example' => 'output',
+ ],
+ 'Value' => [
+ 'description' => 'The value of the output parameter of the node.'."\n"
+ ."\n"
+ .'This parameter corresponds to the Value parameter in the Output Parameters table in the Input and Output Parameters section of the Properties tab in the [DataWorks console](https://workbench.data.aliyun.com/console).'."\n",
+ 'type' => 'string',
+ 'example' => '${bizdate}',
+ ],
+ 'Type' => [
+ 'description' => 'The type of the output parameter of the node. Valid values:'."\n"
+ ."\n"
+ .'* 1: indicates a constant.'."\n"
+ .'* 2: indicates a variable.'."\n"
+ .'* 3: indicates a pass-through variable.'."\n"
+ ."\n"
+ .'This parameter corresponds to the Type parameter in the Output Parameters table in the Input and Output Parameters section of the Properties tab in the [DataWorks console](https://workbench.data.aliyun.com/console).'."\n",
+ 'type' => 'string',
+ 'example' => '1',
+ ],
+ 'Description' => [
+ 'description' => 'The description of the output parameter of the node.'."\n",
+ 'type' => 'string',
+ 'example' => 'It\'s a context output parameter.',
+ ],
+ ],
+ ],
+ ],
+ 'ApplyScheduleImmediately' => [
+ 'description' => 'Indicates whether scheduling configurations immediately take effect after the deployment.'."\n",
+ 'type' => 'string',
+ 'example' => 'true',
+ ],
+ 'IgnoreParentSkipRunningProperty' => [
+ 'description' => 'Indicates whether to skip the dry-run property of the ancestor nodes of the node that corresponds to the file. This parameter corresponds to the Skip the dry-run property of the ancestor node parameter that is displayed after you configure the Depend On parameter in the Dependencies section of the Properties tab in the DataWorks console.'."\n",
+ 'type' => 'string',
+ 'example' => 'true',
+ ],
+ 'Timeout' => [
+ 'description' => 'The timeout period.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '1',
+ ],
+ 'ImageId' => [
+ 'description' => 'The ID of the custom image.'."\n",
+ 'type' => 'string',
+ 'example' => 'm-bp1h4b5a8ogkbll2f3tr',
+ ],
+ ],
+ ],
+ 'ResourceDownloadLink' => [
+ 'description' => 'The download URL of the resource.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'downloadLink' => [
+ 'description' => 'The download URL of the resource.'."\n",
+ 'type' => 'string',
+ 'example' => 'http://xx',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'errorCodes' => [
+ 403 => [
+ [
+ 'errorCode' => 'Forbidden.Access',
+ 'errorMessage' => 'Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.',
+ ],
+ ],
+ 429 => [
+ [
+ 'errorCode' => 'Throttling.Api',
+ 'errorMessage' => 'The request for this resource has exceeded your available limit.',
+ ],
+ [
+ 'errorCode' => 'Throttling.System',
+ 'errorMessage' => 'The DataWorks system is busy. Try again later.',
+ ],
+ [
+ 'errorCode' => 'Throttling.User',
+ 'errorMessage' => 'Your request is too frequent. Try again later.',
+ ],
+ ],
+ 500 => [
+ [
+ 'errorCode' => 'InternalError.System',
+ 'errorMessage' => 'An internal system error occurred. Try again later.',
+ ],
+ [
+ 'errorCode' => 'InternalError.UserId.Missing',
+ 'errorMessage' => 'An internal system error occurred. Try again later.',
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"ErrorMessage\\": \\"The connection does not exist.\\",\\n \\"RequestId\\": \\"0000-ABCD-EFG****\\",\\n \\"ErrorCode\\": \\"Invalid.Tenant.ConnectionNotExists\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"File\\": {\\n \\"CommitStatus\\": 0,\\n \\"AutoParsing\\": true,\\n \\"Owner\\": \\"7775674356****\\",\\n \\"CreateTime\\": 1593879116000,\\n \\"FileType\\": 10,\\n \\"CurrentVersion\\": 3,\\n \\"BizId\\": 1000001,\\n \\"LastEditUser\\": \\"62465892****\\",\\n \\"FileName\\": \\"ods_user_info_d\\",\\n \\"ConnectionName\\": \\"odps_source\\",\\n \\"UseType\\": \\"NORMAL\\",\\n \\"FileFolderId\\": \\"2735c2****\\",\\n \\"ParentId\\": -1,\\n \\"CreateUser\\": \\"424732****\\",\\n \\"IsMaxCompute\\": true,\\n \\"BusinessId\\": 1000001,\\n \\"FileDescription\\": \\"My first DataWorks file\\",\\n \\"DeletedStatus\\": \\"RECYCLE\\",\\n \\"LastEditTime\\": 1593879116000,\\n \\"Content\\": \\"SHOW TABLES;\\",\\n \\"NodeId\\": 300001,\\n \\"AdvancedSettings\\": \\"{\\\\\\\\\\\\\\"priority\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"1\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"ENABLE_SPARKSQL_JDBC\\\\\\\\\\\\\\":false,\\\\\\\\\\\\\\"FLOW_SKIP_SQL_ANALYZE\\\\\\\\\\\\\\":false,\\\\\\\\\\\\\\"queue\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"default\\\\\\\\\\\\\\"}\\",\\n \\"FileId\\": 100000001\\n },\\n \\"NodeConfiguration\\": {\\n \\"RerunMode\\": \\"ALL_ALLOWED\\",\\n \\"SchedulerType\\": \\"NORMAL\\",\\n \\"Stop\\": false,\\n \\"ParaValue\\": \\"a=x b=y\\",\\n \\"StartEffectDate\\": 936923400000,\\n \\"EndEffectDate\\": 4155787800000,\\n \\"CycleType\\": \\"DAY\\",\\n \\"DependentNodeIdList\\": \\"5,10,15,20\\",\\n \\"ResourceGroupId\\": 375827434852437,\\n \\"DependentType\\": \\"USER_DEFINE\\",\\n \\"AutoRerunTimes\\": 3,\\n \\"AutoRerunIntervalMillis\\": 120000,\\n \\"CronExpress\\": \\"00 05 00 * * ?\\",\\n \\"InputList\\": [\\n {\\n \\"Input\\": \\"project.001_out\\",\\n \\"ParseType\\": \\"MANUAL\\"\\n }\\n ],\\n \\"OutputList\\": [\\n {\\n \\"RefTableName\\": \\"ods_user_info_d\\",\\n \\"Output\\": \\"dw_project.002_out\\"\\n }\\n ],\\n \\"StartImmediately\\": true,\\n \\"InputParameters\\": [\\n {\\n \\"ParameterName\\": \\"input\\",\\n \\"ValueSource\\": \\"project_001.parent_node:outputs\\"\\n }\\n ],\\n \\"OutputParameters\\": [\\n {\\n \\"ParameterName\\": \\"output\\",\\n \\"Value\\": \\"${bizdate}\\",\\n \\"Type\\": \\"1\\",\\n \\"Description\\": \\"It\'s a context output parameter.\\"\\n }\\n ],\\n \\"ApplyScheduleImmediately\\": \\"true\\",\\n \\"IgnoreParentSkipRunningProperty\\": \\"true\\",\\n \\"Timeout\\": 1,\\n \\"ImageId\\": \\"m-bp1h4b5a8ogkbll2f3tr\\"\\n },\\n \\"ResourceDownloadLink\\": {\\n \\"downloadLink\\": \\"http://xx\\"\\n }\\n }\\n}","errorExample":""},{"type":"xml","example":"<GetFileResponse>\\n <HttpStatusCode>200</HttpStatusCode>\\n <ErrorMessage>The connection does not exist.</ErrorMessage>\\n <RequestId>0000-ABCD-EFG****</RequestId>\\n <ErrorCode>Invalid.Tenant.ConnectionNotExists</ErrorCode>\\n <Success>true</Success>\\n <Data>\\n <File>\\n <CommitStatus>0</CommitStatus>\\n <AutoParsing>true</AutoParsing>\\n <Owner>7775674356****</Owner>\\n <CreateTime>1593879116000</CreateTime>\\n <FileType>10</FileType>\\n <CurrentVersion>3</CurrentVersion>\\n <BizId>1000001</BizId>\\n <LastEditUser>62465892****</LastEditUser>\\n <FileName>ods_user_info_d</FileName>\\n <ConnectionName>odps_source</ConnectionName>\\n <UseType>NORMAL</UseType>\\n <FileFolderId>2735c2****</FileFolderId>\\n <ParentId>-1</ParentId>\\n <CreateUser>424732****</CreateUser>\\n <IsMaxCompute>true</IsMaxCompute>\\n <BusinessId>1000001</BusinessId>\\n <FileDescription>我的第一个Dataworks文件</FileDescription>\\n <DeletedStatus>RECYCLE</DeletedStatus>\\n <LastEditTime>1593879116000</LastEditTime>\\n <Content>SHOW TABLES;</Content>\\n <NodeId>300001</NodeId>\\n <AdvancedSettings>{\\"queue\\":\\"default\\",\\"SPARK_CONF\\":\\"--conf spark.driver.memory=2g\\"}</AdvancedSettings>\\n <FileId>100000001</FileId>\\n </File>\\n <NodeConfiguration>\\n <RerunMode>ALL_ALLOWED</RerunMode>\\n <SchedulerType>NORMAL</SchedulerType>\\n <Stop>false</Stop>\\n <ParaValue>a=x b=y</ParaValue>\\n <StartEffectDate>936923400000</StartEffectDate>\\n <EndEffectDate>4155787800000</EndEffectDate>\\n <CycleType>DAY</CycleType>\\n <DependentNodeIdList>5,10,15,20</DependentNodeIdList>\\n <ResourceGroupId>375827434852437</ResourceGroupId>\\n <DependentType>USER_DEFINE</DependentType>\\n <AutoRerunTimes>3</AutoRerunTimes>\\n <AutoRerunIntervalMillis>120000</AutoRerunIntervalMillis>\\n <CronExpress>00 05 00 * * ?</CronExpress>\\n <InputList>\\n <Input>project.001_out</Input>\\n <ParseType>MANUAL</ParseType>\\n </InputList>\\n <OutputList>\\n <RefTableName>ods_user_info_d</RefTableName>\\n <Output>dw_project.002_out</Output>\\n </OutputList>\\n <StartImmediately>true</StartImmediately>\\n <InputParameters>\\n <ParameterName>input</ParameterName>\\n <ValueSource>project_001.parent_node:outputs</ValueSource>\\n </InputParameters>\\n <OutputParameters>\\n <ParameterName>output</ParameterName>\\n <Value>${bizdate}</Value>\\n <Type>1</Type>\\n <Description>It\'s a context output parameter.</Description>\\n </OutputParameters>\\n </NodeConfiguration>\\n </Data>\\n</GetFileResponse>","errorExample":""}]',
+ 'title' => 'GetFile',
+ 'summary' => 'Queries the information about a file.',
+ 'requestParamsDescription' => ' ',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ ],
+ 'ListFolders' => [
+ 'methods' => [
+ 'post',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'get',
+ 'abilityTreeCode' => '78313',
+ 'abilityTreeNodes' => [
+ 'FEATUREdide8FM783',
+ ],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'ProjectId',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The error message.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'docRequired' => false,
+ 'example' => '10000',
+ ],
+ ],
+ [
+ 'name' => 'ProjectIdentifier',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The request ID. You can troubleshoot issues based on the ID.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'dw_project',
+ ],
+ ],
+ [
+ 'name' => 'ParentFolderPath',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => '0000-ABCD-EFG****',
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'Business_process/my_first_business_process/MaxCompute',
+ ],
+ ],
+ [
+ 'name' => 'PageNumber',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The error code.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => true,
+ 'docRequired' => true,
+ 'minimum' => '1',
+ 'example' => '1',
+ ],
+ ],
+ [
+ 'name' => 'PageSize',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'Indicates whether the request was successful.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => true,
+ 'docRequired' => true,
+ 'maximum' => '100',
+ 'minimum' => '0',
+ 'example' => '10',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'HttpStatusCode' => [
+ 'description' => 'The information about the folders.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '200',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The page number.'."\n",
+ 'type' => 'string',
+ 'example' => 'The connection does not exist.',
+ ],
+ 'RequestId' => [
+ 'description' => 'The number of entries per page.'."\n",
+ 'type' => 'string',
+ 'example' => '0000-ABCD-****',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The total number of entries returned.'."\n",
+ 'type' => 'string',
+ 'example' => 'Invalid.Tenant.ConnectionNotExists',
+ ],
+ 'Success' => [
+ 'description' => 'The list of folders.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'Data' => [
+ 'description' => 'The path of the folder.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'PageNumber' => [
+ 'description' => 'The folder ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '1',
+ ],
+ 'PageSize' => [
+ 'description' => 'http://100.67.165.184/business/api/folders/list',
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '10',
+ ],
+ 'TotalCount' => [
+ 'description' => 'ListFolders',
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '13',
+ ],
+ 'Folders' => [
+ 'description' => '',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'FolderPath' => [
+ 'description' => '',
+ 'type' => 'string',
+ 'example' => 'Business_process/my_first_business_process/MaxCompute/ods_layer',
+ ],
+ 'FolderId' => [
+ 'description' => '',
+ 'type' => 'string',
+ 'example' => '2735c2****',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'errorCodes' => [
+ 403 => [
+ [
+ 'errorCode' => 'Forbidden.Access',
+ 'errorMessage' => 'Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.',
+ ],
+ ],
+ 429 => [
+ [
+ 'errorCode' => 'Throttling.Api',
+ 'errorMessage' => 'The request for this resource has exceeded your available limit.',
+ ],
+ [
+ 'errorCode' => 'Throttling.System',
+ 'errorMessage' => 'The DataWorks system is busy. Try again later.',
+ ],
+ [
+ 'errorCode' => 'Throttling.User',
+ 'errorMessage' => 'Your request is too frequent. Try again later.',
+ ],
+ ],
+ 500 => [
+ [
+ 'errorCode' => 'InternalError.System',
+ 'errorMessage' => 'An internal system error occurred. Try again later.',
+ ],
+ [
+ 'errorCode' => 'InternalError.UserId.Missing',
+ 'errorMessage' => 'An internal system error occurred. Try again later.',
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"ErrorMessage\\": \\"The connection does not exist.\\",\\n \\"RequestId\\": \\"0000-ABCD-****\\",\\n \\"ErrorCode\\": \\"Invalid.Tenant.ConnectionNotExists\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 13,\\n \\"Folders\\": [\\n {\\n \\"FolderPath\\": \\"Business_process/my_first_business_process/MaxCompute/ods_layer\\",\\n \\"FolderId\\": \\"2735c2****\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<RequestId>0000-ABCD-EFG****</RequestId>\\n<HttpStatusCode>200</HttpStatusCode>\\n<Data>\\n <TotalCount>13</TotalCount>\\n <PageSize>10</PageSize>\\n <PageNumber>1</PageNumber>\\n <Folders>\\n <FolderPath>业务流程/我的第一个业务流程/MaxCompute/ods层</FolderPath>\\n <FolderId>2735c2****</FolderId>\\n </Folders>\\n</Data>\\n<ErrorCode>Invalid.Tenant.ConnectionNotExists</ErrorCode>\\n<ErrorMessage>The connection does not exist.</ErrorMessage>\\n<Success>true</Success>","errorExample":""}]',
+ 'title' => 'ListFolders',
+ 'summary' => 'Queries a list of folders.',
+ 'requestParamsDescription' => ' ',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ ],
+ 'DeployFile' => [
+ 'methods' => [
+ 'post',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'readAndWrite',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'update',
+ 'abilityTreeCode' => '78223',
+ 'abilityTreeNodes' => [
+ 'FEATUREdide8FM783',
+ ],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'ProjectId',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The ID of the DataWorks workspace. You can log on to the DataWorks console and go to the Workspace Management page to obtain the workspace ID. You must configure either this parameter or the ProjectIdentifier parameter to determine the DataWorks workspace to which the operation is applied.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'docRequired' => false,
+ 'example' => '10000',
+ ],
+ ],
+ [
+ 'name' => 'ProjectIdentifier',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The name of the DataWorks workspace. You can log on to the DataWorks console and go to the Workspace Management page to obtain the workspace name. You must configure either this parameter or the ProjectId parameter to determine the DataWorks workspace to which the operation is applied.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'dw_project',
+ ],
+ ],
+ [
+ 'name' => 'FileId',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The file ID. You can call the [ListFiles](~~173942~~) operation to query the file ID. You must configure either this parameter or the NodeId parameter.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'docRequired' => true,
+ 'example' => '10000001',
+ ],
+ ],
+ [
+ 'name' => 'Comment',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The description of the deployment operation.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'First release task',
+ ],
+ ],
+ [
+ 'name' => 'NodeId',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The ID of the node in the scheduling system that corresponds to the file that you want to deploy. You must configure either the NodeId parameter or the FileId parameter.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'example' => '2000001',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'description' => '',
+ 'type' => 'object',
+ 'properties' => [
+ 'HttpStatusCode' => [
+ 'description' => 'The HTTP status code returned.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '200',
+ ],
+ 'Data' => [
+ 'description' => 'The ID of the deployment task. The ID is used as the value of a specific request parameter when you call the [GetDeployment](~~173950~~) operation to query the details of the deployment task.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '30000001',
+ ],
+ 'RequestId' => [
+ 'description' => 'The ID of the request. You can troubleshoot issues based on the ID.'."\n",
+ 'type' => 'string',
+ 'example' => '0000-ABCD-EFG****',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message returned.'."\n",
+ 'type' => 'string',
+ 'example' => 'The connection does not exist.',
+ ],
+ 'Success' => [
+ 'description' => 'Indicates whether the request is successful.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code returned.'."\n",
+ 'type' => 'string',
+ 'example' => 'Invalid.Tenant.ConnectionNotExists',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'errorCodes' => [
+ 403 => [
+ [
+ 'errorCode' => 'Forbidden.Access',
+ 'errorMessage' => 'Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.',
+ ],
+ ],
+ 429 => [
+ [
+ 'errorCode' => 'Throttling.Api',
+ 'errorMessage' => 'The request for this resource has exceeded your available limit.',
+ ],
+ [
+ 'errorCode' => 'Throttling.System',
+ 'errorMessage' => 'The DataWorks system is busy. Try again later.',
+ ],
+ [
+ 'errorCode' => 'Throttling.User',
+ 'errorMessage' => 'Your request is too frequent. Try again later.',
+ ],
+ ],
+ 500 => [
+ [
+ 'errorCode' => 'InternalError.System',
+ 'errorMessage' => 'An internal system error occurred. Try again later.',
+ ],
+ [
+ 'errorCode' => 'InternalError.UserId.Missing',
+ 'errorMessage' => 'An internal system error occurred. Try again later.',
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Data\\": 30000001,\\n \\"RequestId\\": \\"0000-ABCD-EFG****\\",\\n \\"ErrorMessage\\": \\"The connection does not exist.\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"Invalid.Tenant.ConnectionNotExists\\"\\n}","errorExample":""},{"type":"xml","example":"<DeployFileResponse>\\n <HttpStatusCode>200</HttpStatusCode>\\n <Data>30000001</Data>\\n <RequestId>0000-ABCD-EFG****</RequestId>\\n <ErrorMessage>The connection does not exist.</ErrorMessage>\\n <Success>true</Success>\\n <ErrorCode>Invalid.Tenant.ConnectionNotExists</ErrorCode>\\n</DeployFileResponse>","errorExample":""}]',
+ 'title' => 'DeployFile',
+ 'summary' => 'Deploys a file to the production environment.',
+ 'requestParamsDescription' => ' ',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ ],
+ 'UpdateUdfFile' => [
+ 'methods' => [
+ 'post',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'readAndWrite',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'update',
+ 'abilityTreeCode' => '78387',
+ 'abilityTreeNodes' => [
+ 'FEATUREdide8FM783',
+ ],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'FileFolderPath',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The path of the folder in which the function file is stored.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'docRequired' => false,
+ 'example' => 'Business_process/First_Business_Process/function/string_processing_function',
+ ],
+ ],
+ [
+ 'name' => 'ProjectId',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The ID of the DataWorks workspace. You can click the Workspace Manage icon in the upper-right corner of the DataStudio page to go to the Workspace Management page and view the workspace ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'docRequired' => false,
+ 'example' => '10000',
+ ],
+ ],
+ [
+ 'name' => 'FunctionType',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The type of the function. Valid values: MATH, AGGREGATE, STRING, DATE, ANALYTIC, and OTHER. This parameter corresponds to the Function Type parameter in the Register Function section of the configuration tab of the function on the DataStudio page.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'enumValueTitles' => [],
+ 'example' => 'STRING',
+ 'enum' => [
+ 'MATH',
+ 'AGGREGATE',
+ 'STRING',
+ 'DATE',
+ 'ANALYTIC',
+ 'OTHER',
+ ],
+ ],
+ ],
+ [
+ 'name' => 'ClassName',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The name of the class in which the function is defined. This parameter corresponds to the Class Name parameter in the Register Function section of the configuration tab of the function in the DataWorks console.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'com.alibaba.DataWorks.api.udf.StringConcat',
+ ],
+ ],
+ [
+ 'name' => 'Resources',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The names of the resources that are referenced by the function. This parameter corresponds to the Resources parameter in the Register Function section of the configuration tab of the function in the DataWorks console. Separate multiple resource names with commas (,).'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'string-concat-1.0.0.jar,commons-lang-2.6.jar',
+ ],
+ ],
+ [
+ 'name' => 'UdfDescription',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The description of the function. This parameter corresponds to the Description parameter in the Register Function section of the configuration tab of the function on the DataStudio page.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'docRequired' => false,
+ 'example' => 'Concatenate several strings to generate a new string',
+ ],
+ ],
+ [
+ 'name' => 'CmdDescription',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The syntax used for calling the function. This parameter corresponds to the Expression Syntax parameter in the Register Function section of the configuration tab of the function in the DataWorks console.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'StringConcat(String... substrs)',
+ ],
+ ],
+ [
+ 'name' => 'ParameterDescription',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The description of the input parameters of the function. This parameter corresponds to the Parameter Description parameter in the Register Function section of the configuration tab of the function on the DataStudio page.'."\n"
+ ."\n"
+ .'Valid values:'."\n"
+ ."\n"
+ .'* ALL_ALLOWD'."\n"
+ .'* FAILURE_ALLOWED'."\n"
+ .'* ALL_DENIED'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'enumValueTitles' => [],
+ 'example' => 'List of strings to be connected',
+ 'default' => 'ALL_ALLOWED',
+ 'enum' => [
+ 'ALL_ALLOWD',
+ 'FAILURE_ALLOWED',
+ 'ALL_DENIED',
+ ],
+ ],
+ ],
+ [
+ 'name' => 'ReturnValue',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The description of the return value of the function. This parameter corresponds to the Return Value parameter in the Register Function section of the configuration tab of the function on the DataStudio page.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'New strings generated by concatenating all strings before and after the input order',
+ 'default' => 'false',
+ ],
+ ],
+ [
+ 'name' => 'Example',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The example for calling the function. This parameter corresponds to the Example parameter in the Register Function section of the configuration tab of the function in the DataWorks console.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'StringConcat(\'a\', \'b\', \'c\')',
+ ],
+ ],
+ [
+ 'name' => 'ProjectIdentifier',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The unique identifier of the DataWorks workspace. You can click the identifier in the upper-left corner of the DataStudio page to switch to another workspace.'."\n"
+ ."\n"
+ .'You must specify either this parameter or ProjectId to determine the DataWorks workspace to which the operation is applied.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'dw_project',
+ ],
+ ],
+ [
+ 'name' => 'FileId',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The file ID.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => '10000001',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'HttpStatusCode' => [
+ 'description' => 'The HTTP status code returned.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '200',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message returned.'."\n",
+ 'type' => 'string',
+ 'example' => 'The connection does not exist.',
+ ],
+ 'RequestId' => [
+ 'description' => 'The ID of the request. You can troubleshoot issues based on the ID.'."\n",
+ 'type' => 'string',
+ 'example' => '0000-ABCD-EFG****',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code returned.'."\n",
+ 'type' => 'string',
+ 'example' => 'Invalid.Tenant.ConnectionNotExists',
+ ],
+ 'Success' => [
+ 'description' => 'Indicates whether the request is successful.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'errorCodes' => [
+ 403 => [
+ [
+ 'errorCode' => 'Forbidden.Access',
+ 'errorMessage' => 'Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.',
+ ],
+ ],
+ 429 => [
+ [
+ 'errorCode' => 'Throttling.Api',
+ 'errorMessage' => 'The request for this resource has exceeded your available limit.',
+ ],
+ [
+ 'errorCode' => 'Throttling.System',
+ 'errorMessage' => 'The DataWorks system is busy. Try again later.',
+ ],
+ [
+ 'errorCode' => 'Throttling.User',
+ 'errorMessage' => 'Your request is too frequent. Try again later.',
+ ],
+ ],
+ 500 => [
+ [
+ 'errorCode' => 'InternalError.System',
+ 'errorMessage' => 'An internal system error occurred. Try again later.',
+ ],
+ [
+ 'errorCode' => 'InternalError.UserId.Missing',
+ 'errorMessage' => 'An internal system error occurred. Try again later.',
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"ErrorMessage\\": \\"The connection does not exist.\\",\\n \\"RequestId\\": \\"0000-ABCD-EFG****\\",\\n \\"ErrorCode\\": \\"Invalid.Tenant.ConnectionNotExists\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<RequestId>0000-ABCD-EFG****</RequestId>\\n<HttpStatusCode>200</HttpStatusCode>\\n<Success>true</Success>","errorExample":""}]',
+ 'title' => 'UpdateUdfFile',
+ 'summary' => 'Updates the file information about a function.',
+ 'requestParamsDescription' => ' ',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ ],
+ 'GetBusiness' => [
+ 'methods' => [
+ 'post',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'get',
+ 'abilityTreeCode' => '78232',
+ 'abilityTreeNodes' => [
+ 'FEATUREdide8FM783',
+ ],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'ProjectId',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The ID of the DataWorks workspace. You can log on to the DataWorks console and go to the Workspace Management page to obtain the ID. You must specify either this parameter or ProjectIdentifier to determine the DataWorks workspace to which the operation is applied.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'docRequired' => false,
+ 'example' => '10000',
+ ],
+ ],
+ [
+ 'name' => 'ProjectIdentifier',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The name of the DataWorks workspace. You can log on to the DataWorks console and go to the Workspace Settings panel to obtain the name. You must specify either this parameter or ProjectId to determine the DataWorks workspace to which the operation is applied.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'dw_project',
+ ],
+ ],
+ [
+ 'name' => 'BusinessId',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The workflow ID. You can call the [ListBusiness](~~173945~~) operation to query the ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => '1000000001',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'HttpStatusCode' => [
+ 'description' => 'The HTTP status code returned.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '200',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message returned.'."\n",
+ 'type' => 'string',
+ 'example' => 'The connection does not exist.',
+ ],
+ 'RequestId' => [
+ 'description' => 'The ID of the request. You can use the ID to troubleshoot issues.'."\n",
+ 'type' => 'string',
+ 'example' => '0000-ABCD-EFG****',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code returned.'."\n",
+ 'type' => 'string',
+ 'example' => 'Invalid.Tenant.ConnectionNotExists',
+ ],
+ 'Success' => [
+ 'description' => 'Indicates whether the request is successful.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'Data' => [
+ 'description' => 'The details of the workflow.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'Owner' => [
+ 'description' => 'The Alibaba Cloud account ID of the workflow owner.'."\n",
+ 'type' => 'string',
+ 'example' => '20000****',
+ ],
+ 'Description' => [
+ 'description' => 'The description of the workflow.'."\n",
+ 'type' => 'string',
+ 'example' => 'This is my first business process.',
+ ],
+ 'ProjectId' => [
+ 'description' => 'The ID of the workspace to which the workflow belongs.'."\n",
+ 'type' => 'string',
+ 'example' => '10000',
+ ],
+ 'BusinessId' => [
+ 'description' => 'The ID of the workflow.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '1000001',
+ ],
+ 'BusinessName' => [
+ 'description' => 'The name of the workflow.'."\n",
+ 'type' => 'string',
+ 'example' => 'The first business process',
+ ],
+ 'UseType' => [
+ 'description' => 'The module to which the workflow belongs. Valid values: NORMAL and MANUAL_BIZ.'."\n",
+ 'type' => 'string',
+ 'example' => 'NORMAL',
+ ],
+ ],
+ ],
+ ],
+ 'description' => '',
+ ],
+ ],
+ ],
+ 'errorCodes' => [
+ 403 => [
+ [
+ 'errorCode' => 'Forbidden.Access',
+ 'errorMessage' => 'Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.',
+ ],
+ ],
+ 429 => [
+ [
+ 'errorCode' => 'Throttling.Api',
+ 'errorMessage' => 'The request for this resource has exceeded your available limit.',
+ ],
+ [
+ 'errorCode' => 'Throttling.System',
+ 'errorMessage' => 'The DataWorks system is busy. Try again later.',
+ ],
+ [
+ 'errorCode' => 'Throttling.User',
+ 'errorMessage' => 'Your request is too frequent. Try again later.',
+ ],
+ ],
+ 500 => [
+ [
+ 'errorCode' => 'InternalError.System',
+ 'errorMessage' => 'An internal system error occurred. Try again later.',
+ ],
+ [
+ 'errorCode' => 'InternalError.UserId.Missing',
+ 'errorMessage' => 'An internal system error occurred. Try again later.',
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"ErrorMessage\\": \\"The connection does not exist.\\",\\n \\"RequestId\\": \\"0000-ABCD-EFG****\\",\\n \\"ErrorCode\\": \\"Invalid.Tenant.ConnectionNotExists\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"Owner\\": \\"20000****\\",\\n \\"Description\\": \\"This is my first business process.\\",\\n \\"ProjectId\\": \\"10000\\",\\n \\"BusinessId\\": 1000001,\\n \\"BusinessName\\": \\"The first business process\\",\\n \\"UseType\\": \\"NORMAL\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"<RequestId>0000-ABCD-EFG****</RequestId>\\n<HttpStatusCode>200</HttpStatusCode>\\n<Data>\\n <Owner>20000****</Owner>\\n <Description>这是我的第一个业务流程</Description>\\n <BusinessName>第一个业务流程</BusinessName>\\n <UseType>NORMAL</UseType>\\n <ProjectId>10000</ProjectId>\\n <BusinessId>1000001</BusinessId>\\n</Data>\\n<ErrorCode>Invalid.Tenant.ConnectionNotExists</ErrorCode>\\n<ErrorMessage>The connection does not exist.</ErrorMessage>\\n<Success>true</Success>","errorExample":""}]',
+ 'title' => 'GetBusiness',
+ 'summary' => 'Queries the information about a workflow.',
+ 'requestParamsDescription' => ' ',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ ],
+ 'UpdateFolder' => [
+ 'methods' => [
+ 'post',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'readAndWrite',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'update',
+ 'abilityTreeCode' => '78373',
+ 'abilityTreeNodes' => [
+ 'FEATUREdide8FM783',
+ ],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'ProjectId',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The ID of the DataWorks workspace. You can log on to the DataWorks console and go to the Workspace Management page to obtain the ID. You must specify either this parameter or ProjectIdentifier to determine the DataWorks workspace to which the operation is applied.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'docRequired' => false,
+ 'example' => '10000',
+ ],
+ ],
+ [
+ 'name' => 'ProjectIdentifier',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The name of the DataWorks workspace. You can log on to the DataWorks console and go to the Workspace Settings panel to obtain the name. You must specify either this parameter or ProjectId to determine the DataWorks workspace to which the operation is applied.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'dw_project',
+ ],
+ ],
+ [
+ 'name' => 'FolderId',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The ID of the folder. You can call the [ListFolders](~~173955~~) operation to query the ID.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => '2735c2c19d58',
+ ],
+ ],
+ [
+ 'name' => 'FolderName',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The name of the folder.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'MySecondFolder',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'description' => '',
+ 'type' => 'object',
+ 'properties' => [
+ 'HttpStatusCode' => [
+ 'description' => 'The HTTP status code returned.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '200',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message returned.'."\n",
+ 'type' => 'string',
+ 'example' => 'The connection does not exist.',
+ ],
+ 'RequestId' => [
+ 'description' => 'The ID of the request. You can use the ID to troubleshoot issues.'."\n",
+ 'type' => 'string',
+ 'example' => '0000-ABCD-EFG****',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code returned.'."\n",
+ 'type' => 'string',
+ 'example' => 'Invalid.Tenant.ConnectionNotExists',
+ ],
+ 'Success' => [
+ 'description' => 'Indicates whether the request is successful.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'errorCodes' => [
+ 403 => [
+ [
+ 'errorCode' => 'Forbidden.Access',
+ 'errorMessage' => 'Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.',
+ ],
+ ],
+ 429 => [
+ [
+ 'errorCode' => 'Throttling.Api',
+ 'errorMessage' => 'The request for this resource has exceeded your available limit.',
+ ],
+ [
+ 'errorCode' => 'Throttling.System',
+ 'errorMessage' => 'The DataWorks system is busy. Try again later.',
+ ],
+ [
+ 'errorCode' => 'Throttling.User',
+ 'errorMessage' => 'Your request is too frequent. Try again later.',
+ ],
+ ],
+ 500 => [
+ [
+ 'errorCode' => 'InternalError.System',
+ 'errorMessage' => 'An internal system error occurred. Try again later.',
+ ],
+ [
+ 'errorCode' => 'InternalError.UserId.Missing',
+ 'errorMessage' => 'An internal system error occurred. Try again later.',
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"ErrorMessage\\": \\"The connection does not exist.\\",\\n \\"RequestId\\": \\"0000-ABCD-EFG****\\",\\n \\"ErrorCode\\": \\"Invalid.Tenant.ConnectionNotExists\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<UpdateFolderResponse>\\n <HttpStatusCode>200</HttpStatusCode>\\n <ErrorMessage>The connection does not exist.</ErrorMessage>\\n <RequestId>0000-ABCD-EFG****</RequestId>\\n <ErrorCode>Invalid.Tenant.ConnectionNotExists</ErrorCode>\\n <Success>true</Success>\\n</UpdateFolderResponse>","errorExample":""}]',
+ 'title' => 'UpdateFolder',
+ 'summary' => 'Updates a folder.',
+ 'requestParamsDescription' => ' ',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ ],
+ 'ListDeployments' => [
+ 'summary' => 'Queries a list of deployment packages. This operation is equivalent to viewing a list of deployment packages on the Deployment Packages page of the DataWorks console.',
+ 'methods' => [
+ 'post',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'list',
+ 'abilityTreeCode' => '100712',
+ 'abilityTreeNodes' => [
+ 'FEATUREdide8FM783',
+ ],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'ProjectIdentifier',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The name of the DataWorks workspace. You can log on to the [DataWorks console](https://workbench.data.aliyun.com/console) and go to the Workspace page to obtain the workspace name.'."\n"
+ ."\n"
+ .'You must configure either this parameter or the ProjectId parameter to determine the DataWorks workspace to which the operation is applied.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'dw_project',
+ ],
+ ],
+ [
+ 'name' => 'ProjectId',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The DataWorks workspace ID. You can log on to the [DataWorks console](https://workbench.data.aliyun.com/console) and go to the Workspace page to obtain the workspace ID.'."\n"
+ ."\n"
+ .'You must configure either this parameter or the ProjectIdentifier parameter to determine the DataWorks workspace to which the operation is applied.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'example' => '10000',
+ ],
+ ],
+ [
+ 'name' => 'Creator',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The ID of the Alibaba Cloud account used by the user who creates the deployment packages.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => '20030****',
+ ],
+ ],
+ [
+ 'name' => 'EndCreateTime',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The time when the deployment packages to be queried are created. This value must be a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'example' => '1593877765000',
+ ],
+ ],
+ [
+ 'name' => 'Executor',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The ID of the Alibaba Cloud account used by the user who runs the deployment packages.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => '2003****',
+ ],
+ ],
+ [
+ 'name' => 'EndExecuteTime',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The time when the deployment packages are run. This value must be a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'example' => '1593877765000',
+ ],
+ ],
+ [
+ 'name' => 'Status',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The status of the deployment packages. Valid values:'."\n"
+ ."\n"
+ .'* 0: The deployment packages are ready.'."\n"
+ .'* 1: The deployment packages are deployed.'."\n"
+ .'* 2: The deployment packages fail to be deployed.'."\n"
+ .'* 6: The deployment packages are rejected.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => false,
+ 'example' => '1',
+ ],
+ ],
+ [
+ 'name' => 'Keyword',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The keyword that is contained in the names of the deployment packages. A fuzzy search is supported. After you enter a keyword, all deployment packages whose names contain the keyword are displayed.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'hello',
+ ],
+ ],
+ [
+ 'name' => 'PageNumber',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The page number.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => false,
+ 'example' => '1',
+ ],
+ ],
+ [
+ 'name' => 'PageSize',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The number of entries per page. Default value: 10. Maximum value: 100.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => false,
+ 'maximum' => '100',
+ 'example' => '20',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => 'Schema of Response',
+ 'description' => 'The response parameters.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'title' => 'Id of the request',
+ 'description' => 'The request ID.'."\n",
+ 'type' => 'string',
+ 'example' => '0000-ABCD-EFG',
+ ],
+ 'Data' => [
+ 'description' => 'The data returned.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'PageNumber' => [
+ 'description' => 'The page number.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '1',
+ ],
+ 'PageSize' => [
+ 'description' => 'The number of entries per page.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '10',
+ ],
+ 'TotalCount' => [
+ 'description' => 'The total number of entries returned.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '13',
+ ],
+ 'Deployments' => [
+ 'description' => 'The deployment packages.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '',
+ 'type' => 'object',
+ 'properties' => [
+ 'Status' => [
+ 'description' => 'The status of the deployment package. Valid values:'."\n"
+ ."\n"
+ .'* 0: The deployment package is ready.'."\n"
+ .'* 1: The deployment package is deployed.'."\n"
+ .'* 2: The deployment package fails to be deployed.'."\n"
+ .'* 6: The deployment package is rejected.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '1',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message returned when the deployment package failed.'."\n",
+ 'type' => 'string',
+ 'example' => 'OK',
+ ],
+ 'CreateTime' => [
+ 'description' => 'The time when the deployment package was created.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '1593877765000',
+ ],
+ 'Executor' => [
+ 'description' => 'The ID of the Alibaba Cloud account used by the user who ran the deployment package.'."\n",
+ 'type' => 'string',
+ 'example' => '2003****',
+ ],
+ 'Creator' => [
+ 'description' => 'The ID of the Alibaba Cloud account used by the user who created the deployment package.'."\n",
+ 'type' => 'string',
+ 'example' => '2003****',
+ ],
+ 'ExecuteTime' => [
+ 'description' => 'The time when the deployment package was run. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '1593877765000',
+ ],
+ 'Name' => [
+ 'description' => 'The name of the deployment package.'."\n",
+ 'type' => 'string',
+ 'example' => 'auto_created',
+ ],
+ 'Id' => [
+ 'description' => 'The deployment package ID. You can call the [GetDeployment](~~173950~~) operation to obtain the ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '11111',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'errorCodes' => [
+ 403 => [
+ [
+ 'errorCode' => 'Forbidden.Access',
+ 'errorMessage' => 'Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.',
+ ],
+ ],
+ 429 => [
+ [
+ 'errorCode' => 'Throttling.Api',
+ 'errorMessage' => 'The request for this resource has exceeded your available limit.',
+ ],
+ [
+ 'errorCode' => 'Throttling.System',
+ 'errorMessage' => 'The DataWorks system is busy. Try again later.',
+ ],
+ [
+ 'errorCode' => 'Throttling.User',
+ 'errorMessage' => 'Your request is too frequent. Try again later.',
+ ],
+ ],
+ 500 => [
+ [
+ 'errorCode' => 'InternalError.System',
+ 'errorMessage' => 'An internal system error occurred. Try again later.',
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"0000-ABCD-EFG\\",\\n \\"Data\\": {\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 13,\\n \\"Deployments\\": [\\n {\\n \\"Status\\": 1,\\n \\"ErrorMessage\\": \\"OK\\",\\n \\"CreateTime\\": 1593877765000,\\n \\"Executor\\": \\"2003****\\",\\n \\"Creator\\": \\"2003****\\",\\n \\"ExecuteTime\\": 1593877765000,\\n \\"Name\\": \\"auto_created\\",\\n \\"Id\\": 11111\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<ListDeploymentsResponse>\\n <RequestId>0000-ABCD-EFG</RequestId>\\n <Data>\\n <PageNumber>1</PageNumber>\\n <PageSize>10</PageSize>\\n <TotalCount>13</TotalCount>\\n <Deployments>\\n <Status>1</Status>\\n <ErrorMessage>OK</ErrorMessage>\\n <CreateTime>1593877765000</CreateTime>\\n <Executor>2003****</Executor>\\n <Creator>2003****</Creator>\\n <ExecuteTime>1593877765000</ExecuteTime>\\n <Name>auto_created</Name>\\n <Id>11111</Id>\\n </Deployments>\\n </Data>\\n</ListDeploymentsResponse>","errorExample":""}]',
+ 'title' => 'ListDeployments',
+ ],
+ 'UpdateIDEEventResult' => [
+ 'summary' => 'Returns the check result of an extension point event to DataStudio after the extension point event is triggered during data development and checked by an extension.',
+ 'methods' => [
+ 'post',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'write',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'get',
+ 'abilityTreeCode' => '101717',
+ 'abilityTreeNodes' => [
+ 'FEATUREdide6ZPSGN',
+ ],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'MessageId',
+ 'in' => 'formData',
+ 'schema' => [
+ 'title' => '消息UUID',
+ 'description' => 'The message ID. You can obtain the ID from a received message when an extension point event is triggered.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => '8abcb91f-d266-4073-b907-2ed670378ed1',
+ ],
+ ],
+ [
+ 'name' => 'ExtensionCode',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The unique identifier of the extension. You can log on to the [DataWorks console](https://workbench.data.aliyun.com/console) and go to the Extensions tab of the Open Platform page to view the identifier.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => '8abcb91f-d266-4073-b907-2ed670378ed1',
+ ],
+ ],
+ [
+ 'name' => 'CheckResult',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The check status of the extension point event. Valid values:'."\n"
+ ."\n"
+ .'* OK: The event passes the check.'."\n"
+ .'* FAIL: The event fails to pass the check. You must check and handle the reported error at the earliest opportunity to ensure that your program is run as expected.'."\n"
+ .'* WARN: The event passes the check, but an alert is reported.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'OK',
+ ],
+ ],
+ [
+ 'name' => 'CheckResultTip',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The summary information of the check result. The information is displayed in DataStudio. If an alert is reported or the event fails the check, you can troubleshoot errors based on the information.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'Succeeded',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => 'Schema of Response',
+ 'description' => 'The response parameters.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'title' => 'Id of the request',
+ 'description' => 'The request ID.'."\n",
+ 'type' => 'string',
+ 'example' => '8abcb91f-d266-4073-b907-2ed670378ed1',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'errorCodes' => [
+ 400 => [
+ [
+ 'errorCode' => 'InternalError.UserId.Missing',
+ 'errorMessage' => 'An internal system error occurred. Try again later.',
+ ],
+ ],
+ 403 => [
+ [
+ 'errorCode' => 'Forbidden.Access',
+ 'errorMessage' => 'Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.',
+ ],
+ ],
+ 429 => [
+ [
+ 'errorCode' => 'Throttling.Api',
+ 'errorMessage' => 'The request for this resource has exceeded your available limit.',
+ ],
+ [
+ 'errorCode' => 'Throttling.System',
+ 'errorMessage' => 'The DataWorks system is busy. Try again later.',
+ ],
+ [
+ 'errorCode' => 'Throttling.User',
+ 'errorMessage' => 'Your request is too frequent. Try again later.',
+ ],
+ ],
+ 500 => [
+ [
+ 'errorCode' => 'InternalError.System',
+ 'errorMessage' => 'An internal system error occurred. Try again later.',
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"8abcb91f-d266-4073-b907-2ed670378ed1\\"\\n}","errorExample":""},{"type":"xml","example":"<UpdateIDEEventResultResponse>\\n <RequestId>8abcb91f-d266-4073-b907-2ed670378ed1</RequestId>\\n</UpdateIDEEventResultResponse>","errorExample":""}]',
+ 'title' => 'UpdateIDEEventResult',
+ 'description' => "\n",
+ 'requestParamsDescription' => ' ',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ ],
+ 'GetIDEEventDetail' => [
+ 'summary' => 'Queries the data snapshot of an extension point based on the ID of a message in DataWorks OpenEvent when the related extension point event is triggered.',
+ 'methods' => [
+ 'post',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'get',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeCode' => '101710',
+ 'abilityTreeNodes' => [
+ 'FEATUREdide8FM783',
+ ],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'MessageId',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The message ID in DataWorks OpenEvent. You can obtain the ID from a received message when an extension point event is triggered.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => '8abcb91f-d266-4073-b907-2ed670378ed1',
+ ],
+ ],
+ [
+ 'name' => 'ProjectId',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The DataWorks workspace ID. You can obtain the ID from the message.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => true,
+ 'example' => '10000',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => 'Schema of Response',
+ 'description' => 'The response.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'title' => 'Id of the request',
+ 'description' => 'The request ID.'."\n",
+ 'type' => 'string',
+ 'example' => '8abcb91f-d266-4073-b907-2ed670378ed1',
+ ],
+ 'EventDetail' => [
+ 'description' => 'The data snapshot that is generated when an extension point event is triggered.'."\n"
+ ."\n"
+ .'The fields contained in data snapshots vary based on the types of the triggered extension point events. For more information, see the description of the fields.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'FileExecutionCommand' => [
+ 'description' => 'The data snapshot when the code in the file is run. This parameter is valid only if the message type is IDE_FILE_EXECUTE_BEFORE.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'FileId' => [
+ 'description' => 'The file ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '1234123',
+ ],
+ 'DataSourceName' => [
+ 'description' => 'The name of the data source with which the file is associated.'."\n",
+ 'type' => 'string',
+ 'example' => 'odps_first',
+ ],
+ 'Content' => [
+ 'description' => 'The code in the file of the current version.'."\n",
+ 'type' => 'string',
+ 'example' => 'SHOW TABLES;',
+ ],
+ 'FileType' => [
+ 'description' => 'The type of the code for the file. The code for files varies based on the file type. For more information, see [DataWorks nodes](~~600169~~).'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '10',
+ ],
+ ],
+ ],
+ 'DeletedFile' => [
+ 'description' => 'The data snapshot when the file is deleted. This parameter is valid only if the message type is IDE_FILE_DELETE_BEFORE.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'Owner' => [
+ 'description' => 'The file owner.'."\n",
+ 'type' => 'string',
+ 'example' => '7384234****',
+ ],
+ 'FileType' => [
+ 'description' => 'The type of the code for the file. The code of files varies based on the file type. For more information, see [DataWorks nodes](~~600169~~).'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '10',
+ ],
+ 'CurrentVersion' => [
+ 'description' => 'The latest version number of the file.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '1',
+ ],
+ 'BusinessId' => [
+ 'description' => 'The ID of the workflow to which the file belongs.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '74328',
+ ],
+ 'FileName' => [
+ 'description' => 'The name of the file.'."\n",
+ 'type' => 'string',
+ 'example' => 'hello_dataworks.sql',
+ ],
+ 'DataSourceName' => [
+ 'description' => 'The name of the data source with which the file is associated.'."\n",
+ 'type' => 'string',
+ 'example' => 'odps_first',
+ ],
+ 'UseType' => [
+ 'description' => 'The module to which the file belongs. Valid values:'."\n"
+ ."\n"
+ .'* NORMAL: The file is used for DataStudio.'."\n"
+ .'* MANUAL: The file is used for a manually triggered node.'."\n"
+ .'* MANUAL_BIZ: The file is used for a manually triggered workflow.'."\n"
+ .'* SKIP: The file is used for a dry-run DataStudio node.'."\n"
+ .'* ADHOCQUERY: The file is used for an ad hoc query.'."\n"
+ .'* COMPONENT: The file is used for a snippet.'."\n",
+ 'type' => 'string',
+ 'example' => 'NORMAL',
+ ],
+ 'FolderId' => [
+ 'description' => 'The ID of the folder to which the file belongs. You can call the [GetFolder](~~173952~~) operation to query the details of the file based on the folder ID.'."\n",
+ 'type' => 'string',
+ 'example' => 'aldurie78l2falure',
+ ],
+ 'ParentFileId' => [
+ 'description' => 'The ID of the do-while node or for-each node that corresponds to the file.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '1234122',
+ ],
+ 'Content' => [
+ 'description' => 'The code in the file of the current version.'."\n",
+ 'type' => 'string',
+ 'example' => 'SHOW TABLES;',
+ ],
+ 'NodeId' => [
+ 'description' => 'The ID of the node that is scheduled.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '421429',
+ ],
+ 'FileId' => [
+ 'description' => 'The file ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '1234123',
+ ],
+ ],
+ ],
+ 'CommittedFile' => [
+ 'description' => 'The data snapshot when the file is committed and deployed.'."\n"
+ ."\n"
+ .'This parameter is valid only if the message type is IDE_FILE_SUBMIT_BEFORE or IDE_FILE_DEPLOY_BEFORE.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'FileId' => [
+ 'description' => 'The file ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '1234123',
+ ],
+ 'Content' => [
+ 'description' => 'The code in the file of the current version.'."\n",
+ 'type' => 'string',
+ 'example' => 'SHOW TABLES;',
+ ],
+ 'Committor' => [
+ 'description' => 'The ID of the Alibaba Cloud account that is used to generate the file of the current version.'."\n",
+ 'type' => 'string',
+ 'example' => '7384234****',
+ ],
+ 'FileType' => [
+ 'description' => 'The type of the code for the file. The code of files varies based on the file type. For more information, see [DataWorks nodes](~~600169~~).'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '10',
+ ],
+ 'ChangeType' => [
+ 'description' => 'The type of the change to the file of the current version. Valid values: CREATE, UPDATE, and DELETE.'."\n",
+ 'type' => 'string',
+ 'example' => 'UPDATE',
+ ],
+ 'FileName' => [
+ 'description' => 'The name of the file.'."\n",
+ 'type' => 'string',
+ 'example' => 'hello_dataworks.sql',
+ ],
+ 'NodeId' => [
+ 'description' => 'The ID of the node that is scheduled.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '421429',
+ ],
+ 'Comment' => [
+ 'description' => 'The description of the file version.'."\n",
+ 'type' => 'string',
+ 'example' => 'Second version submission',
+ ],
+ 'UseType' => [
+ 'description' => 'The module to which the file belongs. Valid values:'."\n"
+ ."\n"
+ .'* NORMAL: The file is used for DataStudio.'."\n"
+ .'* MANUAL: The file is used for a manually triggered node.'."\n"
+ .'* MANUAL_BIZ: The file is used for a manually triggered workflow.'."\n"
+ .'* SKIP: The file is used for a dry-run DataStudio node.'."\n"
+ .'* ADHOCQUERY: The file is used for an ad hoc query.'."\n"
+ .'* COMPONENT: The file is used for a snippet.'."\n",
+ 'type' => 'string',
+ 'example' => 'NORMAL',
+ ],
+ 'FilePropertyContent' => [
+ 'description' => 'The details of the file.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'DataSourceName' => [
+ 'description' => 'The name of the data source with which the file is associated.'."\n",
+ 'type' => 'string',
+ 'example' => 'odps_first',
+ ],
+ 'ParentFileId' => [
+ 'description' => 'The ID of the do-while node or for-each node that corresponds to the file.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '1234122',
+ ],
+ 'BusinessId' => [
+ 'description' => 'The ID of the workflow to which the file belongs.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '74328',
+ ],
+ 'CurrentVersion' => [
+ 'description' => 'The latest version number of the file.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '1',
+ ],
+ 'Owner' => [
+ 'description' => 'The file owner.'."\n",
+ 'type' => 'string',
+ 'example' => '7384234****',
+ ],
+ 'FolderId' => [
+ 'description' => 'The ID of the folder to which the file belongs. You can call the [GetFolder](~~173952~~) operation to query the details of the file based on the folder ID.'."\n",
+ 'type' => 'string',
+ 'example' => 'aldurie78l2falure',
+ ],
+ ],
+ ],
+ 'NodeConfiguration' => [
+ 'description' => 'The scheduling properties of the node that corresponds to the file.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'RerunMode' => [
+ 'description' => 'Indicates whether the node that corresponds to the file can be rerun. Valid values:'."\n"
+ ."\n"
+ .'* ALL_ALLOWED: The node can be rerun regardless of whether it is successfully run or fails to run.'."\n"
+ .'* FAILURE_ALLOWED: The node can be rerun only after it fails to run.'."\n"
+ .'* ALL_DENIED: The node cannot be rerun regardless of whether it is successfully run or fails to run.'."\n"
+ ."\n"
+ .'This parameter corresponds to the Rerun parameter in the Schedule section of the Properties tab in the [DataWorks console](https://workbench.data.aliyun.com/console).'."\n",
+ 'type' => 'string',
+ 'example' => 'ALL_ALLOWED',
+ ],
+ 'SchedulerType' => [
+ 'description' => 'The scheduling type of the node. Valid values:'."\n"
+ ."\n"
+ .'* NORMAL: The node is an auto triggered node.'."\n"
+ .'* MANUAL: The node is a manually triggered node. Manually triggered nodes cannot be automatically triggered. They correspond to the nodes in the Manually Triggered Workflows pane.'."\n"
+ .'* PAUSE: The node is a paused node.'."\n"
+ .'* SKIP: The node is a dry-run node. Dry-run nodes are started as scheduled, but the system sets the status of the nodes to successful when it starts to run them.'."\n",
+ 'type' => 'string',
+ 'example' => 'NORMAL',
+ ],
+ 'ParaValue' => [
+ 'description' => 'The scheduling parameters of the node.'."\n"
+ ."\n"
+ .'This parameter corresponds to the Scheduling Parameter section of the Properties tab in the [DataWorks console](https://workbench.data.aliyun.com/console). For more information about the configurations of the scheduling parameters, see [Configure scheduling parameters](~~137548~~).'."\n",
+ 'type' => 'string',
+ 'example' => 'a=x b=y',
+ ],
+ 'CycleType' => [
+ 'description' => 'The type of the scheduling cycle of the node that corresponds to the file. Valid values: NOT_DAY and DAY. The value NOT_DAY indicates that the node is scheduled to run by minute or hour. The value DAY indicates that the node is scheduled to run by day, week, or month.'."\n"
+ ."\n"
+ .'This parameter corresponds to the Scheduling Cycle parameter in the Schedule section of the Properties tab in the [DataWorks console](https://workbench.data.aliyun.com/console).'."\n",
+ 'type' => 'string',
+ 'example' => 'DAY',
+ ],
+ 'DependentNodeIdList' => [
+ 'description' => 'The ID of the node on which the node that corresponds to the file depends when the DependentType parameter is set to USER_DEFINE. Multiple IDs are separated by commas (,).'."\n"
+ ."\n"
+ .'The value of this parameter is equivalent to the ID of the node that you specified after you select Other Nodes for Cross-Cycle Dependency (Original Previous-Cycle Dependency) in the Dependencies section of the Properties tab in the [DataWorks console](https://workbench.data.aliyun.com/console).'."\n",
+ 'type' => 'string',
+ 'example' => '5,10,15,20',
+ ],
+ 'ResourceGroupId' => [
+ 'description' => 'The ID of the resource group that is used to run the node that corresponds to the file. You can call the [ListResourceGroups](~~173913~~) operation to query the available resource groups in the workspace.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '375827434852437',
+ ],
+ 'AutoRerunTimes' => [
+ 'description' => 'The number of times that the node corresponding to the file can be rerun.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '3',
+ ],
+ 'AutoRerunIntervalMillis' => [
+ 'description' => 'The interval at which the node corresponding to the file is rerun. Unit: milliseconds.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '120000',
+ ],
+ 'CronExpress' => [
+ 'description' => 'The CRON expression that is used to schedule the node corresponding to the file.'."\n",
+ 'type' => 'string',
+ 'example' => '00 05 00 * * ?',
+ ],
+ 'InputList' => [
+ 'description' => 'The output names of the parent files on which the current file depends.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The output information about the parent files on which the current file depends.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'Input' => [
+ 'description' => 'The output name of the parent file on which the current file depends.'."\n"
+ ."\n"
+ .'This parameter corresponds to the Output Name of Ancestor Node parameter under Parent Nodes in the Dependencies section of the Properties tab in the [DataWorks console](https://workbench.data.aliyun.com/console).'."\n",
+ 'type' => 'string',
+ 'example' => 'dw_project_root',
+ ],
+ 'ParseType' => [
+ 'description' => 'The mode of the configuration file dependency. Valid values:'."\n"
+ ."\n"
+ .'* MANUAL: Scheduling dependencies are manually configured.'."\n"
+ .'* AUTO: Scheduling dependencies are automatically parsed.'."\n",
+ 'type' => 'string',
+ 'example' => 'MANUAL',
+ ],
+ ],
+ ],
+ ],
+ 'OutputList' => [
+ 'description' => 'The output names of the current file.'."\n"
+ ."\n"
+ .'This parameter corresponds to the Output Name of Current Node parameter in the Dependencies section of the Properties tab in the [DataWorks console](https://workbench.data.aliyun.com/console).'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The output information about the current file.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'RefTableName' => [
+ 'description' => 'The output table name of the current file.'."\n"
+ ."\n"
+ .'This parameter corresponds to the Output Table Name parameter under Output Name of Current Node in the Dependencies section of the Properties tab in the [DataWorks console](https://workbench.data.aliyun.com/console).'."\n",
+ 'type' => 'string',
+ 'example' => 'ods_user_info_d',
+ ],
+ 'Output' => [
+ 'description' => 'The output name of the current file.'."\n"
+ ."\n"
+ .'This parameter corresponds to the Output Name parameter under Output Name of Current Node in the Dependencies section of the Properties tab in the [DataWorks console](https://workbench.data.aliyun.com/console).'."\n",
+ 'type' => 'string',
+ 'example' => 'dw_project.002_out',
+ ],
+ ],
+ ],
+ ],
+ 'DependentType' => [
+ 'description' => 'The type of the cross-cycle scheduling dependency of the node. Valid values:'."\n"
+ ."\n"
+ .'* SELF: The instance generated for the node in the current cycle depends on the instance generated for the node in the previous cycle.'."\n"
+ .'* CHILD: The instance generated for the node in the current cycle depends on the instances generated for the descendant nodes at the nearest level of the node in the previous cycle.'."\n"
+ .'* USER_DEFINE: The instance generated for the node in the current cycle depends on the instances generated for one or more specified nodes in the previous cycle.'."\n"
+ .'* NONE: No cross-cycle scheduling dependency type is selected for the node.'."\n",
+ 'type' => 'string',
+ 'example' => 'USER_DEFINE',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'TableModel' => [
+ 'description' => 'The data snapshot when the table is committed and deployed. This parameter is valid only if the message type is IDE_TABLE_SUBMIT_BEFORE or IDE_TABLE_DEPLOY_BEFORE.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'Env' => [
+ 'description' => 'The environment in which the table is used. Valid values:'."\n"
+ ."\n"
+ .'* DEV'."\n"
+ .'* PROD'."\n",
+ 'type' => 'string',
+ 'example' => 'DEV',
+ ],
+ 'LifeCycle' => [
+ 'description' => 'The lifecycle of the metatable. Unit: day.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '7',
+ ],
+ 'TableName' => [
+ 'description' => 'The name of the table.'."\n",
+ 'type' => 'string',
+ 'example' => 'tb_hello',
+ ],
+ 'DataSourceName' => [
+ 'description' => 'The name of the data source to which the table belongs.'."\n",
+ 'type' => 'string',
+ 'example' => 'odps_first',
+ ],
+ 'Columns' => [
+ 'description' => 'The columns in the table.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The column in the table.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'ColumnName' => [
+ 'description' => 'The name of the column.'."\n",
+ 'type' => 'string',
+ 'example' => 'ID',
+ ],
+ 'ColumnType' => [
+ 'description' => 'The data type of the column.'."\n",
+ 'type' => 'string',
+ 'example' => 'BIGINT',
+ ],
+ 'IsPartitionColumn' => [
+ 'description' => 'Indicates whether the column is a partition key column. Valid values:'."\n"
+ ."\n"
+ .'* true: The column is a partition key column.'."\n"
+ .'* false: The column is not a partition key column.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'false',
+ ],
+ 'Comment' => [
+ 'description' => 'The remarks of the column.'."\n",
+ 'type' => 'string',
+ 'example' => 'ID',
+ ],
+ ],
+ ],
+ ],
+ 'Comment' => [
+ 'description' => 'The remarks of the table.'."\n",
+ 'type' => 'string',
+ 'example' => 'A new table',
+ ],
+ 'Location' => [
+ 'description' => 'The path of the table.'."\n",
+ 'type' => 'string',
+ 'example' => 'hdfs://path/to/object',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'errorCodes' => [
+ 400 => [
+ [
+ 'errorCode' => 'InternalError.UserId.Missing',
+ 'errorMessage' => 'An internal system error occurred. Try again later.',
+ ],
+ ],
+ 403 => [
+ [
+ 'errorCode' => 'Forbidden.Access',
+ 'errorMessage' => 'Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.',
+ ],
+ ],
+ 429 => [
+ [
+ 'errorCode' => 'Throttling.Api',
+ 'errorMessage' => 'The request for this resource has exceeded your available limit.',
+ ],
+ [
+ 'errorCode' => 'Throttling.System',
+ 'errorMessage' => 'The DataWorks system is busy. Try again later.',
+ ],
+ [
+ 'errorCode' => 'Throttling.User',
+ 'errorMessage' => 'Your request is too frequent. Try again later.',
+ ],
+ ],
+ 500 => [
+ [
+ 'errorCode' => 'InternalError.System',
+ 'errorMessage' => 'An internal system error occurred. Try again later.',
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"8abcb91f-d266-4073-b907-2ed670378ed1\\",\\n \\"EventDetail\\": {\\n \\"FileExecutionCommand\\": {\\n \\"FileId\\": 1234123,\\n \\"DataSourceName\\": \\"odps_source\\",\\n \\"Content\\": \\"SHOW TABLES;\\",\\n \\"FileType\\": 10\\n },\\n \\"DeletedFile\\": {\\n \\"Owner\\": \\"7384234****\\",\\n \\"FileType\\": 10,\\n \\"CurrentVersion\\": 1,\\n \\"BusinessId\\": 74328,\\n \\"FileName\\": \\"hello_dataworks.sql\\",\\n \\"DataSourceName\\": \\"odps_source\\",\\n \\"UseType\\": \\"NORMAL\\",\\n \\"FolderId\\": \\"aldurie78l2falure\\",\\n \\"ParentFileId\\": 1234122,\\n \\"Content\\": \\"SHOW TABLES;\\",\\n \\"NodeId\\": 421429,\\n \\"FileId\\": 1234123\\n },\\n \\"CommittedFile\\": {\\n \\"FileId\\": 1234123,\\n \\"Content\\": \\"SHOW TABLES;\\",\\n \\"Committor\\": \\"7384234****\\",\\n \\"FileType\\": 10,\\n \\"ChangeType\\": \\"UPDATE\\",\\n \\"FileName\\": \\"hello_dataworks.sql\\",\\n \\"NodeId\\": 421429,\\n \\"Comment\\": \\"Second version submission\\",\\n \\"UseType\\": \\"NORMAL\\",\\n \\"FilePropertyContent\\": {\\n \\"DataSourceName\\": \\"odps_source\\",\\n \\"ParentFileId\\": 1234122,\\n \\"BusinessId\\": 74328,\\n \\"CurrentVersion\\": 1,\\n \\"Owner\\": \\"7384234****\\",\\n \\"FolderId\\": \\"aldurie78l2falure\\"\\n },\\n \\"NodeConfiguration\\": {\\n \\"RerunMode\\": \\"ALL_ALLOWED\\",\\n \\"SchedulerType\\": \\"NORMAL\\",\\n \\"ParaValue\\": \\"a=x b=y\\",\\n \\"CycleType\\": \\"DAY\\",\\n \\"DependentNodeIdList\\": \\"5,10,15,20\\",\\n \\"ResourceGroupId\\": 375827434852437,\\n \\"AutoRerunTimes\\": 3,\\n \\"AutoRerunIntervalMillis\\": 120000,\\n \\"CronExpress\\": \\"00 05 00 * * ?\\",\\n \\"InputList\\": [\\n {\\n \\"Input\\": \\"dw_project_root\\",\\n \\"ParseType\\": \\"MANUAL\\"\\n }\\n ],\\n \\"OutputList\\": [\\n {\\n \\"RefTableName\\": \\"ods_user_info_d\\",\\n \\"Output\\": \\"dw_project.002_out\\"\\n }\\n ],\\n \\"DependentType\\": \\"USER_DEFINE\\"\\n }\\n },\\n \\"TableModel\\": {\\n \\"Env\\": \\"DEV\\",\\n \\"LifeCycle\\": 7,\\n \\"TableName\\": \\"tb_hello\\",\\n \\"DataSourceName\\": \\"odps_source\\",\\n \\"Columns\\": [\\n {\\n \\"ColumnName\\": \\"ID\\",\\n \\"ColumnType\\": \\"BIGINT\\",\\n \\"IsPartitionColumn\\": false,\\n \\"Comment\\": \\"ID\\"\\n }\\n ],\\n \\"Comment\\": \\"A new table\\",\\n \\"Location\\": \\"hdfs://path/to/object\\"\\n }\\n }\\n}","errorExample":""},{"type":"xml","example":"<GetIDEEventDetailResponse>\\n <RequestId>8abcb91f-d266-4073-b907-2ed670378ed1</RequestId>\\n <EventDetail>\\n <FileExecutionCommand>\\n <FileId>1234123</FileId>\\n <DataSourceName>odps_source</DataSourceName>\\n <Content>SHOW TABLES;</Content>\\n <FileType>10</FileType>\\n </FileExecutionCommand>\\n <DeletedFile>\\n <Owner>7384234****</Owner>\\n <FileType>10</FileType>\\n <CurrentVersion>1</CurrentVersion>\\n <BusinessId>74328</BusinessId>\\n <FileName>hello_dataworks.sql</FileName>\\n <DataSourceName>odps_source</DataSourceName>\\n <UseType>NORMAL</UseType>\\n <FolderId>aldurie78l2falure</FolderId>\\n <ParentFileId>1234122</ParentFileId>\\n <Content>SHOW TABLES;</Content>\\n <NodeId>421429</NodeId>\\n <FileId>1234123</FileId>\\n </DeletedFile>\\n <CommittedFile>\\n <FileId>1234123</FileId>\\n <Content>SHOW TABLES;</Content>\\n <Committor>7384234****</Committor>\\n <FileType>10</FileType>\\n <ChangeType>UPDATE</ChangeType>\\n <FileName>hello_dataworks.sql</FileName>\\n <NodeId>421429</NodeId>\\n <Comment>第二次版本提交</Comment>\\n <UseType>NORMAL</UseType>\\n <FilePropertyContent>\\n <DataSourceName>odps_source</DataSourceName>\\n <ParentFileId>1234122</ParentFileId>\\n <BusinessId>74328</BusinessId>\\n <CurrentVersion>1</CurrentVersion>\\n <Owner>7384234****</Owner>\\n <FolderId>aldurie78l2falure</FolderId>\\n </FilePropertyContent>\\n <NodeConfiguration>\\n <RerunMode>ALL_ALLOWED</RerunMode>\\n <SchedulerType>NORMAL</SchedulerType>\\n <ParaValue>a=x b=y</ParaValue>\\n <CycleType>DAY</CycleType>\\n <DependentNodeIdList>5,10,15,20</DependentNodeIdList>\\n <ResourceGroupId>375827434852437</ResourceGroupId>\\n <AutoRerunTimes>3</AutoRerunTimes>\\n <AutoRerunIntervalMillis>120000</AutoRerunIntervalMillis>\\n <CronExpress>00 05 00 * * ?</CronExpress>\\n <InputList>\\n <Input>dw_project_root</Input>\\n <ParseType>MANUAL</ParseType>\\n </InputList>\\n <OutputList>\\n <RefTableName>ods_user_info_d</RefTableName>\\n <Output>dw_project.002_out</Output>\\n </OutputList>\\n <DependentType>USER_DEFINE</DependentType>\\n </NodeConfiguration>\\n </CommittedFile>\\n <TableModel>\\n <Env>DEV</Env>\\n <LifeCycle>7</LifeCycle>\\n <TableName>tb_hello</TableName>\\n <DataSourceName>odps_source</DataSourceName>\\n <Columns>\\n <ColumnName>ID</ColumnName>\\n <ColumnType>BIGINT</ColumnType>\\n <IsPartitionColumn>false</IsPartitionColumn>\\n <Comment>ID</Comment>\\n </Columns>\\n <Comment>新建的一张表。</Comment>\\n <Location>hdfs://path/to/object</Location>\\n </TableModel>\\n </EventDetail>\\n</GetIDEEventDetailResponse>","errorExample":""}]',
+ 'title' => 'GetIDEEventDetail',
+ 'description' => "\n",
+ 'requestParamsDescription' => ' ',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ ],
+ 'CreateResourceFile' => [
+ 'summary' => 'Creates or uploads a resource file in DataStudio. The feature that is implemented by calling this operation is the same as the resource creation feature provided in the integrated development environment (IDE).',
+ 'methods' => [
+ 'post',
+ ],
+ 'schemes' => [
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'readAndWrite',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'create',
+ 'abilityTreeCode' => '185133',
+ 'abilityTreeNodes' => [
+ 'FEATUREdide8FM783',
+ 'FEATUREdideJ3TPTK',
+ ],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'ProjectId',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The DataWorks workspace ID. You can log on to the DataWorks console and go to the Workspace page to query the ID. You must configure this parameter to specify the DataWorks workspace to which the operation is applied.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => true,
+ 'docRequired' => true,
+ 'minimum' => '0',
+ 'example' => '10000',
+ ],
+ ],
+ [
+ 'name' => 'FileFolderPath',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The path of the file.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => 'Business_process/First_Business_Process/MaxCompute/Folder_1/Folder_2',
+ ],
+ ],
+ [
+ 'name' => 'FileName',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The name of the file.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => 'File name',
+ ],
+ ],
+ [
+ 'name' => 'FileType',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The type of the code for the file. The code for files varies based on the file type. For more information, see [DataWorks nodes](~~600169~~).'."\n"
+ ."\n"
+ .'You can call the [ListFileType](~~212428~~) operation to query the type of the code for the file.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => true,
+ 'docRequired' => true,
+ 'minimum' => '0',
+ 'example' => '10',
+ ],
+ ],
+ [
+ 'name' => 'FileDescription',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The description of the file.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'This is a description',
+ ],
+ ],
+ [
+ 'name' => 'Owner',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The Alibaba Cloud User ID of the file owner. If this parameter is empty, the caller\'s Alibaba cloud user ID is used by default.',
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => '1000000000001',
+ ],
+ ],
+ [
+ 'name' => 'Content',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The code for the file. The code format varies based on the file type. To view the code format for a specific file type, go to Operation Center, right-click a node of the file type, and then select View Code.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'SHOW TABLES;',
+ ],
+ ],
+ [
+ 'name' => 'ResourceFile',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The OSS URL for uploading files provided by POP.',
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'http://bucketname1.oss-cn-shanghai.aliyuncs.com/example',
+ 'isFileTransferUrl' => true,
+ ],
+ ],
+ [
+ 'name' => 'OriginResourceName',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The name of the original resource file.',
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => 'origin_file_name.sql',
+ ],
+ ],
+ [
+ 'name' => 'UploadMode',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'File resource Upload mode. Currently, only files of the File type of MaxCompute are valid. The values are as follows:'."\n"
+ ."\n"
+ .'- true: The Resource mode that can be downloaded.'."\n"
+ .'- false: The text mode for online editing.',
+ 'type' => 'boolean',
+ 'required' => false,
+ 'example' => 'false',
+ ],
+ ],
+ [
+ 'name' => 'RegisterToCalcEngine',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'Whether to synchronously Upload resources to the computing engine.',
+ 'type' => 'boolean',
+ 'required' => true,
+ 'example' => 'false',
+ ],
+ ],
+ [
+ 'name' => 'StorageURL',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The storage path of the resource file on the computing engine. Currently, only EMR and CDH use this field. EMR format is [oss | hdfs]:// path/to/object. CDH must be/user/admin/lib by default.',
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'oss://oss-cn-shanghai.aliyuncs.com/emr-test',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => 'Schema of Response',
+ 'description' => 'Schema of Response',
+ 'type' => 'object',
+ 'properties' => [
+ 'Data' => [
+ 'description' => 'The ID of the file after it is created.',
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '1000001',
+ ],
+ 'RequestId' => [
+ 'title' => 'Id of the request',
+ 'description' => 'The ID of the request. You can use the ID to locate logs and troubleshoot issues.'."\n",
+ 'type' => 'string',
+ 'example' => '0000-ABCD-EFG',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'errorCodes' => [
+ 403 => [
+ [
+ 'errorCode' => 'Forbidden.Access',
+ 'errorMessage' => 'Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.',
+ ],
+ ],
+ 429 => [
+ [
+ 'errorCode' => 'Throttling.Api',
+ 'errorMessage' => 'The request for this resource has exceeded your available limit.',
+ ],
+ [
+ 'errorCode' => 'Throttling.System',
+ 'errorMessage' => 'The DataWorks system is busy. Try again later.',
+ ],
+ [
+ 'errorCode' => 'Throttling.User',
+ 'errorMessage' => 'Your request is too frequent. Try again later.',
+ ],
+ ],
+ 500 => [
+ [
+ 'errorCode' => 'InternalError.System',
+ 'errorMessage' => 'An internal system error occurred. Try again later.',
+ ],
+ [
+ 'errorCode' => 'InternalError.UserId.Missing',
+ 'errorMessage' => 'An internal system error occurred. Try again later.',
+ ],
+ ],
+ ],
+ 'staticInfo' => [
+ 'returnType' => 'synchronous',
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"Data\\": 1000001,\\n \\"RequestId\\": \\"0000-ABCD-EFG\\"\\n}","errorExample":""},{"type":"xml","example":"<CreateResourceFileResponse>\\n <Data>1000001</Data>\\n <RequestId>0000-ABCD-EFG</RequestId>\\n</CreateResourceFileResponse>","errorExample":""}]',
+ 'title' => 'CreateResourceFile',
+ ],
+ 'CreateDISyncTask' => [
+ 'methods' => [
+ 'post',
+ 'get',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ [
+ 'APP' => [],
+ ],
+ [
+ 'PrivateKey' => [],
+ ],
+ ],
+ 'operationType' => 'readAndWrite',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'get',
+ 'abilityTreeCode' => '93925',
+ 'abilityTreeNodes' => [
+ 'FEATUREdideBP0OJZ',
+ ],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'ProjectId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The DataWorks workspace ID. You can log on to the [DataWorks console](https://workbench.data.aliyun.com/console) and go to the Workspace page to query the ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => true,
+ 'docRequired' => true,
+ 'maximum' => '10000000000',
+ 'minimum' => '1',
+ 'example' => '10000',
+ ],
+ ],
+ [
+ 'name' => 'TaskType',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The type of the data synchronization task. Valid values: DI_OFFLINE, DI_REALTIME, and DI_SOLUTION.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'DI_OFFLINE',
+ ],
+ ],
+ [
+ 'name' => 'TaskContent',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The script content of the data synchronization task.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => '{"type":"job","version":"2.0","steps":[{"stepType":"mysql","parameter":{"envType":1,"datasource":"mysql_pub","column":["id","name","create_time","age","score","t_01"],"connection":[{"datasource":"mysql_pub","table":["u_pk"]}],"where":"","splitPk":"id","encoding":"UTF-8"},"name":"Reader","category":"reader"},{"stepType":"odps","parameter":{"partition":"pt=${bizdate}","truncate":true,"datasource":"odps_source","envType":1,"column":["id","name","create_time","age","score","t_01"],"emptyAsNull":false,"tableComment":"null","table":"u_pk"},"name":"Writer","category":"writer"}],"setting":{"executeMode":null,"errorLimit":{"record":""},"speed":{"concurrent":2,"throttle":false}},"order":{"hops":[{"from":"Reader","to":"Writer"}]}}',
+ 'default' => '',
+ ],
+ ],
+ [
+ 'name' => 'TaskParam',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The configuration parameters of the data synchronization task. The following parameters are supported:'."\n"
+ ."\n"
+ .'* FileFolderPath: the storage path of the data synchronization task.'."\n"
+ .'* ResourceGroup: the identifier of the resource group for Data Integration that is used by the data synchronization task. You can call the [ListResourceGroups](~~173913~~) operation to query the identifier of the resource group.'."\n"
+ .'* Cu: the specifications occupied by the data synchronization task in the serverless resource group. The value of this parameter must be a multiple of 0.5.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'docRequired' => true,
+ 'example' => '{"FileFolderPath":"Business Flow/XXX/Data Integration","ResourceGroup":"S_res_group_XXX_XXXX"}',
+ ],
+ ],
+ [
+ 'name' => 'TaskName',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The name of the data synchronization task.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'docRequired' => true,
+ 'example' => 'new_di_task',
+ ],
+ ],
+ [
+ 'name' => 'ClientToken',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The client token that is used to ensure the idempotence of the request. This parameter can be left empty.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => '0000-ABCD-EFG****',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'Success' => [
+ 'description' => 'Indicates whether the request was successful.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'RequestId' => [
+ 'description' => 'The request ID.'."\n",
+ 'type' => 'string',
+ 'example' => '0bc1411515937635973****',
+ ],
+ 'Data' => [
+ 'description' => 'The information that indicates whether the data synchronization task is created.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'Status' => [
+ 'description' => 'The creation status of the data synchronization task. Valid values:'."\n"
+ ."\n"
+ .'* success'."\n"
+ .'* fail'."\n",
+ 'type' => 'string',
+ 'example' => 'success',
+ ],
+ 'Message' => [
+ 'description' => 'The error message that is returned if the data synchronization task fails to be created. If the data synchronization task is successfully created, this parameter is not returned. If the data synchronization task fails to be created, an error message in the "Invalid path: Workflow/xxxx/Data Integration" format is returned.'."\n",
+ 'type' => 'string',
+ 'example' => 'Invalid path: Business Flow/xxxx/Data Integration',
+ ],
+ 'FileId' => [
+ 'description' => 'The ID of the data synchronization task that is created.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '1000001',
+ ],
+ ],
+ ],
+ ],
+ 'description' => '',
+ ],
+ ],
+ ],
+ 'errorCodes' => [
+ 400 => [
+ [
+ 'errorCode' => 'Invalid.DI.Parameter',
+ 'errorMessage' => 'The parameter is invalid.',
+ ],
+ [
+ 'errorCode' => 'Invalid.DI.Parameter.File.Existed',
+ 'errorMessage' => 'The file name already exists.',
+ ],
+ ],
+ 403 => [
+ [
+ 'errorCode' => 'Forbidden.DI.NoPrivilege',
+ 'errorMessage' => 'No access.',
+ ],
+ ],
+ 500 => [
+ [
+ 'errorCode' => 'InternalError.DI.Parameter',
+ 'errorMessage' => 'A DI internal error occurred.',
+ ],
+ ],
+ ],
+ 'eventInfo' => [
+ 'enable' => false,
+ 'eventNames' => [],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"0bc1411515937635973****\\",\\n \\"Data\\": {\\n \\"Status\\": \\"success\\",\\n \\"Message\\": \\"不合法的目录路径：业务流程/xxxx/数据集成\\",\\n \\"FileId\\": 1000001\\n }\\n}","errorExample":""},{"type":"xml","example":"<CreateDISyncTaskResponse>\\n <Success>true</Success>\\n <RequestId>0bc1411515937635973****</RequestId>\\n <Data>\\n <Status>success</Status>\\n <FileId>1000001</FileId>\\n </Data>\\n</CreateDISyncTaskResponse>","errorExample":""}]',
+ 'title' => 'CreateDISyncTask',
+ 'summary' => 'Creates a data synchronization task.',
+ 'description' => 'You cannot configure scheduling properties for a task by calling this operation. If you want to configure scheduling properties for a task, you can call the UpdateFile operation.[](~~2780137~~)'."\n",
+ 'requestParamsDescription' => ' ',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ ],
+ 'DeleteDISyncTask' => [
+ 'methods' => [
+ 'post',
+ 'get',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ [
+ 'PrivateKey' => [],
+ ],
+ [
+ 'APP' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'get',
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'ProjectId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the DataWorks workspace. You can log on to the [DataWorks console](https://workbench.data.aliyun.com/console) and go to the Workspace page to obtain the workspace ID.'."\n"
+ ."\n"
+ .'You must configure this parameter to specify the DataWorks workspace to which the operation is applied.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => true,
+ 'docRequired' => true,
+ 'maximum' => '10000000000',
+ 'minimum' => '1',
+ 'example' => '10000',
+ ],
+ ],
+ [
+ 'name' => 'TaskType',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The type of the task. Set the value to DI_REALTIME, which indicates a real-time synchronization task.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'DI_REALTIME',
+ ],
+ ],
+ [
+ 'name' => 'FileId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the real-time synchronization task. You can call the [ListFiles](~~173942~~) operation to query the ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => true,
+ 'docRequired' => true,
+ 'maximum' => '9999999999999999',
+ 'minimum' => '1',
+ 'example' => '100',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'description' => 'The returned result.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'Success' => [
+ 'description' => 'Indicates whether the request was successful. Valid values:'."\n"
+ ."\n"
+ .'* true'."\n"
+ .'* false'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'RequestId' => [
+ 'description' => 'The request ID. You can locate logs and troubleshoot issues based on the ID.'."\n",
+ 'type' => 'string',
+ 'example' => '0bc1411515937635973****',
+ ],
+ 'Data' => [
+ 'description' => 'The deletion result.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'Status' => [
+ 'description' => 'Indicates whether the synchronization task is deleted. Valid values:'."\n"
+ ."\n"
+ .'* success: The synchronization task is deleted.'."\n"
+ .'* fail: The synchronization task fails to be deleted. You can troubleshoot the issue based on the failure reason.'."\n",
+ 'type' => 'string',
+ 'example' => 'fail',
+ ],
+ 'Message' => [
+ 'description' => 'The reason why the synchronization task fails to be deleted. If the synchronization task is deleted, the value null is returned for this parameter.'."\n",
+ 'type' => 'string',
+ 'example' => 'fileId:[100] is invalid.',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'errorCodes' => [
+ 400 => [
+ [
+ 'errorCode' => 'Param.Invalid',
+ 'errorMessage' => 'The parameter is invalid.',
+ ],
+ ],
+ 403 => [
+ [
+ 'errorCode' => 'Forbidden.Access',
+ 'errorMessage' => 'Access is forbidden.',
+ ],
+ ],
+ 500 => [
+ [
+ 'errorCode' => 'InternalError.System',
+ 'errorMessage' => 'An internal error occurred.',
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"0bc1411515937635973****\\",\\n \\"Data\\": {\\n \\"Status\\": \\"fail\\",\\n \\"Message\\": \\"fileId:[100] is invalid.\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"<DeleteDISyncTaskResponse>\\n <Success>true</Success>\\n <RequestId>0bc1411515937635973****</RequestId>\\n <Data>\\n <Status>fail</Status>\\n <Message>fileId:[100] is invalid.</Message>\\n </Data>\\n</DeleteDISyncTaskResponse>","errorExample":""}]',
+ 'title' => 'DeleteDISyncTask',
+ 'summary' => 'Deletes a synchronization task. You can call this operation to delete only a real-time synchronization task.',
+ 'description' => 'If you want to delete a batch synchronization task, call the DeleteFile operation. For more information, see [Delete a synchronization task](~~321443~~).'."\n",
+ ],
+ 'UpdateDISyncTask' => [
+ 'methods' => [
+ 'post',
+ 'get',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ [
+ 'APP' => [],
+ ],
+ [
+ 'PrivateKey' => [],
+ ],
+ ],
+ 'operationType' => 'readAndWrite',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'get',
+ 'abilityTreeCode' => '78371',
+ 'abilityTreeNodes' => [
+ 'FEATUREdideBP0OJZ',
+ ],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'ProjectId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the DataWorks workspace. You can log on to the [DataWorks console](https://workbench.data.aliyun.com/console) and go to the Workspace page to obtain the workspace ID. You must configure this parameter to specify the DataWorks workspace to which the API operation is applied.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => true,
+ 'docRequired' => true,
+ 'maximum' => '10000000000',
+ 'minimum' => '1',
+ 'example' => '10000',
+ ],
+ ],
+ [
+ 'name' => 'TaskType',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The type of the data synchronization task. Set the value to DI_OFFLINE. You can call the UpdateDISyncTask operation to update only batch synchronization tasks.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'DI_OFFLINE',
+ ],
+ ],
+ [
+ 'name' => 'TaskContent',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The updated configurations of the data synchronization task. Calling this API operation to update a data synchronization task is equivalent to updating a data synchronization task by using the code editor in the DataWorks console. For more information, see [Create a synchronization task by using the code editor](~~137717~~). You can call the UpdateDISyncTask operation to update only batch synchronization tasks. If you do not need to update the configurations of the data synchronization task, leave this parameter empty.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'docRequired' => true,
+ 'example' => '{"type":"job","version":"2.0","steps":[{"stepType":"mysql","parameter":{"envType":1,"datasource":"mysql_pub","column":["id","name","create_time","age","score","t_01"],"connection":[{"datasource":"mysql_pub","table":["u_pk"]}],"where":"","splitPk":"id","encoding":"UTF-8"},"name":"Reader","category":"reader"},{"stepType":"odps","parameter":{"partition":"pt=${bizdate}","truncate":true,"datasource":"odps_first","envType":1,"column":["id","name","create_time","age","score","t_01"],"emptyAsNull":false,"tableComment":"null","table":"u_pk"},"name":"Writer","category":"writer"}],"setting":{"executeMode":null,"errorLimit":{"record":""},"speed":{"concurrent":2,"throttle":false}},"order":{"hops":[{"from":"Reader","to":"Writer"}]}}',
+ 'default' => '',
+ ],
+ ],
+ [
+ 'name' => 'TaskParam',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The configuration parameters of the data synchronization task. You must configure this parameter in the JSON format.'."\n"
+ ."\n"
+ .'* ResourceGroup: the identifier of the resource group for Data Integration that is used by the data synchronization task. You can call the [ListResourceGroups](~~173913~~) operation to query the identifier of the resource group.'."\n"
+ .'* Cu: the specifications occupied by the data synchronization task in the serverless resource group. The value of this parameter must be a multiple of 0.5.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'docRequired' => true,
+ 'example' => '{"ResourceGroup":"S_res_group_XXX_XXXX"}',
+ ],
+ ],
+ [
+ 'name' => 'FileId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the data synchronization task. You can call the [ListFiles](~~173942~~) operation to query the ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => true,
+ 'docRequired' => true,
+ 'maximum' => '9223372036854775807',
+ 'minimum' => '1',
+ 'example' => '1000000',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'description' => 'The returned result.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'Success' => [
+ 'description' => 'Indicates whether the request was successful. Valid values:'."\n"
+ ."\n"
+ .'* true'."\n"
+ .'* false'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'RequestId' => [
+ 'description' => 'The request ID. You can locate logs and troubleshoot issues based on the ID.'."\n",
+ 'type' => 'string',
+ 'example' => '0bc1411515937635973****',
+ ],
+ 'Data' => [
+ 'description' => 'The information that indicates whether the data synchronization task is updated.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'Status' => [
+ 'description' => 'The update status of the data synchronization task. Valid values:'."\n"
+ ."\n"
+ .'* success'."\n"
+ .'* fail'."\n",
+ 'type' => 'string',
+ 'example' => 'success',
+ ],
+ 'Message' => [
+ 'description' => 'The error message returned if the data synchronization task fails to be updated. If the data synchronization task is successfully updated, the value null is returned for this parameter.'."\n",
+ 'type' => 'string',
+ 'example' => 'ResourceGroup:[S_res_group_XXX] is invalid.',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'errorCodes' => [
+ 400 => [
+ [
+ 'errorCode' => 'Invalid.DI.Parameter',
+ 'errorMessage' => 'The parameter is invalid.',
+ ],
+ ],
+ 403 => [
+ [
+ 'errorCode' => 'Forbidden.DI.NoPrivilege',
+ 'errorMessage' => 'No access.',
+ ],
+ ],
+ 500 => [
+ [
+ 'errorCode' => 'InternalError.DI.Parameter',
+ 'errorMessage' => 'A DI internal error occurred.',
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"0bc1411515937635973****\\",\\n \\"Data\\": {\\n \\"Status\\": \\"success\\",\\n \\"Message\\": \\"ResourceGroup:[S_res_group_XXX] is invalid.\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"<RequestId>0bc1411515937635973****</RequestId>\\n<Data>\\n <Status>success</Status>\\n <Message>ResourceGroup:[S_res_group_XXX] is invalid.</Message>\\n</Data>\\n<Success>true</Success>","errorExample":""}]',
+ 'title' => 'UpdateDISyncTask',
+ 'summary' => 'Updates a data synchronization task.',
+ 'requestParamsDescription' => ' ',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ ],
+ 'TestNetworkConnection' => [
+ 'methods' => [
+ 'post',
+ 'get',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ [
+ 'APP' => [],
+ ],
+ [
+ 'PrivateKey' => [],
+ ],
+ ],
+ 'operationType' => 'readAndWrite',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'get',
+ 'abilityTreeCode' => '78363',
+ 'abilityTreeNodes' => [
+ 'FEATUREdideRWC5F7',
+ ],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'ProjectId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the DataWorks workspace to which the data source belongs. You can call the [ListProjects](~~178393~~) operation to query the ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => true,
+ 'docRequired' => true,
+ 'maximum' => '10000000000',
+ 'minimum' => '1',
+ 'example' => '10000',
+ ],
+ ],
+ [
+ 'name' => 'DatasourceName',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The name of the data source.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'mysql_name',
+ ],
+ ],
+ [
+ 'name' => 'EnvType',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The environment in which the data source resides. Valid values:'."\n"
+ ."\n"
+ .'* 0: development environment'."\n"
+ .'* 1: production environment'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => '1',
+ ],
+ ],
+ [
+ 'name' => 'ResourceGroup',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The identifier of the resource group. You can call the [ListResourceGroups](~~173913~~) operation to query the identifier of the resource group.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'S_res_group_2XXXX4_1619100XXXXX',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'Success' => [
+ 'description' => 'Indicates whether the request was successful. Valid values:'."\n"
+ ."\n"
+ .'* true'."\n"
+ .'* false'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'RequestId' => [
+ 'description' => 'The request ID. You can locate logs and troubleshoot issues based on the ID.'."\n",
+ 'type' => 'string',
+ 'example' => '0000-ABCD-EFG ',
+ ],
+ 'TaskList' => [
+ 'description' => 'The information about the connectivity test.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'ConnectMessage' => [
+ 'description' => 'The reason why the data source and resource group failed the connectivity test. If data source and the resource group passed the connectivity test, this parameter is left empty.'."\n",
+ 'type' => 'string',
+ 'example' => 'Connectable',
+ ],
+ 'ConnectStatus' => [
+ 'description' => 'The result of the connectivity test. Valid values:'."\n"
+ ."\n"
+ .'* true: The data source and the resource group passed the connectivity test.'."\n"
+ .'* false: The data source and the resource group failed the connectivity test. You can troubleshoot issues based on the ConnectMessage parameter.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ ],
+ ],
+ ],
+ 'description' => '',
+ ],
+ ],
+ ],
+ 'errorCodes' => [
+ 400 => [
+ [
+ 'errorCode' => 'Invalid.DI.Parameter',
+ 'errorMessage' => 'The parameter is invalid.',
+ ],
+ ],
+ 403 => [
+ [
+ 'errorCode' => 'Forbidden.DI.NoPrivilege',
+ 'errorMessage' => 'No access.',
+ ],
+ ],
+ 500 => [
+ [
+ 'errorCode' => 'InternalError.DI.Parameter',
+ 'errorMessage' => 'A DI internal error occurred.',
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"0000-ABCD-EFG\\\\t\\",\\n \\"TaskList\\": {\\n \\"ConnectMessage\\": \\"Connectable\\",\\n \\"ConnectStatus\\": true\\n }\\n}","errorExample":""},{"type":"xml","example":"<RequestId>0000-ABCD-EFG\\t</RequestId>\\n<TaskList>\\n <ConnectStatus>true</ConnectStatus>\\n <ConnectMessage>可连通</ConnectMessage>\\n</TaskList>\\n<Success>true</Success>","errorExample":""}]',
+ 'title' => 'TestNetworkConnection',
+ 'summary' => 'Tests the network connectivity between a data source and a resource group.',
+ 'requestParamsDescription' => ' ',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ ],
+ 'GetDataSourceMeta' => [
+ 'methods' => [
+ 'post',
+ 'get',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ [
+ 'APP' => [],
+ ],
+ [
+ 'PrivateKey' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'get',
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'ProjectId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The DataWorks workspace ID. You can log on to the [DataWorks console](https://workbench.data.aliyun.com/console) and go to the Workspace page to obtain the ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => true,
+ 'docRequired' => true,
+ 'maximum' => '10000000000',
+ 'minimum' => '1',
+ 'example' => '10000',
+ ],
+ ],
+ [
+ 'name' => 'DatasourceName',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The name of the data source.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'mysql_name',
+ ],
+ ],
+ [
+ 'name' => 'PageNumber',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The page number.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'docRequired' => true,
+ 'maximum' => '100',
+ 'minimum' => '1',
+ 'example' => '1',
+ 'default' => '1',
+ ],
+ ],
+ [
+ 'name' => 'PageSize',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The number of entries per page.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'docRequired' => true,
+ 'maximum' => '10000',
+ 'minimum' => '1',
+ 'example' => '10',
+ 'default' => '10',
+ ],
+ ],
+ [
+ 'name' => 'EnvType',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The environment in which the data source resides. Valid values:'."\n"
+ ."\n"
+ .'* 0: development environment'."\n"
+ .'* 1: production environment'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => '1',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'description' => 'The returned result.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'Success' => [
+ 'description' => 'Indicates whether the request was successful. Valid values:'."\n"
+ ."\n"
+ .'* true'."\n"
+ .'* false'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'RequestId' => [
+ 'description' => 'The request ID. You can locate logs and troubleshoot issues based on the ID.'."\n",
+ 'type' => 'string',
+ 'example' => '0000-ABCD-EFG ',
+ ],
+ 'Data' => [
+ 'description' => 'The returned result.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'Status' => [
+ 'description' => 'Indicates whether the metadata of the data source is obtained. Valid values:'."\n"
+ ."\n"
+ .'* success: The metadata of the data source is obtained.'."\n"
+ .'* fail: The metadata of the data source failed to be obtained. You can troubleshoot issues based on the Message parameter.'."\n",
+ 'type' => 'string',
+ 'example' => 'success',
+ ],
+ 'Message' => [
+ 'description' => 'The reason why the metadata of the data source fails to be obtained. If the metadata of the data source is obtained, no value is returned for this parameter.'."\n",
+ 'type' => 'string',
+ 'example' => 'read datasource time out',
+ ],
+ 'Meta' => [
+ 'description' => 'The returned metadata of the data source. The returned metadata is in the JSON format.'."\n"
+ ."\n"
+ .'`{"dbTables":[{"dbName":"testdb","schema":[{"tableInfos":[{"dbName":"testdb","enable":true,"table":"table1","tableName":"table1"}]},{"tableInfos":[{"dbName":"testdb","enable":true,"table":"table2","tableName":"table2"}]}]}]}`'."\n"
+ ."\n"
+ .'Parameter description:'."\n"
+ ."\n"
+ .'* dbName: the name of the database in which the data source resides.'."\n"
+ .'* schema: the schema of the database.'."\n"
+ .'* enable: indicates whether the database is available. The valid values are true and false. The value true indicates that the database is available. The value false indicates that the database is unavailable.'."\n"
+ .'* tableName: the name of the table in the database.'."\n"
+ .'* tableInfos: the information about the table in the database.'."\n",
+ 'type' => 'string',
+ 'example' => '{"dbTables":[{"dbName":"testdb","schema":[{"tableInfos":[{"dbName":"testdb","enable":true,"table":"table1","tableName":"table1"}]},{"tableInfos":[{"dbName":"testdb","enable":true,"table":"table2","tableName":"table2"}]}]}]}',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'errorCodes' => [
+ 400 => [
+ [
+ 'errorCode' => 'Invalid.DI.Parameter',
+ 'errorMessage' => 'The parameter is invalid.',
+ ],
+ ],
+ 403 => [
+ [
+ 'errorCode' => 'Forbidden.DI.NoPrivilege',
+ 'errorMessage' => 'No access.',
+ ],
+ ],
+ 500 => [
+ [
+ 'errorCode' => 'InternalError.DI.Parameter',
+ 'errorMessage' => 'A DI internal error occurred.',
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"0000-ABCD-EFG\\\\t\\",\\n \\"Data\\": {\\n \\"Status\\": \\"success\\",\\n \\"Message\\": \\"read datasource time out\\",\\n \\"Meta\\": \\"{\\\\\\"dbTables\\\\\\":[{\\\\\\"dbName\\\\\\":\\\\\\"testdb\\\\\\",\\\\\\"schema\\\\\\":[{\\\\\\"tableInfos\\\\\\":[{\\\\\\"dbName\\\\\\":\\\\\\"testdb\\\\\\",\\\\\\"enable\\\\\\":true,\\\\\\"table\\\\\\":\\\\\\"table1\\\\\\",\\\\\\"tableName\\\\\\":\\\\\\"table1\\\\\\"}]},{\\\\\\"tableInfos\\\\\\":[{\\\\\\"dbName\\\\\\":\\\\\\"testdb\\\\\\",\\\\\\"enable\\\\\\":true,\\\\\\"table\\\\\\":\\\\\\"table2\\\\\\",\\\\\\"tableName\\\\\\":\\\\\\"table2\\\\\\"}]}]}]}\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"<GetDataSourceMetaResponse>\\n <Success>true</Success>\\n <RequestId>0000-ABCD-EFG\\t</RequestId>\\n <Data>\\n <Status>success</Status>\\n <Message>read datasource time out</Message>\\n <Meta>{\\"dbTables\\":[{\\"dbName\\":\\"testdb\\",\\"schema\\":[{\\"tableInfos\\":[{\\"dbName\\":\\"testdb\\",\\"enable\\":true,\\"table\\":\\"table1\\",\\"tableName\\":\\"table1\\"}]},{\\"tableInfos\\":[{\\"dbName\\":\\"testdb\\",\\"enable\\":true,\\"table\\":\\"table2\\",\\"tableName\\":\\"table2\\"}]}]}]}</Meta>\\n </Data>\\n</GetDataSourceMetaResponse>","errorExample":""}]',
+ 'title' => 'GetDataSourceMeta',
+ 'summary' => 'Queries the metadata of a specified data source.',
+ 'requestParamsDescription' => ' ',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ ],
+ 'ListDIProjectConfig' => [
+ 'methods' => [
+ 'post',
+ 'get',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ [
+ 'PrivateKey' => [],
+ ],
+ [
+ 'APP' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'get',
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'ProjectId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The DataWorks workspace ID. You can log on to the [DataWorks console](https://workbench.data.aliyun.com/console) and go to the Workspace page to obtain the ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => true,
+ 'docRequired' => true,
+ 'maximum' => '10000000000',
+ 'minimum' => '1',
+ 'example' => '1000',
+ ],
+ ],
+ [
+ 'name' => 'DestinationType',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The type of the destinations of the synchronization solutions. This parameter cannot be left empty. Valid values: analyticdb_for_mysql, odps, elasticsearch, holo, mysql, and polardb.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'elasticsearch',
+ ],
+ ],
+ [
+ 'name' => 'SourceType',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The type of the sources of the synchronization solutions. Valid values: oracle, mysql, polardb, datahub, drds, and analyticdb_for_mysql. If you do not configure this parameter, DataWorks applies the default global configuration to all sources.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'docRequired' => true,
+ 'example' => 'mysql',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'Success' => [
+ 'description' => 'Indicates whether the request was successful. Valid values:'."\n"
+ ."\n"
+ .'* true'."\n"
+ .'* false'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'RequestId' => [
+ 'description' => 'The request ID.'."\n",
+ 'type' => 'string',
+ 'example' => '0000-ABCD-EFG ',
+ ],
+ 'Data' => [
+ 'description' => 'The information about the query.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'Config' => [
+ 'description' => 'The default global configuration of synchronization solutions. The value indicates the processing rules of different types of DDL messages. Example: {"RENAMECOLUMN":"WARNING","DROPTABLE":"WARNING","CREATETABLE":"WARNING","MODIFYCOLUMN":"WARNING","TRUNCATETABLE":"WARNING","DROPCOLUMN":"WARNING","ADDCOLUMN":"WARNING","RENAMETABLE":"WARNING"}'."\n"
+ ."\n"
+ .'Field description:'."\n"
+ ."\n"
+ .'* RENAMECOLUMN: renames a column.'."\n"
+ .'* DROPTABLE: deletes a table.'."\n"
+ .'* CREATETABLE: creates a table.'."\n"
+ .'* MODIFYCOLUMN: changes the data type of a column.'."\n"
+ .'* TRUNCATETABLE: clears a table.'."\n"
+ .'* DROPCOLUMN: deletes a column.'."\n"
+ .'* ADDCOLUMN: creates a column.'."\n"
+ .'* RENAMETABLE: renames a table.'."\n"
+ ."\n"
+ .'DataWorks processes a DDL message of a specific type based on the following rules:'."\n"
+ ."\n"
+ .'* WARNING: ignores the message and records an alert in real-time synchronization logs. The alert contains information about the situation that the message is ignored because of an execution error.'."\n"
+ .'* IGNORE: discards the message and does not send it to the destination.'."\n"
+ .'* CRITICAL: terminates the real-time synchronization node and sets the node status to Failed.'."\n"
+ .'* NORMAL: sends the message to the destination to process the message. Each destination processes DDL messages based on its own business logic. If DataWorks adopts the NORMAL policy, DataWorks only forwards DDL messages.'."\n",
+ 'type' => 'string',
+ 'example' => '{"RENAMECOLUMN":"WARNING","DROPTABLE":"WARNING","CREATETABLE":"WARNING","MODIFYCOLUMN":"WARNING","TRUNCATETABLE":"WARNING","DROPCOLUMN":"WARNING","ADDCOLUMN":"WARNING","RENAMETABLE":"WARNING"}',
+ ],
+ ],
+ ],
+ ],
+ 'description' => '',
+ ],
+ ],
+ ],
+ 'errorCodes' => [
+ 400 => [
+ [
+ 'errorCode' => 'Invalid.DI.Parameter',
+ 'errorMessage' => 'The parameter is invalid.',
+ ],
+ ],
+ 403 => [
+ [
+ 'errorCode' => 'Forbidden.DI.NoPrivilege',
+ 'errorMessage' => 'No access.',
+ ],
+ ],
+ 500 => [
+ [
+ 'errorCode' => 'InternalError.DI.Parameter',
+ 'errorMessage' => 'A DI internal error occurred.',
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"0000-ABCD-EFG\\\\t\\",\\n \\"Data\\": {\\n \\"Config\\": \\"{\\\\\\"RENAMECOLUMN\\\\\\":\\\\\\"WARNING\\\\\\",\\\\\\"DROPTABLE\\\\\\":\\\\\\"WARNING\\\\\\",\\\\\\"CREATETABLE\\\\\\":\\\\\\"WARNING\\\\\\",\\\\\\"MODIFYCOLUMN\\\\\\":\\\\\\"WARNING\\\\\\",\\\\\\"TRUNCATETABLE\\\\\\":\\\\\\"WARNING\\\\\\",\\\\\\"DROPCOLUMN\\\\\\":\\\\\\"WARNING\\\\\\",\\\\\\"ADDCOLUMN\\\\\\":\\\\\\"WARNING\\\\\\",\\\\\\"RENAMETABLE\\\\\\":\\\\\\"WARNING\\\\\\"}\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"<RequestId>0000-ABCD-EFG\\t</RequestId>\\n<Data>\\n <Config>{\\"RENAMECOLUMN\\":\\"WARNING\\",\\"DROPTABLE\\":\\"WARNING\\",\\"CREATETABLE\\":\\"WARNING\\",\\"MODIFYCOLUMN\\":\\"WARNING\\",\\"TRUNCATETABLE\\":\\"WARNING\\",\\"DROPCOLUMN\\":\\"WARNING\\",\\"ADDCOLUMN\\":\\"WARNING\\",\\"RENAMETABLE\\":\\"WARNING\\"}</Config>\\n</Data>\\n<Success>true</Success>","errorExample":""}]',
+ 'title' => 'ListDIProjectConfig',
+ 'summary' => 'Queries the default global configurations of synchronization solutions in a specified DataWorks workspace.',
+ 'description' => 'DataWorks allows you to specify a default global configuration only for the processing rules of DDL messages in synchronization solutions. After you configure the **processing rules of DDL messages** in synchronization solutions, the configuration is used as the default global configuration and applies to all real-time synchronization tasks in the solutions. You can modify the **processing rules of DDL messages** based on your business requirements. For more information about how to configure a synchronization solution, see [Synchronization solutions](~~199008~~).'."\n",
+ 'requestParamsDescription' => ' ',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ ],
+ 'UpdateDIProjectConfig' => [
+ 'methods' => [
+ 'post',
+ 'get',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ [
+ 'APP' => [],
+ ],
+ [
+ 'PrivateKey' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [],
+ 'parameters' => [
+ [
+ 'name' => 'ProjectId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the DataWorks workspace. You can log on to the [DataWorks console](https://workbench.data.aliyun.com/console) and go to the Workspace page to obtain the workspace ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => true,
+ 'docRequired' => true,
+ 'maximum' => '10000000000',
+ 'minimum' => '1',
+ 'example' => '10000',
+ ],
+ ],
+ [
+ 'name' => 'DestinationType',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The type of the destinations of the synchronization solutions. This parameter cannot be left empty. Valid values: analyticdb_for_mysql, odps, elasticsearch, holo, mysql, and polardb.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'odps',
+ ],
+ ],
+ [
+ 'name' => 'SourceType',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The type of the sources of the synchronization solutions. Valid values: oracle, mysql, polardb, datahub, drds, and analyticdb_for_mysql. If you do not configure this parameter, DataWorks applies the default global configuration to all sources.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'docRequired' => true,
+ 'example' => 'mysql',
+ ],
+ ],
+ [
+ 'name' => 'ProjectConfig',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The new default global configuration of the synchronization solutions. The value indicates the processing rules of different types of DDL messages. The value must be in the JSON format. Example: {"RENAMECOLUMN":"WARNING","DROPTABLE":"WARNING","CREATETABLE":"WARNING","MODIFYCOLUMN":"WARNING","TRUNCATETABLE":"WARNING","DROPCOLUMN":"WARNING","ADDCOLUMN":"WARNING","RENAMETABLE":"WARNING"}.'."\n"
+ ."\n"
+ .'Field description:'."\n"
+ ."\n"
+ .'* RENAMECOLUMN: renames a column.'."\n"
+ .'* DROPTABLE: deletes a table.'."\n"
+ .'* CREATETABLE: creates a table.'."\n"
+ .'* MODIFYCOLUMN: changes the data type of a column.'."\n"
+ .'* TRUNCATETABLE: clears a table.'."\n"
+ .'* DROPCOLUMN: deletes a column.'."\n"
+ .'* ADDCOLUMN: creates a column.'."\n"
+ .'* RENAMETABLE: renames a table.'."\n"
+ ."\n"
+ .'DataWorks processes a DDL message of a specific type based on the following rules:'."\n"
+ ."\n"
+ .'* WARNING: ignores the message and records an alert in real-time synchronization logs. The alert contains information about the situation that the message is ignored because of an execution error.'."\n"
+ .'* IGNORE: discards the message and does not send it to the destination.'."\n"
+ .'* CRITICAL: terminates the real-time synchronization task and sets the node status to Failed.'."\n"
+ .'* NORMAL: sends the message to the destination to process the message. Each destination processes DDL messages based on its own business logic. If DataWorks adopts the NORMAL policy, DataWorks only forwards DDL messages.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => '{"RENAMECOLUMN":"WARNING","DROPTABLE":"WARNING","CREATETABLE":"WARNING","MODIFYCOLUMN":"WARNING","TRUNCATETABLE":"WARNING","DROPCOLUMN":"WARNING","ADDCOLUMN":"WARNING","RENAMETABLE":"WARNING"}',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'Success' => [
+ 'description' => 'Indicates whether the request was successful. Valid values:'."\n"
+ ."\n"
+ .'* true'."\n"
+ .'* false'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'RequestId' => [
+ 'description' => 'The request ID. You can locate logs and troubleshoot issues based on the ID.'."\n",
+ 'type' => 'string',
+ 'example' => '0000-ABCD-EFG ',
+ ],
+ 'Data' => [
+ 'description' => 'The information about the modification.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'Status' => [
+ 'description' => 'Indicates whether the default global configuration of synchronization solutions is modified. Valid values:'."\n"
+ ."\n"
+ .'* success'."\n"
+ .'* fail'."\n",
+ 'type' => 'string',
+ 'example' => 'success',
+ ],
+ ],
+ ],
+ ],
+ 'description' => '',
+ ],
+ ],
+ ],
+ 'errorCodes' => [
+ 400 => [
+ [
+ 'errorCode' => 'Invalid.DI.Parameter',
+ 'errorMessage' => 'The parameter is invalid.',
+ ],
+ ],
+ 403 => [
+ [
+ 'errorCode' => 'Forbidden.DI.NoPrivilege',
+ 'errorMessage' => 'No access.',
+ ],
+ ],
+ 500 => [
+ [
+ 'errorCode' => 'InternalError.DI.Parameter',
+ 'errorMessage' => 'A DI internal error occurred.',
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"0000-ABCD-EFG\\\\t\\",\\n \\"Data\\": {\\n \\"Status\\": \\"success\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"<UpdateDIProjectConfigResponse>\\n <Success>true</Success>\\n <RequestId>0000-ABCD-EFG\\t</RequestId>\\n <Data>\\n <Status>success</Status>\\n </Data>\\n</UpdateDIProjectConfigResponse>","errorExample":""}]',
+ 'title' => 'UpdateDIProjectConfig',
+ 'summary' => 'Modifies the default global configuration of synchronization solutions in a DataWorks workspace.',
+ 'description' => 'DataWorks allows you to specify a default global configuration only for the processing rules of DDL messages in synchronization solutions. After you configure the **processing rules of DDL messages** in synchronization solutions, the configuration is used as the default global configuration and applies to all real-time synchronization tasks in the solutions. You can modify the **processing rules of DDL messages** based on your business requirements. For more information about how to configure a synchronization solution, see [Synchronization solutions](~~199008~~).'."\n",
+ 'requestParamsDescription' => ' ',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ ],
+ 'GetDISyncTask' => [
+ 'methods' => [
+ 'post',
+ 'get',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ [
+ 'APP' => [],
+ ],
+ [
+ 'PrivateKey' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'get',
+ 'abilityTreeCode' => '93929',
+ 'abilityTreeNodes' => [
+ 'FEATUREdideC95Y41',
+ ],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'ProjectId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the DataWorks workspace. You can log on to the [DataWorks console](https://workbench.data.aliyun.com/console) and go to the Workspace page to obtain the workspace ID.'."\n"
+ ."\n"
+ .'You must configure this parameter to specify the DataWorks workspace to which the API operation is applied.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => true,
+ 'docRequired' => true,
+ 'maximum' => '10000000000',
+ 'minimum' => '1',
+ 'example' => '10000',
+ ],
+ ],
+ [
+ 'name' => 'TaskType',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The type of the object that you want to query. Valid values:'."\n"
+ ."\n"
+ .'* DI_REALTIME: real-time synchronization task'."\n"
+ .'* DI_SOLUTION: data synchronization solution'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'DI_REALTIME',
+ ],
+ ],
+ [
+ 'name' => 'FileId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => '* If you set TaskType to DI_REALTIME, set this parameter to the ID of the real-time synchronization task that you want to deploy.'."\n"
+ .'* If you set TaskType to DI_SOLUTION, set this parameter to the ID of the data synchronization solution that you want to deploy.'."\n"
+ ."\n"
+ .'You can call the [ListFiles](~~173942~~) operation to query the ID of the real-time synchronization task or data synchronization solution.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => true,
+ 'docRequired' => true,
+ 'maximum' => '9999999999999999',
+ 'minimum' => '1',
+ 'example' => '100',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'description' => 'The response parameters.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'Success' => [
+ 'description' => 'Indicates whether the request was successful. Valid values:'."\n"
+ ."\n"
+ .'* True'."\n"
+ .'* False'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'RequestId' => [
+ 'description' => 'The request ID. You can locate logs and troubleshoot issues based on the ID.'."\n",
+ 'type' => 'string',
+ 'example' => '0bc1411515937635973**** ',
+ ],
+ 'Data' => [
+ 'description' => 'The returned results.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'Code' => [
+ 'description' => '* If the TaskType parameter is set to DI_REALTIME, the details of the real-time synchronization task are returned.'."\n"
+ .'* If the TaskType parameter is set to DI_SOLUTION, the value null is returned.'."\n",
+ 'type' => 'string',
+ 'example' => '{"extend":{"mode":"wizard","resourceGroup":"S_res_group_287114642182658_1560324290517"},"nodeDef":{},"order":{"hops":[{"from":"datahub_8htXSsfiS2vtZCVG","to":"datahub_CRHBAyGfhSaLmv2f"}]},"setting":{"errorLimit":{},"jvmOption":""},"steps":[{"stepType":"datahub","category":"writer","displayName":"DataHub1","parameter":{"batchSize":1000,"datasource":"datahub_cloud_dev_test","topic":"dwd_tfc_opt_speed_rid_amap_rt"},"name":"datahub_CRHBAyGfhSaLmv2f","gui":{"x":262,"y":325}},{"stepType":"datahub","displayName":"DataHub2","parameter":{"datasource":"datahub_uric_test","topic":"dwd_tfc_opt_speed_rid_amap_rt_330000","batchSize":1000},"name":"datahub_8htXSsfiS2vtZCVG","gui":{"x":268,"y":160.5},"category":"writer"}]}',
+ ],
+ 'Status' => [
+ 'description' => 'Indicates whether the details of the real-time synchronization task or data synchronization solution are obtained. Valid values:'."\n"
+ ."\n"
+ .'success: The details are obtained. fail: The details fail to be obtained.'."\n",
+ 'type' => 'string',
+ 'example' => 'success',
+ ],
+ 'Message' => [
+ 'description' => 'The cause of the failure to obtain the details of the real-time synchronization task or data synchronization solution.'."\n"
+ ."\n"
+ .'If the details of the real-time synchronization task or data synchronization solution are obtained, the value null is returned.'."\n",
+ 'type' => 'string',
+ 'example' => 'fileId:[100] is invalid.',
+ ],
+ 'AlarmList' => [
+ 'description' => 'The alert rules that are associated with the real-time synchronization task. The value of this parameter is an array.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The alert rule that is associated with the real-time synchronization task.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'Id' => [
+ 'description' => 'The ID of the alert rule.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '45242',
+ ],
+ 'Enabled' => [
+ 'description' => 'Indicates whether the alert rule is enabled.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'RuleName' => [
+ 'description' => 'The name of the alert rule.'."\n",
+ 'type' => 'string',
+ 'example' => 'Delay alert rule name 1',
+ ],
+ 'Metric' => [
+ 'description' => 'The alert type. Valid values:'."\n"
+ ."\n"
+ .'* taskStatus'."\n"
+ .'* bizDelay'."\n"
+ .'* taskFailoverCount'."\n"
+ .'* ddlUnsupport'."\n"
+ .'* ddlReport'."\n"
+ .'* totalDirtyRecordWriteInLines'."\n",
+ 'type' => 'string',
+ 'example' => 'taskStatus',
+ ],
+ 'Description' => [
+ 'description' => 'The description of the alert rule.'."\n",
+ 'type' => 'string',
+ 'example' => 'Description',
+ ],
+ 'AlarmRuleList' => [
+ 'description' => 'The alert notification settings. The value of this parameter is an array.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The alert notification setting.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'Level' => [
+ 'description' => '* WARNING'."\n"
+ .'* CRITICAL'."\n",
+ 'type' => 'string',
+ 'example' => 'WARNING',
+ ],
+ 'Comparator' => [
+ 'description' => 'The comparison operator, which indicates the method used to compare a metric with the alert rule.'."\n"
+ ."\n"
+ .'* \'=\''."\n"
+ .'* \'<\''."\n"
+ .'* \'>\''."\n",
+ 'type' => 'string',
+ 'example' => '=',
+ ],
+ 'Threshold' => [
+ 'description' => 'The threshold for the comparison between a metric and the alert rule.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '1',
+ ],
+ 'Duration' => [
+ 'description' => 'The duration that a condition is met before an alert is triggered. Unit: minutes.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '3',
+ ],
+ 'Aggregator' => [
+ 'description' => 'The calculation method of a metric. Valid values:'."\n"
+ ."\n"
+ .'* avg'."\n"
+ .'* max'."\n",
+ 'type' => 'string',
+ 'example' => 'avg',
+ ],
+ ],
+ ],
+ ],
+ 'NotifyRule' => [
+ 'description' => 'The settings for alert notification rules. The value of this parameter is an array.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'Interval' => [
+ 'description' => 'The alert interval. Unit: minutes.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '5',
+ ],
+ 'Warning' => [
+ 'description' => 'The settings for Warning-level alert notifications.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The alert notification method. Valid values:'."\n"
+ ."\n"
+ .'* Mail'."\n"
+ .'* Phone'."\n"
+ .'* Sms'."\n"
+ .'* Ding'."\n",
+ 'type' => 'string',
+ 'example' => 'Ding',
+ ],
+ ],
+ 'Critical' => [
+ 'description' => 'The settings for Critical-level alert notifications.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The alert notification method. Valid values:'."\n"
+ ."\n"
+ .'* Mail'."\n"
+ .'* Phone'."\n"
+ .'* Sms'."\n"
+ .'* Ding'."\n",
+ 'type' => 'string',
+ 'example' => 'Ding',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'SolutionDetail' => [
+ 'description' => '* If the TaskType parameter is set to DI_REALTIME, the value null is returned.'."\n"
+ .'* If the TaskType parameter is set to DI_SOLUTION, the details of the data synchronization solution are returned.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'Status' => [
+ 'description' => 'The status of the data synchronization solution. Valid values:'."\n"
+ ."\n"
+ .'* 0: successful'."\n"
+ .'* 1: not running'."\n"
+ .'* 2: running'."\n"
+ .'* 3: failed'."\n"
+ .'* 4: committed'."\n"
+ .'* 5: pending manual confirmation'."\n"
+ .'* 6: manually confirmed'."\n"
+ .'* 7: others'."\n"
+ .'* 8: waiting'."\n"
+ .'* 9: deleted'."\n",
+ 'type' => 'string',
+ 'example' => '0',
+ ],
+ 'Type' => [
+ 'description' => 'The type of the data synchronization solution.'."\n",
+ 'type' => 'string',
+ 'example' => 'holo',
+ ],
+ 'StartTime' => [
+ 'description' => 'The start time of the data synchronization solution.'."\n",
+ 'type' => 'string',
+ 'example' => '2021-12-07 14:40:51',
+ ],
+ 'CreatorName' => [
+ 'description' => 'The creator of the data synchronization solution.'."\n",
+ 'type' => 'string',
+ 'example' => 'dataworks_di',
+ ],
+ 'ProjectId' => [
+ 'description' => 'The ID of the project to which the data synchronization solution belongs.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '10000',
+ ],
+ 'SourceType' => [
+ 'description' => 'The type of the source of the data synchronization solution.'."\n",
+ 'type' => 'string',
+ 'example' => 'mysql',
+ ],
+ 'ProcessContent' => [
+ 'description' => 'The configuration details of the data synchronization solution.'."\n",
+ 'type' => 'string',
+ 'example' => '{"holoDatasource":"holo","offlineSyncConfig":{"nodeNameRule":"oneclick_holo_di_${db_table_name_src}_to_${db_table_name_dest}","resourceGroup":"group_219193793999490"},"processRuleId":1007,"readerConcurrent":10,"realtimeSyncConfig":{"content":{"order":{"hops":[{"from":"reader","to":"writer"}]},"setting":{"speed":{"readerConcurrent":10}},"steps":[{"stepType":"mysql","name":"reader","category":"reader","parameter":{"connection":[{"datasource":"mm","datasourceType":"mysql","table":[]}]}},{"stepType":"holo","name":"writer","category":"writer","parameter":{"datasource":"holo","writeMode":"replay","datasourceSchema":"public","tableMappingRule":{"datasource":[{"tableRule":[],"srcDatasourceName":"mm"}]}}}]},"extend":{"mode":"migration_holo","resourceGroup":"group_219193793999490"}},"setting":{"autoCreateWorkflow":true,"userDefinedFileNameExpression":"oneclick"},"srcType":"mysql","tableMappingRuleFromRealtimeSyncConfig":{"datasource":[{"srcDatasourceName":"mm","tableRule":[]}]}}',
+ ],
+ 'Name' => [
+ 'description' => 'The name of the data synchronization solution.'."\n",
+ 'type' => 'string',
+ 'example' => 'holo_20211206161025',
+ ],
+ 'ProcessExtra' => [
+ 'description' => 'The additional parameters of the data synchronization solution.'."\n",
+ 'type' => 'string',
+ 'example' => '{"processType":"new","tableNum":300}',
+ ],
+ 'SubmitTime' => [
+ 'description' => 'The time when the data synchronization solution was committed.'."\n",
+ 'type' => 'string',
+ 'example' => '2021-12-07 14:40:51',
+ ],
+ 'Id' => [
+ 'description' => 'The ID of the data synchronization solution.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '100',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'errorCodes' => [
+ 400 => [
+ [
+ 'errorCode' => 'Param.Invalid',
+ 'errorMessage' => 'The parameter is invalid.',
+ ],
+ ],
+ 403 => [
+ [
+ 'errorCode' => 'Forbidden.Access',
+ 'errorMessage' => 'Access is forbidden.',
+ ],
+ ],
+ 500 => [
+ [
+ 'errorCode' => 'InternalError.System',
+ 'errorMessage' => 'An internal error occurred.',
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"0bc1411515937635973****\\\\t\\",\\n \\"Data\\": {\\n \\"Code\\": \\"{\\\\\\"extend\\\\\\":{\\\\\\"mode\\\\\\":\\\\\\"wizard\\\\\\",\\\\\\"resourceGroup\\\\\\":\\\\\\"S_res_group_287114642182658_1560324290517\\\\\\"},\\\\\\"nodeDef\\\\\\":{},\\\\\\"order\\\\\\":{\\\\\\"hops\\\\\\":[{\\\\\\"from\\\\\\":\\\\\\"datahub_8htXSsfiS2vtZCVG\\\\\\",\\\\\\"to\\\\\\":\\\\\\"datahub_CRHBAyGfhSaLmv2f\\\\\\"}]},\\\\\\"setting\\\\\\":{\\\\\\"errorLimit\\\\\\":{},\\\\\\"jvmOption\\\\\\":\\\\\\"\\\\\\"},\\\\\\"steps\\\\\\":[{\\\\\\"stepType\\\\\\":\\\\\\"datahub\\\\\\",\\\\\\"category\\\\\\":\\\\\\"writer\\\\\\",\\\\\\"displayName\\\\\\":\\\\\\"DataHub1\\\\\\",\\\\\\"parameter\\\\\\":{\\\\\\"batchSize\\\\\\":1000,\\\\\\"datasource\\\\\\":\\\\\\"datahub_cloud_dev_test\\\\\\",\\\\\\"topic\\\\\\":\\\\\\"dwd_tfc_opt_speed_rid_amap_rt\\\\\\"},\\\\\\"name\\\\\\":\\\\\\"datahub_CRHBAyGfhSaLmv2f\\\\\\",\\\\\\"gui\\\\\\":{\\\\\\"x\\\\\\":262,\\\\\\"y\\\\\\":325}},{\\\\\\"stepType\\\\\\":\\\\\\"datahub\\\\\\",\\\\\\"displayName\\\\\\":\\\\\\"DataHub2\\\\\\",\\\\\\"parameter\\\\\\":{\\\\\\"datasource\\\\\\":\\\\\\"datahub_uric_test\\\\\\",\\\\\\"topic\\\\\\":\\\\\\"dwd_tfc_opt_speed_rid_amap_rt_330000\\\\\\",\\\\\\"batchSize\\\\\\":1000},\\\\\\"name\\\\\\":\\\\\\"datahub_8htXSsfiS2vtZCVG\\\\\\",\\\\\\"gui\\\\\\":{\\\\\\"x\\\\\\":268,\\\\\\"y\\\\\\":160.5},\\\\\\"category\\\\\\":\\\\\\"writer\\\\\\"}]}\\",\\n \\"Status\\": \\"success\\",\\n \\"Message\\": \\"fileId:[100] is invalid.\\",\\n \\"AlarmList\\": [\\n {\\n \\"Id\\": 45242,\\n \\"Enabled\\": true,\\n \\"RuleName\\": \\"Delay alert rule name 1\\",\\n \\"Metric\\": \\"taskStatus\\",\\n \\"Description\\": \\"Description\\",\\n \\"AlarmRuleList\\": [\\n {\\n \\"Level\\": \\"WARNING\\",\\n \\"Comparator\\": \\"=\\",\\n \\"Threshold\\": 1,\\n \\"Duration\\": 3,\\n \\"Aggregator\\": \\"avg\\"\\n }\\n ],\\n \\"NotifyRule\\": {\\n \\"Interval\\": 5,\\n \\"Warning\\": [\\n \\"Ding\\"\\n ],\\n \\"Critical\\": [\\n \\"Ding\\"\\n ]\\n }\\n }\\n ],\\n \\"SolutionDetail\\": {\\n \\"Status\\": \\"0\\",\\n \\"Type\\": \\"holo\\",\\n \\"StartTime\\": \\"2021-12-07 14:40:51\\",\\n \\"CreatorName\\": \\"dataworks_di\\",\\n \\"ProjectId\\": 10000,\\n \\"SourceType\\": \\"mysql\\",\\n \\"ProcessContent\\": \\"{\\\\\\"holoDatasource\\\\\\":\\\\\\"holo\\\\\\",\\\\\\"offlineSyncConfig\\\\\\":{\\\\\\"nodeNameRule\\\\\\":\\\\\\"oneclick_holo_di_${db_table_name_src}_to_${db_table_name_dest}\\\\\\",\\\\\\"resourceGroup\\\\\\":\\\\\\"group_219193793999490\\\\\\"},\\\\\\"processRuleId\\\\\\":1007,\\\\\\"readerConcurrent\\\\\\":10,\\\\\\"realtimeSyncConfig\\\\\\":{\\\\\\"content\\\\\\":{\\\\\\"order\\\\\\":{\\\\\\"hops\\\\\\":[{\\\\\\"from\\\\\\":\\\\\\"reader\\\\\\",\\\\\\"to\\\\\\":\\\\\\"writer\\\\\\"}]},\\\\\\"setting\\\\\\":{\\\\\\"speed\\\\\\":{\\\\\\"readerConcurrent\\\\\\":10}},\\\\\\"steps\\\\\\":[{\\\\\\"stepType\\\\\\":\\\\\\"mysql\\\\\\",\\\\\\"name\\\\\\":\\\\\\"reader\\\\\\",\\\\\\"category\\\\\\":\\\\\\"reader\\\\\\",\\\\\\"parameter\\\\\\":{\\\\\\"connection\\\\\\":[{\\\\\\"datasource\\\\\\":\\\\\\"mm\\\\\\",\\\\\\"datasourceType\\\\\\":\\\\\\"mysql\\\\\\",\\\\\\"table\\\\\\":[]}]}},{\\\\\\"stepType\\\\\\":\\\\\\"holo\\\\\\",\\\\\\"name\\\\\\":\\\\\\"writer\\\\\\",\\\\\\"category\\\\\\":\\\\\\"writer\\\\\\",\\\\\\"parameter\\\\\\":{\\\\\\"datasource\\\\\\":\\\\\\"holo\\\\\\",\\\\\\"writeMode\\\\\\":\\\\\\"replay\\\\\\",\\\\\\"datasourceSchema\\\\\\":\\\\\\"public\\\\\\",\\\\\\"tableMappingRule\\\\\\":{\\\\\\"datasource\\\\\\":[{\\\\\\"tableRule\\\\\\":[],\\\\\\"srcDatasourceName\\\\\\":\\\\\\"mm\\\\\\"}]}}}]},\\\\\\"extend\\\\\\":{\\\\\\"mode\\\\\\":\\\\\\"migration_holo\\\\\\",\\\\\\"resourceGroup\\\\\\":\\\\\\"group_219193793999490\\\\\\"}},\\\\\\"setting\\\\\\":{\\\\\\"autoCreateWorkflow\\\\\\":true,\\\\\\"userDefinedFileNameExpression\\\\\\":\\\\\\"oneclick\\\\\\"},\\\\\\"srcType\\\\\\":\\\\\\"mysql\\\\\\",\\\\\\"tableMappingRuleFromRealtimeSyncConfig\\\\\\":{\\\\\\"datasource\\\\\\":[{\\\\\\"srcDatasourceName\\\\\\":\\\\\\"mm\\\\\\",\\\\\\"tableRule\\\\\\":[]}]}}\\",\\n \\"Name\\": \\"holo_20211206161025\\",\\n \\"ProcessExtra\\": \\"{\\\\\\"processType\\\\\\":\\\\\\"new\\\\\\",\\\\\\"tableNum\\\\\\":300}\\",\\n \\"SubmitTime\\": \\"2021-12-07 14:40:51\\",\\n \\"Id\\": 100\\n }\\n }\\n}","errorExample":""},{"type":"xml","example":"<GetDISyncTaskResponse>\\n <Success>true</Success>\\n <RequestId>0bc1411515937635973****\\t</RequestId>\\n <Data>\\n <Code>{\\"extend\\":{\\"mode\\":\\"wizard\\",\\"resourceGroup\\":\\"S_res_group_287114642182658_1560324290517\\"},\\"nodeDef\\":{},\\"order\\":{\\"hops\\":[{\\"from\\":\\"datahub_8htXSsfiS2vtZCVG\\",\\"to\\":\\"datahub_CRHBAyGfhSaLmv2f\\"}]},\\"setting\\":{\\"errorLimit\\":{},\\"jvmOption\\":\\"\\"},\\"steps\\":[{\\"stepType\\":\\"datahub\\",\\"category\\":\\"writer\\",\\"displayName\\":\\"DataHub1\\",\\"parameter\\":{\\"batchSize\\":1000,\\"datasource\\":\\"datahub_cloud_dev_test\\",\\"topic\\":\\"dwd_tfc_opt_speed_rid_amap_rt\\"},\\"name\\":\\"datahub_CRHBAyGfhSaLmv2f\\",\\"gui\\":{\\"x\\":262,\\"y\\":325}},{\\"stepType\\":\\"datahub\\",\\"displayName\\":\\"DataHub2\\",\\"parameter\\":{\\"datasource\\":\\"datahub_uric_test\\",\\"topic\\":\\"dwd_tfc_opt_speed_rid_amap_rt_330000\\",\\"batchSize\\":1000},\\"name\\":\\"datahub_8htXSsfiS2vtZCVG\\",\\"gui\\":{\\"x\\":268,\\"y\\":160.5},\\"category\\":\\"writer\\"}]}</Code>\\n <Status>success</Status>\\n <Message>fileId:[100] is invalid.</Message>\\n <SolutionDetail>\\n <Status>0</Status>\\n <Type>holo</Type>\\n <StartTime>2021-12-07 14:40:51</StartTime>\\n <CreatorName>dataworks_di</CreatorName>\\n <ProjectId>10000</ProjectId>\\n <SourceType>mysql</SourceType>\\n <ProcessContent>{\\"holoDatasource\\":\\"holo\\",\\"offlineSyncConfig\\":{\\"nodeNameRule\\":\\"oneclick_holo_di_${db_table_name_src}_to_${db_table_name_dest}\\",\\"resourceGroup\\":\\"group_219193793999490\\"},\\"processRuleId\\":1007,\\"readerConcurrent\\":10,\\"realtimeSyncConfig\\":{\\"content\\":{\\"order\\":{\\"hops\\":[{\\"from\\":\\"reader\\",\\"to\\":\\"writer\\"}]},\\"setting\\":{\\"speed\\":{\\"readerConcurrent\\":10}},\\"steps\\":[{\\"stepType\\":\\"mysql\\",\\"name\\":\\"reader\\",\\"category\\":\\"reader\\",\\"parameter\\":{\\"connection\\":[{\\"datasource\\":\\"mm\\",\\"datasourceType\\":\\"mysql\\",\\"table\\":[]}]}},{\\"stepType\\":\\"holo\\",\\"name\\":\\"writer\\",\\"category\\":\\"writer\\",\\"parameter\\":{\\"datasource\\":\\"holo\\",\\"writeMode\\":\\"replay\\",\\"datasourceSchema\\":\\"public\\",\\"tableMappingRule\\":{\\"datasource\\":[{\\"tableRule\\":[],\\"srcDatasourceName\\":\\"mm\\"}]}}}]},\\"extend\\":{\\"mode\\":\\"migration_holo\\",\\"resourceGroup\\":\\"group_219193793999490\\"}},\\"setting\\":{\\"autoCreateWorkflow\\":true,\\"userDefinedFileNameExpression\\":\\"oneclick\\"},\\"srcType\\":\\"mysql\\",\\"tableMappingRuleFromRealtimeSyncConfig\\":{\\"datasource\\":[{\\"srcDatasourceName\\":\\"mm\\",\\"tableRule\\":[]}]}}</ProcessContent>\\n <Name>holo_20211206161025</Name>\\n <ProcessExtra>{\\"processType\\":\\"new\\",\\"tableNum\\":300}</ProcessExtra>\\n <SubmitTime>2021-12-07 14:40:51</SubmitTime>\\n <Id>100</Id>\\n </SolutionDetail>\\n </Data>\\n</GetDISyncTaskResponse>","errorExample":""}]',
+ 'title' => 'GetDISyncTask',
+ 'summary' => 'Queries the details of a real-time synchronization task or a data synchronization solution.',
+ 'requestParamsDescription' => ' ',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ ],
+ 'DeployDISyncTask' => [
+ 'methods' => [
+ 'post',
+ 'get',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ [
+ 'PrivateKey' => [],
+ ],
+ [
+ 'APP' => [],
+ ],
+ ],
+ 'operationType' => 'readAndWrite',
+ 'systemTags' => [
+ 'operationType' => 'get',
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'ProjectId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The type of the object that you want to deploy. Valid values:'."\n"
+ ."\n"
+ .'* DI_REALTIME: real-time synchronization node'."\n"
+ .'* DI_SOLUTION: data synchronization solution'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => true,
+ 'docRequired' => true,
+ 'maximum' => '10000000000',
+ 'minimum' => '1',
+ 'example' => '10000',
+ ],
+ ],
+ [
+ 'name' => 'TaskType',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The type of the object that you want to deploy. Valid values:'."\n"
+ ."\n"
+ .'* DI_REALTIME: real-time synchronization task'."\n"
+ .'* DI_SOLUTION: synchronization task created in Data Integration'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'DI_REALTIME',
+ ],
+ ],
+ [
+ 'name' => 'FileId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => '* If you set the TaskType parameter to DI_REALTIME, set the FileId parameter to the ID of the real-time synchronization task that you want to deploy.'."\n"
+ .'* If you set the TaskType parameter to DI_SOLUTION, set the FileId parameter to the ID of the synchronization task that you want to deploy.'."\n"
+ ."\n"
+ .'You can call the [ListFiles](~~173942~~) operation to query the ID of the real-time synchronization task or the synchronization task created in Data Integration.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => true,
+ 'docRequired' => true,
+ 'maximum' => '9999999999999999',
+ 'minimum' => '1',
+ 'example' => '100',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'description' => 'The response parameters.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'Success' => [
+ 'description' => 'The ID of the request. You can query logs and troubleshoot issues based on the ID.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'RequestId' => [
+ 'description' => 'The request ID. You can use the ID to query logs and troubleshoot issues.'."\n",
+ 'type' => 'string',
+ 'example' => '0bc1411515937635973****',
+ ],
+ 'Data' => [
+ 'description' => 'Indicates whether the real-time synchronization node or data synchronization solution is deployed. Valid values:'."\n"
+ ."\n"
+ .'* success: The real-time synchronization node or data synchronization solution is deployed.'."\n"
+ .'* fail: The real-time synchronization node or data synchronization solution fails to be deployed.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'Status' => [
+ 'description' => 'The cause of the failure to deploy the real-time synchronization node or data synchronization solution.'."\n"
+ ."\n"
+ .'If the real-time synchronization node or data synchronization solution is deployed, the value null is returned.'."\n",
+ 'type' => 'string',
+ 'example' => 'success',
+ ],
+ 'Message' => [
+ 'description' => 'The reason for the failure to publish a data integration synchronization task.'."\n"
+ ."\n"
+ .'If the data integration synchronization task is published successfully, the return value of this parameter is empty.',
+ 'type' => 'string',
+ 'example' => 'submit and deploy fail.',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'errorCodes' => [
+ 400 => [
+ [
+ 'errorCode' => 'Param.Invalid',
+ 'errorMessage' => 'The parameter is invalid.',
+ ],
+ ],
+ 403 => [
+ [
+ 'errorCode' => 'Forbidden.Access',
+ 'errorMessage' => 'Access is forbidden.',
+ ],
+ ],
+ 500 => [
+ [
+ 'errorCode' => 'InternalError.System',
+ 'errorMessage' => 'An internal error occurred.',
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"0bc14115159376359******\\",\\n \\"Data\\": {\\n \\"Status\\": \\"success\\",\\n \\"Message\\": \\"submit and deploy fail.\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"<DeployDISyncTaskResponse>\\n <Success>true</Success>\\n <RequestId>0bc1411515937635973****</RequestId>\\n <Data>\\n <Status>success</Status>\\n <Message>submit and deploy fail.</Message>\\n </Data>\\n</DeployDISyncTaskResponse>","errorExample":""}]',
+ 'title' => 'DeployDISyncTask',
+ 'summary' => 'Deploys a real-time synchronization task.',
+ ],
+ 'GetDISyncInstanceInfo' => [
+ 'methods' => [
+ 'post',
+ 'get',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ [
+ 'PrivateKey' => [],
+ ],
+ [
+ 'APP' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'get',
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'ProjectId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The DataWorks workspace ID. You can log on to the [DataWorks console](https://workbench.data.aliyun.com/console) and go to the Workspace page to query the ID.'."\n"
+ ."\n"
+ .'You must configure this parameter to specify the DataWorks workspace to which the API operation is applied.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => true,
+ 'docRequired' => true,
+ 'maximum' => '10000000000',
+ 'minimum' => '1',
+ 'example' => '10000',
+ ],
+ ],
+ [
+ 'name' => 'TaskType',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The type of the object that you want to query. Valid values:'."\n"
+ ."\n"
+ .'* DI_REALTIME: real-time synchronization task'."\n"
+ .'* DI_SOLUTION: data synchronization solution'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'DI_REALTIME',
+ ],
+ ],
+ [
+ 'name' => 'FileId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => '* If you set the TaskType parameter to DI_REALTIME, set the FileId parameter to the ID of the real-time synchronization task that you want to query.'."\n"
+ .'* If you set the TaskType parameter to DI_SOLUTION, set the FileId parameter to the ID of the data synchronization solution that you want to query.'."\n"
+ ."\n"
+ .'You can call the [ListFiles](~~173942~~) operation to query the ID of the real-time synchronization task or data synchronization solution.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => true,
+ 'docRequired' => true,
+ 'maximum' => '9999999999999999',
+ 'minimum' => '1',
+ 'example' => '100',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'description' => 'The returned data.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'Success' => [
+ 'description' => 'Indicates whether the request was successful. Valid values:'."\n"
+ ."\n"
+ .'* true'."\n"
+ .'* false'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'RequestId' => [
+ 'description' => 'The request ID.'."\n",
+ 'type' => 'string',
+ 'example' => '0bc1411515937635973****',
+ ],
+ 'Data' => [
+ 'description' => 'The status of the real-time synchronization task or data synchronization solution.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'Status' => [
+ 'description' => '* If the TaskType parameter is set to DI_REALTIME, the Status parameter indicates the status of the real-time synchronization task. Valid values: PAUSE, NORUN, RUN, KILLING, and WAIT.'."\n"
+ .'* If the TaskType parameter is set to DI_SOLUTION, the Status parameter indicates the status of the data synchronization solution. Valid values: success and fail.'."\n",
+ 'type' => 'string',
+ 'example' => 'RUN',
+ ],
+ 'Message' => [
+ 'description' => 'The cause of the failure to obtain the status of the real-time synchronization task or data synchronization solution. If the status of the real-time synchronization task or data synchronization solution is obtained, the value null is returned.'."\n",
+ 'type' => 'string',
+ 'example' => 'fileId[100] is invalid',
+ ],
+ 'Name' => [
+ 'description' => '* If the TaskType parameter is set to DI_REALTIME, the Name parameter indicates the name of the real-time synchronization task.'."\n"
+ .'* If the TaskType parameter is set to DI_SOLUTION, the value null is returned.'."\n",
+ 'type' => 'string',
+ 'example' => 'streamx_name',
+ ],
+ 'SolutionInfo' => [
+ 'description' => '* If the TaskType parameter is set to DI_REALTIME, the value null is returned.'."\n"
+ .'* If the TaskType parameter is set to DI_SOLUTION, the SolutionInfo parameter indicates the details of the data synchronization solution.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'Status' => [
+ 'description' => 'The status of the data synchronization solution.'."\n",
+ 'type' => 'string',
+ 'example' => 'run',
+ ],
+ 'Id' => [
+ 'description' => 'The ID of the data synchronization solution.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '100',
+ ],
+ 'CreatorName' => [
+ 'description' => 'The creator of the data synchronization solution.'."\n",
+ 'type' => 'string',
+ 'example' => 'dataworks_3h1',
+ ],
+ 'StepDetail' => [
+ 'description' => 'The step details of the data synchronization solution.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The returned data.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'Status' => [
+ 'description' => 'The status of the step in the data synchronization solution.'."\n",
+ 'type' => 'string',
+ 'example' => 'success',
+ ],
+ 'StepId' => [
+ 'description' => 'The ID of the step in the data synchronization solution.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '1',
+ ],
+ 'StepName' => [
+ 'description' => 'The name of the step in the data synchronization solution.'."\n",
+ 'type' => 'string',
+ 'example' => 'Create a base table',
+ ],
+ 'Info' => [
+ 'description' => 'The information of the data synchronization solution.'."\n",
+ 'type' => 'string',
+ 'example' => '{\\"fusionProps\\":{\\"dataSource\\":[{\\"fileName\\":\\"holo_20221020161613\\",\\"status\\":\\"SUCCESS\\"}]},\\"customProps\\":{\\"showSN\\":true,\\"columns\\":[{\\"dataIndex\\":\\"fileName\\",\\"width\\":0.8,\\"title\\":\\"Real-time synchronization name\\"},{\\"dataIndex\\":\\"status\\",\\"width\\":0.2,\\"title\\":\\"Status\\"}]},\\"componentName\\":\\"Table\\"}',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'errorCodes' => [
+ 400 => [
+ [
+ 'errorCode' => 'Param.Invalid',
+ 'errorMessage' => 'The parameter is invalid.',
+ ],
+ ],
+ 403 => [
+ [
+ 'errorCode' => 'Forbidden.Access',
+ 'errorMessage' => 'Access is forbidden.',
+ ],
+ ],
+ 500 => [
+ [
+ 'errorCode' => 'InternalError.System',
+ 'errorMessage' => 'An internal error occurred.',
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"0bc1411515937635973****\\",\\n \\"Data\\": {\\n \\"Status\\": \\"RUN\\",\\n \\"Message\\": \\"fileId[100] is invalid\\",\\n \\"Name\\": \\"streamx_name\\",\\n \\"SolutionInfo\\": {\\n \\"Status\\": \\"run\\",\\n \\"Id\\": 100,\\n \\"CreatorName\\": \\"dataworks_3h1\\",\\n \\"StepDetail\\": [\\n {\\n \\"Status\\": \\"success\\",\\n \\"StepId\\": 1,\\n \\"StepName\\": \\"Create a base table\\",\\n \\"Info\\": \\"{\\\\\\\\\\\\\\"fusionProps\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\"dataSource\\\\\\\\\\\\\\":[{\\\\\\\\\\\\\\"fileName\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"holo_20221020161613\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"status\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"SUCCESS\\\\\\\\\\\\\\"}]},\\\\\\\\\\\\\\"customProps\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\"showSN\\\\\\\\\\\\\\":true,\\\\\\\\\\\\\\"columns\\\\\\\\\\\\\\":[{\\\\\\\\\\\\\\"dataIndex\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"fileName\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"width\\\\\\\\\\\\\\":0.8,\\\\\\\\\\\\\\"title\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"Real-time synchronization name\\\\\\\\\\\\\\"},{\\\\\\\\\\\\\\"dataIndex\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"status\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"width\\\\\\\\\\\\\\":0.2,\\\\\\\\\\\\\\"title\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"Status\\\\\\\\\\\\\\"}]},\\\\\\\\\\\\\\"componentName\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"Table\\\\\\\\\\\\\\"}\\"\\n }\\n ]\\n }\\n }\\n}","errorExample":""},{"type":"xml","example":"<GetDISyncInstanceInfoResponse>\\n <Success>true</Success>\\n <RequestId>0bc1411515937635973****</RequestId>\\n <Data>\\n <Status>RUN</Status>\\n <Message>fileId[100] is invalid</Message>\\n <Name>streamx_name</Name>\\n <SolutionInfo>\\n <Status>run</Status>\\n <Id>100</Id>\\n <CreatorName>dataworks_3h1</CreatorName>\\n <StepDetail>\\n <Status>success</Status>\\n <StepId>1</StepId>\\n <StepName>创建base表</StepName>\\n <Info>{\\\\\\"fusionProps\\\\\\":{\\\\\\"dataSource\\\\\\":[{\\\\\\"fileName\\\\\\":\\\\\\"holo_20221020161613\\\\\\",\\\\\\"status\\\\\\":\\\\\\"SUCCESS\\\\\\"}]},\\\\\\"customProps\\\\\\":{\\\\\\"showSN\\\\\\":true,\\\\\\"columns\\\\\\":[{\\\\\\"dataIndex\\\\\\":\\\\\\"fileName\\\\\\",\\\\\\"width\\\\\\":0.8,\\\\\\"title\\\\\\":\\\\\\"实时同步名称\\\\\\"},{\\\\\\"dataIndex\\\\\\":\\\\\\"status\\\\\\",\\\\\\"width\\\\\\":0.2,\\\\\\"title\\\\\\":\\\\\\"状态\\\\\\"}]},\\\\\\"componentName\\\\\\":\\\\\\"Table\\\\\\"}</Info>\\n </StepDetail>\\n </SolutionInfo>\\n </Data>\\n</GetDISyncInstanceInfoResponse>","errorExample":""}]',
+ 'title' => 'GetDISyncInstanceInfo',
+ 'summary' => 'Queries the status of a real-time synchronization task or a data synchronization solution.',
+ ],
+ 'TerminateDISyncInstance' => [
+ 'methods' => [
+ 'post',
+ 'get',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ [
+ 'PrivateKey' => [],
+ ],
+ [
+ 'APP' => [],
+ ],
+ ],
+ 'operationType' => 'readAndWrite',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'get',
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'ProjectId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the DataWorks workspace. You can log on to the [DataWorks console](https://workbench.data.aliyun.com/console) and go to the Workspace page to obtain the workspace ID.'."\n"
+ ."\n"
+ .'You must configure this parameter to specify the DataWorks workspace to which the API operation is applied.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => true,
+ 'docRequired' => true,
+ 'maximum' => '10000000000',
+ 'minimum' => '1',
+ 'example' => '10000',
+ ],
+ ],
+ [
+ 'name' => 'TaskType',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The value DI_REALTIME indicates that the task is a real-time synchronization task.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'DI_REALTIME',
+ ],
+ ],
+ [
+ 'name' => 'FileId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the real-time synchronization task.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => true,
+ 'docRequired' => true,
+ 'maximum' => '9999999999999999',
+ 'minimum' => '1',
+ 'example' => '100',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'description' => 'The response parameters.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'Success' => [
+ 'description' => 'Indicates whether the request was successful. Valid values:'."\n"
+ ."\n"
+ .'* true'."\n"
+ .'* false'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'RequestId' => [
+ 'description' => 'The request ID. You can locate logs and troubleshoot issues based on the ID.'."\n",
+ 'type' => 'string',
+ 'example' => '0bc1411515937635973****',
+ ],
+ 'Data' => [
+ 'description' => 'The returned results.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'Status' => [
+ 'description' => 'Indicates whether the real-time synchronization task is undeployed. Valid values:'."\n"
+ ."\n"
+ .'* success'."\n"
+ .'* fail'."\n",
+ 'type' => 'string',
+ 'example' => 'success',
+ ],
+ 'Message' => [
+ 'description' => 'The reason why the real-time synchronization task fails to be terminated. If the real-time synchronization task is undeployed, the value of this parameter is null.'."\n",
+ 'type' => 'string',
+ 'example' => 'fileId:[100] is invalid.',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'errorCodes' => [
+ 400 => [
+ [
+ 'errorCode' => 'Param.Invalid',
+ 'errorMessage' => 'The parameter is invalid.',
+ ],
+ ],
+ 403 => [
+ [
+ 'errorCode' => 'Forbidden.Access',
+ 'errorMessage' => 'Access is forbidden.',
+ ],
+ ],
+ 500 => [
+ [
+ 'errorCode' => 'InternalError.System',
+ 'errorMessage' => 'An internal error occurred.',
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"0bc1411515937635973****\\",\\n \\"Data\\": {\\n \\"Status\\": \\"success\\",\\n \\"Message\\": \\"fileId:[100] is invalid.\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"<TerminateDISyncInstanceResponse>\\n <Success>true</Success>\\n <RequestId>0bc1411515937635973****</RequestId>\\n <Data>\\n <Status>success</Status>\\n <Message>fileId:[100] is invalid.</Message>\\n </Data>\\n</TerminateDISyncInstanceResponse>","errorExample":""}]',
+ 'title' => 'TerminateDISyncInstance',
+ 'summary' => 'Undeploys a real-time synchronization task.',
+ ],
+ 'GenerateDISyncTaskConfigForCreating' => [
+ 'methods' => [
+ 'post',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ [
+ 'APP' => [],
+ ],
+ [
+ 'PrivateKey' => [],
+ ],
+ ],
+ 'operationType' => 'readAndWrite',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'get',
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'ProjectId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The DataWorks workspace ID. You can log on to the [DataWorks console](https://workbench.data.aliyun.com/console) and go to the Workspace page to obtain the ID.'."\n"
+ ."\n"
+ .'You must configure this parameter to specify the DataWorks workspace to which the API operation is applied.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => true,
+ 'docRequired' => true,
+ 'maximum' => '10000000000',
+ 'minimum' => '1',
+ 'example' => '10000',
+ ],
+ ],
+ [
+ 'name' => 'TaskType',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The type of task that you want to create in Data Integration in asynchronous mode. Valid values:'."\n"
+ ."\n"
+ .'* DI_REALTIME: real-time synchronization task'."\n"
+ .'* DI_SOLUTION: another type of synchronization task'."\n"
+ ."\n"
+ .'DataWorks allows you to create real-time synchronization tasks and other types of synchronization tasks in Data Integration only in asynchronous mode.'."\n"
+ ."\n"
+ .'* DI_OFFLINE'."\n"
+ .'* DI_REALTIME'."\n"
+ .'* DI_SOLUTION'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'enumValueTitles' => [],
+ 'example' => 'DI_REALTIME',
+ 'enum' => [
+ 'DI_OFFLINE',
+ 'DI_REALTIME',
+ 'DI_SOLUTION',
+ ],
+ ],
+ ],
+ [
+ 'name' => 'TaskParam',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The script for the synchronization task. DataWorks allows you to create the following types of synchronization tasks:'."\n"
+ ."\n"
+ .'* Synchronization task that is used to synchronize data from MySQL to MaxCompute'."\n"
+ .'* Synchronization task that is used to synchronize data from MySQL data to Kafka'."\n"
+ .'* Synchronization task that is used to synchronize data from MySQL to Hologres'."\n"
+ ."\n"
+ .'The SelectedTables parameter is used to specify tables that you want to synchronize from multiple databases. The Tables parameter is used to specify tables that you want to synchronize from a single database.'."\n"
+ ."\n"
+ .'* If the script contains the SelectedTables parameter, the system synchronizes data from the tables that you specify in the SelectedTables parameter.'."\n"
+ .'* If the script contains the Tables parameter, the system synchronizes data from the tables that you specify in the Tables parameter.'."\n"
+ ."\n"
+ .'The following sample code provides a script for data synchronization from MySQL to MaxCompute:'."\n"
+ ."\n"
+ .' {'."\n"
+ .' "type": "realtime",'."\n"
+ .' "version": "1.0",'."\n"
+ .' "setting": {'."\n"
+ .' "resourceGroup": "S_res_group_280749521950784_1623033752022",'."\n"
+ .' "taskType": "oneclick_to_odps"'."\n"
+ .' },'."\n"
+ .' "steps": ['."\n"
+ .' {'."\n"
+ .' "stepType": "mysql",'."\n"
+ .' "parameter": {'."\n"
+ .' "connection": ['."\n"
+ .' {'."\n"
+ .' "datasourceType": "mysql",'."\n"
+ .' "datasource": "mysql_pub1",'."\n"
+ .' "selectedTables": ['."\n"
+ .' {'."\n"
+ .' "dbName": "mysql_db",'."\n"
+ .' "schema": ['."\n"
+ .' {'."\n"
+ .' "tableInfos": ['."\n"
+ .' {'."\n"
+ .' "table": "molin_di_test_in_pk_v4"'."\n"
+ .' }'."\n"
+ .' ]'."\n"
+ .' }'."\n"
+ .' ]'."\n"
+ .' }'."\n"
+ .' ]'."\n"
+ .' }'."\n"
+ .' ]'."\n"
+ .' },'."\n"
+ .' "name": "Reader",'."\n"
+ .' "category": "reader"'."\n"
+ .' },'."\n"
+ .' {'."\n"
+ .' "stepType": "odps",'."\n"
+ .' "parameter": {'."\n"
+ .' "datasource": "odps_source"'."\n"
+ .' },'."\n"
+ .' "name": "Writer",'."\n"
+ .' "category": "writer"'."\n"
+ .' }'."\n"
+ .' ]'."\n"
+ .' }'."\n"
+ ."\n"
+ .'The following sample code provides a script for data synchronization from MySQL to Kafka:'."\n"
+ ."\n"
+ .' {'."\n"
+ .' "type": "realtime",'."\n"
+ .' "version": "1.0",'."\n"
+ .' "setting": {'."\n"
+ .' "resourceGroup": "S_res_group_280749521950784_1623033752022",'."\n"
+ .' "taskType": "oneclick_to_kafka"'."\n"
+ .' },'."\n"
+ .' "steps": ['."\n"
+ .' {'."\n"
+ .' "stepType": "mysql",'."\n"
+ .' "parameter": {'."\n"
+ .' "connection": ['."\n"
+ .' {'."\n"
+ .' "datasourceType": "mysql",'."\n"
+ .' "datasource": "pkset_test",'."\n"
+ .' "selectedTables": ['."\n"
+ .' {'."\n"
+ .' "dbName": "mysql_db",'."\n"
+ .' "schema": ['."\n"
+ .' {'."\n"
+ .' "tableInfos": ['."\n"
+ .' {'."\n"
+ .' "table": "molin_di_test_in_pk_v4"'."\n"
+ .' }'."\n"
+ .' ]'."\n"
+ .' }'."\n"
+ .' ]'."\n"
+ .' }'."\n"
+ .' ]'."\n"
+ .' }'."\n"
+ .' ]'."\n"
+ .' },'."\n"
+ .' "name": "Reader",'."\n"
+ .' "category": "reader"'."\n"
+ .' },'."\n"
+ .' {'."\n"
+ .' "stepType": "kafka",'."\n"
+ .' "parameter": {'."\n"
+ .' "datasource": "azn_kafka"'."\n"
+ .' },'."\n"
+ .' "name": "Writer",'."\n"
+ .' "category": "writer"'."\n"
+ .' }'."\n"
+ .' ]'."\n"
+ .' }'."\n"
+ ."\n"
+ .'The following sample code provides a script for data synchronization from MySQL to Hologres:'."\n"
+ ."\n"
+ .' {'."\n"
+ .' "type": "realtime",'."\n"
+ .' "version": "1.0",'."\n"
+ .' "setting": {'."\n"
+ .' "resourceGroup": "S_res_group_280749521950784_1623033752022",'."\n"
+ .' "taskType": "oneclick_to_holo"'."\n"
+ .' },'."\n"
+ .' "steps": ['."\n"
+ .' {'."\n"
+ .' "stepType": "mysql",'."\n"
+ .' "parameter": {'."\n"
+ .' "connection": ['."\n"
+ .' {'."\n"
+ .' "datasourceType": "mysql",'."\n"
+ .' "datasource": "mysql_pub",'."\n"
+ .' "selectedTables": ['."\n"
+ .' {'."\n"
+ .' "dbName": "mysql_db",'."\n"
+ .' "schema": ['."\n"
+ .' {'."\n"
+ .' "tableInfos": ['."\n"
+ .' {'."\n"
+ .' "table": "molin_di_test_in2_pk_v3"'."\n"
+ .' }'."\n"
+ .' ]'."\n"
+ .' }'."\n"
+ .' ]'."\n"
+ .' }'."\n"
+ .' ]'."\n"
+ .' }'."\n"
+ .' ]'."\n"
+ .' },'."\n"
+ .' "name": "Reader",'."\n"
+ .' "category": "reader"'."\n"
+ .' },'."\n"
+ .' {'."\n"
+ .' "stepType": "holo",'."\n"
+ .' "parameter": {'."\n"
+ .' "datasource": "holo"'."\n"
+ .' },'."\n"
+ .' "name": "Writer",'."\n"
+ .' "category": "writer"'."\n"
+ .' }'."\n"
+ .' ]'."\n"
+ .' }'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => '{ "type": "realtime", "version": "1.0", "setting": { "resourceGroup": "S_res_group_280749521950784_1623033752022", "scheduleResgroupId": 30003913, "name": "openapi_realtime_solution_0813_1739", "taskType": "oneclick_to_odps" }, "steps": [ { "stepType": "mysql", "parameter": { "connection": [ { "datasourceType": "mysql", "datasource": "mysql_pub", "table": [ "xyx" ] } ] }, "name": "Reader", "category": "reader" }, { "stepType": "odps", "parameter": { "datasource": "odps_first" }, "name": "Writer", "category": "writer" } ] }',
+ ],
+ ],
+ [
+ 'name' => 'ClientToken',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The client token that is used to ensure the idempotence of the request. This parameter is used to prevent repeated operations that are caused by multiple calls.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'ABFUOEUOTRTRJKE',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'description' => 'The response parameters.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'Success' => [
+ 'description' => 'Indicates whether the request was successful. Valid values:'."\n"
+ ."\n"
+ .'* true'."\n"
+ .'* false'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'RequestId' => [
+ 'description' => 'The request ID.'."\n",
+ 'type' => 'string',
+ 'example' => '0bc1411515937635973****',
+ ],
+ 'Data' => [
+ 'description' => 'The information returned for the ID of the asynchronous thread.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'Status' => [
+ 'description' => 'Indicates whether the ID of the asynchronous thread is generated. Valid values: Valid values:'."\n"
+ ."\n"
+ .'* success: indicates that the ID of the asynchronous thread is generated.'."\n"
+ .'* fail: indicates that the ID of the asynchronous thread fails to be generated. You can view the reason for the failure and troubleshoot the issue based on the reason.'."\n",
+ 'type' => 'string',
+ 'example' => 'true',
+ ],
+ 'ProcessId' => [
+ 'description' => 'The ID of the asynchronous thread. You can call the [QueryDISyncTaskConfigProcessResult](~~383465~~) operation to obtain the asynchronously generated parameters based on the ID. The parameters are used to create a synchronization task in Data Integration.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '10',
+ ],
+ 'Message' => [
+ 'description' => 'The reason why the ID of the asynchronous thread fails to be generated. If the ID is successfully generated, no value is returned for this parameter.'."\n",
+ 'type' => 'string',
+ 'example' => 'XXX is invalid.',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'errorCodes' => [
+ 400 => [
+ [
+ 'errorCode' => 'Invalid.DI.Parameter',
+ 'errorMessage' => 'The parameter is invalid.',
+ ],
+ [
+ 'errorCode' => 'Invalid.DI.Parameter.File.Existed',
+ 'errorMessage' => 'The file name already exists.',
+ ],
+ ],
+ 403 => [
+ [
+ 'errorCode' => 'Forbidden.DI.NoPrivilege',
+ 'errorMessage' => 'No access.',
+ ],
+ ],
+ 500 => [
+ [
+ 'errorCode' => 'InternalError.DI.Parameter',
+ 'errorMessage' => 'A DI internal error occurred.',
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"0bc1411515937635973****\\",\\n \\"Data\\": {\\n \\"Status\\": \\"true\\",\\n \\"ProcessId\\": 10,\\n \\"Message\\": \\"XXX is invalid.\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"<GenerateDISyncTaskConfigForCreatingResponse>\\n <Success>true</Success>\\n <RequestId>0bc1411515937635973****</RequestId>\\n <Data>\\n <Status>true</Status>\\n <ProcessId>10</ProcessId>\\n <Message>XXX is invalid.</Message>\\n </Data>\\n</GenerateDISyncTaskConfigForCreatingResponse>","errorExample":""}]',
+ 'title' => 'GenerateDISyncTaskConfigForCreating',
+ 'summary' => 'Generates an ID for an asynchronous thread that is used to create a synchronization task in Data Integration.',
+ 'description' => 'DataWorks allows you to use the [CreateDISyncTask](~~278725~~) operation to directly create a batch synchronization task in Data Integration. To create a real-time synchronization task or another type of synchronization task, you must first call the [GenerateDISyncTaskConfigForCreating](~~383463~~) operation to generate the ID of an asynchronous thread and call the [QueryDISyncTaskConfigProcessResult](~~383465~~) operation to obtain the asynchronously generated parameters based on the ID. Then, you can use the parameters as request parameters of [CreateDISyncTask](~~278725~~) and call the [CreateDISyncTask](~~278725~~) operation to create a real-time synchronization task or another type of synchronization task. DataWorks allows you to create real-time synchronization tasks and other types of synchronization tasks in Data Integration only in asynchronous mode.'."\n",
+ ],
+ 'GenerateDISyncTaskConfigForUpdating' => [
+ 'methods' => [
+ 'post',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ [
+ 'APP' => [],
+ ],
+ [
+ 'PrivateKey' => [],
+ ],
+ ],
+ 'operationType' => 'readAndWrite',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'get',
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'ProjectId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The DataWorks workspace ID. You can log on to the [DataWorks console](https://workbench.data.aliyun.com/console) and go to the Workspace page to obtain the workspace ID.'."\n"
+ ."\n"
+ .'You must configure this parameter to specify the DataWorks workspace to which the API operation is applied.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => true,
+ 'docRequired' => true,
+ 'maximum' => '10000000000',
+ 'minimum' => '1',
+ 'example' => '10000',
+ ],
+ ],
+ [
+ 'name' => 'TaskType',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The type of the object that you want to update in Data Integration in asynchronous mode. Valid values:'."\n"
+ ."\n"
+ .'* DI_REALTIME: real-time synchronization task'."\n"
+ .'* DI_SOLUTION: synchronization solution DataWorks allows you to create or update real-time synchronization tasks in Data Integration only in asynchronous mode.'."\n"
+ ."\n"
+ .'Valid values:'."\n"
+ ."\n"
+ .'* DI_OFFLINE'."\n"
+ .'* DI_REALTIME'."\n"
+ .'* DI_SOLUTION'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'DI_REALTIME',
+ 'enum' => [
+ 'DI_OFFLINE',
+ 'DI_REALTIME',
+ 'DI_SOLUTION',
+ ],
+ ],
+ ],
+ [
+ 'name' => 'TaskParam',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The script for updating the real-time synchronization task in Data Integration. DataWorks allows you to add or remove tables for a real-time synchronization task in Data Integration only in asynchronous mode. The following types of real-time synchronization tasks are supported:'."\n"
+ ."\n"
+ .'* Synchronization task that is used to synchronize data from MySQL to MaxCompute'."\n"
+ .'* Synchronization task that is used to synchronize data from MySQL data to Kafka'."\n"
+ .'* Synchronization task that is used to synchronize data from MySQL to Hologres'."\n"
+ ."\n"
+ .'The SelectedTables parameter is used to specify tables that you want to synchronize from multiple databases. The Tables parameter is used to specify tables that you want to synchronize from a single database.'."\n"
+ ."\n"
+ .'* If the script contains the SelectedTables parameter, the system synchronizes data from the tables that you specify in the SelectedTables parameter.'."\n"
+ .'* If the script contains the Tables parameter, the system synchronizes data from the tables that you specify in the Tables parameter.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => '{ "steps": [ { "parameter": { "connection": [ { "table": [ "xyx" ] } ] }, "name": "Reader", "category": "reader" } ] }',
+ ],
+ ],
+ [
+ 'name' => 'ClientToken',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The client token that is used to ensure the idempotence of the request. This parameter is used to prevent repeated operations that are caused by multiple calls.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'ABFUOEUOTRTRJKE',
+ ],
+ ],
+ [
+ 'name' => 'TaskId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The task ID.'."\n"
+ ."\n"
+ .'* If you set the TaskType parameter to DI_REALTIME, set the TaskId parameter to the value of the FileId parameter for the real-time synchronization task.'."\n"
+ .'* If you set the TaskType parameter to DI_SOLUTION, set the TaskId parameter to the value of the FileId parameter for the synchronization solution.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => true,
+ 'docRequired' => true,
+ 'maximum' => '9999999999999999',
+ 'minimum' => '0',
+ 'example' => '100',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'description' => 'The returned results.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'Success' => [
+ 'description' => 'Indicates whether the request was successful. Valid values:'."\n"
+ ."\n"
+ .'* true'."\n"
+ .'* false'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'RequestId' => [
+ 'description' => 'The request ID. You can locate logs and troubleshoot issues based on the ID.'."\n",
+ 'type' => 'string',
+ 'example' => '0bc1411515937635973****',
+ ],
+ 'Data' => [
+ 'description' => 'The information returned for the ID of the asynchronous thread.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'Status' => [
+ 'description' => 'Indicates whether the ID of the asynchronous thread is generated. Valid values:'."\n"
+ ."\n"
+ .'* success: indicates that the ID of the asynchronous thread is generated.'."\n"
+ .'* fail: indicates that the ID of the asynchronous thread fails to be generated. You can view the reason for the failure and troubleshoot the issue based on the reason.'."\n",
+ 'type' => 'string',
+ 'example' => 'true',
+ ],
+ 'ProcessId' => [
+ 'description' => 'The ID of the asynchronous thread. You can call the [QueryDISyncTaskConfigProcessResult](~~383465~~) operation to obtain the asynchronously generated parameters based on the ID. The parameters are used to update a real-time synchronization task in Data Integration.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '10',
+ ],
+ 'Message' => [
+ 'description' => 'The reason why the ID of the asynchronous thread fails to be generated. If the ID is successfully generated, no value is returned for this parameter.'."\n",
+ 'type' => 'string',
+ 'example' => 'XXX is invalid.',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'errorCodes' => [
+ 400 => [
+ [
+ 'errorCode' => 'Invalid.DI.Parameter',
+ 'errorMessage' => 'The parameter is invalid.',
+ ],
+ [
+ 'errorCode' => 'Invalid.DI.Parameter.File.Existed',
+ 'errorMessage' => 'The file name already exists.',
+ ],
+ ],
+ 403 => [
+ [
+ 'errorCode' => 'Forbidden.DI.NoPrivilege',
+ 'errorMessage' => 'No access.',
+ ],
+ ],
+ 500 => [
+ [
+ 'errorCode' => 'InternalError.DI.Parameter',
+ 'errorMessage' => 'A DI internal error occurred.',
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"0bc1411515937635973****\\",\\n \\"Data\\": {\\n \\"Status\\": \\"true\\",\\n \\"ProcessId\\": 10,\\n \\"Message\\": \\"XXX is invalid.\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"<GenerateDISyncTaskConfigForUpdatingResponse>\\n <Success>true</Success>\\n <RequestId>0bc1411515937635973****</RequestId>\\n <Data>\\n <Status>true</Status>\\n <ProcessId>10</ProcessId>\\n <Message>XXX is invalid.</Message>\\n </Data>\\n</GenerateDISyncTaskConfigForUpdatingResponse>","errorExample":""}]',
+ 'title' => 'GenerateDISyncTaskConfigForUpdating',
+ 'summary' => 'Generates the JSON for an asynchronous thread that is used to update a real-time synchronization task in Data Integration.',
+ 'description' => 'DataWorks allows you to use only the [UpdateDISyncTask](~~289109~~) operation to update a batch synchronization task in Data Integration. To update a real-time synchronization task, you must first call the GenerateDISyncTaskConfigForUpdating operation to generate the ID of an asynchronous thread and call the [QueryDISyncTaskConfigProcessResult](~~383465~~) operation to obtain the asynchronously generated parameters based on the ID. Then, you can call the UpdateDISyncTask operation and use the parameters as request parameters to update a real-time synchronization task in Data Integration. DataWorks allows you to create or update real-time synchronization tasks in Data Integration only in asynchronous mode.'."\n",
+ ],
+ 'StartDISyncInstance' => [
+ 'methods' => [
+ 'post',
+ 'get',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'readAndWrite',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'get',
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'ProjectId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the DataWorks workspace. You can log on to the [DataWorks console](https://workbench.data.aliyun.com/console) and go to the Workspace page to obtain the workspace ID. You must configure this parameter to specify the DataWorks workspace to which the API operation is applied.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => true,
+ 'docRequired' => true,
+ 'maximum' => '10000000000',
+ 'minimum' => '1',
+ 'example' => '10000',
+ ],
+ ],
+ [
+ 'name' => 'TaskType',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The type of the object that you want to start. Valid values:'."\n"
+ ."\n"
+ .'* DI_REALTIME: real-time synchronization task'."\n"
+ .'* DI_SOLUTION: data synchronization solution'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'DI_REALTIME',
+ ],
+ ],
+ [
+ 'name' => 'FileId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => '* If you set TaskType to DI_REALTIME, set this parameter to the ID of the real-time synchronization task that you want to start.'."\n"
+ .'* If you set TaskType to DI_SOLUTION, set this parameter to the ID of the data synchronization solution that you want to start.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => true,
+ 'docRequired' => true,
+ 'maximum' => '9999999999999999',
+ 'minimum' => '1',
+ 'example' => '100',
+ ],
+ ],
+ [
+ 'name' => 'StartParam',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => '* If you set TaskType to DI_REALTIME, the StartParam parameter specifies the startup parameters for the real-time synchronization task. The startup parameters include failover-related parameters, the parameter that specifies the number of dirty data records allowed, and the parameters in the data definition language (DDL) statements.'."\n"
+ .'* If you set TaskType to DI_SOLUTION, the StartParam parameter does not take effect.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => '{"failoverLimit":{"count":10,"interval":30},"errorLimit":{"record":0},"ddlMarkMap":{"RENAMECOLUMN":"WARNING","DROPTABLE":"WARNING","CREATETABLE":"IGNORE","MODIFYCOLUMN":"WARNING","TRUNCATETABLE":"NORMAL","DROPCOLUMN":"IGNORE","ADDCOLUMN":"NORMAL","RENAMETABLE":"CRITICAL"}}',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'description' => 'The response parameters.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'Success' => [
+ 'description' => 'Indicates whether the request was successful. Valid values:'."\n"
+ ."\n"
+ .'* true'."\n"
+ .'* false'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'RequestId' => [
+ 'description' => 'The request ID. You can locate logs and troubleshoot issues based on the ID.'."\n",
+ 'type' => 'string',
+ 'example' => '0bc1411515937635973****',
+ ],
+ 'Data' => [
+ 'description' => 'The result returned for the start.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'Status' => [
+ 'description' => 'Indicates whether the real-time synchronization task or the data synchronization solution is started. Valid values:'."\n"
+ ."\n"
+ .'* success: The real-time synchronization task or the data synchronization solution is started.'."\n"
+ .'* fail: The real-time synchronization task or the data synchronization solution fails to be started. You can troubleshoot the issue based on the provided cause.'."\n",
+ 'type' => 'string',
+ 'example' => 'success',
+ ],
+ 'Message' => [
+ 'description' => 'The reason why the real-time synchronization task or the data synchronization solution fails to be started.'."\n"
+ ."\n"
+ .'If the real-time synchronization task or the data synchronization solution is started, the value null is returned.'."\n",
+ 'type' => 'string',
+ 'example' => 'fileId:[100] is invalid.',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'errorCodes' => [
+ 400 => [
+ [
+ 'errorCode' => 'Param.Invalid',
+ 'errorMessage' => 'The parameter is invalid.',
+ ],
+ ],
+ 403 => [
+ [
+ 'errorCode' => 'Forbidden.Access',
+ 'errorMessage' => 'Access is forbidden.',
+ ],
+ ],
+ 500 => [
+ [
+ 'errorCode' => 'InternalError.System',
+ 'errorMessage' => 'An internal error occurred.',
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"0bc1411515937635973****\\",\\n \\"Data\\": {\\n \\"Status\\": \\"success\\",\\n \\"Message\\": \\"fileId:[100] is invalid.\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"<StartDISyncInstanceResponse>\\n <RequestId>0bc1411515937635973****</RequestId>\\n <Data>\\n <Status>success</Status>\\n <Message>fileId:[100] is invalid.</Message>\\n </Data>\\n <Success>true</Success>\\n</StartDISyncInstanceResponse>","errorExample":""}]',
+ 'title' => 'StartDISyncInstance',
+ 'summary' => 'Starts a real-time synchronization task or a synchronization solution.',
+ ],
+ 'StopDISyncInstance' => [
+ 'methods' => [
+ 'post',
+ 'get',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ [
+ 'PrivateKey' => [],
+ ],
+ [
+ 'APP' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'get',
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'ProjectId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the DataWorks workspace. You can log on to the [DataWorks console](https://workbench.data.aliyun.com/console) and go to the Workspace page to obtain the workspace ID.'."\n"
+ ."\n"
+ .'You must configure this parameter to specify the DataWorks workspace to which the API operation is applied.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => true,
+ 'docRequired' => true,
+ 'maximum' => '10000000000',
+ 'minimum' => '1',
+ 'example' => '10000',
+ ],
+ ],
+ [
+ 'name' => 'TaskType',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The type of the synchronization task that you want to stop. Set the value to DI_REALTIME.'."\n"
+ ."\n"
+ .'DI_REALTIME indicates a real-time synchronization task.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'DI_REALTIME',
+ ],
+ ],
+ [
+ 'name' => 'FileId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the synchronization task. You can call the [ListFiles](~~173942~~) operation to query the ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => true,
+ 'docRequired' => true,
+ 'maximum' => '9999999999999999',
+ 'minimum' => '1',
+ 'example' => '100',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'description' => 'The response parameters.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'Success' => [
+ 'description' => 'Indicates whether the request was successful. Valid values:'."\n"
+ ."\n"
+ .'* true'."\n"
+ .'* false'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'RequestId' => [
+ 'description' => 'The request ID. You can locate logs and troubleshoot issues based on the ID.'."\n",
+ 'type' => 'string',
+ 'example' => '0bc1411515937635973****',
+ ],
+ 'Data' => [
+ 'description' => 'The information returned for the synchronization task.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'Status' => [
+ 'description' => 'Indicates whether the synchronization task is stopped. Valid values:'."\n"
+ ."\n"
+ .'* success'."\n"
+ .'* fail'."\n",
+ 'type' => 'string',
+ 'example' => 'success',
+ ],
+ 'Message' => [
+ 'description' => 'The reason why the synchronization task fails to be stopped.'."\n"
+ ."\n"
+ .'If the synchronization task is stopped, the value null is returned.'."\n",
+ 'type' => 'string',
+ 'example' => 'fileId:[100] is invalid.',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'errorCodes' => [
+ 400 => [
+ [
+ 'errorCode' => 'Param.Invalid',
+ 'errorMessage' => 'The parameter is invalid.',
+ ],
+ ],
+ 403 => [
+ [
+ 'errorCode' => 'Forbidden.Access',
+ 'errorMessage' => 'Access is forbidden.',
+ ],
+ ],
+ 500 => [
+ [
+ 'errorCode' => 'InternalError.System',
+ 'errorMessage' => 'An internal error occurred.',
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"0bc1411515937635973****\\",\\n \\"Data\\": {\\n \\"Status\\": \\"success\\",\\n \\"Message\\": \\"fileId:[100] is invalid.\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"<StopDISyncInstanceResponse>\\n <Success>true</Success>\\n <RequestId>0bc1411515937635973****</RequestId>\\n <Data>\\n <Status>success</Status>\\n <Message>fileId:[100] is invalid.</Message>\\n </Data>\\n</StopDISyncInstanceResponse>","errorExample":""}]',
+ 'title' => 'StopDISyncInstance',
+ 'summary' => 'Stops a real-time synchronization task.',
+ ],
+ 'QueryDISyncTaskConfigProcessResult' => [
+ 'methods' => [
+ 'post',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ [
+ 'PrivateKey' => [],
+ ],
+ [
+ 'APP' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'get',
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'ProjectId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The DataWorks workspace ID. You can log on to the [DataWorks console](https://workbench.data.aliyun.com/console) and go to the Workspace page to obtain the ID.'."\n"
+ ."\n"
+ .'You must configure this parameter to specify the DataWorks workspace to which the API operation is applied.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => true,
+ 'docRequired' => true,
+ 'maximum' => '10000000000',
+ 'minimum' => '1',
+ 'example' => '10000',
+ ],
+ ],
+ [
+ 'name' => 'TaskType',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The type of the object that you want to create or update in Data Integration in asynchronous mode. Valid values:'."\n"
+ ."\n"
+ .'* DI_REALTIME: real-time synchronization task'."\n"
+ .'* DI_SOLUTION: synchronization solution DataWorks allows you to create or update real-time synchronization tasks and synchronization solutions in Data Integration only in asynchronous mode.'."\n"
+ ."\n"
+ .'Valid values:'."\n"
+ ."\n"
+ .'* DI_OFFLINE'."\n"
+ .'* DI_REALTIME'."\n"
+ .'* DI_SOLUTION'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'enumValueTitles' => [],
+ 'example' => 'DI_REALTIME',
+ 'enum' => [
+ 'DI_OFFLINE',
+ 'DI_REALTIME',
+ 'DI_SOLUTION',
+ ],
+ ],
+ ],
+ [
+ 'name' => 'AsyncProcessId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The asynchronous thread ID. You can call the [GenerateDISyncTaskConfigForCreating](~~383463~~) or [GenerateDISyncTaskConfigForUpdating](~~383464~~) operation to obtain the ID.'."\n"
+ ."\n"
+ .'* The GenerateDISyncTaskConfigForCreating operation is used to generate the ID of the asynchronous thread that is used to create a real-time synchronization task in Data Integration.'."\n"
+ .'* The GenerateDISyncTaskConfigForUpdating operation is used to generate the ID of the asynchronous thread that is used to update a real-time synchronization task in Data Integration.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => true,
+ 'docRequired' => true,
+ 'maximum' => '9999999999999999',
+ 'minimum' => '1',
+ 'example' => '10',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'description' => 'The returned results.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'Success' => [
+ 'description' => 'Indicates whether the request was successful. Valid values:'."\n"
+ ."\n"
+ .'* true'."\n"
+ .'* false'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'RequestId' => [
+ 'description' => 'The request ID. You can locate logs and troubleshoot issues based on the ID.'."\n",
+ 'type' => 'string',
+ 'example' => '0bc1411515937635973****',
+ ],
+ 'Data' => [
+ 'description' => 'The information returned for the parameters that are asynchronously generated and used to create or update a real-time synchronization task in Data Integration.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'Status' => [
+ 'description' => 'Indicates whether the parameters are obtained. Valid values:'."\n"
+ ."\n"
+ .'* success: The parameters are obtained.'."\n"
+ .'* fail: The parameters fail to be obtained. You can view the reason for the failure and troubleshoot the issue based on the reason.'."\n",
+ 'type' => 'string',
+ 'example' => 'success',
+ ],
+ 'Message' => [
+ 'description' => 'The reason why the parameters fail to be obtained. If the parameters are obtained, the value null is returned.'."\n",
+ 'type' => 'string',
+ 'example' => 'fileId:[100] is invalid.',
+ ],
+ 'TaskContent' => [
+ 'description' => 'The parameters that are obtained. The parameters are used as the request parameters of the [CreateDISyncTask](~~278725~~) or [UpdateDISyncTask](~~289109~~) operation to create or update a real-time synchronization task in Data Integration.'."\n",
+ 'type' => 'string',
+ 'example' => '{"extend":{"mode":"migration_holo","resourceGroup":"280749","name":"h"},"type":"job","steps":[{"stepType":"mysql","parameter":{"connection":[{"datasourceType":"mysql","datasource":"mm","selectedTables":[{"schema":[{"tableInfos":[{"enable":true,"table":"m_v1","tableName":"m_v1"}]}],"dbName":"m"}]}]},"name":"reader","category":"reader"},{"stepType":"holo","parameter":{"datasource":"h","tableMappingRule":{"datasource":[{"tableRule":[{"srcTable":"m_v1","mergeIntoCycleType":"DEFAULT","hourDeltaEnable":false,"dstTable":"m.m_v1","dayDeltaEnable":false,"primaryKeyInfo":{"column":["id"],"type":"pk"},"dstCreateTableInfo":{"indexType":"m_v1","dataColumn":[{"columnSize":0,"name":"id","index":0,"comment":"","newDigit":0,"type":"int8","digit":0,"primaryKey":true}],"schemaName":"m","tableName":"m_v1"},"srcDbName":"m"],"srcDatasourceName":"mm"}],"totalTableMapping":1},"writeMode":"replay"},"name":"writer","category":"writer"}],"version":"2.0","order":{"hops":[{"from":"reader","to":"writer"}]}}',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'errorCodes' => [
+ 400 => [
+ [
+ 'errorCode' => 'Param.Invalid',
+ 'errorMessage' => 'The parameter is invalid.',
+ ],
+ ],
+ 403 => [
+ [
+ 'errorCode' => 'Forbidden.Access',
+ 'errorMessage' => 'Access is forbidden.',
+ ],
+ ],
+ 500 => [
+ [
+ 'errorCode' => 'InternalError.System',
+ 'errorMessage' => 'An internal error occurred.',
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"0bc1411515937635973****\\",\\n \\"Data\\": {\\n \\"Status\\": \\"success\\",\\n \\"Message\\": \\"fileId:[100] is invalid.\\",\\n \\"TaskContent\\": \\"{\\\\\\"extend\\\\\\":{\\\\\\"mode\\\\\\":\\\\\\"migration_holo\\\\\\",\\\\\\"resourceGroup\\\\\\":\\\\\\"280749\\\\\\",\\\\\\"name\\\\\\":\\\\\\"h\\\\\\"},\\\\\\"type\\\\\\":\\\\\\"job\\\\\\",\\\\\\"steps\\\\\\":[{\\\\\\"stepType\\\\\\":\\\\\\"mysql\\\\\\",\\\\\\"parameter\\\\\\":{\\\\\\"connection\\\\\\":[{\\\\\\"datasourceType\\\\\\":\\\\\\"mysql\\\\\\",\\\\\\"datasource\\\\\\":\\\\\\"mm\\\\\\",\\\\\\"selectedTables\\\\\\":[{\\\\\\"schema\\\\\\":[{\\\\\\"tableInfos\\\\\\":[{\\\\\\"enable\\\\\\":true,\\\\\\"table\\\\\\":\\\\\\"m_v1\\\\\\",\\\\\\"tableName\\\\\\":\\\\\\"m_v1\\\\\\"}]}],\\\\\\"dbName\\\\\\":\\\\\\"m\\\\\\"}]}]},\\\\\\"name\\\\\\":\\\\\\"reader\\\\\\",\\\\\\"category\\\\\\":\\\\\\"reader\\\\\\"},{\\\\\\"stepType\\\\\\":\\\\\\"holo\\\\\\",\\\\\\"parameter\\\\\\":{\\\\\\"datasource\\\\\\":\\\\\\"h\\\\\\",\\\\\\"tableMappingRule\\\\\\":{\\\\\\"datasource\\\\\\":[{\\\\\\"tableRule\\\\\\":[{\\\\\\"srcTable\\\\\\":\\\\\\"m_v1\\\\\\",\\\\\\"mergeIntoCycleType\\\\\\":\\\\\\"DEFAULT\\\\\\",\\\\\\"hourDeltaEnable\\\\\\":false,\\\\\\"dstTable\\\\\\":\\\\\\"m.m_v1\\\\\\",\\\\\\"dayDeltaEnable\\\\\\":false,\\\\\\"primaryKeyInfo\\\\\\":{\\\\\\"column\\\\\\":[\\\\\\"id\\\\\\"],\\\\\\"type\\\\\\":\\\\\\"pk\\\\\\"},\\\\\\"dstCreateTableInfo\\\\\\":{\\\\\\"indexType\\\\\\":\\\\\\"m_v1\\\\\\",\\\\\\"dataColumn\\\\\\":[{\\\\\\"columnSize\\\\\\":0,\\\\\\"name\\\\\\":\\\\\\"id\\\\\\",\\\\\\"index\\\\\\":0,\\\\\\"comment\\\\\\":\\\\\\"\\\\\\",\\\\\\"newDigit\\\\\\":0,\\\\\\"type\\\\\\":\\\\\\"int8\\\\\\",\\\\\\"digit\\\\\\":0,\\\\\\"primaryKey\\\\\\":true}],\\\\\\"schemaName\\\\\\":\\\\\\"m\\\\\\",\\\\\\"tableName\\\\\\":\\\\\\"m_v1\\\\\\"},\\\\\\"srcDbName\\\\\\":\\\\\\"m\\\\\\"}],\\\\\\"srcDatasourceName\\\\\\":\\\\\\"mm\\\\\\"}],\\\\\\"totalTableMapping\\\\\\":1},\\\\\\"writeMode\\\\\\":\\\\\\"replay\\\\\\"},\\\\\\"name\\\\\\":\\\\\\"writer\\\\\\",\\\\\\"category\\\\\\":\\\\\\"writer\\\\\\"}],\\\\\\"version\\\\\\":\\\\\\"2.0\\\\\\",\\\\\\"order\\\\\\":{\\\\\\"hops\\\\\\":[{\\\\\\"from\\\\\\":\\\\\\"reader\\\\\\",\\\\\\"to\\\\\\":\\\\\\"writer\\\\\\"}]}}\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"<QueryDISyncTaskConfigProcessResultResponse>\\n <Success>true</Success>\\n <RequestId>0bc1411515937635973****</RequestId>\\n <Data>\\n <Status>success</Status>\\n <Message>fileId:[100] is invalid.</Message>\\n <TaskContent>{\\"extend\\":{\\"mode\\":\\"migration_holo\\",\\"resourceGroup\\":\\"280749\\",\\"name\\":\\"h\\"},\\"type\\":\\"job\\",\\"steps\\":[{\\"stepType\\":\\"mysql\\",\\"parameter\\":{\\"connection\\":[{\\"datasourceType\\":\\"mysql\\",\\"datasource\\":\\"mm\\",\\"selectedTables\\":[{\\"schema\\":[{\\"tableInfos\\":[{\\"enable\\":true,\\"table\\":\\"m_v1\\",\\"tableName\\":\\"m_v1\\"}]}],\\"dbName\\":\\"m\\"}]}]},\\"name\\":\\"reader\\",\\"category\\":\\"reader\\"},{\\"stepType\\":\\"holo\\",\\"parameter\\":{\\"datasource\\":\\"h\\",\\"tableMappingRule\\":{\\"datasource\\":[{\\"tableRule\\":[{\\"srcTable\\":\\"m_v1\\",\\"mergeIntoCycleType\\":\\"DEFAULT\\",\\"hourDeltaEnable\\":false,\\"dstTable\\":\\"m.m_v1\\",\\"dayDeltaEnable\\":false,\\"primaryKeyInfo\\":{\\"column\\":[\\"id\\"],\\"type\\":\\"pk\\"},\\"dstCreateTableInfo\\":{\\"indexType\\":\\"m_v1\\",\\"dataColumn\\":[{\\"columnSize\\":0,\\"name\\":\\"id\\",\\"index\\":0,\\"comment\\":\\"\\",\\"newDigit\\":0,\\"type\\":\\"int8\\",\\"digit\\":0,\\"primaryKey\\":true}],\\"schemaName\\":\\"m\\",\\"tableName\\":\\"m_v1\\"},\\"srcDbName\\":\\"m\\"}],\\"srcDatasourceName\\":\\"mm\\"}],\\"totalTableMapping\\":1},\\"writeMode\\":\\"replay\\"},\\"name\\":\\"writer\\",\\"category\\":\\"writer\\"}],\\"version\\":\\"2.0\\",\\"order\\":{\\"hops\\":[{\\"from\\":\\"reader\\",\\"to\\":\\"writer\\"}]}}</TaskContent>\\n </Data>\\n</QueryDISyncTaskConfigProcessResultResponse>","errorExample":""}]',
+ 'title' => 'QueryDISyncTaskConfigProcessResult',
+ 'summary' => 'Queries the execution results of an asynchronous task.',
+ 'description' => 'DataWorks allows you to call only the [CreateDISyncTask](~~278725~~) operation to create a batch synchronization task or the [UpdateDISyncTask](~~289109~~) operation to update a batch synchronization task in Data Integration. To create or update a real-time synchronization task, you must first call the [GenerateDISyncTaskConfigForCreating](~~383463~~) or [GenerateDISyncTaskConfigForUpdating](~~383464~~) operation to obtain the ID of an asynchronous thread and call the [QueryDISyncTaskConfigProcessResult](~~383465~~) operation to obtain the asynchronously generated parameters based on the ID. Then, you can call the CreateDISyncTask or UpdateDISyncTask operation and use the parameters as request parameters to create or update a real-time synchronization task. DataWorks allows you to create or update real-time synchronization tasks in Data Integration only in asynchronous mode.'."\n",
+ ],
+ 'CreateDIJob' => [
+ 'summary' => 'Creates a new-version synchronization task. The following types of synchronization tasks are supported: real-time synchronization of all data in a MySQL database to Hologres and batch synchronization of all data in a MySQL database to Hive.',
+ 'methods' => [
+ 'post',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'write',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'create',
+ 'abilityTreeCode' => '155151',
+ 'abilityTreeNodes' => [
+ 'FEATUREdideQHGTK4',
+ ],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'ProjectId',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The DataWorks workspace ID. You can call the [ListProjects](~~178393~~) operation to obtain the ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'example' => '10000',
+ ],
+ ],
+ [
+ 'name' => 'JobName',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The name of the synchronization task.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'mysql_to_holo_sync_8772',
+ ],
+ ],
+ [
+ 'name' => 'Description',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The description of the synchronization task.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'Synchronize mysql to hologres',
+ ],
+ ],
+ [
+ 'name' => 'MigrationType',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The synchronization type. Valid values:'."\n"
+ ."\n"
+ .'* FullAndRealtimeIncremental (one-time full synchronization and real-time incremental synchronization)'."\n"
+ .'* RealtimeIncremental (real-time incremental synchronization)'."\n"
+ .'* Full (full synchronization)'."\n"
+ .'* OfflineIncremental (batch incremental synchronization)'."\n"
+ .'* FullAndOfflineIncremental (one-time full synchronization and batch incremental synchronization)'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'enumValueTitles' => [],
+ 'example' => 'FullAndRealtimeIncremental',
+ ],
+ ],
+ [
+ 'name' => 'SourceDataSourceType',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The source type. Set this parameter to MySQL.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'enumValueTitles' => [],
+ 'example' => 'MySQL',
+ ],
+ ],
+ [
+ 'name' => 'DestinationDataSourceType',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The destination type. Valid values: Hologres and Hive.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'enumValueTitles' => [],
+ 'example' => 'Hologres',
+ ],
+ ],
+ [
+ 'name' => 'SourceDataSourceSettings',
+ 'in' => 'formData',
+ 'style' => 'json',
+ 'schema' => [
+ 'description' => 'The settings of the source. Only a single source is supported.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '',
+ 'type' => 'object',
+ 'properties' => [
+ 'DataSourceName' => [
+ 'description' => 'The name of the data source.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'mysql_datasource_1',
+ ],
+ 'DataSourceProperties' => [
+ 'description' => 'The properties of the data source.'."\n",
+ 'type' => 'object',
+ 'required' => false,
+ 'additionalProperties' => [
+ 'type' => 'string',
+ 'example' => 'TimeZone',
+ 'description' => 'The properties of the source. The properties of a MySQL data source include TimeZone and Encoding.'."\n",
+ ],
+ ],
+ ],
+ 'required' => false,
+ ],
+ 'required' => false,
+ ],
+ ],
+ [
+ 'name' => 'DestinationDataSourceSettings',
+ 'in' => 'formData',
+ 'style' => 'json',
+ 'schema' => [
+ 'description' => 'The settings of the destination. Only a single destination is supported.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '',
+ 'type' => 'object',
+ 'properties' => [
+ 'DataSourceName' => [
+ 'description' => 'The name of the data source.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'holo_datasource_1',
+ ],
+ 'DataSourceProperties' => [
+ 'description' => 'The properties of the data source.'."\n",
+ 'type' => 'object',
+ 'required' => false,
+ 'additionalProperties' => [
+ 'type' => 'string',
+ 'example' => 'TimeZone',
+ 'description' => 'The properties of the destination. No properties can be configured for a Hologres data source.'."\n",
+ ],
+ ],
+ ],
+ 'required' => false,
+ ],
+ 'required' => false,
+ ],
+ ],
+ [
+ 'name' => 'ResourceSettings',
+ 'in' => 'formData',
+ 'style' => 'json',
+ 'schema' => [
+ 'description' => 'The resource settings.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'OfflineResourceSettings' => [
+ 'description' => 'The resource used for batch synchronization.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'ResourceGroupIdentifier' => [
+ 'description' => 'The identifier of the resource group for Data Integration used for batch synchronization.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'S_res_group_111_222',
+ ],
+ ],
+ 'required' => false,
+ ],
+ 'RealtimeResourceSettings' => [
+ 'description' => 'The resource used for real-time synchronization.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'ResourceGroupIdentifier' => [
+ 'description' => 'The identifier of the resource group for Data Integration used for real-time synchronization.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'S_res_group_111_222',
+ ],
+ ],
+ 'required' => false,
+ ],
+ 'RequestedCu' => [
+ 'description' => 'The number of compute units (CUs) in the resource group that are used for incremental and full synchronization.'."\n",
+ 'type' => 'number',
+ 'format' => 'float',
+ 'required' => false,
+ 'example' => '2.0',
+ ],
+ ],
+ 'required' => false,
+ ],
+ ],
+ [
+ 'name' => 'TransformationRules',
+ 'in' => 'formData',
+ 'style' => 'json',
+ 'schema' => [
+ 'description' => 'The list of transformation rules that you want to apply to the synchronization objects selected from the source. Each entry in the list defines a transformation rule.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The transformation rule that you want to apply to the synchronization objects selected from the source.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'RuleName' => [
+ 'description' => 'The name of the rule. If the values of the RuleActionType parameter and the RuleTargetType parameter are the same for multiple transformation rules, you must make sure that the transformation rule names are unique.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'rename_rule_1',
+ ],
+ 'RuleActionType' => [
+ 'description' => 'The action type. Valid values:'."\n"
+ ."\n"
+ .'* DefinePrimaryKey'."\n"
+ .'* Rename'."\n"
+ .'* AddColumn'."\n"
+ .'* HandleDml'."\n"
+ .'* DefineIncrementalCondition'."\n"
+ .'* DefineCycleScheduleSettings'."\n"
+ .'* DefineRuntimeSettings'."\n"
+ .'* DefinePartitionKey'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'enumValueTitles' => [],
+ 'example' => 'Rename',
+ ],
+ 'RuleTargetType' => [
+ 'description' => 'The type of the object on which you want to perform the action. Valid values:'."\n"
+ ."\n"
+ .'* Table'."\n"
+ .'* Schema'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'enumValueTitles' => [],
+ 'example' => 'Table',
+ ],
+ 'RuleExpression' => [
+ 'description' => 'The expression of the rule. An expression must be a JSON string.'."\n"
+ ."\n"
+ .'Example of a renaming rule: {"expression":"${srcDatasourceName}\\_${srcDatabaseName}\\_0922","variables":\\[{"variableName":"srcDatabaseName","variableRules":\\[{"from":"fromdb","to":"todb"}]}]}'."\n"
+ ."\n"
+ .'* expression: the expression of the renaming rule. You can use the following variables in an expression: ${srcDatasourceName}, ${srcDatabaseName}, and ${srcTableName}. ${srcDatasourceName} indicates the name of the source. ${srcDatabaseName} indicates the name of a source database. ${srcTableName} indicates the name of a source table.'."\n"
+ .'* variables: the generation rule for a variable used in the expression of the renaming rule. The default value of the specified variable is the original value of the object indicated by the variable. You can define a group of string replacement rules to change the original values based on your business requirements. variableName: the name of the variable. Do not enclose the variable name in ${}. variableRules: the string replacement rules for variables. The system runs the string replacement rules in sequence for string replacement. from specifies the original string. to specifies the new string.'."\n"
+ ."\n"
+ .'Example of a rule used to add a specific field to the destination and assign a value to the field: {"columns":\\[{"columnName":"my_add_column","columnValueType":"Constant","columnValue":"123"}]}'."\n"
+ ."\n"
+ .'* If you do not configure such a rule, no fields are added to the destination and no values are assigned by default.'."\n"
+ .'* columnName: the name of the field that is added.'."\n"
+ .'* columnValueType: the type of the value of the field. Valid values: Constant and Variable.'."\n"
+ .'* columnValue: the value of the field that you want to add. If you set the valueType parameter to Constant, set the columnValue parameter to a custom constant of the STRING type. If you set the valueType parameter to Variable, set the columnValue to a built-in variable. The following built-in variables are supported: EXECUTE_TIME (LONG data type), DB_NAME_SRC (STRING data type), DATASOURCE_NAME_SRC (STRING data type), TABLE_NAME_SRC (STRING data type), DB_NAME_DEST (STRING data type), DATASOURCE_NAME_DEST (STRING data type), TABLE_NAME_DEST (STRING data type), and DB_NAME_SRC_TRANSED (STRING data type). EXECUTE_TIME specifies the execution time. DB_NAME_SRC specifies the name of a source database. DATASOURCE_NAME_SRC specifies the name of the source. TABLE_NAME_SRC specifies the name of a source table. DB_NAME_DEST specifies the name of a destination database. DATASOURCE_NAME_DEST specifies the name of the destination. TABLE_NAME_DEST specifies the name of a destination table. DB_NAME_SRC_TRANSED specifies the database name obtained after a transformation.'."\n"
+ ."\n"
+ .'Example of a rule used to specify primary key fields for a destination table: {"columns":\\["ukcolumn1","ukcolumn2"]}'."\n"
+ ."\n"
+ .'* If you do not configure such a rule, the primary key fields in the mapped source table are used for the destination table by default.'."\n"
+ .'* If the destination table is an existing table, Data Integration does not modify the schema of the destination table. If the specified primary key fields do not exist in the destination table, an error is reported when the synchronization task starts to run.'."\n"
+ .'* If the destination table is automatically created by the system, Data Integration automatically creates the schema of the destination table. The schema contains the primary key fields that you specify. If the specified primary key fields do not exist in the destination table, an error is reported when the synchronization task starts to run.'."\n"
+ ."\n"
+ .'Example of a rule used to process DML messages: {"dmlPolicies":\\[{"dmlType":"Delete","dmlAction":"Filter","filterCondition":"id > 1"}]}'."\n"
+ ."\n"
+ .'* If you do not configure such a rule, the default processing policy for messages generated for insert, update, and delete operations is Normal.'."\n"
+ .'* dmlType: the DML operation. Valid values: Insert, Update, and Delete.'."\n"
+ .'* dmlAction: the processing policy for DML messages. Valid values: Normal, Ignore, Filter, and LogicalDelete. Filter indicates conditional processing. You can set the dmlAction parameter to Filter only when the dmlType parameter is set to Update or Delete.'."\n"
+ .'* filterCondition: the condition used to filter DML messages. This parameter is required only when the dmlAction parameter is set to Filter.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => '{"expression":"${srcDatasoureName}_${srcDatabaseName}"}',
+ ],
+ ],
+ 'required' => false,
+ ],
+ 'required' => false,
+ ],
+ ],
+ [
+ 'name' => 'TableMappings',
+ 'in' => 'formData',
+ 'style' => 'json',
+ 'schema' => [
+ 'description' => 'The list of mappings between rules used to select synchronization objects in the source and transformation rules applied to the selected synchronization objects. Each entry in the list displays a mapping between a rule used to select synchronization objects and a transformation rule applied to the selected synchronization objects.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The mapping between a rule used to select synchronization objects in the source and a transformation rule applied to the selected synchronization objects.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'SourceObjectSelectionRules' => [
+ 'description' => 'The rules used to select synchronization objects in the source.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The rule used to select synchronization objects in the source. The objects can be databases or tables.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'ObjectType' => [
+ 'description' => 'The object type. Valid values:'."\n"
+ ."\n"
+ .'* Table'."\n"
+ .'* Database'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'enumValueTitles' => [],
+ 'example' => 'Table',
+ ],
+ 'Expression' => [
+ 'description' => 'The expression.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'mysql_table_1',
+ ],
+ ],
+ 'required' => false,
+ ],
+ 'required' => false,
+ ],
+ 'TransformationRules' => [
+ 'description' => 'The list of transformation rules that you want to apply to the synchronization objects selected from the source.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The transformation rule that you want to apply to the synchronization objects selected from the source.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'RuleName' => [
+ 'description' => 'The name of the rule. If the values of the RuleActionType parameter and the RuleTargetType parameter are the same for multiple transformation rules, you must make sure that the transformation rule names are unique.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'rename_rule_1',
+ ],
+ 'RuleActionType' => [
+ 'description' => 'The action type. Valid values:'."\n"
+ ."\n"
+ .'* DefinePrimaryKey'."\n"
+ .'* Rename'."\n"
+ .'* AddColumn'."\n"
+ .'* HandleDml'."\n"
+ .'* DefineIncrementalCondition'."\n"
+ .'* DefineCycleScheduleSettings'."\n"
+ .'* DefineRuntimeSettings'."\n"
+ .'* DefinePartitionKey'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'enumValueTitles' => [],
+ 'example' => 'Rename',
+ ],
+ 'RuleTargetType' => [
+ 'description' => 'The type of the object on which you want to perform the action. Valid values:'."\n"
+ ."\n"
+ .'* Table'."\n"
+ .'* Schema'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'enumValueTitles' => [],
+ 'example' => 'Table',
+ ],
+ ],
+ 'required' => false,
+ ],
+ 'required' => false,
+ ],
+ ],
+ 'required' => false,
+ ],
+ 'required' => false,
+ ],
+ ],
+ [
+ 'name' => 'JobSettings',
+ 'in' => 'formData',
+ 'style' => 'json',
+ 'schema' => [
+ 'description' => 'The settings for the dimension of the synchronization task. The settings include processing policies for DDL messages, policies for data type mappings between source fields and destination fields, and runtime parameters of the synchronization task.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'DdlHandlingSettings' => [
+ 'description' => 'The processing settings for DDL messages.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The processing setting for a specific type of DDL message.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'Type' => [
+ 'description' => 'The type of the DDL operation. Valid values:'."\n"
+ ."\n"
+ .'* RenameColumn'."\n"
+ .'* ModifyColumn'."\n"
+ .'* CreateTable'."\n"
+ .'* TruncateTable'."\n"
+ .'* DropTable'."\n"
+ .'* DropColumn'."\n"
+ .'* AddColumn'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'enumValueTitles' => [],
+ 'example' => 'AddColumn',
+ ],
+ 'Action' => [
+ 'description' => 'The processing policy. Valid values:'."\n"
+ ."\n"
+ .'* Ignore: ignores a DDL message.'."\n"
+ .'* Critical: reports an error for a DDL message.'."\n"
+ .'* Normal: normally processes a DDL message.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'enumValueTitles' => [],
+ 'example' => 'Critical',
+ ],
+ ],
+ 'required' => false,
+ ],
+ 'required' => false,
+ ],
+ 'ColumnDataTypeSettings' => [
+ 'description' => 'The settings for data type mappings between source fields and destination fields. The value of this parameter must be an array.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The data type mapping between a source field and a destination field.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'SourceDataType' => [
+ 'description' => 'The data type of the source field.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'bigint',
+ ],
+ 'DestinationDataType' => [
+ 'description' => 'The data type of the destination field.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'text',
+ ],
+ ],
+ 'required' => false,
+ ],
+ 'required' => false,
+ ],
+ 'RuntimeSettings' => [
+ 'description' => 'The runtime settings. The value of this parameter must be an array.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The runtime setting.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'Name' => [
+ 'description' => 'The name of the configuration item. Valid values:'."\n"
+ ."\n"
+ .'* runtime.offline.speed.limit.mb: specifies the maximum transmission rate that is allowed for a batch synchronization task. This configuration item takes effect only when runtime.offline.speed.limit.enable is set to true.'."\n"
+ .'* runtime.offline.speed.limit.enable: specifies whether throttling is enabled for a batch synchronization task.'."\n"
+ .'* dst.offline.connection.max: specifies the maximum number of connections that are allowed for writing data to the destination of a batch synchronization task.'."\n"
+ .'* runtime.offline.concurrent: specifies the maximum number of parallel threads that are allowed for a batch synchronization task.'."\n"
+ .'* dst.realtime.connection.max: specifies the maximum number of connections that are allowed for writing data to the destination of a real-time synchronization task.'."\n"
+ .'* runtime.enable.auto.create.schema: specifies whether schemas are automatically created in the destination of a synchronization task.'."\n"
+ .'* src.offline.datasource.max.connection: specifies the maximum number of connections that are allowed for reading data from the source of a batch synchronization task.'."\n"
+ .'* runtime.realtime.concurrent: specifies the maximum number of parallel threads that are allowed for a real-time synchronization task.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'enumValueTitles' => [],
+ 'example' => 'runtime.offline.concurrent',
+ ],
+ 'Value' => [
+ 'description' => 'The value of the configuration item.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => '1',
+ ],
+ ],
+ 'required' => false,
+ ],
+ 'required' => false,
+ ],
+ 'CycleScheduleSettings' => [
+ 'description' => 'The settings for periodic scheduling.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'CycleMigrationType' => [
+ 'description' => 'The synchronization type that requires periodic scheduling. Valid values:'."\n"
+ ."\n"
+ .'* Full: full synchronization'."\n"
+ .'* OfflineIncremental: batch incremental synchronization'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'Full',
+ ],
+ 'ScheduleParameters' => [
+ 'description' => 'The scheduling parameters.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'bizdate=$bizdate'."\n",
+ ],
+ ],
+ 'required' => false,
+ ],
+ 'ChannelSettings' => [
+ 'description' => 'The channel control settings for the synchronization task. The value of this parameter must be a JSON string.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => '{"structInfo":"MANAGED","storageType":"TEXTFILE","writeMode":"APPEND","partitionColumns":[{"columnName":"pt","columnType":"STRING","comment":""}],"fieldDelimiter":""}'."\n",
+ ],
+ 'ImportRuleSettings' => [
+ 'description' => 'The import settings for the synchronization task.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'Source' => [
+ 'description' => 'The import source of the task. Set the value to Datastudio, which indicates synchronization tasks created in DataStudio.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'Datastudio',
+ ],
+ 'FileId' => [
+ 'description' => 'The ID of the task to be imported.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => '10000',
+ ],
+ ],
+ 'required' => false,
+ ],
+ ],
+ 'required' => false,
+ ],
+ ],
+ [
+ 'name' => 'SystemDebug',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'Specifies whether to perform system debugging. Valid values: true and false. Default value: false.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'false',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => 'Schema of Response',
+ 'description' => 'The response parameters.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'title' => 'Id of the request',
+ 'description' => 'The request ID. You can use the request ID to query logs and troubleshoot issues.'."\n",
+ 'type' => 'string',
+ 'example' => '4F6AB6B3-41FB-5EBB-AFB2-0C98D49DA2BB',
+ ],
+ 'DIJobId' => [
+ 'description' => 'The synchronization task ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '11792',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'errorCodes' => [
+ 429 => [
+ [
+ 'errorCode' => 'Throttling.Api',
+ 'errorMessage' => 'The request for this resource has exceeded your available limit.',
+ ],
+ [
+ 'errorCode' => 'Throttling.System',
+ 'errorMessage' => 'The DataWorks system is busy. Try again later.',
+ ],
+ [
+ 'errorCode' => 'Throttling.User',
+ 'errorMessage' => 'Your request is too frequent. Try again later.',
+ ],
+ ],
+ 500 => [
+ [
+ 'errorCode' => 'InternalError.System',
+ 'errorMessage' => 'An internal system error occurred. Try again later.',
+ ],
+ [
+ 'errorCode' => 'InternalError.UserId.Missing',
+ 'errorMessage' => 'An internal system error occurred. Try again later.',
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"4F6AB6B3-41FB-5EBB-AFB2-0C98D49DA2BB\\",\\n \\"DIJobId\\": 11792\\n}","errorExample":""},{"type":"xml","example":"<CreateDIJobResponse>\\n <RequestId>4F6AB6B3-41FB-5EBB-AFB2-0C98D49DA2BB</RequestId>\\n <DIJobId>11792</DIJobId>\\n</CreateDIJobResponse>","errorExample":""}]',
+ 'title' => 'CreateDIJob',
+ ],
+ 'DeleteDIJob' => [
+ 'summary' => 'Deletes a Data Integration task of a new version. Only the following type of task is supported: real-time data synchronization from a MySQL database to Hologres.',
+ 'methods' => [
+ 'post',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'write',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'delete',
+ 'abilityTreeCode' => '155161',
+ 'abilityTreeNodes' => [
+ 'FEATUREdideQHGTK4',
+ ],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'DIJobId',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The task ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => true,
+ 'example' => '11126',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => 'Schema of Response',
+ 'description' => 'The response parameters.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'title' => 'Id of the request',
+ 'description' => 'The request ID.'."\n",
+ 'type' => 'string',
+ 'example' => 'D33D4A51-5845-579A-B4BA-FAADD0F83D53',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'errorCodes' => [
+ 403 => [
+ [
+ 'errorCode' => 'Forbidden.Access',
+ 'errorMessage' => 'Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.',
+ ],
+ ],
+ 429 => [
+ [
+ 'errorCode' => 'Throttling.Api',
+ 'errorMessage' => 'The request for this resource has exceeded your available limit.',
+ ],
+ [
+ 'errorCode' => 'Throttling.System',
+ 'errorMessage' => 'The DataWorks system is busy. Try again later.',
+ ],
+ [
+ 'errorCode' => 'Throttling.User',
+ 'errorMessage' => 'Your request is too frequent. Try again later.',
+ ],
+ ],
+ 500 => [
+ [
+ 'errorCode' => 'InternalError.System',
+ 'errorMessage' => 'An internal system error occurred. Try again later.',
+ ],
+ [
+ 'errorCode' => 'InternalError.UserId.Missing',
+ 'errorMessage' => 'An internal system error occurred. Try again later.',
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"D33D4A51-5845-579A-B4BA-FAADD0F83D53\\"\\n}","errorExample":""},{"type":"xml","example":"<DeleteDIJobResponse>\\n <RequestId>D33D4A51-5845-579A-B4BA-FAADD0F83D53</RequestId>\\n</DeleteDIJobResponse>","errorExample":""}]',
+ 'title' => 'DeleteDIJob',
+ ],
+ 'GetDIJob' => [
+ 'summary' => 'Queries the information about a new-version synchronization task created in Data Integration. The following types of synchronization tasks are supported: real-time synchronization of all data in a MySQL database to Hologres.',
+ 'methods' => [
+ 'post',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'get',
+ 'abilityTreeCode' => '154572',
+ 'abilityTreeNodes' => [
+ 'FEATUREdideQHGTK4',
+ ],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'DIJobId',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The ID of the synchronization task.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => true,
+ 'example' => '11588',
+ ],
+ ],
+ [
+ 'name' => 'WithDetails',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'Specifies whether to return detailed configuration information, including TransformationRules, TableMappings, and JobSettings. Valid values: true and false. Default value: true.'."\n",
+ 'type' => 'boolean',
+ 'required' => false,
+ 'example' => 'true',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'description' => 'The returned result.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'Data' => [
+ 'description' => 'The information about the synchronization task.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'ProjectId' => [
+ 'description' => 'The workspace ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '22',
+ ],
+ 'DIJobId' => [
+ 'description' => 'The ID of the synchronization task.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '11588',
+ ],
+ 'JobName' => [
+ 'description' => 'The name of the synchronization task.'."\n",
+ 'type' => 'string',
+ 'example' => 'mysql_to_holo_sync_445',
+ ],
+ 'Description' => [
+ 'description' => 'The description of the synchronization task.'."\n",
+ 'type' => 'string',
+ 'example' => 'Synchronize mysql to hologres'."\n",
+ ],
+ 'MigrationType' => [
+ 'description' => 'The synchronization type. Valid values:'."\n"
+ ."\n"
+ .'* FullAndRealtimeIncremental: one-time full synchronization and real-time incremental synchronization'."\n"
+ .'* RealtimeIncremental: real-time incremental synchronization'."\n"
+ .'* Full: full synchronization'."\n"
+ .'* OfflineIncremental: batch incremental synchronization'."\n"
+ .'* FullAndOfflineIncremental: one-time full synchronization and batch incremental synchronization'."\n",
+ 'type' => 'string',
+ 'enumValueTitles' => [],
+ 'example' => 'FullAndRealtimeIncremental',
+ ],
+ 'SourceDataSourceType' => [
+ 'description' => 'The source type. The value MySQL is returned.'."\n",
+ 'type' => 'string',
+ 'enumValueTitles' => [],
+ 'example' => 'MySQL',
+ ],
+ 'DestinationDataSourceType' => [
+ 'description' => 'The destination type. Valid values: Hologres and Hive.'."\n",
+ 'type' => 'string',
+ 'enumValueTitles' => [],
+ 'example' => 'Hologres',
+ ],
+ 'SourceDataSourceSettings' => [
+ 'description' => 'The settings of the source. Only a single source is supported.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '',
+ 'type' => 'object',
+ 'properties' => [
+ 'DataSourceName' => [
+ 'description' => 'The name of the data source.'."\n",
+ 'type' => 'string',
+ 'example' => 'mysql_datasource_1',
+ ],
+ 'DataSourceProperties' => [
+ 'description' => 'The properties of the data source.'."\n",
+ 'type' => 'object',
+ 'additionalProperties' => [
+ 'type' => 'string',
+ 'description' => 'The properties of the source. The properties of a MySQL data source include TimeZone and Encoding.'."\n",
+ 'example' => 'TimeZone',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'DestinationDataSourceSettings' => [
+ 'description' => 'The settings of the destination. Only a single destination is supported.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '',
+ 'type' => 'object',
+ 'properties' => [
+ 'DataSourceName' => [
+ 'description' => 'The name of the data source.'."\n",
+ 'type' => 'string',
+ 'example' => 'holo_datasource_1',
+ ],
+ 'DataSourceProperties' => [
+ 'description' => 'The properties of the data source.'."\n",
+ 'type' => 'object',
+ 'additionalProperties' => [
+ 'type' => 'string',
+ 'example' => 'TimeZone',
+ 'description' => 'The properties of the destination. No properties are returned because DataWorks does not allow you to configure properties for a Hologres data source.'."\n",
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'ResourceSettings' => [
+ 'description' => 'The resource settings.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'OfflineResourceSettings' => [
+ 'description' => 'The resource used for batch synchronization.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'ResourceGroupIdentifier' => [
+ 'description' => 'The identifier of the resource group for Data Integration used for batch synchronization.'."\n",
+ 'type' => 'string',
+ 'example' => 'S_res_group_111_222',
+ ],
+ ],
+ ],
+ 'RealtimeResourceSettings' => [
+ 'description' => 'The resource used for real-time synchronization.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'ResourceGroupIdentifier' => [
+ 'description' => 'The identifier of the resource group for Data Integration used for real-time synchronization.'."\n",
+ 'type' => 'string',
+ 'example' => 'S_res_group_111_222',
+ ],
+ ],
+ ],
+ 'RequestedCu' => [
+ 'description' => 'The number of compute units (CUs) in the resource group that are used for incremental and full synchronization.'."\n",
+ 'type' => 'number',
+ 'format' => 'float',
+ 'example' => '2.0',
+ ],
+ ],
+ ],
+ 'TransformationRules' => [
+ 'description' => 'The list of transformation rules that are applied to the synchronization objects selected from the source. Each entry in the list defines a transformation rule.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The transformation rule that is applied to the synchronization objects selected from the source.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'RuleActionType' => [
+ 'description' => 'The action type. Valid values:'."\n"
+ ."\n"
+ .'* DefinePrimaryKey'."\n"
+ .'* Rename'."\n"
+ .'* AddColumn'."\n"
+ .'* HandleDml'."\n"
+ .'* DefineIncrementalCondition'."\n"
+ .'* DefineCycleScheduleSettings'."\n"
+ .'* DefineRuntimeSettings'."\n"
+ .'* DefinePartitionKey'."\n",
+ 'type' => 'string',
+ 'enumValueTitles' => [],
+ 'example' => 'Rename',
+ ],
+ 'RuleExpression' => [
+ 'description' => 'The expression of the rule. The expression is a JSON string.'."\n"
+ ."\n"
+ .'* Example of a renaming rule: `{"expression":"${srcDatasourceName}_${srcDatabaseName}_0922","variables":\\[{"variableName":"srcDatabaseName","variableRules":\\[{"from":"fromdb","to":"todb"}\\]}\\]}`.'."\n"
+ ."\n"
+ .' * expression: the expression of the renaming rule. The expression may contain the following variables:'."\n"
+ ."\n"
+ .' * ${srcDatasourceName}'."\n"
+ .' * ${srcDatabaseName}'."\n"
+ .' * ${srcTableName}'."\n"
+ ."\n"
+ .' * variables: the generation rule for a variable used in the expression of the renaming rule. The default value of the specified variable is the original value of the object indicated by the variable. A group of string replacement rules used to change the original values may be returned.'."\n"
+ ."\n"
+ .' * variableName: the name of the variable. The variable name is not enclosed in ${}.'."\n"
+ .' * variableRules: the string replacement rules for variables. The system runs the string replacement rules in sequence. from indicates the original string. to indicates the new string.'."\n"
+ ."\n"
+ .'* Example of a rule used to add a specific field to the destination and assign a value to the field: `{"columns":\\[{"columnName":"my_add_column","columnValueType":"Constant","columnValue":"123"}\\]}`.'."\n"
+ ."\n"
+ .' If no rule of this type is configured, no fields are added to the destination and no values are assigned by default.'."\n"
+ ."\n"
+ .' * columnName: the name of the field that is added.'."\n"
+ ."\n"
+ .' * columnValueType: the value type of the field. Valid values: Constant and Variable.'."\n"
+ ."\n"
+ .' * columnValue: the value of the field.'."\n"
+ ."\n"
+ .' * If the value of the columnValueType parameter is Constant, the value of the columnValue parameter is a constant of the STRING data type.'."\n"
+ .' * If the value of the columnValueType parameter is Variable, the value of the columnValue parameter is a built-in variable. The following built-in variables are supported: EXECUTE_TIME (LONG data type), DB_NAME_SRC (STRING data type), DATASOURCE_NAME_SRC (STRING data type), TABLE_NAME_SRC (STRING data type), DB_NAME_DEST (STRING data type), DATASOURCE_NAME_DEST (STRING data type), TABLE_NAME_DEST (STRING data type), and DB_NAME_SRC_TRANSED (STRING data type). EXECUTE_TIME indicates the execution time. DB_NAME_SRC indicates the name of a source database. DATASOURCE_NAME_SRC indicates the name of the source. TABLE_NAME_SRC indicates the name of a source table. DB_NAME_DEST indicates the name of a destination database. DATASOURCE_NAME_DEST indicates the name of the destination. TABLE_NAME_DEST indicates the name of a destination table. DB_NAME_SRC_TRANSED indicates the database name obtained after a transformation.'."\n"
+ ."\n"
+ .'* Example of a rule used to specify primary key fields for a destination table: `{"columns":\\["ukcolumn1","ukcolumn2"\\]}`.'."\n"
+ ."\n"
+ .' If no rule of this type is configured, the primary key fields in the mapped source table are used for the destination table by default.'."\n"
+ ."\n"
+ .' * If the destination table is an existing table, Data Integration does not modify the schema of the destination table. If the specified primary key fields do not exist in the destination table, an error is reported when the synchronization task starts to run.'."\n"
+ .' * If the destination table is automatically created by the system, Data Integration automatically creates the schema of the destination table. The schema contains the primary key fields that you specify. If the specified primary key fields do not exist in the destination table, an error is reported when the synchronization task starts to run.'."\n"
+ ."\n"
+ .'* Example of a rule used to process DML messages: `{"dmlPolicies":\\[{"dmlType":"Delete","dmlAction":"Filter","filterCondition":"id > 1"}\\]}`.'."\n"
+ ."\n"
+ .' If no rule of this type is configured, the default processing policy for messages generated for insert, update, and delete operations is Normal.'."\n"
+ ."\n"
+ .' * dmlType: the DML operation. Valid values: Insert, Update, and Delete.'."\n"
+ .' * dmlAction: the processing policy for DML messages. Valid values: Normal, Ignore, Filter, and LogicalDelete. Filter indicates conditional processing. The value Filter is returned for the dmlAction parameter only when the value of the dmlType parameter is Update or Delete.'."\n"
+ .' * filterCondition: the condition used to filter DML messages. This parameter is returned only when the value of the dmlAction parameter is Filter.'."\n",
+ 'type' => 'string',
+ 'example' => '{"expression":"${srcDatasoureName}_${srcDatabaseName}"}',
+ ],
+ 'RuleName' => [
+ 'description' => 'The name of the rule. If the values of the RuleActionType parameter and the RuleTargetType parameter are the same for multiple transformation rules, you must make sure that the transformation rule names are unique.'."\n",
+ 'type' => 'string',
+ 'example' => 'rename_rule_1',
+ ],
+ 'RuleTargetType' => [
+ 'description' => 'The type of the object on which the action is performed. Valid values:'."\n"
+ ."\n"
+ .'* Table'."\n"
+ .'* Schema'."\n",
+ 'type' => 'string',
+ 'enumValueTitles' => [],
+ 'example' => 'Table',
+ ],
+ ],
+ ],
+ ],
+ 'TableMappings' => [
+ 'description' => 'The list of mappings between rules used to select synchronization objects in the source and transformation rules applied to the selected synchronization objects. Each entry in the list displays a mapping between a rule used to select synchronization objects and a transformation rule applied to the selected synchronization objects.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The mapping between a rule used to select synchronization objects in the source and a transformation rule applied to the selected synchronization objects.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'SourceObjectSelectionRules' => [
+ 'description' => 'The list of rules used to select synchronization objects in the source.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The rule used to select synchronization objects in the source. The objects can be databases or tables.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'Expression' => [
+ 'description' => 'The expression.'."\n",
+ 'type' => 'string',
+ 'example' => 'mysql_table_1',
+ ],
+ 'ObjectType' => [
+ 'description' => 'The object type. Valid values:'."\n"
+ ."\n"
+ .'* Table'."\n"
+ .'* Database'."\n",
+ 'type' => 'string',
+ 'enumValueTitles' => [],
+ 'example' => 'Table',
+ ],
+ ],
+ ],
+ ],
+ 'TransformationRules' => [
+ 'description' => 'The list of transformation rules that are applied to the synchronization objects selected from the source.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The transformation rule that is applied to the synchronization objects selected from the source.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'RuleActionType' => [
+ 'description' => 'The action type. Valid values:'."\n"
+ ."\n"
+ .'* DefinePrimaryKey'."\n"
+ .'* Rename'."\n"
+ .'* AddColumn'."\n"
+ .'* HandleDml'."\n"
+ .'* DefineIncrementalCondition'."\n"
+ .'* DefineCycleScheduleSettings'."\n"
+ .'* DefineRuntimeSettings'."\n"
+ .'* DefinePartitionKey'."\n",
+ 'type' => 'string',
+ 'enumValueTitles' => [],
+ 'example' => 'Rename',
+ ],
+ 'RuleName' => [
+ 'description' => 'The name of the rule. If the values of the RuleActionType parameter and the RuleTargetType parameter are the same for multiple transformation rules, you must make sure that the transformation rule names are unique.'."\n",
+ 'type' => 'string',
+ 'example' => 'rename_rule_1',
+ ],
+ 'RuleTargetType' => [
+ 'description' => 'The type of the object on which the action is performed. Valid values:'."\n"
+ ."\n"
+ .'* Table'."\n"
+ .'* Schema'."\n",
+ 'type' => 'string',
+ 'enumValueTitles' => [],
+ 'example' => 'Table',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'JobSettings' => [
+ 'description' => 'The settings for the dimension of the synchronization task. The settings include processing policies for DDL messages, policies for data type mappings between source fields and destination fields, and runtime parameters of the synchronization task.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'ColumnDataTypeSettings' => [
+ 'description' => 'The settings for data type mappings between source fields and destination fields. The value of this parameter is an array.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '',
+ 'type' => 'object',
+ 'properties' => [
+ 'SourceDataType' => [
+ 'description' => 'The data type of a source field.'."\n",
+ 'type' => 'string',
+ 'example' => 'bigint',
+ ],
+ 'DestinationDataType' => [
+ 'description' => 'The data type of a destination field.'."\n",
+ 'type' => 'string',
+ 'example' => 'text',
+ ],
+ ],
+ ],
+ ],
+ 'DdlHandlingSettings' => [
+ 'description' => 'The settings for processing DDL messages. The value of this parameter is an array.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The processing setting for a specific type of DDL message.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'Action' => [
+ 'description' => 'The processing policy. Valid values:'."\n"
+ ."\n"
+ .'* Ignore: ignores a DDL message.'."\n"
+ .'* Critical: reports an error for a DDL message.'."\n"
+ .'* Normal: normally processes a DDL message.'."\n",
+ 'type' => 'string',
+ 'enumValueTitles' => [],
+ 'example' => 'Critical',
+ ],
+ 'Type' => [
+ 'description' => 'The type of the DDL operation. Valid values:'."\n"
+ ."\n"
+ .'* RenameColumn'."\n"
+ .'* ModifyColumn'."\n"
+ .'* CreateTable'."\n"
+ .'* TruncateTable'."\n"
+ .'* DropTable'."\n"
+ .'* DropColumn'."\n"
+ .'* AddColumn'."\n",
+ 'type' => 'string',
+ 'enumValueTitles' => [],
+ 'example' => 'AddColumn',
+ ],
+ ],
+ ],
+ ],
+ 'RuntimeSettings' => [
+ 'description' => 'The runtime settings. The value of this parameter is an array.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The runtime setting.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'Name' => [
+ 'description' => 'The name of the configuration item. Valid values:'."\n"
+ ."\n"
+ .'* runtime.offline.speed.limit.mb: indicates the maximum transmission rate that is allowed for a batch synchronization task. This configuration item takes effect only when runtime.offline.speed.limit.enable is set to true.'."\n"
+ .'* runtime.offline.speed.limit.enable: indicates whether throttling is enabled for a batch synchronization task.'."\n"
+ .'* dst.offline.connection.max: indicates the maximum number of connections that are allowed for writing data to the destination of a batch synchronization task.'."\n"
+ .'* runtime.offline.concurrent: indicates the maximum number of parallel threads that are allowed for a batch synchronization task.'."\n"
+ .'* dst.realtime.connection.max: indicates the maximum number of connections that are allowed for writing data to the destination of a real-time synchronization task.'."\n"
+ .'* runtime.enable.auto.create.schema: indicates whether schemas are automatically created in the destination of a synchronization task.'."\n"
+ .'* src.offline.datasource.max.connection: indicates the maximum number of connections that are allowed for reading data from the source of a batch synchronization task.'."\n"
+ .'* runtime.realtime.concurrent: indicates the maximum number of parallel threads that are allowed for a real-time synchronization task.'."\n",
+ 'type' => 'string',
+ 'enumValueTitles' => [],
+ 'example' => 'runtime.offline.concurrent',
+ ],
+ 'Value' => [
+ 'description' => 'The value of the configuration item.'."\n",
+ 'type' => 'string',
+ 'example' => '1',
+ ],
+ ],
+ ],
+ ],
+ 'CycleScheduleSettings' => [
+ 'description' => 'The settings for periodic scheduling.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'CycleMigrationType' => [
+ 'description' => 'The synchronization type that requires periodic scheduling. Valid values:'."\n"
+ ."\n"
+ .'* Full: full synchronization'."\n"
+ .'* OfflineIncremental: batch incremental synchronization'."\n",
+ 'type' => 'string',
+ 'example' => 'Full',
+ ],
+ 'ScheduleParameters' => [
+ 'description' => 'The scheduling parameters.'."\n",
+ 'type' => 'string',
+ 'example' => 'bizdate=$bizdate',
+ ],
+ ],
+ ],
+ 'ChannelSettings' => [
+ 'description' => 'The channel control settings for the synchronization task. The value of this parameter is a JSON string.'."\n",
+ 'type' => 'string',
+ 'example' => '{"structInfo":"MANAGED","storageType":"TEXTFILE","writeMode":"APPEND","partitionColumns":[{"columnName":"pt","columnType":"STRING","comment":""}],"fieldDelimiter":""}'."\n",
+ ],
+ ],
+ ],
+ 'CreatedTime' => [
+ 'description' => 'The timestamp when the synchronization task was created. The timestamp is accurate to the second.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '1671516776',
+ ],
+ 'CreatedUid' => [
+ 'description' => 'The ID of the user who creates the synchronization task.'."\n",
+ 'type' => 'string',
+ 'example' => '100000001',
+ ],
+ 'UpdatedTime' => [
+ 'description' => 'The timestamp when the synchronization task was last modified. The timestamp is accurate to the second.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '1673859985',
+ ],
+ 'UpdatedUid' => [
+ 'description' => 'The ID of the user who last modifies the synchronization task.'."\n",
+ 'type' => 'string',
+ 'example' => '100000001',
+ ],
+ 'StartedTime' => [
+ 'description' => 'The timestamp when the synchronization task was last started. The timestamp is accurate to the second.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '1673859999',
+ ],
+ 'StartedUid' => [
+ 'description' => 'The ID of the user who last starts the synchronization task.'."\n",
+ 'type' => 'string',
+ 'example' => '100000001',
+ ],
+ 'JobStatus' => [
+ 'description' => 'The status of the synchronization task. Valid values:'."\n"
+ ."\n"
+ .'* Finished'."\n"
+ .'* Initialized'."\n"
+ .'* Stopped'."\n"
+ .'* Failed'."\n"
+ .'* Running'."\n"
+ .'* Stopping'."\n",
+ 'type' => 'string',
+ 'enumValueTitles' => [],
+ 'example' => 'Finished',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message returned if the value of the JobStatus parameter is Failed.'."\n",
+ 'type' => 'string',
+ 'example' => 'error details xxx',
+ ],
+ 'RunStats' => [
+ 'description' => 'The information about the running of the synchronization task.'."\n",
+ 'type' => 'object',
+ 'additionalProperties' => [
+ 'type' => 'string',
+ 'description' => 'The detailed statistics on the running of the synchronization task.'."\n"
+ ."\n"
+ .'* StructureMigrationTotalTables: the total number of tables whose schemas need to be migrated.'."\n"
+ .'* StructureMigrationSuccessTables: the number of tables whose schemas are successfully migrated.'."\n"
+ .'* StructureMigrationFailedTables: the number of tables whose schemas fail to be migrated.'."\n"
+ .'* StructureMigrationStatus: the status of schema migration. Valid values: Waiting, Running, Finished, Failed, and Stopped.'."\n"
+ .'* StructureMigrationErrorMessage: the error message returned for schema migration.'."\n"
+ .'* FullMigrationTotalTables: the total number of tables whose full data needs to be synchronized.'."\n"
+ .'* FullMigrationSuccessTables: the number of tables whose full data is successfully synchronized.'."\n"
+ .'* FullMigrationFailedTables: the number of tables whose full data fails to be synchronized.'."\n"
+ .'* FullMigrationStatus: the status of full synchronization.'."\n"
+ .'* FullMigrationErrorMessage: the error message returned for full synchronization.'."\n"
+ .'* RealtimeMigrationMaxDelay: the latency of real-time synchronization. Unit: milliseconds.'."\n"
+ .'* RealtimeMigrationStatus: the status of real-time synchronization.'."\n"
+ .'* RealtimeMigrationErrorMessage: the error message returned for real-time synchronization.'."\n",
+ 'example' => 'StructureMigrationTotalTables',
+ ],
+ ],
+ ],
+ ],
+ 'RequestId' => [
+ 'description' => 'The request ID.'."\n",
+ 'type' => 'string',
+ 'example' => '0000-ABCD-EFG****',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'errorCodes' => [
+ 429 => [
+ [
+ 'errorCode' => 'Throttling.Api',
+ 'errorMessage' => 'The request for this resource has exceeded your available limit.',
+ ],
+ [
+ 'errorCode' => 'Throttling.System',
+ 'errorMessage' => 'The DataWorks system is busy. Try again later.',
+ ],
+ [
+ 'errorCode' => 'Throttling.User',
+ 'errorMessage' => 'Your request is too frequent. Try again later.',
+ ],
+ ],
+ 500 => [
+ [
+ 'errorCode' => 'InternalError.System',
+ 'errorMessage' => 'An internal system error occurred. Try again later.',
+ ],
+ [
+ 'errorCode' => 'InternalError.UserId.Missing',
+ 'errorMessage' => 'An internal system error occurred. Try again later.',
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"Data\\": {\\n \\"ProjectId\\": 22,\\n \\"DIJobId\\": 11588,\\n \\"JobName\\": \\"mysql_to_holo_sync_445\\",\\n \\"Description\\": \\"Synchronize mysql to hologres\\\\n\\",\\n \\"MigrationType\\": \\"FullAndRealtimeIncremental\\",\\n \\"SourceDataSourceType\\": \\"MySQL\\",\\n \\"DestinationDataSourceType\\": \\"Hologres\\",\\n \\"SourceDataSourceSettings\\": [\\n {\\n \\"DataSourceName\\": \\"mysql_datasource_1\\",\\n \\"DataSourceProperties\\": {\\n \\"key\\": \\"TimeZone\\"\\n }\\n }\\n ],\\n \\"DestinationDataSourceSettings\\": [\\n {\\n \\"DataSourceName\\": \\"holo_datasource_1\\",\\n \\"DataSourceProperties\\": {\\n \\"key\\": \\"TimeZone\\"\\n }\\n }\\n ],\\n \\"ResourceSettings\\": {\\n \\"OfflineResourceSettings\\": {\\n \\"ResourceGroupIdentifier\\": \\"S_res_group_111_222\\"\\n },\\n \\"RealtimeResourceSettings\\": {\\n \\"ResourceGroupIdentifier\\": \\"S_res_group_111_222\\"\\n },\\n \\"RequestedCu\\": 2\\n },\\n \\"TransformationRules\\": [\\n {\\n \\"RuleActionType\\": \\"Rename\\",\\n \\"RuleExpression\\": \\"{\\\\\\"expression\\\\\\":\\\\\\"${srcDatasoureName}_${srcDatabaseName}\\\\\\"}\\",\\n \\"RuleName\\": \\"rename_rule_1\\",\\n \\"RuleTargetType\\": \\"Table\\"\\n }\\n ],\\n \\"TableMappings\\": [\\n {\\n \\"SourceObjectSelectionRules\\": [\\n {\\n \\"Expression\\": \\"mysql_table_1\\",\\n \\"ObjectType\\": \\"Table\\"\\n }\\n ],\\n \\"TransformationRules\\": [\\n {\\n \\"RuleActionType\\": \\"Rename\\",\\n \\"RuleName\\": \\"rename_rule_1\\",\\n \\"RuleTargetType\\": \\"Table\\"\\n }\\n ]\\n }\\n ],\\n \\"JobSettings\\": {\\n \\"ColumnDataTypeSettings\\": [\\n {\\n \\"SourceDataType\\": \\"bigint\\",\\n \\"DestinationDataType\\": \\"text\\"\\n }\\n ],\\n \\"DdlHandlingSettings\\": [\\n {\\n \\"Action\\": \\"Critical\\",\\n \\"Type\\": \\"AddColumn\\"\\n }\\n ],\\n \\"RuntimeSettings\\": [\\n {\\n \\"Name\\": \\"runtime.offline.concurrent\\",\\n \\"Value\\": \\"1\\"\\n }\\n ],\\n \\"CycleScheduleSettings\\": {\\n \\"CycleMigrationType\\": \\"Full\\",\\n \\"ScheduleParameters\\": \\"bizdate=$bizdate\\"\\n },\\n \\"ChannelSettings\\": \\"{\\\\\\"structInfo\\\\\\":\\\\\\"MANAGED\\\\\\",\\\\\\"storageType\\\\\\":\\\\\\"TEXTFILE\\\\\\",\\\\\\"writeMode\\\\\\":\\\\\\"APPEND\\\\\\",\\\\\\"partitionColumns\\\\\\":[{\\\\\\"columnName\\\\\\":\\\\\\"pt\\\\\\",\\\\\\"columnType\\\\\\":\\\\\\"STRING\\\\\\",\\\\\\"comment\\\\\\":\\\\\\"\\\\\\"}],\\\\\\"fieldDelimiter\\\\\\":\\\\\\"\\\\\\"}\\\\n\\"\\n },\\n \\"CreatedTime\\": 1671516776,\\n \\"CreatedUid\\": \\"100000001\\",\\n \\"UpdatedTime\\": 1673859985,\\n \\"UpdatedUid\\": \\"100000001\\",\\n \\"StartedTime\\": 1673859999,\\n \\"StartedUid\\": \\"100000001\\",\\n \\"JobStatus\\": \\"Finished\\",\\n \\"ErrorMessage\\": \\"error details xxx\\",\\n \\"RunStats\\": {\\n \\"key\\": \\"StructureMigrationTotalTables\\"\\n }\\n },\\n \\"RequestId\\": \\"0000-ABCD-EFG****\\"\\n}","errorExample":""},{"type":"xml","example":"<GetDIJobResponse>\\n <Data>\\n <ProjectId>22</ProjectId>\\n <DIJobId>11588</DIJobId>\\n <JobName>mysql_to_holo_sync_445</JobName>\\n <Description>mysql同步到hologres</Description>\\n <MigrationType>FullAndRealtimeIncremental</MigrationType>\\n <SourceDataSourceType>MySQL</SourceDataSourceType>\\n <DestinationDataSourceType>Hologres</DestinationDataSourceType>\\n <SourceDataSourceSettings>\\n <DataSourceName>mysql_datasource_1</DataSourceName>\\n <DataSourceProperties>\\n <key>TimeZone</key>\\n </DataSourceProperties>\\n </SourceDataSourceSettings>\\n <DestinationDataSourceSettings>\\n <DataSourceName>holo_datasource_1</DataSourceName>\\n <DataSourceProperties>\\n <key>TimeZone</key>\\n </DataSourceProperties>\\n </DestinationDataSourceSettings>\\n <ResourceSettings>\\n <OfflineResourceSettings>\\n <ResourceGroupIdentifier>S_res_group_111_222</ResourceGroupIdentifier>\\n </OfflineResourceSettings>\\n <RealtimeResourceSettings>\\n <ResourceGroupIdentifier>S_res_group_111_222</ResourceGroupIdentifier>\\n </RealtimeResourceSettings>\\n </ResourceSettings>\\n <TransformationRules>\\n <RuleActionType>Rename</RuleActionType>\\n <RuleExpression>{\\"expression\\":\\"${srcDatasoureName}_${srcDatabaseName}\\"}</RuleExpression>\\n <RuleName>rename_rule_1</RuleName>\\n <RuleTargetType>Table</RuleTargetType>\\n </TransformationRules>\\n <TableMappings>\\n <SourceObjectSelectionRules>\\n <Expression>mysql_table_1</Expression>\\n <ObjectType>Table</ObjectType>\\n </SourceObjectSelectionRules>\\n <TransformationRules>\\n <RuleActionType>Rename</RuleActionType>\\n <RuleName>rename_rule_1</RuleName>\\n <RuleTargetType>Table</RuleTargetType>\\n </TransformationRules>\\n </TableMappings>\\n <JobSettings>\\n <ColumnDataTypeSettings>\\n <SourceDataType>bigint</SourceDataType>\\n <DestinationDataType>text</DestinationDataType>\\n </ColumnDataTypeSettings>\\n <DdlHandlingSettings>\\n <Action>Critical</Action>\\n <Type>AddColumn</Type>\\n </DdlHandlingSettings>\\n <RuntimeSettings>\\n <Name>runtime.offline.concurrent</Name>\\n <Value>1</Value>\\n </RuntimeSettings>\\n </JobSettings>\\n <CreatedTime>1671516776</CreatedTime>\\n <CreatedUid>100000001</CreatedUid>\\n <UpdatedTime>1673859985</UpdatedTime>\\n <UpdatedUid>100000001</UpdatedUid>\\n <StartedTime>1673859999</StartedTime>\\n <StartedUid>100000001</StartedUid>\\n <JobStatus>Finished</JobStatus>\\n <ErrorMessage>error details xxx</ErrorMessage>\\n <RunStats>\\n <key>StructureMigrationTotalTables</key>\\n </RunStats>\\n </Data>\\n <RequestId>0000-ABCD-EFG****</RequestId>\\n</GetDIJobResponse>","errorExample":""}]',
+ 'title' => 'GetDIJob',
+ ],
+ 'ListDIJobs' => [
+ 'summary' => 'Queries a list of new-version synchronization tasks. The following type of task is supported: real-time data synchronization from a MySQL database to Hologres.',
+ 'methods' => [
+ 'post',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'list',
+ 'abilityTreeCode' => '155162',
+ 'abilityTreeNodes' => [
+ 'FEATUREdideQHGTK4',
+ ],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'ProjectId',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The ID of the workspace.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => true,
+ 'example' => '1967',
+ ],
+ ],
+ [
+ 'name' => 'JobName',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The name of the task. Fuzzy match is supported. If you do not configure this parameter, no limits are imposed on the tasks.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'mysql_to_holo_sync_8772',
+ ],
+ ],
+ [
+ 'name' => 'SourceDataSourceType',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The source type. If you do not configure this parameter, no limits are imposed on the tasks.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'MySQL',
+ ],
+ ],
+ [
+ 'name' => 'DestinationDataSourceType',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The destination type. If you do not configure this parameter, no limits are imposed on the tasks.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'Hologres',
+ ],
+ ],
+ [
+ 'name' => 'PageNumber',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The page number. Default value: 1.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => false,
+ 'example' => '1',
+ ],
+ ],
+ [
+ 'name' => 'PageSize',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The number of entries per page. Default value: 10. Maximum value: 100.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => false,
+ 'example' => '10',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => 'Schema of Response',
+ 'description' => 'The returned result.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'title' => 'Id of the request',
+ 'description' => 'The request ID.'."\n",
+ 'type' => 'string',
+ 'example' => '7263E4AC-9D2E-5B29-B8AF-7C5012E92A41',
+ ],
+ 'DIJobPaging' => [
+ 'description' => 'The pagination information.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'TotalCount' => [
+ 'description' => 'The total number of entries returned.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '6',
+ ],
+ 'PageNumber' => [
+ 'description' => 'The page number.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '1',
+ ],
+ 'PageSize' => [
+ 'description' => 'The number of entries per page.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '10',
+ ],
+ 'DIJobs' => [
+ 'description' => 'The list of tasks.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '',
+ 'type' => 'object',
+ 'properties' => [
+ 'DIJobId' => [
+ 'description' => 'The task ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '16626',
+ ],
+ 'ProjectId' => [
+ 'description' => 'The workspace ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '1967',
+ ],
+ 'JobName' => [
+ 'description' => 'The task name.'."\n",
+ 'type' => 'string',
+ 'example' => 'mysql_to_holo_sync_8772',
+ ],
+ 'MigrationType' => [
+ 'description' => 'The synchronization type. Valid values:'."\n"
+ ."\n"
+ .'* FullAndRealtimeIncremental: one-time full synchronization and real-time incremental synchronization'."\n"
+ .'* RealtimeIncremental: real-time incremental synchronization'."\n"
+ .'* Full: one-time full synchronization'."\n",
+ 'type' => 'string',
+ 'enumValueTitles' => [
+ 'FullAndRealtimeIncremental' => '',
+ 'RealtimeIncremental' => '',
+ 'Full' => '',
+ ],
+ 'example' => 'Full',
+ ],
+ 'SourceDataSourceType' => [
+ 'description' => 'The type of the source. The value MySQL is returned.'."\n",
+ 'type' => 'string',
+ 'enumValueTitles' => [
+ 'MySQL' => 'MySQL',
+ ],
+ 'example' => 'MySQL',
+ ],
+ 'DestinationDataSourceType' => [
+ 'description' => 'The type of the destination. The value Hologres is returned.'."\n",
+ 'type' => 'string',
+ 'enumValueTitles' => [
+ 'Hologres' => 'Hologres',
+ ],
+ 'example' => 'Hologres',
+ ],
+ 'JobStatus' => [
+ 'description' => 'The task status. Valid values:'."\n"
+ ."\n"
+ .'* Finished'."\n"
+ .'* Initialized'."\n"
+ .'* Stopped'."\n"
+ .'* Failed'."\n"
+ .'* Running'."\n"
+ .'* Stopping'."\n",
+ 'type' => 'string',
+ 'enumValueTitles' => [
+ 'Finished' => '',
+ 'Initialized' => '',
+ 'Stopped' => '',
+ 'Failed' => '',
+ 'Running' => '',
+ 'Stopping' => '',
+ ],
+ 'example' => 'Finished',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'errorCodes' => [
+ 403 => [
+ [
+ 'errorCode' => 'Forbidden.Access',
+ 'errorMessage' => 'Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.',
+ ],
+ ],
+ 429 => [
+ [
+ 'errorCode' => 'Throttling.Api',
+ 'errorMessage' => 'The request for this resource has exceeded your available limit.',
+ ],
+ [
+ 'errorCode' => 'Throttling.System',
+ 'errorMessage' => 'The DataWorks system is busy. Try again later.',
+ ],
+ [
+ 'errorCode' => 'Throttling.User',
+ 'errorMessage' => 'Your request is too frequent. Try again later.',
+ ],
+ ],
+ 500 => [
+ [
+ 'errorCode' => 'InternalError.System',
+ 'errorMessage' => 'An internal system error occurred. Try again later.',
+ ],
+ [
+ 'errorCode' => 'InternalError.UserId.Missing',
+ 'errorMessage' => 'An internal system error occurred. Try again later.',
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"7263E4AC-9D2E-5B29-B8AF-7C5012E92A41\\",\\n \\"DIJobPaging\\": {\\n \\"TotalCount\\": 6,\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"DIJobs\\": [\\n {\\n \\"DIJobId\\": 16626,\\n \\"ProjectId\\": 1967,\\n \\"JobName\\": \\"mysql_to_holo_sync_8772\\",\\n \\"MigrationType\\": \\"Full\\",\\n \\"SourceDataSourceType\\": \\"MySQL\\",\\n \\"DestinationDataSourceType\\": \\"Hologres\\",\\n \\"JobStatus\\": \\"Finished\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<ListDIJobsResponse>\\n <RequestId>7263E4AC-9D2E-5B29-B8AF-7C5012E92A41</RequestId>\\n <DIJobPaging>\\n <TotalCount>6</TotalCount>\\n <PageNumber>1</PageNumber>\\n <PageSize>10</PageSize>\\n <DIJobs>\\n <DIJobId>16626</DIJobId>\\n <ProjectId>1967</ProjectId>\\n <JobName>mysql_to_holo_sync_8772</JobName>\\n <MigrationType>Full</MigrationType>\\n <SourceDataSourceType>MySQL</SourceDataSourceType>\\n <DestinationDataSourceType>Hologres</DestinationDataSourceType>\\n <JobStatus>Finished</JobStatus>\\n </DIJobs>\\n </DIJobPaging>\\n</ListDIJobsResponse>","errorExample":""}]',
+ 'title' => 'ListDIJobs',
+ 'description' => 'You can call this operation to obtain only the basic information about the tasks. If you want to obtain the details of a task, call the GetDIJob operation.'."\n",
+ ],
+ 'StartDIJob' => [
+ 'summary' => 'Starts a synchronization task of a new version. Only the following type of task is supported: real-time data synchronization from a MySQL database to Hologres.',
+ 'methods' => [
+ 'post',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'write',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'update',
+ 'abilityTreeCode' => '155172',
+ 'abilityTreeNodes' => [
+ 'FEATUREdideQHGTK4',
+ ],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'DIJobId',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The task ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => true,
+ 'example' => '11743',
+ ],
+ ],
+ [
+ 'name' => 'RealtimeStartSettings',
+ 'in' => 'formData',
+ 'style' => 'json',
+ 'schema' => [
+ 'description' => 'The settings for the start.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'StartTime' => [
+ 'description' => 'The timestamp of the start offset. Unit: seconds. If you do not configure this parameter, the offset is not reset by default.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'example' => '1671516776',
+ ],
+ 'FailoverSettings' => [
+ 'description' => 'The failover settings.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'Interval' => [
+ 'description' => 'The failover interval. Unit: minutes.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'example' => '10',
+ ],
+ 'UpperLimit' => [
+ 'description' => 'The maximum number of failovers.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'example' => '30',
+ ],
+ ],
+ 'required' => false,
+ ],
+ ],
+ 'required' => false,
+ ],
+ ],
+ [
+ 'name' => 'ForceToRerun',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'Specifies whether to forcefully rerun all synchronization steps. If you do not configure this parameter, the system does not forcefully rerun the task.'."\n",
+ 'type' => 'boolean',
+ 'required' => false,
+ 'example' => 'true',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => 'Schema of Response',
+ 'description' => 'The response parameters.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'title' => 'Id of the request',
+ 'description' => 'The request ID.'."\n",
+ 'type' => 'string',
+ 'example' => '999431B2-6013-577F-B684-36F7433C753B',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'errorCodes' => [
+ 403 => [
+ [
+ 'errorCode' => 'Forbidden.Access',
+ 'errorMessage' => 'Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.',
+ ],
+ ],
+ 429 => [
+ [
+ 'errorCode' => 'Throttling.Api',
+ 'errorMessage' => 'The request for this resource has exceeded your available limit.',
+ ],
+ [
+ 'errorCode' => 'Throttling.System',
+ 'errorMessage' => 'The DataWorks system is busy. Try again later.',
+ ],
+ [
+ 'errorCode' => 'Throttling.User',
+ 'errorMessage' => 'Your request is too frequent. Try again later.',
+ ],
+ ],
+ 500 => [
+ [
+ 'errorCode' => 'InternalError.System',
+ 'errorMessage' => 'An internal system error occurred. Try again later.',
+ ],
+ [
+ 'errorCode' => 'InternalError.UserId.Missing',
+ 'errorMessage' => 'An internal system error occurred. Try again later.',
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"999431B2-6013-577F-B684-36F7433C753B\\"\\n}","errorExample":""},{"type":"xml","example":"<StartDIJobResponse>\\n <RequestId>999431B2-6013-577F-B684-36F7433C753B</RequestId>\\n</StartDIJobResponse>","errorExample":""}]',
+ 'title' => 'StartDIJob',
+ ],
+ 'StopDIJob' => [
+ 'summary' => 'Stops a new-version synchronization task. The following type of synchronization task is supported: real-time synchronization of all data in a MySQL database to Hologres.',
+ 'methods' => [
+ 'post',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'write',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'update',
+ 'abilityTreeCode' => '155174',
+ 'abilityTreeNodes' => [
+ 'FEATUREdideQHGTK4',
+ ],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'DIJobId',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The task ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => true,
+ 'example' => '11668',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => 'Schema of Response',
+ 'description' => 'The response parameters.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'title' => 'Id of the request',
+ 'description' => 'The request ID.'."\n",
+ 'type' => 'string',
+ 'example' => '92F778C7-8F00-53B1-AE1A-B3B17101247D',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'errorCodes' => [
+ 403 => [
+ [
+ 'errorCode' => 'Forbidden.Access',
+ 'errorMessage' => 'Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.',
+ ],
+ ],
+ 429 => [
+ [
+ 'errorCode' => 'Throttling.Api',
+ 'errorMessage' => 'The request for this resource has exceeded your available limit.',
+ ],
+ [
+ 'errorCode' => 'Throttling.System',
+ 'errorMessage' => 'The DataWorks system is busy. Try again later.',
+ ],
+ [
+ 'errorCode' => 'Throttling.User',
+ 'errorMessage' => 'Your request is too frequent. Try again later.',
+ ],
+ ],
+ 500 => [
+ [
+ 'errorCode' => 'InternalError.System',
+ 'errorMessage' => 'An internal system error occurred. Try again later.',
+ ],
+ [
+ 'errorCode' => 'InternalError.UserId.Missing',
+ 'errorMessage' => 'An internal system error occurred. Try again later.',
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"92F778C7-8F00-53B1-AE1A-B3B17101247D\\"\\n}","errorExample":""},{"type":"xml","example":"<StopDIJobResponse>\\n <RequestId>92F778C7-8F00-53B1-AE1A-B3B17101247D</RequestId>\\n</StopDIJobResponse>","errorExample":""}]',
+ 'title' => 'StopDIJob',
+ ],
+ 'UpdateDIJob' => [
+ 'summary' => 'Updates a new-version synchronization task. The following type of task is supported: real-time synchronization of all data in a MySQL database to Hologres.',
+ 'methods' => [
+ 'post',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'write',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'update',
+ 'abilityTreeCode' => '155160',
+ 'abilityTreeNodes' => [
+ 'FEATUREdideQHGTK4',
+ ],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'DIJobId',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The ID of the synchronization task.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'example' => '11588',
+ ],
+ ],
+ [
+ 'name' => 'Description',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The description of the synchronization task.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'Synchronize mysql to hologres',
+ ],
+ ],
+ [
+ 'name' => 'ResourceSettings',
+ 'in' => 'formData',
+ 'style' => 'json',
+ 'schema' => [
+ 'description' => 'The resource settings.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'OfflineResourceSettings' => [
+ 'description' => 'The resource used for batch synchronization.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'ResourceGroupIdentifier' => [
+ 'description' => 'The identifier of the resource group for Data Integration used for batch synchronization.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'S_res_group_111_222',
+ ],
+ ],
+ 'required' => false,
+ ],
+ 'RealtimeResourceSettings' => [
+ 'description' => 'The resource used for real-time synchronization.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'ResourceGroupIdentifier' => [
+ 'description' => 'The identifier of the resource group for Data Integration used for real-time synchronization.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'S_res_group_111_222',
+ ],
+ ],
+ 'required' => false,
+ ],
+ 'RequestedCu' => [
+ 'description' => 'The number of compute units (CUs) in the resource group that are used for full and incremental synchronization.'."\n",
+ 'type' => 'number',
+ 'format' => 'float',
+ 'required' => false,
+ 'example' => '2.0',
+ ],
+ ],
+ 'required' => false,
+ ],
+ ],
+ [
+ 'name' => 'TransformationRules',
+ 'in' => 'formData',
+ 'style' => 'json',
+ 'schema' => [
+ 'description' => 'The list of transformation rules that you want to apply to the synchronization objects selected from the source. Each entry in the list defines a transformation rule.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The transformation rule that you want to apply to the synchronization objects selected from the source.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'RuleName' => [
+ 'description' => 'The name of the rule. If the values of the RuleActionType parameter and the RuleTargetType parameter are the same for multiple transformation rules, you must make sure that the transformation rule names are unique.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'rename_rule_1',
+ ],
+ 'RuleActionType' => [
+ 'description' => 'The type of the action. Valid values:'."\n"
+ ."\n"
+ .'* DefinePrimaryKey'."\n"
+ .'* Rename'."\n"
+ .'* AddColumn'."\n"
+ .'* HandleDml'."\n"
+ .'* DefineIncrementalCondition'."\n"
+ .'* DefineCycleScheduleSettings'."\n"
+ .'* DefineRuntimeSettings'."\n"
+ .'* DefinePartitionKey'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'enumValueTitles' => [],
+ 'example' => 'Rename',
+ ],
+ 'RuleTargetType' => [
+ 'description' => 'The type of the object on which you want to perform the action. Valid values:'."\n"
+ ."\n"
+ .'* Table'."\n"
+ .'* Schema'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'enumValueTitles' => [],
+ 'example' => 'Table',
+ ],
+ 'RuleExpression' => [
+ 'description' => 'The expression of the rule. The expression must be a JSON string.'."\n"
+ ."\n"
+ .'Example of a renaming rule: {"expression":"${srcDatasourceName}\\_${srcDatabaseName}\\_0922","variables":\\[{"variableName":"srcDatabaseName","variableRules":\\[{"from":"fromdb","to":"todb"}]}]}.'."\n"
+ ."\n"
+ .'expression: the expression of the renaming rule. The expression may contain the following variables: ${srcDatasourceName}, ${srcDatabaseName}, and ${srcTableName}. ${srcDatasourceName} specifies the name of the source. ${srcDatabaseName} specifies the name of a source database. ${srcTableName} specifies the name of a source table. variables: the generation rule for a variable used in the expression of the renaming rule. The default value of the specified variable is the original value of the object indicated by the variable. You can define a group of string replacement rules to change the original values based on your business requirements. variableName: the name of the variable. Do not enclose the variable name in ${}. variableRules: the string replacement rules for variables. The system runs the string replacement rules in sequence. from specifies the original string. to specifies the new string. Example of a rule used to add a specific field to the destination and assign a value to the field: {"columns":\\[{"columnName":"my_add_column","columnValueType":"Constant","columnValue":"123"}]}.'."\n"
+ ."\n"
+ .'If you do not configure such a rule, no fields are added to the destination and no values are assigned by default. columnName: the name of the field that you want to add. columnValueType: the value type of the field. Valid values: Constant and Variable. columnValue: the value of the field that you want to add. If you set the valueType parameter to Constant, set the columnValue parameter to a custom constant of the STRING type. If you set the valueType parameter to Variable, set the columnValue to a built-in variable. The following built-in variables are supported: EXECUTE_TIME (LONG data type), DB_NAME_SRC (STRING data type), DATASOURCE_NAME_SRC (STRING data type), TABLE_NAME_SRC (STRING data type), DB_NAME_DEST (STRING data type), DATASOURCE_NAME_DEST (STRING data type), TABLE_NAME_DEST (STRING data type), and DB_NAME_SRC_TRANSED (STRING data type). EXECUTE_TIME specifies the execution time. DB_NAME_SRC indicates the name of a source database. DATASOURCE_NAME_SRC specifies the name of the source. TABLE_NAME_SRC specifies the name of a source table. DB_NAME_DEST specifies the name of a destination database. DATASOURCE_NAME_DEST specifies the name of the destination. TABLE_NAME_DEST specifies the name of a destination table. DB_NAME_SRC_TRANSED specifies the database name obtained after a transformation. Example of a rule used to specify primary key fields for a destination table: {"columns":\\["ukcolumn1","ukcolumn2"]}.'."\n"
+ ."\n"
+ .'If you do not configure such a rule, the primary key fields in the mapped source table are used for the destination table by default. If the destination table is an existing table, Data Integration does not modify the schema of the destination table. If the specified primary key fields do not exist in the destination table, an error is reported when the synchronization task starts to run. If the destination table is automatically created by the system, Data Integration automatically creates the schema of the destination table. The schema contains the primary key fields that you specify. If the specified primary key fields do not exist in the destination table, an error is reported when the synchronization task starts to run. Example of a rule used to process DML messages: {"dmlPolicies":\\[{"dmlType":"Delete","dmlAction":"Filter","filterCondition":"id > 1"}]}.'."\n"
+ ."\n"
+ .'If you do not configure such a rule, the default processing policy for messages generated for insert, update, and delete operations is Normal. dmlType: the DML operation. Valid values: Insert, Update, and Delete. dmlAction: the processing policy for DML messages. Valid values: Normal, Ignore, Filter, and LogicalDelete. Filter indicates conditional processing. You can set the dmlAction parameter to Filter only when the dmlType parameter is set to Update or Delete. filterCondition: the condition used to filter DML messages. This parameter is required only when the dmlAction parameter is set to Filter.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => '{"expression":"${srcDatasoureName}_${srcDatabaseName}"}',
+ ],
+ ],
+ 'required' => false,
+ ],
+ 'required' => false,
+ ],
+ ],
+ [
+ 'name' => 'TableMappings',
+ 'in' => 'formData',
+ 'style' => 'json',
+ 'schema' => [
+ 'description' => 'The list of mappings between rules used to select synchronization objects in the source and transformation rules applied to the selected synchronization objects. Each entry in the list displays a mapping between a rule used to select synchronization objects and a transformation rule applied to the selected synchronization objects.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The mapping between a rule used to select synchronization objects in the source and a transformation rule applied to the selected synchronization objects.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'SourceObjectSelectionRules' => [
+ 'description' => 'The list of rules that you want to use to select synchronization objects in the source.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The rule that you want to use to select synchronization objects in the source. The objects can be databases or tables.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'ObjectType' => [
+ 'description' => 'The type of the object. Valid values:'."\n"
+ ."\n"
+ .'* Table'."\n"
+ .'* Database'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'enumValueTitles' => [],
+ 'example' => 'Table',
+ ],
+ 'Expression' => [
+ 'description' => 'The expression.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'mysql_table_1',
+ ],
+ ],
+ 'required' => false,
+ ],
+ 'required' => false,
+ ],
+ 'TransformationRules' => [
+ 'description' => 'The list of transformation rules that you want to apply to the synchronization objects selected from the source.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The transformation rule that you want to apply to the synchronization objects selected from the source.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'RuleName' => [
+ 'description' => 'The name of the rule. If the values of the RuleActionType parameter and the RuleTargetType parameter are the same for multiple transformation rules, you must make sure that the transformation rule names are unique.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'rename_rule_1',
+ ],
+ 'RuleActionType' => [
+ 'description' => 'The type of the action. Valid values:'."\n"
+ ."\n"
+ .'* DefinePrimaryKey'."\n"
+ .'* Rename'."\n"
+ .'* AddColumn'."\n"
+ .'* HandleDml'."\n"
+ .'* DefineIncrementalCondition'."\n"
+ .'* DefineCycleScheduleSettings'."\n"
+ .'* DefineRuntimeSettings'."\n"
+ .'* DefinePartitionKey'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'enumValueTitles' => [],
+ 'example' => 'Rename',
+ ],
+ 'RuleTargetType' => [
+ 'description' => 'The type of the object on which you want to perform the action. Valid values:'."\n"
+ ."\n"
+ .'* Table'."\n"
+ .'* Schema'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'enumValueTitles' => [],
+ 'example' => 'Table',
+ ],
+ ],
+ 'required' => false,
+ ],
+ 'required' => false,
+ ],
+ ],
+ 'required' => false,
+ ],
+ 'required' => false,
+ ],
+ ],
+ [
+ 'name' => 'JobSettings',
+ 'in' => 'formData',
+ 'style' => 'json',
+ 'schema' => [
+ 'description' => 'The settings for the dimension of the synchronization task. The settings include processing policies for DDL messages, policies for data type mappings between source fields and destination fields, and runtime parameters of the synchronization task.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'DdlHandlingSettings' => [
+ 'description' => 'The settings for processing DDL messages. The value of this parameter must be an array.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The processing setting for a specific type of DDL message.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'Type' => [
+ 'description' => 'The type of the DDL operation. Valid values:'."\n"
+ ."\n"
+ .'* RenameColumn'."\n"
+ .'* ModifyColumn'."\n"
+ .'* CreateTable'."\n"
+ .'* TruncateTable'."\n"
+ .'* DropTable'."\n"
+ .'* DropColumn'."\n"
+ .'* AddColumn'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'enumValueTitles' => [],
+ 'example' => 'AddColumn',
+ ],
+ 'Action' => [
+ 'description' => 'The processing policy for DDL messages. Valid values:'."\n"
+ ."\n"
+ .'* Ignore: ignores a DDL message.'."\n"
+ .'* Critical: reports an error for a DDL message.'."\n"
+ .'* Normal: normally processes a DDL message.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'enumValueTitles' => [],
+ 'example' => 'Critical',
+ ],
+ ],
+ 'required' => false,
+ ],
+ 'required' => false,
+ ],
+ 'ColumnDataTypeSettings' => [
+ 'description' => 'The settings for data type mappings between source fields and destination fields. The value of this parameter must be an array.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The data type mapping between a source field and a destination field.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'SourceDataType' => [
+ 'description' => 'The data type of a source field.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'bigint',
+ ],
+ 'DestinationDataType' => [
+ 'description' => 'The data type of a destination field.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'text',
+ ],
+ ],
+ 'required' => false,
+ ],
+ 'required' => false,
+ ],
+ 'RuntimeSettings' => [
+ 'description' => 'The runtime settings. The value of this parameter must be an array.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The runtime settings.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'Name' => [
+ 'description' => 'The name of the configuration item. Valid values:'."\n"
+ ."\n"
+ .'* runtime.offline.speed.limit.mb: specifies the maximum transmission rate that is allowed for a batch synchronization task. This configuration item takes effect only when runtime.offline.speed.limit.enable is set to true.'."\n"
+ .'* runtime.offline.speed.limit.enable: specifies whether throttling is enabled for a batch synchronization task.'."\n"
+ .'* dst.offline.connection.max: specifies the maximum number of connections that are allowed for writing data to the destination of a batch synchronization task.'."\n"
+ .'* runtime.offline.concurrent: specifies the maximum number of parallel threads that are allowed for a batch synchronization task.'."\n"
+ .'* dst.realtime.connection.max: specifies the maximum number of connections that are allowed for writing data to the destination of a real-time synchronization task.'."\n"
+ .'* runtime.enable.auto.create.schema: specifies whether schemas are automatically created in the destination of a synchronization task.'."\n"
+ .'* src.offline.datasource.max.connection: specifies the maximum number of connections that are allowed for reading data from the source of a batch synchronization task.'."\n"
+ .'* runtime.realtime.concurrent: specifies the maximum number of parallel threads that are allowed for a real-time synchronization task.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'enumValueTitles' => [],
+ 'example' => 'runtime.offline.concurrent',
+ ],
+ 'Value' => [
+ 'description' => 'The value of the configuration item.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => '1',
+ ],
+ ],
+ 'required' => false,
+ ],
+ 'required' => false,
+ ],
+ 'CycleScheduleSettings' => [
+ 'description' => 'The settings for periodic scheduling.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'ScheduleParameters' => [
+ 'description' => 'The scheduling parameters.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'bizdate=$bizdate'."\n",
+ ],
+ ],
+ 'required' => false,
+ ],
+ 'ChannelSettings' => [
+ 'description' => 'The channel control settings for the synchronization task. The value of this parameter must be a JSON string.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => '{"structInfo":"MANAGED","storageType":"TEXTFILE","writeMode":"APPEND","partitionColumns":[{"columnName":"pt","columnType":"STRING","comment":""}],"fieldDelimiter":""}'."\n",
+ ],
+ ],
+ 'required' => false,
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => 'Schema of Response',
+ 'description' => 'The returned result.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'title' => 'Id of the request',
+ 'description' => 'The request ID.'."\n",
+ 'type' => 'string',
+ 'example' => 'AAC30B35-820D-5F3E-A42C-E96BB6379325',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'errorCodes' => [
+ 429 => [
+ [
+ 'errorCode' => 'Throttling.Api',
+ 'errorMessage' => 'The request for this resource has exceeded your available limit.',
+ ],
+ [
+ 'errorCode' => 'Throttling.System',
+ 'errorMessage' => 'The DataWorks system is busy. Try again later.',
+ ],
+ [
+ 'errorCode' => 'Throttling.User',
+ 'errorMessage' => 'Your request is too frequent. Try again later.',
+ ],
+ ],
+ 500 => [
+ [
+ 'errorCode' => 'InternalError.System',
+ 'errorMessage' => 'An internal system error occurred. Try again later.',
+ ],
+ [
+ 'errorCode' => 'InternalError.UserId.Missing',
+ 'errorMessage' => 'An internal system error occurred. Try again later.',
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"AAC30B35-820D-5F3E-A42C-E96BB6379325\\"\\n}","errorExample":""},{"type":"xml","example":"<UpdateDIJobResponse>\\n <RequestId>AAC30B35-820D-5F3E-A42C-E96BB6379325</RequestId>\\n</UpdateDIJobResponse>","errorExample":""}]',
+ 'title' => 'UpdateDIJob',
+ ],
+ 'CreateDIAlarmRule' => [
+ 'summary' => 'Creates an alert rule for a Data Integration task of a new version. Only the following type of task is supported: real-time data synchronization from a MySQL database to Hologres.',
+ 'methods' => [
+ 'post',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'write',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'create',
+ 'abilityTreeCode' => '154822',
+ 'abilityTreeNodes' => [
+ 'FEATUREdideTG7EYI',
+ ],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'DIJobId',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The ID of the task with which the alert rule is associated.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => true,
+ 'example' => '11265',
+ ],
+ ],
+ [
+ 'name' => 'Description',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The description of the task.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'mysql synchronizes to hologres heartbeat alert',
+ ],
+ ],
+ [
+ 'name' => 'MetricType',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The metric type in the alert rule. Valid values:'."\n"
+ ."\n"
+ .'* Heartbeat'."\n"
+ .'* FailoverCount'."\n"
+ .'* Delay'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'enumValueTitles' => [],
+ 'example' => 'Heartbeat',
+ ],
+ ],
+ [
+ 'name' => 'TriggerConditions',
+ 'in' => 'formData',
+ 'style' => 'json',
+ 'schema' => [
+ 'description' => 'The conditions that are used to trigger the alert rule.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The condition that is used to trigger the alert rule.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'Severity' => [
+ 'description' => 'The severity level. Valid values:'."\n"
+ ."\n"
+ .'* Warning'."\n"
+ .'* Critical'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'enumValueTitles' => [],
+ 'example' => 'Warning',
+ ],
+ 'Duration' => [
+ 'description' => 'The time interval for alert calculation. Unit: minutes.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'example' => '15',
+ ],
+ 'Threshold' => [
+ 'description' => 'The alert threshold.'."\n"
+ ."\n"
+ .'* If the alert rule is for task status, you do not need to specify a threshold.'."\n"
+ .'* If the alert rule is for failovers, specify the number of failovers.'."\n"
+ .'* If the alert rule is for latency, the threshold is the latency duration, in seconds.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'example' => '5',
+ ],
+ ],
+ 'required' => false,
+ ],
+ 'required' => true,
+ ],
+ ],
+ [
+ 'name' => 'NotificationSettings',
+ 'in' => 'formData',
+ 'style' => 'json',
+ 'schema' => [
+ 'description' => 'The alert notification settings.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'NotificationChannels' => [
+ 'description' => 'The alert notification methods.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The alert notification method.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'Severity' => [
+ 'description' => 'The severity level. Valid values:'."\n"
+ ."\n"
+ .'* Warning'."\n"
+ .'* Critical'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'enumValueTitles' => [],
+ 'example' => 'Warning',
+ ],
+ 'Channels' => [
+ 'description' => 'The alert notification methods.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The alert notification method. Valid values:'."\n"
+ ."\n"
+ .'* Mail: email'."\n"
+ .'* Phone: phone call'."\n"
+ .'* Sms: text message'."\n"
+ .'* Ding: DingTalk chatbot token'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'enumValueTitles' => [],
+ 'example' => 'Ding',
+ ],
+ 'required' => false,
+ ],
+ ],
+ 'required' => false,
+ ],
+ 'required' => true,
+ ],
+ 'NotificationReceivers' => [
+ 'description' => 'The settings of alert notification recipients.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The setting of an alert notification recipient.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'ReceiverType' => [
+ 'description' => 'The recipient type. Valid values: AliyunUid and DingToken.'."\n"
+ ."\n"
+ .'* If the alert notification method is Mail, Phone, or Sms, set this parameter to **AliyunUid**, which specifies the Alibaba Cloud account ID.'."\n"
+ .'* If the alert notification method is Ding, set this parameter to **DingToken**, which indicates the DingTalk chatbot token.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'enumValueTitles' => [],
+ 'example' => 'DingToken',
+ ],
+ 'ReceiverValues' => [
+ 'description' => 'The recipients.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The recipient.'."\n"
+ ."\n"
+ .'* If the ReceiverType parameter is set to AliyunUid, set this parameter to the Alibaba Cloud account ID of a user.'."\n"
+ .'* If the ReceiverType parameter is set to DingToken, set this parameter to the token of a DingTalk chatbot.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'token1',
+ ],
+ 'required' => false,
+ ],
+ ],
+ 'required' => false,
+ ],
+ 'required' => true,
+ ],
+ 'InhibitionInterval' => [
+ 'description' => 'The duration of the alert suppression interval. Default value: 5. Unit: minutes.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => false,
+ 'example' => '5',
+ ],
+ ],
+ 'required' => true,
+ ],
+ ],
+ [
+ 'name' => 'Enabled',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'Specifies whether to enable the alert rule. By default, the alert rule is disabled.'."\n",
+ 'type' => 'boolean',
+ 'required' => false,
+ 'example' => 'true',
+ 'default' => 'false',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => 'Schema of Response',
+ 'description' => 'The response parameters.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'title' => 'Id of the request',
+ 'description' => 'The request ID.'."\n",
+ 'type' => 'string',
+ 'example' => 'C636A747-7E4E-594D-94CD-2B4F8A9A9A63',
+ ],
+ 'DIAlarmRuleId' => [
+ 'description' => 'The alert rule ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '34988',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'errorCodes' => [
+ 403 => [
+ [
+ 'errorCode' => 'Forbidden.Access',
+ 'errorMessage' => 'Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.',
+ ],
+ ],
+ 429 => [
+ [
+ 'errorCode' => 'Throttling.Api',
+ 'errorMessage' => 'The request for this resource has exceeded your available limit.',
+ ],
+ [
+ 'errorCode' => 'Throttling.System',
+ 'errorMessage' => 'The DataWorks system is busy. Try again later.',
+ ],
+ [
+ 'errorCode' => 'Throttling.User',
+ 'errorMessage' => 'Your request is too frequent. Try again later.',
+ ],
+ ],
+ 500 => [
+ [
+ 'errorCode' => 'InternalError.System',
+ 'errorMessage' => 'An internal system error occurred. Try again later.',
+ ],
+ [
+ 'errorCode' => 'InternalError.UserId.Missing',
+ 'errorMessage' => 'An internal system error occurred. Try again later.',
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"C636A747-7E4E-594D-94CD-2B4F8A9A9A63\\",\\n \\"DIAlarmRuleId\\": 34988\\n}","errorExample":""},{"type":"xml","example":"<CreateDIAlarmRuleResponse>\\n <RequestId>C636A747-7E4E-594D-94CD-2B4F8A9A9A63</RequestId>\\n <DIAlarmRuleId>34988</DIAlarmRuleId>\\n</CreateDIAlarmRuleResponse>","errorExample":""}]',
+ 'title' => 'CreateDIAlarmRule',
+ 'description' => 'You can configure alert rules only for tasks that can be used for real-time data synchronization.'."\n",
+ ],
+ 'DeleteDIAlarmRule' => [
+ 'summary' => 'Deletes an alert rule for a Data Integration task of a new version. Only the following type of task is supported: real-time data synchronization from a MySQL database to Hologres.',
+ 'methods' => [
+ 'post',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'write',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'delete',
+ 'abilityTreeCode' => '154894',
+ 'abilityTreeNodes' => [
+ 'FEATUREdide39WW3A',
+ ],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'DIAlarmRuleId',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The alert rule ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => true,
+ 'example' => '34971',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => 'Schema of Response',
+ 'description' => 'The response parameters.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'title' => 'Id of the request',
+ 'description' => 'The request ID.'."\n",
+ 'type' => 'string',
+ 'example' => 'C99E2BE6-9DEA-5C2E-8F51-1DDCFEADE490',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'errorCodes' => [
+ 403 => [
+ [
+ 'errorCode' => 'Forbidden.Access',
+ 'errorMessage' => 'Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.',
+ ],
+ ],
+ 429 => [
+ [
+ 'errorCode' => 'Throttling.Api',
+ 'errorMessage' => 'The request for this resource has exceeded your available limit.',
+ ],
+ [
+ 'errorCode' => 'Throttling.System',
+ 'errorMessage' => 'The DataWorks system is busy. Try again later.',
+ ],
+ [
+ 'errorCode' => 'Throttling.User',
+ 'errorMessage' => 'Your request is too frequent. Try again later.',
+ ],
+ ],
+ 500 => [
+ [
+ 'errorCode' => 'InternalError.System',
+ 'errorMessage' => 'An internal system error occurred. Try again later.',
+ ],
+ [
+ 'errorCode' => 'InternalError.UserId.Missing',
+ 'errorMessage' => 'An internal system error occurred. Try again later.',
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"C99E2BE6-9DEA-5C2E-8F51-1DDCFEADE490\\"\\n}","errorExample":""},{"type":"xml","example":"<DeleteDIAlarmRuleResponse>\\n <RequestId>C99E2BE6-9DEA-5C2E-8F51-1DDCFEADE490</RequestId>\\n</DeleteDIAlarmRuleResponse>","errorExample":""}]',
+ 'title' => 'DeleteDIAlarmRule',
+ 'description' => 'You can configure alert rules only for tasks whose MigrationType is set to RealtimeIncremental.'."\n",
+ ],
+ 'GetDIAlarmRule' => [
+ 'summary' => 'Queries the details of an alert rule configured for a new-version synchronization task. Only the following types of tasks are supported: real-time data synchronization from a MySQL database to Hologres.',
+ 'methods' => [
+ 'post',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'get',
+ 'abilityTreeCode' => '154881',
+ 'abilityTreeNodes' => [
+ 'FEATUREdide39WW3A',
+ ],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'DIAlarmRuleId',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The alert rule ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => true,
+ 'example' => '34994',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => 'Schema of Response',
+ 'description' => 'The returned result.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'title' => 'Id of the request',
+ 'description' => 'The request ID.'."\n",
+ 'type' => 'string',
+ 'example' => '4A807D85-AC9F-55F7-A58F-998D5249CAD9',
+ ],
+ 'DIAlarmRule' => [
+ 'description' => 'The details of the alert rule.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'DIAlarmRuleId' => [
+ 'description' => 'The alert rule ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '34988',
+ ],
+ 'DIJobId' => [
+ 'description' => 'The ID of the task with which the alert rule is associated.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '11170',
+ ],
+ 'Description' => [
+ 'description' => 'The description of the alert rule.'."\n",
+ 'type' => 'string',
+ 'example' => 'mysql synchronizes to hologres heartbeat alert',
+ ],
+ 'MetricType' => [
+ 'description' => 'The metric type in the alert rule. Valid values:'."\n"
+ ."\n"
+ .'* Heartbeat'."\n"
+ .'* FailoverCount'."\n"
+ .'* Delay'."\n",
+ 'type' => 'string',
+ 'enumValueTitles' => [],
+ 'example' => 'Heartbeat',
+ ],
+ 'Enabled' => [
+ 'description' => 'Indicates whether the alert rule is enabled.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'TriggerConditions' => [
+ 'description' => 'The conditions that are used to trigger the alert rule.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The condition that is used to trigger the alert rule.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'Severity' => [
+ 'description' => 'The severity level. Valid values:'."\n"
+ ."\n"
+ .'* Warning'."\n"
+ .'* Critical'."\n",
+ 'type' => 'string',
+ 'enumValueTitles' => [],
+ 'example' => 'Warning',
+ ],
+ 'Duration' => [
+ 'description' => 'The time interval for alert calculation. Unit: minutes.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '15',
+ ],
+ 'Threshold' => [
+ 'description' => 'The alert threshold.'."\n"
+ ."\n"
+ .'* If the alert rule is for task status, no threshold is used.'."\n"
+ .'* If the alert rule is for failovers, specify the number of failovers.'."\n"
+ .'* If the alert rule is for latency, the threshold is the latency duration, in seconds.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '5',
+ ],
+ ],
+ ],
+ ],
+ 'NotificationSettings' => [
+ 'description' => 'The alert notification settings.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'NotificationChannels' => [
+ 'description' => 'The alert notification methods.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The alert notification method.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'Severity' => [
+ 'description' => 'The severity level. Valid values:'."\n"
+ ."\n"
+ .'* Warning'."\n"
+ .'* Critical'."\n",
+ 'type' => 'string',
+ 'enumValueTitles' => [],
+ 'example' => 'Warning',
+ ],
+ 'Channels' => [
+ 'description' => 'The alert notification methods.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The alert notification method. Valid values:'."\n"
+ ."\n"
+ .'* Mail: email'."\n"
+ .'* Phone: phone call'."\n"
+ .'* Sms: text message'."\n"
+ .'* Ding: DingTalk chatbot token'."\n",
+ 'type' => 'string',
+ 'enumValueTitles' => [],
+ 'example' => 'Ding',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'NotificationReceivers' => [
+ 'description' => 'The alert notification recipients.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The alert notification recipient.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'ReceiverType' => [
+ 'description' => 'The recipient type. Valid values: AliyunUid and DingToken.'."\n"
+ ."\n"
+ .'* If the alert notification method is Mail, Phone, or Sms, the value of this parameter is **AliyunUid**, which indicates the Alibaba Cloud account ID.'."\n"
+ .'* If the alert notification method is Ding, the value of this parameter is **DingToken**, which indicates the DingTalk chatbot token.'."\n",
+ 'type' => 'string',
+ 'enumValueTitles' => [],
+ 'example' => 'DingToken',
+ ],
+ 'ReceiverValues' => [
+ 'description' => 'The recipients.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The recipient.'."\n"
+ ."\n"
+ .'* If the recipient type is Alibaba Cloud account ID, set this parameter to the Alibaba Cloud account ID of a user.'."\n"
+ .'* If the recipient type is DingTalk chatbot token, set this parameter to the token of a DingTalk chatbot.'."\n",
+ 'type' => 'string',
+ 'example' => 'token1',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'InhibitionInterval' => [
+ 'description' => 'The duration of the alert suppression interval. Unit: minutes.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '5',
+ ],
+ ],
+ ],
+ 'CreatedUid' => [
+ 'description' => 'The ID of the user who creates the alert rule.'."\n",
+ 'type' => 'string',
+ 'example' => '10000001',
+ ],
+ 'CreatedTime' => [
+ 'description' => 'The timestamp when the alert rule was created. Unit: seconds.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '1663573162',
+ ],
+ 'UpdatedUid' => [
+ 'description' => 'The ID of the user who last updates the alert rule.'."\n",
+ 'type' => 'string',
+ 'example' => '10000001',
+ ],
+ 'UpdatedTime' => [
+ 'description' => 'The timestamp when the alert rule was last updated. Unit: seconds.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '1663573163',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'errorCodes' => [
+ 403 => [
+ [
+ 'errorCode' => 'Forbidden.Access',
+ 'errorMessage' => 'Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.',
+ ],
+ ],
+ 429 => [
+ [
+ 'errorCode' => 'Throttling.Api',
+ 'errorMessage' => 'The request for this resource has exceeded your available limit.',
+ ],
+ [
+ 'errorCode' => 'Throttling.System',
+ 'errorMessage' => 'The DataWorks system is busy. Try again later.',
+ ],
+ [
+ 'errorCode' => 'Throttling.User',
+ 'errorMessage' => 'Your request is too frequent. Try again later.',
+ ],
+ ],
+ 500 => [
+ [
+ 'errorCode' => 'InternalError.System',
+ 'errorMessage' => 'An internal system error occurred. Try again later.',
+ ],
+ [
+ 'errorCode' => 'InternalError.UserId.Missing',
+ 'errorMessage' => 'An internal system error occurred. Try again later.',
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"4A807D85-AC9F-55F7-A58F-998D5249CAD9\\",\\n \\"DIAlarmRule\\": {\\n \\"DIAlarmRuleId\\": 34988,\\n \\"DIJobId\\": 11170,\\n \\"Description\\": \\"mysql synchronizes to hologres heartbeat alert\\",\\n \\"MetricType\\": \\"Heartbeat\\",\\n \\"Enabled\\": true,\\n \\"TriggerConditions\\": [\\n {\\n \\"Severity\\": \\"Warning\\",\\n \\"Duration\\": 15,\\n \\"Threshold\\": 5\\n }\\n ],\\n \\"NotificationSettings\\": {\\n \\"NotificationChannels\\": [\\n {\\n \\"Severity\\": \\"Warning\\",\\n \\"Channels\\": [\\n \\"Ding\\"\\n ]\\n }\\n ],\\n \\"NotificationReceivers\\": [\\n {\\n \\"ReceiverType\\": \\"DingToken\\",\\n \\"ReceiverValues\\": [\\n \\"token1\\"\\n ]\\n }\\n ],\\n \\"InhibitionInterval\\": 5\\n },\\n \\"CreatedUid\\": \\"10000001\\",\\n \\"CreatedTime\\": 1663573162,\\n \\"UpdatedUid\\": \\"10000001\\",\\n \\"UpdatedTime\\": 1663573163\\n }\\n}","errorExample":""},{"type":"xml","example":"<GetDIAlarmRuleResponse>\\n <RequestId>4A807D85-AC9F-55F7-A58F-998D5249CAD9</RequestId>\\n <DIAlarmRule>\\n <DIAlarmRuleId>34988</DIAlarmRuleId>\\n <DIJobId>11170</DIJobId>\\n <Description>mysql同步到hologres心跳告警</Description>\\n <MetricType>Heartbeat</MetricType>\\n <Enabled>true</Enabled>\\n <TriggerConditions>\\n <Severity>Warning</Severity>\\n <Duration>15</Duration>\\n <Threshold>5</Threshold>\\n </TriggerConditions>\\n <NotificationSettings>\\n <NotificationChannels>\\n <Severity>Warning</Severity>\\n <Channels>Ding</Channels>\\n </NotificationChannels>\\n <NotificationReceivers>\\n <ReceiverType>DingToken</ReceiverType>\\n <ReceiverValues>token1</ReceiverValues>\\n </NotificationReceivers>\\n <InhibitionInterval>5</InhibitionInterval>\\n </NotificationSettings>\\n <CreatedUid>10000001</CreatedUid>\\n <CreatedTime>1663573162</CreatedTime>\\n <UpdatedUid>10000001</UpdatedUid>\\n <UpdatedTime>1663573163</UpdatedTime>\\n </DIAlarmRule>\\n</GetDIAlarmRuleResponse>","errorExample":""}]',
+ 'title' => 'GetDIAlarmRule',
+ 'description' => 'You can configure alert rules only for tasks that can be used for real-time data synchronization.'."\n",
+ ],
+ 'ListDIAlarmRules' => [
+ 'summary' => 'Queries a list of alert rules configured for a new-version synchronization task. The following type of task is supported: real-time data synchronization from a MySQL database to Hologres.',
+ 'methods' => [
+ 'post',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'list',
+ 'abilityTreeCode' => '154898',
+ 'abilityTreeNodes' => [
+ 'FEATUREdideTG7EYI',
+ ],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'DIJobId',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The ID of the task with which the alert rules are associated.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => true,
+ 'example' => '11260',
+ ],
+ ],
+ [
+ 'name' => 'PageNumber',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The page number. Default value: 1.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'example' => '1',
+ 'default' => '1',
+ ],
+ ],
+ [
+ 'name' => 'PageSize',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The number of entries per page. Default value: 10.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'example' => '10',
+ 'default' => '10',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => 'Schema of Response',
+ 'description' => 'The returned result.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'title' => 'Id of the request',
+ 'description' => 'The request ID.'."\n",
+ 'type' => 'string',
+ 'example' => '74C2FECD-5B3A-554A-BCF5-351A36DE9815',
+ ],
+ 'DIAlarmRulePaging' => [
+ 'description' => 'The pagination information.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'TotalCount' => [
+ 'description' => 'The total number of entries returned.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '2',
+ ],
+ 'PageNumber' => [
+ 'description' => 'The page number.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '1',
+ ],
+ 'PageSize' => [
+ 'description' => 'The number of entries per page.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '10',
+ ],
+ 'DIJobAlarmRules' => [
+ 'description' => 'The alert rules.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The details of the alert rule.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'DIAlarmRuleId' => [
+ 'description' => 'The alert rule ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '41998',
+ ],
+ 'DIJobId' => [
+ 'description' => 'The ID of the task with which the alert rule is associated.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '11260',
+ ],
+ 'Description' => [
+ 'description' => 'The description of the alert rule.'."\n",
+ 'type' => 'string',
+ 'example' => 'mysql synchronizes to hologres heartbeat alert',
+ ],
+ 'MetricType' => [
+ 'description' => 'The metric type in the alert rule. Valid values:'."\n"
+ ."\n"
+ .'* Heartbeat'."\n"
+ .'* FailoverCount'."\n"
+ .'* Delay'."\n",
+ 'type' => 'string',
+ 'enumValueTitles' => [],
+ 'example' => 'Heartbeat',
+ ],
+ 'Enabled' => [
+ 'description' => 'Indicates whether the alert rule is enabled.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'TriggerConditions' => [
+ 'description' => 'The conditions that are used to trigger the alert rule.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The condition that is used to trigger the alert rule.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'Severity' => [
+ 'description' => 'The severity level. Valid values:'."\n"
+ ."\n"
+ .'* Warning'."\n"
+ .'* Critical'."\n",
+ 'type' => 'string',
+ 'enumValueTitles' => [],
+ 'example' => 'Warning',
+ ],
+ 'Duration' => [
+ 'description' => 'The time interval for alert calculation. Unit: minutes.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '15',
+ ],
+ 'Threshold' => [
+ 'description' => 'The alert threshold.'."\n"
+ ."\n"
+ .'* If the alert rule is for task status, no threshold is used.'."\n"
+ .'* If the alert rule is for failovers, the threshold is the number of failovers.'."\n"
+ .'* If the alert rule is for latency, the threshold is the latency duration, in seconds.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '5',
+ ],
+ ],
+ ],
+ ],
+ 'NotificationSettings' => [
+ 'description' => 'The alert notification settings.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'NotificationChannels' => [
+ 'description' => 'The alert notification methods.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The alert notification method.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'Severity' => [
+ 'description' => 'The severity level. Valid values:'."\n"
+ ."\n"
+ .'* Warning'."\n"
+ .'* Critical'."\n",
+ 'type' => 'string',
+ 'enumValueTitles' => [],
+ 'example' => 'Warning',
+ ],
+ 'Channels' => [
+ 'description' => 'The alert notification methods.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The alert notification method. Valid values:'."\n"
+ ."\n"
+ .'* Mail: email'."\n"
+ .'* Phone: phone call'."\n"
+ .'* Sms: text message'."\n"
+ .'* Ding: DingTalk chatbot token'."\n",
+ 'type' => 'string',
+ 'enumValueTitles' => [],
+ 'example' => 'Ding',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'NotificationReceivers' => [
+ 'description' => 'The settings of alert notification recipients.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The setting of an alert notification recipient.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'ReceiverType' => [
+ 'description' => 'The recipient type. Valid values: AliyunUid and DingToken.'."\n"
+ ."\n"
+ .'* If the alert notification method is Mail, Phone, or Sms, the value of this parameter is **AliyunUid**, which indicates the Alibaba Cloud account ID.'."\n"
+ .'* If the alert notification method is Ding, the value of this parameter is **DingToken**, which indicates the DingTalk chatbot token.'."\n",
+ 'type' => 'string',
+ 'enumValueTitles' => [],
+ 'example' => 'DingToken',
+ ],
+ 'ReceiverValues' => [
+ 'description' => 'The recipients.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The recipient.'."\n"
+ ."\n"
+ .'* If the recipient type is Alibaba Cloud account ID, the value of this parameter is the Alibaba Cloud account ID of a user.'."\n"
+ .'* If the recipient type is DingTalk chatbot token, the value of this parameter is the token of a DingTalk chatbot.'."\n",
+ 'type' => 'string',
+ 'example' => 'token1',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'InhibitionInterval' => [
+ 'description' => 'The duration of the alert suppression interval. Unit: minutes.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '5',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'errorCodes' => [
+ 403 => [
+ [
+ 'errorCode' => 'Forbidden.Access',
+ 'errorMessage' => 'Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.',
+ ],
+ ],
+ 429 => [
+ [
+ 'errorCode' => 'Throttling.Api',
+ 'errorMessage' => 'The request for this resource has exceeded your available limit.',
+ ],
+ [
+ 'errorCode' => 'Throttling.System',
+ 'errorMessage' => 'The DataWorks system is busy. Try again later.',
+ ],
+ [
+ 'errorCode' => 'Throttling.User',
+ 'errorMessage' => 'Your request is too frequent. Try again later.',
+ ],
+ ],
+ 500 => [
+ [
+ 'errorCode' => 'InternalError.System',
+ 'errorMessage' => 'An internal system error occurred. Try again later.',
+ ],
+ [
+ 'errorCode' => 'InternalError.UserId.Missing',
+ 'errorMessage' => 'An internal system error occurred. Try again later.',
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"74C2FECD-5B3A-554A-BCF5-35****\\",\\n \\"DIAlarmRulePaging\\": {\\n \\"TotalCount\\": 2,\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"DIJobAlarmRules\\": [\\n {\\n \\"DIAlarmRuleId\\": 41998,\\n \\"DIJobId\\": 11260,\\n \\"Description\\": \\"mysql synchronizes to hologres heartbeat alert\\",\\n \\"MetricType\\": \\"Heartbeat\\",\\n \\"Enabled\\": true,\\n \\"TriggerConditions\\": [\\n {\\n \\"Severity\\": \\"Warning\\",\\n \\"Duration\\": 15,\\n \\"Threshold\\": 5\\n }\\n ],\\n \\"NotificationSettings\\": {\\n \\"NotificationChannels\\": [\\n {\\n \\"Severity\\": \\"Warning\\",\\n \\"Channels\\": [\\n \\"Ding\\"\\n ]\\n }\\n ],\\n \\"NotificationReceivers\\": [\\n {\\n \\"ReceiverType\\": \\"DingToken\\",\\n \\"ReceiverValues\\": [\\n \\"token1\\"\\n ]\\n }\\n ],\\n \\"InhibitionInterval\\": 5\\n }\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<ListDIAlarmRulesResponse>\\n <RequestId>74C2FECD-5B3A-554A-BCF5-351A36DE9815</RequestId>\\n <DIAlarmRulePaging>\\n <TotalCount>2</TotalCount>\\n <PageNumber>1</PageNumber>\\n <PageSize>10</PageSize>\\n <DIJobAlarmRules>\\n <DIAlarmRuleId>41998</DIAlarmRuleId>\\n <DIJobId>11260</DIJobId>\\n <Description>mysql同步到hologres心跳告警</Description>\\n <MetricType>Heartbeat</MetricType>\\n <Enabled>true</Enabled>\\n <TriggerConditions>\\n <Severity>Warning</Severity>\\n <Duration>15</Duration>\\n <Threshold>5</Threshold>\\n </TriggerConditions>\\n <NotificationSettings>\\n <NotificationChannels>\\n <Severity>Warning</Severity>\\n <Channels>Ding</Channels>\\n </NotificationChannels>\\n <NotificationReceivers>\\n <ReceiverType>DingToken</ReceiverType>\\n <ReceiverValues>token1</ReceiverValues>\\n </NotificationReceivers>\\n <InhibitionInterval>5</InhibitionInterval>\\n </NotificationSettings>\\n </DIJobAlarmRules>\\n </DIAlarmRulePaging>\\n</ListDIAlarmRulesResponse>","errorExample":""}]',
+ 'title' => 'ListDIAlarmRules',
+ 'description' => 'You can configure alert rules only for tasks that can be used for real-time data synchronization.'."\n",
+ ],
+ 'UpdateDIAlarmRule' => [
+ 'summary' => 'Updates an alert rule for a new-version synchronization task. The following type of task is supported: real-time synchronization of all data in a MySQL database to Hologres.',
+ 'methods' => [
+ 'post',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'write',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'update',
+ 'abilityTreeCode' => '154892',
+ 'abilityTreeNodes' => [
+ 'FEATUREdide39WW3A',
+ ],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'DIAlarmRuleId',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The alert rule ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => true,
+ 'example' => '34982',
+ ],
+ ],
+ [
+ 'name' => 'Description',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The description of the alert rule.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'mysql synchronizes to hologres heartbeat alert',
+ ],
+ ],
+ [
+ 'name' => 'MetricType',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The metric type in the alert rule. Valid values:'."\n"
+ ."\n"
+ .'* Heartbeat'."\n"
+ .'* FailoverCount'."\n"
+ .'* Delay'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'enumValueTitles' => [],
+ 'example' => 'Heartbeat',
+ ],
+ ],
+ [
+ 'name' => 'TriggerConditions',
+ 'in' => 'formData',
+ 'style' => 'json',
+ 'schema' => [
+ 'description' => 'The conditions that are used to trigger the alert rule.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The condition that is used to trigger the alert rule.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'Severity' => [
+ 'description' => 'The severity level. Valid values:'."\n"
+ ."\n"
+ .'* Warning'."\n"
+ .'* Critical'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'enumValueTitles' => [],
+ 'example' => 'Warning',
+ ],
+ 'Duration' => [
+ 'description' => 'The time interval for alert calculation. Unit: minutes.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'example' => '15',
+ ],
+ 'Threshold' => [
+ 'description' => 'The alert threshold.'."\n"
+ ."\n"
+ .'* If the alert rule is for task status, you do not need to specify a threshold.'."\n"
+ .'* If the alert rule is for failovers, you must specify the number of failovers.'."\n"
+ .'* If the alert rule is for latency, you must specify the latency duration, in seconds.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'example' => '5',
+ ],
+ ],
+ 'required' => false,
+ ],
+ 'required' => true,
+ ],
+ ],
+ [
+ 'name' => 'NotificationSettings',
+ 'in' => 'formData',
+ 'style' => 'json',
+ 'schema' => [
+ 'description' => 'The alert notification settings.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'NotificationChannels' => [
+ 'description' => 'The alert notification methods.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The alert notification method.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'Severity' => [
+ 'description' => 'The severity level. Valid values:'."\n"
+ ."\n"
+ .'* Warning'."\n"
+ .'* Critical'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'enumValueTitles' => [],
+ 'example' => 'Warning',
+ ],
+ 'Channels' => [
+ 'description' => 'The alert notification methods.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The alert notification method. Valid values:'."\n"
+ ."\n"
+ .'* Mail: email'."\n"
+ .'* Phone: phone call'."\n"
+ .'* Sms: text message'."\n"
+ .'* Ding: DingTalk chatbot token'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'enumValueTitles' => [],
+ 'example' => 'Ding',
+ ],
+ 'required' => false,
+ ],
+ ],
+ 'required' => false,
+ ],
+ 'required' => true,
+ ],
+ 'NotificationReceivers' => [
+ 'description' => 'The settings of alert notification recipients.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The setting of an alert notification recipient.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'ReceiverType' => [
+ 'description' => 'The recipient type.'."\n"
+ ."\n"
+ .'* If the alert notification method is Mail, Phone, or Sms, the recipient type is the Alibaba Cloud account ID.'."\n"
+ .'* If the alert notification method is Ding, the recipient type is the DingTalk chatbot token.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'enumValueTitles' => [],
+ 'example' => 'DingToken',
+ ],
+ 'ReceiverValues' => [
+ 'description' => 'The recipients.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The recipient.'."\n"
+ ."\n"
+ .'* If the ReceiverType parameter is set to AliyunUid, set this parameter to the Alibaba Cloud account ID of a user.'."\n"
+ .'* If the ReceiverType parameter is set to DingToken, set this parameter to the token of a DingTalk chatbot.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'token1',
+ ],
+ 'required' => false,
+ ],
+ ],
+ 'required' => false,
+ ],
+ 'required' => true,
+ ],
+ 'InhibitionInterval' => [
+ 'description' => 'The duration of the alert suppression interval. Default value: 5. Unit: minutes.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => false,
+ 'example' => '5',
+ ],
+ ],
+ 'required' => true,
+ ],
+ ],
+ [
+ 'name' => 'Enabled',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'Specifies whether to enable the alert rule. By default, the alert rule is disabled.'."\n",
+ 'type' => 'boolean',
+ 'required' => false,
+ 'example' => 'true',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => 'Schema of Response',
+ 'description' => 'The returned result.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'title' => 'Id of the request',
+ 'description' => 'The request ID.'."\n",
+ 'type' => 'string',
+ 'example' => 'A6C6B486-E3A2-5D52-9E76-D9380485D946',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'errorCodes' => [
+ 403 => [
+ [
+ 'errorCode' => 'Forbidden.Access',
+ 'errorMessage' => 'Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.',
+ ],
+ ],
+ 429 => [
+ [
+ 'errorCode' => 'Throttling.Api',
+ 'errorMessage' => 'The request for this resource has exceeded your available limit.',
+ ],
+ [
+ 'errorCode' => 'Throttling.System',
+ 'errorMessage' => 'The DataWorks system is busy. Try again later.',
+ ],
+ [
+ 'errorCode' => 'Throttling.User',
+ 'errorMessage' => 'Your request is too frequent. Try again later.',
+ ],
+ ],
+ 500 => [
+ [
+ 'errorCode' => 'InternalError.System',
+ 'errorMessage' => 'An internal system error occurred. Try again later.',
+ ],
+ [
+ 'errorCode' => 'InternalError.UserId.Missing',
+ 'errorMessage' => 'An internal system error occurred. Try again later.',
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"A6C6B486-E3A2-5D52-9E76-D9380485D946\\"\\n}","errorExample":""},{"type":"xml","example":"<UpdateDIAlarmRuleResponse>\\n <RequestId>A6C6B486-E3A2-5D52-9E76-D9380485D946</RequestId>\\n</UpdateDIAlarmRuleResponse>","errorExample":""}]',
+ 'title' => 'UpdateDIAlarmRule',
+ 'description' => 'You can configure alert rules only for tasks that can be used for real-time data synchronization. You must update all fields in the alert rule.'."\n",
+ ],
+ 'QueryPublicModelEngine' => [
+ 'summary' => 'Queries information about objects that are created in Data Modeling by using fast modeling language (FML) statements.',
+ 'methods' => [
+ 'post',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'get',
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'Text',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The FML statement that is used to query information about objects that are created in Data Modeling. For more information, see [Use FML statements to configure and manage data tables](~~298128~~). Only SHOW statements are supported.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'show dim tables',
+ ],
+ ],
+ [
+ 'name' => 'ProjectId',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The DataWorks workspace ID. You can log on to the [DataWorks console](https://workbench.data.aliyun.com/console) and go to the Workspace page to query the ID.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => '1234',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'description' => 'The response parameters.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'description' => 'The request ID.'."\n",
+ 'type' => 'string',
+ 'example' => '4CFB2DED-7D9B-4C42-B4AA-CFF4991DFFF4',
+ ],
+ 'ReturnValue' => [
+ 'description' => 'The returned information about objects.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The returned information about the object.'."\n",
+ 'type' => 'object',
+ 'example' => '',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'errorCodes' => [
+ 400 => [
+ [
+ 'errorCode' => 'Valid.FML.NoPermission',
+ 'errorMessage' => 'You are not authorized to access the project resources.',
+ ],
+ [
+ 'errorCode' => 'Valid.FML.OnlySupportQueryStatement',
+ 'errorMessage' => 'Only FML query statement is supported.',
+ ],
+ [
+ 'errorCode' => 'Valid.FML.ProjectNotExist',
+ 'errorMessage' => 'The project does not exist.',
+ ],
+ [
+ 'errorCode' => 'Valid.FML.StatementNotValid',
+ 'errorMessage' => 'The FML statement is invalid.',
+ ],
+ [
+ 'errorCode' => 'Valid.FML.ProductExpired',
+ 'errorMessage' => '智能数据建模产品购买已到期',
+ ],
+ [
+ 'errorCode' => 'Valid.FML.ProductNotActivated',
+ 'errorMessage' => '智能数据建模产品未开通',
+ ],
+ ],
+ 500 => [
+ [
+ 'errorCode' => 'Execute.FML.ProcessError',
+ 'errorMessage' => 'Failed to execute FML statement.',
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"4CFB2DED-7D9B-4C42-B4AA-CFF4991DFFF4\\",\\n \\"ReturnValue\\": [\\n {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<QueryPublicModelEngineResponse>\\n <RequestId>4CFB2DED-7D9B-4C42-B4AA-CFF4991DFFF4</RequestId>\\n <ReturnValue/>\\n</QueryPublicModelEngineResponse>","errorExample":""}]',
+ 'title' => 'QueryPublicModelEngine',
+ 'description' => '* Each time you call this API operation, you must use FML statements to query information about objects that are created in Data Modeling.'."\n"
+ .'* The information about the objects can be queried by page, except for data layers, business processes, and data domains. You can add an offset to the end of an FML statement. The num LIMIT num statement specifies the offset when the information about the objects is queried, and the number of pages to return each time. The offset value must be a multiple of the number of pages.'."\n"
+ .'* A maximum of 1,000 entries can be returned each time you call this API operation.'."\n",
+ 'requestParamsDescription' => ' ',
+ 'responseParamsDescription' => '## Response description'."\n"
+ ."\n"
+ .'### FML statement used to query data layers'."\n"
+ ."\n"
+ .'show layers; '."\n"
+ .'Response parameters'."\n"
+ ."\n"
+ .'|Parameter|Type|Example|Description|'."\n"
+ .'|---|---|---|---|'."\n"
+ .'|code|String|dws|The code of the data layer.|'."\n"
+ .'|englishName|String|dws|The name of the data layer.|'."\n"
+ .'|name|String|DWS layer|The display name of the data layer.|'."\n"
+ .'|ownerId|String|0123456|The owner ID.|'."\n"
+ .'|ownerName|String|A, B, C, and D|The name of the owner.|'."\n"
+ .'|description|String|Description of the DWS layer|The description of the data layer.|'."\n"
+ .'|uuid|String|obj-123456|The UUID of the data layer.|'."\n"
+ .'|gmtCreate|TimeStamp|1644397025000|The time when the data layer was created.|'."\n"
+ .'|gmtModified|TimeStamp|1644459965000|The time when the data layer was last modified.|'."\n"
+ .'|creatorId|String|0123456|The ID of the user who created the data layer.|'."\n"
+ .'|creatorName|String|A, B, C, and D|The name of the user who created the data layer.|'."\n"
+ .'|modifierId|String|0123456|The ID of the user who last modified the data layer.|'."\n"
+ .'|modifierName|String|A, B, C, and D|The name of the user who last modified the data layer.|'."\n"
+ ."\n"
+ .'### FML statement used to query data domains'."\n"
+ ."\n"
+ .'show domains; '."\n"
+ .'Response parameters'."\n"
+ ."\n"
+ .'|Parameter|Type|Example|Description|'."\n"
+ .'|---|---|---|---|'."\n"
+ .'|code|String|member|The code of the data domain.|'."\n"
+ .'|englishName|String|member|The name of the data domain.|'."\n"
+ .'|name|String|Member|The display name of the data domain.|'."\n"
+ .'|ownerId|String|0123456|The owner ID.|'."\n"
+ .'|ownerName|String|A, B, C, and D|The name of the owner.|'."\n"
+ .'|businessUnitCode|String|bu-123456|The code of the business unit.|'."\n"
+ .'|description|String|Description of the Member data domain|The description of the data domain.|'."\n"
+ .'|uuid|String|obj-123456|The UUID of the data domain.|'."\n"
+ .'|gmtCreate|TimeStamp|1644397025000|The time when the data domain was created.|'."\n"
+ .'|gmtModified|TimeStamp|1644459965000|The time when the data domain was last modified.|'."\n"
+ .'|creatorId|String|0123456|The ID of the user who created the data domain.|'."\n"
+ .'|creatorName|String|A, B, C, and D|The name of the user who created the data domain.|'."\n"
+ .'|modifierId|String|0123456|The ID of the user who last modified the data domain.|'."\n"
+ .'|modifierName|String|A, B, C, and D|The name of the user who last modified the data domain.|'."\n"
+ ."\n"
+ .'### FML statements used to query business processes'."\n"
+ ."\n"
+ .'* FML statement used to query business processes without configuring query conditions: show business\\_processes;'."\n"
+ .'* FML statement used to query a business process based on the code of the business process: show business\\_processes where code=\'bp-code\';'."\n"
+ .'* FML statement used to query business processes based on the code of a data domain: show business\\_processes where data\\_domain=\'dm-code\';'."\n"
+ ."\n"
+ .'Response parameters'."\n"
+ ."\n"
+ .'|Parameter|Type|Example|Description|'."\n"
+ .'|---|---|---|---|'."\n"
+ .'|code|String|bp-123456|The code of the business process.|'."\n"
+ .'|englishName|String|pay|The name of the business process.|'."\n"
+ .'|name|String|Payment|The display name of the business process.|'."\n"
+ .'|dataDomainCode|String|trade|The code of the data domain to which the business process belongs.|'."\n"
+ .'|dataDomainName|String|Transaction|The display name of the data domain to which the business process belongs.|'."\n"
+ .'|dataDomainUuid|String|dm-123456|The UUID of the data domain to which the business process belongs.|'."\n"
+ .'|ownerId|String|0123456|The owner ID.|'."\n"
+ .'|ownerName|String|A, B, C, and D|The name of the owner.|'."\n"
+ .'|description|String|Payment|The description of the business process.|'."\n"
+ .'|source|Integer|2|The source of the business process. Valid values:1: indicates that the business process is created by the system.2: indicates that the business process is created by a user.|'."\n"
+ .'|uuid|String|obj-123456|The UUID of the business process.|'."\n"
+ .'|gmtCreate|TimeStamp|1644397025000|The time when the business process was created.|'."\n"
+ .'|gmtModified|TimeStamp|1644459965000|The time when the business process was last modified.|'."\n"
+ .'|creatorId|String|creatorId|The ID of the user who created the business process.|'."\n"
+ .'|creatorName|String|A, B, C, and D|The name of the user who created the business process.|'."\n"
+ .'|modifierId|String|0123456|The ID of the user who last modified the business process.|'."\n"
+ .'|modifierName|String|A, B, C, and D|The name of the user who last modified the business process.|'."\n"
+ ."\n"
+ .'### FML statements used to query business categories'."\n"
+ ."\n"
+ .'```'."\n"
+ .' show business_categories;'."\n"
+ .' show business_categories where code=\'code\';'."\n"
+ .' show business_categories where keyword=\'keyword\';'."\n"
+ .' show business_categories where uuid=\'uuid\'; '."\n"
+ .'```'."\n"
+ ."\n"
+ .'Response parameters'."\n"
+ ."\n"
+ .'|Parameter|Type|Example|Description|'."\n"
+ .'|---|---|---|---|'."\n"
+ .'|categoryDetail|DirectoryDetailDTO|{"uuid": "cate\\_uuid", "code": "trd", "name": "Transaction"}|The details of the business category.|'."\n"
+ .'|name|String|E-commerce|The name of the directory.|'."\n"
+ .'|detailType|String|DICT|The type of the directory.|'."\n"
+ .'|parentUuid|String|dy-123456|The UUID of the parent directory.|'."\n"
+ .'|description|String|Description|The description of the directory.|'."\n"
+ .'|code|String|ind|The code of the business category.|'."\n"
+ .'|dataDomains|List|\\[{"uuid": "domain1", "code": "trd", "name": "Transaction data domain"}\\]|The data domains that are associated with the business category.|'."\n"
+ .'|ownerId|String|0123456|The owner ID.|'."\n"
+ .'|ownerName|String|A, B, C, and D|The name of the owner.|'."\n"
+ .'|businessUnitCode|String|bu-123456|The code of the business unit.|'."\n"
+ .'|description|String|Description|The description of the directory.|'."\n"
+ .'|categoryPath|String|tm.ind|The path of the business category.|'."\n"
+ ."\n"
+ .'### FML statement used to query data marts'."\n"
+ ."\n"
+ .'show markets; Response parameters'."\n"
+ ."\n"
+ .'|Parameter|Type|Example|Description|'."\n"
+ .'|---|---|---|---|'."\n"
+ .'|categoryDetail|DirectoryDetailDTO|{"uuid": "cate\\_uuid", "code": "trd", "name": "Transaction"}|The details of the data mart.|'."\n"
+ .'|name|String|E-commerce|The name of the directory.|'."\n"
+ .'|detailType|String|DICT|The type of the directory.|'."\n"
+ .'|parentUuid|String|dy-123456|The UUID of the parent directory.|'."\n"
+ .'|description|String|Description|The description of the directory.|'."\n"
+ .'|code|String|ind|The code of the business category.|'."\n"
+ .'|subDetailType|String|common|The subtype of the directory.|'."\n"
+ .'|auditDTOList|List|\\[{"baseId":"123","showName":"test"}\\]|The reviewers.|'."\n"
+ .'|code|String|member|The code of the data domain.|'."\n"
+ .'|englishName|String|member|The name of the data domain.|'."\n"
+ .'|name|String|Member|The display name of the data domain.|'."\n"
+ .'|ownerId|String|0123456|The owner ID.|'."\n"
+ .'|ownerName|String|A, B, C, and D|The name of the owner.|'."\n"
+ .'|businessUnitCode|String|bu-123456|The code of the business unit.|'."\n"
+ .'|description|String|Description of the Member data domain|The description of the data domain.|'."\n"
+ .'|auditDTOList|List|\\[{"baseId":"123","showName":"test"}\\]|The reviewers.|'."\n"
+ .'|categoryPath|String|tm.ind|The path of the business category.|'."\n"
+ ."\n"
+ .'### FML statement used to query subject areas'."\n"
+ ."\n"
+ .'show subjects; Response parameters'."\n"
+ ."\n"
+ .'|Parameter|Type|Example|Description|'."\n"
+ .'|---|---|---|---|'."\n"
+ .'|categoryDetail|DirectoryDetailDTO|{"uuid": "cate\\_uuid", "code": "trd", "name": "Transaction"}|The details of the subject area.|'."\n"
+ .'|name|String|E-commerce|The name of the directory.|'."\n"
+ .'|detailType|String|DICT|The type of the directory.|'."\n"
+ .'|parentUuid|String|dy-123456|The UUID of the parent directory.|'."\n"
+ .'|description|String|Description|The description of the directory.|'."\n"
+ .'|code|String|ind|The code of the business category.|'."\n"
+ .'|subDetailType|String|common|The subtype of the directory.|'."\n"
+ .'|auditDTOList|List|\\[{"baseId":"123","showName":"test"}\\]|The reviewers.|'."\n"
+ .'|code|String|member|The code of the data domain.|'."\n"
+ .'|englishName|String|member|The name of the data domain.|'."\n"
+ .'|name|String|Member|The display name of the data domain.|'."\n"
+ .'|ownerId|String|0123456|The owner ID.|'."\n"
+ .'|ownerName|String|A, B, C, and D|The name of the owner.|'."\n"
+ .'|businessUnitCode|String|bu-123456|The code of the business unit.|'."\n"
+ .'|description|String|Description of the Member data domain|The description of the subject area.|'."\n"
+ .'|auditDTOList|List|\\[{"baseId":"123","showName":"test"}\\]|The reviewers.|'."\n"
+ .'|categoryPath|String|tm.ind|The path of the business category.|'."\n"
+ ."\n"
+ .'### FML statement used to query data standard sets'."\n"
+ ."\n"
+ .'show dict groups; Response parameters'."\n"
+ ."\n"
+ .'|Parameter|Type|Example|Description|'."\n"
+ .'|---|---|---|---|'."\n"
+ .'|name|String|E-commerce|The name of the directory.|'."\n"
+ .'|detailType|String|DICT|The type of the directory.|'."\n"
+ .'|parentUuid|String|dy-123456|The UUID of the parent directory.|'."\n"
+ .'|description|String|Description|The description of the directory.|'."\n"
+ .'|code|String|ind|The code of the business category.|'."\n"
+ .'|uuid|List|obj-123456|The UUID of the data standard set.|'."\n"
+ .'|gmtCreate|TimeStamp|1644397025000|The time when the data standard set was created.|'."\n"
+ .'|gmtModified|TimeStamp|1644459965000|The time when the data standard set was last modified.|'."\n"
+ .'|creatorId|String|0123456|The ID of the user who created the data standard set.|'."\n"
+ .'|creatorName|String|A, B, C, and D|The name of the user who created the data standard set.|'."\n"
+ .'|modifierId|String|0123456|The ID of the user who last modified the data standard set.|'."\n"
+ .'|modifierName|String|A, B, C, and D|The name of the user who last modified the data standard set.|'."\n"
+ ."\n"
+ .'### FML statement used to query data standards'."\n"
+ ."\n"
+ .'show dicts; Response parameters'."\n"
+ ."\n"
+ .'|Parameter|Type|Example|Description|'."\n"
+ .'|---|---|---|---|'."\n"
+ .'|code|String|shop\\_type|The abbreviation for the name of the data standard.|'."\n"
+ .'|englishName|String|shop type|The name of the data standard.|'."\n"
+ .'|name|String|Shop type|The display name of the data standard.|'."\n"
+ .'|no|String|SN00001|The data standard ID.|'."\n"
+ .'|dataType|String|STRING|The data type of the fields that use the data standard.|'."\n"
+ .'|length|Integer|10|The maximum number of digits in the values of the fields that use the data standard.|'."\n"
+ .'|numericalPrecision|Integer|2|The number of decimal places that are retained in the values of the fields that use the data standard.|'."\n"
+ .'|notNull|Boolean|false|Indicates whether the values of the fields that use the data standard can be non-null.|'."\n"
+ .'|defaultValue|String|Flagship shop|The default value.|'."\n"
+ .'|parentNo|String|SN0001|The ID of the parent data standard.|'."\n"
+ .'|parentName|String|Shop|The name of the parent data standard.|'."\n"
+ .'|codeTableNo|String|shop\\_type|The code of the lookup table that defines the value range of the fields that use the data standard.|'."\n"
+ .'|codeTableName|String|Shop type|The name of the lookup table that defines the value range of the fields that use the data standard.|'."\n"
+ .'|codeTableUuid|String|tb-0001|The UUID of the lookup table that defines the value range of the fields that use the data standard.|'."\n"
+ .'|directoryUuid|String|Directory UUID|The UUID of the directory in which the data standard is stored.|'."\n"
+ .'|directoryName|String|Shop directory|The name of the directory in which the data standard is stored.|'."\n"
+ .'|description|String|remark|The description of the data standard.|'."\n"
+ .'|uuid|String|obj-123456|The UUID of the data standard.|'."\n"
+ .'|gmtCreate|TimeStamp|1644397025000|The time when the data standard was created.|'."\n"
+ .'|gmtModified|TimeStamp|1644459965000|The time when the data standard was last modified.|'."\n"
+ .'|creatorId|String|0123456|The ID of the user who created the data standard.|'."\n"
+ .'|creatorName|String|A, B, C, and D|The name of the user who created the data standard.|'."\n"
+ .'|modifierId|String|0123456|The ID of the user who last modified the data standard.|'."\n"
+ .'|modifierName|String|A, B, C, and D|The name of the user who last modified the data standard.|'."\n"
+ ."\n"
+ .'### FML statement used to query lookup tables'."\n"
+ ."\n"
+ .'show code tables; Response parameters'."\n"
+ ."\n"
+ .'|Parameter|Type|Example|Description|'."\n"
+ .'|---|---|---|---|'."\n"
+ .'|code|String|shop\\_type|The code of the lookup table.|'."\n"
+ .'|name|String|Shop type|The display name of the lookup table.|'."\n"
+ .'|extendName|String|shop type|The name of the lookup table.|'."\n"
+ .'|description|String|remark|The description of the lookup table.|'."\n"
+ .'|uuid|String|obj-123456|The UUID of the lookup table.|'."\n"
+ .'|gmtCreate|TimeStamp|1644397025000|The time when the lookup table was created.|'."\n"
+ .'|gmtModified|TimeStamp|1644459965000|The time when the lookup table was last modified.|'."\n"
+ .'|creatorId|String|0123456|The ID of the user who created the lookup table.|'."\n"
+ .'|creatorName|String|A, B, C, and D|The name of the user who created the lookup table.|'."\n"
+ .'|modifierId|String|0123456|The ID of the user who last modified the lookup table.|'."\n"
+ .'|modifierName|String|A, B, C, and D|The name of the user who last modified the lookup table.|'."\n"
+ ."\n"
+ .'### FML statement used to query measurement unit groups'."\n"
+ ."\n"
+ .'show measure\\_unit groups; Response parameters'."\n"
+ ."\n"
+ .'|Parameter|Type|Example|Description|'."\n"
+ .'|---|---|---|---|'."\n"
+ .'|name|String|E-commerce|The name of the directory.|'."\n"
+ .'|detailType|String|DICT|The type of the directory.|'."\n"
+ .'|parentUuid|String|dy-123456|The UUID of the parent directory.|'."\n"
+ .'|description|String|Description|The description of the directory.|'."\n"
+ .'|code|String|ind|The code of the business category.|'."\n"
+ .'|uuid|String|obj-123456|The UUID of the measurement unit group.|'."\n"
+ .'|gmtCreate|TimeStamp|1644397025000|The time when the measurement unit group was created.|'."\n"
+ .'|gmtModified|TimeStamp|1644459965000|The time when the measurement unit group was last modified.|'."\n"
+ .'|creatorId|String|0123456|The ID of the user who created the measurement unit group.|'."\n"
+ .'|creatorName|String|A, B, C, and D|The name of the user who created the measurement unit group.|'."\n"
+ .'|modifierId|String|0123456|The ID of the user who last modified the measurement unit group.|'."\n"
+ .'|modifierName|String|A, B, C, and D|The name of the user who last modified the measurement unit group.|'."\n"
+ ."\n"
+ .'### FML statement used to query measurement units'."\n"
+ ."\n"
+ .'show measure\\_units; Response parameters'."\n"
+ ."\n"
+ .'|Parameter|Type|Example|Description|'."\n"
+ .'|---|---|---|---|'."\n"
+ .'|code|String|yuan|The abbreviation for the name of the measurement unit.|'."\n"
+ .'|englishName|String|RMB|The name of the measurement unit.|'."\n"
+ .'|name|String|Yuan|The display name of the measurement unit.|'."\n"
+ .'|directoryUuid|String|di-0001|The UUID of the measurement unit group to which the measurement unit belongs.|'."\n"
+ .'|directoryName|String|Currency|The name of the measurement unit group to which the measurement unit belongs.|'."\n"
+ .'|description|String|remark|The description of the measurement unit.|'."\n"
+ .'|uuid|String|obj-123456|The UUID of the measurement unit.|'."\n"
+ .'|gmtCreate|TimeStamp|1644397025000|The time when the measurement unit was created.|'."\n"
+ .'|gmtModified|TimeStamp|1644459965000|The time when the measurement unit was last modified.|'."\n"
+ .'|creatorId|String|0123456|The ID of the user who created the measurement unit.|'."\n"
+ .'|creatorName|String|A, B, C, and D|The name of the user who created the measurement unit.|'."\n"
+ .'|modifierId|String|0123456|The ID of the user who last modified the measurement unit.|'."\n"
+ .'|modifierName|String|A, B, C, and D|The name of the user who last modified the measurement unit.|'."\n"
+ ."\n"
+ .'### FML statement used to query the data of a lookup table'."\n"
+ ."\n"
+ .'show codes from code\\_table; Response parameters'."\n"
+ ."\n"
+ .'|Parameter|Type|Example|Description|'."\n"
+ .'|---|---|---|---|'."\n"
+ .'|codeContent|String|0|The content of the lookup table.|'."\n"
+ .'|extendNameContent|String|female|The display name of the lookup table.|'."\n"
+ .'|nameContent|String|Female|The name of the lookup table.|'."\n"
+ .'|description|String|remark|The description of the lookup table.|'."\n"
+ .'|uuid|String|obj-123456|The UUID of the lookup table.|'."\n"
+ .'|gmtCreate|TimeStamp|1644397025000|The time when the lookup table was created.|'."\n"
+ .'|gmtModified|TimeStamp|1644459965000|The time when the lookup table was last modified.|'."\n"
+ .'|creatorId|String|0123456|The ID of the user who created the lookup table.|'."\n"
+ .'|creatorName|String|A, B, C, and D|The name of the user who created the lookup table.|'."\n"
+ .'|modifierId|String|0123456|The ID of the user who last modified the lookup table.|'."\n"
+ .'|modifierName|String|A, B, C, and D|The name of the user who last modified the lookup table.|'."\n"
+ ."\n"
+ .'### FML statement used to query naming dictionaries'."\n"
+ ."\n"
+ .'show naming dicts; Response parameters'."\n"
+ ."\n"
+ .'|Parameter|Type|Example|Description|'."\n"
+ .'|---|---|---|---|'."\n"
+ .'|code|String|shop|The abbreviation for the name of the naming dictionary.|'."\n"
+ .'|creatorId|String|0123456|The ID of the user who created the naming dictionary.|'."\n"
+ .'|creatorName|String|A, B, C, and D|The name of the user who created the naming dictionary.|'."\n"
+ .'|extendName|String|shop|The name of the naming dictionary.|'."\n"
+ .'|gmtCreate|TimeStamp|1644397025000|The time when the naming dictionary was created.|'."\n"
+ .'|gmtModified|TimeStamp|1644459965000|The time when the naming dictionary was last modified.|'."\n"
+ .'|modifierId|String|0123456|The ID of the user who last modified the naming dictionary.|'."\n"
+ .'|modifierName|String|A, B, C, and D|The name of the user who last modified the naming dictionary.|'."\n"
+ .'|name|String|Shop|The display name of the naming dictionary.|'."\n"
+ .'|ownerId|String|0123456|The owner ID.|'."\n"
+ .'|ownerName|String|A, B, C, and D|The name of the owner.|'."\n"
+ .'|uuid|String|obj-123456|The UUID of the naming dictionary.|'."\n"
+ ."\n"
+ .'### FML statement used to query tables'."\n"
+ ."\n"
+ .'show tables; Response parameters'."\n"
+ ."\n"
+ .'|Parameter|Type|Example|Description|'."\n"
+ .'|---|---|---|---|'."\n"
+ .'|code|String|dim\\_shop|The code of the table.|'."\n"
+ .'|name|String|Shop table|The display name of the table.|'."\n"
+ .'|type|Integer|1|The type of the table. Valid values:0: fact table1: dimension table3: aggregate table4: application table5: ODS table6: dimension|'."\n"
+ .'|detailType|String|normal|The subtype of the table. Valid values:Common dimension tableEnumeration dimension tableTransaction fact table|'."\n"
+ .'|businessProcessUuid|String|bp-123456|The UUID of the business process.|'."\n"
+ .'|businessUnitUuid|String|bu-123456|The UUID of the business unit.|'."\n"
+ .'|dataWarehouseLayerUuid|String|ly-123456|The UUID of the data layer.|'."\n"
+ .'|businessCategoryUuid|String|bc-123456|The UUID of the business category.|'."\n"
+ .'|ownerId|String|0123456|The owner ID.|'."\n"
+ .'|ownerName|String|A, B, C, and D|The name of the owner.|'."\n"
+ .'|description|String|Description|The description of the table.|'."\n"
+ .'|config|String|JSON string|The extended configurations for the table.|'."\n"
+ .'|lifeCycle|Integer|365|The lifecycle of the table.|'."\n"
+ .'|uuid|String|obj-123456|The UUID of the table.|'."\n"
+ .'|gmtCreate|TimeStamp|1644397025000|The time when the table was created.|'."\n"
+ .'|gmtModified|TimeStamp|1644459965000|The time when the table was last modified.|'."\n"
+ .'|creatorId|String|0123456|The ID of the user who created the table.|'."\n"
+ .'|creatorName|String|A, B, C, and D|The name of the user who created the table.|'."\n"
+ .'|modifierId|String|0123456|The ID of the user who last modified the table.|'."\n"
+ .'|modifierName|String|A, B, C, and D|The name of the user who last modified the table.|'."\n"
+ ."\n"
+ .'### FML statement used to query dimension tables'."\n"
+ ."\n"
+ .'show dim tables; '."\n"
+ .'Response parameters'."\n"
+ ."\n"
+ .'|Parameter|Type|Example|Description|'."\n"
+ .'|---|---|---|---|'."\n"
+ .'|code|String|dim\\_shop|The code of the dimension table.|'."\n"
+ .'|name|String|Shop table|The display name of the dimension table.|'."\n"
+ .'|type|Integer|1|The type of the table. Valid values:0: fact table1: dimension table|'."\n"
+ .'|detailType|String|normal|The subtype of the table. Valid values:Common dimension tableEnumeration dimension table|'."\n"
+ .'|businessProcessUuid|String|bp-123456|The UUID of the business process.|'."\n"
+ .'|businessUnitUuid|String|bu-123456|The UUID of the business unit.|'."\n"
+ .'|dataWarehouseLayerUuid|String|ly-123456|The UUID of the data layer.|'."\n"
+ .'|businessCategoryUuid|String|bc-123456|The UUID of the business category.|'."\n"
+ .'|ownerId|String|0123456|The owner ID.|'."\n"
+ .'|ownerName|String|A, B, C, and D|The name of the owner.|'."\n"
+ .'|description|String|Description|The description of the dimension table.|'."\n"
+ .'|config|String|JSON string|The extended configurations for the dimension table.|'."\n"
+ .'|lifeCycle|Integer|365|The lifecycle of the dimension table.|'."\n"
+ .'|uuid|String|obj-123456|The UUID of the dimension table.|'."\n"
+ .'|gmtCreate|TimeStamp|1644397025000|The time when the dimension table was created.|'."\n"
+ .'|gmtModified|TimeStamp|1644459965000|The time when the dimension table was last modified.|'."\n"
+ .'|creatorId|String|0123456|The ID of the user who created the dimension table.|'."\n"
+ .'|creatorName|String|A, B, C, and D|The name of the user who created the dimension table.|'."\n"
+ .'|modifierId|String|0123456|The ID of the user who last modified the dimension table.|'."\n"
+ .'|modifierName|String|A, B, C, and D|The name of the user who last modified the dimension table.|'."\n"
+ ."\n"
+ .'### FML statement used to query fact tables'."\n"
+ ."\n"
+ .'show fact tables; Response parameters'."\n"
+ ."\n"
+ .'|Parameter|Type|Example|Description|'."\n"
+ .'|---|---|---|---|'."\n"
+ .'|code|String|dim\\_shop|The code of the fact table.|'."\n"
+ .'|name|String|Shop table|The display name of the fact table.|'."\n"
+ .'|type|Integer|1|The type of the table. Valid values:0: fact table1: dimension table|'."\n"
+ .'|detailType|String|normal|The subtype of the table. Only transaction fact tables are supported.|'."\n"
+ .'|businessProcessUuid|String|bp-123456|The UUID of the business process.|'."\n"
+ .'|businessUnitUuid|String|bu-123456|The UUID of the business unit.|'."\n"
+ .'|dataWarehouseLayerUuid|String|ly-123456|The UUID of the data layer.|'."\n"
+ .'|businessCategoryUuid|String|bc-123456|The UUID of the business category.|'."\n"
+ .'|ownerId|String|0123456|The owner ID.|'."\n"
+ .'|ownerName|String|A, B, C, and D|The name of the owner.|'."\n"
+ .'|description|String|Description|The description of the fact table.|'."\n"
+ .'|config|String|JSON string|The extended configurations for the fact table.|'."\n"
+ .'|lifeCycle|Integer|365|The lifecycle of the fact table.|'."\n"
+ .'|uuid|String|obj-123456|The UUID of the fact table.|'."\n"
+ .'|gmtCreate|TimeStamp|1644397025000|The time when the fact table was created.|'."\n"
+ .'|gmtModified|TimeStamp|1644459965000|The time when the fact table was last modified.|'."\n"
+ .'|creatorId|String|0123456|The ID of the user who created the fact table.|'."\n"
+ .'|creatorName|String|A, B, C, and D|The name of the user who created the fact table.|'."\n"
+ .'|modifierId|String|0123456|The ID of the user who last modified the fact table.|'."\n"
+ .'|modifierName|String|A, B, C, and D|The name of the user who last modified the fact table.|'."\n"
+ ."\n"
+ .'### FML statement used to query aggregate tables'."\n"
+ ."\n"
+ .'show dws tables; Response parameters'."\n"
+ ."\n"
+ .'|Parameter|Type|Example|Description|'."\n"
+ .'|---|---|---|---|'."\n"
+ .'|dataDomainUuid|String|dm-12345|The UUID of the data domain.|'."\n"
+ .'|dataDomainCode|String|member|The code of the data domain.|'."\n"
+ .'|dataDomainName|String|Member|The name of the data domain.|'."\n"
+ .'|timePeriods|List|\\[{"uuid": "uuid", "code": "code", "name": "Display name"}\\]|The periods for the aggregate table.|'."\n"
+ .'|uuid|String|obj-123456|The UUID of the aggregate table.|'."\n"
+ .'|code|String|dws\\_001|The name of the aggregate table.|'."\n"
+ .'|name|String|Payment aggregate table|The display name of the aggregate table.|'."\n"
+ .'|adjuncts|List|\\[{"uuid": "uuid", "code": "code", "name": "Display name"}\\]|The modifiers for the aggregate table.|'."\n"
+ .'|dimensions|List|\\[{"uuid": "uuid", "code": "code", "name": "Display name"}\\]|The dimensions that are associated with the aggregate table.|'."\n"
+ .'|bizEntityUuid|String|dim-123456|The UUID of the business object.|'."\n"
+ .'|bizEntityCode|String|dim\\_shop|The abbreviation for the name of the business object.|'."\n"
+ .'|bizEntityName|String|Shop table|The display name of the business object.|'."\n"
+ .'|relUuid|String|dim\\_a-123456|The UUID of the dimension that is associated with the aggregate table.|'."\n"
+ .'|type|Integer|3|The type of the table. Only 3 (aggregate table) is supported.|'."\n"
+ .'|detailType|String|dws\\_normal|The subtype of the table. Valid values:dws\\_normal: single-granularity aggregate tabledws\\_advanced: multi-granularity aggregate table|'."\n"
+ .'|businessProcessUuid|String|bp-123456|The UUID of the business process.|'."\n"
+ .'|businessUnitUuid|String|bu-123456|The UUID of the business unit.|'."\n"
+ .'|dataWarehouseLayerUuid|String|ly-123456|The UUID of the data layer.|'."\n"
+ .'|businessCategoryUuid|String|bc-123456|The UUID of the business category.|'."\n"
+ .'|ownerId|String|0123456|The owner ID.|'."\n"
+ .'|ownerName|String|A, B, C, and D|The name of the owner.|'."\n"
+ .'|description|String|Description|The description of the aggregate table.|'."\n"
+ .'|config|String|JSON string|The extended configurations for the aggregate table.|'."\n"
+ .'|lifeCycle|Integer|365|The lifecycle of the aggregate table.|'."\n"
+ .'|gmtCreate|TimeStamp|1644397025000|The time when the aggregate table was created.|'."\n"
+ .'|gmtModified|TimeStamp|1644459965000|The time when the aggregate table was last modified.|'."\n"
+ .'|creatorId|String|0123456|The ID of the user who created the aggregate table.|'."\n"
+ .'|creatorName|String|A, B, C, and D|The name of the user who created the aggregate table.|'."\n"
+ .'|modifierId|String|0123456|The ID of the user who last modified the aggregate table.|'."\n"
+ .'|modifierName|String|A, B, C, and D|The name of the user who last modified the aggregate table.|'."\n"
+ ."\n"
+ .'### FML statement used to query application tables'."\n"
+ ."\n"
+ .'show ads tables; Response parameters'."\n"
+ ."\n"
+ .'|Parameter|Type|Example|Description|'."\n"
+ .'|---|---|---|---|'."\n"
+ .'|dataDomainUuid|String|dm-12345|The UUID of the data domain.|'."\n"
+ .'|dataDomainCode|String|member|The code of the data domain.|'."\n"
+ .'|dataDomainName|String|Member|The name of the data domain.|'."\n"
+ .'|timePeriods|List|\\[{"uuid": "uuid", "code": "code", "name": "Display name"}\\]|The periods for the application table.|'."\n"
+ .'|uuid|String|obj-123456|The UUID of the application table.|'."\n"
+ .'|code|String|dws\\_001|The name of the application table.|'."\n"
+ .'|name|String|Payment application table|The display name of the application table.|'."\n"
+ .'|adjuncts|List|\\[{"uuid": "uuid", "code": "code", "name": "Display name"}\\]|The modifiers for the application table.|'."\n"
+ .'|dimensions|List|\\[{"uuid": "uuid", "code": "code", "name": "Display name"}\\]|The dimensions that are associated with the application table.|'."\n"
+ .'|bizEntityUuid|String|dim-123456|The UUID of the business object.|'."\n"
+ .'|bizEntityCode|String|dim\\_shop|The abbreviation for the name of the business object.|'."\n"
+ .'|bizEntityName|String|Shop table|The display name of the business object.|'."\n"
+ .'|relUuid|String|dim\\_a-123456|The UUID of the dimension that is associated with the application table.|'."\n"
+ .'|type|Integer|1|The type of the table. Valid values:0: fact table1: dimension table<x>4: application table</x>|'."\n"
+ .'|detailType|String|normal|The subtype of the table. Valid values:Common dimension tableEnumeration dimension tableTransaction fact table|'."\n"
+ .'|businessProcessUuid|String|bp-123456|The UUID of the business process.|'."\n"
+ .'|businessUnitUuid|String|bu-123456|The UUID of the business unit.|'."\n"
+ .'|dataWarehouseLayerUuid|String|ly-123456|The UUID of the data layer.|'."\n"
+ .'|businessCategoryUuid|String|bc-123456|The UUID of the business category.|'."\n"
+ .'|ownerId|String|0123456|The owner ID.|'."\n"
+ .'|ownerName|String|A, B, C, and D|The name of the owner.|'."\n"
+ .'|description|String|Description|The description of the application table.|'."\n"
+ .'|config|String|JSON string|The extended configurations for the application table.|'."\n"
+ .'|lifeCycle|Integer|365|The lifecycle of the application table.|'."\n"
+ .'|gmtCreate|TimeStamp|1644397025000|The time when the application table was created.|'."\n"
+ .'|gmtModified|TimeStamp|1644459965000|The time when the application table was last modified.|'."\n"
+ .'|creatorId|String|0123456|The ID of the user who created the application table.|'."\n"
+ .'|creatorName|String|A, B, C, and D|The name of the user who created the application table.|'."\n"
+ .'|modifierId|String|0123456|The ID of the user who last modified the application table.|'."\n"
+ .'|modifierName|String|A, B, C, and D|The name of the user who last modified the application table.|'."\n"
+ ."\n"
+ .'### FML statement used to query tables and return the fields of each table'."\n"
+ ."\n"
+ .'show full tables; Response parameters'."\n"
+ ."\n"
+ .'|Parameter|Type|Example|Description|'."\n"
+ .'|---|---|---|---|'."\n"
+ .'|tableUuid|String|tb-123456|The UUID of the table.|'."\n"
+ .'|tableCode|String|dim\\_shop|The code of the table.|'."\n"
+ .'|tableName|String|Shop table|The name of the table.|'."\n"
+ .'|columnCode|String|shop\\_id|The code of the column.|'."\n"
+ .'|columnName|String|Shop ID|The name of the column.|'."\n"
+ .'|columnUuid|String|col-123456|The UUID of the column.|'."\n"
+ .'|columnType|String|STRING|The data type of the column.|'."\n"
+ .'|columnCategory|String|ATTRIBUTE|The type of the column.|'."\n"
+ ."\n"
+ .'### FML statement used to query information about the columns of a table'."\n"
+ ."\n"
+ .'show columns from table\\_code; Response parameters'."\n"
+ ."\n"
+ .'|Parameter|Type|Example|Description|'."\n"
+ .'|---|---|---|---|'."\n"
+ .'|code|String|seller\\_id|The code of the column.|'."\n"
+ .'|name|String|Seller ID|The display name of the column.|'."\n"
+ .'|dataType|String|STRING|The data type of the column.|'."\n"
+ .'|type|String|ATTRIBUTE|The type of the field.|'."\n"
+ .'|isPrimaryKey|Boolean|false|Indicates whether the field is a primary key column.|'."\n"
+ .'|isPartitionKey|Boolean|false|Indicates whether the field is a partition key column.|'."\n"
+ .'|partitionOrder|Integer|1|The order of the partition key column.|'."\n"
+ .'|notNull|Boolean|true|Indicates whether the field is non-null.|'."\n"
+ .'|dataDictionaryUuid|String|member\\_id|The UUID of the data dictionary.|'."\n"
+ .'|dataDictionaryCode|String|Member ID|The name of the data dictionary.|'."\n"
+ .'|codeTableUuid|String|cd-123456|The UUID of the associated lookup table.|'."\n"
+ .'|codeTableCode|String|sex|The code of the associated lookup table.|'."\n"
+ .'|codeTableName|String|Gender|The name of the associated lookup table.|'."\n"
+ .'|measureUnitCode|String|percent|The code of the associated measurement unit.|'."\n"
+ .'|measureUnitName|String|Percent|The name of the associated measurement unit.|'."\n"
+ .'|sourceProjectName|String|autotest|The name of the source workspace.|'."\n"
+ .'|sourceTableCode|String|dict|The code of the source table.|'."\n"
+ .'|sourceColumnCode|String|age|The code of the source field.|'."\n"
+ .'|sourceRelationTag|String|label|The tag of the source relationship.|'."\n"
+ .'|description|String|Description|The description of the field.|'."\n"
+ .'|orderId|String|1|The order of the field.|'."\n"
+ .'|columnGroupName|Integer|col\\_group\\_1|The name of the group to which the field belongs.|'."\n"
+ .'|config|String|JSON string|The extended configurations for the field.|'."\n"
+ .'|uuid|String|obj-123456|The UUID of the field.|'."\n"
+ .'|gmtCreate|TimeStamp|1644397025000|The time when the field was created.|'."\n"
+ .'|gmtModified|TimeStamp|1644459965000|The time when the field was last modified.|'."\n"
+ .'|creatorId|String|0123456|The ID of the user who created the field.|'."\n"
+ .'|creatorName|String|A, B, C, and D|The name of the user who created the field.|'."\n"
+ .'|modifierId|String|0123456|The ID of the user who last modified the field.|'."\n"
+ .'|modifierName|String|A, B, C, and D|The name of the user who last modified the field.|'."\n"
+ ."\n"
+ .'### FML statement used to query modifiers'."\n"
+ ."\n"
+ .'show adjuncts; Response parameters'."\n"
+ ."\n"
+ .'|Parameter|Type|Example|Description|'."\n"
+ .'|---|---|---|---|'."\n"
+ .'|businessUnitUuid|String|bu-123456|The UUID of the business unit.|'."\n"
+ .'|businessUnitCode|String|test\\_bu|The code of the business unit.|'."\n"
+ .'|businessUnitName|String|Test|The name of the business unit.|'."\n"
+ .'|dataDomainUuid|String|dt-123456|The UUID of the data domain.|'."\n"
+ .'|dataDomainCode|String|member|The code of the data domain.|'."\n"
+ .'|dataDomainName|String|Member|The name of the data domain.|'."\n"
+ .'|categoryUuid|String|cy-123456|The UUID of the business category.|'."\n"
+ .'|categoryCode|String|trade|The code of the business category.|'."\n"
+ .'|categoryName|String|E-commerce|The name of the business category.|'."\n"
+ .'|type|AdjunctTypeEnum|DIM\\_VAL|The type of the modifier.|'."\n"
+ .'|code|String|beauty|The abbreviation for the name of the modifier.|'."\n"
+ .'|name|String|Makeup|The display name of the modifier.|'."\n"
+ .'|extendName|String|beauty|The name of the modifier.|'."\n"
+ .'|description|String|Description|The description of the modifier.|'."\n"
+ .'|bizExpression|String|Statistical criterion|The statistical criterion of the modifier.|'."\n"
+ .'|expression|String|beauty = 1|The expression of the modifier.|'."\n"
+ .'|bizEntityUuid|String|dim-123456|The UUID of the business object.|'."\n"
+ .'|bizEntityCode|String|dim\\_shop|The abbreviation for the name of the business object.|'."\n"
+ .'|bizEntityName|String|Shop table|The display name of the business object.|'."\n"
+ .'|relUuid|String|dim\\_a-123456|The UUID of the dimension that is associated with the modifier.|'."\n"
+ .'|ownerId|String|0123456|The owner ID.|'."\n"
+ .'|ownerName|String|A, B, C, and D|The name of the owner.|'."\n"
+ .'|isDeleted|DeleteTagEnum|NO|Indicates whether the modifier is deleted.|'."\n"
+ .'|uuid|String|obj-123456|The UUID of the modifier.|'."\n"
+ .'|gmtCreate|TimeStamp|1644397025000|The time when the modifier was created.|'."\n"
+ .'|gmtModified|TimeStamp|1644459965000|The time when the modifier was last modified.|'."\n"
+ .'|creatorId|String|0123456|The ID of the user who created the modifier.|'."\n"
+ .'|creatorName|String|A, B, C, and D|The name of the user who created the modifier.|'."\n"
+ .'|modifierId|String|0123456|The ID of the user who last modified the modifier.|'."\n"
+ .'|modifierName|String|A, B, C, and D|The name of the user who last modified the modifier.|'."\n"
+ ."\n"
+ .'### FML statement used to query periods'."\n"
+ ."\n"
+ .'show time\\_periods; Response parameters'."\n"
+ ."\n"
+ .'|Parameter|Type|Example|Description|'."\n"
+ .'|---|---|---|---|'."\n"
+ .'|businessUnitUuid|String|bu-123456|The UUID of the business unit to which the period belongs.|'."\n"
+ .'|businessUnitCode|String|test\\_bu|The code of the business unit.|'."\n"
+ .'|type|TimePeriodTypeEnum|DAY|The type of the period.|'."\n"
+ .'|typeName|String|Day|The name of the type of the period.|'."\n"
+ .'|code|String|1d|The abbreviation for the name of the period.|'."\n"
+ .'|name|String|One day|The display name of the period.|'."\n"
+ .'|extendName|String|1d|The name of the period.|'."\n"
+ .'|description|String|Description|The description of the period.|'."\n"
+ .'|isDeleted|DeleteTagEnum|NO|Indicates whether the period is deleted.|'."\n"
+ .'|timeBegin|String|start\\_expression|The expression for the start time.|'."\n"
+ .'|timeEnd|String|end\\_expression|The expression for the end time.|'."\n"
+ .'|gmtCreate|TimeStamp|1633885261000|The time when the period was created.|'."\n"
+ .'|gmtModified|TimeStamp|1633885261000|The time when the period was last modified.|'."\n"
+ .'|modifierId|String|0123456|The ID of the user who last modified the period.|'."\n"
+ .'|modifierName|String|A, B, C, and D|The name of the user who last modified the period.|'."\n"
+ .'|ownerId|String|0123456|The owner ID.|'."\n"
+ .'|ownerName|String|A, B, C, and D|The name of the owner.|'."\n"
+ .'|beginOffset|Integer|1|The offset of the start time.|'."\n"
+ .'|endOffset|Integer|1|The offset of the end time.|'."\n"
+ .'|firstDay|Integer|1|The first day of the period. This parameter is returned if the type of the period is set to WEEK, MONTH, QUARTER, or YEAR. Valid values if the type of the period is set to WEEK: 1 to 7, which indicate Sunday, Monday, Tuesday, Wednesday, Thursday, Friday, and Saturday. Valid values if the type of the period is set to MONTH: 1, 99, and 2 to 27. The value 1 indicates the first day of the month, the value 99 indicates the end of the month, and values from 2 to 27 indicate the 2nd to 27th days of the month. Valid values if the type of the period is set to QUARTER: 0 to 11, which indicate January to December. Valid values if the type of the period is set to YEAR: 0 to 11, which indicate January to December.|'."\n"
+ .'|uuid|String|obj-123456|The UUID of the period.|'."\n"
+ .'|creatorId|String|0123456|The ID of the user who created the period.|'."\n"
+ .'|creatorName|String|A, B, C, and D|The name of the user who created the period.|'."\n"
+ ."\n"
+ .'### FML statement used to query atomic metrics'."\n"
+ ."\n"
+ .'show atomic indicators; Response parameters'."\n"
+ ."\n"
+ .'|Parameter|Type|Example|Description|'."\n"
+ .'|---|---|---|---|'."\n"
+ .'|dataDistinct|YesOrNoEnum|YES|Indicates whether duplicate data is removed during statistics collection. Valid values:YESNO|'."\n"
+ .'|aggFunctionType|AggFunctionEnum|SUM|The type of the function for the atomic metric. Valid values:SUMCOUNTAVGMAXMINRATERANKUNDEFINED|'."\n"
+ .'|calExpression|String|price|The expression of the atomic metric.|'."\n"
+ .'|dataType|DataTypeNameEnum|TINYINT|The type of data that can be collected by the atomic metric. Valid values: TINYINT, SMALLINT, INT, BIGINT, BINARY, FLOAT, DOUBLE, DECIMAL, VARCHAR, CHAR, STRING, DATE, DATETIME, TIMESTAMP, BOOLEAN, ARRAY, MAP, STRUCT, and JSON|'."\n"
+ .'|dataRound|String|N|The number of decimal places after the decimal point. Valid values:NM|'."\n"
+ .'|dataUnitUuid|String|du-123456|The UUID of the metric unit.|'."\n"
+ .'|dataUnitCode|String|percent|The code of the metric unit.|'."\n"
+ .'|dataUnitName|String|Fen|The name of the metric unit.|'."\n"
+ .'|bizExpression|String|Aggregation of payment amount|The statistical criterion.|'."\n"
+ .'|dataRollUpType|String|AGG\\_FUNCTION|The method of the data roll-up. Valid values:AGG\\_FUNCTIONSUM\\_THEN\\_RATERATE\\_THEN\\_AVGNOT\\_SUPPORT|'."\n"
+ .'|businessUnitUuid|String|bu-0001|The UUID of the business unit.|'."\n"
+ .'|businessUnitCode|String|project\\_code|The code of the business unit.|'."\n"
+ .'|businessProcessUuid|String|di-0002|The UUID of the business process.|'."\n"
+ .'|businessProcessCode|String|pay|The code of the business process.|'."\n"
+ .'|businessProcessName|String|Payment|The name of the business process.|'."\n"
+ .'|dataDomainUuid|String|di-0003|The UUID of the data domain.|'."\n"
+ .'|dataDomainCode|String|trd|The code of the data domain.|'."\n"
+ .'|dataDomainName|String|Transaction|The name of the data domain.|'."\n"
+ .'|categoryUuid|String|di-0001|The UUID of the business category.|'."\n"
+ .'|categoryCode|String|tb|The code of the business category.|'."\n"
+ .'|categoryName|String|Taobao|The name of the business category.|'."\n"
+ .'|type|String|ATOMIC|The type of the metric. Valid values:ATOMICDERIVATIVEDERIVATIVE\\_COMPOSITE|'."\n"
+ .'|code|String|pay\\_amt|The abbreviation for the name of the atomic metric.|'."\n"
+ .'|name|String|Payment amount|The display name of the atomic metric.|'."\n"
+ .'|extendName|String|pay amount|The name of the atomic metric.|'."\n"
+ .'|description|String|remark|The description of the atomic metric.|'."\n"
+ .'|status|String|NORMAL|The status of the atomic metric. Valid values:DRAFTDEVNORMAL|'."\n"
+ .'|ownerId|String|0001|The owner ID.|'."\n"
+ .'|ownerName|String|Owner name|The name of the owner.|'."\n"
+ .'|isDeleted|DeleteTagEnum|NO|Indicates whether the atomic metric is deleted. Valid values:YESNO|'."\n"
+ .'|uuid|String|obj-123456|The UUID of the atomic metric.|'."\n"
+ .'|gmtCreate|TimeStamp|1644397025000|The time when the atomic metric was created.|'."\n"
+ .'|gmtModified|TimeStamp|1644459965000|The time when the atomic metric was last modified.|'."\n"
+ .'|creatorId|String|0123456|The ID of the user who created the atomic metric.|'."\n"
+ .'|creatorName|String|A, B, C, and D|The name of the user who created the atomic metric.|'."\n"
+ .'|modifierId|String|0123456|The ID of the user who last modified the atomic metric.|'."\n"
+ .'|modifierName|String|A, B, C, and D|The name of the user who last modified the atomic metric.|'."\n"
+ ."\n"
+ .'### FML statement used to query derived metrics'."\n"
+ ."\n"
+ .'show derivative indicators; Response parameters'."\n"
+ ."\n"
+ .'|Parameter|Type|Example|Description|'."\n"
+ .'|---|---|---|---|'."\n"
+ .'|timePeriodUuid|String|tp-0001|The UUID of the period.|'."\n"
+ .'|timePeriodCode|String|1d|The abbreviation for the name of the period.|'."\n"
+ .'|timePeriodName|String|Last day|The display name of the period.|'."\n"
+ .'|adjunctUuids|List|\\["adj-001"\\]|The UUIDs of modifiers.|'."\n"
+ .'|adjunctCodes|List|\\["male"\\]|The abbreviations for the names of modifiers.|'."\n"
+ .'|adjunctNames|List|Male|The display names of modifiers.|'."\n"
+ .'|atomicIndicatorUuid|String|ind-a-0001|The UUID of the atomic metric.|'."\n"
+ .'|atomicIndicatorCode|String|pay\\_amt|The abbreviation for the name of the atomic metric.|'."\n"
+ .'|atomicIndicatorName|String|Payment amount|The display name of the atomic metric.|'."\n"
+ .'|dataType|DataTypeNameEnum|BIGINT|The type of data that can be collected by the derived metric. Valid values: TINYINT, SMALLINT, INT, BIGINT, BINARY, FLOAT, DOUBLE, DECIMAL, VARCHAR, CHAR, STRING, DATE, DATETIME, TIMESTAMP, BOOLEAN, ARRAY, MAP, STRUCT, and JSON|'."\n"
+ .'|bizEntityUuid|String|dim-123456|The UUID of the business object.|'."\n"
+ .'|bizEntityCode|String|dim\\_shop|The abbreviation for the name of the business object.|'."\n"
+ .'|bizEntityName|String|Shop table|The display name of the business object.|'."\n"
+ .'|relUuid|String|dim\\_a-123456|The UUID of the dimension that is associated with the derived metric.|'."\n"
+ .'|indHash|String|hash-0001|The hash value for the elements of the derived metric.|'."\n"
+ .'|suggestCode|String|pay\\_amt\\_1d|The recommended code that is used by the derived metric.|'."\n"
+ .'|businessUnitUuid|String|bu-0001|The UUID of the business unit.|'."\n"
+ .'|businessUnitCode|String|project\\_code|The code of the business unit.|'."\n"
+ .'|businessProcessUuid|String|di-0002|The UUID of the business process.|'."\n"
+ .'|businessProcessCode|String|pay|The code of the business process.|'."\n"
+ .'|businessProcessName|String|Payment|The name of the business process.|'."\n"
+ .'|dataDomainUuid|String|di-0003|The UUID of the data domain.|'."\n"
+ .'|dataDomainCode|String|trd|The code of the data domain.|'."\n"
+ .'|dataDomainName|String|Transaction|The name of the data domain.|'."\n"
+ .'|categoryUuid|String|di-0001|The UUID of the business category.|'."\n"
+ .'|categoryCode|String|tb|The code of the business category.|'."\n"
+ .'|categoryName|String|Taobao|The name of the business category.|'."\n"
+ .'|type|IndicatorTypeEnum|ATOMIC|The type of the metric. Valid values:ATOMICDERIVATIVEDERIVATIVE\\_COMPOSITE|'."\n"
+ .'|code|String|pay\\_amt|The abbreviation for the name of the derived metric.|'."\n"
+ .'|name|String|Payment amount|The display name of the derived metric.|'."\n"
+ .'|extendName|String|pay amount|The name of the derived metric.|'."\n"
+ .'|description|String|remark|The description of the derived metric.|'."\n"
+ .'|status|IndicatorStatusEnum|NORMAL|The status of the derived metric. Valid values:DRAFTDEVNORMAL|'."\n"
+ .'|ownerId|String|0001|The owner ID.|'."\n"
+ .'|ownerName|String|Owner name|The name of the owner.|'."\n"
+ .'|isDeleted|DeleteTagEnum|NO|Indicates whether the derived metric is deleted. Valid values:YESNO|'."\n"
+ .'|uuid|String|obj-123456|The UUID of the derived metric.|'."\n"
+ .'|gmtCreate|TimeStamp|1644397025000|The time when the derived metric was created.|'."\n"
+ .'|gmtModified|TimeStamp|1644459965000|The time when the derived metric was last modified.|'."\n"
+ .'|creatorId|String|0123456|The ID of the user who created the derived metric.|'."\n"
+ .'|creatorName|String|A, B, C, and D|The name of the user who created the derived metric.|'."\n"
+ .'|modifierId|String|0123456|The ID of the user who last modified the derived metric.|'."\n"
+ .'|modifierName|String|A, B, C, and D|The name of the user who last modified the derived metric.|'."\n"
+ ."\n"
+ .'### FML statement used to query composite metrics'."\n"
+ ."\n"
+ .'show derivative composite indicators; Response parameters'."\n"
+ ."\n"
+ .'|Parameter|Type|Example|Description|'."\n"
+ .'|---|---|---|---|'."\n"
+ .'|businessUnitCode|String|project\\_code|The name of the workspace.|'."\n"
+ .'|businessProcessUuid|String|di-0002|The UUID of the business process.|'."\n"
+ .'|businessProcessCode|String|pay|The code of the business process.|'."\n"
+ .'|businessProcessName|String|Payment|The name of the business process.|'."\n"
+ .'|dataDomainUuid|String|di-0003|The UUID of the data domain.|'."\n"
+ .'|dataDomainCode|String|trd|The code of the data domain.|'."\n"
+ .'|dataDomainName|String|Transaction|The name of the data domain.|'."\n"
+ .'|categoryUuid|String|di-0001|The UUID of the business category.|'."\n"
+ .'|categoryCode|String|tb|The code of the business category.|'."\n"
+ .'|categoryName|String|Taobao|The name of the business category.|'."\n"
+ .'|type|String|DERIVATIVE\\_COMPOSITE|The computing logic. Valid values: DERIVATIVE\\_COMPOSITE and DERIVATIVE\\_COMPARISON. The value DERIVATIVE\\_COMPOSITE indicates a calculation expression. The value DERIVATIVE\\_COMPARISON indicates comparison.|'."\n"
+ .'|code|String|pay\\_amt|The abbreviation for the name of the composite metric.|'."\n"
+ .'|name|String|Payment amount|The display name of the composite metric.|'."\n"
+ .'|extendName|String|pay amount|The name of the composite metric.|'."\n"
+ .'|description|String|remark|The description of the composite metric.|'."\n"
+ .'|calculateExpression|String|{@pay\\_amt\\_1d\\[Last day\\_Payment amount\\]}/{@pay\\_amt\\_1m\\[Last 30 days\\_Payment amount\\]}|The calculation expression.|'."\n"
+ .'|comparisonPeriodType|String|DAY\\_MOM|The comparison type. Valid values: DAY\\_MOM, WEEK\\_MOM, WEEK\\_YOY, MONTH\\_MOM, MONTH\\_YOY, QUARTER\\_MOM, YEAR\\_MOM, and YEAR\\_YOY.|'."\n"
+ .'|comparisonIndicatorUuid|String|obj-123456|The UUID of the composite metric that is used for comparison.|'."\n"
+ .'|comparisonIndicatorCode|String|pay\\_amt\\_1d|The abbreviation for the name of the composite metric that is used for comparison.|'."\n"
+ .'|comparisonIndicatorName|String|Last day\\_Payment amount|The display name of the composite metric that is used for comparison.|'."\n"
+ .'|ownerId|String|0001|The ID of the owner of the composite metric.|'."\n"
+ .'|ownerName|String|Bob|The name of the owner of the composite metric.|'."\n"
+ .'|isDeleted|DeleteTagEnum|NO|Indicates whether the composite metric is deleted. Valid values: YES and NO.|'."\n"
+ .'|uuid|String|obj-123456|The UUID of the composite metric.|'."\n"
+ .'|gmtCreate|TimeStamp|1644397025000|The time when the composite metric was created.|'."\n"
+ .'|gmtModified|TimeStamp|1644459965000|The time when the composite metric was last modified.|'."\n"
+ .'|creatorId|String|0123456|The ID of the user who created the composite metric.|'."\n"
+ .'|creatorName|String|A, B, C, and D|The name of the user who created the composite metric.|'."\n"
+ .'|modifierId|String|0123456|The ID of the user who last modified the composite metric.|'."\n"
+ .'|modifierName|String|A, B, C, and D|The name of the user who last modified the composite metric.|'."\n"
+ ."\n"
+ .'### FML statement used to query information about the model on which a single metric depends'."\n"
+ ."\n"
+ .'show statistic indicator table\\_code; Response parameters'."\n"
+ ."\n"
+ .'|Parameter|Type|Example|Description|'."\n"
+ .'|---|---|---|---|'."\n"
+ .'|uuid|String|obj-123456|The UUID of the metric.|'."\n"
+ .'|code|String|pay\\_amt|The abbreviation for the name of the metric.|'."\n"
+ .'|name|String|Payment amount|The display name of the metric.|'."\n"
+ .'|extendName|String|pay amount|The name of the metric.|'."\n"
+ .'|relations|List|Example|The information about the model on which the metric depends. You can view the following code and table to obtain the structure of the EntityInfo parameter.|'."\n"
+ ."\n"
+ .'Sample structure and description of the EntityInfo parameter'."\n"
+ ."\n"
+ .'```'."\n"
+ .'['."\n"
+ .' {'."\n"
+ .' "uuid": "uuid",'."\n"
+ .' "code": "code",'."\n"
+ .' "name": "Display name",'."\n"
+ .' "extendName": "full name in English",'."\n"
+ .' "entityType": "EntityTypeEnum.BASE_DERIVATIVE_INDICATOR",'."\n"
+ .' "entityTypeName": "Entity type name",'."\n"
+ .' "entitySubType": "DERIVATIVE_INDICATOR",'."\n"
+ .' "entitySubTypeName": "Entity subtype name",'."\n"
+ .' "ownerId": "0001",'."\n"
+ .' "ownerName": "Owner name"'."\n"
+ .' }'."\n"
+ .']'."\n"
+ .'```'."\n"
+ ."\n"
+ .'|Parameter|Type|Example|Description|'."\n"
+ .'|---|---|---|---|'."\n"
+ .'|uuid|String|obj-123456|The UUID of the model.|'."\n"
+ .'|code|String|dws\\_001|The abbreviation for the name of the model.|'."\n"
+ .'|name|String|Payment aggregate table|The display name of the model.|'."\n"
+ .'|extendName|String|dws\\_001|The name of the model.|'."\n"
+ .'|entityType|EntityTypeEnum|Table|The entity type of the metric. The values of this parameter include but are not limited to `TABLE, BASE_ATOMIC_INDICATOR, and BASE_DERIVATIVE_INDICATOR`.|'."\n"
+ .'|entityTypeName|String|Table|The type name of the entity.|'."\n"
+ .'|entitySubType|String|DWS\\_TABLE|The subtype of the entity. The values of this parameter include but are not limited to `DWS_TABLE, ATOMIC_INDICATOR, and DERIVATIVE_INDICATOR`.|'."\n"
+ .'|entitySubTypeName|String|Aggregate table|The subtype name of the entity.|'."\n"
+ .'|ownerId|String|0001|The owner ID.|'."\n"
+ .'|ownerName|String|Bob|The name of the owner.|',
+ 'extraInfo' => ' ',
+ ],
+ 'GetAlertMessage' => [
+ 'summary' => 'Queries alert information based on the alert ID that is specified by the AlertId parameter.',
+ 'methods' => [
+ 'post',
+ ],
+ 'schemes' => [
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'get',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeCode' => '201154',
+ 'abilityTreeNodes' => [
+ 'FEATUREdideRJGWWC',
+ ],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'AlertId',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The alert ID. You can all the [ListAlertMessages](~~173961~~) operation to obtain the alert ID.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => '1421',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => 'Schema of Response',
+ 'description' => 'The response parameters.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'title' => 'Id of the request',
+ 'description' => 'The request ID.'."\n",
+ 'type' => 'string',
+ 'example' => '0000-ABCD-EFG****',
+ ],
+ 'HttpStatusCode' => [
+ 'description' => 'The HTTP status code.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '200',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message.'."\n",
+ 'type' => 'string',
+ 'example' => 'The specified parameters are invalid.',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code.'."\n",
+ 'type' => 'string',
+ 'example' => 'Invalid.Tenant.ConnectionNotExists',
+ ],
+ 'Success' => [
+ 'description' => 'Indicates whether the request was successful. Valid values:'."\n"
+ ."\n"
+ .'* true'."\n"
+ .'* false'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'Data' => [
+ 'description' => 'The information about returned alerts.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'RemindId' => [
+ 'description' => 'The ID of the custom alert rule that was triggered. This parameter is returned if the value of the Source parameter is REMIND_ALERT.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '1234',
+ ],
+ 'AlertMessageStatus' => [
+ 'description' => 'The sending status of the notification. Valid values:'."\n"
+ ."\n"
+ .'* READY_TO_SEND: The notification is waiting to be sent.'."\n"
+ .'* SEND_FAIL: The notification fails to be sent.'."\n"
+ .'* SEND_SUCCESS: The notification is sent.'."\n"
+ .'* SEND_OVERLIMIT: The number of notifications that are sent exceeds the upper limit.'."\n",
+ 'type' => 'string',
+ 'example' => 'READY_TO_SEND',
+ ],
+ 'AlertUser' => [
+ 'description' => 'The ID of the Alibaba Cloud account used by the alert recipient.'."\n",
+ 'type' => 'string',
+ 'example' => '9527952795****',
+ ],
+ 'AlertTime' => [
+ 'description' => 'The time when the alert was reported.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '1553524393000',
+ ],
+ 'AlertMethod' => [
+ 'description' => 'The notification method. Valid values:'."\n"
+ ."\n"
+ .'* MAIL.'."\n"
+ .'* SMS.'."\n"
+ .'* PHONE. Only DataWorks Professional Edition and more advanced editions support the PHONE notification method.'."\n",
+ 'type' => 'string',
+ 'example' => 'SMS',
+ ],
+ 'Source' => [
+ 'description' => 'The type of the alert. Valid values:'."\n"
+ ."\n"
+ .'* REMIND_ALERT: The alert is a custom alert.'."\n"
+ .'* TOPIC_ALERT: The alert is an event alert.'."\n"
+ .'* SLA_ALERT: The alert is a baseline alert.'."\n"
+ .'* NODE_CYCLE_ALERT: The alert is reported for a node dependency loop.'."\n"
+ .'* NODE_LONELY_ALERT: The alert is reported for isolated nodes.'."\n",
+ 'type' => 'string',
+ 'example' => 'REMIND_ALERT',
+ ],
+ 'Content' => [
+ 'description' => 'The content of the alert.'."\n",
+ 'type' => 'string',
+ 'example' => 'Node error',
+ ],
+ 'RemindName' => [
+ 'description' => 'The name of the custom alert rule that was triggered. This parameter is returned if the value of the Source parameter is REMIND_ALERT.'."\n",
+ 'type' => 'string',
+ 'example' => 'Custom monitoring rule name',
+ ],
+ 'AlertId' => [
+ 'description' => 'The alert ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '123',
+ ],
+ 'Instances' => [
+ 'description' => 'The instances that triggered the custom alert rule. This parameter is returned if the value of the Source parameter is REMIND_ALERT. This parameter is left empty if the value of the Source parameter is not REMIND_ALERT.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The information about the instance.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'Status' => [
+ 'description' => 'The status of the instance. Valid values:'."\n"
+ ."\n"
+ .'* NOT_RUN'."\n"
+ .'* WAIT_TIME'."\n"
+ .'* WAIT_RESOURCE'."\n"
+ .'* RUNNING'."\n"
+ .'* CHECKING'."\n"
+ .'* CHECKING_CONDITION'."\n"
+ .'* FAILURE'."\n"
+ .'* SUCCESS'."\n",
+ 'type' => 'string',
+ 'example' => 'NOT_RUN',
+ ],
+ 'InstanceId' => [
+ 'description' => 'The instance ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '12312312',
+ ],
+ 'NodeName' => [
+ 'description' => 'The name of the node.'."\n",
+ 'type' => 'string',
+ 'example' => 'Node name',
+ ],
+ 'NodeId' => [
+ 'description' => 'The node ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '1234',
+ ],
+ 'ProjectId' => [
+ 'description' => 'The ID of the workspace to which the node belongs.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '1234',
+ ],
+ ],
+ ],
+ ],
+ 'Topics' => [
+ 'description' => 'The events that triggered alerts. This parameter is returned if the value of the Source parameter is TOPIC_ALERT. This parameter is left empty if the value of the Source parameter is not TOPIC_ALERT.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The information about the event.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'TopicName' => [
+ 'description' => 'The name of the event.'."\n",
+ 'type' => 'string',
+ 'example' => 'error',
+ ],
+ 'InstanceId' => [
+ 'description' => 'The ID of the instance that triggered the event.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '12345',
+ ],
+ 'TopicId' => [
+ 'description' => 'The event ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '412431',
+ ],
+ 'TopicOwner' => [
+ 'description' => 'The ID of the Alibaba Cloud account used by the event owner.'."\n",
+ 'type' => 'string',
+ 'example' => '9527952795****',
+ ],
+ 'NodeId' => [
+ 'description' => 'The ID of the node that triggered the event.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '1234',
+ ],
+ 'TopicStatus' => [
+ 'description' => 'The status of the event. Valid values:'."\n"
+ ."\n"
+ .'* IGNORE'."\n"
+ .'* NEW'."\n"
+ .'* FIXING'."\n"
+ .'* RECOVER'."\n",
+ 'type' => 'string',
+ 'example' => 'FIXING',
+ ],
+ ],
+ ],
+ ],
+ 'Nodes' => [
+ 'description' => 'The nodes returned for different alert sources. The nodes that form a loop are returned if the value of the Source parameter is NODE_CYCLE_ALERT. The nodes that are isolated are returned if the value of the Source parameter is NODE_LONELY_ALERT.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The information about the node.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'Owner' => [
+ 'description' => 'The ID of the Alibaba Cloud account used by the node owner.'."\n",
+ 'type' => 'string',
+ 'example' => '95279527952****',
+ ],
+ 'NodeName' => [
+ 'description' => 'The name of the node.'."\n",
+ 'type' => 'string',
+ 'example' => 'Node name',
+ ],
+ 'NodeId' => [
+ 'description' => 'The node ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '1234',
+ ],
+ 'ProjectId' => [
+ 'description' => 'The ID of the workspace to which the node belongs.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '1234',
+ ],
+ ],
+ ],
+ ],
+ 'SlaAlert' => [
+ 'description' => 'The basic information about the baseline instance that triggered an alert. This parameter is returned if the value of the Source parameter is SLA_ALERT. This parameter is left empty if the value of the Source parameter is not SLA_ALERT.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'Status' => [
+ 'description' => 'The status of the baseline. Valid values:'."\n"
+ ."\n"
+ .'* ERROR'."\n"
+ .'* SAFE'."\n"
+ .'* DANGEROUS'."\n"
+ .'* OVER'."\n",
+ 'type' => 'string',
+ 'example' => 'SAFE',
+ ],
+ 'BaselineOwner' => [
+ 'description' => 'The ID of the Alibaba Cloud account used by the baseline owner. Multiple IDs are separated by commas (,).'."\n",
+ 'type' => 'string',
+ 'example' => '952795279****',
+ ],
+ 'BaselineId' => [
+ 'description' => 'The baseline ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '15142123',
+ ],
+ 'BaselineName' => [
+ 'description' => 'The name of the baseline.'."\n",
+ 'type' => 'string',
+ 'example' => 'Baseline name',
+ ],
+ 'Bizdate' => [
+ 'description' => 'The data timestamp of the baseline instance.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '1553443200000',
+ ],
+ 'ProjectId' => [
+ 'description' => 'The ID of the workspace to which the baseline belongs.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '1234',
+ ],
+ 'InGroupId' => [
+ 'description' => 'The ID of the cycle of the baseline instance. Valid values of the ID of an hour-level cycle: \\[1,24]. The ID of a day-level cycle is 1.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '1',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'staticInfo' => [
+ 'returnType' => 'synchronous',
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"0000-ABCD-EFG****\\",\\n \\"HttpStatusCode\\": 200,\\n \\"ErrorMessage\\": \\"The specified parameters are invalid.\\",\\n \\"ErrorCode\\": \\"Invalid.Tenant.ConnectionNotExists\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"RemindId\\": 1234,\\n \\"AlertMessageStatus\\": \\"READY_TO_SEND\\",\\n \\"AlertUser\\": \\"9527952795****\\",\\n \\"AlertTime\\": 1553524393000,\\n \\"AlertMethod\\": \\"SMS\\",\\n \\"Source\\": \\"REMIND_ALERT\\",\\n \\"Content\\": \\"Node error\\",\\n \\"RemindName\\": \\"Custom monitoring rule name\\",\\n \\"AlertId\\": 123,\\n \\"Instances\\": [\\n {\\n \\"Status\\": \\"NOT_RUN\\",\\n \\"InstanceId\\": 0,\\n \\"NodeName\\": \\"Node name\\",\\n \\"NodeId\\": 1234,\\n \\"ProjectId\\": 1234\\n }\\n ],\\n \\"Topics\\": [\\n {\\n \\"TopicName\\": \\"error\\",\\n \\"InstanceId\\": 12345,\\n \\"TopicId\\": 412431,\\n \\"TopicOwner\\": \\"9527952795****\\",\\n \\"NodeId\\": 1234,\\n \\"TopicStatus\\": \\"FIXING\\"\\n }\\n ],\\n \\"Nodes\\": [\\n {\\n \\"Owner\\": \\"95279527952****\\",\\n \\"NodeName\\": \\"Node name\\",\\n \\"NodeId\\": 1234,\\n \\"ProjectId\\": 1234\\n }\\n ],\\n \\"SlaAlert\\": {\\n \\"Status\\": \\"SAFE\\",\\n \\"BaselineOwner\\": \\"952795279****\\",\\n \\"BaselineId\\": 15142123,\\n \\"BaselineName\\": \\"Baseline name\\",\\n \\"Bizdate\\": 1553443200000,\\n \\"ProjectId\\": 1234,\\n \\"InGroupId\\": 1\\n }\\n }\\n}","errorExample":""},{"type":"xml","example":"<GetAlertMessageResponse>\\n <RequestId>0000-ABCD-EFG****</RequestId>\\n <HttpStatusCode>200</HttpStatusCode>\\n <ErrorMessage>The specified parameters are invalid.</ErrorMessage>\\n <ErrorCode>Invalid.Tenant.ConnectionNotExists</ErrorCode>\\n <Success>true</Success>\\n <Data>\\n <RemindId>1234</RemindId>\\n <AlertMessageStatus>READY_TO_SEND</AlertMessageStatus>\\n <AlertUser>9527952795****</AlertUser>\\n <AlertTime>1553524393000</AlertTime>\\n <AlertMethod>SMS</AlertMethod>\\n <Source>REMIND_ALERT</Source>\\n <Content>节点出错</Content>\\n <RemindName>自定义监控规则名称</RemindName>\\n <AlertId>123</AlertId>\\n <Instances>\\n <Status>NOT_RUN</Status>\\n <InstanceId>12312312</InstanceId>\\n <NodeName>节点名</NodeName>\\n <NodeId>1234</NodeId>\\n <ProjectId>1234</ProjectId>\\n </Instances>\\n <Topics>\\n <TopicName>9527出错</TopicName>\\n <InstanceId>12345</InstanceId>\\n <TopicId>412431</TopicId>\\n <TopicOwner>9527952795****</TopicOwner>\\n <NodeId>1234</NodeId>\\n <TopicStatus>FIXING</TopicStatus>\\n </Topics>\\n <Nodes>\\n <Owner>95279527952****</Owner>\\n <NodeName>节点名</NodeName>\\n <NodeId>1234</NodeId>\\n <ProjectId>1234</ProjectId>\\n </Nodes>\\n <SlaAlert>\\n <Status>SAFE</Status>\\n <BaselineOwner>952795279****</BaselineOwner>\\n <BaselineId>15142123</BaselineId>\\n <BaselineName>基线名</BaselineName>\\n <Bizdate>1553443200000</Bizdate>\\n <ProjectId>1234</ProjectId>\\n <InGroupId>1</InGroupId>\\n </SlaAlert>\\n </Data>\\n</GetAlertMessageResponse>","errorExample":""}]',
+ 'title' => 'GetAlertMessage',
+ ],
+ 'ListAlertMessages' => [
+ 'methods' => [
+ 'post',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'list',
+ 'abilityTreeCode' => '78294',
+ 'abilityTreeNodes' => [
+ 'FEATUREdideRJGWWC',
+ ],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'PageNumber',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The page number. Default value: 1. Minimum value: 1. Maximum value: 30.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => '1',
+ ],
+ ],
+ [
+ 'name' => 'PageSize',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The number of entries per page. Default value: 10. Maximum value: 100.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => '10',
+ ],
+ ],
+ [
+ 'name' => 'BeginTime',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The beginning of the time range to query. Specify the time in the ISO 8601 standard in the yyyy-MM-dd\'T\'HH:mm:ssZ format. The time must be in UTC.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => '2020-04-02T00:00:00+0800',
+ ],
+ ],
+ [
+ 'name' => 'EndTime',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The end of the time range to query. Specify the time in the ISO 8601 standard in the yyyy-MM-dd\'T\'HH:mm:ssZ format. The time must be in UTC.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => '2020-04-04T00:00:00+0800',
+ ],
+ ],
+ [
+ 'name' => 'RemindId',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The custom alert rule ID. This parameter takes effect if the AlertRuleTypes parameter is set to USER_DEFINE. You can configure either this parameter or the BaselineId parameter.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'docRequired' => false,
+ 'example' => '9527',
+ ],
+ ],
+ [
+ 'name' => 'AlertMethods',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The notification method. Valid values:'."\n"
+ ."\n"
+ .'* MAIL'."\n"
+ .'* SMS Alert notifications can be sent by text message only in the Singapore, Malaysia (Kuala Lumpur), and Germany (Frankfurt) regions.'."\n"
+ ."\n"
+ .'You can specify multiple notification methods. Separate them with commas (,).'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'SMS,MAIL,PHONE',
+ ],
+ ],
+ [
+ 'name' => 'AlertUser',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The ID of the Alibaba Cloud account used by the alert recipient.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => '123456',
+ ],
+ ],
+ [
+ 'name' => 'AlertRuleTypes',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The type of the alert rule. Valid values: GLOBAL, USER_DEFINE, and OTHER. The value GLOBAL indicates that the alert rule is a global alert rule. The value USER_DEFINE indicates that the alert rule is customized by a user. The value OTHER indicates that the alert rule is a rule of another type. You can specify multiple types. Separate them with commas (,).'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'GLOBAL,USER_DEFINE,OTHER',
+ ],
+ ],
+ [
+ 'name' => 'BaselineId',
+ 'in' => 'formData',
+ 'schema' => [
+ 'title' => '基线ID，当 alertRuleTypes 包含 GLOBAL 时生效，与 RemindId 互斥',
+ 'description' => 'The baseline ID. This parameter takes effect if the AlertRuleTypes parameter is set to GLOBAL. You can configure either this parameter or the RemindId parameter.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'example' => '1234',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'description' => 'The response parameters.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'HttpStatusCode' => [
+ 'description' => 'The HTTP status code.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '200',
+ ],
+ 'RequestId' => [
+ 'description' => 'The request ID.'."\n",
+ 'type' => 'string',
+ 'example' => '0000-ABCD-EFG****',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message.'."\n",
+ 'type' => 'string',
+ 'example' => 'The specified parameters are invalid.',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code.'."\n",
+ 'type' => 'string',
+ 'example' => 'Invalid.Tenant.ConnectionNotExists',
+ ],
+ 'Success' => [
+ 'description' => 'Indicates whether the request was successful.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'Data' => [
+ 'description' => 'The information about returned alerts.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'PageNumber' => [
+ 'description' => 'The page number.'."\n",
+ 'type' => 'string',
+ 'example' => '1',
+ ],
+ 'PageSize' => [
+ 'description' => 'The number of entries per page.'."\n",
+ 'type' => 'string',
+ 'example' => '10',
+ ],
+ 'TotalCount' => [
+ 'description' => 'The total number of alerts returned.'."\n",
+ 'type' => 'string',
+ 'example' => '100',
+ ],
+ 'AlertMessages' => [
+ 'description' => 'The alerts.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The returned data.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'RemindId' => [
+ 'description' => 'The ID of the custom alert rule that was triggered. This parameter is returned if the value of the Source parameter is REMIND_ALERT.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '1234',
+ ],
+ 'AlertMessageStatus' => [
+ 'description' => 'The sending status of the notification. Valid values: READY_TO_SEND, SEND_FAIL, SEND_SUCCESS, and SEND_OVERLIMIT. The value READY_TO_SEND indicates that the notification is waiting to be sent. The value SEND_FAIL indicates that the notification fails to be sent. The value SEND_SUCCESS indicates that the notification is sent. The value SEND_OVERLIMIT indicates that the number of notifications that are sent exceeds the upper limit.'."\n",
+ 'type' => 'string',
+ 'example' => 'READY_TO_SEND',
+ ],
+ 'AlertUser' => [
+ 'description' => 'The ID of the Alibaba Cloud used by the alert recipient.'."\n",
+ 'type' => 'string',
+ 'example' => '9527952795****',
+ ],
+ 'AlertTime' => [
+ 'description' => 'The timestamp when the alert was reported.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '1553531401000',
+ ],
+ 'AlertMethod' => [
+ 'description' => 'The notification method. Valid values: MAIL, SMS, and PHONE. Only DataWorks Professional Edition and more advanced editions support the PHONE notification method.'."\n",
+ 'type' => 'string',
+ 'example' => 'SMS',
+ ],
+ 'Source' => [
+ 'description' => 'The type of the alert. Valid values: REMIND_ALERT, TOPIC_ALERT, SLA_ALERT, NODE_CYCLE_ALERT, and NODE_LONELY_ALERT. The value REMIND_ALERT indicates that the alert is a custom alert. The value TOPIC_ALERT indicates that the alert is an event alert. The value SLA_ALERT indicates that the alert is a baseline alert. The value NODE_CYCLE_ALERT indicates that the alert is reported for a node dependency loop. The value NODE_LONELY_ALERT indicates that the alert is reported for isolated nodes.'."\n",
+ 'type' => 'string',
+ 'example' => 'REMIND_ALERT',
+ ],
+ 'Content' => [
+ 'description' => 'The content of the alert.'."\n",
+ 'type' => 'string',
+ 'example' => 'Node error',
+ ],
+ 'RemindName' => [
+ 'description' => 'The name of the custom alert rule that was triggered. This parameter is returned if the value of the Source parameter is REMIND_ALERT.'."\n",
+ 'type' => 'string',
+ 'example' => 'Custom monitoring rule name',
+ ],
+ 'AlertId' => [
+ 'description' => 'The alert ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '1234',
+ ],
+ 'Instances' => [
+ 'description' => 'The instances that triggered the custom alert rule. This parameter is returned if the value of the Source parameter is REMIND_ALERT. This parameter is left empty if the value of the Source parameter is not REMIND_ALERT.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The information about the instance.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'Status' => [
+ 'description' => 'The status of the instance. Valid values: NOT_RUN, WAIT_TIME, WAIT_RESOURCE, RUNNING, CHECKING, CHECKING_CONDITION, FAILURE, and SUCCESS. The value NOT_RUN indicates that the instance is not run. The value WAIT_TIME indicates that the instance is waiting to be run. The value WAIT_RESOURCE indicates that the instance is waiting for resources. The value RUNNING indicates that the instance is running. The value CHECKING indicates that data quality is being checked for the node for which the instance is generated. The value CHECKING_CONDITION indicates that branch conditions are being checked for the node for which the instance is generated. The value FAILURE indicates that the instance fails to run. The value SUCCESS indicates that the instance is successfully run.'."\n",
+ 'type' => 'string',
+ 'example' => 'NOT_RUN',
+ ],
+ 'InstanceId' => [
+ 'description' => 'The instance ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '12345',
+ ],
+ 'NodeName' => [
+ 'description' => 'The name of the node.'."\n",
+ 'type' => 'string',
+ 'example' => 'Node name',
+ ],
+ 'NodeId' => [
+ 'description' => 'The node ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '1234',
+ ],
+ 'ProjectId' => [
+ 'description' => 'The ID of the workspace to which the node belongs.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '1234',
+ ],
+ ],
+ ],
+ ],
+ 'Topics' => [
+ 'description' => 'The events that triggered alerts. This parameter is returned if the value of the Source parameter is TOPIC_ALERT. This parameter is left empty if the value of the Source parameter is not TOPIC_ALERT.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The information about the event.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'TopicName' => [
+ 'description' => 'The name of the event.'."\n",
+ 'type' => 'string',
+ 'example' => '9527 error',
+ ],
+ 'InstanceId' => [
+ 'description' => 'The ID of the instance that triggered the event.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '12345',
+ ],
+ 'TopicId' => [
+ 'description' => 'The event ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '1234',
+ ],
+ 'TopicOwner' => [
+ 'description' => 'The ID of the Alibaba Cloud account used by the event owner.'."\n",
+ 'type' => 'string',
+ 'example' => '9527952795****',
+ ],
+ 'NodeId' => [
+ 'description' => 'The ID of the node that triggered the event.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '1234',
+ ],
+ 'TopicStatus' => [
+ 'description' => 'The status of the event. Valid values: IGNORE, NEW, FIXING, and RECOVER. The value IGNORE indicates that the event is ignored. The value NEW indicates that the event is a new event. The value FIXING indicates that the event is being handled. The value RECOVER indicates that the event is handled.'."\n",
+ 'type' => 'string',
+ 'example' => 'FIXING',
+ ],
+ ],
+ ],
+ ],
+ 'Nodes' => [
+ 'description' => 'The nodes returned for different alert sources.'."\n"
+ ."\n"
+ .'* The nodes that form a loop are returned if the value of the Source parameter is NODE_CYCLE_ALERT.'."\n"
+ .'* The nodes that are isolated are returned if the value of the Source parameter is NODE_LONELY_ALERT.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The information about the node.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'Owner' => [
+ 'description' => 'The ID of the Alibaba Cloud account used by the node owner.'."\n",
+ 'type' => 'string',
+ 'example' => '95279527952****',
+ ],
+ 'NodeName' => [
+ 'description' => 'The name of the node.'."\n",
+ 'type' => 'string',
+ 'example' => 'Node name',
+ ],
+ 'NodeId' => [
+ 'description' => 'The node ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '1234',
+ ],
+ 'ProjectId' => [
+ 'description' => 'The ID of the workspace to which the node belongs.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '1234',
+ ],
+ ],
+ ],
+ ],
+ 'SlaAlert' => [
+ 'description' => 'The basic information about the baseline instance that triggered an alert. This parameter is returned if the value of the Source parameter is SLA_ALERT. This parameter is left empty if the value of the Source parameter is not SLA_ALERT.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'Status' => [
+ 'description' => 'The status of the baseline. Valid values: ERROR, SAFE, DANGEROUS, and OVER. The value ERROR indicates that no nodes are associated with the baseline, or all nodes associated with the baseline are suspended. The value SAFE indicates that nodes are run before the alert duration begins. The value DANGEROUS indicates that nodes are still running after the alert duration ends but the committed completion time does not arrive. The value OVER indicates that nodes are still running after the committed completion time.'."\n",
+ 'type' => 'string',
+ 'example' => 'SAFE',
+ ],
+ 'BaselineOwner' => [
+ 'description' => 'The ID of the Alibaba Cloud account used by the baseline owner. Multiple IDs are separated by commas (,).'."\n",
+ 'type' => 'string',
+ 'example' => '952795279****',
+ ],
+ 'BaselineId' => [
+ 'description' => 'The baseline ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '1234',
+ ],
+ 'BaselineName' => [
+ 'description' => 'The name of the baseline.'."\n",
+ 'type' => 'string',
+ 'example' => 'Baseline name',
+ ],
+ 'Bizdate' => [
+ 'description' => 'The data timestamp of the baseline instance.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '1553443200000',
+ ],
+ 'ProjectId' => [
+ 'description' => 'The ID of the workspace to which the baseline belongs.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '1234',
+ ],
+ 'InGroupId' => [
+ 'description' => 'The ID of the cycle of the baseline instance. Valid values of the ID of an hour-level cycle: \\[1,24]. The ID of a day-level cycle is 1.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '1',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'errorCodes' => [
+ 403 => [
+ [
+ 'errorCode' => 'Forbidden.Access',
+ 'errorMessage' => 'Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.',
+ ],
+ ],
+ 429 => [
+ [
+ 'errorCode' => 'Throttling.Api',
+ 'errorMessage' => 'The request for this resource has exceeded your available limit.',
+ ],
+ [
+ 'errorCode' => 'Throttling.Api.Risk',
+ 'errorMessage' => 'The request for this resource has exceeded your daily available limit.',
+ ],
+ [
+ 'errorCode' => 'Throttling.Resource',
+ 'errorMessage' => 'You have reached the limit for the resource. Please contact us by submitting a ticket.',
+ ],
+ [
+ 'errorCode' => 'Throttling.System',
+ 'errorMessage' => 'The DataWorks system is busy. Try again later.',
+ ],
+ [
+ 'errorCode' => 'Throttling.User',
+ 'errorMessage' => 'Your request is too frequent. Try again later.',
+ ],
+ ],
+ 500 => [
+ [
+ 'errorCode' => 'Forbidden.Not.Server',
+ 'errorMessage' => 'The dataworksAPI service is not available in this area. Please try it in another area.',
+ ],
+ [
+ 'errorCode' => 'InternalError.System',
+ 'errorMessage' => 'An internal system error occurred. Try again later.',
+ ],
+ [
+ 'errorCode' => 'InternalError.UserId.Missing',
+ 'errorMessage' => 'An internal system error occurred. Try again later.',
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"0000-ABCD-EFG****\\",\\n \\"ErrorMessage\\": \\"The specified parameters are invalid.\\",\\n \\"ErrorCode\\": \\"Invalid.Tenant.ConnectionNotExists\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"PageNumber\\": \\"1\\",\\n \\"PageSize\\": \\"10\\",\\n \\"TotalCount\\": \\"100\\",\\n \\"AlertMessages\\": [\\n {\\n \\"RemindId\\": 1234,\\n \\"AlertMessageStatus\\": \\"READY_TO_SEND\\",\\n \\"AlertUser\\": \\"9527952795****\\",\\n \\"AlertTime\\": 1553531401000,\\n \\"AlertMethod\\": \\"SMS\\",\\n \\"Source\\": \\"REMIND_ALERT\\",\\n \\"Content\\": \\"Node error\\",\\n \\"RemindName\\": \\"Custom monitoring rule name\\",\\n \\"AlertId\\": 1234,\\n \\"Instances\\": [\\n {\\n \\"Status\\": \\"NOT_RUN\\",\\n \\"InstanceId\\": 12345,\\n \\"NodeName\\": \\"Node name\\",\\n \\"NodeId\\": 1234,\\n \\"ProjectId\\": 1234\\n }\\n ],\\n \\"Topics\\": [\\n {\\n \\"TopicName\\": \\"9527 error\\",\\n \\"InstanceId\\": 12345,\\n \\"TopicId\\": 1234,\\n \\"TopicOwner\\": \\"9527952795****\\",\\n \\"NodeId\\": 1234,\\n \\"TopicStatus\\": \\"FIXING\\"\\n }\\n ],\\n \\"Nodes\\": [\\n {\\n \\"Owner\\": \\"95279527952****\\",\\n \\"NodeName\\": \\"Node name\\",\\n \\"NodeId\\": 1234,\\n \\"ProjectId\\": 1234\\n }\\n ],\\n \\"SlaAlert\\": {\\n \\"Status\\": \\"SAFE\\",\\n \\"BaselineOwner\\": \\"952795279****\\",\\n \\"BaselineId\\": 1234,\\n \\"BaselineName\\": \\"Baseline name\\",\\n \\"Bizdate\\": 1553443200000,\\n \\"ProjectId\\": 1234,\\n \\"InGroupId\\": 1\\n }\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<ListAlertMessagesResponse>\\n <HttpStatusCode>200</HttpStatusCode>\\n <RequestId>0000-ABCD-EFG****</RequestId>\\n <ErrorMessage>The specified parameters are invalid.</ErrorMessage>\\n <ErrorCode>Invalid.Tenant.ConnectionNotExists</ErrorCode>\\n <Success>true</Success>\\n <Data>\\n <PageNumber>1</PageNumber>\\n <PageSize>10</PageSize>\\n <TotalCount>100</TotalCount>\\n <AlertMessages>\\n <RemindId>1234</RemindId>\\n <AlertMessageStatus>READY_TO_SEND</AlertMessageStatus>\\n <AlertUser>9527952795****</AlertUser>\\n <AlertTime>1553531401000</AlertTime>\\n <AlertMethod>SMS</AlertMethod>\\n <Source>REMIND_ALERT</Source>\\n <Content>节点出错</Content>\\n <RemindName>自定义监控规则名称</RemindName>\\n <AlertId>1234</AlertId>\\n <Instances>\\n <Status>NOT_RUN</Status>\\n <InstanceId>12345</InstanceId>\\n <NodeName>节点名称</NodeName>\\n <NodeId>1234</NodeId>\\n <ProjectId>1234</ProjectId>\\n </Instances>\\n <Topics>\\n <TopicName>9527出错</TopicName>\\n <InstanceId>12345</InstanceId>\\n <TopicId>1234</TopicId>\\n <TopicOwner>9527952795****</TopicOwner>\\n <NodeId>1234</NodeId>\\n <TopicStatus>FIXING</TopicStatus>\\n </Topics>\\n <Nodes>\\n <Owner>95279527952****</Owner>\\n <NodeName>节点名称</NodeName>\\n <NodeId>1234</NodeId>\\n <ProjectId>1234</ProjectId>\\n </Nodes>\\n <SlaAlert>\\n <Status>SAFE</Status>\\n <BaselineOwner>952795279****</BaselineOwner>\\n <BaselineId>1234</BaselineId>\\n <BaselineName>基线名称</BaselineName>\\n <Bizdate>1553443200000</Bizdate>\\n <ProjectId>1234</ProjectId>\\n <InGroupId>1</InGroupId>\\n </SlaAlert>\\n </AlertMessages>\\n </Data>\\n</ListAlertMessagesResponse>","errorExample":""}]',
+ 'title' => 'ListAlertMessages',
+ 'summary' => 'Queries a list of alerts.',
+ 'requestParamsDescription' => ' ',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ ],
+ 'GetBaselineConfig' => [
+ 'methods' => [
+ 'post',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'get',
+ 'abilityTreeCode' => '78229',
+ 'abilityTreeNodes' => [
+ 'FEATUREdideSFSFU4',
+ ],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'BaselineId',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The baseline ID. You can call the [GetNode](~~173977~~) operation to query the baseline ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => '1234',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'headers' => [],
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'HttpStatusCode' => [
+ 'description' => 'The HTTP status code.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '401',
+ ],
+ 'RequestId' => [
+ 'description' => 'The request ID.'."\n",
+ 'type' => 'string',
+ 'example' => 'ecb967ec-c137-48a5-860****',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message.'."\n",
+ 'type' => 'string',
+ 'example' => 'The specified parameters are invalid.',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code.'."\n",
+ 'type' => 'string',
+ 'example' => '1031203110005',
+ ],
+ 'Success' => [
+ 'description' => 'Indicates whether the request was successful.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'Data' => [
+ 'description' => 'The details of the baseline.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'HourSlaDetail' => [
+ 'description' => 'The committed completion time of the hour-level baseline. This parameter is presented as key-value pairs in the JSON format. The key indicates the ID of the cycle, and the value is presented in the hh:mm format. Valid values of hh: \\[0,47]. Valid values of mm: \\[0,59].'."\n",
+ 'type' => 'string',
+ 'example' => '{"1":"03:58","2":"04:58","3":"05:58","4":"06:58","5":"07:58","6":"08:58","7":"09:58","8":"10:58","9":"11:58","10":"12:58","11":"13:58","12":"14:58","13":"15:58","14":"16:58","15":"17:58","16":"18:58","17":"19:58","18":"20:58","19":"21:58","20":"22:58","21":"23:58","22":"24:58","23":"25:58","24":"26:58"}',
+ ],
+ 'IsDefault' => [
+ 'description' => 'Indicates whether the baseline is a default baseline of the workspace. Valid values: true and false.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'Owner' => [
+ 'description' => 'The ID of the Alibaba Cloud account used by the baseline owner. Multiple IDs can be specified. The IDs are separated by commas (,).'."\n",
+ 'type' => 'string',
+ 'example' => '9527952****',
+ ],
+ 'ProjectId' => [
+ 'description' => 'The ID of the workspace.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '1234',
+ ],
+ 'Priority' => [
+ 'description' => 'The priority of the baseline. Valid values: {1,3,5,7,8}.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '1',
+ ],
+ 'SlaMinu' => [
+ 'description' => 'The minute in the committed completion time of the day-level baseline. Valid values: \\[0, 59].'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '30',
+ ],
+ 'SlaHour' => [
+ 'description' => 'The hour in the committed completion time of the day-level baseline. Valid values: \\[0, 47].'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '9',
+ ],
+ 'BaselineId' => [
+ 'description' => 'The baseline ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '1234',
+ ],
+ 'BaselineName' => [
+ 'description' => 'The name of the baseline.'."\n",
+ 'type' => 'string',
+ 'example' => 'Baseline name'."\n",
+ ],
+ 'HourExpDetail' => [
+ 'description' => 'The alerting time of the hour-level baseline. This parameter is presented as key-value pairs in the JSON format. The key indicates the ID of the cycle, and the value is presented in the hh:mm format. Valid values of hh: \\[0,47]. Valid values of mm: \\[0,59].'."\n",
+ 'type' => 'string',
+ 'example' => '{"1":"03:28","2":"04:28","3":"05:28","4":"06:28","5":"07:28","6":"08:28","7":"09:28","8":"10:28","9":"11:28","10":"12:28","11":"13:28","12":"14:28","13":"15:28","14":"16:28","15":"17:28","16":"18:28","17":"19:28","18":"20:28","19":"21:28","20":"22:28","21":"23:28","22":"24:28","23":"25:28","24":"26:28"}',
+ ],
+ 'UseFlag' => [
+ 'description' => 'Indicates whether the baseline is enabled. Valid values: true and false.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'ExpHour' => [
+ 'description' => 'The hour in the alerting time of the day-level baseline. Valid values: \\[0, 47].'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '7',
+ ],
+ 'BaselineType' => [
+ 'description' => 'The type of the baseline. Valid values: DAILY and HOURLY.'."\n",
+ 'type' => 'string',
+ 'example' => 'DAILY',
+ ],
+ 'ExpMinu' => [
+ 'description' => 'The minute in the alerting time of the day-level baseline. Valid values: \\[0, 59].'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '30',
+ ],
+ ],
+ ],
+ ],
+ 'description' => '',
+ ],
+ ],
+ ],
+ 'errorCodes' => [
+ 403 => [
+ [
+ 'errorCode' => 'Forbidden.Access',
+ 'errorMessage' => 'Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.',
+ ],
+ ],
+ 429 => [
+ [
+ 'errorCode' => 'Throttling.Api',
+ 'errorMessage' => 'The request for this resource has exceeded your available limit.',
+ ],
+ [
+ 'errorCode' => 'Throttling.Api.Risk',
+ 'errorMessage' => 'The request for this resource has exceeded your daily available limit.',
+ ],
+ [
+ 'errorCode' => 'Throttling.System',
+ 'errorMessage' => 'The DataWorks system is busy. Try again later.',
+ ],
+ [
+ 'errorCode' => 'Throttling.User',
+ 'errorMessage' => 'Your request is too frequent. Try again later.',
+ ],
+ ],
+ 500 => [
+ [
+ 'errorCode' => 'Forbidden.Not.Server',
+ 'errorMessage' => 'The dataworksAPI service is not available in this area. Please try it in another area.',
+ ],
+ [
+ 'errorCode' => 'Forbidden.Wkbench.BaselineNoPermission',
+ 'errorMessage' => 'You are not authorized to access the baseline.',
+ ],
+ [
+ 'errorCode' => 'InternalError.System',
+ 'errorMessage' => 'An internal system error occurred. Try again later.',
+ ],
+ [
+ 'errorCode' => 'InternalError.UserId.Missing',
+ 'errorMessage' => 'An internal system error occurred. Try again later.',
+ ],
+ [
+ 'errorCode' => 'InternalError.Wkbench.ServiceError',
+ 'errorMessage' => 'An internal error occurred.',
+ ],
+ [
+ 'errorCode' => 'Invalid.Wkbench.Parameter',
+ 'errorMessage' => 'The specified parameters are invalid.',
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 401,\\n \\"RequestId\\": \\"ecb967ec-c137-48a5-860****\\",\\n \\"ErrorMessage\\": \\"The specified parameters are invalid.\\",\\n \\"ErrorCode\\": \\"1031203110005\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"HourSlaDetail\\": \\"{\\\\\\"1\\\\\\":\\\\\\"03:58\\\\\\",\\\\\\"2\\\\\\":\\\\\\"04:58\\\\\\",\\\\\\"3\\\\\\":\\\\\\"05:58\\\\\\",\\\\\\"4\\\\\\":\\\\\\"06:58\\\\\\",\\\\\\"5\\\\\\":\\\\\\"07:58\\\\\\",\\\\\\"6\\\\\\":\\\\\\"08:58\\\\\\",\\\\\\"7\\\\\\":\\\\\\"09:58\\\\\\",\\\\\\"8\\\\\\":\\\\\\"10:58\\\\\\",\\\\\\"9\\\\\\":\\\\\\"11:58\\\\\\",\\\\\\"10\\\\\\":\\\\\\"12:58\\\\\\",\\\\\\"11\\\\\\":\\\\\\"13:58\\\\\\",\\\\\\"12\\\\\\":\\\\\\"14:58\\\\\\",\\\\\\"13\\\\\\":\\\\\\"15:58\\\\\\",\\\\\\"14\\\\\\":\\\\\\"16:58\\\\\\",\\\\\\"15\\\\\\":\\\\\\"17:58\\\\\\",\\\\\\"16\\\\\\":\\\\\\"18:58\\\\\\",\\\\\\"17\\\\\\":\\\\\\"19:58\\\\\\",\\\\\\"18\\\\\\":\\\\\\"20:58\\\\\\",\\\\\\"19\\\\\\":\\\\\\"21:58\\\\\\",\\\\\\"20\\\\\\":\\\\\\"22:58\\\\\\",\\\\\\"21\\\\\\":\\\\\\"23:58\\\\\\",\\\\\\"22\\\\\\":\\\\\\"24:58\\\\\\",\\\\\\"23\\\\\\":\\\\\\"25:58\\\\\\",\\\\\\"24\\\\\\":\\\\\\"26:58\\\\\\"}\\",\\n \\"IsDefault\\": true,\\n \\"Owner\\": \\"9527952****\\",\\n \\"ProjectId\\": 123456,\\n \\"Priority\\": 1,\\n \\"SlaMinu\\": 30,\\n \\"SlaHour\\": 9,\\n \\"BaselineId\\": 1234,\\n \\"BaselineName\\": \\"Baseline name\\\\n\\",\\n \\"HourExpDetail\\": \\"{\\\\\\"1\\\\\\":\\\\\\"03:28\\\\\\",\\\\\\"2\\\\\\":\\\\\\"04:28\\\\\\",\\\\\\"3\\\\\\":\\\\\\"05:28\\\\\\",\\\\\\"4\\\\\\":\\\\\\"06:28\\\\\\",\\\\\\"5\\\\\\":\\\\\\"07:28\\\\\\",\\\\\\"6\\\\\\":\\\\\\"08:28\\\\\\",\\\\\\"7\\\\\\":\\\\\\"09:28\\\\\\",\\\\\\"8\\\\\\":\\\\\\"10:28\\\\\\",\\\\\\"9\\\\\\":\\\\\\"11:28\\\\\\",\\\\\\"10\\\\\\":\\\\\\"12:28\\\\\\",\\\\\\"11\\\\\\":\\\\\\"13:28\\\\\\",\\\\\\"12\\\\\\":\\\\\\"14:28\\\\\\",\\\\\\"13\\\\\\":\\\\\\"15:28\\\\\\",\\\\\\"14\\\\\\":\\\\\\"16:28\\\\\\",\\\\\\"15\\\\\\":\\\\\\"17:28\\\\\\",\\\\\\"16\\\\\\":\\\\\\"18:28\\\\\\",\\\\\\"17\\\\\\":\\\\\\"19:28\\\\\\",\\\\\\"18\\\\\\":\\\\\\"20:28\\\\\\",\\\\\\"19\\\\\\":\\\\\\"21:28\\\\\\",\\\\\\"20\\\\\\":\\\\\\"22:28\\\\\\",\\\\\\"21\\\\\\":\\\\\\"23:28\\\\\\",\\\\\\"22\\\\\\":\\\\\\"24:28\\\\\\",\\\\\\"23\\\\\\":\\\\\\"25:28\\\\\\",\\\\\\"24\\\\\\":\\\\\\"26:28\\\\\\"}\\",\\n \\"UseFlag\\": true,\\n \\"ExpHour\\": 7,\\n \\"BaselineType\\": \\"DAILY\\",\\n \\"ExpMinu\\": 30\\n }\\n}","errorExample":""},{"type":"xml","example":"<GetBaselineConfigResponse>\\n <HttpStatusCode>401</HttpStatusCode>\\n <RequestId>ecb967ec-c137-48a5-860****</RequestId>\\n <ErrorMessage>The specified parameters are invalid.</ErrorMessage>\\n <ErrorCode>1031203110005</ErrorCode>\\n <Success>true</Success>\\n <Data>\\n <HourSlaDetail>{\\"1\\":\\"03:58\\",\\"2\\":\\"04:58\\",\\"3\\":\\"05:58\\",\\"4\\":\\"06:58\\",\\"5\\":\\"07:58\\",\\"6\\":\\"08:58\\",\\"7\\":\\"09:58\\",\\"8\\":\\"10:58\\",\\"9\\":\\"11:58\\",\\"10\\":\\"12:58\\",\\"11\\":\\"13:58\\",\\"12\\":\\"14:58\\",\\"13\\":\\"15:58\\",\\"14\\":\\"16:58\\",\\"15\\":\\"17:58\\",\\"16\\":\\"18:58\\",\\"17\\":\\"19:58\\",\\"18\\":\\"20:58\\",\\"19\\":\\"21:58\\",\\"20\\":\\"22:58\\",\\"21\\":\\"23:58\\",\\"22\\":\\"24:58\\",\\"23\\":\\"25:58\\",\\"24\\":\\"26:58\\"}</HourSlaDetail>\\n <IsDefault>true</IsDefault>\\n <Owner>9527952****</Owner>\\n <ProjectId>1234</ProjectId>\\n <Priority>1</Priority>\\n <SlaMinu>30</SlaMinu>\\n <SlaHour>9</SlaHour>\\n <BaselineId>1234</BaselineId>\\n <BaselineName>基线名称</BaselineName>\\n <HourExpDetail>{\\"1\\":\\"03:28\\",\\"2\\":\\"04:28\\",\\"3\\":\\"05:28\\",\\"4\\":\\"06:28\\",\\"5\\":\\"07:28\\",\\"6\\":\\"08:28\\",\\"7\\":\\"09:28\\",\\"8\\":\\"10:28\\",\\"9\\":\\"11:28\\",\\"10\\":\\"12:28\\",\\"11\\":\\"13:28\\",\\"12\\":\\"14:28\\",\\"13\\":\\"15:28\\",\\"14\\":\\"16:28\\",\\"15\\":\\"17:28\\",\\"16\\":\\"18:28\\",\\"17\\":\\"19:28\\",\\"18\\":\\"20:28\\",\\"19\\":\\"21:28\\",\\"20\\":\\"22:28\\",\\"21\\":\\"23:28\\",\\"22\\":\\"24:28\\",\\"23\\":\\"25:28\\",\\"24\\":\\"26:28\\"}</HourExpDetail>\\n <UseFlag>true</UseFlag>\\n <ExpHour>7</ExpHour>\\n <BaselineType>DAILY</BaselineType>\\n <ExpMinu>30</ExpMinu>\\n </Data>\\n</GetBaselineConfigResponse>","errorExample":""}]',
+ 'title' => 'GetBaselineConfig',
+ 'summary' => 'Queries the configurations of a baseline.',
+ 'requestParamsDescription' => ' ',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ ],
+ 'ListNodesByBaseline' => [
+ 'methods' => [
+ 'post',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'list',
+ 'abilityTreeCode' => '78321',
+ 'abilityTreeNodes' => [
+ 'FEATUREdideSFSFU4',
+ ],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'BaselineId',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The baseline ID. You can call the [ListBaselineConfigs](~~173964~~) operation to query the baseline ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => '1234',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'HttpStatusCode' => [
+ 'description' => 'The HTTP status code.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '200',
+ ],
+ 'RequestId' => [
+ 'description' => 'The request ID. You can use the ID to troubleshoot issues.'."\n",
+ 'type' => 'string',
+ 'example' => '0000-ABCD-E****',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message.'."\n",
+ 'type' => 'string',
+ 'example' => 'The specified parameters are invalid.',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code.'."\n",
+ 'type' => 'string',
+ 'example' => '1031203110005',
+ ],
+ 'Success' => [
+ 'description' => 'Indicates whether the request was successful.'."\n",
+ 'type' => 'string',
+ 'example' => 'true',
+ ],
+ 'Data' => [
+ 'description' => 'The nodes in the baseline.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'Owner' => [
+ 'description' => 'The ID of the Alibaba Cloud account used by the node owner.'."\n",
+ 'type' => 'string',
+ 'example' => '9527952****',
+ ],
+ 'NodeName' => [
+ 'description' => 'The name of the node.'."\n",
+ 'type' => 'string',
+ 'example' => 'Node name',
+ ],
+ 'NodeId' => [
+ 'description' => 'The node ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '1234',
+ ],
+ 'ProjectId' => [
+ 'description' => 'The ID of the workspace to which the node belongs.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '1234',
+ ],
+ ],
+ 'description' => '',
+ ],
+ ],
+ ],
+ 'description' => '',
+ ],
+ ],
+ ],
+ 'errorCodes' => [
+ 403 => [
+ [
+ 'errorCode' => 'Forbidden.Access',
+ 'errorMessage' => 'Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.',
+ ],
+ ],
+ 429 => [
+ [
+ 'errorCode' => 'Throttling.Api',
+ 'errorMessage' => 'The request for this resource has exceeded your available limit.',
+ ],
+ [
+ 'errorCode' => 'Throttling.Api.Risk',
+ 'errorMessage' => 'The request for this resource has exceeded your daily available limit.',
+ ],
+ [
+ 'errorCode' => 'Throttling.Resource',
+ 'errorMessage' => 'You have reached the limit for the resource. Please contact us by submitting a ticket.',
+ ],
+ [
+ 'errorCode' => 'Throttling.System',
+ 'errorMessage' => 'The DataWorks system is busy. Try again later.',
+ ],
+ [
+ 'errorCode' => 'Throttling.User',
+ 'errorMessage' => 'Your request is too frequent. Try again later.',
+ ],
+ ],
+ 500 => [
+ [
+ 'errorCode' => 'Forbidden.Not.Server',
+ 'errorMessage' => 'The dataworksAPI service is not available in this area. Please try it in another area.',
+ ],
+ [
+ 'errorCode' => 'Forbidden.Wkbench.BaselineNoPermission',
+ 'errorMessage' => 'You are not authorized to access the baseline.',
+ ],
+ [
+ 'errorCode' => 'Forbidden.Wkbench.ProjectNoPermission',
+ 'errorMessage' => 'You are not authorized to access the workspace.',
+ ],
+ [
+ 'errorCode' => 'InternalError.System',
+ 'errorMessage' => 'An internal system error occurred. Try again later.',
+ ],
+ [
+ 'errorCode' => 'InternalError.UserId.Missing',
+ 'errorMessage' => 'An internal system error occurred. Try again later.',
+ ],
+ [
+ 'errorCode' => 'InternalError.Wkbench.ServiceError',
+ 'errorMessage' => 'An internal error occurred.',
+ ],
+ [
+ 'errorCode' => 'Invalid.Wkbench.Parameter',
+ 'errorMessage' => 'The specified parameters are invalid.',
+ ],
+ [
+ 'errorCode' => 'Invalid.Wkbench.BaselineNotExist',
+ 'errorMessage' => 'The baseline does not exist.',
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"0000-ABCD-E****\\",\\n \\"ErrorMessage\\": \\"The specified parameters are invalid.\\",\\n \\"ErrorCode\\": \\"1031203110005\\",\\n \\"Success\\": \\"true\\",\\n \\"Data\\": [\\n {\\n \\"Owner\\": \\"9527952****\\",\\n \\"NodeName\\": \\"Node name\\",\\n \\"NodeId\\": 12345,\\n \\"ProjectId\\": 12345\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<ListNodesByBaselineResponse>\\n <HttpStatusCode>200</HttpStatusCode>\\n <RequestId>0000-ABCD-E****</RequestId>\\n <ErrorMessage>The specified parameters are invalid.</ErrorMessage>\\n <ErrorCode>1031203110005</ErrorCode>\\n <Success>true</Success>\\n <Data>\\n <Owner>9527952****</Owner>\\n <NodeName>节点名称</NodeName>\\n <NodeId>1234</NodeId>\\n <ProjectId>1234</ProjectId>\\n </Data>\\n</ListNodesByBaselineResponse>","errorExample":""}]',
+ 'title' => 'ListNodesByBaseline',
+ 'summary' => 'Queries nodes in a baseline.',
+ 'requestParamsDescription' => ' ',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ ],
+ 'ListBaselineConfigs' => [
+ 'methods' => [
+ 'post',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'list',
+ 'abilityTreeCode' => '78295',
+ 'abilityTreeNodes' => [
+ 'FEATUREdideSFSFU4',
+ ],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'PageNumber',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The page number. Valid values: 1 to 30. Default value: 1.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => '1',
+ ],
+ ],
+ [
+ 'name' => 'PageSize',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The number of entries per page. Valid values: 1 to 100. Default value: 10.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => '10',
+ ],
+ ],
+ [
+ 'name' => 'Owner',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The ID of the Alibaba Cloud account used by the baseline owner.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => '95279527****',
+ ],
+ ],
+ [
+ 'name' => 'ProjectId',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The workspace ID. You can call the ListProjects operation to query the ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => '1234',
+ ],
+ ],
+ [
+ 'name' => 'Priority',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The priority of the baseline. Valid values: {1,3,5,7,8}. Separate multiple priorities with commas (,).'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => '1,3,5,7,8',
+ ],
+ ],
+ [
+ 'name' => 'Useflag',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'Specifies whether to enable the baseline. Valid values: true and false.'."\n",
+ 'type' => 'boolean',
+ 'required' => false,
+ 'example' => 'true',
+ ],
+ ],
+ [
+ 'name' => 'BaselineTypes',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The type of the baseline. Valid values: DAILY and HOURLY. Separate multiple baseline types with commas (,).'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'DAILY,HOURLY',
+ ],
+ ],
+ [
+ 'name' => 'SearchText',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The keyword in the baseline name, which is used to search for the baseline.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'Baseline name search keywords',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'headers' => [],
+ 'schema' => [
+ 'description' => 'The response parameters.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'HttpStatusCode' => [
+ 'description' => 'The HTTP status code.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '200',
+ ],
+ 'RequestId' => [
+ 'description' => 'The request ID.'."\n",
+ 'type' => 'string',
+ 'example' => '0000-ABCD-EFG****',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message.'."\n",
+ 'type' => 'string',
+ 'example' => 'The specified parameters are invalid.',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code.'."\n",
+ 'type' => 'string',
+ 'example' => '1031203110005',
+ ],
+ 'Success' => [
+ 'description' => 'Indicates whether the request was successful.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'Data' => [
+ 'description' => 'The returned data.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'PageNumber' => [
+ 'description' => 'The page number.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '1',
+ ],
+ 'PageSize' => [
+ 'description' => 'The number of entries per page.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '10',
+ ],
+ 'TotalCount' => [
+ 'description' => 'The total number of baselines returned.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '100',
+ ],
+ 'Baselines' => [
+ 'description' => 'The baselines.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The returned result.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'HourSlaDetail' => [
+ 'description' => 'The committed completion time of the hour-level baseline. This parameter is presented as key-value pairs in the JSON format. The key indicates the ID of the cycle, and the value is presented in the hh:mm format. Valid values of hh: \\[0,47]. Valid values of mm: \\[0,59].'."\n",
+ 'type' => 'string',
+ 'example' => '{"1":"03:58","2":"04:58","3":"05:58","4":"06:58","5":"07:58","6":"08:58","7":"09:58","8":"10:58","9":"11:58","10":"12:58","11":"13:58","12":"14:58","13":"15:58","14":"16:58","15":"17:58","16":"18:58","17":"19:58","18":"20:58","19":"21:58","20":"22:58","21":"23:58","22":"24:58","23":"25:58","24":"26:58"}',
+ ],
+ 'IsDefault' => [
+ 'description' => 'Indicates whether the baseline is a default baseline of the workspace. Valid values: true and false.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'Owner' => [
+ 'description' => 'The ID of the Alibaba Cloud account used by the baseline owner. Multiple IDs can be specified. The IDs are separated by commas (,).'."\n",
+ 'type' => 'string',
+ 'example' => '952795****',
+ ],
+ 'ProjectId' => [
+ 'description' => 'The ID of the workspace to which the baseline belongs.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '9527',
+ ],
+ 'Priority' => [
+ 'description' => 'The priority of the baseline. Valid values: {1,3,5,7,8}.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '1',
+ ],
+ 'SlaMinu' => [
+ 'description' => 'The minute in the alerting time of the day-level baseline. Valid values: \\[0, 59].'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '30',
+ ],
+ 'SlaHour' => [
+ 'description' => 'The hour in the committed completion time of the day-level baseline. Valid values: \\[0, 47].'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '9',
+ ],
+ 'BaselineId' => [
+ 'description' => 'The baseline ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '1234',
+ ],
+ 'BaselineName' => [
+ 'description' => 'The name of the baseline.'."\n",
+ 'type' => 'string',
+ 'example' => 'Baseline name',
+ ],
+ 'HourExpDetail' => [
+ 'description' => 'The alerting time of the hour-level baseline. This parameter is presented as key-value pairs in the JSON format. The key indicates the ID of the cycle, and the value is presented in the hh:mm format. Valid values of hh: \\[0,47]. Valid values of mm: \\[0,59].'."\n",
+ 'type' => 'string',
+ 'example' => '{"1":"03:28","2":"04:28","3":"05:28","4":"06:28","5":"07:28","6":"08:28","7":"09:28","8":"10:28","9":"11:28","10":"12:28","11":"13:28","12":"14:28","13":"15:28","14":"16:28","15":"17:28","16":"18:28","17":"19:28","18":"20:28","19":"21:28","20":"22:28","21":"23:28","22":"24:28","23":"25:28","24":"26:28"}',
+ ],
+ 'UseFlag' => [
+ 'description' => 'Indicates whether the baseline is enabled. Valid values: true and false.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'ExpHour' => [
+ 'description' => 'The hour in the alerting time of the day-level baseline. Valid values: \\[0, 47].'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '7',
+ ],
+ 'BaselineType' => [
+ 'description' => 'The type of the baseline. Valid values: DAILY and HOURLY.'."\n",
+ 'type' => 'string',
+ 'example' => 'DAILY',
+ ],
+ 'ExpMinu' => [
+ 'description' => 'The minute in the alerting time of the day-level baseline. Valid values: \\[0, 59].'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '30',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'errorCodes' => [
+ 403 => [
+ [
+ 'errorCode' => 'Forbidden.Access',
+ 'errorMessage' => 'Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.',
+ ],
+ ],
+ 429 => [
+ [
+ 'errorCode' => 'Throttling.Api',
+ 'errorMessage' => 'The request for this resource has exceeded your available limit.',
+ ],
+ [
+ 'errorCode' => 'Throttling.Api.Risk',
+ 'errorMessage' => 'The request for this resource has exceeded your daily available limit.',
+ ],
+ [
+ 'errorCode' => 'Throttling.System',
+ 'errorMessage' => 'The DataWorks system is busy. Try again later.',
+ ],
+ [
+ 'errorCode' => 'Throttling.User',
+ 'errorMessage' => 'Your request is too frequent. Try again later.',
+ ],
+ ],
+ 500 => [
+ [
+ 'errorCode' => 'Forbidden.Not.Server',
+ 'errorMessage' => 'The dataworksAPI service is not available in this area. Please try it in another area.',
+ ],
+ [
+ 'errorCode' => 'InternalError.System',
+ 'errorMessage' => 'An internal system error occurred. Try again later.',
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"0000-ABCD-EFG****\\",\\n \\"ErrorMessage\\": \\"The specified parameters are invalid.\\",\\n \\"ErrorCode\\": \\"1031203110005\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 100,\\n \\"Baselines\\": [\\n {\\n \\"HourSlaDetail\\": \\"{\\\\\\"1\\\\\\":\\\\\\"03:58\\\\\\",\\\\\\"2\\\\\\":\\\\\\"04:58\\\\\\",\\\\\\"3\\\\\\":\\\\\\"05:58\\\\\\",\\\\\\"4\\\\\\":\\\\\\"06:58\\\\\\",\\\\\\"5\\\\\\":\\\\\\"07:58\\\\\\",\\\\\\"6\\\\\\":\\\\\\"08:58\\\\\\",\\\\\\"7\\\\\\":\\\\\\"09:58\\\\\\",\\\\\\"8\\\\\\":\\\\\\"10:58\\\\\\",\\\\\\"9\\\\\\":\\\\\\"11:58\\\\\\",\\\\\\"10\\\\\\":\\\\\\"12:58\\\\\\",\\\\\\"11\\\\\\":\\\\\\"13:58\\\\\\",\\\\\\"12\\\\\\":\\\\\\"14:58\\\\\\",\\\\\\"13\\\\\\":\\\\\\"15:58\\\\\\",\\\\\\"14\\\\\\":\\\\\\"16:58\\\\\\",\\\\\\"15\\\\\\":\\\\\\"17:58\\\\\\",\\\\\\"16\\\\\\":\\\\\\"18:58\\\\\\",\\\\\\"17\\\\\\":\\\\\\"19:58\\\\\\",\\\\\\"18\\\\\\":\\\\\\"20:58\\\\\\",\\\\\\"19\\\\\\":\\\\\\"21:58\\\\\\",\\\\\\"20\\\\\\":\\\\\\"22:58\\\\\\",\\\\\\"21\\\\\\":\\\\\\"23:58\\\\\\",\\\\\\"22\\\\\\":\\\\\\"24:58\\\\\\",\\\\\\"23\\\\\\":\\\\\\"25:58\\\\\\",\\\\\\"24\\\\\\":\\\\\\"26:58\\\\\\"}\\",\\n \\"IsDefault\\": true,\\n \\"Owner\\": \\"952795****\\",\\n \\"ProjectId\\": 100001,\\n \\"Priority\\": 1,\\n \\"SlaMinu\\": 30,\\n \\"SlaHour\\": 9,\\n \\"BaselineId\\": 1234,\\n \\"BaselineName\\": \\"Baseline name\\",\\n \\"HourExpDetail\\": \\"{\\\\\\"1\\\\\\":\\\\\\"03:28\\\\\\",\\\\\\"2\\\\\\":\\\\\\"04:28\\\\\\",\\\\\\"3\\\\\\":\\\\\\"05:28\\\\\\",\\\\\\"4\\\\\\":\\\\\\"06:28\\\\\\",\\\\\\"5\\\\\\":\\\\\\"07:28\\\\\\",\\\\\\"6\\\\\\":\\\\\\"08:28\\\\\\",\\\\\\"7\\\\\\":\\\\\\"09:28\\\\\\",\\\\\\"8\\\\\\":\\\\\\"10:28\\\\\\",\\\\\\"9\\\\\\":\\\\\\"11:28\\\\\\",\\\\\\"10\\\\\\":\\\\\\"12:28\\\\\\",\\\\\\"11\\\\\\":\\\\\\"13:28\\\\\\",\\\\\\"12\\\\\\":\\\\\\"14:28\\\\\\",\\\\\\"13\\\\\\":\\\\\\"15:28\\\\\\",\\\\\\"14\\\\\\":\\\\\\"16:28\\\\\\",\\\\\\"15\\\\\\":\\\\\\"17:28\\\\\\",\\\\\\"16\\\\\\":\\\\\\"18:28\\\\\\",\\\\\\"17\\\\\\":\\\\\\"19:28\\\\\\",\\\\\\"18\\\\\\":\\\\\\"20:28\\\\\\",\\\\\\"19\\\\\\":\\\\\\"21:28\\\\\\",\\\\\\"20\\\\\\":\\\\\\"22:28\\\\\\",\\\\\\"21\\\\\\":\\\\\\"23:28\\\\\\",\\\\\\"22\\\\\\":\\\\\\"24:28\\\\\\",\\\\\\"23\\\\\\":\\\\\\"25:28\\\\\\",\\\\\\"24\\\\\\":\\\\\\"26:28\\\\\\"}\\",\\n \\"UseFlag\\": true,\\n \\"ExpHour\\": 7,\\n \\"BaselineType\\": \\"DAILY\\",\\n \\"ExpMinu\\": 30\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<ListBaselineConfigsResponse>\\n <HttpStatusCode>200</HttpStatusCode>\\n <RequestId>0000-ABCD-EFG****</RequestId>\\n <ErrorMessage>The specified parameters are invalid.</ErrorMessage>\\n <ErrorCode>1031203110005</ErrorCode>\\n <Success>true</Success>\\n <Data>\\n <PageNumber>1</PageNumber>\\n <PageSize>10</PageSize>\\n <TotalCount>100</TotalCount>\\n <Baselines>\\n <HourSlaDetail>{\\"1\\":\\"03:58\\",\\"2\\":\\"04:58\\",\\"3\\":\\"05:58\\",\\"4\\":\\"06:58\\",\\"5\\":\\"07:58\\",\\"6\\":\\"08:58\\",\\"7\\":\\"09:58\\",\\"8\\":\\"10:58\\",\\"9\\":\\"11:58\\",\\"10\\":\\"12:58\\",\\"11\\":\\"13:58\\",\\"12\\":\\"14:58\\",\\"13\\":\\"15:58\\",\\"14\\":\\"16:58\\",\\"15\\":\\"17:58\\",\\"16\\":\\"18:58\\",\\"17\\":\\"19:58\\",\\"18\\":\\"20:58\\",\\"19\\":\\"21:58\\",\\"20\\":\\"22:58\\",\\"21\\":\\"23:58\\",\\"22\\":\\"24:58\\",\\"23\\":\\"25:58\\",\\"24\\":\\"26:58\\"}</HourSlaDetail>\\n <IsDefault>true</IsDefault>\\n <Owner>952795****</Owner>\\n <ProjectId>9527</ProjectId>\\n <Priority>1</Priority>\\n <SlaMinu>30</SlaMinu>\\n <SlaHour>9</SlaHour>\\n <BaselineId>1234</BaselineId>\\n <BaselineName>基线名称</BaselineName>\\n <HourExpDetail>{\\"1\\":\\"03:28\\",\\"2\\":\\"04:28\\",\\"3\\":\\"05:28\\",\\"4\\":\\"06:28\\",\\"5\\":\\"07:28\\",\\"6\\":\\"08:28\\",\\"7\\":\\"09:28\\",\\"8\\":\\"10:28\\",\\"9\\":\\"11:28\\",\\"10\\":\\"12:28\\",\\"11\\":\\"13:28\\",\\"12\\":\\"14:28\\",\\"13\\":\\"15:28\\",\\"14\\":\\"16:28\\",\\"15\\":\\"17:28\\",\\"16\\":\\"18:28\\",\\"17\\":\\"19:28\\",\\"18\\":\\"20:28\\",\\"19\\":\\"21:28\\",\\"20\\":\\"22:28\\",\\"21\\":\\"23:28\\",\\"22\\":\\"24:28\\",\\"23\\":\\"25:28\\",\\"24\\":\\"26:28\\"}</HourExpDetail>\\n <UseFlag>true</UseFlag>\\n <ExpHour>7</ExpHour>\\n <BaselineType>DAILY</BaselineType>\\n <ExpMinu>30</ExpMinu>\\n </Baselines>\\n </Data>\\n</ListBaselineConfigsResponse>","errorExample":""}]',
+ 'title' => 'ListBaselineConfigs',
+ 'summary' => 'Queries a list of baselines.',
+ 'requestParamsDescription' => ' ',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ ],
+ 'GetBaselineKeyPath' => [
+ 'methods' => [
+ 'post',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'get',
+ 'abilityTreeCode' => '78230',
+ 'abilityTreeNodes' => [
+ 'FEATUREdideSFSFU4',
+ ],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'BaselineId',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The name of the event.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => '1234',
+ ],
+ ],
+ [
+ 'name' => 'Bizdate',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The ID of the instance.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => '2020-07-07T00:00:00+0800',
+ ],
+ ],
+ [
+ 'name' => 'InGroupId',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The ID of the event.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => '1',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'HttpStatusCode' => [
+ 'description' => 'The timestamp when the event was found.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '200',
+ ],
+ 'RequestId' => [
+ 'description' => 'The unique ID of the call. After an error occurs, you can troubleshoot the problem based on the ID.',
+ 'type' => 'string',
+ 'example' => '0000-ABCD-EFG****',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'Error message',
+ 'type' => 'string',
+ 'example' => 'The specified parameters are invalid.',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'Error code',
+ 'type' => 'string',
+ 'example' => '1031203110005',
+ ],
+ 'Success' => [
+ 'description' => 'Whether the call is successful.',
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'Data' => [
+ 'description' => 'The information about the key path.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'Owner' => [
+ 'description' => 'The ID of the Alibaba Cloud account used by the node owner.'."\n",
+ 'type' => 'string',
+ 'example' => '9527952****',
+ ],
+ 'NodeName' => [
+ 'description' => 'The name of the node.'."\n",
+ 'type' => 'string',
+ 'example' => 'Node name',
+ ],
+ 'Bizdate' => [
+ 'description' => 'The data timestamp of the instance.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '1553443200000',
+ ],
+ 'ProjectId' => [
+ 'description' => 'The ID of the workspace to which the node belongs.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '1234',
+ ],
+ 'InstanceId' => [
+ 'description' => 'The ID of the instance.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '12345',
+ ],
+ 'PrgType' => [
+ 'description' => 'The type of the node. Valid values: 23, 10, 6, and 99. The value 23 indicates that the node is a Data Integration node. The value 10 indicates that the node is a MaxCompute SQL node. The value 6 indicates that the node is a Shell node. The value 99 indicates that the node is a zero load node.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '10',
+ ],
+ 'NodeId' => [
+ 'description' => 'The node ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '1234',
+ ],
+ 'InGroupId' => [
+ 'description' => 'The ID of the scheduling cycle of the instance. Valid values: 1 to 288.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '1',
+ ],
+ 'Runs' => [
+ 'description' => 'The running records of the instance.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'Status' => [
+ 'description' => 'The status of the instance. Valid values: NOT_RUN, WAIT_TIME, WAIT_RESOURCE, RUNNING, CHECKING, CHECKING_CONDITION, FAILURE, and SUCCESS. The value NOT_RUN indicates that the instance is not run. The value WAIT_TIME indicates that the instance is waiting to be run. The value WAIT_RESOURCE indicates that the instance is waiting for resources. The value RUNNING indicates that the instance is running. The value CHECKING indicates that data quality is being checked for the instance. The value CHECKING_CONDITION indicates that branch conditions are being checked for the instance. The value FAILURE indicates that the instance fails to run. The value SUCCESS indicates that the instance is run.'."\n",
+ 'type' => 'string',
+ 'example' => 'SUCCESS',
+ ],
+ 'AbsTime' => [
+ 'description' => 'The timestamp obtained by adding the predicted time when the instance started to run to the historical average running duration of the instance.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '1553531402000',
+ ],
+ 'BeginRunningTime' => [
+ 'description' => 'The timestamp of the actual time when the instance started to run.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '1553531401000',
+ ],
+ 'FinishTime' => [
+ 'description' => 'The timestamp of the actual time when the instance finished running.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '1553531401000',
+ ],
+ 'BeginCast' => [
+ 'description' => 'The timestamp of the predicted time when the instance started to run.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '1553531686000',
+ ],
+ 'EndCast' => [
+ 'description' => 'The timestamp of the predicted time when the instance finished running.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '1553531687000',
+ ],
+ 'BeginWaitResTime' => [
+ 'description' => 'The timestamp when the instance started to wait for resources.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '1553531401000',
+ ],
+ 'BeginWaitTimeTime' => [
+ 'description' => 'The timestamp when the instance started to wait for the scheduling time.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '1553531400000',
+ ],
+ ],
+ ],
+ ],
+ 'Topics' => [
+ 'description' => 'The information about the events that are associated with the instance.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'TopicName' => [
+ 'description' => 'The name of the event.'."\n",
+ 'type' => 'string',
+ 'example' => '1234',
+ ],
+ 'InstanceId' => [
+ 'description' => 'The instance ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '1234',
+ ],
+ 'TopicId' => [
+ 'description' => 'The event ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '1234',
+ ],
+ 'AddTime' => [
+ 'description' => 'The timestamp when the event was found.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '1553531401000',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'description' => '',
+ ],
+ ],
+ ],
+ 'description' => '',
+ ],
+ ],
+ ],
+ 'errorCodes' => [
+ 403 => [
+ [
+ 'errorCode' => 'Forbidden.Access',
+ 'errorMessage' => 'Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.',
+ ],
+ ],
+ 429 => [
+ [
+ 'errorCode' => 'Throttling.Api',
+ 'errorMessage' => 'The request for this resource has exceeded your available limit.',
+ ],
+ [
+ 'errorCode' => 'Throttling.Api.Risk',
+ 'errorMessage' => 'The request for this resource has exceeded your daily available limit.',
+ ],
+ [
+ 'errorCode' => 'Throttling.System',
+ 'errorMessage' => 'The DataWorks system is busy. Try again later.',
+ ],
+ [
+ 'errorCode' => 'Throttling.User',
+ 'errorMessage' => 'Your request is too frequent. Try again later.',
+ ],
+ ],
+ 500 => [
+ [
+ 'errorCode' => 'Forbidden.Wkbench.BaselineNoPermission',
+ 'errorMessage' => 'You are not authorized to access the baseline.',
+ ],
+ [
+ 'errorCode' => 'Forbidden.Wkbench.ProjectNoPermission',
+ 'errorMessage' => 'You are not authorized to access the workspace.',
+ ],
+ [
+ 'errorCode' => 'Forbidden.Not.Server',
+ 'errorMessage' => 'The dataworksAPI service is not available in this area. Please try it in another area.',
+ ],
+ [
+ 'errorCode' => 'InternalError.System',
+ 'errorMessage' => 'An internal system error occurred. Try again later.',
+ ],
+ [
+ 'errorCode' => 'InternalError.UserId.Missing',
+ 'errorMessage' => 'An internal system error occurred. Try again later.',
+ ],
+ [
+ 'errorCode' => 'Invalid.Wkbench.BaselineStatusNotExist',
+ 'errorMessage' => 'The BaselineStatus does not exist.',
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"0000-ABCD-EFG****\\",\\n \\"ErrorMessage\\": \\"The specified parameters are invalid.\\",\\n \\"ErrorCode\\": \\"1031203110005\\",\\n \\"Success\\": true,\\n \\"Data\\": [\\n {\\n \\"Owner\\": \\"9527952****\\",\\n \\"NodeName\\": \\"Node name\\",\\n \\"Bizdate\\": 1553443200000,\\n \\"ProjectId\\": 1234,\\n \\"InstanceId\\": 123456,\\n \\"PrgType\\": 10,\\n \\"NodeId\\": 1234,\\n \\"InGroupId\\": 1,\\n \\"Runs\\": [\\n {\\n \\"Status\\": \\"SUCCESS\\",\\n \\"AbsTime\\": 1553531402000,\\n \\"BeginRunningTime\\": 1553531401000,\\n \\"FinishTime\\": 1553531401000,\\n \\"BeginCast\\": 1553531686000,\\n \\"EndCast\\": 1553531687000,\\n \\"BeginWaitResTime\\": 1553531401000,\\n \\"BeginWaitTimeTime\\": 1553531400000\\n }\\n ],\\n \\"Topics\\": [\\n {\\n \\"TopicName\\": \\"1234\\",\\n \\"InstanceId\\": 1234,\\n \\"TopicId\\": 1234,\\n \\"AddTime\\": 1553531401000\\n }\\n ]\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<GetBaselineKeyPathResponse>\\n <HttpStatusCode>200</HttpStatusCode>\\n <RequestId>0000-ABCD-EFG****</RequestId>\\n <ErrorMessage>The specified parameters are invalid.</ErrorMessage>\\n <ErrorCode>1031203110005</ErrorCode>\\n <Success>true</Success>\\n <Data>\\n <Owner>9527952****</Owner>\\n <NodeName>节点名称</NodeName>\\n <Bizdate>1553443200000</Bizdate>\\n <ProjectId>1234</ProjectId>\\n <InstanceId>12345</InstanceId>\\n <PrgType>10</PrgType>\\n <NodeId>1234</NodeId>\\n <InGroupId>1</InGroupId>\\n <Runs>\\n <Status>SUCCESS</Status>\\n <AbsTime>1553531402000</AbsTime>\\n <BeginRunningTime>1553531401000</BeginRunningTime>\\n <CycTime>1553443200000</CycTime>\\n <Owner>9527952****</Owner>\\n <FinishTime>1553531401000</FinishTime>\\n <ProjectId>1234</ProjectId>\\n <BeginCast>1553531686000</BeginCast>\\n <InstanceId>1234</InstanceId>\\n <EndCast>1553531687000</EndCast>\\n <BeginWaitResTime>1553531401000</BeginWaitResTime>\\n <InGroupId>1</InGroupId>\\n <NodeName>节点名称</NodeName>\\n <Bizdate>1553443200000</Bizdate>\\n <BeginWaitTimeTime>1553531400000</BeginWaitTimeTime>\\n <NodeId>1234</NodeId>\\n </Runs>\\n <Topics>\\n <TopicName>1234</TopicName>\\n <InstanceId>1234</InstanceId>\\n <TopicId>1234</TopicId>\\n <AddTime>1553531401000</AddTime>\\n </Topics>\\n </Data>\\n</GetBaselineKeyPathResponse>","errorExample":""}]',
+ 'title' => 'GetBaselineKeyPath',
+ 'summary' => 'The information about the events that are associated with the instance.',
+ 'requestParamsDescription' => ' ',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ ],
+ 'GetBaselineStatus' => [
+ 'methods' => [
+ 'post',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'get',
+ 'abilityTreeCode' => '78231',
+ 'abilityTreeNodes' => [
+ 'FEATUREdideSFSFU4',
+ ],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'BaselineId',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The ID of the baseline.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => '1234',
+ ],
+ ],
+ [
+ 'name' => 'Bizdate',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The data timestamp of the baseline instance. Specify the time in the ISO 8601 standard in the yyyy-MM-dd\'T\'HH:mm:ssZ format. The time must be in UTC.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => '2020-07-07T00:00:00+0800',
+ ],
+ ],
+ [
+ 'name' => 'InGroupId',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The ID of the scheduling cycle of the baseline instance. For a baseline instance that is scheduled by day, the value of this parameter is 1. For a baseline instance that is scheduled by hour, the value of this parameter ranges from 1 to 24.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => '1',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'headers' => [],
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'HttpStatusCode' => [
+ 'description' => 'The HTTP status code returned.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '200',
+ ],
+ 'RequestId' => [
+ 'description' => 'The ID of the request. You can use the ID to troubleshoot issues.'."\n",
+ 'type' => 'string',
+ 'example' => '0000-ABCD-EFG****',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message returned.'."\n",
+ 'type' => 'string',
+ 'example' => 'The specified parameters are invalid.',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code returned.'."\n",
+ 'type' => 'string',
+ 'example' => '1031203110005',
+ ],
+ 'Success' => [
+ 'description' => 'Indicates whether the request was successful.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'Data' => [
+ 'description' => 'The details of the baseline instance.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'Status' => [
+ 'description' => 'The status of the baseline. Valid values: ERROR, SAFE, DANGEROUS, and OVER. The value ERROR indicates that no nodes are associated with the baseline, or all nodes associated with the baseline are suspended. The value SAFE indicates that nodes finish running before the alerting time. The value DANGEROUS indicates that nodes are still running after the alerting time but before the committed completion time. The value OVER indicates that nodes are still running after the committed completion time.'."\n",
+ 'type' => 'string',
+ 'example' => 'SAFE',
+ ],
+ 'Owner' => [
+ 'description' => 'The ID of the Alibaba Cloud account used by the baseline owner. Multiple IDs are separated by commas (,).'."\n",
+ 'type' => 'string',
+ 'example' => '9527952795****',
+ ],
+ 'FinishTime' => [
+ 'description' => 'The timestamp of the actual time when the baseline instance finished running. This parameter is returned if the value of the FinishStatus parameter is FINISH.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '1553443200000',
+ ],
+ 'ProjectId' => [
+ 'description' => 'The ID of the workspace to which the baseline belongs.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '1234',
+ ],
+ 'Priority' => [
+ 'description' => 'The priority of the baseline. Valid values: 1, 2, 5, 7, and 8.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '1',
+ ],
+ 'EndCast' => [
+ 'description' => 'The timestamp of the predicted time when the baseline instance finished running.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '1553443200000',
+ ],
+ 'InGroupId' => [
+ 'description' => 'The ID of the scheduling cycle of the baseline instance. For a baseline instance that is scheduled by day, the value of this parameter is 1. For a baseline instance that is scheduled by hour, the value of this parameter ranges from 1 to 24.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '1',
+ ],
+ 'BaselineName' => [
+ 'description' => 'The name of the baseline.'."\n",
+ 'type' => 'string',
+ 'example' => 'Baseline name'."\n",
+ ],
+ 'BaselineId' => [
+ 'description' => 'The ID of the baseline.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '1234',
+ ],
+ 'FinishStatus' => [
+ 'description' => 'The status of the baseline instance. Valid values: UNFINISH and FINISH. The value UNFINISH indicates that the baseline instance is still running. The value FINISH indicates that the baseline instance finishes running.'."\n",
+ 'type' => 'string',
+ 'example' => 'UNFINISH',
+ ],
+ 'Bizdate' => [
+ 'description' => 'The data timestamp of the baseline instance.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '1553443200000',
+ ],
+ 'Buffer' => [
+ 'description' => 'The margin of the baseline instance. Unit: seconds.'."\n",
+ 'type' => 'number',
+ 'format' => 'float',
+ 'example' => '1200',
+ ],
+ 'SlaTime' => [
+ 'description' => 'The timestamp of the committed completion time of the baseline instance.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '1553443200000',
+ ],
+ 'ExpTime' => [
+ 'description' => 'The timestamp of the alerting time of the baseline instance.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '1553443200000',
+ ],
+ 'LastInstance' => [
+ 'description' => 'The information about the last generated instance.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'Status' => [
+ 'description' => 'The status of the instance. Valid values: NOT_RUN, WAIT_TIME, WAIT_RESOURCE, RUNNING, CHECKING, CHECKING_CONDITION, FAILURE, and SUCCESS. The value NOT_RUN indicates that the instance is not run. The value WAIT_TIME indicates that the instance is waiting to be run. The value WAIT_RESOURCE indicates that the instance is waiting for resources. The value RUNNING indicates that the instance is running. The value CHECKING indicates that data quality is being checked for the instance. The value CHECKING_CONDITION indicates that branch conditions are being checked for the instance. The value FAILURE indicates that the instance fails to run. The value SUCCESS indicates that the instance is run.'."\n",
+ 'type' => 'string',
+ 'example' => 'SUCCESS',
+ ],
+ 'Owner' => [
+ 'description' => 'The ID of the Alibaba Cloud account used by the node owner.'."\n",
+ 'type' => 'string',
+ 'example' => '9527952795****',
+ ],
+ 'FinishTime' => [
+ 'description' => 'The timestamp of the actual time when the instance finished running.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '1553443200000',
+ ],
+ 'NodeName' => [
+ 'description' => 'The name of the node.'."\n",
+ 'type' => 'string',
+ 'example' => 'Node name'."\n",
+ ],
+ 'ProjectId' => [
+ 'description' => 'The ID of the workspace to which the node belongs.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '1234',
+ ],
+ 'InstanceId' => [
+ 'description' => 'The ID of the instance.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '12345',
+ ],
+ 'EndCast' => [
+ 'description' => 'The timestamp of the predicted time when the instance finished running.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '1553443200000',
+ ],
+ 'NodeId' => [
+ 'description' => 'The ID of the node.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '1234',
+ ],
+ ],
+ ],
+ 'BlockInstance' => [
+ 'description' => 'The information about the key instance.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'Status' => [
+ 'description' => 'The status of the instance. Valid values: NOT_RUN, WAIT_TIME, WAIT_RESOURCE, RUNNING, CHECKING, CHECKING_CONDITION, FAILURE, and SUCCESS. The value NOT_RUN indicates that the instance is not run. The value WAIT_TIME indicates that the instance is waiting to be run. The value WAIT_RESOURCE indicates that the instance is waiting for resources. The value RUNNING indicates that the instance is running. The value CHECKING indicates that data quality is being checked for the instance. The value CHECKING_CONDITION indicates that branch conditions are being checked for the instance. The value FAILURE indicates that the instance fails to run. The value SUCCESS indicates that the instance is run.'."\n",
+ 'type' => 'string',
+ 'example' => 'SUCCESS',
+ ],
+ 'Owner' => [
+ 'description' => 'The ID of the Alibaba Cloud account used by the node owner.'."\n",
+ 'type' => 'string',
+ 'example' => '9527952795****',
+ ],
+ 'FinishTime' => [
+ 'description' => 'The timestamp of the actual time when the instance finished running.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '1553443200000',
+ ],
+ 'NodeName' => [
+ 'description' => 'The name of the node.'."\n",
+ 'type' => 'string',
+ 'example' => 'Node name'."\n",
+ ],
+ 'ProjectId' => [
+ 'description' => 'The ID of the workspace to which the node belongs.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '1234',
+ ],
+ 'InstanceId' => [
+ 'description' => 'The ID of the instance.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '12345',
+ ],
+ 'EndCast' => [
+ 'description' => 'The timestamp of the predicted time when the instance finished running.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '1553443200000',
+ ],
+ 'NodeId' => [
+ 'description' => 'The ID of the node.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '1234',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'errorCodes' => [
+ 403 => [
+ [
+ 'errorCode' => 'Forbidden.Access',
+ 'errorMessage' => 'Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.',
+ ],
+ ],
+ 429 => [
+ [
+ 'errorCode' => 'Throttling.Api',
+ 'errorMessage' => 'The request for this resource has exceeded your available limit.',
+ ],
+ [
+ 'errorCode' => 'Throttling.Api.Risk',
+ 'errorMessage' => 'The request for this resource has exceeded your daily available limit.',
+ ],
+ [
+ 'errorCode' => 'Throttling.System',
+ 'errorMessage' => 'The DataWorks system is busy. Try again later.',
+ ],
+ [
+ 'errorCode' => 'Throttling.User',
+ 'errorMessage' => 'Your request is too frequent. Try again later.',
+ ],
+ ],
+ 500 => [
+ [
+ 'errorCode' => 'Forbidden.Not.Server',
+ 'errorMessage' => 'The dataworksAPI service is not available in this area. Please try it in another area.',
+ ],
+ [
+ 'errorCode' => 'InternalError.System',
+ 'errorMessage' => 'An internal system error occurred. Try again later.',
+ ],
+ [
+ 'errorCode' => 'InternalError.UserId.Missing',
+ 'errorMessage' => 'An internal system error occurred. Try again later.',
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"0000-ABCD-EFG****\\",\\n \\"ErrorMessage\\": \\"The specified parameters are invalid.\\",\\n \\"ErrorCode\\": \\"1031203110005\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"Status\\": \\"SAFE\\",\\n \\"Owner\\": \\"9527952795****\\",\\n \\"FinishTime\\": 1553443200000,\\n \\"ProjectId\\": 1234,\\n \\"Priority\\": 1,\\n \\"EndCast\\": 1553443200000,\\n \\"InGroupId\\": 1,\\n \\"BaselineName\\": \\"基线名称\\",\\n \\"BaselineId\\": 1234,\\n \\"FinishStatus\\": \\"UNFINISH\\",\\n \\"Bizdate\\": 1553443200000,\\n \\"Buffer\\": 1200,\\n \\"SlaTime\\": 1553443200000,\\n \\"ExpTime\\": 1553443200000,\\n \\"LastInstance\\": {\\n \\"Status\\": \\"SUCCESS\\",\\n \\"Owner\\": \\"9527952795****\\",\\n \\"FinishTime\\": 1553443200000,\\n \\"NodeName\\": \\"节点名称\\",\\n \\"ProjectId\\": 1234,\\n \\"InstanceId\\": 12345,\\n \\"EndCast\\": 1553443200000,\\n \\"NodeId\\": 1234\\n },\\n \\"BlockInstance\\": {\\n \\"Status\\": \\"SUCCESS\\",\\n \\"Owner\\": \\"9527952795****\\",\\n \\"FinishTime\\": 1553443200000,\\n \\"NodeName\\": \\"节点名称\\",\\n \\"ProjectId\\": 1234,\\n \\"InstanceId\\": 12345,\\n \\"EndCast\\": 1553443200000,\\n \\"NodeId\\": 1234\\n }\\n }\\n}","errorExample":""},{"type":"xml","example":"<GetBaselineStatusResponse>\\n <HttpStatusCode>200</HttpStatusCode>\\n <RequestId>0000-ABCD-EFG****</RequestId>\\n <ErrorMessage>The specified parameters are invalid.</ErrorMessage>\\n <ErrorCode>1031203110005</ErrorCode>\\n <Success>true</Success>\\n <Data>\\n <Status>SAFE</Status>\\n <Owner>9527952795****</Owner>\\n <FinishTime>1553443200000</FinishTime>\\n <ProjectId>1234</ProjectId>\\n <Priority>1</Priority>\\n <EndCast>1553443200000</EndCast>\\n <InGroupId>1</InGroupId>\\n <BaselineName>基线名称</BaselineName>\\n <BaselineId>1234</BaselineId>\\n <FinishStatus>UNFINISH</FinishStatus>\\n <Bizdate>1553443200000</Bizdate>\\n <Buffer>1200</Buffer>\\n <SlaTime>1553443200000</SlaTime>\\n <ExpTime>1553443200000</ExpTime>\\n <LastInstance>\\n <Status>SUCCESS</Status>\\n <Owner>9527952795****</Owner>\\n <FinishTime>1553443200000</FinishTime>\\n <NodeName>节点名称</NodeName>\\n <ProjectId>1234</ProjectId>\\n <InstanceId>12345</InstanceId>\\n <EndCast>1553443200000</EndCast>\\n <NodeId>1234</NodeId>\\n </LastInstance>\\n <BlockInstance>\\n <Status>SUCCESS</Status>\\n <Owner>9527952795****</Owner>\\n <FinishTime>1553443200000</FinishTime>\\n <NodeName>节点名称</NodeName>\\n <ProjectId>1234</ProjectId>\\n <InstanceId>12345</InstanceId>\\n <EndCast>1553443200000</EndCast>\\n <NodeId>1234</NodeId>\\n </BlockInstance>\\n </Data>\\n</GetBaselineStatusResponse>","errorExample":""}]',
+ 'title' => 'GetBaselineStatus',
+ 'summary' => 'Queries the details of a baseline instance.',
+ 'requestParamsDescription' => ' ',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ ],
+ 'ListBaselineStatuses' => [
+ 'methods' => [
+ 'post',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'list',
+ 'abilityTreeCode' => '78296',
+ 'abilityTreeNodes' => [
+ 'FEATUREdideSFSFU4',
+ ],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'PageNumber',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The number of the page to return. Valid values: 1 to 30. Default value: 1.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => '1',
+ ],
+ ],
+ [
+ 'name' => 'PageSize',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The number of entries to return on each page. Default value: 10. Maximum value: 100.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => '10',
+ ],
+ ],
+ [
+ 'name' => 'Bizdate',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The data timestamp of the baseline instance. Specify the time in the ISO 8601 standard in the yyyy-MM-dd\'T\'HH:mm:ssZ format. The time must be in UTC.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => '2020-07-07T00:00:00+0800',
+ ],
+ ],
+ [
+ 'name' => 'Priority',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The priority of the baseline. Valid values: 1, 3, 5, 7, and 8. Multiple priorities are separated by commas (,).'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => '1,3,5,7,8',
+ ],
+ ],
+ [
+ 'name' => 'SearchText',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The keyword of the baseline name used to search for the baseline.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'Keyword of the baseline name'."\n",
+ ],
+ ],
+ [
+ 'name' => 'Owner',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The ID of the Alibaba Cloud account used by the baseline owner.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => '9527952795****',
+ ],
+ ],
+ [
+ 'name' => 'TopicId',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The ID of the event.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'example' => '1234',
+ ],
+ ],
+ [
+ 'name' => 'FinishStatus',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The status of the baseline instance. Valid values: UNFINISH and FINISH. The value UNFINISH indicates that the baseline instance is still running. The value FINISH indicates that the baseline instance finishes running. Multiple states are separated by commas (,).'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'FINISH,UNFINISH',
+ ],
+ ],
+ [
+ 'name' => 'Status',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The status of the baseline. Valid values: ERROR, SAFE, DANGEROUS, and OVER. The value ERROR indicates that no nodes are associated with the baseline, or all nodes associated with the baseline are suspended. The value SAFE indicates that nodes finish running before the alerting time. The value DANGEROUS indicates that nodes are still running after the alerting time but before the committed completion time. The value OVER indicates that nodes are still running after the committed completion time. Multiple states are separated by commas (,).'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'SAFE,DANGROUS,OVER',
+ ],
+ ],
+ [
+ 'name' => 'BaselineTypes',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The type of the baseline. Valid values: DAILY and HOURLY. The value DAILY indicates that the baseline is scheduled by day. The value HOURLY indicates that the baseline is scheduled by hour. Multiple types are separated by commas (,).'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'DAILY,HOURLY',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'description' => 'The response parameters.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'HttpStatusCode' => [
+ 'description' => 'The HTTP status code returned.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '200',
+ ],
+ 'RequestId' => [
+ 'description' => 'The ID of the request. You can use the ID to troubleshoot issues.'."\n",
+ 'type' => 'string',
+ 'example' => '0000-ABCD-EFG****',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message returned.'."\n",
+ 'type' => 'string',
+ 'example' => 'The specified parameters are invalid.',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code returned.'."\n",
+ 'type' => 'string',
+ 'example' => 'Invalid.Tenant.ConnectionNotExists',
+ ],
+ 'Success' => [
+ 'description' => 'Indicates whether the request was successful.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'Data' => [
+ 'description' => 'The data returned.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'PageNumber' => [
+ 'description' => 'The page number of the returned page.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '1',
+ ],
+ 'PageSize' => [
+ 'description' => 'The number of entries returned per page.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '10',
+ ],
+ 'TotalCount' => [
+ 'description' => 'The total number of baseline instances.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '100',
+ ],
+ 'BaselineStatuses' => [
+ 'description' => 'The list of baseline instances.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The information about the baseline instances.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'Status' => [
+ 'description' => 'The status of the baseline. Valid values: ERROR, SAFE, DANGEROUS, and OVER. The value ERROR indicates that no nodes are associated with the baseline, or all nodes associated with the baseline are suspended. The value SAFE indicates that nodes are run before the alert duration begins. The value DANGEROUS indicates that nodes are still running after the alert duration ends but the committed completion time does not arrive. The value OVER indicates that nodes are still running after the committed completion time.'."\n",
+ 'type' => 'string',
+ 'example' => 'SAFE',
+ ],
+ 'Owner' => [
+ 'description' => 'The ID of the Alibaba Cloud account used by the baseline owner. Multiple IDs are separated by commas (,).'."\n",
+ 'type' => 'string',
+ 'example' => '9527952795****',
+ ],
+ 'FinishTime' => [
+ 'description' => 'The timestamp of the actual time when the baseline instance finished running. This parameter is returned if the value of the FinishStatus parameter is FINISH.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '1553531400000',
+ ],
+ 'ProjectId' => [
+ 'description' => 'The ID of the workspace to which the baseline belongs.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '1234',
+ ],
+ 'Priority' => [
+ 'description' => 'The priority of the baseline. Valid values: {1,3,5,7,8}.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '1',
+ ],
+ 'EndCast' => [
+ 'description' => 'The timestamp of the predicted time when the baseline instance finished running.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '1553531400000',
+ ],
+ 'InGroupId' => [
+ 'description' => 'The ID of the cycle of the baseline instance. Valid values of the ID of an hour-level cycle: \\[1,24]. The ID of a day-level cycle is 1.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '1',
+ ],
+ 'BaselineName' => [
+ 'description' => 'The name of the baseline.'."\n",
+ 'type' => 'string',
+ 'example' => 'Baseline name'."\n",
+ ],
+ 'BaselineId' => [
+ 'description' => 'The baseline ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '1234',
+ ],
+ 'FinishStatus' => [
+ 'description' => 'The status of the baseline instance. Valid values: UNFINISH and FINISH.'."\n",
+ 'type' => 'string',
+ 'example' => 'UNFINISH',
+ ],
+ 'Bizdate' => [
+ 'description' => 'The data timestamp.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '1553443200000',
+ ],
+ 'Buffer' => [
+ 'description' => 'The margin of the baseline instance. Unit: seconds.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '1800',
+ ],
+ 'SlaTime' => [
+ 'description' => 'The timestamp of the actual time when the baseline instance finished running.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '1553531400000',
+ ],
+ 'ExpTime' => [
+ 'description' => 'The timestamp of the alerting time of the baseline instance.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '1553531400000',
+ ],
+ 'BaselineType' => [
+ 'description' => 'The type of the baseline, including DAILY and HOURLY. Separate multiple types with commas (,).',
+ 'type' => 'string',
+ 'example' => 'DAILY,HOURLY',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'errorCodes' => [
+ 403 => [
+ [
+ 'errorCode' => 'Forbidden.Access',
+ 'errorMessage' => 'Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.',
+ ],
+ ],
+ 429 => [
+ [
+ 'errorCode' => 'Throttling.Api',
+ 'errorMessage' => 'The request for this resource has exceeded your available limit.',
+ ],
+ [
+ 'errorCode' => 'Throttling.Api.Risk',
+ 'errorMessage' => 'The request for this resource has exceeded your daily available limit.',
+ ],
+ [
+ 'errorCode' => 'Throttling.System',
+ 'errorMessage' => 'The DataWorks system is busy. Try again later.',
+ ],
+ [
+ 'errorCode' => 'Throttling.User',
+ 'errorMessage' => 'Your request is too frequent. Try again later.',
+ ],
+ ],
+ 500 => [
+ [
+ 'errorCode' => 'Forbidden.Not.Server',
+ 'errorMessage' => 'The dataworksAPI service is not available in this area. Please try it in another area.',
+ ],
+ [
+ 'errorCode' => 'InternalError.System',
+ 'errorMessage' => 'An internal system error occurred. Try again later.',
+ ],
+ [
+ 'errorCode' => 'InternalError.UserId.Missing',
+ 'errorMessage' => 'An internal system error occurred. Try again later.',
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"0000-ABCD-EFG****\\",\\n \\"ErrorMessage\\": \\"The specified parameters are invalid.\\",\\n \\"ErrorCode\\": \\"Invalid.Tenant.ConnectionNotExists\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 100,\\n \\"BaselineStatuses\\": [\\n {\\n \\"Status\\": \\"SAFE\\",\\n \\"Owner\\": \\"9527952795****\\",\\n \\"FinishTime\\": 1553531400000,\\n \\"ProjectId\\": 1234,\\n \\"Priority\\": 1,\\n \\"EndCast\\": 1553531400000,\\n \\"InGroupId\\": 1,\\n \\"BaselineName\\": \\"基线名称\\",\\n \\"BaselineId\\": 1234,\\n \\"FinishStatus\\": \\"UNFINISH\\",\\n \\"Bizdate\\": 1553443200000,\\n \\"Buffer\\": 1800,\\n \\"SlaTime\\": 1553531400000,\\n \\"ExpTime\\": 1553531400000,\\n \\"BaselineType\\": \\"基线类型\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<ListBaselineStatusesResponse>\\n <HttpStatusCode>200</HttpStatusCode>\\n <RequestId>0000-ABCD-EFG****</RequestId>\\n <ErrorMessage>The specified parameters are invalid.</ErrorMessage>\\n <ErrorCode>Invalid.Tenant.ConnectionNotExists</ErrorCode>\\n <Success>true</Success>\\n <Data>\\n <PageNumber>1</PageNumber>\\n <PageSize>10</PageSize>\\n <TotalCount>100</TotalCount>\\n <BaselineStatuses>\\n <Status>SAFE</Status>\\n <Owner>9527952795****</Owner>\\n <FinishTime>1553531400000</FinishTime>\\n <ProjectId>1234</ProjectId>\\n <Priority>1</Priority>\\n <EndCast>1553531400000</EndCast>\\n <InGroupId>1</InGroupId>\\n <BaselineName>基线名称</BaselineName>\\n <BaselineId>1234</BaselineId>\\n <FinishStatus>UNFINISH</FinishStatus>\\n <Bizdate>1553443200000</Bizdate>\\n <Buffer>1800</Buffer>\\n <SlaTime>1553531400000</SlaTime>\\n <ExpTime>1553531400000</ExpTime>\\n </BaselineStatuses>\\n </Data>\\n</ListBaselineStatusesResponse>","errorExample":""}]',
+ 'title' => 'ListBaselineStatuses',
+ 'summary' => 'Queries a list of baseline instances.',
+ 'requestParamsDescription' => ' ',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ ],
+ 'DeleteRemind' => [
+ 'summary' => 'Deletes a custom alert rule.',
+ 'methods' => [
+ 'post',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'write',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'delete',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeCode' => '78217',
+ 'abilityTreeNodes' => [
+ 'FEATUREdideRJGWWC',
+ ],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'RemindId',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The ID of the custom alert rule.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => '1234',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'HttpStatusCode' => [
+ 'description' => 'The HTTP status code returned.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '200',
+ ],
+ 'Data' => [
+ 'description' => 'Indicates whether the custom alert rule is deleted. Valid values: true and false. The value true indicates that the custom alert rule is deleted. The value false indicates that the custom alert rule fails to be deleted.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message returned.'."\n",
+ 'type' => 'string',
+ 'example' => 'The specified parameters are invalid.',
+ ],
+ 'RequestId' => [
+ 'description' => 'The ID of the request. You can use the ID to troubleshoot issues.'."\n",
+ 'type' => 'string',
+ 'example' => '0000-ABCD-EFG****',
+ ],
+ 'Success' => [
+ 'description' => 'Indicates whether the request was successful.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code returned.'."\n",
+ 'type' => 'string',
+ 'example' => '1031203110005',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'errorCodes' => [
+ 403 => [
+ [
+ 'errorCode' => 'Forbidden.Access',
+ 'errorMessage' => 'Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.',
+ ],
+ ],
+ 429 => [
+ [
+ 'errorCode' => 'Throttling.Api',
+ 'errorMessage' => 'The request for this resource has exceeded your available limit.',
+ ],
+ ],
+ 500 => [
+ [
+ 'errorCode' => 'Forbidden.Not.Server',
+ 'errorMessage' => 'The dataworksAPI service is not available in this area. Please try it in another area.',
+ ],
+ [
+ 'errorCode' => 'InternalError.System',
+ 'errorMessage' => 'An internal system error occurred. Try again later.',
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Data\\": true,\\n \\"ErrorMessage\\": \\"The specified parameters are invalid.\\",\\n \\"RequestId\\": \\"0000-ABCD-EFG****\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"1031203110005\\"\\n}","errorExample":""},{"type":"xml","example":"<RequestId>0000-ABCD-EFG****</RequestId>\\n<HttpStatusCode>200</HttpStatusCode>\\n<Data>true</Data>\\n<ErrorCode>1031203110005</ErrorCode>\\n<ErrorMessage>The specified parameters are invalid.</ErrorMessage>\\n<Success>true</Success>","errorExample":""}]',
+ 'title' => 'DeleteRemind',
+ 'requestParamsDescription' => ' ',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ ],
+ 'UpdateRemind' => [
+ 'methods' => [
+ 'post',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'write',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'update',
+ 'abilityTreeCode' => '78381',
+ 'abilityTreeNodes' => [
+ 'FEATUREdideRJGWWC',
+ ],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'RemindId',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The custom alert rule ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => '1234',
+ ],
+ ],
+ [
+ 'name' => 'RemindName',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The name of the custom alert rule. The name cannot exceed 128 characters in length.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'update_remindname',
+ ],
+ ],
+ [
+ 'name' => 'DndEnd',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The end of the period during which no alert notifications are sent. Specify the time in the hh:mm format. Valid values of hh: \\[0,23]. Valid values of mm: \\[0,59].'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => '08:00',
+ ],
+ ],
+ [
+ 'name' => 'RemindUnit',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The type of the object to which the custom alert rule is applied. Valid values:'."\n"
+ ."\n"
+ .'* NODE'."\n"
+ .'* BASELINE'."\n"
+ .'* PROJECT'."\n"
+ .'* BIZPROCESS'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'NODE',
+ 'enum' => [
+ 'NODE',
+ 'BASELINE',
+ 'PROJECT',
+ 'BIZPROCESS',
+ ],
+ ],
+ ],
+ [
+ 'name' => 'NodeIds',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The ID of the node to which the custom alert rule is applied. A maximum of 50 nodes can be specified for a custom alert rule. You can specify multiple IDs. Separate multiple IDs with commas (,). This parameter takes effect when you set the RemindUnit parameter to NODE.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => '1,2,3',
+ ],
+ ],
+ [
+ 'name' => 'BaselineIds',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The ID of the baseline to which the custom alert rule is applied. A maximum of 5 baselines can be specified for a custom alert rule. You can specify multiple IDs. Separate multiple IDs with commas (,). This parameter takes effect when you set the RemindUnit parameter to BASELINE.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => '1,2,3',
+ ],
+ ],
+ [
+ 'name' => 'ProjectId',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The ID of the workspace to which the custom alert rule is applied. You can specify only one workspace for a custom alert rule. This parameter takes effect when you set the RemindUnit parameter to PROJECT.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'example' => '1234',
+ ],
+ ],
+ [
+ 'name' => 'BizProcessIds',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The ID of the workflow to which the custom alert rule is applied. A maximum of 5 workflows can be specified for a custom alert rule. You can specify multiple IDs. Separate multiple IDs with commas (,). This parameter takes effect when you set the RemindUnit parameter to BIZPROCESS.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => '1,2,3',
+ ],
+ ],
+ [
+ 'name' => 'RemindType',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The condition that triggers the alert rule. Valid values:'."\n"
+ ."\n"
+ .'* FINISHED: The system monitors an instance when it starts to run and sends an alert notification after the running of the instance is complete.'."\n"
+ .'* UNFINISHED: The system monitors an instance when it starts to run and sends an alert notification if the instance is still running at the specified point in time.'."\n"
+ .'* ERROR: The system monitors an instance when it starts to run and sends an alert notification if an error occurs.'."\n"
+ .'* CYCLE_UNFINISHED: The system sends an alert notification if a monitored instance is still running at the end of the specified cycle. In most cases, you can configure this trigger condition for node instances that are scheduled to run by hour.'."\n"
+ .'* TIMEOUT: The system monitors an instance when it starts to run and sends an alert notification if the instance is still running after the specified period ends. In most cases, you can configure this trigger condition to monitor the running duration of node instances.'."\n"
+ ."\n"
+ .'For more information, see [Manage custom alert rules](~~138172~~).'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'FINISHED',
+ 'enum' => [
+ 'FINISHED',
+ 'UNFINISHED',
+ 'ERROR',
+ 'CYCLE_UNFINISHED',
+ 'TIMEOUT',
+ 'EXHAUSTED_ERROR',
+ ],
+ ],
+ ],
+ [
+ 'name' => 'MaxAlertTimes',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The maximum number of alerts. Valid values: 1 to 10. Default value: 3.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => false,
+ 'maximum' => '10',
+ 'minimum' => '1',
+ 'example' => '3',
+ 'default' => '3',
+ ],
+ ],
+ [
+ 'name' => 'AlertInterval',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The intervals at which alert notifications are sent. Unit: seconds. Minimum value: 1200. Default value: 1800.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => false,
+ 'docRequired' => false,
+ 'maximum' => '1800',
+ 'minimum' => '1200',
+ 'example' => '1800',
+ 'default' => '1800',
+ ],
+ ],
+ [
+ 'name' => 'Detail',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The details of the conditions that trigger an alert.'."\n"
+ ."\n"
+ .'* If the RemindType parameter is set to FINISHED, leave this parameter empty.'."\n"
+ .'* If the RemindType parameter is set to UNFINISHED, set this parameter to key-value pairs. Example: {"hour":23,"minu":59}. Valid values of hour: \\[0,47]. Valid values of minu: \\[0,59].'."\n"
+ .'* If the RemindType parameter is set to ERROR, leave this parameter empty.'."\n"
+ .'* If the RemindType parameter is set to CYCLE_UNFINISHED, set this parameter to key-value pairs in the JSON format. Example: {"1":"05:50","2":"06:50","3":"07:50","4":"08:50","5":"09:50","6":"10:50","7":"11:50","8":"12:50","9":"13:50","10":"14:50","11":"15:50","12":"16:50","13":"17:50","14":"18:50","15":"19:50","16":"20:50","17":"21:50","18":"22:50","19":"23:50","20":"24:50","21":"25:50"}. A key in the JSON string indicates the sequence number of a cycle. Valid values of keys: 1 to 288. A value in the JSON string indicates the time in point when a monitored instance times out in the relevant cycle. Values must be in the format of hh:mm. Valid values of hh: \\[0,47]. Valid values of mm: \\[0,59].'."\n"
+ .'* If the RemindType parameter is set to TIMEOUT, set this parameter to the timeout period. Unit: seconds. Example: 1800. This indicates that an alert notification is sent if the running duration of a monitored instance exceeds 30 minutes.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => '{"hour":23,"minu":59}',
+ ],
+ ],
+ [
+ 'name' => 'AlertUnit',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The recipient to whom alert notifications are sent. Valid values: OWNER and OTHER. The value OWNER indicates that alert notifications are sent to the object owner. The value OTHER indicates that alert notifications are sent to a specified user.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'OWNER',
+ 'default' => '',
+ 'enum' => [
+ 'OTHER',
+ 'OWNER',
+ ],
+ ],
+ ],
+ [
+ 'name' => 'AlertMethods',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The notification method. Valid values:'."\n"
+ ."\n"
+ .'* MAIL: Alert notifications are sent by email.'."\n"
+ .'* SMS: Alert notifications are sent by text message.'."\n"
+ .'* PHONE: Alert notifications are sent by phone call. You can use this notification method only in DataWorks Professional Edition or more advanced editions.'."\n"
+ .'* DINGROBOTS: Alert notifications are sent by DingTalk message. You can use this notification method only if the RobotUrls parameter is configured.'."\n"
+ .'* WEBHOOKS (WeCom or Lark chatbot): Alert notifications are sent by WeCom or Lark message. You can use this notification method only if the Webhooks parameter is configured.'."\n"
+ ."\n"
+ .'Multiple notification methods are separated by commas (,).'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'SMS,MAIL',
+ 'default' => '',
+ 'enum' => [],
+ ],
+ ],
+ [
+ 'name' => 'AlertTargets',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The value format required by this parameter varies based on the value that you specify for the AlertUnit parameter. Take note of the following items:'."\n"
+ ."\n"
+ .'* If the AlertUnit parameter is set to OWNER, leave this parameter empty.'."\n"
+ .'* If the AlertUnit parameter is set to OTHER, set this parameter to the unique ID (UID) of the specified user. You can specify multiple UIDs. Separate them with commas (,). A maximum of 10 UIDs can be specified for receiving alert notifications.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => '9527952795279527',
+ ],
+ ],
+ [
+ 'name' => 'UseFlag',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'Specifies whether to enable the alert rule. Valid values:'."\n"
+ ."\n"
+ .'* true'."\n"
+ .'* false'."\n",
+ 'type' => 'boolean',
+ 'required' => false,
+ 'example' => 'true',
+ ],
+ ],
+ [
+ 'name' => 'RobotUrls',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The webhook URL of the DingTalk chatbot. You can specify multiple webhook URLs. Separate multiple webhook URLs with commas (,). If this parameter is set to undefined, the specified webhook URLs are cleared.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'https://oapi.dingtalk.com/robot/send?access_token=******************************',
+ ],
+ ],
+ [
+ 'name' => 'Webhooks',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The webhook URL of the WeCom or Lark chatbot. You can specify multiple webhook URLs. Separate multiple webhook URLs with commas (,). The value of AlertMethods must include WEBHOOKS. If this parameter is set to undefined, the specified webhook URLs are cleared.'."\n"
+ ."\n"
+ .'Only DataWorks Enterprise Edition supports this parameter. The webhook URL-based alerting feature is supported in the following regions: China (Shanghai), China (Chengdu), China (Zhangjiakou), China (Beijing), China (Hangzhou), China (Shenzhen), China (Hong Kong), Germany (Frankfurt), and Singapore.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'https://open.feishu.cn/open-apis/bot/v2/hook/*******'."\n",
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'HttpStatusCode' => [
+ 'description' => 'The HTTP status code.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '200',
+ ],
+ 'Data' => [
+ 'description' => 'Indicates whether the modification to the custom alert rule succeeds.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message.'."\n",
+ 'type' => 'string',
+ 'example' => 'The specified parameters are invalid.',
+ ],
+ 'RequestId' => [
+ 'description' => 'The request ID. You can use the ID to troubleshoot issues.'."\n",
+ 'type' => 'string',
+ 'example' => '0000-ABCD-EFG****',
+ ],
+ 'Success' => [
+ 'description' => 'Indicates whether the request was successful. Valid values:'."\n"
+ ."\n"
+ .'* true'."\n"
+ .'* false'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code.'."\n",
+ 'type' => 'string',
+ 'example' => '1031203110005',
+ ],
+ ],
+ 'description' => '',
+ ],
+ ],
+ ],
+ 'errorCodes' => [
+ 429 => [
+ [
+ 'errorCode' => 'Throttling.Api',
+ 'errorMessage' => 'The request for this resource has exceeded your available limit.',
+ ],
+ [
+ 'errorCode' => 'Throttling.Api.Risk',
+ 'errorMessage' => 'The request for this resource has exceeded your daily available limit.',
+ ],
+ [
+ 'errorCode' => 'Throttling.Resource',
+ 'errorMessage' => 'You have reached the limit for the resource. Please contact us by submitting a ticket.',
+ ],
+ [
+ 'errorCode' => 'Throttling.System',
+ 'errorMessage' => 'The DataWorks system is busy. Try again later.',
+ ],
+ [
+ 'errorCode' => 'Throttling.User',
+ 'errorMessage' => 'Your request is too frequent. Try again later.',
+ ],
+ ],
+ 500 => [
+ [
+ 'errorCode' => 'Forbidden.Not.Server',
+ 'errorMessage' => 'The dataworksAPI service is not available in this area. Please try it in another area.',
+ ],
+ [
+ 'errorCode' => 'Forbidden.Wkbench.BaselineNoPermission',
+ 'errorMessage' => 'You are not authorized to access the baseline.',
+ ],
+ [
+ 'errorCode' => 'Forbidden.Wkbench.ProjectNoPermission',
+ 'errorMessage' => 'You are not authorized to access the workspace.',
+ ],
+ [
+ 'errorCode' => 'InternalError.System',
+ 'errorMessage' => 'An internal system error occurred. Try again later.',
+ ],
+ [
+ 'errorCode' => 'InternalError.UserId.Missing',
+ 'errorMessage' => 'An internal system error occurred. Try again later.',
+ ],
+ [
+ 'errorCode' => 'Forbidden.Wkbench.RemindNoPermission',
+ 'errorMessage' => 'You are not authorized to modify the reminder.',
+ ],
+ [
+ 'errorCode' => 'Invalid.Wkbench.RemindNotExist',
+ 'errorMessage' => 'The reminder does not exist.',
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Data\\": true,\\n \\"ErrorMessage\\": \\"The specified parameters are invalid.\\",\\n \\"RequestId\\": \\"0000-ABCD-EFG****\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"1031203110005\\"\\n}","errorExample":""},{"type":"xml","example":"<RequestId>0000-ABCD-EFG****</RequestId>\\n<HttpStatusCode>200</HttpStatusCode>\\n<Data>true</Data>\\n<ErrorCode>1031203110005</ErrorCode>\\n<ErrorMessage>The specified parameters are invalid.</ErrorMessage>\\n<Success>true</Success>","errorExample":""}]',
+ 'title' => 'UpdateRemind',
+ 'summary' => 'Modifies a custom alert rule.',
+ 'requestParamsDescription' => ' ',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ ],
+ 'CreateRemind' => [
+ 'methods' => [
+ 'post',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'write',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'create',
+ 'abilityTreeCode' => '78196',
+ 'abilityTreeNodes' => [
+ 'FEATUREdideRJGWWC',
+ ],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'RemindName',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The name of the custom alert rule. The name cannot exceed 128 characters in length.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'test_error_remind',
+ ],
+ ],
+ [
+ 'name' => 'DndEnd',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The end time of the quiet hours. Specify the time in the hh:mm format. Valid values of hh: \\[0,23]. Valid values of mm: \\[0,59].'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => '08:00',
+ ],
+ ],
+ [
+ 'name' => 'RemindUnit',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The type of the object to which the custom alert rule is applied. Valid values: NODE, BASELINE, PROJECT, and BIZPROCESS. The value NODE indicates a node. The value BASELINE indicates a baseline. The value PROJECT indicates a workspace. The value BIZPROCESS indicates a workflow.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'NODE',
+ 'enum' => [
+ 'NODE',
+ 'BASELINE',
+ 'PROJECT',
+ 'BIZPROCESS',
+ ],
+ ],
+ ],
+ [
+ 'name' => 'NodeIds',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The ID of the node to which the custom alert rule is applied. This parameter takes effect when the RemindUnit parameter is set to NODE. You can specify multiple IDs. Separate multiple IDs with commas (,). A maximum of 50 nodes can be specified for a custom alert rule.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => '1,2,3',
+ ],
+ ],
+ [
+ 'name' => 'BaselineIds',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The ID of the baseline to which the custom alert rule is applied. This parameter takes effect when the RemindUnit parameter is set to BASELINE. You can specify multiple IDs. Separate multiple IDs with commas (,). A maximum of five baselines can be specified for a custom alert rule.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => '1,2,3',
+ ],
+ ],
+ [
+ 'name' => 'ProjectId',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The ID of the workspace to which the custom alert rule is applied. This parameter takes effect when the RemindUnit parameter is set to PROJECT. You can specify only one workspace for a custom alert rule.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'example' => '9527',
+ ],
+ ],
+ [
+ 'name' => 'BizProcessIds',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The ID of the workflow to which the custom alert rule is applied. This parameter takes effect when the RemindUnit parameter is set to BIZPROCESS. You can specify multiple IDs. Separate multiple IDs with commas (,). A maximum of five workflows can be specified for a custom alert rule.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => '1,2,3',
+ ],
+ ],
+ [
+ 'name' => 'RemindType',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The conditions that trigger an alert. Valid values: FINISHED, UNFINISHED, ERROR, CYCLE_UNFINISHED, and TIMEOUT.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'FINISHED',
+ 'enum' => [
+ 'FINISHED',
+ 'UNFINISHED',
+ 'ERROR',
+ 'CYCLE_UNFINISHED',
+ 'TIMEOUT',
+ 'EXHAUSTED_ERROR',
+ ],
+ ],
+ ],
+ [
+ 'name' => 'MaxAlertTimes',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The maximum number of alerts. Valid values: 1 to 10. Default value: 3.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => false,
+ 'maximum' => '10',
+ 'minimum' => '1',
+ 'example' => '2',
+ 'default' => '3',
+ ],
+ ],
+ [
+ 'name' => 'AlertInterval',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The minimum interval at which alerts are reported. Unit: seconds. Minimum value: 1200. Default value: 1800.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => false,
+ 'minimum' => '1200',
+ 'example' => '1800',
+ 'default' => '1800',
+ ],
+ ],
+ [
+ 'name' => 'Detail',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The details of the conditions that trigger an alert.'."\n"
+ ."\n"
+ .'* If the RemindType parameter is set to FINISHED, leave this parameter empty.'."\n"
+ .'* If the RemindType parameter is set to UNFINISHED, configure this parameter as key-value pairs. Example: {"hour":23,"minu":59}. Valid values of hour: \\[0,47]. Valid values of minu: \\[0,59].'."\n"
+ .'* If the RemindType parameter is set to ERROR, leave this parameter empty.'."\n"
+ .'* If the RemindType parameter is set to CYCLE_UNFINISHED, configure this parameter as key-value pairs. Example: {"1":"05:50","2":"06:50","3":"07:50","4":"08:50","5":"09:50","6":"10:50","7":"11:50","8":"12:50","9":"13:50","10":"14:50","11":"15:50","12":"16:50","13":"17:50","14":"18:50","15":"19:50","16":"20:50","17":"21:50","18":"22:50","19":"23:50","20":"24:50","21":"25:50"}. The key indicates the ID of the cycle. Valid values: \\[1,288]. The value indicates the timeout period of the node that is running in the cycle. Specify the value in the hh:mm format. Valid values of hh: \\[0,47]. Valid values of mm: \\[0,59].'."\n"
+ .'* If the RemindType parameter is set to TIMEOUT, set this parameter to the timeout period. Unit: seconds. Example: 1800. This value indicates that an alert is reported if the node has run for more than 30 minutes.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => '{"hour":23,"minu":59}',
+ ],
+ ],
+ [
+ 'name' => 'AlertUnit',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The recipient of the alert. Valid values: OWNER and OTHER. The value OWNER indicates the node owner. The value OTHER indicates a specified user.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'OWNER',
+ 'default' => '',
+ 'enum' => [
+ 'OTHER',
+ 'OWNER',
+ ],
+ ],
+ ],
+ [
+ 'name' => 'AlertMethods',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The notification method. Valid values:'."\n"
+ ."\n"
+ .'* MAIL: Alert notifications are sent by email.'."\n"
+ .'* SMS: Alert notifications are sent by text message. Alert notifications can be sent by text message only in the Singapore, Malaysia (Kuala Lumpur), and Germany (Frankfurt) regions.'."\n"
+ .'* WEBHOOKS (WeCom or Lark chatbot): Alert notifications are sent by WeCom or Lark message. If you want to use this notification method, you must configure the Webhooks parameter.'."\n"
+ .'* DINGROBOTS: Alert notifications are sent by DingTalk chatbot.'."\n"
+ ."\n"
+ .'You can specify multiple notification methods. Separate them with commas (,).'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'SMS,MAIL',
+ ],
+ ],
+ [
+ 'name' => 'AlertTargets',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => '* If the AlertUnit parameter is set to OWNER, leave this parameter empty.'."\n"
+ .'* If the AlertUnit parameter is set to OTHER, set this parameter to the ID of the Alibaba Cloud account used by the specified user. You can specify multiple IDs. Separate multiple IDs with commas (,). You can specify a maximum of 10 IDs.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => '9527952795279527',
+ ],
+ ],
+ [
+ 'name' => 'RobotUrls',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The webhook URL of the DingTalk chatbot. You can specify multiple webhook URLs. Separate multiple webhook URLs with commas (,).'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'https://oapi.dingtalk.com/robot/send?access_token=******************************',
+ ],
+ ],
+ [
+ 'name' => 'Webhooks',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The webhook URL of the WeCom or Lark chatbot. You can specify multiple webhook URLs. Separate multiple webhook URLs with commas (,). You must specify WEBHOOKS for AlertMethods.'."\n"
+ ."\n"
+ .'Only DataWorks Enterprise Edition supports this parameter. The webhook URL-based alerting feature is supported in the following regions: China (Shanghai), China (Chengdu), China (Zhangjiakou), China (Beijing), China (Hangzhou), China (Shenzhen), China (Hong Kong), Germany (Frankfurt), and Singapore.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'https://open.feishu.cn/open-apis/bot/v2/hook/*******',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'description' => 'The response parameters.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'HttpStatusCode' => [
+ 'description' => 'The HTTP status code.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '200',
+ ],
+ 'Data' => [
+ 'description' => 'The ID of the custom alert rule.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '1234',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message.'."\n",
+ 'type' => 'string',
+ 'example' => 'The specified parameters are invalid.',
+ ],
+ 'RequestId' => [
+ 'description' => 'The request ID.'."\n",
+ 'type' => 'string',
+ 'example' => '0000-ABCD-EFG****',
+ ],
+ 'Success' => [
+ 'description' => 'Indicates whether the request was successful.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code.'."\n",
+ 'type' => 'string',
+ 'example' => '1031203110005',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'errorCodes' => [
+ 403 => [
+ [
+ 'errorCode' => 'Forbidden.Access',
+ 'errorMessage' => 'Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.',
+ ],
+ ],
+ 429 => [
+ [
+ 'errorCode' => 'Throttling.Api',
+ 'errorMessage' => 'The request for this resource has exceeded your available limit.',
+ ],
+ [
+ 'errorCode' => 'Throttling.Api.Risk',
+ 'errorMessage' => 'The request for this resource has exceeded your daily available limit.',
+ ],
+ [
+ 'errorCode' => 'Throttling.Resource',
+ 'errorMessage' => 'You have reached the limit for the resource. Please contact us by submitting a ticket.',
+ ],
+ [
+ 'errorCode' => 'Throttling.System',
+ 'errorMessage' => 'The DataWorks system is busy. Try again later.',
+ ],
+ [
+ 'errorCode' => 'Throttling.User',
+ 'errorMessage' => 'Your request is too frequent. Try again later.',
+ ],
+ ],
+ 500 => [
+ [
+ 'errorCode' => 'Forbidden.Not.Server',
+ 'errorMessage' => 'The dataworksAPI service is not available in this area. Please try it in another area.',
+ ],
+ [
+ 'errorCode' => 'Forbidden.Wkbench.BaselineNoPermission',
+ 'errorMessage' => 'You are not authorized to access the baseline.',
+ ],
+ [
+ 'errorCode' => 'Forbidden.Wkbench.ProjectNoPermission',
+ 'errorMessage' => 'You are not authorized to access the workspace.',
+ ],
+ [
+ 'errorCode' => 'InternalError.System',
+ 'errorMessage' => 'An internal system error occurred. Try again later.',
+ ],
+ [
+ 'errorCode' => 'InternalError.UserId.Missing',
+ 'errorMessage' => 'An internal system error occurred. Try again later.',
+ ],
+ [
+ 'errorCode' => 'Forbidden.Wkbench.NoProject',
+ 'errorMessage' => 'You have not joined any project.',
+ ],
+ [
+ 'errorCode' => 'Invalid.Wkbench.NodeNotExist',
+ 'errorMessage' => 'The node does not exist.',
+ ],
+ [
+ 'errorCode' => 'Invalid.Wkbench.BaselineNotExist',
+ 'errorMessage' => 'The baseline does not exist.',
+ ],
+ [
+ 'errorCode' => 'Forbidden.Wkbench.RemindOverlimit',
+ 'errorMessage' => 'The maximum number of reminders is exceeded.',
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Data\\": 1234,\\n \\"ErrorMessage\\": \\"The specified parameters are invalid.\\",\\n \\"RequestId\\": \\"0000-ABCD-EFG****\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"1031203110005\\"\\n}","errorExample":""},{"type":"xml","example":"<CreateRemindResponse>\\n <HttpStatusCode>200</HttpStatusCode>\\n <Data>1234</Data>\\n <ErrorMessage>The specified parameters are invalid.</ErrorMessage>\\n <RequestId>0000-ABCD-EFG****</RequestId>\\n <Success>true</Success>\\n <ErrorCode>1031203110005</ErrorCode>\\n</CreateRemindResponse>","errorExample":""}]',
+ 'title' => 'CreateRemind',
+ 'summary' => 'Creates a custom alert rule.',
+ 'requestParamsDescription' => ' ',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ ],
+ 'GetRemind' => [
+ 'methods' => [
+ 'post',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'get',
+ 'abilityTreeCode' => '78286',
+ 'abilityTreeNodes' => [
+ 'FEATUREdideRJGWWC',
+ ],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'RemindId',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The custom alert rule ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => '1234',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'description' => 'The response parameters.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'HttpStatusCode' => [
+ 'description' => 'The HTTP status code.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '200',
+ ],
+ 'RequestId' => [
+ 'description' => 'The request ID.'."\n",
+ 'type' => 'string',
+ 'example' => '0000-ABCD-EFGH-IJKLMNOPQ',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message.'."\n",
+ 'type' => 'string',
+ 'example' => 'The specified parameters are invalid.',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code.'."\n",
+ 'type' => 'string',
+ 'example' => '1031203110005',
+ ],
+ 'Success' => [
+ 'description' => 'Indicates whether the request was successful.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'Data' => [
+ 'description' => 'The details of the custom alert rule.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'MaxAlertTimes' => [
+ 'description' => 'The maximum number of alerts.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '3',
+ ],
+ 'RemindUnit' => [
+ 'description' => 'The type of the object to which the custom alert rule is applied. Valid values: NODE, BASELINE, PROJECT, and BIZPROCESS. The value NODE indicates a node. The value BASELINE indicates a baseline. The value PROJECT indicates a workspace. The value BIZPROCESS indicates a workflow.'."\n",
+ 'type' => 'string',
+ 'example' => 'NODE',
+ ],
+ 'AlertInterval' => [
+ 'description' => 'The minimum interval at which alerts are reported. Unit: seconds.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '1800',
+ ],
+ 'Useflag' => [
+ 'description' => 'Indicates whether the custom alert rule is enabled. Valid values: true and false.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'Founder' => [
+ 'description' => 'The ID of the Alibaba Cloud account used by the creator of the custom alert rule.'."\n",
+ 'type' => 'string',
+ 'example' => '9527951795****',
+ ],
+ 'RemindId' => [
+ 'description' => 'The custom alert rule ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '1234',
+ ],
+ 'DndEnd' => [
+ 'description' => 'The end time of the quiet hours. The value is in the hh:mm format. Valid values of hh: \\[0,23]. Valid values of mm: \\[0,59].'."\n",
+ 'type' => 'string',
+ 'example' => '08:00',
+ ],
+ 'RemindType' => [
+ 'description' => 'The conditions that trigger an alert. Valid values: FINISHED, UNFINISHED, ERROR, CYCLE_UNFINISHED, and TIMEOUT.'."\n",
+ 'type' => 'string',
+ 'example' => 'FINISHED',
+ ],
+ 'AlertUnit' => [
+ 'description' => 'The type of the alert recipient. For more information about alert recipient types, see the Receivers parameter. Valid values:'."\n"
+ ."\n"
+ .'* OWNER: the task owner'."\n"
+ .'* OTHER: specified personnel'."\n"
+ .'* SHIFT_SCHEDULE: personnel in a shift schedule'."\n",
+ 'type' => 'string',
+ 'example' => 'OWNER',
+ ],
+ 'DndStart' => [
+ 'description' => 'The start time of the quiet hours. The value is in the hh:mm format. Valid values of hh: \\[0,23]. Valid values of mm: \\[0,59].'."\n",
+ 'type' => 'string',
+ 'example' => '00:00',
+ ],
+ 'RemindName' => [
+ 'description' => 'The name of the rule.'."\n",
+ 'type' => 'string',
+ 'example' => 'Rule name',
+ ],
+ 'Detail' => [
+ 'description' => '* If the value of the RemindType parameter is FINISHED, this parameter is left empty.'."\n"
+ .'* If the value of the RemindType parameter is UNFINISHED, the trigger conditions are returned as key-value pairs. Example: {"hour":23,"minu":59}. Valid values of hour: \\[0,47]. Valid values of minu: \\[0,59].'."\n"
+ .'* If the value of the RemindType parameter is ERROR, this parameter is left empty.'."\n"
+ .'* If the value of the RemindType parameter is CYCLE_UNFINISHED, the trigger conditions are returned as key-value pairs. Example: {"1":"05:50","2":"06:50","3":"07:50","4":"08:50","5":"09:50","6":"10:50","7":"11:50","8":"12:50","9":"13:50","10":"14:50","11":"15:50","12":"16:50","13":"17:50","14":"18:50","15":"19:50","16":"20:50","17":"21:50","18":"22:50","19":"23:50","20":"24:50","21":"25:50"}. The key indicates the ID of the cycle. Valid values: \\[1,288]. The value indicates the timeout period of the node that is running in the cycle. Specify the value in the hh:mm format. Valid values of hh: \\[0,47]. Valid values of mm: \\[0,59].'."\n"
+ .'* If the value of the RemindType parameter is TIMEOUT, the timeout period is returned. Unit: seconds. Example: 1800. This value indicates that an alert is reported if the node has run for more than 30 minutes.'."\n",
+ 'type' => 'string',
+ 'example' => '{"hour":23,"minu":59}',
+ ],
+ 'Robots' => [
+ 'description' => 'The webhook URLs of the DingTalk chatbots.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '',
+ 'type' => 'object',
+ 'properties' => [
+ 'WebUrl' => [
+ 'description' => 'The webhook URL of the DingTalk chatbot.'."\n",
+ 'type' => 'string',
+ 'example' => 'https://oapi.dingtalk.com/robot/send?access_token=******************************',
+ ],
+ 'AtAll' => [
+ 'description' => 'Indicates whether all group members are notified when the alert notification is sent to a DingTalk group. Valid values: true and false.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ ],
+ ],
+ ],
+ 'Nodes' => [
+ 'description' => 'The nodes to which the custom alert rule is applied. This parameter is returned if the value of the RemindUnit parameter is NODE.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '',
+ 'type' => 'object',
+ 'properties' => [
+ 'Owner' => [
+ 'description' => 'The ID of the Alibaba Cloud account used by the node owner.'."\n",
+ 'type' => 'string',
+ 'example' => '9527951795****',
+ ],
+ 'NodeName' => [
+ 'description' => 'The name of the node.'."\n",
+ 'type' => 'string',
+ 'example' => 'Node name',
+ ],
+ 'NodeId' => [
+ 'description' => 'The node ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '1234',
+ ],
+ 'ProjectId' => [
+ 'description' => 'The ID of the workspace to which the node belongs.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '1234',
+ ],
+ ],
+ ],
+ ],
+ 'Baselines' => [
+ 'description' => 'The baselines to which the custom alert rule is applied. This parameter is returned if the value of the RemindUnit parameter is BASELINE.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '',
+ 'type' => 'object',
+ 'properties' => [
+ 'BaselineName' => [
+ 'description' => 'The name of the baseline.'."\n",
+ 'type' => 'string',
+ 'example' => 'Baseline name',
+ ],
+ 'BaselineId' => [
+ 'description' => 'The baseline ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '1234',
+ ],
+ ],
+ ],
+ ],
+ 'Projects' => [
+ 'description' => 'The workspaces to which the custom alert rule is applied. This parameter is returned if the value of the RemindUnit parameter is PROJECT.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '',
+ 'type' => 'object',
+ 'properties' => [
+ 'ProjectId' => [
+ 'description' => 'The workspace ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '1234',
+ ],
+ ],
+ ],
+ ],
+ 'BizProcesses' => [
+ 'description' => 'The workflows to which the custom alert rule is applied. This parameter is returned if the value of the RemindUnit parameter is BIZPROCESS.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '',
+ 'type' => 'object',
+ 'properties' => [
+ 'BizProcessName' => [
+ 'description' => 'The name of the workflow.'."\n",
+ 'type' => 'string',
+ 'example' => 'Business process name',
+ ],
+ 'BizId' => [
+ 'description' => 'The ID of the workflow.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '9527',
+ ],
+ ],
+ ],
+ ],
+ 'AlertTargets' => [
+ 'description' => 'The description of the alert recipient. For more information about alert recipients, see the Receivers parameter.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '* If the value of the AlertUnit parameter is OWNER, this parameter is left empty.'."\n"
+ .'* If the value of the AlertUnit parameter is OTHER, the ID of the Alibaba Cloud account used by the specified user is returned.'."\n"
+ .'* If the value of the AlertUnit parameter is SHIFT_SCHEDULE, the shift schedule ID is returned.'."\n",
+ 'type' => 'string',
+ 'example' => '9527952795279527',
+ ],
+ ],
+ 'AlertMethods' => [
+ 'description' => 'The notification method.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The notification method. Valid values:'."\n"
+ ."\n"
+ .'* MAIL'."\n"
+ .'* SMS'."\n"
+ .'* Alert notifications can be sent by text message only in the Singapore, Malaysia (Kuala Lumpur), and Germany (Frankfurt) regions.'."\n",
+ 'type' => 'string',
+ 'example' => 'SMS,MAIL',
+ ],
+ ],
+ 'Webhooks' => [
+ 'description' => 'WebHook URL'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The webhook URL of the WeCom or Lark chatbot. You must specify Webhooks for AlertMethods. Only DataWorks Enterprise Edition supports this parameter.'."\n",
+ 'type' => 'string',
+ 'example' => 'https://open.feishu.cn/open-apis/bot/v2/hook/*******',
+ ],
+ ],
+ 'Receivers' => [
+ 'description' => 'The information about the alert recipients.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The information about the alert recipient.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'AlertUnit' => [
+ 'description' => 'The type of the alert recipient. For more information about alert recipients, see the Receivers parameter. Valid values:'."\n"
+ ."\n"
+ .'* OWNER: indicate the task owner.'."\n"
+ .'* OTHER: indicates specified personnel.'."\n"
+ .'* SHIFT_SCHEDULE: indicates personnel in a shift schedule.'."\n",
+ 'type' => 'string',
+ 'example' => 'OWNER',
+ ],
+ 'AlertTargets' => [
+ 'description' => 'The alert recipient.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '* If the value of the AlertUnit parameter is OWNER, this parameter is left empty.'."\n"
+ .'* If the value of the AlertUnit parameter is OTHER, the ID of the Alibaba Cloud account used by the specified user is returned.'."\n"
+ .'* If the value of the AlertUnit parameter is SHIFT_SCHEDULE, the shift schedule ID is returned.'."\n",
+ 'type' => 'string',
+ 'example' => '9527952795279527',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'AllowNodes' => [
+ 'description' => 'The IDs of the nodes that are added to a whitelist.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The ID of the node that is added to a whitelist. The nodes that you add to the whitelist are not monitored.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '123',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'errorCodes' => [
+ 403 => [
+ [
+ 'errorCode' => 'Forbidden.Access',
+ 'errorMessage' => 'Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.',
+ ],
+ ],
+ 429 => [
+ [
+ 'errorCode' => 'Throttling.Api',
+ 'errorMessage' => 'The request for this resource has exceeded your available limit.',
+ ],
+ [
+ 'errorCode' => 'Throttling.Api.Risk',
+ 'errorMessage' => 'The request for this resource has exceeded your daily available limit.',
+ ],
+ [
+ 'errorCode' => 'Throttling.Resource',
+ 'errorMessage' => 'You have reached the limit for the resource. Please contact us by submitting a ticket.',
+ ],
+ [
+ 'errorCode' => 'Throttling.System',
+ 'errorMessage' => 'The DataWorks system is busy. Try again later.',
+ ],
+ [
+ 'errorCode' => 'Throttling.User',
+ 'errorMessage' => 'Your request is too frequent. Try again later.',
+ ],
+ ],
+ 500 => [
+ [
+ 'errorCode' => 'Forbidden.Not.Server',
+ 'errorMessage' => 'The dataworksAPI service is not available in this area. Please try it in another area.',
+ ],
+ [
+ 'errorCode' => 'InternalError.System',
+ 'errorMessage' => 'An internal system error occurred. Try again later.',
+ ],
+ [
+ 'errorCode' => 'InternalError.UserId.Missing',
+ 'errorMessage' => 'An internal system error occurred. Try again later.',
+ ],
+ ],
+ ],
+ 'eventInfo' => [
+ 'enable' => false,
+ 'eventNames' => [],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"0000-ABCD-EFGH-IJK****\\",\\n \\"ErrorMessage\\": \\"The specified parameters are invalid.\\",\\n \\"ErrorCode\\": \\"1031203110005\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"MaxAlertTimes\\": 3,\\n \\"RemindUnit\\": \\"NODE\\",\\n \\"AlertInterval\\": 1800,\\n \\"Useflag\\": true,\\n \\"Founder\\": \\"9527951795****\\",\\n \\"RemindId\\": 1234,\\n \\"DndEnd\\": \\"08:00\\",\\n \\"RemindType\\": \\"FINISHED\\",\\n \\"AlertUnit\\": \\"OWNER\\",\\n \\"DndStart\\": \\"00:00\\",\\n \\"RemindName\\": \\"Rule name\\",\\n \\"Detail\\": \\"{\\\\\\"hour\\\\\\":23,\\\\\\"minu\\\\\\":59}\\",\\n \\"Robots\\": [\\n {\\n \\"WebUrl\\": \\"https://oapi.dingtalk.com/robot/send?access_token=******************************\\",\\n \\"AtAll\\": true\\n }\\n ],\\n \\"Nodes\\": [\\n {\\n \\"Owner\\": \\"9527951795****\\",\\n \\"NodeName\\": \\"Node name\\",\\n \\"NodeId\\": 1234,\\n \\"ProjectId\\": 1234\\n }\\n ],\\n \\"Baselines\\": [\\n {\\n \\"BaselineName\\": \\"Baseline name\\",\\n \\"BaselineId\\": 1234\\n }\\n ],\\n \\"Projects\\": [\\n {\\n \\"ProjectId\\": 1234\\n }\\n ],\\n \\"BizProcesses\\": [\\n {\\n \\"BizProcessName\\": \\"Business process name\\",\\n \\"BizId\\": 9527\\n }\\n ],\\n \\"AlertTargets\\": [\\n \\"9527952795279527\\"\\n ],\\n \\"AlertMethods\\": [\\n \\"SMS,MAIL\\"\\n ],\\n \\"Webhooks\\": [\\n \\"https://open.feishu.cn/open-apis/bot/v2/hook/*******\\"\\n ],\\n \\"Receivers\\": [\\n {\\n \\"AlertUnit\\": \\"OWNER\\",\\n \\"AlertTargets\\": [\\n \\"9527952795279527\\"\\n ]\\n }\\n ],\\n \\"AllowNodes\\": [\\n 123\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<GetRemindResponse>\\n <HttpStatusCode>200</HttpStatusCode>\\n <RequestId>0000-ABCD-EFGH-IJKLMNOPQ</RequestId>\\n <ErrorMessage>The specified parameters are invalid.</ErrorMessage>\\n <ErrorCode>1031203110005</ErrorCode>\\n <Success>true</Success>\\n <Data>\\n <MaxAlertTimes>3</MaxAlertTimes>\\n <RemindUnit>NODE</RemindUnit>\\n <AlertInterval>1800</AlertInterval>\\n <Useflag>true</Useflag>\\n <Founder>9527951795****</Founder>\\n <RemindId>1234</RemindId>\\n <DndEnd>08:00</DndEnd>\\n <RemindType>FINISHED</RemindType>\\n <AlertUnit>OWNER</AlertUnit>\\n <DndStart>00:00</DndStart>\\n <RemindName>规则名称</RemindName>\\n <Detail>{\\"hour\\":23,\\"minu\\":59}</Detail>\\n <Robots>\\n <WebUrl>https://oapi.dingtalk.com/robot/send?access_token=******************************</WebUrl>\\n <AtAll>true</AtAll>\\n </Robots>\\n <Nodes>\\n <Owner>9527951795****</Owner>\\n <NodeName>节点名称</NodeName>\\n <NodeId>1234</NodeId>\\n <ProjectId>1234</ProjectId>\\n </Nodes>\\n <Baselines>\\n <BaselineName>基线名称</BaselineName>\\n <BaselineId>1234</BaselineId>\\n </Baselines>\\n <Projects>\\n <ProjectId>1234</ProjectId>\\n </Projects>\\n <BizProcesses>\\n <BizProcessName>业务流程名称</BizProcessName>\\n <BizId>9527</BizId>\\n </BizProcesses>\\n <AlertTargets>9527952795279527</AlertTargets>\\n <AlertMethods>SMS,MAIL</AlertMethods>\\n <Webhooks>https://open.feishu.cn/open-apis/bot/v2/hook/*******</Webhooks>\\n </Data>\\n</GetRemindResponse>","errorExample":""}]',
+ 'title' => 'GetRemind',
+ 'summary' => 'Queries the information about a custom alert rule.',
+ 'description' => '## Debugging'."\n"
+ ."\n"
+ .'[OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.](https://api.aliyun.com/#product=dataworks-public\\&api=GetRemind\\&type=RPC\\&version=2020-05-18)'."\n",
+ 'requestParamsDescription' => ' ',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ ],
+ 'ListReminds' => [
+ 'methods' => [
+ 'post',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'list',
+ 'abilityTreeCode' => '78333',
+ 'abilityTreeNodes' => [
+ 'FEATUREdideRJGWWC',
+ ],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'PageNumber',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The number of the page to return. Valid values: 1 to 30. Default value: 1.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => '1',
+ ],
+ ],
+ [
+ 'name' => 'PageSize',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The number of entries to return on each page. Default value: 10. Maximum value: 100.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => '10',
+ ],
+ ],
+ [
+ 'name' => 'Founder',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The ID of the Alibaba Cloud account that is used to create the custom alert rules.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => '9527952795****',
+ ],
+ ],
+ [
+ 'name' => 'NodeId',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The ID of the node to which the custom alert rules are applied. You can use the ID to search for the custom alert rules that are applied to the node.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'example' => '1234',
+ ],
+ ],
+ [
+ 'name' => 'RemindTypes',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The conditions that trigger an alert for the node. Valid values: FINISHED, UNFINISHED, ERROR, CYCLE_UNFINISHED, and TIMEOUT. The value FINISHED indicates that the node finishes running. The value UNFINISHED indicates that the node is still running at the specified point in time. The value ERROR indicates that an error occurs when the node is running. The value CYCLE_UNFINISHED indicates that the node does not finish running in the specified scheduling cycle. The value TIMEOUT indicates that the node times out. You can specify multiple conditions for a custom alert rule. If you specify multiple condition, separate them with commas (,).'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'FINISHED,ERROR',
+ ],
+ ],
+ [
+ 'name' => 'AlertTarget',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The ID of the Alibaba Cloud account that is used to receive alert notifications.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => '9527952795****',
+ ],
+ ],
+ [
+ 'name' => 'SearchText',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The keyword in a rule name that is used to search for the rule. Fuzzy search is supported.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'Keyword',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'headers' => [],
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'HttpStatusCode' => [
+ 'description' => 'The HTTP status code returned.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '200',
+ ],
+ 'RequestId' => [
+ 'description' => 'The ID of the request. You can use the ID to troubleshoot issues.'."\n",
+ 'type' => 'string',
+ 'example' => '0000-ABCD-EFG****',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message returned.'."\n",
+ 'type' => 'string',
+ 'example' => 'The specified parameters are invalid.',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code returned.'."\n",
+ 'type' => 'string',
+ 'example' => '1031203110005',
+ ],
+ 'Success' => [
+ 'description' => 'Indicates whether the request was successful.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'Data' => [
+ 'description' => 'The data returned.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'PageNumber' => [
+ 'description' => 'The page number of the returned page.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '1',
+ ],
+ 'PageSize' => [
+ 'description' => 'The number of entries returned per page.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '10',
+ ],
+ 'TotalCount' => [
+ 'description' => 'The total number of custom alert rules returned.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '100',
+ ],
+ 'Reminds' => [
+ 'description' => 'The list of custom alert rules.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '',
+ 'type' => 'object',
+ 'properties' => [
+ 'Founder' => [
+ 'description' => 'The ID of the Alibaba Cloud account used by the rule creator.'."\n",
+ 'type' => 'string',
+ 'example' => '952795****',
+ ],
+ 'RemindId' => [
+ 'description' => 'The custom alert rule ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '1234',
+ ],
+ 'AlertUnit' => [
+ 'description' => 'The alert recipient. Valid values: OWNER and OTHER. The value OWNER indicates the node owner. The value OTHER indicates a specified user.'."\n",
+ 'type' => 'string',
+ 'example' => 'OWNER',
+ ],
+ 'RemindType' => [
+ 'description' => 'The condition that triggers an alert. Valid values: FINISHED, UNFINISHED, ERROR, CYCLE_UNFINISHED, and TIMEOUT.'."\n",
+ 'type' => 'string',
+ 'example' => 'FINISHED',
+ ],
+ 'DndEnd' => [
+ 'description' => 'The end time of the quiet hours. The time is in the hh:mm format. Valid values of hh: \\[0,23]. Valid values of mm: \\[0,59].'."\n",
+ 'type' => 'string',
+ 'example' => '08:00',
+ ],
+ 'DndStart' => [
+ 'description' => 'The start time of the quiet hours. The time is in the hh:mm format. Valid values of hh: \\[0,23]. Valid values of mm: \\[0,59].'."\n",
+ 'type' => 'string',
+ 'example' => '00:00',
+ ],
+ 'RemindUnit' => [
+ 'description' => 'The type of the object to which the custom alert rule is applied. Valid values: NODE, BASELINE, PROJECT, and BIZPROCESS. The value NODE indicates a node. The value BASELINE indicates a baseline. The value PROJECT indicates a workspace. The value BIZPROCESS indicates a workflow.'."\n",
+ 'type' => 'string',
+ 'example' => 'NODE',
+ ],
+ 'Useflag' => [
+ 'description' => 'Indicates whether the custom alert rule is enabled. Valid values: true and false.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'RemindName' => [
+ 'description' => 'The name of the custom alert rule.'."\n",
+ 'type' => 'string',
+ 'example' => 'Alert Rule',
+ ],
+ 'AlertTargets' => [
+ 'description' => 'The IDs of the Alibaba Cloud accounts used by alert recipients.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The ID of the Alibaba Cloud account used by the alert recipient.'."\n",
+ 'type' => 'string',
+ 'example' => '952795****',
+ ],
+ ],
+ 'NodeIds' => [
+ 'description' => 'The IDs of the nodes to which the custom alert rule is applied. This parameter is returned if the value of the RemindUnit parameter is NODE.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The ID of the node to which the custom alert rule is applied. This parameter is returned if the value of the RemindUnit parameter is NODE.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '1234',
+ ],
+ ],
+ 'BizProcessIds' => [
+ 'description' => 'The IDs of the workflows to which the custom alert rule is applied. This parameter is returned if the value of the RemindUnit parameter is BIZPROCESS.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The ID of the workflow to which the custom alert rule is applied. This parameter is returned if the value of the RemindUnit parameter is BIZPROCESS.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '9527',
+ ],
+ ],
+ 'ProjectIds' => [
+ 'description' => 'The IDs of the workspaces to which the custom alert rule is applied. This parameter is returned if the value of the RemindUnit parameter is PROJECT.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The ID of the workspace to which the custom alert rule is applied. This parameter is returned if the value of the RemindUnit parameter is PROJECT.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '1234',
+ ],
+ ],
+ 'BaselineIds' => [
+ 'description' => 'The IDs of the baselines to which the custom alert rule is applied. This parameter is returned if the value of the RemindUnit parameter is BASELINE.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The ID of the baseline to which the custom alert rule is applied. This parameter is returned if the value of the RemindUnit parameter is BASELINE.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '9527',
+ ],
+ ],
+ 'AlertMethods' => [
+ 'description' => 'The notification method. Valid values: MAIL, SMS, and PHONE. The value MAIL indicates that the notification is sent by email. Only DataWorks Professional Edition and more advanced editions support the PHONE notification method.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The notification method. Valid values: MAIL, SMS, and PHONE. The value MAIL indicates that the notification is sent by email. Only DataWorks Professional Edition and more advanced editions support the PHONE notification method.'."\n",
+ 'type' => 'string',
+ 'example' => 'SMS',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'description' => '',
+ ],
+ ],
+ ],
+ 'errorCodes' => [
+ 403 => [
+ [
+ 'errorCode' => 'Forbidden.Access',
+ 'errorMessage' => 'Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.',
+ ],
+ ],
+ 429 => [
+ [
+ 'errorCode' => 'Throttling.Api',
+ 'errorMessage' => 'The request for this resource has exceeded your available limit.',
+ ],
+ [
+ 'errorCode' => 'Throttling.Api.Risk',
+ 'errorMessage' => 'The request for this resource has exceeded your daily available limit.',
+ ],
+ [
+ 'errorCode' => 'Throttling.System',
+ 'errorMessage' => 'The DataWorks system is busy. Try again later.',
+ ],
+ [
+ 'errorCode' => 'Throttling.User',
+ 'errorMessage' => 'Your request is too frequent. Try again later.',
+ ],
+ ],
+ 500 => [
+ [
+ 'errorCode' => 'Forbidden.Not.Server',
+ 'errorMessage' => 'The dataworksAPI service is not available in this area. Please try it in another area.',
+ ],
+ [
+ 'errorCode' => 'InternalError.System',
+ 'errorMessage' => 'An internal system error occurred. Try again later.',
+ ],
+ [
+ 'errorCode' => 'InternalError.UserId.Missing',
+ 'errorMessage' => 'An internal system error occurred. Try again later.',
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"0000-ABCD-EFG****\\",\\n \\"ErrorMessage\\": \\"The specified parameters are invalid.\\",\\n \\"ErrorCode\\": \\"1031203110005\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 100,\\n \\"Reminds\\": [\\n {\\n \\"Founder\\": \\"952795****\\",\\n \\"RemindId\\": 1234,\\n \\"AlertUnit\\": \\"OWNER\\",\\n \\"RemindType\\": \\"FINISHED\\",\\n \\"DndEnd\\": \\"08:00\\",\\n \\"DndStart\\": \\"00:00\\",\\n \\"RemindUnit\\": \\"NODE\\",\\n \\"Useflag\\": true,\\n \\"RemindName\\": \\"规则名称\\",\\n \\"AlertTargets\\": [\\n \\"952795****\\"\\n ],\\n \\"NodeIds\\": [\\n 1234\\n ],\\n \\"BizProcessIds\\": [\\n 9527\\n ],\\n \\"ProjectIds\\": [\\n 1234\\n ],\\n \\"BaselineIds\\": [\\n 9527\\n ],\\n \\"AlertMethods\\": [\\n \\"SMS\\"\\n ]\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<ListRemindsResponse>\\n <HttpStatusCode>200</HttpStatusCode>\\n <RequestId>0000-ABCD-EFG****</RequestId>\\n <ErrorMessage>The specified parameters are invalid.</ErrorMessage>\\n <ErrorCode>1031203110005</ErrorCode>\\n <Success>true</Success>\\n <Data>\\n <PageNumber>1</PageNumber>\\n <PageSize>10</PageSize>\\n <TotalCount>100</TotalCount>\\n <Reminds>\\n <Founder>952795****</Founder>\\n <RemindId>1234</RemindId>\\n <AlertUnit>OWNER</AlertUnit>\\n <RemindType>FINISHED</RemindType>\\n <DndEnd>08:00</DndEnd>\\n <DndStart>00:00</DndStart>\\n <RemindUnit>NODE</RemindUnit>\\n <Useflag>true</Useflag>\\n <RemindName>规则名称</RemindName>\\n <AlertTargets>952795****</AlertTargets>\\n <NodeIds>1234</NodeIds>\\n <BizProcessIds>9527</BizProcessIds>\\n <ProjectIds>1234</ProjectIds>\\n <BaselineIds>9527</BaselineIds>\\n <AlertMethods>SMS</AlertMethods>\\n </Reminds>\\n </Data>\\n</ListRemindsResponse>","errorExample":""}]',
+ 'title' => 'ListReminds',
+ 'summary' => 'Queries a list of custom alert rules.',
+ 'requestParamsDescription' => ' ',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ ],
+ 'ListTopics' => [
+ 'methods' => [
+ 'post',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'get',
+ 'abilityTreeCode' => '78338',
+ 'abilityTreeNodes' => [
+ 'FEATUREdideSFSFU4',
+ ],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'BeginTime',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The beginning of the time range to query. Specify the time in the ISO 8601 standard in the yyyy-MM-dd\'T\'HH:mm:ssZ format. The time must be in UTC.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => '2019-03-24T00:00:00+0800',
+ ],
+ ],
+ [
+ 'name' => 'EndTime',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The end of the time range to query. Specify the time in the ISO 8601 standard in the yyyy-MM-dd\'T\'HH:mm:ssZ format. The time must be in UTC.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => '2019-03-25T23:00:00+0800',
+ ],
+ ],
+ [
+ 'name' => 'TopicTypes',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The types of the events. Valid values: SLOW and ERROR. The value SLOW indicates that the running duration of the node in the current scheduling cycle is significantly longer than the average running duration of the node in previous scheduling cycles. The value ERROR indicates that the node fails to run. You can specify multiple types. Separate them with commas (,).'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'ERROR,SLOW',
+ ],
+ ],
+ [
+ 'name' => 'TopicStatuses',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The status of the events. Valid values: IGNORE, NEW, FIXING, and RECOVER. The value IGNORE indicates that the events are ignored. The value NEW indicates that the events are new events. The value FIXING indicates that the events are being processed. The value RECOVER indicates that the events are processed. You can specify multiple states. Separate them with commas (,).'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'IGNORE,NEW,FIXING,RECOVER',
+ ],
+ ],
+ [
+ 'name' => 'NodeId',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The ID of the node that triggers the events. You can configure either this parameter or the InstanceId parameter.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'example' => '1234',
+ ],
+ ],
+ [
+ 'name' => 'InstanceId',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The ID of the node instance that triggers the events. You can configure either this parameter or the NodeId parameter.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'example' => '12345',
+ ],
+ ],
+ [
+ 'name' => 'Owner',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The ID of the Alibaba Cloud account used by the owner of the events.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => '952795****',
+ ],
+ ],
+ [
+ 'name' => 'PageNumber',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The number of the page to return. Valid values: 1 to 30. Default value: 1.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => true,
+ 'docRequired' => true,
+ 'maximum' => '30',
+ 'minimum' => '1',
+ 'example' => '1',
+ 'default' => '',
+ ],
+ ],
+ [
+ 'name' => 'PageSize',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The number of entries to return on each page. Default value: 10. Maximum value: 100.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => true,
+ 'docRequired' => true,
+ 'maximum' => '100',
+ 'minimum' => '1',
+ 'example' => '10',
+ 'default' => '',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'headers' => [],
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'HttpStatusCode' => [
+ 'description' => 'The HTTP status code returned.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '200',
+ ],
+ 'RequestId' => [
+ 'description' => 'The ID of the request. You can use the ID to troubleshoot issues.'."\n",
+ 'type' => 'string',
+ 'example' => '0000-ABCD-EFG****',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message returned.'."\n",
+ 'type' => 'string',
+ 'example' => 'The specified parameters are invalid.',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code returned.'."\n",
+ 'type' => 'string',
+ 'example' => '1031203110005',
+ ],
+ 'Success' => [
+ 'description' => 'Indicates whether the request was successful.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'Data' => [
+ 'description' => 'The information about the events returned.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'PageNumber' => [
+ 'description' => 'The page number of the returned page.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '1',
+ ],
+ 'PageSize' => [
+ 'description' => 'The number of entries returned per page.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '10',
+ ],
+ 'TotalCount' => [
+ 'description' => 'The total number of the events returned.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '100',
+ ],
+ 'Topics' => [
+ 'description' => 'The events returned.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'TopicName' => [
+ 'description' => 'The name of the event.'."\n",
+ 'type' => 'string',
+ 'example' => '1234 Error',
+ ],
+ 'ProjectId' => [
+ 'description' => 'The ID of the workspace to which the node belongs.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '1234',
+ ],
+ 'NodeOwner' => [
+ 'description' => 'The ID of the Alibaba Cloud account that is used by the node owner.'."\n",
+ 'type' => 'string',
+ 'example' => '952795****',
+ ],
+ 'InstanceId' => [
+ 'description' => 'The ID of the node instance that triggers the event.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '12345',
+ ],
+ 'FixTime' => [
+ 'description' => 'The timestamp when the event was processed.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '1553508465000',
+ ],
+ 'TopicType' => [
+ 'description' => 'The type of the event. Valid values: SLOW and ERROR. The value SLOW indicates that the running duration of the node in the current scheduling cycle is significantly longer than the average running duration of the node in previous scheduling cycles. The value ERROR indicates that the node fails to run.'."\n",
+ 'type' => 'string',
+ 'example' => 'ERROR',
+ ],
+ 'TopicStatus' => [
+ 'description' => 'The status of the event. Valid values: IGNORE, NEW, FIXING, and RECOVER. The value IGNORE indicates that the event is ignored. The value NEW indicates that the event is a new event. The value FIXING indicates that the event is being processed. The value RECOVER indicates that the event is processed.'."\n",
+ 'type' => 'string',
+ 'example' => 'NEW',
+ ],
+ 'HappenTime' => [
+ 'description' => 'The timestamp when the event occurred. A time difference may exist between the time when the event occurred and the time when the event was found.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '1553508465000',
+ ],
+ 'NodeName' => [
+ 'description' => 'The name of the node.'."\n",
+ 'type' => 'string',
+ 'example' => 'Node Name'."\n",
+ ],
+ 'TopicId' => [
+ 'description' => 'The ID of the event.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '1234',
+ ],
+ 'AddTime' => [
+ 'description' => 'The timestamp when the event was found.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '1553524393000',
+ ],
+ 'NodeId' => [
+ 'description' => 'The ID of the node that triggers the event.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '1234',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'errorCodes' => [
+ 403 => [
+ [
+ 'errorCode' => 'Forbidden.Access',
+ 'errorMessage' => 'Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.',
+ ],
+ ],
+ 429 => [
+ [
+ 'errorCode' => 'Throttling.Api',
+ 'errorMessage' => 'The request for this resource has exceeded your available limit.',
+ ],
+ [
+ 'errorCode' => 'Throttling.Api.Risk',
+ 'errorMessage' => 'The request for this resource has exceeded your daily available limit.',
+ ],
+ [
+ 'errorCode' => 'Throttling.System',
+ 'errorMessage' => 'The DataWorks system is busy. Try again later.',
+ ],
+ [
+ 'errorCode' => 'Throttling.User',
+ 'errorMessage' => 'Your request is too frequent. Try again later.',
+ ],
+ ],
+ 500 => [
+ [
+ 'errorCode' => 'Forbidden.Not.Server',
+ 'errorMessage' => 'The dataworksAPI service is not available in this area. Please try it in another area.',
+ ],
+ [
+ 'errorCode' => 'InternalError.System',
+ 'errorMessage' => 'An internal system error occurred. Try again later.',
+ ],
+ [
+ 'errorCode' => 'InternalError.UserId.Missing',
+ 'errorMessage' => 'An internal system error occurred. Try again later.',
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"0000-ABCD-EFG****\\",\\n \\"ErrorMessage\\": \\"The specified parameters are invalid.\\",\\n \\"ErrorCode\\": \\"1031203110005\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 100,\\n \\"Topics\\": [\\n {\\n \\"TopicName\\": \\"1234出错\\",\\n \\"ProjectId\\": 1234,\\n \\"NodeOwner\\": \\"952795****\\",\\n \\"InstanceId\\": 12345,\\n \\"FixTime\\": 1553508465000,\\n \\"TopicType\\": \\"ERROR\\",\\n \\"TopicStatus\\": \\"NEW\\",\\n \\"HappenTime\\": 1553508465000,\\n \\"NodeName\\": \\"节点名称\\",\\n \\"TopicId\\": 1234,\\n \\"AddTime\\": 1553524393000,\\n \\"NodeId\\": 1234\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<ListTopicsResponse>\\n <HttpStatusCode>200</HttpStatusCode>\\n <RequestId>0000-ABCD-EFG****</RequestId>\\n <ErrorMessage>The specified parameters are invalid.</ErrorMessage>\\n <ErrorCode>1031203110005</ErrorCode>\\n <Success>true</Success>\\n <Data>\\n <PageNumber>1</PageNumber>\\n <PageSize>10</PageSize>\\n <TotalCount>100</TotalCount>\\n <Topics>\\n <TopicName>1234出错</TopicName>\\n <ProjectId>1234</ProjectId>\\n <NodeOwner>952795****</NodeOwner>\\n <InstanceId>12345</InstanceId>\\n <FixTime>1553508465000</FixTime>\\n <TopicType>ERROR</TopicType>\\n <TopicStatus>NEW</TopicStatus>\\n <HappenTime>1553508465000</HappenTime>\\n <NodeName>节点名称</NodeName>\\n <TopicId>1234</TopicId>\\n <AddTime>1553524393000</AddTime>\\n <NodeId>1234</NodeId>\\n </Topics>\\n </Data>\\n</ListTopicsResponse>","errorExample":""}]',
+ 'title' => 'ListTopics',
+ 'summary' => 'Queries events.',
+ 'requestParamsDescription' => ' ',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ ],
+ 'GetTopic' => [
+ 'methods' => [
+ 'post',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'get',
+ 'abilityTreeCode' => '78289',
+ 'abilityTreeNodes' => [
+ 'FEATUREdideSFSFU4',
+ ],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'TopicId',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The event ID. You can call the [ListTopics](~~173973~~) operation to query the ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => '1234',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'headers' => [],
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'HttpStatusCode' => [
+ 'description' => 'The HTTP status code.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '200',
+ ],
+ 'RequestId' => [
+ 'description' => 'The request ID.'."\n",
+ 'type' => 'string',
+ 'example' => '0000-ABCD-EFGH-IJKLMNOPQ',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message.'."\n",
+ 'type' => 'string',
+ 'example' => 'The specified parameters are invalid.',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code.'."\n",
+ 'type' => 'string',
+ 'example' => '1031203110005',
+ ],
+ 'Success' => [
+ 'description' => 'Indicates whether the request was successful.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'Data' => [
+ 'description' => 'The details of the event.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'Owner' => [
+ 'description' => 'The ID of the Alibaba Cloud account used by the event owner.'."\n",
+ 'type' => 'string',
+ 'example' => '952795****',
+ ],
+ 'TopicName' => [
+ 'description' => 'The name of the event.'."\n",
+ 'type' => 'string',
+ 'example' => '1234 error',
+ ],
+ 'BaselineStatus' => [
+ 'description' => 'The status of the baseline. Valid values: ERROR, SAFE, DANGROUS, and OVER. The value ERROR indicates that no nodes are associated with the baseline, or all nodes associated with the baseline are suspended. The value SAFE indicates that nodes are run before the alert duration begins. The value DANGROUS indicates that nodes are still running after the alert duration ends but the committed completion time does not arrive. The value OVER indicates that nodes are still running after the committed completion time.'."\n",
+ 'type' => 'string',
+ 'example' => 'SAFE',
+ ],
+ 'ProjectId' => [
+ 'description' => 'The ID of the workspace to which the node that triggered the event belongs.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '1234',
+ ],
+ 'NextAlertTime' => [
+ 'description' => 'The timestamp when the system reports the next alert.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '1553524393000',
+ ],
+ 'InstanceId' => [
+ 'description' => 'The ID of the instance that triggered the event.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '12345',
+ ],
+ 'FixTime' => [
+ 'description' => 'The timestamp when the event was processed.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '1553524393000',
+ ],
+ 'BaselineInGroupId' => [
+ 'description' => 'The ID of the cycle of the worst baseline instance.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '1',
+ ],
+ 'BaselineBuffer' => [
+ 'description' => 'The margin of the worst baseline instance. Unit: seconds.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '3600',
+ ],
+ 'TopicType' => [
+ 'description' => 'The type of the event. Valid values: SLOW and ERROR. The value SLOW indicates that the duration of the task is significantly longer than the average duration of the task in previous cycles. The value ERROR indicates that the task fails to run.'."\n",
+ 'type' => 'string',
+ 'example' => 'ERROR',
+ ],
+ 'TopicStatus' => [
+ 'description' => 'The status of the event. Valid values: IGNORE, NEW, FIXING, and RECOVER.'."\n",
+ 'type' => 'string',
+ 'example' => 'FIXING',
+ ],
+ 'HappenTime' => [
+ 'description' => 'The timestamp when the event occurred. A time difference may exist between the time when the event occurred and the time when the event was found.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '1553524393000',
+ ],
+ 'DealTime' => [
+ 'description' => 'The timestamp when the event was last processed.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '1553524393000',
+ ],
+ 'DealUser' => [
+ 'description' => 'The ID of the Alibaba Cloud account used by the user who last processed the event.'."\n",
+ 'type' => 'string',
+ 'example' => '952795****',
+ ],
+ 'BaselineName' => [
+ 'description' => 'The name of the baseline to which the worst baseline instance belongs.'."\n",
+ 'type' => 'string',
+ 'example' => 'Baseline name',
+ ],
+ 'BaselineId' => [
+ 'description' => 'The ID of the baseline to which the worst baseline instance belongs.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '1234',
+ ],
+ 'NodeName' => [
+ 'description' => 'The name of the node that triggered the event.'."\n",
+ 'type' => 'string',
+ 'example' => 'Node name',
+ ],
+ 'AlertTime' => [
+ 'description' => 'The timestamp when the first alert was reported.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '1553524393000',
+ ],
+ 'Buffer' => [
+ 'description' => 'The margin of the event. Unit: seconds.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '1200',
+ ],
+ 'Assigner' => [
+ 'description' => 'The ID of the Alibaba Cloud account used by the alert recipient.'."\n",
+ 'type' => 'string',
+ 'example' => '952795****',
+ ],
+ 'TopicId' => [
+ 'description' => 'The event ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '1234',
+ ],
+ 'AddTime' => [
+ 'description' => 'The timestamp when the event was found.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '1553524393000',
+ ],
+ 'NodeId' => [
+ 'description' => 'The ID of the node that triggered the event.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '1234',
+ ],
+ ],
+ ],
+ ],
+ 'description' => '',
+ ],
+ ],
+ ],
+ 'errorCodes' => [
+ 403 => [
+ [
+ 'errorCode' => 'Forbidden.Access',
+ 'errorMessage' => 'Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.',
+ ],
+ ],
+ 429 => [
+ [
+ 'errorCode' => 'Throttling.Api.Risk',
+ 'errorMessage' => 'The request for this resource has exceeded your daily available limit.',
+ ],
+ [
+ 'errorCode' => 'Throttling.System',
+ 'errorMessage' => 'The DataWorks system is busy. Try again later.',
+ ],
+ [
+ 'errorCode' => 'Throttling.User',
+ 'errorMessage' => 'Your request is too frequent. Try again later.',
+ ],
+ ],
+ 500 => [
+ [
+ 'errorCode' => 'Forbidden.Not.Server',
+ 'errorMessage' => 'The dataworksAPI service is not available in this area. Please try it in another area.',
+ ],
+ [
+ 'errorCode' => 'Invalid.Wkbench.Parameter',
+ 'errorMessage' => 'The specified parameters are invalid.',
+ ],
+ [
+ 'errorCode' => 'InternalError.UserId.Missing',
+ 'errorMessage' => 'An internal system error occurred. Try again later.',
+ ],
+ [
+ 'errorCode' => 'InternalError.Wkbench.ServiceError',
+ 'errorMessage' => 'An internal error occurred.',
+ ],
+ [
+ 'errorCode' => 'Invalid.Wkbench.TopicNotExist',
+ 'errorMessage' => 'The topic does not exist.',
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"0000-ABCD-EFGH-IJKLMNOPQ\\",\\n \\"ErrorMessage\\": \\"The specified parameters are invalid.\\",\\n \\"ErrorCode\\": \\"1031203110005\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"Owner\\": \\"952795****\\",\\n \\"TopicName\\": \\"1234 error\\",\\n \\"BaselineStatus\\": \\"SAFE\\",\\n \\"ProjectId\\": 123456,\\n \\"NextAlertTime\\": 1553524393000,\\n \\"InstanceId\\": 12345,\\n \\"FixTime\\": 1553524393000,\\n \\"BaselineInGroupId\\": 1,\\n \\"BaselineBuffer\\": 3600,\\n \\"TopicType\\": \\"ERROR\\",\\n \\"TopicStatus\\": \\"FIXING\\",\\n \\"HappenTime\\": 1553524393000,\\n \\"DealTime\\": 1553524393000,\\n \\"DealUser\\": \\"952795****\\",\\n \\"BaselineName\\": \\"Baseline name\\",\\n \\"BaselineId\\": 1234,\\n \\"NodeName\\": \\"Node name\\",\\n \\"AlertTime\\": 1553524393000,\\n \\"Buffer\\": 1200,\\n \\"Assigner\\": \\"952795****\\",\\n \\"TopicId\\": 1234,\\n \\"AddTime\\": 1553524393000,\\n \\"NodeId\\": 1234\\n }\\n}","errorExample":""},{"type":"xml","example":"<RequestId>0000-ABCD-EFG****</RequestId>\\n<HttpStatusCode>200</HttpStatusCode>\\n<Data>\\n <BaselineId>1234</BaselineId>\\n <Buffer>1200</Buffer>\\n <FixTime>1553524393000</FixTime>\\n <Owner>952795****</Owner>\\n <InstanceId>12345</InstanceId>\\n <NodeName>节点名称</NodeName>\\n <BaselineStatus>SAFE</BaselineStatus>\\n <ProjectId>1234</ProjectId>\\n <TopicStatus>FIXING</TopicStatus>\\n <AddTime>1553524393000</AddTime>\\n <HappenTime>1553524393000</HappenTime>\\n <AlertTime>1553524393000</AlertTime>\\n <BaselineInGroupId>1</BaselineInGroupId>\\n <TopicName>1234出错</TopicName>\\n <TopicType>ERROR</TopicType>\\n <Assigner>9527952795279528</Assigner>\\n <DealUser>9527952795279528</DealUser>\\n <NextAlertTime>1553524393000</NextAlertTime>\\n <BaselineName>基线名称</BaselineName>\\n <NodeId>1234</NodeId>\\n <TopicId>1234</TopicId>\\n <BaselineBuffer>3600</BaselineBuffer>\\n <DealTime>1553524393000</DealTime>\\n</Data>\\n<ErrorCode>1031203110005</ErrorCode>\\n<ErrorMessage>The specified parameters are invalid.</ErrorMessage>\\n<Success>true</Success>","errorExample":""}]',
+ 'title' => 'GetTopic',
+ 'summary' => 'Queries the information about an event.',
+ 'description' => '****',
+ 'requestParamsDescription' => ' ',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ ],
+ 'GetTopicInfluence' => [
+ 'methods' => [
+ 'post',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'get',
+ 'abilityTreeCode' => '78290',
+ 'abilityTreeNodes' => [
+ 'FEATUREdideSFSFU4',
+ ],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'TopicId',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The ID of the event.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => '1234',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'headers' => [],
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'HttpStatusCode' => [
+ 'description' => 'The HTTP status code returned.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '200',
+ ],
+ 'RequestId' => [
+ 'description' => 'The ID of the request. You can use the ID to troubleshoot issues.'."\n",
+ 'type' => 'string',
+ 'example' => '0000-ABCD-EFG****',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message returned.'."\n",
+ 'type' => 'string',
+ 'example' => 'The specified parameters are invalid.',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code returned.'."\n",
+ 'type' => 'string',
+ 'example' => '1031203110005',
+ ],
+ 'Success' => [
+ 'description' => 'Indicates whether the request was successful.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'Data' => [
+ 'description' => 'The data returned.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'TopicId' => [
+ 'description' => 'The ID of the event.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '1234',
+ ],
+ 'Influences' => [
+ 'description' => 'The affected baseline instances.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'Status' => [
+ 'description' => 'The status of the baseline. Valid values: ERROR, SAFE, DANGROUS, and OVER. The value ERROR indicates that no nodes are associated with the baseline, or all nodes associated with the baseline are suspended. The value SAFE indicates that nodes are run before the alert duration begins. The value DANGROUS indicates that nodes are still running after the alert duration ends but the committed time does not arrive. The value OVER indicates that nodes are still running after the committed time.'."\n",
+ 'type' => 'string',
+ 'example' => 'SAFE',
+ ],
+ 'Owner' => [
+ 'description' => 'The ID of the Alibaba Cloud account used by the baseline owner. Multiple IDs are separated by commas (,).'."\n",
+ 'type' => 'string',
+ 'example' => '952795****',
+ ],
+ 'BaselineName' => [
+ 'description' => 'The name of the baseline.'."\n",
+ 'type' => 'string',
+ 'example' => 'Baseline name',
+ ],
+ 'BaselineId' => [
+ 'description' => 'The ID of the baseline.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '12345',
+ ],
+ 'Bizdate' => [
+ 'description' => 'The data timestamp of the baseline instance.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '1553356800000',
+ ],
+ 'Buffer' => [
+ 'description' => 'The margin of the baseline instance. Unit: seconds.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '360',
+ ],
+ 'ProjectId' => [
+ 'description' => 'The ID of the workspace to which the baseline belongs.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '1234',
+ ],
+ 'Priority' => [
+ 'description' => 'The priority of the baseline. Valid values: 1, 2, 5, 7, and 8.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '1',
+ ],
+ 'InGroupId' => [
+ 'description' => 'The ID of the cycle of the baseline instance. For a baseline instance that is scheduled by day, the field value is 1. For a baseline instance that is scheduled by hour, the field value ranges from 1 to 24.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '1',
+ ],
+ ],
+ 'description' => '',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'description' => '',
+ ],
+ ],
+ ],
+ 'errorCodes' => [
+ 403 => [
+ [
+ 'errorCode' => 'Forbidden.Access',
+ 'errorMessage' => 'Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.',
+ ],
+ ],
+ 429 => [
+ [
+ 'errorCode' => 'Throttling.Api',
+ 'errorMessage' => 'The request for this resource has exceeded your available limit.',
+ ],
+ [
+ 'errorCode' => 'Throttling.Api.Risk',
+ 'errorMessage' => 'The request for this resource has exceeded your daily available limit.',
+ ],
+ [
+ 'errorCode' => 'Throttling.System',
+ 'errorMessage' => 'The DataWorks system is busy. Try again later.',
+ ],
+ [
+ 'errorCode' => 'Throttling.User',
+ 'errorMessage' => 'Your request is too frequent. Try again later.',
+ ],
+ ],
+ 500 => [
+ [
+ 'errorCode' => 'Forbidden.Not.Server',
+ 'errorMessage' => 'The dataworksAPI service is not available in this area. Please try it in another area.',
+ ],
+ [
+ 'errorCode' => 'InternalError.System',
+ 'errorMessage' => 'An internal system error occurred. Try again later.',
+ ],
+ [
+ 'errorCode' => 'InternalError.UserId.Missing',
+ 'errorMessage' => 'An internal system error occurred. Try again later.',
+ ],
+ [
+ 'errorCode' => 'InternalError.Wkbench.ServiceError',
+ 'errorMessage' => 'An internal error occurred.',
+ ],
+ [
+ 'errorCode' => 'Invalid.Wkbench.Parameter',
+ 'errorMessage' => 'The specified parameters are invalid.',
+ ],
+ [
+ 'errorCode' => 'Invalid.Wkbench.TopicNotExist',
+ 'errorMessage' => 'The topic does not exist.',
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"0000-ABCD-EFG****\\",\\n \\"ErrorMessage\\": \\"The specified parameters are invalid.\\",\\n \\"ErrorCode\\": \\"1031203110005\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"TopicId\\": 1234,\\n \\"Influences\\": [\\n {\\n \\"Status\\": \\"SAFE\\",\\n \\"Owner\\": \\"952795****\\",\\n \\"BaselineName\\": \\"Baseline name\\",\\n \\"BaselineId\\": 12345,\\n \\"Bizdate\\": 1553356800000,\\n \\"Buffer\\": 360,\\n \\"ProjectId\\": 1234,\\n \\"Priority\\": 1,\\n \\"InGroupId\\": 1\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<GetTopicInfluenceResponse>\\n <HttpStatusCode>200</HttpStatusCode>\\n <RequestId>0000-ABCD-EFG****</RequestId>\\n <ErrorMessage>The specified parameters are invalid.</ErrorMessage>\\n <ErrorCode>1031203110005</ErrorCode>\\n <Success>true</Success>\\n <Data>\\n <TopicId>1234</TopicId>\\n <Influences>\\n <Status>SAFE</Status>\\n <Owner>952795****</Owner>\\n <BaselineName>基线名称</BaselineName>\\n <BaselineId>1234</BaselineId>\\n <Bizdate>1553356800000</Bizdate>\\n <Buffer>360</Buffer>\\n <ProjectId>1234</ProjectId>\\n <Priority>1</Priority>\\n <InGroupId>1</InGroupId>\\n </Influences>\\n </Data>\\n</GetTopicInfluenceResponse>","errorExample":""}]',
+ 'title' => 'GetTopicInfluence',
+ 'summary' => 'Queries baseline instances affected by an event.',
+ 'description' => '## Debugging'."\n"
+ ."\n"
+ .'[OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.](https://api.aliyun.com/#product=dataworks-public\\&api=GetTopicInfluence\\&type=RPC\\&version=2020-05-18)'."\n",
+ 'requestParamsDescription' => ' ',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ ],
+ 'GetNode' => [
+ 'methods' => [
+ 'post',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'get',
+ 'abilityTreeCode' => '78272',
+ 'abilityTreeNodes' => [
+ 'FEATUREdide7WF1GB',
+ 'FEATUREdideVFMENL',
+ ],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'NodeId',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The interval at which the node is rerun after the node fails to run.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => true,
+ 'docRequired' => true,
+ 'minimum' => '2',
+ 'example' => '1234',
+ 'isFileTransferUrl' => false,
+ ],
+ ],
+ [
+ 'name' => 'ProjectEnv',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The environment of the workspace. Valid values: PROD and DEV.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'enumValueTitles' => [],
+ 'example' => 'PROD',
+ 'isFileTransferUrl' => false,
+ 'enum' => [
+ 'PROD',
+ 'DEV',
+ ],
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'description' => 'The response parameters.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'HttpStatusCode' => [
+ 'description' => 'The operation that you want to perform. Set the value to **GetNode**.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '200',
+ ],
+ 'RequestId' => [
+ 'description' => 'Other parameters.'."\n",
+ 'type' => 'string',
+ 'example' => 'E6F0DBDD-5AD****',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The connection string.'."\n",
+ 'type' => 'string',
+ 'example' => 'The connection does not exist.',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The ID of the node. You can call the [ListNodes](~~173979~~) operation to query the node ID.'."\n",
+ 'type' => 'string',
+ 'example' => 'Invalid.Tenant.ConnectionNotExists',
+ ],
+ 'Success' => [
+ 'description' => 'The ID of the workflow.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'Data' => [
+ 'description' => 'The details of the node.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'SchedulerType' => [
+ 'description' => 'The ID of the workspace.'."\n",
+ 'type' => 'string',
+ 'example' => 'NORMAL',
+ ],
+ 'RepeatInterval' => [
+ 'description' => 'The ID of the workflow to which the node belongs.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '60',
+ ],
+ 'Repeatability' => [
+ 'description' => 'The type of the node.'."\n",
+ 'type' => 'string',
+ 'example' => 'true',
+ ],
+ 'RepeatMode' => [
+ 'description' => 'Rerun mode. 0 indicates that you can rerun only if you fail, 1 indicates that you can rerun in all cases, and 2 indicates that you cannot rerun in all cases.',
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '1',
+ ],
+ 'ProjectId' => [
+ 'description' => 'Indicates whether the node can be rerun.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '1234',
+ ],
+ 'ProgramType' => [
+ 'description' => 'The ID of the owner of the node.'."\n",
+ 'type' => 'string',
+ 'example' => 'ODPS_SQL',
+ ],
+ 'Priority' => [
+ 'description' => 'The HTTP status code returned.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '1',
+ ],
+ 'OwnerId' => [
+ 'description' => 'The ID of the node.'."\n",
+ 'type' => 'string',
+ 'example' => '17366294****',
+ ],
+ 'Connection' => [
+ 'description' => 'The environment of the workspace. Valid values: PROD and DEV.'."\n",
+ 'type' => 'string',
+ 'example' => 'odps_first_dev',
+ ],
+ 'ParamValues' => [
+ 'description' => 'The CRON expression returned.'."\n",
+ 'type' => 'string',
+ 'example' => 'a=b',
+ ],
+ 'RelatedFlowId' => [
+ 'description' => 'Indicates whether the node is associated with Data Quality. Valid values: 0 and 1. A value of 0 indicates that the node is associated with Data Quality. A value of 1 indicates that the node is not associated with Data Quality.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '123',
+ ],
+ 'DqcType' => [
+ 'description' => 'The error message returned.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '1',
+ ],
+ 'BaselineId' => [
+ 'description' => 'The description of the node.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '123456',
+ ],
+ 'Description' => [
+ 'description' => 'The name of the resource group.'."\n",
+ 'type' => 'string',
+ 'example' => 'test',
+ ],
+ 'NodeName' => [
+ 'description' => 'The scheduling type of the node. Valid values:'."\n"
+ ."\n"
+ .'* NORMAL: The node is an auto triggered node.'."\n"
+ .'* MANUAL: The node is a manually triggered node. Manually triggered nodes cannot be automatically triggered.'."\n"
+ .'* PAUSE: The node is a paused node.'."\n"
+ .'* SKIP: The node is a dry-run node. Dry-run nodes are started as scheduled but the system sets the status of the nodes to successful when it starts to run them.'."\n",
+ 'type' => 'string',
+ 'example' => 'The ID of the baseline.'."\n",
+ ],
+ 'ResGroupName' => [
+ 'description' => 'The ID of the request. You can use the ID to locate logs and troubleshoot issues.'."\n",
+ 'type' => 'string',
+ 'example' => 'The table and partition filter expression in Data Quality that are associated with the node.'."\n",
+ ],
+ 'BusinessId' => [
+ 'description' => 'The operation that you want to perform. Set the value to **GetNode**.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '123',
+ ],
+ 'DqcDescription' => [
+ 'description' => 'The ID of the node. You can call the [ListNodes](~~173979~~) operation to query the node ID.'."\n",
+ 'type' => 'string',
+ 'example' => '[{"projectName":"test_0923001","tableName":"test_table_001","partition":"ds\\u003d$[yyyymmdd]"},{"projectName":"test_0923001","tableName":"test_table_002","partition":"NOTAPARTITIONTABLE"}]',
+ ],
+ 'CronExpress' => [
+ 'description' => 'The environment of the workspace. Valid values: PROD and DEV.'."\n",
+ 'type' => 'string',
+ 'example' => '00 00 00 * * ?',
+ ],
+ 'NodeId' => [
+ 'description' => 'The HTTP status code returned.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '1234',
+ ],
+ 'ResGroupIdentifier' => [
+ 'description' => 'The unique identifier of the resource group.',
+ 'type' => 'string',
+ 'example' => 'group_123',
+ ],
+ 'FileType' => [
+ 'description' => 'The file type. Different file types have different codes. For more information, see [DataWorks node collection](~~600169~~).',
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '10',
+ ],
+ 'FileId' => [
+ 'description' => 'The file ID.'."\n"
+ ."\n"
+ .'**'."\n"
+ ."\n"
+ .'**Warning** The field is deprecated.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '123',
+ ],
+ 'FileVersion' => [
+ 'description' => 'The version of the file.',
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '1',
+ ],
+ 'DeployDate' => [
+ 'description' => 'The deployment date.',
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '1727280000000',
+ ],
+ 'CreateTime' => [
+ 'description' => 'The creation time.',
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '1727280000000',
+ ],
+ 'ModifyTime' => [
+ 'description' => 'The modification time.',
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '1727280000000',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"E6F0DBDD-5AD****\\",\\n \\"ErrorMessage\\": \\"The connection does not exist.\\",\\n \\"ErrorCode\\": \\"Invalid.Tenant.ConnectionNotExists\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"SchedulerType\\": \\"NORMAL\\",\\n \\"RepeatInterval\\": 60,\\n \\"Repeatability\\": \\"true\\",\\n \\"RepeatMode\\": 1,\\n \\"ProjectId\\": 1234,\\n \\"ProgramType\\": \\"ODPS_SQL\\",\\n \\"Priority\\": 1,\\n \\"OwnerId\\": \\"17366294****\\",\\n \\"Connection\\": \\"odps_source_dev\\",\\n \\"ParamValues\\": \\"a=b\\",\\n \\"RelatedFlowId\\": 123,\\n \\"DqcType\\": 1,\\n \\"BaselineId\\": 123456,\\n \\"Description\\": \\"test\\",\\n \\"NodeName\\": \\"sql节点\\",\\n \\"ResGroupName\\": \\"默认资源组\\",\\n \\"BusinessId\\": 123,\\n \\"DqcDescription\\": \\"[{\\\\\\"projectName\\\\\\":\\\\\\"test_0923001\\\\\\",\\\\\\"tableName\\\\\\":\\\\\\"test_table_001\\\\\\",\\\\\\"partition\\\\\\":\\\\\\"ds\\\\\\\\u003d$[yyyymmdd]\\\\\\"},{\\\\\\"projectName\\\\\\":\\\\\\"test_0923001\\\\\\",\\\\\\"tableName\\\\\\":\\\\\\"test_table_002\\\\\\",\\\\\\"partition\\\\\\":\\\\\\"NOTAPARTITIONTABLE\\\\\\"}]\\",\\n \\"CronExpress\\": \\"00 00 00 * * ?\\",\\n \\"NodeId\\": 1234,\\n \\"ResGroupIdentifier\\": \\"group_123\\",\\n \\"FileType\\": 10,\\n \\"FileId\\": 123,\\n \\"FileVersion\\": 1,\\n \\"DeployDate\\": 1727280000000,\\n \\"CreateTime\\": 1727280000000,\\n \\"ModifyTime\\": 1727280000000\\n }\\n}","errorExample":""},{"type":"xml","example":"<GetNodeResponse>\\n <HttpStatusCode>200</HttpStatusCode>\\n <RequestId>E6F0DBDD-5AD****</RequestId>\\n <ErrorMessage>The connection does not exist.</ErrorMessage>\\n <ErrorCode>Invalid.Tenant.ConnectionNotExists</ErrorCode>\\n <Success>true</Success>\\n <Data>\\n <SchedulerType>NORMAL</SchedulerType>\\n <RepeatInterval>60</RepeatInterval>\\n <Repeatability>true</Repeatability>\\n <ProjectId>1234</ProjectId>\\n <ProgramType>ODPS_SQL</ProgramType>\\n <Priority>1</Priority>\\n <OwnerId>17366294****</OwnerId>\\n <Connection>odps_source_dev</Connection>\\n <ParamValues>a=b</ParamValues>\\n <RelatedFlowId>123</RelatedFlowId>\\n <DqcType>1</DqcType>\\n <BaselineId>123456</BaselineId>\\n <Description>test</Description>\\n <NodeName>sql节点</NodeName>\\n <ResGroupName>默认资源组</ResGroupName>\\n <BusinessId>123</BusinessId>\\n <DqcDescription>[{\\"projectName\\":\\"test_0923001\\",\\"tableName\\":\\"test_table_001\\",\\"partition\\":\\"ds\\\\u003d$[yyyymmdd]\\"},{\\"projectName\\":\\"test_0923001\\",\\"tableName\\":\\"test_table_002\\",\\"partition\\":\\"NOTAPARTITIONTABLE\\"}]</DqcDescription>\\n <CronExpress>00 00 00 * * ?</CronExpress>\\n <NodeId>1234</NodeId>\\n <ResGroupIdentifier>group_123</ResGroupIdentifier>\\n <FileType>10</FileType>\\n </Data>\\n</GetNodeResponse>","errorExample":""}]',
+ 'title' => 'GetNode',
+ 'summary' => 'Indicates whether the request is successful.',
+ 'requestParamsDescription' => ' ',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ ],
+ 'ListNodeInputOrOutput' => [
+ 'methods' => [
+ 'post',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'get',
+ 'abilityTreeCode' => '78318',
+ 'abilityTreeNodes' => [
+ 'FEATUREdide7WF1GB',
+ ],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'NodeId',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The node ID. You can call the [ListNodes](~~173979~~) operation to query the ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => true,
+ 'docRequired' => true,
+ 'minimum' => '2',
+ 'example' => '12314567',
+ 'isFileTransferUrl' => false,
+ ],
+ ],
+ [
+ 'name' => 'ProjectEnv',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The environment of the workspace. Valid values: DEV and PROD.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'PROD',
+ 'isFileTransferUrl' => false,
+ 'enum' => [
+ 'PROD',
+ 'DEV',
+ ],
+ ],
+ ],
+ [
+ 'name' => 'IoType',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The type of node that you want to query. Valid values:'."\n"
+ ."\n"
+ .'* input: ancestor node'."\n"
+ .'* output: descendant node'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'output',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'description' => 'The response parameters.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'HttpStatusCode' => [
+ 'description' => 'The HTTP status code.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '200',
+ ],
+ 'RequestId' => [
+ 'description' => 'The request ID.'."\n",
+ 'type' => 'string',
+ 'example' => 'E6F0DBDD-5AD****',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message.'."\n",
+ 'type' => 'string',
+ 'example' => 'The project does not exist.',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code.'."\n",
+ 'type' => 'string',
+ 'example' => 'Invalid.Tenant.ProjectNotExists',
+ ],
+ 'Success' => [
+ 'description' => 'Indicates whether the request was successful.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'Data' => [
+ 'description' => 'The ancestor or descendant nodes.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The ancestor or descendant node.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'TableName' => [
+ 'description' => 'This parameter does not take effect. You cannot obtain the parameter settings.'."\n",
+ 'type' => 'string',
+ 'example' => 'dwd_xxx_table',
+ ],
+ 'Data' => [
+ 'description' => 'The name of the ancestor or descendant node.'."\n",
+ 'type' => 'string',
+ 'example' => 'xxxx.123141254_out',
+ ],
+ 'NodeId' => [
+ 'description' => 'The node ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '1234667',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"E6F0DBDD-5AD****\\",\\n \\"ErrorMessage\\": \\"The project does not exist.\\",\\n \\"ErrorCode\\": \\"Invalid.Tenant.ProjectNotExists\\",\\n \\"Success\\": true,\\n \\"Data\\": [\\n {\\n \\"TableName\\": \\"dwd_xxx_table\\",\\n \\"Data\\": \\"xxxx.123141254_out\\",\\n \\"NodeId\\": 12314567\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<ListNodeInputOrOutputResponse>\\n <HttpStatusCode>200</HttpStatusCode>\\n <RequestId>E6F0DBDD-5AD****</RequestId>\\n <ErrorMessage>The project does not exist.</ErrorMessage>\\n <ErrorCode>Invalid.Tenant.ProjectNotExists</ErrorCode>\\n <Success>true</Success>\\n <Data>\\n <TableName>dwd_xxx_table</TableName>\\n <Data>xxxx.123141254_out</Data>\\n <NodeId>1234667</NodeId>\\n </Data>\\n</ListNodeInputOrOutputResponse>","errorExample":""}]',
+ 'title' => 'ListNodeInputOrOutput',
+ 'summary' => 'Queries the input and output information about a node. Only the ancestor or descendant nodes at the nearest level can be queried each time.',
+ 'requestParamsDescription' => ' ',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ ],
+ 'ListNodes' => [
+ 'methods' => [
+ 'post',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'list',
+ 'abilityTreeCode' => '78320',
+ 'abilityTreeNodes' => [
+ 'FEATUREdide7WF1GB',
+ ],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'Owner',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The description of the node.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'docRequired' => false,
+ 'example' => '193379****',
+ ],
+ ],
+ [
+ 'name' => 'BizName',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The error code returned.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'docRequired' => false,
+ 'example' => 'test_bizName',
+ ],
+ ],
+ [
+ 'name' => 'ProgramType',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The operation that you want to perform. Set the value to **ListNodes**.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'docRequired' => false,
+ 'example' => 'ODPS_SQL',
+ ],
+ ],
+ [
+ 'name' => 'PageNumber',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The page number. Minimum value: 1. Maximum value: 100.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => false,
+ 'minimum' => '1',
+ 'example' => '1',
+ 'default' => '1',
+ ],
+ ],
+ [
+ 'name' => 'PageSize',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The number of entries per page. Default value: 10. Maximum value: 100.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => false,
+ 'maximum' => '100',
+ 'minimum' => '1',
+ 'example' => '10',
+ 'default' => '10',
+ ],
+ ],
+ [
+ 'name' => 'ProjectId',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The ID of the owner.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => '1234',
+ ],
+ ],
+ [
+ 'name' => 'ProjectEnv',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The environment in which the node runs. Valid values: DEV and PROD.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'PROD',
+ 'enum' => [
+ 'PROD',
+ 'DEV',
+ ],
+ ],
+ ],
+ [
+ 'name' => 'NodeName',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The ID of the baseline with which the node is associated.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'docRequired' => false,
+ 'example' => 'liux_test_n****',
+ ],
+ ],
+ [
+ 'name' => 'SchedulerType',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The scheduling type. Valid values:'."\n"
+ ."\n"
+ .'* NORMAL: Nodes are scheduled as expected.'."\n"
+ .'* PAUSE: Nodes are paused.'."\n"
+ .'* SKIP: Nodes are dry-run. Dry-run nodes are started as scheduled, but the system sets the status of the nodes to successful when it starts to run them.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'NORMAL',
+ 'enum' => [
+ 'NORMAL',
+ 'MANUAL',
+ 'PAUSE',
+ 'SKIP',
+ ],
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'description' => 'The returned result.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'HttpStatusCode' => [
+ 'description' => 'The interval at which the node is rerun after the node fails to run.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '200',
+ ],
+ 'RequestId' => [
+ 'description' => 'The list of nodes.'."\n",
+ 'type' => 'string',
+ 'example' => 'E6F0DBDD-5AD****',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The page number of the returned page.'."\n",
+ 'type' => 'string',
+ 'example' => 'The connection does not exist.',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The HTTP status code returned.'."\n",
+ 'type' => 'string',
+ 'example' => 'Invalid.Tenant.ConnectionNotExists',
+ ],
+ 'Success' => [
+ 'description' => 'Indicates whether the node can be rerun.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'Data' => [
+ 'description' => 'The nodes.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'PageNumber' => [
+ 'description' => 'The name of the node.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '1',
+ ],
+ 'PageSize' => [
+ 'description' => 'The cron expression returned.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '10',
+ ],
+ 'TotalCount' => [
+ 'description' => 'The name of the workflow.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '66',
+ ],
+ 'Nodes' => [
+ 'description' => 'The information about the nodes.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The returned result.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'SchedulerType' => [
+ 'description' => 'The types of the nodes. You can call the [ListNodes](~~173979~~) operation to query the type of the node.'."\n",
+ 'type' => 'string',
+ 'example' => 'NORMAL',
+ ],
+ 'RepeatInterval' => [
+ 'description' => 'The environment of the workspace. Valid values: PROD and DEV.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '60',
+ ],
+ 'Repeatability' => [
+ 'description' => 'The name of the node.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'RepeatMode' => [
+ 'description' => 'The rerun mode. The value 0 indicates that rerun can be performed only if a failure occurs. The value 1 indicates that rerun can be performed in all cases. The value 2 indicates that rerun cannot be performed in all cases.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '1',
+ ],
+ 'ProjectId' => [
+ 'description' => 'The information about the nodes.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '33671',
+ ],
+ 'ProgramType' => [
+ 'description' => 'The error message returned.'."\n",
+ 'type' => 'string',
+ 'example' => 'ODPS_SQL',
+ ],
+ 'Priority' => [
+ 'description' => 'The ID of the owner.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '1',
+ ],
+ 'OwnerId' => [
+ 'description' => 'The additional parameters.'."\n",
+ 'type' => 'string',
+ 'example' => '19337906836551',
+ ],
+ 'Connection' => [
+ 'description' => 'The name of the resource group.'."\n",
+ 'type' => 'string',
+ 'example' => 'odps_first',
+ ],
+ 'ParamValues' => [
+ 'description' => 'The type of the node.'."\n",
+ 'type' => 'string',
+ 'example' => 'a=b',
+ ],
+ 'RelatedFlowId' => [
+ 'description' => 'The table and partition filter expression in Data Quality that are associated with the node.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '1231123',
+ ],
+ 'DqcType' => [
+ 'description' => 'The connection string.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '1',
+ ],
+ 'BaselineId' => [
+ 'description' => 'The number of the page to return. Minimum value: 1. Maximum value: 100.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '123456',
+ ],
+ 'Description' => [
+ 'description' => 'The priority for running the node. Valid values: 1, 3, 5, 7, and 8.'."\n",
+ 'type' => 'string',
+ 'example' => 'test',
+ ],
+ 'NodeName' => [
+ 'description' => 'The total number of nodes returned.'."\n",
+ 'type' => 'string',
+ 'example' => 'liux_test_n****',
+ ],
+ 'ResGroupName' => [
+ 'description' => 'The ID of the workflow.'."\n",
+ 'type' => 'string',
+ 'example' => 'The ID of the request. You can use the ID to query logs and troubleshoot issues.'."\n",
+ ],
+ 'BusinessId' => [
+ 'description' => 'The operation that you want to perform. Set the value to **ListNodes**.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '123',
+ ],
+ 'DqcDescription' => [
+ 'description' => 'The ID of the owner.'."\n",
+ 'type' => 'string',
+ 'example' => '[{"projectName":"ztjy_dim","tableName":"dim_user_agent_manage_area_a","partition":"ds\\u003d$[yyyy-mm-dd-1]"}]',
+ ],
+ 'CronExpress' => [
+ 'description' => 'The name of the workflow.'."\n",
+ 'type' => 'string',
+ 'example' => '00 00 00 * * ?',
+ ],
+ 'NodeId' => [
+ 'description' => 'The types of the nodes. You can call the [ListNodes](~~173979~~) operation to query the type of the node.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '1234',
+ ],
+ 'ResGroupIdentifier' => [
+ 'description' => 'The identifier of the resource group.'."\n",
+ 'type' => 'string',
+ 'example' => 'group_123',
+ ],
+ 'FileType' => [
+ 'description' => 'Different file types have different codes. For more information, see [DataWorks node collection](~~600169~~).'."\n"
+ .'You can also call the [ListFileType](~~212428~~) interface to query the code type of the file.',
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '10',
+ ],
+ 'FileId' => [
+ 'description' => 'The file ID. You can call the ListFiles operation to query the ID.'."\n"
+ ."\n"
+ .'**'."\n"
+ ."\n"
+ .'**Warning** This field is deprecated.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '20',
+ ],
+ 'FileVersion' => [
+ 'description' => 'The latest version number of the file.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '3',
+ ],
+ 'DeployDate' => [
+ 'description' => 'The timestamp when the node was deployed. Unit: milliseconds.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '1734537600000',
+ ],
+ 'CreateTime' => [
+ 'description' => 'The timestamp when the node was created. Unit: milliseconds.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '1593879116000',
+ ],
+ 'ModifyTime' => [
+ 'description' => 'The timestamp when the node was modified. Unit: milliseconds.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '1593879116000',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'eventInfo' => [
+ 'enable' => false,
+ 'eventNames' => [],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"E6F0DBDD-5AD****\\",\\n \\"ErrorMessage\\": \\"The connection does not exist.\\",\\n \\"ErrorCode\\": \\"Invalid.Tenant.ConnectionNotExists\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 66,\\n \\"Nodes\\": [\\n {\\n \\"SchedulerType\\": \\"NORMAL\\",\\n \\"RepeatInterval\\": 60,\\n \\"Repeatability\\": true,\\n \\"RepeatMode\\": 1,\\n \\"ProjectId\\": 33671,\\n \\"ProgramType\\": \\"ODPS_SQL\\",\\n \\"Priority\\": 1,\\n \\"OwnerId\\": \\"19337906836551\\",\\n \\"Connection\\": \\"odps_source\\",\\n \\"ParamValues\\": \\"a=b\\",\\n \\"RelatedFlowId\\": 1231123,\\n \\"DqcType\\": 1,\\n \\"BaselineId\\": 123456,\\n \\"Description\\": \\"test\\",\\n \\"NodeName\\": \\"liux_test_n****\\",\\n \\"ResGroupName\\": \\"默认资源组\\",\\n \\"BusinessId\\": 123,\\n \\"DqcDescription\\": \\"[{\\\\\\"projectName\\\\\\":\\\\\\"ztjy_dim\\\\\\",\\\\\\"tableName\\\\\\":\\\\\\"dim_user_agent_manage_area_a\\\\\\",\\\\\\"partition\\\\\\":\\\\\\"ds\\\\\\\\u003d$[yyyy-mm-dd-1]\\\\\\"}]\\",\\n \\"CronExpress\\": \\"00 00 00 * * ?\\",\\n \\"NodeId\\": 1234,\\n \\"ResGroupIdentifier\\": \\"group_123\\",\\n \\"FileType\\": 10,\\n \\"FileId\\": 20,\\n \\"FileVersion\\": 3,\\n \\"DeployDate\\": 1734537600000,\\n \\"CreateTime\\": 1593879116000,\\n \\"ModifyTime\\": 1593879116000\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<ListNodesResponse>\\n <HttpStatusCode>200</HttpStatusCode>\\n <RequestId>E6F0DBDD-5AD****</RequestId>\\n <ErrorMessage>The connection does not exist.</ErrorMessage>\\n <ErrorCode>Invalid.Tenant.ConnectionNotExists</ErrorCode>\\n <Success>true</Success>\\n <Data>\\n <PageNumber>1</PageNumber>\\n <PageSize>10</PageSize>\\n <TotalCount>66</TotalCount>\\n <Nodes>\\n <SchedulerType>NORMAL</SchedulerType>\\n <RepeatInterval>60</RepeatInterval>\\n <Repeatability>true</Repeatability>\\n <ProjectId>33671</ProjectId>\\n <ProgramType>ODPS_SQL</ProgramType>\\n <Priority>1</Priority>\\n <OwnerId>19337906836551</OwnerId>\\n <Connection>odps_source</Connection>\\n <ParamValues>a=b</ParamValues>\\n <RelatedFlowId>1231123</RelatedFlowId>\\n <DqcType>1</DqcType>\\n <BaselineId>123456</BaselineId>\\n <Description>test</Description>\\n <NodeName>liux_test_n****</NodeName>\\n <ResGroupName>默认资源组</ResGroupName>\\n <BusinessId>123</BusinessId>\\n <DqcDescription>[{\\"projectName\\":\\"ztjy_dim\\",\\"tableName\\":\\"dim_user_agent_manage_area_a\\",\\"partition\\":\\"ds\\\\u003d$[yyyy-mm-dd-1]\\"}]</DqcDescription>\\n <CronExpress>00 00 00 * * ?</CronExpress>\\n <NodeId>1234</NodeId>\\n <ResGroupIdentifier>group_123</ResGroupIdentifier>\\n <FileType>10</FileType>\\n </Nodes>\\n </Data>\\n</ListNodesResponse>","errorExample":""}]',
+ 'title' => 'ListNodes',
+ 'summary' => 'The ID of the workspace.',
+ 'requestParamsDescription' => ' ',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ ],
+ 'GetNodeCode' => [
+ 'methods' => [
+ 'post',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'get',
+ 'abilityTreeCode' => '78274',
+ 'abilityTreeNodes' => [
+ 'FEATUREdide7WF1GB',
+ 'FEATUREdideVFMENL',
+ ],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'NodeId',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The ID of the node.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => true,
+ 'docRequired' => true,
+ 'minimum' => '2',
+ 'example' => '1234',
+ 'isFileTransferUrl' => false,
+ ],
+ ],
+ [
+ 'name' => 'ProjectEnv',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The environment of the workspace. Valid values: PROD and DEV.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'PROD',
+ 'isFileTransferUrl' => false,
+ 'enum' => [
+ 'PROD',
+ 'DEV',
+ ],
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'description' => 'The response parameters.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'HttpStatusCode' => [
+ 'description' => 'The HTTP status code.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '200',
+ ],
+ 'Data' => [
+ 'description' => 'The code of the node.'."\n",
+ 'type' => 'string',
+ 'example' => 'select a;',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message.'."\n",
+ 'type' => 'string',
+ 'example' => 'The connection does not exist.',
+ ],
+ 'RequestId' => [
+ 'description' => 'The request ID. You can use the ID to locate logs and troubleshoot issues.'."\n",
+ 'type' => 'string',
+ 'example' => 'E6F0DBDD-5AD****',
+ ],
+ 'Success' => [
+ 'description' => 'Indicates whether the request was successful.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code.'."\n",
+ 'type' => 'string',
+ 'example' => 'Invalid.Tenant.ConnectionNotExists',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Data\\": \\"select a;\\",\\n \\"ErrorMessage\\": \\"The connection does not exist.\\",\\n \\"RequestId\\": \\"E6F0DBDD-5AD****\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"Invalid.Tenant.ConnectionNotExists\\"\\n}","errorExample":""},{"type":"xml","example":"<GetNodeCodeResponse>\\n <HttpStatusCode>200</HttpStatusCode>\\n <Data>select a;</Data>\\n <ErrorMessage>The connection does not exist.</ErrorMessage>\\n <RequestId>E6F0DBDD-5AD****</RequestId>\\n <Success>true</Success>\\n <ErrorCode>Invalid.Tenant.ConnectionNotExists</ErrorCode>\\n</GetNodeCodeResponse>","errorExample":""}]',
+ 'title' => 'GetNodeCode',
+ 'summary' => 'Queries the code of a node.',
+ 'requestParamsDescription' => ' ',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ ],
+ 'GetInstance' => [
+ 'methods' => [
+ 'post',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'get',
+ 'abilityTreeCode' => '78249',
+ 'abilityTreeNodes' => [
+ 'FEATUREdide7WF1GB',
+ ],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'InstanceId',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The instance ID. You can call the [ListInstances](~~173982~~) operation to query the ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => '1234',
+ ],
+ ],
+ [
+ 'name' => 'ProjectEnv',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The environment of the workspace. Valid values: PROD and DEV.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'PROD',
+ 'enum' => [
+ 'PROD',
+ 'DEV',
+ ],
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'description' => 'The response parameters.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'HttpStatusCode' => [
+ 'description' => 'The HTTP status code.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '200',
+ ],
+ 'RequestId' => [
+ 'description' => 'The request ID.'."\n",
+ 'type' => 'string',
+ 'example' => 'E6F0DBDD-5AD****',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message returned when the instance fails to be scheduled.'."\n",
+ 'type' => 'string',
+ 'example' => 'test',
+ ],
+ 'Success' => [
+ 'description' => 'Indicates whether the request was successful.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code.'."\n",
+ 'type' => 'string',
+ 'example' => '0',
+ ],
+ 'Data' => [
+ 'description' => 'The details of the instance.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'Status' => [
+ 'description' => 'The status of the node that generates the instance. Valid values:'."\n"
+ ."\n"
+ .'* NOT_RUN: The node is not run.'."\n"
+ .'* WAIT_TIME: The node is waiting for its scheduling time to arrive.'."\n"
+ .'* WAIT_RESOURCE: The node is waiting for resources.'."\n"
+ .'* RUNNING: The node is running.'."\n"
+ .'* CHECKING: Data quality is being checked for the node.'."\n"
+ .'* CHECKING_CONDITION: Branch conditions are being checked for the node.'."\n"
+ .'* FAILURE: The node fails to run.'."\n"
+ .'* SUCCESS: The node is successfully run.'."\n",
+ 'type' => 'string',
+ 'example' => 'NOT_RUN',
+ ],
+ 'CycTime' => [
+ 'description' => 'The scheduling time of the instance.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '1590422400000',
+ ],
+ 'BeginRunningTime' => [
+ 'description' => 'The time when the instance started to run.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '1590416703313',
+ ],
+ 'FinishTime' => [
+ 'description' => 'The time when the running of the instance was complete.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '1590416703313',
+ ],
+ 'CreateTime' => [
+ 'description' => 'The time when the instance was generated.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '1590416703313',
+ ],
+ 'DagId' => [
+ 'description' => 'The workflow ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '338450167',
+ ],
+ 'Priority' => [
+ 'description' => 'The priority of the instance. Valid values: 1, 3, 5, 7, and 8. A greater value indicates a higher priority. Default value: 1.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '1',
+ ],
+ 'TaskType' => [
+ 'description' => 'The scheduling type of the node that generates the instance. Valid values:'."\n"
+ ."\n"
+ .'* NORMAL(0): The node is an auto triggered node. The scheduling system regularly runs the node.'."\n"
+ .'* MANUAL(1): The node is a manually triggered node. The scheduling system does not regularly run the node.'."\n"
+ .'* PAUSE(2): The node is a frozen node. The scheduling system regularly runs the node but sets the status of the node to failed when the scheduling system starts to run the node.'."\n"
+ .'* SKIP(3): The node is a dry-run node. The scheduling system regularly runs the node but sets the status of the node to successful when the scheduling system starts to run the node.'."\n"
+ .'* SKIP_UNCHOOSE(4): The node is an unselected node in a temporary workflow. This type of node exists only in temporary workflows. The scheduling system sets the status of the node to successful when the scheduling system starts to run the node.'."\n"
+ .'* SKIP_CYCLE(5): The node is a node that is scheduled by the week or month and is waiting for the scheduling time to arrive. The scheduling system regularly runs the node but sets the status of the node to successful when the scheduling system starts to run the node.'."\n"
+ .'* CONDITION_UNCHOOSE(6): The node is not selected by its ancestor branch node and is run as a dry-run node.'."\n"
+ .'* REALTIME_DEPRECATED(7): The node has instances that are generated in real time but deprecated. The scheduling system sets the status of the node to successful.'."\n",
+ 'type' => 'string',
+ 'example' => 'NORMAL(0)',
+ ],
+ 'ParamValues' => [
+ 'description' => 'The parameters related to the node.'."\n",
+ 'type' => 'string',
+ 'example' => 'bizdate=$bizdate tbods=$tbods tbdw=$tbdw tbpmic=$tbpmic tbpidx=$tbpidx tbptcif=$tbptcif',
+ ],
+ 'Connection' => [
+ 'description' => 'The connection string.'."\n",
+ 'type' => 'string',
+ 'example' => 'odps_first',
+ ],
+ 'BaselineId' => [
+ 'description' => 'The baseline ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '123123',
+ ],
+ 'DqcType' => [
+ 'description' => 'Indicates whether the instance is associated with a monitoring rule in Data Quality. Valid values:'."\n"
+ ."\n"
+ .'* 0: The instance is associated with a monitoring rule in Data Quality.'."\n"
+ .'* 1: The instance is not associated with a monitoring rule in Data Quality.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '1',
+ ],
+ 'DagType' => [
+ 'description' => 'The type of the workflow. Valid values:'."\n"
+ ."\n"
+ .'* DAILY: The workflow is used to run auto triggered nodes.'."\n"
+ .'* MANUAL: The workflow is used to run manually triggered nodes.'."\n"
+ .'* SMOKE_TEST: The workflow is used to perform smoke testing.'."\n"
+ .'* SUPPLY_DATA: The workflow is used to backfill data.'."\n",
+ 'type' => 'string',
+ 'example' => 'DAILY',
+ ],
+ 'BusinessId' => [
+ 'description' => 'The workflow ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '123',
+ ],
+ 'TaskRerunTime' => [
+ 'description' => 'The number of times the node can be rerun. The value of this parameter can be empty or an integer that is greater than or equal to 0.'."\n"
+ ."\n"
+ .'* If the value of this parameter is empty, the number of times that the node can be rerun is not specified.'."\n"
+ .'* If the value of this parameter is 0, the node cannot be rerun.'."\n"
+ .'* If the value of this parameter is a positive integer such as n, the node can still be rerun n times. For example, if the value of this parameter is 1, the node can still be rerun once. If the value of this parameter is 2, the node can still be rerun twice.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '0',
+ ],
+ 'PeriodNumber' => [
+ 'description' => 'The sequence number of the cycle. This parameter indicates the sequence number of the cycle of the instance on the current day.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '1',
+ ],
+ 'ModifyTime' => [
+ 'description' => 'The time when the instance was last modified.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '1590416703313',
+ ],
+ 'Repeatability' => [
+ 'description' => 'Indicates whether the node that generates the instance can be rerun.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'RepeatInterval' => [
+ 'description' => 'The interval at which the node is rerun after the node fails to run. Unit: milliseconds.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '60000',
+ ],
+ 'InstanceId' => [
+ 'description' => 'The instance ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '11713307578',
+ ],
+ 'BeginWaitResTime' => [
+ 'description' => 'The time when the instance started to wait for resources.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '1590416703313',
+ ],
+ 'RelatedFlowId' => [
+ 'description' => 'The ID of the workflow to which the node belongs.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '123123',
+ ],
+ 'Bizdate' => [
+ 'description' => 'The data timestamp of the instance. In most cases, the value is one day before the time when the instance was run.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '1590336000000',
+ ],
+ 'NodeName' => [
+ 'description' => 'The name of the node.'."\n",
+ 'type' => 'string',
+ 'example' => 'kzh',
+ ],
+ 'BeginWaitTimeTime' => [
+ 'description' => 'The time when the instance started to wait to be scheduled.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '1590416703313',
+ ],
+ 'DqcDescription' => [
+ 'description' => 'The table and partition filter expression in Data Quality that are associated with the node.'."\n",
+ 'type' => 'string',
+ 'example' => '[{"projectName":"ztjy_dim","tableName":"dim_user_agent_manage_area_a","partition":"ds\\u003d$[yyyy-mm-dd-1]"}]',
+ ],
+ 'NodeId' => [
+ 'description' => 'The node ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '33115',
+ ],
+ 'CreateUser' => [
+ 'description' => 'The creator of the instance.'."\n",
+ 'type' => 'string',
+ 'example' => '111',
+ ],
+ 'Owner' => [
+ 'description' => 'The owner of the instance.'."\n",
+ 'type' => 'string',
+ 'example' => '111',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"E6F0DBDD-5AD****\\",\\n \\"ErrorMessage\\": \\"test\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"0\\",\\n \\"Data\\": {\\n \\"Status\\": \\"NOT_RUN\\",\\n \\"CycTime\\": 1590422400000,\\n \\"BeginRunningTime\\": 1590416703313,\\n \\"FinishTime\\": 1590416703313,\\n \\"CreateTime\\": 1590416703313,\\n \\"DagId\\": 338450167,\\n \\"Priority\\": 1,\\n \\"TaskType\\": \\"NORMAL(0)\\",\\n \\"ParamValues\\": \\"bizdate=$bizdate tbods=$tbods tbdw=$tbdw tbpmic=$tbpmic tbpidx=$tbpidx tbptcif=$tbptcif\\",\\n \\"Connection\\": \\"odps_source\\",\\n \\"BaselineId\\": 123123,\\n \\"DqcType\\": 1,\\n \\"DagType\\": \\"DAILY\\",\\n \\"BusinessId\\": 123,\\n \\"TaskRerunTime\\": 0,\\n \\"PeriodNumber\\": 1,\\n \\"ModifyTime\\": 1590416703313,\\n \\"Repeatability\\": true,\\n \\"RepeatInterval\\": 60000,\\n \\"InstanceId\\": 11713307578,\\n \\"BeginWaitResTime\\": 1590416703313,\\n \\"RelatedFlowId\\": 123123,\\n \\"Bizdate\\": 1590336000000,\\n \\"NodeName\\": \\"kzh\\",\\n \\"BeginWaitTimeTime\\": 1590416703313,\\n \\"DqcDescription\\": \\"[{\\\\\\"projectName\\\\\\":\\\\\\"ztjy_dim\\\\\\",\\\\\\"tableName\\\\\\":\\\\\\"dim_user_agent_manage_area_a\\\\\\",\\\\\\"partition\\\\\\":\\\\\\"ds\\\\\\\\u003d$[yyyy-mm-dd-1]\\\\\\"}]\\",\\n \\"NodeId\\": 33115,\\n \\"CreateUser\\": \\"111\\",\\n \\"Owner\\": \\"111\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"<GetInstanceResponse>\\n <HttpStatusCode>200</HttpStatusCode>\\n <RequestId>E6F0DBDD-5AD****</RequestId>\\n <ErrorMessage>test</ErrorMessage>\\n <Success>true</Success>\\n <ErrorCode>0</ErrorCode>\\n <Data>\\n <Status>NOT_RUN</Status>\\n <CycTime>1590422400000</CycTime>\\n <BeginRunningTime>1590416703313</BeginRunningTime>\\n <FinishTime>1590416703313</FinishTime>\\n <CreateTime>1590416703313</CreateTime>\\n <DagId>338450167</DagId>\\n <Priority>1</Priority>\\n <TaskType>NORMAL(0)</TaskType>\\n <ParamValues>bizdate=$bizdate tbods=$tbods tbdw=$tbdw tbpmic=$tbpmic tbpidx=$tbpidx tbptcif=$tbptcif</ParamValues>\\n <Connection>odps_source</Connection>\\n <BaselineId>123123</BaselineId>\\n <DqcType>1</DqcType>\\n <DagType>DAILY</DagType>\\n <BusinessId>123</BusinessId>\\n <TaskRerunTime>0</TaskRerunTime>\\n <ModifyTime>1590416703313</ModifyTime>\\n <Repeatability>true</Repeatability>\\n <RepeatInterval>60000</RepeatInterval>\\n <InstanceId>11713307578</InstanceId>\\n <BeginWaitResTime>1590416703313</BeginWaitResTime>\\n <RelatedFlowId>123123</RelatedFlowId>\\n <Bizdate>1590336000000</Bizdate>\\n <NodeName>kzh</NodeName>\\n <BeginWaitTimeTime>1590416703313</BeginWaitTimeTime>\\n <DqcDescription>[{\\"projectName\\":\\"ztjy_dim\\",\\"tableName\\":\\"dim_user_agent_manage_area_a\\",\\"partition\\":\\"ds\\\\u003d$[yyyy-mm-dd-1]\\"}]</DqcDescription>\\n <NodeId>33115</NodeId>\\n <CreateUser>111</CreateUser>\\n </Data>\\n</GetInstanceResponse>","errorExample":""}]',
+ 'title' => 'GetInstance',
+ 'summary' => 'Queries the information about an instance.',
+ 'requestParamsDescription' => ' ',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ ],
+ 'ListInstances' => [
+ 'methods' => [
+ 'post',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'list',
+ 'abilityTreeCode' => '78315',
+ 'abilityTreeNodes' => [
+ 'FEATUREdide4QKMAF',
+ ],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'ProjectEnv',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The environment in which the node runs. Valid values: DEV and PROD.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'enumValueTitles' => [],
+ 'example' => 'PROD',
+ 'enum' => [
+ 'PROD',
+ 'DEV',
+ ],
+ ],
+ ],
+ [
+ 'name' => 'NodeId',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'Indicates whether the instance is associated with a monitoring rule in Data Quality. Valid values:'."\n"
+ ."\n"
+ .'* 0: The instance is associated with a monitoring rule in Data Quality.'."\n"
+ .'* 1: The instance is not associated with a monitoring rule in Data Quality.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'docRequired' => false,
+ 'example' => '100000000000',
+ ],
+ ],
+ [
+ 'name' => 'NodeName',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'Indicates whether the node can be rerun.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'openmr_8****',
+ ],
+ ],
+ [
+ 'name' => 'Owner',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The connection string.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => '193379****',
+ ],
+ ],
+ [
+ 'name' => 'ProjectId',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The ID of the baseline.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => '12345',
+ ],
+ ],
+ [
+ 'name' => 'BizName',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The ID of the instance.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'test_bizName',
+ ],
+ ],
+ [
+ 'name' => 'ProgramType',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The error code returned.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'ODPS_SQL',
+ ],
+ ],
+ [
+ 'name' => 'PageNumber',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The operation that you want to perform.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => false,
+ 'minimum' => '1',
+ 'example' => '1',
+ 'default' => '1',
+ ],
+ ],
+ [
+ 'name' => 'PageSize',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The ID of the node.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => false,
+ 'maximum' => '100',
+ 'minimum' => '1',
+ 'example' => '10',
+ 'default' => '10',
+ ],
+ ],
+ [
+ 'name' => 'DagId',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The environment of the workspace. Valid values: PROD and DEV. The value PROD indicates the production environment. The value DEV indicates the development environment.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'example' => '11111',
+ ],
+ ],
+ [
+ 'name' => 'Bizdate',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The number of entries returned per page. Default value: 10. Maximum value: 100.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => '2020-02-02 00:00:00',
+ ],
+ ],
+ [
+ 'name' => 'BeginBizdate',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The parameters related to the node.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => '2020-02-02 00:00:00',
+ ],
+ ],
+ [
+ 'name' => 'EndBizdate',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The ID of the workflow.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => '2020-02-03 00:00:00',
+ ],
+ ],
+ [
+ 'name' => 'Status',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The status of the node. Valid values:'."\n"
+ ."\n"
+ .'* NOT_RUN: The node is not run.'."\n"
+ .'* WAIT_TIME: The node is waiting for the scheduling time to arrive.'."\n"
+ .'* WAIT_RESOURCE: The node is waiting for resources.'."\n"
+ .'* RUNNING: The node is running.'."\n"
+ .'* CHECKING: Data quality is being checked for the node.'."\n"
+ .'* CHECKING_CONDITION: Branch conditions are being checked for the node.'."\n"
+ .'* FAILURE: The node fails to run.'."\n"
+ .'* SUCCESS: The node is successfully run.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'enumValueTitles' => [],
+ 'example' => 'NOT_RUN',
+ 'enum' => [
+ 'SUCCESS',
+ 'FAILURE',
+ 'WAIT_TRIGGER',
+ 'CHECKING',
+ 'RUNNING',
+ 'WAIT_RESOURCE',
+ 'WAIT_TIME',
+ 'NOT_RUN',
+ ],
+ ],
+ ],
+ [
+ 'name' => 'OrderBy',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The sorting rule of the instances to be returned. Valid values:'."\n"
+ ."\n"
+ .'* CREATE_TIME_DESC: The instances are sorted in descending order of their creation time.'."\n"
+ .'* INSTANCE_ID_DESC (default): The instances are sorted in descending order of their IDs.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'enumValueTitles' => [],
+ 'example' => 'INSTANCE_ID_DESC',
+ 'enum' => [
+ 'INSTANCE_ID_DESC',
+ 'CREATE_TIME_DESC',
+ ],
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'description' => 'The instances returned.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'HttpStatusCode' => [
+ 'description' => 'The error message that is returned for the instance.'."\n"
+ ."\n"
+ .'This parameter is deprecated. You can call the [GetInstanceLog](~~173983~~) operation to query the error information related to the node.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '200',
+ ],
+ 'RequestId' => [
+ 'description' => 'The name of the node.'."\n",
+ 'type' => 'string',
+ 'example' => 'E6F0DBDD-5AD****',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The page number of the returned page.'."\n",
+ 'type' => 'string',
+ 'example' => 'The project does not exist.',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The HTTP status code returned.'."\n",
+ 'type' => 'string',
+ 'example' => 'Invalid.Tenant.ProjectNotExists',
+ ],
+ 'Success' => [
+ 'description' => 'The beginning of the time range to query. Specify the time in the yyyy-MM-dd HH:mm:ss format.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'Data' => [
+ 'description' => 'The ID of the node. You can call the [ListNodes](~~173979~~) operation to query the ID of the node.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'PageNumber' => [
+ 'description' => 'The time when the node was scheduled to run.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '1',
+ ],
+ 'PageSize' => [
+ 'description' => 'The end of the time range to query. Specify the time in the yyyy-MM-dd HH:mm:ss format.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '10',
+ ],
+ 'TotalCount' => [
+ 'description' => 'The priority of the instance. Valid values: 1, 3, 5, 7, and 8.'."\n"
+ ."\n"
+ .'A greater value indicates a higher priority. Default value: 1.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '66',
+ ],
+ 'Instances' => [
+ 'description' => 'The name of the node. You can call the [ListNodes](~~173979~~) operation to query the name of the node.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The time when the instance was generated.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'Status' => [
+ 'description' => 'The data timestamp of the instances that you want to query. Specify the timestamp in the yyyy-MM-dd HH:mm:ss format.'."\n",
+ 'type' => 'string',
+ 'example' => 'NOT_RUN',
+ ],
+ 'CycTime' => [
+ 'description' => 'The error message returned.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '1590422400000',
+ ],
+ 'BeginRunningTime' => [
+ 'description' => 'The time when the instance started to run.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '1590416703313',
+ ],
+ 'FinishTime' => [
+ 'description' => 'The ID of the Alibaba Cloud account used by the workspace administrator. You can log on to the Alibaba Cloud Management Console and view the ID on the Security Settings page of the Account Center console.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '1590416703313',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The name of the account that is used to run the instance. For example, if an account named Test was used to run the instance to backfill data, the value of this parameter is Test.'."\n",
+ 'type' => 'string',
+ 'example' => 'error message',
+ ],
+ 'CreateTime' => [
+ 'description' => 'The interval at which the node is rerun after the node fails to run. Unit: milliseconds.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '1590416703313',
+ ],
+ 'DagId' => [
+ 'description' => 'The time when the instance started to wait for resources.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '33845',
+ ],
+ 'Priority' => [
+ 'description' => 'The total number of instances.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '1',
+ ],
+ 'TaskType' => [
+ 'description' => 'The information about the instances.'."\n",
+ 'type' => 'string',
+ 'example' => 'NORMAL(0)',
+ ],
+ 'ParamValues' => [
+ 'description' => 'The table and partition filter expression in Data Quality that are associated with the node.'."\n",
+ 'type' => 'string',
+ 'example' => 'bizdate=$bizdate tbods=$tbods',
+ ],
+ 'Connection' => [
+ 'description' => 'The number of times the node can be rerun. The value of this parameter can be empty or an integer that is greater than or equal to 0.'."\n"
+ ."\n"
+ .'* If the value of this parameter is empty, the number of times that the node can be rerun is not specified.'."\n"
+ .'* If the value of this parameter is 0, the node cannot be rerun.'."\n"
+ .'* If the value of this parameter is a positive integer such as n, the node can be rerun n times. For example, if the value of this parameter is 1, the node can be rerun once. If the value of this parameter is 2, the node can be rerun twice.'."\n",
+ 'type' => 'string',
+ 'example' => 'odps_first',
+ ],
+ 'BaselineId' => [
+ 'description' => 'The type of the workflow. Valid values:'."\n"
+ ."\n"
+ .'* DAILY: The workflow is used to run auto triggered nodes.'."\n"
+ .'* MANUAL: The workflow is used to run manually triggered nodes.'."\n"
+ .'* SMOKE_TEST: The workflow is used to perform smoke testing.'."\n"
+ .'* SUPPLY_DATA: The workflow is used to backfill data.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '123123',
+ ],
+ 'DqcType' => [
+ 'description' => 'The status of the node. Valid values:'."\n"
+ ."\n"
+ .'* NOT_RUN: The node is not run.'."\n"
+ .'* WAIT_TIME: The node is waiting for the scheduling time to arrive.'."\n"
+ .'* WAIT_RESOURCE: The node is waiting for resources.'."\n"
+ .'* RUNNING: The node is running.'."\n"
+ .'* CHECKING: Data quality is being checked for the node.'."\n"
+ .'* CHECKING_CONDITION: Branch conditions are being checked for the node.'."\n"
+ .'* FAILURE: The node fails to run.'."\n"
+ .'* SUCCESS: The node is successfully run.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '1',
+ ],
+ 'DagType' => [
+ 'description' => 'The data timestamp of the instance. In most cases, the value is one day before the time when the instance was run.'."\n",
+ 'type' => 'string',
+ 'example' => 'DAILY',
+ ],
+ 'BusinessId' => [
+ 'description' => 'The ID of the workflow to which the node belongs.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '123',
+ ],
+ 'TaskRerunTime' => [
+ 'description' => 'The ID of the workspace. You can call the [ListProjects](~~178393~~) operation to query the ID of the workspace.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '0',
+ ],
+ 'ModifyTime' => [
+ 'description' => 'The name of the workflow. You can call the [ListBusiness](~~173945~~) operation to query the name of the workflow.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '1590416703313',
+ ],
+ 'Repeatability' => [
+ 'description' => 'The status of the node. Valid values:'."\n"
+ ."\n"
+ .'* NOT_RUN: The node is not run.'."\n"
+ .'* WAIT_TIME: The node is waiting for the scheduling time to arrive.'."\n"
+ .'* WAIT_RESOURCE: The node is waiting for resources.'."\n"
+ .'* RUNNING: The node is running.'."\n"
+ .'* CHECKING: Data quality is being checked for the node.'."\n"
+ .'* CHECKING_CONDITION: Branch conditions are being checked for the node.'."\n"
+ .'* FAILURE: The node fails to run.'."\n"
+ .'* SUCCESS: The node is successfully run.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'RepeatInterval' => [
+ 'description' => 'The scheduling type of the node. Valid values:'."\n"
+ ."\n"
+ .'* NORMAL(0): The node is an auto triggered node. The scheduling system regularly runs the node.'."\n"
+ ."\n"
+ .'* MANUAL(1): The node is a manually triggered node. The scheduling system does not regularly run the node.'."\n"
+ ."\n"
+ .'* PAUSE(2): The node is a frozen node. The scheduling system regularly runs the node but sets the status of the node to failed when the scheduling system starts to run the node.'."\n"
+ ."\n"
+ .'* SKIP(3): The node is a dry-run node. The scheduling system regularly runs the node but sets the status of the node to succeeded when the scheduling system starts to run the node.'."\n"
+ ."\n"
+ .'* SKIP_UNCHOOSE(4): The node is an unselected node in a temporary workflow. This type of node exists only in temporary workflows. The scheduling system sets the status of the node to succeeded when the scheduling system starts to run the node.'."\n"
+ ."\n"
+ .'* SKIP_CYCLE(5): The node is a node that is scheduled by week or month and is waiting for the scheduling time to arrive. The scheduling system regularly runs the node but sets the status of the node to succeeded when the scheduling system starts to run the node.'."\n"
+ ."\n"
+ .'* CONDITION_UNCHOOSE(6): The node is not selected by its ancestor branch node and is run as a dry-run node.'."\n"
+ ."\n"
+ .' REALTIME_DEPRECATED(7): The node has instances that are generated in real time but deprecated. The scheduling system sets the status of the node to succeeded.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '60000',
+ ],
+ 'InstanceId' => [
+ 'description' => 'The number of the page to return. Minimum value:1. Maximum value: 100.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '1234',
+ ],
+ 'BeginWaitResTime' => [
+ 'description' => 'The time when the node stopped running.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '1590416703313',
+ ],
+ 'RelatedFlowId' => [
+ 'description' => 'The type of the node. You can call the [ListNodes](~~173979~~) operation to query the type of the node.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '123456',
+ ],
+ 'Bizdate' => [
+ 'description' => 'The number of entries to return on each page. Default value: 10. Maximum value: 100.'."\n"
+ ."\n"
+ .'You cannot specify the sorting method for the instances to be returned by this operation. By default, the instances are sorted in descending order of the time when the instances were created.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '1590336000000',
+ ],
+ 'NodeName' => [
+ 'description' => 'The ID of the workflow.'."\n",
+ 'type' => 'string',
+ 'example' => 'kzh',
+ ],
+ 'BeginWaitTimeTime' => [
+ 'description' => 'The ID of the request. You can use the ID to locate logs and troubleshoot issues.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '1590416703313',
+ ],
+ 'DqcDescription' => [
+ 'description' => 'The operation that you want to perform.'."\n",
+ 'type' => 'string',
+ 'example' => '[{"projectName":"ztjy_dim","tableName":"dim_user_agent_manage_area_a","partition":"ds\\u003d$[yyyy-mm-dd-1]"}]',
+ ],
+ 'NodeId' => [
+ 'description' => 'The environment of the workspace. Valid values: PROD and DEV. The value PROD indicates the production environment. The value DEV indicates the development environment.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '33115',
+ ],
+ 'CreateUser' => [
+ 'description' => 'The ID of the node. You can call the [ListNodes](~~173979~~) operation to query the ID of the node.'."\n",
+ 'type' => 'string',
+ 'example' => 'Test',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"E6F0DBDD-5AD****\\",\\n \\"ErrorMessage\\": \\"The project does not exist.\\",\\n \\"ErrorCode\\": \\"Invalid.Tenant.ProjectNotExists\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 66,\\n \\"Instances\\": [\\n {\\n \\"Status\\": \\"NOT_RUN\\",\\n \\"CycTime\\": 1590422400000,\\n \\"BeginRunningTime\\": 1590416703313,\\n \\"FinishTime\\": 1590416703313,\\n \\"ErrorMessage\\": \\"error message\\",\\n \\"CreateTime\\": 1590416703313,\\n \\"DagId\\": 33845,\\n \\"Priority\\": 1,\\n \\"TaskType\\": \\"NORMAL(0)\\",\\n \\"ParamValues\\": \\"bizdate=$bizdate tbods=$tbods\\",\\n \\"Connection\\": \\"odps_source\\",\\n \\"BaselineId\\": 123123,\\n \\"DqcType\\": 1,\\n \\"DagType\\": \\"DAILY\\",\\n \\"BusinessId\\": 123,\\n \\"TaskRerunTime\\": 0,\\n \\"ModifyTime\\": 1590416703313,\\n \\"Repeatability\\": true,\\n \\"RepeatInterval\\": 60000,\\n \\"InstanceId\\": 1234,\\n \\"BeginWaitResTime\\": 1590416703313,\\n \\"RelatedFlowId\\": 123456,\\n \\"Bizdate\\": 1590336000000,\\n \\"NodeName\\": \\"kzh\\",\\n \\"BeginWaitTimeTime\\": 1590416703313,\\n \\"DqcDescription\\": \\"[{\\\\\\"projectName\\\\\\":\\\\\\"ztjy_dim\\\\\\",\\\\\\"tableName\\\\\\":\\\\\\"dim_user_agent_manage_area_a\\\\\\",\\\\\\"partition\\\\\\":\\\\\\"ds\\\\\\\\u003d$[yyyy-mm-dd-1]\\\\\\"}]\\",\\n \\"NodeId\\": 33115,\\n \\"CreateUser\\": \\"Test\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<ListInstancesResponse>\\n <HttpStatusCode>200</HttpStatusCode>\\n <RequestId>E6F0DBDD-5AD****</RequestId>\\n <ErrorMessage>The project does not exist.</ErrorMessage>\\n <ErrorCode>Invalid.Tenant.ProjectNotExists</ErrorCode>\\n <Success>true</Success>\\n <Data>\\n <PageNumber>1</PageNumber>\\n <PageSize>10</PageSize>\\n <TotalCount>66</TotalCount>\\n <Instances>\\n <Status>NOT_RUN</Status>\\n <CycTime>1590422400000</CycTime>\\n <BeginRunningTime>1590416703313</BeginRunningTime>\\n <FinishTime>1590416703313</FinishTime>\\n <ErrorMessage>error message</ErrorMessage>\\n <CreateTime>1590416703313</CreateTime>\\n <DagId>33845</DagId>\\n <Priority>1</Priority>\\n <TaskType>NORMAL(0)</TaskType>\\n <ParamValues>bizdate=$bizdate tbods=$tbods</ParamValues>\\n <Connection>odps_source</Connection>\\n <BaselineId>123123</BaselineId>\\n <DqcType>1</DqcType>\\n <DagType>DAILY</DagType>\\n <BusinessId>123</BusinessId>\\n <TaskRerunTime>0</TaskRerunTime>\\n <ModifyTime>1590416703313</ModifyTime>\\n <Repeatability>true</Repeatability>\\n <RepeatInterval>60000</RepeatInterval>\\n <InstanceId>1234</InstanceId>\\n <BeginWaitResTime>1590416703313</BeginWaitResTime>\\n <RelatedFlowId>123456</RelatedFlowId>\\n <Bizdate>1590336000000</Bizdate>\\n <NodeName>kzh</NodeName>\\n <BeginWaitTimeTime>1590416703313</BeginWaitTimeTime>\\n <DqcDescription>[{\\"projectName\\":\\"ztjy_dim\\",\\"tableName\\":\\"dim_user_agent_manage_area_a\\",\\"partition\\":\\"ds\\\\u003d$[yyyy-mm-dd-1]\\"}]</DqcDescription>\\n <NodeId>33115</NodeId>\\n <CreateUser>Test</CreateUser>\\n </Instances>\\n </Data>\\n</ListInstancesResponse>","errorExample":""}]',
+ 'title' => 'ListInstances',
+ 'summary' => 'Queries a list of instances.',
+ 'requestParamsDescription' => ' ',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ ],
+ 'GetInstanceLog' => [
+ 'methods' => [
+ 'post',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'get',
+ 'abilityTreeCode' => '78253',
+ 'abilityTreeNodes' => [
+ 'FEATUREdide7WF1GB',
+ ],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'InstanceId',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The ID of the instance.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => '1234',
+ ],
+ ],
+ [
+ 'name' => 'ProjectEnv',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The environment of the workspace. Valid values: PROD and DEV.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'PROD',
+ 'enum' => [
+ 'PROD',
+ 'DEV',
+ ],
+ ],
+ ],
+ [
+ 'name' => 'InstanceHistoryId',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The historical record number of the instance. You can call the ListInstanceHistory operation to query the ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'example' => '1',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'HttpStatusCode' => [
+ 'description' => 'The HTTP status code returned.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '200',
+ ],
+ 'Data' => [
+ 'description' => 'The content of the logs.'."\n",
+ 'type' => 'string',
+ 'example' => 'log_content',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message returned.'."\n",
+ 'type' => 'string',
+ 'example' => 'The connection does not exist.',
+ ],
+ 'RequestId' => [
+ 'description' => 'The ID of the request. You can locate logs and troubleshoot issues based on the ID.'."\n",
+ 'type' => 'string',
+ 'example' => 'E6F0DBDD-5AD****',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code returned.'."\n",
+ 'type' => 'string',
+ 'example' => 'Invalid.Tenant.ConnectionNotExists',
+ ],
+ 'Success' => [
+ 'description' => 'Indicates whether the request is successful.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Data\\": \\"log_content\\",\\n \\"ErrorMessage\\": \\"The connection does not exist.\\",\\n \\"RequestId\\": \\"E6F0DBDD-5AD****\\",\\n \\"ErrorCode\\": \\"Invalid.Tenant.ConnectionNotExists\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<GetInstanceLogResponse>\\n <HttpStatusCode>200</HttpStatusCode>\\n <Data>log_content</Data>\\n <ErrorMessage>The connection does not exist.</ErrorMessage>\\n <RequestId>E6F0DBDD-5AD****</RequestId>\\n <ErrorCode>Invalid.Tenant.ConnectionNotExists</ErrorCode>\\n <Success>true</Success>\\n</GetInstanceLogResponse>","errorExample":""}]',
+ 'title' => 'GetInstanceLog',
+ 'summary' => 'Queries the logs of an instance. ',
+ 'description' => 'You may not obtain the instance logs that were generated more than seven days ago.'."\n",
+ 'requestParamsDescription' => ' ',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ ],
+ 'StopInstance' => [
+ 'methods' => [
+ 'post',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'readAndWrite',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'update',
+ 'abilityTreeCode' => '78359',
+ 'abilityTreeNodes' => [
+ 'FEATUREdide7WF1GB',
+ ],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'InstanceId',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The instance ID. You can call the [ListInstances](~~173982~~) operation to obtain the ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => '1234',
+ ],
+ ],
+ [
+ 'name' => 'ProjectEnv',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The environment of the workspace. Valid values: PROD and DEV.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'PROD',
+ 'enum' => [
+ 'PROD',
+ 'DEV',
+ ],
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'HttpStatusCode' => [
+ 'description' => 'The HTTP status code.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '200',
+ ],
+ 'Data' => [
+ 'description' => 'The result returned.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message.'."\n",
+ 'type' => 'string',
+ 'example' => 'The connection does not exist.',
+ ],
+ 'RequestId' => [
+ 'description' => 'The request ID.'."\n",
+ 'type' => 'string',
+ 'example' => 'E6F0DBDD-5AD****',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code.'."\n",
+ 'type' => 'string',
+ 'example' => 'Invalid.Tenant.ConnectionNotExists',
+ ],
+ 'Success' => [
+ 'description' => 'Indicates whether the request was successful.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ ],
+ 'description' => '',
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Data\\": true,\\n \\"ErrorMessage\\": \\"The connection does not exist.\\",\\n \\"RequestId\\": \\"E6F0DBDD-5AD****\\",\\n \\"ErrorCode\\": \\"Invalid.Tenant.ConnectionNotExists\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<StopInstanceResponse>\\n <RequestId>E6F0DBDD-5AD****</RequestId>\\n <HttpStatusCode>200</HttpStatusCode>\\n <Data>true</Data>\\n <ErrorCode>Invalid.Tenant.ConnectionNotExists</ErrorCode>\\n <ErrorMessage>The connection does not exist.</ErrorMessage>\\n <Success>true</Success>\\n</StopInstanceResponse>","errorExample":""}]',
+ 'title' => 'StopInstance',
+ 'summary' => 'Terminates an instance.',
+ 'requestParamsDescription' => ' ',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ ],
+ 'RestartInstance' => [
+ 'methods' => [
+ 'post',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'readAndWrite',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'get',
+ 'abilityTreeCode' => '78342',
+ 'abilityTreeNodes' => [
+ 'FEATUREdide7WF1GB',
+ ],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'InstanceId',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The instance ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => '1234',
+ ],
+ ],
+ [
+ 'name' => 'ProjectEnv',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The environment of the workspace. Valid values: PROD and DEV.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'PROD',
+ 'enum' => [
+ 'PROD',
+ 'DEV',
+ ],
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'HttpStatusCode' => [
+ 'description' => 'The HTTP status code.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '200',
+ ],
+ 'Data' => [
+ 'description' => 'The data returned.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message.'."\n",
+ 'type' => 'string',
+ 'example' => 'The connection does not exist.',
+ ],
+ 'RequestId' => [
+ 'description' => 'The request ID.'."\n",
+ 'type' => 'string',
+ 'example' => 'q32ety****',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code.'."\n",
+ 'type' => 'string',
+ 'example' => 'Invalid.Tenant.ConnectionNotExists',
+ ],
+ 'Success' => [
+ 'description' => 'Indicates whether the request was successful.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ ],
+ 'description' => '',
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Data\\": true,\\n \\"ErrorMessage\\": \\"The connection does not exist.\\",\\n \\"RequestId\\": \\"q32ety****\\",\\n \\"ErrorCode\\": \\"Invalid.Tenant.ConnectionNotExists\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<RequestId>q32ety****</RequestId>\\n<HttpStatusCode>200</HttpStatusCode>\\n<Data>true</Data>\\n<ErrorCode>Invalid.Tenant.ConnectionNotExists</ErrorCode>\\n<ErrorMessage>The connection does not exist.</ErrorMessage>\\n<Success>true</Success>","errorExample":""}]',
+ 'title' => 'RestartInstance',
+ 'summary' => 'Restarts an instance.',
+ 'requestParamsDescription' => ' ',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ ],
+ 'SetSuccessInstance' => [
+ 'methods' => [
+ 'post',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'readAndWrite',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'update',
+ 'abilityTreeCode' => '78355',
+ 'abilityTreeNodes' => [
+ 'FEATUREdide7WF1GB',
+ ],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'InstanceId',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The instance ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => '1234',
+ ],
+ ],
+ [
+ 'name' => 'ProjectEnv',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The environment of the workspace. Valid values: PROD and DEV.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'PROD',
+ 'enum' => [
+ 'PROD',
+ 'DEV',
+ ],
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'description' => 'The response parameters.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'HttpStatusCode' => [
+ 'description' => 'The HTTP status code.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '200',
+ ],
+ 'Data' => [
+ 'description' => 'Indicates whether result details are returned.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message.'."\n",
+ 'type' => 'string',
+ 'example' => 'The connection does not exist.',
+ ],
+ 'RequestId' => [
+ 'description' => 'The request ID.'."\n",
+ 'type' => 'string',
+ 'example' => 'E6F0DBDD-5AD****',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code.'."\n",
+ 'type' => 'string',
+ 'example' => 'Invalid.Tenant.ConnectionNotExists',
+ ],
+ 'Success' => [
+ 'description' => 'Indicates whether the request was successful.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Data\\": true,\\n \\"ErrorMessage\\": \\"The connection does not exist.\\",\\n \\"RequestId\\": \\"E6F0DBDD-5AD****\\",\\n \\"ErrorCode\\": \\"Invalid.Tenant.ConnectionNotExists\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<SetSuccessInstanceResponse>\\n <HttpStatusCode>200</HttpStatusCode>\\n <Data>true</Data>\\n <ErrorMessage>The connection does not exist.</ErrorMessage>\\n <RequestId>E6F0DBDD-5AD****</RequestId>\\n <ErrorCode>Invalid.Tenant.ConnectionNotExists</ErrorCode>\\n <Success>true</Success>\\n</SetSuccessInstanceResponse>","errorExample":""}]',
+ 'title' => 'SetSuccessInstance',
+ 'summary' => 'Sets the state of a failed instance to successful.',
+ 'requestParamsDescription' => ' ',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ ],
+ 'SuspendInstance' => [
+ 'methods' => [
+ 'post',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'readAndWrite',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'update',
+ 'abilityTreeCode' => '78361',
+ 'abilityTreeNodes' => [
+ 'FEATUREdide7WF1GB',
+ ],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'InstanceId',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The instance ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => '1234',
+ ],
+ ],
+ [
+ 'name' => 'ProjectEnv',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The environment of the workspace. Valid values: PROD and DEV.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'PROD',
+ 'enum' => [
+ 'PROD',
+ 'DEV',
+ ],
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'HttpStatusCode' => [
+ 'description' => 'The HTTP status code.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '200',
+ ],
+ 'Data' => [
+ 'description' => 'The data returned.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message.'."\n",
+ 'type' => 'string',
+ 'example' => 'The connection does not exist.',
+ ],
+ 'RequestId' => [
+ 'description' => 'The request ID. You can use the ID to locate logs and troubleshoot issues.'."\n",
+ 'type' => 'string',
+ 'example' => '0baf87f0159376****',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code.'."\n",
+ 'type' => 'string',
+ 'example' => 'Invalid.Tenant.ProjectNotExists',
+ ],
+ 'Success' => [
+ 'description' => 'Indicates whether the request was successful.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ ],
+ 'description' => '',
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Data\\": true,\\n \\"ErrorMessage\\": \\"The connection does not exist.\\",\\n \\"RequestId\\": \\"0baf87f0159376****\\",\\n \\"ErrorCode\\": \\"Invalid.Tenant.ProjectNotExists\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<RequestId>0baf87f0159376****</RequestId>\\n<HttpStatusCode>200</HttpStatusCode>\\n<Data>true</Data>\\n<ErrorCode>Invalid.Tenant.ProjectNotExists</ErrorCode>\\n<ErrorMessage>The connection does not exist.</ErrorMessage>\\n<Success>true</Success>","errorExample":""}]',
+ 'title' => 'SuspendInstance',
+ 'summary' => 'Suspends an instance.',
+ 'requestParamsDescription' => ' ',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ ],
+ 'ResumeInstance' => [
+ 'summary' => 'Calls the ResumeInstance operation to resume a suspended instance.',
+ 'methods' => [
+ 'post',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'readAndWrite',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'update',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeCode' => '78343',
+ 'abilityTreeNodes' => [
+ 'FEATUREdide7WF1GB',
+ ],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'InstanceId',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The instance ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => '1234',
+ ],
+ ],
+ [
+ 'name' => 'ProjectEnv',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The environment of the workspace. Valid values: PROD and DEV.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'PROD',
+ 'enum' => [
+ 'PROD',
+ 'DEV',
+ ],
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'description' => 'The response parameters.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'HttpStatusCode' => [
+ 'description' => 'The HTTP status code.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '200',
+ ],
+ 'Data' => [
+ 'description' => 'The result returned.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message.'."\n",
+ 'type' => 'string',
+ 'example' => 'The connection does not exist.',
+ ],
+ 'RequestId' => [
+ 'description' => 'The request ID.'."\n",
+ 'type' => 'string',
+ 'example' => 'E6F0DBDD-5AD****',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code.'."\n",
+ 'type' => 'string',
+ 'example' => 'Invalid.Tenant.ConnectionNotExists',
+ ],
+ 'Success' => [
+ 'description' => 'Indicates whether the request was successful.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Data\\": true,\\n \\"ErrorMessage\\": \\"The connection does not exist.\\",\\n \\"RequestId\\": \\"E6F0DBDD-5AD****\\",\\n \\"ErrorCode\\": \\"Invalid.Tenant.ConnectionNotExists\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<ResumeInstanceResponse>\\n <HttpStatusCode>200</HttpStatusCode>\\n <Data>true</Data>\\n <ErrorMessage>The connection does not exist.</ErrorMessage>\\n <RequestId>E6F0DBDD-5AD****</RequestId>\\n <ErrorCode>Invalid.Tenant.ConnectionNotExists</ErrorCode>\\n <Success>true</Success>\\n</ResumeInstanceResponse>","errorExample":""}]',
+ 'title' => 'ResumeInstance',
+ 'requestParamsDescription' => ' ',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ ],
+ 'RunCycleDagNodes' => [
+ 'summary' => 'Creates a workflow to backfill data.',
+ 'methods' => [
+ 'post',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'readAndWrite',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'get',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeCode' => '78346',
+ 'abilityTreeNodes' => [
+ 'FEATUREdide7WF1GB',
+ ],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'ProjectEnv',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The environment of the workspace. Valid values: PROD and DEV. The value PROD indicates the production environment, and the value DEV indicates the development environment.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'PROD',
+ 'enum' => [
+ 'PROD',
+ 'DEV',
+ ],
+ ],
+ ],
+ [
+ 'name' => 'StartBizDate',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The data timestamp at which data starts to be backfilled. Specify the value in the yyyy-MM-dd 00:00:00 format.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => '2020-05-20 00:00:00',
+ ],
+ ],
+ [
+ 'name' => 'Name',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The name of the workflow.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'xm_test',
+ 'maxLength' => 128,
+ ],
+ ],
+ [
+ 'name' => 'RootNodeId',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The ID of the node for which data is first backfilled. You can call the [ListNodes](~~173979~~) operation to obtain the node ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => '1234',
+ ],
+ ],
+ [
+ 'name' => 'ExcludeNodeIds',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The IDs of the nodes for which no data needs to be backfilled. The system generates dry-run instances for all these nodes. After these dry-run instances are scheduled, the statuses of these instances are directly set to successful, but the script is not run.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'docRequired' => false,
+ 'example' => '1234,123465',
+ ],
+ ],
+ [
+ 'name' => 'BizBeginTime',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The time when the node starts to run. This parameter is required only for auto triggered nodes that are scheduled by hour. Specify the value in the HH:mm:ss format. Valid values: 00:00:00 to 23:59:59.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'docRequired' => false,
+ 'example' => '00:00:00',
+ ],
+ ],
+ [
+ 'name' => 'BizEndTime',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The time when the node stops running. This parameter is required only for auto triggered nodes that are scheduled by hour. Specify the value in the HH:mm:ss format. Valid values: 00:00:00 to 23:59:59.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'docRequired' => false,
+ 'example' => '01:00:00',
+ ],
+ ],
+ [
+ 'name' => 'Parallelism',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'Specifies whether data can be backfilled for multiple nodes at the same time.'."\n",
+ 'type' => 'boolean',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'false',
+ ],
+ ],
+ [
+ 'name' => 'EndBizDate',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The data timestamp at which data is no longer backfilled. Specify the value in the yyyy-MM-dd 00:00:00 format.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => '2020-05-21 00:00:00',
+ ],
+ ],
+ [
+ 'name' => 'NodeParams',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The parameters that need to be configured for the node. Set this parameter to a JSON string. The key indicates the ID of the node, and the value indicates the actual values of the parameters.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'docRequired' => false,
+ 'example' => '{74324:"a=123 b=456"}',
+ ],
+ ],
+ [
+ 'name' => 'IncludeNodeIds',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The ID of the node for which you want to backfill data. If you want to backfill data for multiple nodes, separate the IDs of the nodes with commas (,). You can call the [ListNodes](~~173979~~) operation to obtain the node ID.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => '74324,74325',
+ ],
+ ],
+ [
+ 'name' => 'StartFutureInstanceImmediately',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'Specifies whether to immediately run an instance that is scheduled to run in the future. If you set this parameter to true, the instance that is scheduled to run in the future is run immediately. Otherwise, the instance is run as scheduled.'."\n",
+ 'type' => 'boolean',
+ 'required' => false,
+ 'example' => 'false',
+ 'default' => 'false',
+ ],
+ ],
+ [
+ 'name' => 'ConcurrentRuns',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The number of nodes that can run in parallel. Valid values: 2 to 10.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => false,
+ 'maximum' => '10',
+ 'minimum' => '2',
+ 'example' => '5',
+ ],
+ ],
+ [
+ 'name' => 'AlertType',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The alert type. Valid values:'."\n"
+ ."\n"
+ .'* SUCCESS: An alert is generated when data backfill succeeds.'."\n"
+ .'* FAILURE: An alert is generated when data backfill fails.'."\n"
+ .'* SUCCESS_FAILURE: An alert is generated regardless of whether data backfill succeeds or fails.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'enumValueTitles' => [],
+ 'example' => 'FAILURE',
+ 'enum' => [
+ 'SUCCESS',
+ 'FAILURE',
+ 'SUCCESS_FAILURE',
+ ],
+ ],
+ ],
+ [
+ 'name' => 'AlertNoticeType',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The alert notification method. Valid values:'."\n"
+ ."\n"
+ .'* SMS'."\n"
+ .'* MAIL'."\n"
+ .'* SMS_MAIL'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'enumValueTitles' => [],
+ 'example' => 'SMS',
+ 'enum' => [
+ 'SMS',
+ 'MAIL',
+ 'SMS_MAIL',
+ ],
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'description' => 'The response parameters.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'HttpStatusCode' => [
+ 'description' => 'The HTTP status code.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '200',
+ ],
+ 'RequestId' => [
+ 'description' => 'The request ID. You can use the request ID to query logs and troubleshoot issues.'."\n",
+ 'type' => 'string',
+ 'example' => '>E6F0DBDD-5AD****',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message.'."\n",
+ 'type' => 'string',
+ 'example' => 'The connection does not exist.',
+ ],
+ 'Success' => [
+ 'description' => 'Indicates whether the request was successful.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code.'."\n",
+ 'type' => 'string',
+ 'example' => 'Invalid.Tenant.ConnectionNotExists',
+ ],
+ 'Data' => [
+ 'description' => 'The IDs of the nodes in the workflow. You can query instances based on the IDs.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The ID of the node in the workflow.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '111',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\">E6F0DBDD-5AD****\\",\\n \\"ErrorMessage\\": \\"The connection does not exist.\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"Invalid.Tenant.ConnectionNotExists\\",\\n \\"Data\\": [\\n 111\\n ]\\n}","errorExample":""},{"type":"xml","example":"<RunCycleDagNodesResponse>\\n <HttpStatusCode>200</HttpStatusCode>\\n <RequestId>&gt;E6F0DBDD-5AD****</RequestId>\\n <ErrorMessage>The connection does not exist.</ErrorMessage>\\n <Success>true</Success>\\n <ErrorCode>Invalid.Tenant.ConnectionNotExists</ErrorCode>\\n <Data>111</Data>\\n</RunCycleDagNodesResponse>","errorExample":""}]',
+ 'title' => 'RunCycleDagNodes',
+ 'description' => 'For more information about data backfill, see [Backfill data](~~137937~~).'."\n",
+ 'requestParamsDescription' => ' ',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ ],
+ 'RunSmokeTest' => [
+ 'methods' => [
+ 'post',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'readAndWrite',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'get',
+ 'abilityTreeCode' => '78348',
+ 'abilityTreeNodes' => [
+ 'FEATUREdide7WF1GB',
+ ],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'ProjectEnv',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The environment of the workspace. Valid values: PROD and DEV. The value PROD indicates the production environment, and the value DEV indicates the development environment. A workspace in basic mode does not have a development environment. For more information, see [Differences between workspaces in basic mode and workspaces in standard mode](~~85772~~).'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'PROD',
+ 'enum' => [
+ 'PROD',
+ 'DEV',
+ ],
+ ],
+ ],
+ [
+ 'name' => 'Bizdate',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The data timestamp.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => '2020-05-26 00:00:00',
+ ],
+ ],
+ [
+ 'name' => 'Name',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The name of the workflow.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'xm_create_test',
+ 'maxLength' => 128,
+ ],
+ ],
+ [
+ 'name' => 'NodeId',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The node ID. You can call the [ListNodes](~~173979~~) operation to query the ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => '1234',
+ ],
+ ],
+ [
+ 'name' => 'NodeParams',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The parameters related to the node. Set this parameter to a JSON string. A key in the string indicates a parameter, and a value in the string indicates the value of the related parameter.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'docRequired' => false,
+ 'example' => 'bizdate=$bizdate tbods=$tbods',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'description' => 'The data returned.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'HttpStatusCode' => [
+ 'description' => 'The HTTP status code.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '200',
+ ],
+ 'Data' => [
+ 'description' => 'The workflow ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '3333333',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message.'."\n",
+ 'type' => 'string',
+ 'example' => 'The connection does not exist.',
+ ],
+ 'RequestId' => [
+ 'description' => 'The request ID. You can use the ID to locate logs and troubleshoot issues.'."\n",
+ 'type' => 'string',
+ 'example' => 'E6F0DBDD-5AD****',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code.'."\n",
+ 'type' => 'string',
+ 'example' => 'Invalid.Tenant.ConnectionNotExists',
+ ],
+ 'Success' => [
+ 'description' => 'Indicates whether the request was successful.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'false',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Data\\": 3333333,\\n \\"ErrorMessage\\": \\"The connection does not exist.\\",\\n \\"RequestId\\": \\"E6F0DBDD-5AD****\\",\\n \\"ErrorCode\\": \\"Invalid.Tenant.ConnectionNotExists\\",\\n \\"Success\\": false\\n}","errorExample":""},{"type":"xml","example":"<RunSmokeTestResponse>\\n <HttpStatusCode>200</HttpStatusCode>\\n <Data>3333333</Data>\\n <ErrorMessage>The connection does not exist.</ErrorMessage>\\n <RequestId>E6F0DBDD-5AD****</RequestId>\\n <ErrorCode>Invalid.Tenant.ConnectionNotExists</ErrorCode>\\n <Success>false</Success>\\n</RunSmokeTestResponse>","errorExample":""}]',
+ 'title' => 'RunSmokeTest',
+ 'summary' => 'Creates a workflow to perform smoke testing.',
+ 'requestParamsDescription' => ' ',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ ],
+ 'ListSuccessInstanceAmount' => [
+ 'methods' => [
+ 'post',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'list',
+ 'abilityTreeCode' => '78335',
+ 'abilityTreeNodes' => [
+ 'FEATUREdideXLVI81',
+ ],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'ProjectId',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The DataWorks workspace ID. You can log on to the DataWorks console and go to the Workspace page to obtain the workspace ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => true,
+ 'docRequired' => true,
+ 'maximum' => '99999999999',
+ 'minimum' => '2',
+ 'example' => '9527',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'description' => 'The response parameters.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'description' => 'The request ID.'."\n",
+ 'type' => 'string',
+ 'example' => '952795279527ab****',
+ ],
+ 'InstanceStatusTrend' => [
+ 'description' => 'Indicates the trend of the number of auto triggered node instances that are successfully run every hour on the hour of the current day.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'TodayTrend' => [
+ 'description' => 'The trend of the number of auto triggered node instances that are successfully run on the current day.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '',
+ 'type' => 'object',
+ 'properties' => [
+ 'TimePoint' => [
+ 'description' => 'The point in time. The value is an exact hour that ranges from 00:00 to 23:00, such as 00:00, 01:00, or 02:00.'."\n",
+ 'type' => 'string',
+ 'example' => '01:00',
+ ],
+ 'Count' => [
+ 'description' => 'The number of instances that are successfully run.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '10',
+ ],
+ ],
+ ],
+ ],
+ 'YesterdayTrend' => [
+ 'description' => 'The trend of the number of auto triggered node instances that are successfully run one day earlier than the current day.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '',
+ 'type' => 'object',
+ 'properties' => [
+ 'TimePoint' => [
+ 'description' => 'The point in time. The value is an exact hour that ranges from 00:00 to 23:00, such as 00:00, 01:00, or 02:00.'."\n",
+ 'type' => 'string',
+ 'example' => '01:00',
+ ],
+ 'Count' => [
+ 'description' => 'The number of instances that are successfully run.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '10',
+ ],
+ ],
+ ],
+ ],
+ 'AvgTrend' => [
+ 'description' => 'The average trend.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '',
+ 'type' => 'object',
+ 'properties' => [
+ 'TimePoint' => [
+ 'description' => 'The point in time. The value is an exact hour that ranges from 00:00 to 23:00, such as 00:00, 01:00, or 02:00.'."\n",
+ 'type' => 'string',
+ 'example' => '01:00',
+ ],
+ 'Count' => [
+ 'description' => 'The number of instances that are successfully run.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '10',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'errorCodes' => [
+ 403 => [
+ [
+ 'errorCode' => 'ResourceNotAuthorized.Api',
+ 'errorMessage' => 'You are not authorized to access the resources.',
+ ],
+ [
+ 'errorCode' => 'Forbidden.Access',
+ 'errorMessage' => 'Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.',
+ ],
+ ],
+ 429 => [
+ [
+ 'errorCode' => 'Throttling.Api',
+ 'errorMessage' => 'The request for this resource has exceeded your available limit.',
+ ],
+ [
+ 'errorCode' => 'Throttling.Api.Risk',
+ 'errorMessage' => 'The request for this resource has exceeded your daily available limit.',
+ ],
+ [
+ 'errorCode' => 'Throttling.Resource',
+ 'errorMessage' => 'You have reached the limit for the resource. Please contact us by submitting a ticket.',
+ ],
+ [
+ 'errorCode' => 'Throttling.System',
+ 'errorMessage' => 'The DataWorks system is busy. Try again later.',
+ ],
+ [
+ 'errorCode' => 'Throttling.User',
+ 'errorMessage' => 'Your request is too frequent. Try again later.',
+ ],
+ ],
+ 500 => [
+ [
+ 'errorCode' => 'Forbidden.Not.Server',
+ 'errorMessage' => 'The dataworksAPI service is not available in this area. Please try it in another area.',
+ ],
+ [
+ 'errorCode' => 'InternalError.System',
+ 'errorMessage' => 'An internal system error occurred. Try again later.',
+ ],
+ [
+ 'errorCode' => 'InternalError.UserId.Missing',
+ 'errorMessage' => 'An internal system error occurred. Try again later.',
+ ],
+ [
+ 'errorCode' => 'Forbidden.Wkbench.ProjectNoPermission',
+ 'errorMessage' => 'You are not authorized to access the workspace.',
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"952795279527ab****\\",\\n \\"InstanceStatusTrend\\": {\\n \\"TodayTrend\\": [\\n {\\n \\"TimePoint\\": \\"01:00\\",\\n \\"Count\\": 10\\n }\\n ],\\n \\"YesterdayTrend\\": [\\n {\\n \\"TimePoint\\": \\"01:00\\",\\n \\"Count\\": 10\\n }\\n ],\\n \\"AvgTrend\\": [\\n {\\n \\"TimePoint\\": \\"01:00\\",\\n \\"Count\\": 10\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<ListSuccessInstanceAmountResponse>\\n <RequestId>952795279527ab****</RequestId>\\n <InstanceStatusTrend>\\n <TodayTrend>\\n <TimePoint>01:00</TimePoint>\\n <Count>10</Count>\\n </TodayTrend>\\n <YesterdayTrend>\\n <TimePoint>01:00</TimePoint>\\n <Count>10</Count>\\n </YesterdayTrend>\\n <AvgTrend>\\n <TimePoint>01:00</TimePoint>\\n <Count>10</Count>\\n </AvgTrend>\\n </InstanceStatusTrend>\\n</ListSuccessInstanceAmountResponse>","errorExample":""}]',
+ 'title' => 'ListSuccessInstanceAmount',
+ 'summary' => 'Queries the trend of the number of auto triggered node instances that are successfully run every hour on the hour of the current day.',
+ 'requestParamsDescription' => ' ',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ ],
+ 'ListInstanceAmount' => [
+ 'methods' => [
+ 'post',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'get',
+ 'abilityTreeCode' => '78314',
+ 'abilityTreeNodes' => [
+ 'FEATUREdideXLVI81',
+ ],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'ProjectId',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The DataWorks workspace ID. You can log on to the DataWorks console and go to the Work space page to obtain the workspace ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => true,
+ 'docRequired' => true,
+ 'maximum' => '99999999999',
+ 'minimum' => '2',
+ 'example' => '10000',
+ ],
+ ],
+ [
+ 'name' => 'BeginDate',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The beginning of the time range to query, accurate to the day. Specify the time in the ISO 8601 standard in the yyyy-MM-dd\'T\'HH:mm:ssZ format. The time must be in UTC.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => '2021-06-13T00:00:00+0800',
+ ],
+ ],
+ [
+ 'name' => 'EndDate',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The end of the time range to query, accurate to the day. Specify the time in the ISO 8601 standard in the yyyy-MM-dd\'T\'HH:mm:ssZ format. The time must be in UTC.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => '2021-06-16T00:00:00+0800',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'description' => 'The response parameters.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'description' => 'The request ID.'."\n",
+ 'type' => 'string',
+ 'example' => '95279527adhfj****',
+ ],
+ 'InstanceCounts' => [
+ 'description' => 'The trend of the number of auto triggered node instances within the specified period of time.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '',
+ 'type' => 'object',
+ 'properties' => [
+ 'Date' => [
+ 'description' => 'The data timestamp at which the number of auto triggered node instances was obtained. This value is a UNIX timestamp.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '1623772800000',
+ ],
+ 'Count' => [
+ 'description' => 'The number of auto triggered node instances.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '9527',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'errorCodes' => [
+ 403 => [
+ [
+ 'errorCode' => 'ResourceNotAuthorized.Api',
+ 'errorMessage' => 'You are not authorized to access the resources.',
+ ],
+ [
+ 'errorCode' => 'Forbidden.Access',
+ 'errorMessage' => 'Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.',
+ ],
+ ],
+ 429 => [
+ [
+ 'errorCode' => 'Throttling.Api',
+ 'errorMessage' => 'The request for this resource has exceeded your available limit.',
+ ],
+ [
+ 'errorCode' => 'Throttling.Api.Risk',
+ 'errorMessage' => 'The request for this resource has exceeded your daily available limit.',
+ ],
+ [
+ 'errorCode' => 'Throttling.Resource',
+ 'errorMessage' => 'You have reached the limit for the resource. Please contact us by submitting a ticket.',
+ ],
+ [
+ 'errorCode' => 'Throttling.System',
+ 'errorMessage' => 'The DataWorks system is busy. Try again later.',
+ ],
+ [
+ 'errorCode' => 'Throttling.User',
+ 'errorMessage' => 'Your request is too frequent. Try again later.',
+ ],
+ ],
+ 500 => [
+ [
+ 'errorCode' => 'Forbidden.Not.Server',
+ 'errorMessage' => 'The dataworksAPI service is not available in this area. Please try it in another area.',
+ ],
+ [
+ 'errorCode' => 'InternalError.System',
+ 'errorMessage' => 'An internal system error occurred. Try again later.',
+ ],
+ [
+ 'errorCode' => 'InternalError.UserId.Missing',
+ 'errorMessage' => 'An internal system error occurred. Try again later.',
+ ],
+ [
+ 'errorCode' => 'Forbidden.Wkbench.NoProject',
+ 'errorMessage' => 'You have not joined any project.',
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"95279527adhfj****\\",\\n \\"InstanceCounts\\": [\\n {\\n \\"Date\\": 1623772800000,\\n \\"Count\\": 9527\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<ListInstanceAmountResponse>\\n <RequestId>95279527adhfj****</RequestId>\\n <InstanceCounts>\\n <Date>1623772800000</Date>\\n <Count>9527</Count>\\n </InstanceCounts>\\n</ListInstanceAmountResponse>","errorExample":""}]',
+ 'title' => 'ListInstanceAmount',
+ 'summary' => 'Queries the trend of the number of auto triggered node instances within a specified period of time.',
+ 'requestParamsDescription' => ' ',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ ],
+ 'TopTenElapsedTimeInstance' => [
+ 'methods' => [
+ 'post',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'get',
+ 'abilityTreeCode' => '78364',
+ 'abilityTreeNodes' => [
+ 'FEATUREdideXLVI81',
+ ],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'ProjectId',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The DataWorks workspace ID. You can log on to the DataWorks console and go to the Workspace page to query the ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => true,
+ 'docRequired' => true,
+ 'maximum' => '99999999999',
+ 'minimum' => '2',
+ 'example' => '100000',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'description' => 'The response parameters.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'description' => 'The request ID.'."\n",
+ 'type' => 'string',
+ 'example' => '6347364dadsfadf****',
+ ],
+ 'InstanceConsumeTimeRank' => [
+ 'description' => 'The ranking record of the running durations of the instances.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'UpdateTime' => [
+ 'description' => 'The timestamp at which the ranking of the running durations of the instances was updated.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '1600963200000',
+ ],
+ 'ConsumeTimeRank' => [
+ 'description' => 'The ranking data of the running durations of the instances.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The returned data.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'Owner' => [
+ 'description' => 'The ID of the Alibaba Cloud account used by the node owner.'."\n",
+ 'type' => 'string',
+ 'example' => '952795279527',
+ ],
+ 'NodeName' => [
+ 'description' => 'The name of the node.'."\n",
+ 'type' => 'string',
+ 'example' => 'Node name',
+ ],
+ 'BusinessDate' => [
+ 'description' => 'The data timestamp of the instance.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '1600963200000',
+ ],
+ 'ProgramType' => [
+ 'description' => 'The type of the node. Valid values: 6 (Shell), 10 (ODPS SQL), 11 (ODPS MR), 23 (Data Integration), 24 (ODPS Script), 99 (zero load), 221 (PyODPS 2), 225 (ODPS Spark), 227 (EMR Hive), 228 (EMR Spark), 229 (EMR Spark SQL), 230 (EMR MR), 239 (OSS object inspection), 257 (EMR Shell), 258 (EMR Spark Shell), 259 (EMR Presto), 260 (EMR Impala), 900 (real-time synchronization), 1089 (cross-tenant collaboration), 1091 (Hologres development), 1093 (Hologres SQL), 1100 (assignment), and 1221 (PyODPS 3)'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '10',
+ ],
+ 'InstanceId' => [
+ 'description' => 'The instance ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '95279527',
+ ],
+ 'NodeId' => [
+ 'description' => 'The node ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '9527',
+ ],
+ 'Consumed' => [
+ 'description' => 'The run time length of the instance. Unit: seconds.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '1000',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'errorCodes' => [
+ 403 => [
+ [
+ 'errorCode' => 'ResourceNotAuthorized.Api',
+ 'errorMessage' => 'You are not authorized to access the resources.',
+ ],
+ [
+ 'errorCode' => 'Forbidden.Access',
+ 'errorMessage' => 'Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.',
+ ],
+ ],
+ 429 => [
+ [
+ 'errorCode' => 'Throttling.Api',
+ 'errorMessage' => 'The request for this resource has exceeded your available limit.',
+ ],
+ [
+ 'errorCode' => 'Throttling.Api.Risk',
+ 'errorMessage' => 'The request for this resource has exceeded your daily available limit.',
+ ],
+ [
+ 'errorCode' => 'Throttling.Resource',
+ 'errorMessage' => 'You have reached the limit for the resource. Please contact us by submitting a ticket.',
+ ],
+ [
+ 'errorCode' => 'Throttling.System',
+ 'errorMessage' => 'The DataWorks system is busy. Try again later.',
+ ],
+ [
+ 'errorCode' => 'Throttling.User',
+ 'errorMessage' => 'Your request is too frequent. Try again later.',
+ ],
+ ],
+ 500 => [
+ [
+ 'errorCode' => 'Forbidden.Not.Server',
+ 'errorMessage' => 'The dataworksAPI service is not available in this area. Please try it in another area.',
+ ],
+ [
+ 'errorCode' => 'InternalError.System',
+ 'errorMessage' => 'An internal system error occurred. Try again later.',
+ ],
+ [
+ 'errorCode' => 'InternalError.UserId.Missing',
+ 'errorMessage' => 'An internal system error occurred. Try again later.',
+ ],
+ [
+ 'errorCode' => 'Forbidden.Wkbench.ProjectNoPermission',
+ 'errorMessage' => 'You are not authorized to access the workspace.',
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"6347364dadsfadf****\\",\\n \\"InstanceConsumeTimeRank\\": {\\n \\"UpdateTime\\": 1600963200000,\\n \\"ConsumeTimeRank\\": [\\n {\\n \\"Owner\\": \\"952795279527\\",\\n \\"NodeName\\": \\"Node name\\",\\n \\"BusinessDate\\": 1600963200000,\\n \\"ProgramType\\": 10,\\n \\"InstanceId\\": 95279527,\\n \\"NodeId\\": 9527,\\n \\"Consumed\\": 1000\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<TopTenElapsedTimeInstanceResponse>\\n <RequestId>6347364dadsfadf****</RequestId>\\n <InstanceConsumeTimeRank>\\n <UpdateTime>1600963200000</UpdateTime>\\n <ConsumeTimeRank>\\n <Owner>952795279527</Owner>\\n <NodeName>节点名称</NodeName>\\n <BusinessDate>1600963200000</BusinessDate>\\n <ProgramType>10</ProgramType>\\n <InstanceId>95279527</InstanceId>\\n <NodeId>9527</NodeId>\\n <Consumed>1000</Consumed>\\n </ConsumeTimeRank>\\n </InstanceConsumeTimeRank>\\n</TopTenElapsedTimeInstanceResponse>","errorExample":""}]',
+ 'title' => 'TopTenElapsedTimeInstance',
+ 'summary' => 'Queries the ranking of the running durations of instances.',
+ 'requestParamsDescription' => ' ',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ ],
+ 'TopTenErrorTimesInstance' => [
+ 'methods' => [
+ 'post',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'get',
+ 'abilityTreeCode' => '78365',
+ 'abilityTreeNodes' => [
+ 'FEATUREdideXLVI81',
+ ],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'ProjectId',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The DataWorks workspace ID. You can log on to the DataWorks console and go to the Workspace page to query the ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => true,
+ 'docRequired' => true,
+ 'maximum' => '99999999999',
+ 'minimum' => '2',
+ 'example' => '9527',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'description' => 'The response parameters.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'description' => 'The request ID.'."\n",
+ 'type' => 'string',
+ 'example' => '952795279527****',
+ ],
+ 'InstanceErrorRank' => [
+ 'description' => 'The ranking data of nodes on which errors occurred.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'UpdateTime' => [
+ 'description' => 'The timestamp at which the rankings were updated.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '1600963200000',
+ ],
+ 'ErrorRank' => [
+ 'description' => 'The ranking data of nodes on which errors occurred within the last month.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The returned data.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'Owner' => [
+ 'description' => 'The ID of the Alibaba Cloud account used by the node owner.'."\n",
+ 'type' => 'string',
+ 'example' => '952795279527',
+ ],
+ 'NodeName' => [
+ 'description' => 'The name of the node.'."\n",
+ 'type' => 'string',
+ 'example' => 'Node name',
+ ],
+ 'ProjectId' => [
+ 'description' => 'The DataWorks workspace ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '9527',
+ ],
+ 'ProgramType' => [
+ 'description' => 'The type of the node. Valid values: 6 (Shell), 10 (ODPS SQL), 11 (ODPS MR), 23 (Data Integration), 24 (ODPS Script), 99 (zero load), 221 (PyODPS 2), 225 (ODPS Spark), 227 (EMR Hive), 228 (EMR Spark), 229 (EMR Spark SQL), 230 (EMR MR), 239 (OSS object inspection), 257 (EMR Shell), 258 (EMR Spark Shell), 259 (EMR Presto), 260 (EMR Impala), 900 (real-time synchronization), 1089 (cross-tenant collaboration), 1091 (Hologres development), 1093 (Hologres SQL), 1100 (assignment), and 1221 (PyODPS 3)'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '10',
+ ],
+ 'NodeId' => [
+ 'description' => 'The node ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '9527',
+ ],
+ 'Count' => [
+ 'description' => 'The number of errors that occurred on the node.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '5',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'errorCodes' => [
+ 403 => [
+ [
+ 'errorCode' => 'ResourceNotAuthorized.Api',
+ 'errorMessage' => 'You are not authorized to access the resources.',
+ ],
+ [
+ 'errorCode' => 'Forbidden.Access',
+ 'errorMessage' => 'Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.',
+ ],
+ ],
+ 429 => [
+ [
+ 'errorCode' => 'Throttling.Api',
+ 'errorMessage' => 'The request for this resource has exceeded your available limit.',
+ ],
+ [
+ 'errorCode' => 'Throttling.Api.Risk',
+ 'errorMessage' => 'The request for this resource has exceeded your daily available limit.',
+ ],
+ [
+ 'errorCode' => 'Throttling.Resource',
+ 'errorMessage' => 'You have reached the limit for the resource. Please contact us by submitting a ticket.',
+ ],
+ [
+ 'errorCode' => 'Throttling.System',
+ 'errorMessage' => 'The DataWorks system is busy. Try again later.',
+ ],
+ [
+ 'errorCode' => 'Throttling.User',
+ 'errorMessage' => 'Your request is too frequent. Try again later.',
+ ],
+ ],
+ 500 => [
+ [
+ 'errorCode' => 'Forbidden.Not.Server',
+ 'errorMessage' => 'The dataworksAPI service is not available in this area. Please try it in another area.',
+ ],
+ [
+ 'errorCode' => 'InternalError.System',
+ 'errorMessage' => 'An internal system error occurred. Try again later.',
+ ],
+ [
+ 'errorCode' => 'InternalError.UserId.Missing',
+ 'errorMessage' => 'An internal system error occurred. Try again later.',
+ ],
+ [
+ 'errorCode' => 'Forbidden.Wkbench.ProjectNoPermission',
+ 'errorMessage' => 'You are not authorized to access the workspace.',
+ ],
+ [
+ 'errorCode' => 'Invalid.Wkbench.Parameter',
+ 'errorMessage' => 'The specified parameters are invalid.',
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"952795279527****\\",\\n \\"InstanceErrorRank\\": {\\n \\"UpdateTime\\": 1600963200000,\\n \\"ErrorRank\\": [\\n {\\n \\"Owner\\": \\"952795279527\\",\\n \\"NodeName\\": \\"Node name\\",\\n \\"ProjectId\\": 9527,\\n \\"ProgramType\\": 10,\\n \\"NodeId\\": 9527,\\n \\"Count\\": 5\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<TopTenErrorTimesInstanceResponse>\\n <RequestId>952795279527****</RequestId>\\n <InstanceErrorRank>\\n <UpdateTime>1600963200000</UpdateTime>\\n <ErrorRank>\\n <Owner>952795279527</Owner>\\n <NodeName>节点名称</NodeName>\\n <ProjectId>9527</ProjectId>\\n <ProgramType>10</ProgramType>\\n <NodeId>9527</NodeId>\\n <Count>5</Count>\\n </ErrorRank>\\n </InstanceErrorRank>\\n</TopTenErrorTimesInstanceResponse>","errorExample":""}]',
+ 'title' => 'TopTenErrorTimesInstance',
+ 'summary' => 'Queries the ranking of nodes on which errors occur within the previous month.',
+ 'requestParamsDescription' => ' ',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ ],
+ 'GetFileTypeStatistic' => [
+ 'methods' => [
+ 'post',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'get',
+ 'abilityTreeCode' => '78246',
+ 'abilityTreeNodes' => [
+ 'FEATUREdide7WF1GB',
+ ],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'ProjectId',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The ID of the DataWorks workspace. You can log on to the DataWorks console and go to the Workspace Management page to obtain the ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => true,
+ 'docRequired' => true,
+ 'maximum' => '9223372036854775807',
+ 'minimum' => '1',
+ 'example' => '123465',
+ 'isFileTransferUrl' => false,
+ ],
+ ],
+ [
+ 'name' => 'ProjectEnv',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The environment of the workspace. Valid values: PROD and DEV. The value PROD indicates the production environment. The value DEV indicates the development environment.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'PROD',
+ 'isFileTransferUrl' => false,
+ 'enum' => [
+ 'PROD',
+ 'DEV',
+ ],
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'description' => 'The ID of the request. You can use the ID to locate logs and troubleshoot issues.'."\n",
+ 'type' => 'string',
+ 'example' => 'SDFSDFSDF-SDFSDF-SDFDSF-SDFSDF',
+ ],
+ 'ProgramTypeAndCounts' => [
+ 'description' => 'An array of node types and quantity.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'Count' => [
+ 'description' => 'The number of nodes.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '1',
+ ],
+ 'ProgramType' => [
+ 'description' => 'The type of the node.'."\n"
+ ."\n"
+ .'Valid values:'."\n"
+ ."\n"
+ .'6 (Shell node), 10 (ODPS SQL node), 11 (ODPS MR node), 23 (Data Integration node), 24 (ODPS Script node), 99 (zero load node), 221 (PyODPS 2 node), 225 (ODPS Spark node), 227 (EMR Hive node), 228 (EMR Spark node), 229 (EMR Spark SQL node), 230 (EMR MR node), 239 (OSS object inspection node), 257 (EMR Shell node), 258 (EMR Spark Shell node), 259 (EMR Presto node), 260 (EMR Impala node), 900 (real-time data synchronization node), 1089 (cross-tenant collaboration node), 1091 (Hologres development node), 1093 (Hologres SQL node), 1100 (assignment node), and 1221 (PyODPS 3 node).'."\n",
+ 'type' => 'string',
+ 'example' => 'ODPS_SQL',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"SDFSDFSDF-SDFSDF-SDFDSF-SDFSDF\\",\\n \\"ProgramTypeAndCounts\\": [\\n {\\n \\"Count\\": 1,\\n \\"ProgramType\\": \\"ODPS_SQL\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<RequestId>SDFSDFSDF-SDFSDF-SDFDSF-SDFSDF</RequestId>\\n<ProgramTypeAndCounts>\\n <Count>1</Count>\\n <ProgramType>ODPS_SQL</ProgramType>\\n</ProgramTypeAndCounts>","errorExample":""}]',
+ 'title' => 'GetFileTypeStatistic',
+ 'summary' => 'Queries the distribution of node types.',
+ 'requestParamsDescription' => ' ',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ ],
+ 'GetInstanceStatusStatistic' => [
+ 'methods' => [
+ 'post',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'get',
+ 'abilityTreeCode' => '78255',
+ 'abilityTreeNodes' => [
+ 'FEATUREdide7WF1GB',
+ ],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'ProjectId',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The DataWorks workspace ID. You can log on to the DataWorks console and go to the Workspace page to query the ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => true,
+ 'docRequired' => true,
+ 'maximum' => '9223372036854775807',
+ 'minimum' => '1',
+ 'example' => '1234',
+ 'isFileTransferUrl' => false,
+ ],
+ ],
+ [
+ 'name' => 'ProjectEnv',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The runtime environment. Valid values: PROD and DEV.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'enumValueTitles' => [],
+ 'example' => 'PROD',
+ 'isFileTransferUrl' => false,
+ 'enum' => [
+ 'PROD',
+ 'DEV',
+ ],
+ ],
+ ],
+ [
+ 'name' => 'BizDate',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The date on which the numbers of instances in different states are obtained. Specify the date in the yyyy-MM-dd format.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => '2020-01-01',
+ 'maxLength' => 10,
+ 'minLength' => 10,
+ 'isFileTransferUrl' => false,
+ ],
+ ],
+ [
+ 'name' => 'SchedulerType',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The scheduling type of the node. Valid values:'."\n"
+ ."\n"
+ .'* NORMAL: auto triggered node'."\n"
+ .'* MANUAL: manually triggered node'."\n"
+ .'* PAUSE: paused node'."\n"
+ .'* SKIP: dry-run node'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'enumValueTitles' => [],
+ 'example' => 'NORMAL',
+ 'enum' => [
+ 'NORMAL',
+ 'MANUAL',
+ 'PAUSE',
+ 'SKIP',
+ ],
+ ],
+ ],
+ [
+ 'name' => 'DagType',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The type of the directed acyclic graph (DAG). Valid values:'."\n"
+ ."\n"
+ .'* MANUAL: DAG for a manually triggered workflow'."\n"
+ .'* SMOKE_TEST: DAG for a smoke testing workflow'."\n"
+ .'* SUPPLY_DATA: DAG for a data backfill instance'."\n"
+ .'* BUSINESS_PROCESS_DAG: DAG for a one-time workflow'."\n"
+ ."\n"
+ .'<!---->'."\n"
+ ."\n"
+ .'* DAILY'."\n"
+ .'* MANUAL'."\n"
+ .'* SMOKE_TEST'."\n"
+ .'* SUPPLY_DATA'."\n"
+ .'* BUSINESS_PROCESS_DAG'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'enumValueTitles' => [],
+ 'example' => 'MANUAL',
+ 'enum' => [
+ 'DAILY',
+ 'MANUAL',
+ 'SMOKE_TEST',
+ 'SUPPLY_DATA',
+ 'BUSINESS_PROCESS_DAG',
+ ],
+ ],
+ ],
+ [
+ 'name' => 'SchedulerPeriod',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The scheduling cycle. Valid values:'."\n"
+ ."\n"
+ .'* MINUTE'."\n"
+ .'* HOUR'."\n"
+ .'* DAY'."\n"
+ .'* WEEK'."\n"
+ .'* MONTH'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'enumValueTitles' => [],
+ 'example' => 'DAY',
+ 'enum' => [
+ 'MINUTE',
+ 'HOUR',
+ 'DAY',
+ 'WEEK',
+ 'MONTH',
+ ],
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'description' => 'The response parameters.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'description' => 'The request ID.'."\n",
+ 'type' => 'string',
+ 'example' => '0000-ABCD-EFG****',
+ ],
+ 'StatusCount' => [
+ 'description' => 'The numbers of instances in different states.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'FailureCount' => [
+ 'description' => 'The number of instances that failed to run.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '1',
+ ],
+ 'WaitTimeCount' => [
+ 'description' => 'The number of instances that are waiting to run.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '1',
+ ],
+ 'RunningCount' => [
+ 'description' => 'The number of instances that are running.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '1',
+ ],
+ 'SuccessCount' => [
+ 'description' => 'The number of instances that are successfully run.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '1',
+ ],
+ 'TotalCount' => [
+ 'description' => 'The total number of instances returned.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '1',
+ ],
+ 'NotRunCount' => [
+ 'description' => 'The number of instances that are not run.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '1',
+ ],
+ 'WaitResCount' => [
+ 'description' => 'The number of instances that are waiting for resources.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '1',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"0000-ABCD-EFG****\\",\\n \\"StatusCount\\": {\\n \\"FailureCount\\": 1,\\n \\"WaitTimeCount\\": 1,\\n \\"RunningCount\\": 1,\\n \\"SuccessCount\\": 1,\\n \\"TotalCount\\": 1,\\n \\"NotRunCount\\": 1,\\n \\"WaitResCount\\": 1\\n }\\n}","errorExample":""},{"type":"xml","example":"<GetInstanceStatusStatisticResponse>\\n <RequestId>0000-ABCD-EFG****</RequestId>\\n <StatusCount>\\n <FailureCount>1</FailureCount>\\n <WaitTimeCount>1</WaitTimeCount>\\n <RunningCount>1</RunningCount>\\n <SuccessCount>1</SuccessCount>\\n <TotalCount>1</TotalCount>\\n <NotRunCount>1</NotRunCount>\\n <WaitResCount>1</WaitResCount>\\n </StatusCount>\\n</GetInstanceStatusStatisticResponse>","errorExample":""}]',
+ 'title' => 'GetInstanceStatusStatistic',
+ 'summary' => 'Queries the number of instances that are in each state.',
+ 'requestParamsDescription' => ' ',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ ],
+ 'ListFileType' => [
+ 'methods' => [
+ 'post',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'get',
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'ProjectId',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The DataWorks workspace ID. You can log on to the DataWorks console and go to the Workspace page to view the workspace ID. You must configure either this parameter or the ProjectIdentifier parameter to determine the DataWorks workspace to which the operation is applied.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'example' => '10000',
+ ],
+ ],
+ [
+ 'name' => 'ProjectIdentifier',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The name of the DataWorks workspace. You can log on to the DataWorks console and go to the Workspace page to view the workspace name. You must configure either this parameter or the ProjectId parameter to determine the DataWorks workspace to which the operation is applied.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'dw_project',
+ ],
+ ],
+ [
+ 'name' => 'PageNumber',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The page number.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => '1',
+ ],
+ ],
+ [
+ 'name' => 'PageSize',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The number of entries per page. Maximum value: 100.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => '50',
+ ],
+ ],
+ [
+ 'name' => 'Keyword',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The name of the node type. You can log on to the DataWorks console, go to the DataStudio page, and then view the name of a specific node type on the left side of the page. Take note of the following items when you configure this parameter:'."\n"
+ ."\n"
+ .'* You can view the name of a specific node type, but the language specified by this parameter to present the name must be the same as the language specified by the Locale parameter.'."\n"
+ .'* Fuzzy match is supported.'."\n"
+ .'* If this parameter is not configured, the names of all node types are returned.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'ODPS SQL',
+ ],
+ ],
+ [
+ 'name' => 'Locale',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The language that you use for the query. Valid values: zh-CN and en-US.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'zh-CN',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'description' => 'The request ID.'."\n",
+ 'type' => 'string',
+ 'example' => '0000-ABCD-EFG****',
+ ],
+ 'NodeTypeInfoList' => [
+ 'description' => 'The information about node types.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'PageNumber' => [
+ 'description' => 'The page number.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '1',
+ ],
+ 'PageSize' => [
+ 'description' => 'The number of entries per page.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '50',
+ ],
+ 'TotalCount' => [
+ 'description' => 'The total number of entries returned.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '127',
+ ],
+ 'NodeTypeInfo' => [
+ 'description' => 'The information about the node type.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'NodeTypeName' => [
+ 'description' => 'The name of the node type. The codes and names of node types have the following mappings: 6 (Shell), 10 (ODPS SQL), 11 (ODPS MR), 23 (Data Integration), 24 (ODPS Script), 99 (zero load), 221 (PyODPS 2), 225 (ODPS Spark), 227 (EMR Hive), 228 (EMR Spark), 229 (EMR Spark SQL), 230 (EMR MR), 239 (OSS object inspection), 257 (EMR Shell), 258 (EMR Spark Shell), 259 (EMR Presto), 260 (EMR Impala), 900 (real-time synchronization), 1089 (cross-tenant collaboration), 1091 (Hologres development), 1093 (Hologres SQL), 1100 (assignment), and 1221 (PyODPS 3)'."\n",
+ 'type' => 'string',
+ 'example' => 'ODPS SQL',
+ ],
+ 'NodeType' => [
+ 'description' => 'The code of the node type. The codes and names of node types have the following mappings: 6 (Shell), 10 (ODPS SQL), 11 (ODPS MR), 23 (Data Integration), 24 (ODPS Script), 99 (zero load), 221 (PyODPS 2), 225 (ODPS Spark), 227 (EMR Hive), 228 (EMR Spark), 229 (EMR Spark SQL), 230 (EMR MR), 239 (OSS object inspection), 257 (EMR Shell), 258 (EMR Spark Shell), 259 (EMR Presto), 260 (EMR Impala), 900 (real-time synchronization), 1089 (cross-tenant collaboration), 1091 (Hologres development), 1093 (Hologres SQL), 1100 (assignment), and 1221 (PyODPS 3)'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '10',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'description' => '',
+ ],
+ ],
+ ],
+ 'errorCodes' => [
+ 403 => [
+ [
+ 'errorCode' => 'Forbidden.Access',
+ 'errorMessage' => 'Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.',
+ ],
+ ],
+ 429 => [
+ [
+ 'errorCode' => 'Throttling.Api',
+ 'errorMessage' => 'The request for this resource has exceeded your available limit.',
+ ],
+ [
+ 'errorCode' => 'Throttling.System',
+ 'errorMessage' => 'The DataWorks system is busy. Try again later.',
+ ],
+ [
+ 'errorCode' => 'Throttling.User',
+ 'errorMessage' => 'Your request is too frequent. Try again later.',
+ ],
+ ],
+ 500 => [
+ [
+ 'errorCode' => 'InternalError.UserId.Missing',
+ 'errorMessage' => 'An internal system error occurred. Try again later.',
+ ],
+ [
+ 'errorCode' => 'InternalError.System',
+ 'errorMessage' => 'An internal system error occurred. Try again later.',
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"0000-ABCD-EFG****\\",\\n \\"NodeTypeInfoList\\": {\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 50,\\n \\"TotalCount\\": 127,\\n \\"NodeTypeInfo\\": [\\n {\\n \\"NodeTypeName\\": \\"ODPS SQL\\",\\n \\"NodeType\\": 10\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<ListFileTypeResponse>\\n <RequestId>0000-ABCD-EFG****</RequestId>\\n <NodeTypeInfoList>\\n <PageNumber>1</PageNumber>\\n <PageSize>50</PageSize>\\n <TotalCount>127</TotalCount>\\n <NodeTypeInfo>\\n <NodeTypeName>ODPS SQL</NodeTypeName>\\n <NodeType>10</NodeType>\\n </NodeTypeInfo>\\n </NodeTypeInfoList>\\n</ListFileTypeResponse>","errorExample":""}]',
+ 'title' => 'ListFileType',
+ 'summary' => 'Queries the information about node types, such as the code and name.',
+ 'requestParamsDescription' => ' ',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ ],
+ 'RunManualDagNodes' => [
+ 'methods' => [
+ 'post',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'readAndWrite',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'update',
+ 'abilityTreeCode' => '78347',
+ 'abilityTreeNodes' => [
+ 'FEATUREdideD0YY7B',
+ ],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'ProjectEnv',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The environment type of Operation Center. Valid values: PROD and DEV. The value PROD indicates the production environment. The value DEV indicates the development environment.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'enumValueTitles' => [],
+ 'example' => 'PROD or DEV',
+ 'enum' => [
+ 'PROD',
+ 'DEV',
+ ],
+ ],
+ ],
+ [
+ 'name' => 'ProjectName',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The name of the workspace to which the manually triggered workflow belongs.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'test_workspace',
+ 'pattern' => '^([^\\x00-\\xff]|[\\w.,;/@\\n-])+$',
+ ],
+ ],
+ [
+ 'name' => 'FlowName',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The name of the manually triggered workflow.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'test_workflow',
+ 'pattern' => '^([^\\x00-\\xff]|[\\w.,;/@\\n-])+$',
+ ],
+ ],
+ [
+ 'name' => 'BizDate',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The data timestamp. The value of the data timestamp must be one or more days before the current date. For example, if the current date is November 11, 2020, set the value to 2020-11-10 00:00:00 or earlier. Configure this parameter in the YYYY-MM-DD 00:00:00 format. The StartBizDate parameter is used together with the EndBizDate parameter. You can configure only the BizDate parameter or the StartBizDate and EndBizDate parameters.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'docRequired' => false,
+ 'example' => '2020-11-11 00:00:00',
+ ],
+ ],
+ [
+ 'name' => 'NodeParameters',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The scheduling parameters of nodes in the manually triggered workflow. Configure NodeParameters in the following JSON format: {"\\<ID of a node in the manually triggered workflow>": "Scheduling parameter settings of the node, which are in the same format as the parameter settings in the Scheduling Parameter section of the Properties tab on the DataStudio page", "\\<ID of a node in the manually triggered workflow>": "Scheduling parameter settings of the node, which are in the same format as the parameter settings in the Scheduling Parameter section of the Properties tab on the DataStudio page"}.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'docRequired' => false,
+ 'example' => '{"20000123121": "key1=val2 key2=val2", "20000123124": "kkkk=vvvvv aaaa=bbbb"}',
+ ],
+ ],
+ [
+ 'name' => 'DagParameters',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The parameters are synchronized to all the instances in the directed acyclic graph (DAG) of the workflow. If a workflow parameter specified in DagParameters is referenced as a scheduling parameter of a [node](~~147245~~), the value of the scheduling parameter is replaced with the value of the workflow parameter.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'docRequired' => false,
+ 'example' => '{"kaaaa": "vaaaaa", "kbbbb": "vbbbbb"}',
+ ],
+ ],
+ [
+ 'name' => 'IncludeNodeIds',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The IDs of the nodes that you need to run in the manually triggered workflow. Separate multiple node IDs with commas (,).'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => '74324,74325',
+ ],
+ ],
+ [
+ 'name' => 'ExcludeNodeIds',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The IDs of the nodes that you do not need to run in the manually triggered workflow. DataWorks generates dry-run instances for all these nodes. After the dry-run instances are scheduled, the states of these instances are directly set to successful, but the scripts are not run. Separate multiple node IDs with commas (,). The ExcludeNodeIds parameter must be used together with the IncludeNodeIds parameter. This way, the settings of the ExcludeNodeIds parameter can take effect.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => '123,456',
+ ],
+ ],
+ [
+ 'name' => 'ProjectId',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The ID of the workspace to which the manually triggered workflow belongs.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'example' => '123',
+ ],
+ ],
+ [
+ 'name' => 'StartBizDate',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The beginning of the time range in which data generated needs to be processed. Configure this parameter in the yyyy-MM-dd HH:mm:ss format. The StartBizDate parameter is used together with the EndBizDate parameter. You can configure only the BizDate parameter or the StartBizDate and EndBizDate parameters.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => '2020-02-02 00:00:00',
+ ],
+ ],
+ [
+ 'name' => 'EndBizDate',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The end of the time range in which data generated needs to be processed. Configure this parameter in the yyyy-MM-dd HH:mm:ss format. The StartBizDate parameter is used together with the EndBizDate parameter. You can configure only the BizDate parameter or the StartBizDate and EndBizDate parameters.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => '2020-02-03 00:00:00',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'description' => 'The response parameters.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'DagId' => [
+ 'description' => 'The ID of the DAG for the manually triggered workflow. You can call an operation with this parameter as a request parameter to query the details and states of the nodes in the manually triggered workflow.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '700000123123141',
+ ],
+ 'RequestId' => [
+ 'description' => 'The request ID.'."\n",
+ 'type' => 'string',
+ 'example' => 'AASFDFSDFG-DFSDF-DFSDFD-SDFSDF',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"DagId\\": 700000123123141,\\n \\"RequestId\\": \\"AASFDFSDFG-DFSDF-DFSDFD-SDFSDF\\"\\n}","errorExample":""},{"type":"xml","example":"<RunManualDagNodesResponse>\\n <DagId>700000123123141</DagId>\\n <RequestId>AASFDFSDFG-DFSDF-DFSDFD-SDFSDF</RequestId>\\n</RunManualDagNodesResponse>","errorExample":""}]',
+ 'title' => 'RunManualDagNodes',
+ 'summary' => 'Runs nodes in a manually triggered workflow. Before you call this operation, make sure that the manually triggered workflow is committed and deployed. You can find a manually triggered workflow in Operation Center only after the manually triggered workflow is committed and deployed.',
+ 'requestParamsDescription' => ' ',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ ],
+ 'ListManualDagInstances' => [
+ 'methods' => [
+ 'post',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'list',
+ 'abilityTreeCode' => '78316',
+ 'abilityTreeNodes' => [
+ 'FEATUREdideVFMENL',
+ ],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'ProjectEnv',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The environment of Operation Center. Valid values: PROD and DEV.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'RPOD',
+ 'enum' => [
+ 'PROD',
+ 'DEV',
+ ],
+ ],
+ ],
+ [
+ 'name' => 'ProjectName',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The name of the workspace to which the manually triggered workflow belongs. You can log on to the [DataWorks console](https://workbench.data.aliyun.com/console) and go to the Workspace page to obtain the name.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'test_workspace',
+ ],
+ ],
+ [
+ 'name' => 'DagId',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The ID of the directed acyclic graph (DAG) for the manually triggered workflow. You can call the [RunManualDagNodes](~~212830~~) operation to obtain the ID.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => '7000001231241',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'description' => 'The response parameters.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'description' => 'The request ID.'."\n",
+ 'type' => 'string',
+ 'example' => 'SDFSDFSDF-SDFSDF-SDFDSF-SDFSDF',
+ ],
+ 'Instances' => [
+ 'description' => 'The instances in the manually triggered workflow.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '',
+ 'type' => 'object',
+ 'properties' => [
+ 'Status' => [
+ 'description' => 'The status of the instance. Valid values:'."\n"
+ ."\n"
+ .'* NOT_RUN: The instance is not run.'."\n"
+ .'* WAIT_TIME: The instance is waiting for its scheduling time to arrive.'."\n"
+ .'* WAIT_RESOURCE: The instance is waiting for resources.'."\n"
+ .'* RUNNING: The instance is running.'."\n"
+ .'* CHECKING: Data quality is being checked for the instance.'."\n"
+ .'* CHECKING_CONDITION: Branch conditions are being checked for the instance.'."\n"
+ .'* FAILURE: The instance fails to be run.'."\n"
+ .'* SUCCESS: The instance is successfully run.'."\n",
+ 'type' => 'string',
+ 'example' => 'SUCCESS',
+ ],
+ 'BeginRunningTime' => [
+ 'description' => 'The time when the instance started to run.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '1605178414676',
+ ],
+ 'BizDate' => [
+ 'description' => 'The data timestamp of the instance. In most cases, the value is one day before the time when the instance was run.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '1605178414676',
+ ],
+ 'CycTime' => [
+ 'description' => 'The time when the instance was scheduled to run.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '1605178414676',
+ ],
+ 'FinishTime' => [
+ 'description' => 'The time when the instance finished running.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '1605178414676',
+ ],
+ 'CreateTime' => [
+ 'description' => 'The time when the instance was generated.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '1605178414676',
+ ],
+ 'DagId' => [
+ 'description' => 'The ID of the DAG for the instance in the manually triggered workflow.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '350850491',
+ ],
+ 'InstanceId' => [
+ 'description' => 'The instance ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '11726873619',
+ ],
+ 'BeginWaitResTime' => [
+ 'description' => 'The time when the instance started to wait for resources.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '1605178414676',
+ ],
+ 'TaskType' => [
+ 'description' => 'The scheduling type of the node. Valid values:'."\n"
+ ."\n"
+ .'* NORMAL(0): The node is an auto triggered node. The scheduling system regularly runs the node.'."\n"
+ .'* MANUAL(1): The node is a manually triggered node. The scheduling system does not regularly run the node.'."\n"
+ .'* PAUSE(2): The node is a frozen node. The scheduling system regularly runs the node but sets the status of the node to failed when the scheduling system starts to run the node.'."\n"
+ .'* SKIP(3): The node is a dry-run node. The scheduling system regularly runs the node but sets the status of the node to successful when the scheduling system starts to run the node.'."\n"
+ .'* SKIP_UNCHOOSE(4): The node is an unselected node in a temporary workflow. This type of node exists only in temporary workflows. The scheduling system sets the status of the node to successful when the scheduling system starts to run the node.'."\n"
+ .'* SKIP_CYCLE(5): The node is a node that is scheduled by week or month and is waiting for the scheduling time to arrive. The scheduling system regularly runs the node but sets the status of the node to successful when the scheduling system starts to run the node.'."\n"
+ .'* CONDITION_UNCHOOSE(6): The node is not selected by its ancestor branch node and is run as a dry-run node.'."\n"
+ .'* REALTIME_DEPRECATED(7): The node has instances that are generated in real time but deprecated. The scheduling system sets the status of the node to successful.'."\n",
+ 'type' => 'string',
+ 'example' => 'MANUAL',
+ ],
+ 'ParamValues' => [
+ 'description' => 'The parameters related to the instance.'."\n",
+ 'type' => 'string',
+ 'example' => 'xxx=yyy',
+ ],
+ 'DagType' => [
+ 'description' => 'The type of the manually triggered workflow.'."\n",
+ 'type' => 'string',
+ 'example' => '5',
+ ],
+ 'NodeName' => [
+ 'description' => 'The name of the node.'."\n",
+ 'type' => 'string',
+ 'example' => 'test2',
+ ],
+ 'BeginWaitTimeTime' => [
+ 'description' => 'The time when the instance started to wait to be scheduled.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '1605178414676',
+ ],
+ 'NodeId' => [
+ 'description' => 'The ID of the node in the manually triggered workflow.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '37851',
+ ],
+ 'ModifyTime' => [
+ 'description' => 'The time when the instance was last modified.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '1605178414676',
+ ],
+ 'CreateUser' => [
+ 'description' => 'The name of the account that is used to run the instance. For example, if you use an account named Test to run the instance, the value of this parameter is Test.'."\n",
+ 'type' => 'string',
+ 'example' => 'Test',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"SDFSDFSDF-SDFSDF-SDFDSF-SDFSDF\\",\\n \\"Instances\\": [\\n {\\n \\"Status\\": \\"SUCCESS\\",\\n \\"BeginRunningTime\\": 1605178414676,\\n \\"BizDate\\": 1605178414676,\\n \\"CycTime\\": 1605178414676,\\n \\"FinishTime\\": 1605178414676,\\n \\"CreateTime\\": 1605178414676,\\n \\"DagId\\": 350850491,\\n \\"InstanceId\\": 11726873619,\\n \\"BeginWaitResTime\\": 1605178414676,\\n \\"TaskType\\": \\"MANUAL\\",\\n \\"ParamValues\\": \\"xxx=yyy\\",\\n \\"DagType\\": \\"5\\",\\n \\"NodeName\\": \\"test2\\",\\n \\"BeginWaitTimeTime\\": 1605178414676,\\n \\"NodeId\\": 37851,\\n \\"ModifyTime\\": 1605178414676,\\n \\"CreateUser\\": \\"Test\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<ListManualDagInstancesResponse>\\n <RequestId>SDFSDFSDF-SDFSDF-SDFDSF-SDFSDF</RequestId>\\n <Instances>\\n <Status>SUCCESS</Status>\\n <BeginRunningTime>1605178414676</BeginRunningTime>\\n <BizDate>1605178414676</BizDate>\\n <CycTime>1605178414676</CycTime>\\n <FinishTime>1605178414676</FinishTime>\\n <CreateTime>1605178414676</CreateTime>\\n <DagId>350850491</DagId>\\n <InstanceId>11726873619</InstanceId>\\n <BeginWaitResTime>1605178414676</BeginWaitResTime>\\n <TaskType>MANUAL</TaskType>\\n <ParamValues>xxx=yyy</ParamValues>\\n <DagType>5</DagType>\\n <NodeName>test2</NodeName>\\n <BeginWaitTimeTime>1605178414676</BeginWaitTimeTime>\\n <NodeId>37851</NodeId>\\n <ModifyTime>1605178414676</ModifyTime>\\n <CreateUser>Test</CreateUser>\\n </Instances>\\n</ListManualDagInstancesResponse>","errorExample":""}]',
+ 'title' => 'ListManualDagInstances',
+ 'summary' => 'Queries the information about instances in a manually triggered workflow.',
+ 'requestParamsDescription' => ' ',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ ],
+ 'GetDag' => [
+ 'methods' => [
+ 'post',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'get',
+ 'abilityTreeCode' => '78234',
+ 'abilityTreeNodes' => [
+ 'FEATUREdide7WF1GB',
+ ],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'DagId',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The ID of the DAG. You can use one of the following method to obtain the ID:'."\n"
+ ."\n"
+ .'* Call the [RunCycleDagNodes](~~2780209~~) operation and obtain the value of the **Data** response parameter.'."\n"
+ .'* Call the [RunSmokeTest](~~2780210~~) operation and obtain the value of the **Data** response parameter.'."\n"
+ .'* Call the [RunManualDagNodes](~~2780218~~) operation and obtain the value of the **DagId** response parameter.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => true,
+ 'docRequired' => true,
+ 'minimum' => '2',
+ 'example' => '123141452344525',
+ ],
+ ],
+ [
+ 'name' => 'ProjectEnv',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The environment of the workspace. Valid values: PROD and DEV.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'PROD',
+ 'enum' => [
+ 'PROD',
+ 'DEV',
+ ],
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'description' => 'The response parameters.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'HttpStatusCode' => [
+ 'description' => 'The HTTP status code.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '200',
+ ],
+ 'RequestId' => [
+ 'description' => 'The request ID.'."\n",
+ 'type' => 'string',
+ 'example' => '7782a299-b291-4fee-8424-cf8058efa8e8',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message.'."\n",
+ 'type' => 'string',
+ 'example' => 'The connection does not exist.',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code.'."\n",
+ 'type' => 'string',
+ 'example' => 'Invalid.Tenant.ConnectionNotExists',
+ ],
+ 'Success' => [
+ 'description' => 'Indicates whether the request was successful.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'Data' => [
+ 'description' => 'The details of the DAG.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'Type' => [
+ 'description' => 'The type of the DAG. Valid values: MANUAL, SMOKE_TEST, SUPPLY_DATA, and BUSINESS_PROCESS_DAG. The value MANUAL indicates the DAG for a manually triggered workflow. The value SMOKE_TEST indicates the DAG for a smoke testing workflow. The value SUPPLY_DATA indicates the DAG for a data backfill instance. The value BUSINESS_PROCESS_DAG indicates the DAG for a one-time workflow.'."\n",
+ 'type' => 'string',
+ 'example' => 'MANUAL_FLOW',
+ ],
+ 'Status' => [
+ 'description' => 'The status of the DAG. Valid values: CREATED, RUNNING, FAILURE, and SUCCESS.'."\n",
+ 'type' => 'string',
+ 'example' => 'FAILURE',
+ ],
+ 'FinishTime' => [
+ 'description' => 'The time when the DAG finished running.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '1605052800000',
+ ],
+ 'CreateTime' => [
+ 'description' => 'The time when the DAG was created.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '1605052800000',
+ ],
+ 'ProjectId' => [
+ 'description' => 'The workspace ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '112345',
+ ],
+ 'DagId' => [
+ 'description' => 'The DAG ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '351249682',
+ ],
+ 'Gmtdate' => [
+ 'description' => 'The time when the DAG was scheduled to run.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '1605052800000',
+ ],
+ 'StartTime' => [
+ 'description' => 'The time when the DAG started to run.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '1605052800000',
+ ],
+ 'CreateUser' => [
+ 'description' => 'The creator.'."\n",
+ 'type' => 'string',
+ 'example' => '1736629400048545',
+ ],
+ 'Bizdate' => [
+ 'description' => 'The data timestamp.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '1605052800000',
+ ],
+ 'Name' => [
+ 'description' => 'The name of the DAG.'."\n",
+ 'type' => 'string',
+ 'example' => 'test_dag',
+ ],
+ 'ModifyTime' => [
+ 'description' => 'The time when the DAG was last modified.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '1605052800000',
+ ],
+ 'OpSeq' => [
+ 'description' => 'The sequence number of the operation.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '123',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"7782a299-b291-4fee-8424-cf8058efa8e8\\",\\n \\"ErrorMessage\\": \\"The connection does not exist.\\",\\n \\"ErrorCode\\": \\"Invalid.Tenant.ConnectionNotExists\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"Type\\": \\"MANUAL_FLOW\\",\\n \\"Status\\": \\"FAILURE\\",\\n \\"FinishTime\\": 1605052800000,\\n \\"CreateTime\\": 1605052800000,\\n \\"ProjectId\\": 112345,\\n \\"DagId\\": 351249682,\\n \\"Gmtdate\\": 1605052800000,\\n \\"StartTime\\": 1605052800000,\\n \\"CreateUser\\": \\"1736629400048545\\",\\n \\"Bizdate\\": 1605052800000,\\n \\"Name\\": \\"test_dag\\",\\n \\"ModifyTime\\": 1605052800000,\\n \\"OpSeq\\": 123\\n }\\n}","errorExample":""},{"type":"xml","example":"<GetDagResponse>\\n <HttpStatusCode>200</HttpStatusCode>\\n <RequestId>7782a299-b291-4fee-8424-cf8058efa8e8</RequestId>\\n <ErrorMessage>The connection does not exist.</ErrorMessage>\\n <ErrorCode>Invalid.Tenant.ConnectionNotExists</ErrorCode>\\n <Success>true</Success>\\n <Data>\\n <Type>MANUAL_FLOW</Type>\\n <Status>FAILURE</Status>\\n <FinishTime>1605052800000</FinishTime>\\n <CreateTime>1605052800000</CreateTime>\\n <ProjectId>112345</ProjectId>\\n <DagId>351249682</DagId>\\n <Gmtdate>1605052800000</Gmtdate>\\n <StartTime>1605052800000</StartTime>\\n <CreateUser>1736629400048545</CreateUser>\\n <Bizdate>1605052800000</Bizdate>\\n <Name>test_dag</Name>\\n <ModifyTime>1605052800000</ModifyTime>\\n <OpSeq>123</OpSeq>\\n </Data>\\n</GetDagResponse>","errorExample":""}]',
+ 'title' => 'GetDag',
+ 'summary' => 'Queries the information about a directed acyclic graph (DAG). You can call the GetDag operation to query the information about the DAG for a manually triggered workflow, a manually triggered node, or a data backfill instance. However, you cannot query the information about the DAG for an auto triggered node or an auto triggered workflow.',
+ 'description' => 'Supported DAG types:'."\n"
+ ."\n"
+ .'* MANUAL: DAG for a manually triggered workflow'."\n"
+ .'* SMOKE_TEST: DAG for a smoke testing workflow'."\n"
+ .'* SUPPLY_DATA: DAG for a data backfill instance'."\n"
+ .'* BUSINESS_PROCESS_DAG: DAG for a one-time workflow'."\n"
+ ."\n"
+ .'Supported DAG states:'."\n"
+ ."\n"
+ .'* CREATED'."\n"
+ .'* RUNNING'."\n"
+ .'* FAILURE'."\n"
+ .'* SUCCESS'."\n",
+ 'requestParamsDescription' => ' ',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ ],
+ 'ListDags' => [
+ 'summary' => 'Queries the details of directed acyclic graphs (DAGs) for a single data backfill instance based on OpSeq.',
+ 'methods' => [
+ 'post',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'list',
+ 'abilityTreeCode' => '99773',
+ 'abilityTreeNodes' => [
+ 'FEATUREdide7WF1GB',
+ ],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'OpSeq',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The sequence number that uniquely identifies the data backfill operation. You can call the [GetDag](~~189753~~) operation to query the sequence number.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => true,
+ 'minimum' => '2',
+ 'example' => '123',
+ ],
+ ],
+ [
+ 'name' => 'ProjectEnv',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The environment of the workspace. Valid values: PROD and DEV. The value PROD indicates the production environment, and the value DEV indicates the development environment.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => 'PROD',
+ 'enum' => [
+ 'PROD',
+ 'DEV',
+ ],
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'description' => 'The returned result.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'HttpStatusCode' => [
+ 'description' => 'The HTTP status code.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '200',
+ ],
+ 'RequestId' => [
+ 'description' => 'The request ID. You can use the ID to locate logs and troubleshoot issues.'."\n",
+ 'type' => 'string',
+ 'example' => '7782a299-b291-4fee-8424-cf8058efa8e8',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message.'."\n",
+ 'type' => 'string',
+ 'example' => 'The connection does not exist.',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code.'."\n",
+ 'type' => 'string',
+ 'example' => 'Invalid.Tenant.ConnectionNotExists',
+ ],
+ 'Success' => [
+ 'description' => 'Indicates whether the request was successful.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'Data' => [
+ 'description' => 'The details of DAGs.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'Dags' => [
+ 'description' => 'The entities returned.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '',
+ 'type' => 'object',
+ 'properties' => [
+ 'Type' => [
+ 'description' => 'The type of the DAG. Valid values:'."\n"
+ ."\n"
+ .'* MANUAL: DAG for a manually triggered workflow'."\n"
+ .'* SMOKE_TEST: DAG for a smoke testing workflow'."\n"
+ .'* SUPPLY_DATA: DAG for a data backfill instance'."\n"
+ .'* BUSINESS_PROCESS_DAG: DAG for a one-time workflow'."\n",
+ 'type' => 'string',
+ 'example' => 'MANUAL_FLOW',
+ ],
+ 'Status' => [
+ 'description' => 'The status of the DAG. Valid values:'."\n"
+ ."\n"
+ .'* CREATED'."\n"
+ .'* RUNNING'."\n"
+ .'* FAILURE'."\n"
+ .'* SUCCESS'."\n",
+ 'type' => 'string',
+ 'example' => 'FAILURE',
+ ],
+ 'FinishTime' => [
+ 'description' => 'The end time.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '1605052800000',
+ ],
+ 'CreateTime' => [
+ 'description' => 'The creation time.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '1605052800000',
+ ],
+ 'ProjectId' => [
+ 'description' => 'The workspace ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '112345',
+ ],
+ 'DagId' => [
+ 'description' => 'The DAG ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '351249682',
+ ],
+ 'Gmtdate' => [
+ 'description' => 'The actual running time.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '1605052800000',
+ ],
+ 'StartTime' => [
+ 'description' => 'The start time.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '1605052800000',
+ ],
+ 'CreateUser' => [
+ 'description' => 'The creator.'."\n",
+ 'type' => 'string',
+ 'example' => '1736629400048545',
+ ],
+ 'Bizdate' => [
+ 'description' => 'The data timestamp.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '1605052800000',
+ ],
+ 'Name' => [
+ 'description' => 'The name of the DAG.'."\n",
+ 'type' => 'string',
+ 'example' => 'test_dag',
+ ],
+ 'ModifyTime' => [
+ 'description' => 'The modification time.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '1605052800000',
+ ],
+ 'OpSeq' => [
+ 'description' => 'The sequence number of the operation.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '123',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"7782a299-b291-4fee-8424-cf8058efa8e8\\",\\n \\"ErrorMessage\\": \\"The connection does not exist.\\",\\n \\"ErrorCode\\": \\"Invalid.Tenant.ConnectionNotExists\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"Dags\\": [\\n {\\n \\"Type\\": \\"MANUAL_FLOW\\",\\n \\"Status\\": \\"FAILURE\\",\\n \\"FinishTime\\": 1605052800000,\\n \\"CreateTime\\": 1605052800000,\\n \\"ProjectId\\": 112345,\\n \\"DagId\\": 351249682,\\n \\"Gmtdate\\": 1605052800000,\\n \\"StartTime\\": 1605052800000,\\n \\"CreateUser\\": \\"1736629400048545\\",\\n \\"Bizdate\\": 1605052800000,\\n \\"Name\\": \\"test_dag\\",\\n \\"ModifyTime\\": 1605052800000,\\n \\"OpSeq\\": 123\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<ListDagsResponse>\\n <HttpStatusCode>200</HttpStatusCode>\\n <RequestId>7782a299-b291-4fee-8424-cf8058efa8e8</RequestId>\\n <ErrorMessage>The connection does not exist.</ErrorMessage>\\n <ErrorCode>Invalid.Tenant.ConnectionNotExists</ErrorCode>\\n <Success>true</Success>\\n <Data>\\n <Dags>\\n <Type>MANUAL_FLOW</Type>\\n <Status>FAILURE</Status>\\n <FinishTime>1605052800000</FinishTime>\\n <CreateTime>1605052800000</CreateTime>\\n <ProjectId>112345</ProjectId>\\n <DagId>351249682</DagId>\\n <Gmtdate>1605052800000</Gmtdate>\\n <StartTime>1605052800000</StartTime>\\n <CreateUser>1736629400048545</CreateUser>\\n <Bizdate>1605052800000</Bizdate>\\n <Name>test_dag</Name>\\n <ModifyTime>1605052800000</ModifyTime>\\n <OpSeq>123</OpSeq>\\n </Dags>\\n </Data>\\n</ListDagsResponse>","errorExample":""}]',
+ 'title' => 'ListDags',
+ 'description' => 'Supported DAG types:'."\n"
+ ."\n"
+ .'* MANUAL: DAG for a manually triggered workflow'."\n"
+ .'* SMOKE_TEST: DAG for a smoke testing workflow'."\n"
+ .'* SUPPLY_DATA: DAG for a data backfill instance'."\n"
+ .'* BUSINESS_PROCESS_DAG: DAG for a one-time workflow'."\n"
+ ."\n"
+ .'Supported DAG states:'."\n"
+ ."\n"
+ .'* CREATED: The DAG is created.'."\n"
+ .'* RUNNING: The DAG is running.'."\n"
+ .'* FAILURE: The DAG fails to run.'."\n"
+ .'* SUCCESS: The DAG is successfully run.'."\n",
+ ],
+ 'ListNodesByOutput' => [
+ 'methods' => [
+ 'post',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'get',
+ 'abilityTreeCode' => '78322',
+ 'abilityTreeNodes' => [
+ 'FEATUREdide7WF1GB',
+ ],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'ProjectEnv',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The environment of Operation Center. Valid values: PROD and DEV. The value PROD indicates the production environment, and the value DEV indicates the development environment.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'enumValueTitles' => [],
+ 'example' => 'PROD',
+ 'enum' => [
+ 'PROD',
+ 'DEV',
+ ],
+ ],
+ ],
+ [
+ 'name' => 'Outputs',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The output name of the node. You can specify multiple output names. Separate them with commas (,).'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'aaaaa.1231412_out,bbbb.12313123_out',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'HttpStatusCode' => [
+ 'description' => 'The HTTP status code.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '200',
+ ],
+ 'RequestId' => [
+ 'description' => 'The request ID.'."\n",
+ 'type' => 'string',
+ 'example' => 'SDFSDFSDF-asdfDFSDF-SDFSDf-SDfSFD',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message.'."\n",
+ 'type' => 'string',
+ 'example' => 'The connection does not exist.',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code.'."\n",
+ 'type' => 'string',
+ 'example' => 'Invalid.Tenant.ConnectionNotExists',
+ ],
+ 'Success' => [
+ 'description' => 'Indicates whether the request was successful.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'Data' => [
+ 'description' => 'The nodes returned.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'Output' => [
+ 'description' => 'The output name of the current node.'."\n",
+ 'type' => 'string',
+ 'example' => 'test_0709_1.630003556_out',
+ ],
+ 'NodeList' => [
+ 'description' => 'The information about the nodes returned.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'SchedulerType' => [
+ 'description' => 'The scheduling type of the node. Valid values:'."\n"
+ ."\n"
+ .'* NORMAL: The node is an auto triggered node. The scheduling system regularly runs the node.'."\n"
+ .'* MANUAL: The node is a manually triggered node. The scheduling system does not regularly run the node.'."\n"
+ .'* PAUSE: The node is a frozen node. The scheduling system regularly runs the node but sets the status of the node to failed when the scheduling system starts to run the node.'."\n"
+ .'* SKIP: The node is a dry-run node. The scheduling system regularly runs the node but sets the status of the node to successful when the scheduling system starts to run the node.'."\n",
+ 'type' => 'string',
+ 'example' => 'NORMAL',
+ ],
+ 'RepeatInterval' => [
+ 'description' => 'The interval at which the node is rerun after the node fails to run.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '60',
+ ],
+ 'Repeatability' => [
+ 'description' => 'Indicates whether the node can be rerun.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'FileType' => [
+ 'description' => 'The node type. Valid values:'."\n"
+ ."\n"
+ .'6 (Shell), 10 (ODPS SQL), 11 (ODPS MR), 23 (Data Integration), 24 (ODPS Script), 99 (zero load), 221 (PyODPS 2), 225 (ODPS Spark), 227 (EMR Hive), 228 (EMR Spark), 229 (EMR Spark SQL), 230 (EMR MR), 239 (OSS object inspection), 257 (EMR Shell), 258 (EMR Spark Shell), 259 (EMR Presto), 260 (EMR Impala), 900 (real-time synchronization), 1089 (cross-tenant collaboration), 1091 (Hologres development), 1093 (Hologres SQL), 1100 (assignment), and 1221 (PyODPS 3)'."\n",
+ 'type' => 'string',
+ 'example' => 'ODPS_SQL',
+ ],
+ 'ProjectId' => [
+ 'description' => 'The workspace ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '33671',
+ ],
+ 'ProgramType' => [
+ 'description' => 'The node type. This parameter is deprecated. For more information about node types, see valid values of the FileType parameter.'."\n",
+ 'type' => 'string',
+ 'example' => 'ODPS_SQL',
+ ],
+ 'Priority' => [
+ 'description' => 'The priority of the node. Valid values: 1, 3, 5, 7, and 8. A greater value indicates a higher priority. Default value: 1.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '1',
+ ],
+ 'OwnerId' => [
+ 'description' => 'The owner ID.'."\n",
+ 'type' => 'string',
+ 'example' => '19337906836551',
+ ],
+ 'Connection' => [
+ 'description' => 'The name of the data source.'."\n",
+ 'type' => 'string',
+ 'example' => 'odps_first',
+ ],
+ 'ParamValues' => [
+ 'description' => 'The scheduling parameters of the node.'."\n",
+ 'type' => 'string',
+ 'example' => 'a=b',
+ ],
+ 'RelatedFlowId' => [
+ 'description' => 'The ID of the workflow to which the node belongs.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '1235655464',
+ ],
+ 'DqcType' => [
+ 'description' => 'Indicates whether the node is associated with a monitoring rule in Data Quality. Valid values: 0 and 1. The value 0 indicates that the node is associated with a monitoring rule in Data Quality. The value 1 indicates that the node is not associated with a monitoring rule in Data Quality.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '1',
+ ],
+ 'BaselineId' => [
+ 'description' => 'The baseline ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '1235667',
+ ],
+ 'Description' => [
+ 'description' => 'The description of the node.'."\n",
+ 'type' => 'string',
+ 'example' => 'test',
+ ],
+ 'NodeName' => [
+ 'description' => 'The name of the node.'."\n",
+ 'type' => 'string',
+ 'example' => 'liux_test_n****',
+ ],
+ 'ResGroupName' => [
+ 'description' => 'The name of the resource group.'."\n",
+ 'type' => 'string',
+ 'example' => 'Default Resource Group',
+ ],
+ 'DqcDescription' => [
+ 'description' => 'The table and partition filter expression in Data Quality that are associated with the node.'."\n",
+ 'type' => 'string',
+ 'example' => '[{"projectName":"ztjy_dim","tableName":"dim_user_agent_manage_area_a","partition":"ds\\u003d$[yyyy-mm-dd-1]"}]',
+ ],
+ 'CronExpress' => [
+ 'description' => 'The CRON expression.'."\n",
+ 'type' => 'string',
+ 'example' => '00 00 00 * * ?',
+ ],
+ 'NodeId' => [
+ 'description' => 'The node ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '125677',
+ ],
+ ],
+ 'description' => '',
+ ],
+ ],
+ ],
+ 'description' => '',
+ ],
+ ],
+ ],
+ 'description' => '',
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"SDFSDFSDF-asdfDFSDF-SDFSDf-SDfSFD\\",\\n \\"ErrorMessage\\": \\"The connection does not exist.\\",\\n \\"ErrorCode\\": \\"Invalid.Tenant.ConnectionNotExists\\",\\n \\"Success\\": true,\\n \\"Data\\": [\\n {\\n \\"Output\\": \\"test_0709_1.630003556_out\\",\\n \\"NodeList\\": [\\n {\\n \\"SchedulerType\\": \\"NORMAL\\",\\n \\"RepeatInterval\\": 60,\\n \\"Repeatability\\": true,\\n \\"FileType\\": \\"ODPS_SQL\\",\\n \\"ProjectId\\": 33671,\\n \\"ProgramType\\": \\"ODPS_SQL\\",\\n \\"Priority\\": 1,\\n \\"OwnerId\\": \\"19337906836551\\",\\n \\"Connection\\": \\"odps_source\\",\\n \\"ParamValues\\": \\"a=b\\",\\n \\"RelatedFlowId\\": 1235655464,\\n \\"DqcType\\": 1,\\n \\"BaselineId\\": 1235667,\\n \\"Description\\": \\"test\\",\\n \\"NodeName\\": \\"liux_test_n****\\",\\n \\"ResGroupName\\": \\"Default Resource Group\\",\\n \\"DqcDescription\\": \\"[{\\\\\\"projectName\\\\\\":\\\\\\"ztjy_dim\\\\\\",\\\\\\"tableName\\\\\\":\\\\\\"dim_user_agent_manage_area_a\\\\\\",\\\\\\"partition\\\\\\":\\\\\\"ds\\\\\\\\u003d$[yyyy-mm-dd-1]\\\\\\"}]\\",\\n \\"CronExpress\\": \\"00 00 00 * * ?\\",\\n \\"NodeId\\": 125677\\n }\\n ]\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<ListNodesByOutputResponse>\\n <RequestId>SDFSDFSDF-asdfDFSDF-SDFSDf-SDfSFD</RequestId>\\n <HttpStatusCode>200</HttpStatusCode>\\n <Data>\\n <Output>test_0709_1.630003556_out</Output>\\n <NodeList>\\n <BaselineId>1235667</BaselineId>\\n <ResGroupName>默认资源组</ResGroupName>\\n <Description>test</Description>\\n <NodeName>liux_test_n****</NodeName>\\n <DqcType>1</DqcType>\\n <Priority>1</Priority>\\n <ParamValues>a=b</ParamValues>\\n <Connection>odps_source</Connection>\\n <ProjectId>33671</ProjectId>\\n <RelatedFlowId>1235655464</RelatedFlowId>\\n <SchedulerType>NORMAL</SchedulerType>\\n <CronExpress>00 00 00 * * ?</CronExpress>\\n <Repeatability>true</Repeatability>\\n <OwnerId>19337906836551</OwnerId>\\n <FileType>ODPS_SQL</FileType>\\n <DqcDescription>[{\\"projectName\\":\\"ztjy_dim\\",\\"tableName\\":\\"dim_user_agent_manage_area_a\\",\\"partition\\":\\"ds\\\\u003d$[yyyy-mm-dd-1]\\"}]</DqcDescription>\\n <NodeId>125677</NodeId>\\n <ProgramType>ODPS_SQL</ProgramType>\\n <RepeatInterval>60</RepeatInterval>\\n </NodeList>\\n </Data>\\n <ErrorCode>Invalid.Tenant.ConnectionNotExists</ErrorCode>\\n <ErrorMessage>The connection does not exist.</ErrorMessage>\\n <Success>true</Success>\\n</ListNodesByOutputResponse>","errorExample":""}]',
+ 'title' => 'ListNodesByOutput',
+ 'summary' => 'Queries nodes based on the output of the nodes.',
+ 'requestParamsDescription' => ' ',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ ],
+ 'RunTriggerNode' => [
+ 'methods' => [
+ 'post',
+ 'get',
+ 'put',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'write',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'none',
+ 'abilityTreeCode' => '78349',
+ 'abilityTreeNodes' => [
+ 'FEATUREdide7WF1GB',
+ 'FEATUREdideVFMENL',
+ ],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'NodeId',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The ID of the manually triggered node. You can call the [ListNodes](~~173979~~) operation to query the ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => true,
+ 'docRequired' => true,
+ 'maximum' => '9223372036854775807',
+ 'minimum' => '-9223372036854775808',
+ 'example' => '10000011',
+ ],
+ ],
+ [
+ 'name' => 'CycleTime',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The scheduling time to run the manually triggered node. Set the value to a 13-digit timestamp in milliseconds.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => true,
+ 'docRequired' => true,
+ 'maximum' => '9223372036854775807',
+ 'minimum' => '-9223372036854775808',
+ 'example' => '1606200230105',
+ ],
+ ],
+ [
+ 'name' => 'BizDate',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The data timestamp of the instance that is generated for the manually triggered node.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => true,
+ 'docRequired' => true,
+ 'maximum' => '9223372036854775807',
+ 'minimum' => '-9223372036854775808',
+ 'example' => '1606200230105',
+ ],
+ ],
+ [
+ 'name' => 'AppId',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The ID of the DataWorks workspace to which the manually triggered node belongs. You can call the [ListProjects](~~178393~~) operation to query the ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => true,
+ 'docRequired' => true,
+ 'maximum' => '9223372036854775807',
+ 'minimum' => '-9223372036854775808',
+ 'example' => '10001',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'Success' => [
+ 'description' => 'Indicates whether the request was successful. Valid values:'."\n"
+ ."\n"
+ .'* true'."\n"
+ .'* false'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'RequestId' => [
+ 'description' => 'The request ID.'."\n",
+ 'type' => 'string',
+ 'example' => '9BA675F1-F848-4752-A6E3-92ABA0616005',
+ ],
+ ],
+ 'description' => '',
+ ],
+ ],
+ ],
+ 'errorCodes' => [
+ 403 => [
+ [
+ 'errorCode' => 'ResourceNotAuthorized.Api',
+ 'errorMessage' => 'You are not authorized to access the resources.',
+ ],
+ ],
+ 429 => [
+ [
+ 'errorCode' => 'Throttling.Api',
+ 'errorMessage' => 'The request for this resource has exceeded your available limit.',
+ ],
+ [
+ 'errorCode' => 'Throttling.Api.Risk',
+ 'errorMessage' => 'The request for this resource has exceeded your daily available limit.',
+ ],
+ [
+ 'errorCode' => 'Throttling.System',
+ 'errorMessage' => 'The DataWorks system is busy. Try again later.',
+ ],
+ [
+ 'errorCode' => 'Throttling.User',
+ 'errorMessage' => 'Your request is too frequent. Try again later.',
+ ],
+ ],
+ 500 => [
+ [
+ 'errorCode' => 'Forbidden.Not.Server',
+ 'errorMessage' => 'The dataworksAPI service is not available in this area. Please try it in another area.',
+ ],
+ [
+ 'errorCode' => 'InternalError.System',
+ 'errorMessage' => 'An internal system error occurred. Try again later.',
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"9BA675F1-F848-4752-A6E3-92ABA0616005\\"\\n}","errorExample":""},{"type":"xml","example":"<RequestId>9BA675F1-F848-4752-A6E3-92ABA0616005</RequestId>\\n<Success>true</Success>","errorExample":""}]',
+ 'title' => 'RunTriggerNode',
+ 'summary' => 'Runs a manually triggered node.',
+ 'requestParamsDescription' => ' ',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ ],
+ 'GetNodeParents' => [
+ 'methods' => [
+ 'post',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'get',
+ 'abilityTreeCode' => '78276',
+ 'abilityTreeNodes' => [
+ 'FEATUREdide7WF1GB',
+ 'FEATUREdideVFMENL',
+ ],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'ProjectEnv',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The environment type of Operation Center. Valid values: PROD and DEV. The value PROD indicates the production environment, and the value DEV indicates the development environment.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'PROD',
+ 'enum' => [
+ 'PROD',
+ 'DEV',
+ ],
+ ],
+ ],
+ [
+ 'name' => 'NodeId',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The node ID. You can go to the Operation Center page in the DataWorks console to query the node ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => '12345456211234',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'description' => 'The returned result.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'HttpStatusCode' => [
+ 'description' => 'The HTTP status code.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '200',
+ ],
+ 'RequestId' => [
+ 'description' => 'The request ID. You can troubleshoot issues based on the ID.'."\n",
+ 'type' => 'string',
+ 'example' => 'asfasdfs-adfasdf-asfas-dfasdf-asdf',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message.'."\n",
+ 'type' => 'string',
+ 'example' => 'err',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code.'."\n",
+ 'type' => 'string',
+ 'example' => '1060010000000',
+ ],
+ 'Success' => [
+ 'description' => 'Indicates whether the request was successful.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'Data' => [
+ 'description' => 'The ancestor nodes.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'Nodes' => [
+ 'description' => 'The ancestor nodes.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The returned result.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'SchedulerType' => [
+ 'description' => 'The scheduling type of the node. Valid values:'."\n"
+ ."\n"
+ .'* NORMAL: The node is an auto triggered node.'."\n"
+ .'* MANUAL: The node is a manually triggered node. Manually triggered nodes cannot be automatically triggered.'."\n"
+ .'* PAUSE: The node is a paused node. Paused nodes are started as scheduled but the system sets the status of the nodes to failed when it starts to run them.'."\n"
+ .'* SKIP: The node is a dry-run node. Dry-run nodes are started as scheduled but the system sets the status of the nodes to successful when it starts to run them.'."\n",
+ 'type' => 'string',
+ 'example' => 'NORMAL',
+ ],
+ 'BaselineId' => [
+ 'description' => 'The baseline ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '1244564565',
+ ],
+ 'Repeatability' => [
+ 'description' => 'Indicates whether the node can be rerun if the node fails to run. Valid values:'."\n"
+ ."\n"
+ .'* true'."\n"
+ .'* false'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'NodeName' => [
+ 'description' => 'The name of the node.'."\n",
+ 'type' => 'string',
+ 'example' => 'test_Node',
+ ],
+ 'ProjectId' => [
+ 'description' => 'The ID of the workspace to which the node belongs.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '12315412412',
+ ],
+ 'ProgramType' => [
+ 'description' => 'The type of the node.'."\n",
+ 'type' => 'string',
+ 'example' => 'ODPS_SQL',
+ ],
+ 'Priority' => [
+ 'description' => 'The priority. Valid values: 1 to 8. A large value indicates a high priority.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '3',
+ ],
+ 'OwnerId' => [
+ 'description' => 'The ID of the Alibaba Cloud account used by the node owner.'."\n",
+ 'type' => 'string',
+ 'example' => '123124561341251321',
+ ],
+ 'CronExpress' => [
+ 'description' => 'The CRON expression. CRON expressions are used to run auto triggered nodes.'."\n",
+ 'type' => 'string',
+ 'example' => '00 00 * * * *',
+ ],
+ 'NodeId' => [
+ 'description' => 'The node ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '1244564565',
+ ],
+ 'StepType' => [
+ 'description' => 'The scheduling dependency type.'."\n"
+ ."\n"
+ .'* **0**: same-cycle scheduling dependency'."\n"
+ .'* **3**: cross-cycle scheduling dependency'."\n",
+ 'type' => 'string',
+ 'example' => '0',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"asfsdfas-adfasdf-asfas-dfasdf-asdf\\",\\n \\"ErrorMessage\\": \\"err\\",\\n \\"ErrorCode\\": \\"1060010000000\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"Nodes\\": [\\n {\\n \\"SchedulerType\\": \\"NORMAL\\",\\n \\"BaselineId\\": 1244564565,\\n \\"Repeatability\\": true,\\n \\"NodeName\\": \\"test_Node\\",\\n \\"ProjectId\\": 12315412412,\\n \\"ProgramType\\": \\"ODPS_SQL\\",\\n \\"Priority\\": 3,\\n \\"OwnerId\\": \\"123124561341251321\\",\\n \\"CronExpress\\": \\"00 00 * * * *\\",\\n \\"NodeId\\": 1244564565,\\n \\"StepType\\": \\"0\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<GetNodeParentsResponse>\\n <HttpStatusCode>200</HttpStatusCode>\\n <RequestId>asdfasdfas-adfasdf-asfas-dfasdf-asdf</RequestId>\\n <ErrorMessage>err</ErrorMessage>\\n <ErrorCode>1060010000000</ErrorCode>\\n <Success>true</Success>\\n <Data>\\n <Nodes>\\n <SchedulerType>NORMAL</SchedulerType>\\n <BaselineId>1244564565</BaselineId>\\n <Repeatability>true</Repeatability>\\n <NodeName>test_Node</NodeName>\\n <ProjectId>12315412412</ProjectId>\\n <ProgramType>ODPS_SQL</ProgramType>\\n <Priority>3</Priority>\\n <OwnerId>123124561341251321</OwnerId>\\n <CronExpress>00 00 * * * *</CronExpress>\\n <NodeId>1244564565</NodeId>\\n </Nodes>\\n </Data>\\n</GetNodeParentsResponse>","errorExample":""}]',
+ 'title' => 'GetNodeParents',
+ 'summary' => 'Queries a list of ancestor nodes of a node.',
+ 'requestParamsDescription' => ' ',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ ],
+ 'GetNodeChildren' => [
+ 'methods' => [
+ 'post',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'get',
+ 'abilityTreeCode' => '78273',
+ 'abilityTreeNodes' => [
+ 'FEATUREdide7WF1GB',
+ 'FEATUREdideVFMENL',
+ ],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'ProjectEnv',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The environment type of Operation Center. Valid values: PROD and DEV. The value PROD indicates the production environment, and the value DEV indicates the development environment.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'enumValueTitles' => [],
+ 'example' => 'PROD',
+ 'enum' => [
+ 'PROD',
+ 'DEV',
+ ],
+ ],
+ ],
+ [
+ 'name' => 'NodeId',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The node ID. You can go to the Operation Center page in the DataWorks console to query the node ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => '123456878',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'description' => 'The response parameters.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'HttpStatusCode' => [
+ 'description' => 'The HTTP status code.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '200',
+ ],
+ 'RequestId' => [
+ 'description' => 'The request ID. You can use the ID to troubleshoot issues.'."\n",
+ 'type' => 'string',
+ 'example' => 'adsfasdf-adf-asdf-asdf-asdfadfasdd',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message.'."\n",
+ 'type' => 'string',
+ 'example' => 'err',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code.'."\n",
+ 'type' => 'string',
+ 'example' => '1060010000000',
+ ],
+ 'Success' => [
+ 'description' => 'Indicates whether the request was successful.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'Data' => [
+ 'description' => 'The information about the descendant nodes.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'Nodes' => [
+ 'description' => 'The descendant nodes.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The descendant node.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'SchedulerType' => [
+ 'description' => 'The scheduling type of the node. Valid values:'."\n"
+ ."\n"
+ .'* NORMAL: The node is an auto triggered node.'."\n"
+ .'* MANUAL: The node is a manually triggered node. Manually triggered nodes cannot be automatically triggered.'."\n"
+ .'* PAUSE: The node is a paused node. Paused nodes are started as scheduled but the system sets the status of the nodes to failed when it starts to run them.'."\n"
+ .'* SKIP: The node is a dry-run node. Dry-run nodes are started as scheduled but the system sets the status of the nodes to successful when it starts to run them.'."\n",
+ 'type' => 'string',
+ 'example' => 'NORMAL',
+ ],
+ 'BaselineId' => [
+ 'description' => 'The baseline ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '12345656',
+ ],
+ 'Repeatability' => [
+ 'description' => 'Indicates whether the node can be rerun if the node fails to run. Valid values:'."\n"
+ ."\n"
+ .'* true'."\n"
+ .'* false'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'NodeName' => [
+ 'description' => 'The name of the node.'."\n",
+ 'type' => 'string',
+ 'example' => 'test_Node',
+ ],
+ 'ProjectId' => [
+ 'description' => 'The ID of the workspace to which the node belongs.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '12315412412',
+ ],
+ 'ProgramType' => [
+ 'description' => 'The type of the node.'."\n",
+ 'type' => 'string',
+ 'example' => 'ODPS_SQL',
+ ],
+ 'Priority' => [
+ 'description' => 'The priority. Valid values: 1 to 8. A large value indicates a high priority.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '3',
+ ],
+ 'OwnerId' => [
+ 'description' => 'The ID of the Alibaba Cloud account used by the node owner.'."\n",
+ 'type' => 'string',
+ 'example' => '123124561341251321',
+ ],
+ 'CronExpress' => [
+ 'description' => 'The CRON expression. CRON expressions are used to run auto triggered nodes.'."\n",
+ 'type' => 'string',
+ 'example' => '00 00 * * * * ',
+ ],
+ 'NodeId' => [
+ 'description' => 'The node ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '1244564565',
+ ],
+ 'StepType' => [
+ 'description' => 'The scheduling dependency type. Valid values:'."\n"
+ ."\n"
+ .'* **0**: same-cycle scheduling dependency'."\n"
+ .'* **3**: cross-cycle scheduling dependency'."\n",
+ 'type' => 'string',
+ 'example' => '0',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"adsfasdf-adf-asdf-asdf-asdfadfasdd\\",\\n \\"ErrorMessage\\": \\"err\\",\\n \\"ErrorCode\\": \\"1060010000000\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"Nodes\\": [\\n {\\n \\"SchedulerType\\": \\"NORMAL\\",\\n \\"BaselineId\\": 12345656,\\n \\"Repeatability\\": true,\\n \\"NodeName\\": \\"test_Node\\",\\n \\"ProjectId\\": 12315412412,\\n \\"ProgramType\\": \\"ODPS_SQL\\",\\n \\"Priority\\": 3,\\n \\"OwnerId\\": \\"123124561341251321\\",\\n \\"CronExpress\\": \\"00 00 * * * * \\",\\n \\"NodeId\\": 1244564565,\\n \\"StepType\\": \\"0\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<GetNodeChildrenResponse>\\n <HttpStatusCode>200</HttpStatusCode>\\n <RequestId>adsfasdf-adf-asdf-asdf-asdfadfasdd</RequestId>\\n <ErrorMessage>err</ErrorMessage>\\n <ErrorCode>1060010000000</ErrorCode>\\n <Success>true</Success>\\n <Data>\\n <Nodes>\\n <SchedulerType>NORMAL</SchedulerType>\\n <BaselineId>12345656</BaselineId>\\n <Repeatability>true</Repeatability>\\n <NodeName>test_Node</NodeName>\\n <ProjectId>12315412412</ProjectId>\\n <ProgramType>ODPS_SQL</ProgramType>\\n <Priority>3</Priority>\\n <OwnerId>123124561341251321</OwnerId>\\n <CronExpress>00 00 * * * * </CronExpress>\\n <NodeId>1244564565</NodeId>\\n </Nodes>\\n </Data>\\n</GetNodeChildrenResponse>","errorExample":""}]',
+ 'title' => 'GetNodeChildren',
+ 'summary' => 'Queries a list of instances.',
+ 'requestParamsDescription' => ' ',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ ],
+ 'UpdateNodeRunMode' => [
+ 'methods' => [
+ 'post',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'readAndWrite',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'update',
+ 'abilityTreeCode' => '78378',
+ 'abilityTreeNodes' => [
+ 'FEATUREdide7WF1GB',
+ ],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'ProjectEnv',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The environment in which the node runs. Valid values: DEV and PROD. The value DEV indicates the development environment, and the value PROD indicates the production environment.'."\n"
+ ."\n"
+ .'* PROD'."\n"
+ .'* DEV'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'PROD',
+ 'enum' => [
+ 'PROD',
+ 'DEV',
+ ],
+ ],
+ ],
+ [
+ 'name' => 'NodeId',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The node ID. You can call the [ListNodes](~~173979~~) operation to query the node ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => '1234',
+ ],
+ ],
+ [
+ 'name' => 'SchedulerType',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The operation that you want to perform on the node. Valid values:'."\n"
+ ."\n"
+ .'* 0: indicates that you want to unfreeze the node.'."\n"
+ .'* 2: indicates that you want to freeze the node.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => '0',
+ 'enum' => [
+ '0',
+ '2',
+ ],
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'description' => 'The response parameters.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'Success' => [
+ 'description' => 'Indicates whether the request was successful. Valid values:'."\n"
+ ."\n"
+ .'* true'."\n"
+ .'* false'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'RequestId' => [
+ 'description' => 'The request ID.'."\n",
+ 'type' => 'string',
+ 'example' => 'E6F0DBDD-5AD****',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"E6F0DBDD-5AD****\\"\\n}","errorExample":""},{"type":"xml","example":"<UpdateNodeRunModeResponse>\\n <Success>true</Success>\\n <RequestId>E6F0DBDD-5AD****</RequestId>\\n</UpdateNodeRunModeResponse>","errorExample":""}]',
+ 'title' => 'UpdateNodeRunMode',
+ 'summary' => 'Freezes or unfreezes a node.',
+ 'requestParamsDescription' => ' ',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ ],
+ 'UpdateNodeOwner' => [
+ 'methods' => [
+ 'post',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'readAndWrite',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'get',
+ 'abilityTreeCode' => '78377',
+ 'abilityTreeNodes' => [
+ 'FEATUREdide7WF1GB',
+ ],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'ProjectEnv',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The environment in which the node runs. Valid values: DEV and PROD. The value DEV indicates the development environment, and the value PROD indicates the production environment.'."\n"
+ ."\n"
+ .'* PROD'."\n"
+ .'* DEV'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'PROD',
+ 'enum' => [
+ 'PROD',
+ 'DEV',
+ ],
+ ],
+ ],
+ [
+ 'name' => 'NodeId',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The node ID. You can call the [ListNodes](~~173979~~) operation to query the node ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => '1234',
+ ],
+ ],
+ [
+ 'name' => 'UserId',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The ID of the Alibaba Cloud account used by the node owner. You can log on to the DataWorks console and move the pointer over the profile picture in the upper-right corner to view the ID.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => '19337906836551',
+ 'maxLength' => 64,
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'description' => 'The response parameters.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'Success' => [
+ 'description' => 'Indicates whether the request was successful. Valid values:'."\n"
+ ."\n"
+ .'* true'."\n"
+ .'* false'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'RequestId' => [
+ 'description' => 'The request ID. You can use the request ID to query logs and troubleshoot issues.'."\n",
+ 'type' => 'string',
+ 'example' => 'E6F0DBDD-5AD****',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"E6F0DBDD-5AD****\\"\\n}","errorExample":""},{"type":"xml","example":"<UpdateNodeOwnerResponse>\\n <Success>true</Success>\\n <RequestId>E6F0DBDD-5AD****</RequestId>\\n</UpdateNodeOwnerResponse>","errorExample":""}]',
+ 'title' => 'UpdateNodeOwner',
+ 'summary' => 'Changes the owner of a node.',
+ 'requestParamsDescription' => ' ',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ ],
+ 'UpdateWorkbenchEventResult' => [
+ 'summary' => 'Returns the processing result sent by an extension after a process in Operation Center is blocked by the extension.',
+ 'methods' => [
+ 'post',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'readAndWrite',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'update',
+ 'abilityTreeCode' => '103198',
+ 'abilityTreeNodes' => [
+ 'FEATUREdide7WF1GB',
+ ],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'MessageId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the message received when the related extension point event is triggered after you enable message subscription by using the OpenEvent module.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => '03400b03-b721-4c34-8727-2d6884077091',
+ ],
+ ],
+ [
+ 'name' => 'ExtensionCode',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The code of the extension.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => '58e95e2acd6f408e8707f1bf2591f9e9',
+ ],
+ ],
+ [
+ 'name' => 'CheckResult',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The check result of the extension point event. Valid values: OK and Fail.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'FAIL',
+ 'enum' => [
+ 'OK',
+ 'FAIL',
+ 'WARN',
+ ],
+ ],
+ ],
+ [
+ 'name' => 'CheckResultTip',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The cause of the check failure.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'SQL is too long',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => 'Schema of Response',
+ 'description' => 'The response parameters.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'title' => 'Id of the request',
+ 'description' => 'The request ID.'."\n",
+ 'type' => 'string',
+ 'example' => '0bc1ec92159376****',
+ ],
+ 'Success' => [
+ 'title' => '成功标识',
+ 'description' => 'Indicates whether the request was successful.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"0bc1ec92159376****\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<UpdateWorkbenchEventResultResponse>\\n <RequestId>0bc1ec92159376****</RequestId>\\n <Success>true</Success>\\n</UpdateWorkbenchEventResultResponse>","errorExample":""}]',
+ 'title' => 'UpdateWorkbenchEventResult',
+ ],
+ 'ListShiftPersonnels' => [
+ 'summary' => 'Queries a list of on-duty engineers in a shift schedule.',
+ 'methods' => [
+ 'get',
+ 'post',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'list',
+ 'abilityTreeCode' => '140337',
+ 'abilityTreeNodes' => [
+ 'FEATUREdideRJGWWC',
+ ],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'ShiftScheduleIdentifier',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The unique identifier of the shift schedule.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => '2ab6456ada634b2f938ee******9b45b',
+ ],
+ ],
+ [
+ 'name' => 'UserType',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The type of the on-duty engineer that you want to query. Valid values: ALL, PRIMARY, BACKUP, and DESIGNATED_USER.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'enumValueTitles' => [],
+ 'example' => 'ALL',
+ 'default' => 'ALL',
+ 'enum' => [
+ 'ALL',
+ 'PRIMARY',
+ 'BACKUP',
+ 'DESIGNATED_USER',
+ ],
+ ],
+ ],
+ [
+ 'name' => 'ShiftPersonUID',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The ID of the Alibaba Cloud account. You can log on to the DataWorks console and move the pointer over the profile picture in the upper-right corner to view the ID.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => '1933790****551',
+ ],
+ ],
+ [
+ 'name' => 'BeginTime',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The time when the on-duty engineer starts a shift. Set the value to a UNIX timestamp.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => '1593950832000',
+ ],
+ ],
+ [
+ 'name' => 'EndTime',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The time when the on-duty engineer ends a shift. Set the value to a UNIX timestamp.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => '1593950832000',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => 'Schema of Response',
+ 'description' => 'The response parameters.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'title' => 'Id of the request',
+ 'description' => 'The request ID. You can use the ID to troubleshoot issues.'."\n",
+ 'type' => 'string',
+ 'example' => '0000-ABCD-EFG',
+ ],
+ 'Paging' => [
+ 'description' => 'The pagination information.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'PageNumber' => [
+ 'description' => 'The page number. Valid values: 1 to 100. Default value: 1.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '1',
+ ],
+ 'PageSize' => [
+ 'description' => 'The number of entries per page. Default value: 10. Maximum value: 100.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '10',
+ ],
+ 'TotalCount' => [
+ 'description' => 'The total number of entries returned.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '100',
+ ],
+ 'ShiftPersons' => [
+ 'description' => 'The on-duty engineers in the shift schedule.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The on-duty engineer in the shift schedule.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'ShiftPersonUID' => [
+ 'description' => 'The UID of the on-duty engineer.'."\n",
+ 'type' => 'string',
+ 'example' => '3726346****',
+ ],
+ 'ShiftPersonName' => [
+ 'description' => 'The name of the on-duty engineer.'."\n",
+ 'type' => 'string',
+ 'example' => 'Zhang San',
+ ],
+ 'BeginTime' => [
+ 'description' => 'The time when the on-duty engineer starts the shift.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '1593950832000',
+ ],
+ 'EndTime' => [
+ 'description' => 'The time when the on-duty engineer ends the shift.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '1593950832000',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"0000-ABCD-EFG\\",\\n \\"Paging\\": {\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 100,\\n \\"ShiftPersons\\": [\\n {\\n \\"ShiftPersonUID\\": \\"3726346****\\",\\n \\"ShiftPersonName\\": \\"Zhang San\\",\\n \\"BeginTime\\": 1593950832000,\\n \\"EndTime\\": 1593950832000\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<ListShiftPersonnelsResponse>\\n <RequestId>0000-ABCD-EFG</RequestId>\\n <Paging>\\n <PageNumber>1</PageNumber>\\n <PageSize>10</PageSize>\\n <TotalCount>100</TotalCount>\\n <ShiftPersons>\\n <ShiftPersonUID>3726346****</ShiftPersonUID>\\n <ShiftPersonName>张三</ShiftPersonName>\\n <StartLong>1593950832000</StartLong>\\n <EndLong>1593950832000</EndLong>\\n </ShiftPersons>\\n </Paging>\\n</ListShiftPersonnelsResponse>","errorExample":""}]',
+ 'title' => 'ListShiftPersonnels',
+ ],
+ 'ListShiftSchedules' => [
+ 'summary' => 'Queries a list of shift schedules in Operation Center.',
+ 'methods' => [
+ 'get',
+ 'post',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'list',
+ 'abilityTreeCode' => '140315',
+ 'abilityTreeNodes' => [
+ 'FEATUREdideRJGWWC',
+ ],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'ShiftScheduleName',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The keyword used to perform a fuzzy search on shift schedules.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'Duty table name keyword',
+ ],
+ ],
+ [
+ 'name' => 'Owner',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The Alibaba Cloud account ID. You can log on to the DataWorks console and move the pointer over the profile picture in the upper-right corner to view the ID.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => '1933790683****',
+ ],
+ ],
+ [
+ 'name' => 'PageSize',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The number of entries per page. Default value: 10. Maximum value: 100.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => false,
+ 'maximum' => '100',
+ 'minimum' => '10',
+ 'example' => '10',
+ 'default' => '10',
+ ],
+ ],
+ [
+ 'name' => 'PageNumber',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The page number. Minimum value:1. Maximum value: 100. Default value: 1.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => false,
+ 'maximum' => '100',
+ 'minimum' => '1',
+ 'example' => '1',
+ 'default' => '1',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => 'Schema of Response',
+ 'description' => 'The response parameters.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'title' => 'Id of the request',
+ 'description' => 'The request ID.'."\n",
+ 'type' => 'string',
+ 'example' => 'E6F0DBDD-5AD****',
+ ],
+ 'Paging' => [
+ 'description' => 'The pagination information.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'PageNumber' => [
+ 'description' => 'The page number. Minimum value: 1. Maximum value: 100.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '1',
+ ],
+ 'PageSize' => [
+ 'description' => 'The number of entries per page.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '10',
+ ],
+ 'TotalCount' => [
+ 'description' => 'The total number of entries returned.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '100',
+ ],
+ 'ShiftSchedules' => [
+ 'description' => 'The shift schedules.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The shift schedule.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'ShiftScheduleIdentifier' => [
+ 'description' => 'The unique identifier of the shift schedule. You can use the identifier to query the on-duty engineers in the shift schedule.'."\n",
+ 'type' => 'string',
+ 'example' => '2ab6456ada634b2f938ee******9b45b',
+ ],
+ 'ShiftScheduleName' => [
+ 'description' => 'The name of the shift schedule.'."\n",
+ 'type' => 'string',
+ 'example' => 'Duty table name',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"E6F0DBDD-5AD****\\",\\n \\"Paging\\": {\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 100,\\n \\"ShiftSchedules\\": [\\n {\\n \\"ShiftScheduleIdentifier\\": \\"2ab6456ada634b2f938ee******9b45b\\",\\n \\"ShiftScheduleName\\": \\"Duty table name\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<ListShiftSchedulesResponse>\\n <RequestId>E6F0DBDD-5AD****</RequestId>\\n <Paging>\\n <PageNumber>1</PageNumber>\\n <PageSize>10</PageSize>\\n <TotalCount>100</TotalCount>\\n <ShiftSchedules>\\n <ShiftScheduleIdentifier>2ab6456ada634b2f938ee******9b45b</ShiftScheduleIdentifier>\\n <ShiftScheduleName>值班表名称</ShiftScheduleName>\\n </ShiftSchedules>\\n </Paging>\\n</ListShiftSchedulesResponse>","errorExample":""}]',
+ 'title' => 'ListShiftSchedules',
+ ],
+ 'ListInstanceHistory' => [
+ 'summary' => 'Queries information about the historical records of all instances. One historical record is generated if an instance is rerun once.',
+ 'methods' => [
+ 'post',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'get',
+ 'abilityTreeCode' => '146270',
+ 'abilityTreeNodes' => [
+ 'FEATUREdide7WF1GB',
+ ],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'InstanceId',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The instance ID. You can call the ListInstances operation to query the instance ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => '1234',
+ ],
+ ],
+ [
+ 'name' => 'ProjectEnv',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The environment of the workspace. Valid values: PROD and DEV. By default, data of instances in the production environment is queried.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'PROD',
+ 'default' => 'PROD',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => 'Schema of Response',
+ 'description' => 'The response parameters.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'title' => 'Id of the request',
+ 'description' => 'The request ID.'."\n",
+ 'type' => 'string',
+ 'example' => 'E6F0DBDD-5AD****',
+ ],
+ 'Success' => [
+ 'description' => 'Indicates whether the request was successful. Valid values:'."\n"
+ ."\n"
+ .'* true'."\n"
+ .'* false'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'Instances' => [
+ 'description' => 'The instances.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '',
+ 'type' => 'object',
+ 'properties' => [
+ 'Status' => [
+ 'description' => 'The status of the node that generates the instance. Valid values:'."\n"
+ ."\n"
+ .'* NOT_RUN: The node is not run.'."\n"
+ .'* WAIT_TIME: The node is waiting for the scheduling time to arrive.'."\n"
+ .'* WAIT_RESOURCE: The node is waiting for resources.'."\n"
+ .'* RUNNING: The node is running.'."\n"
+ .'* CHECKING: Data quality is being checked for the node.'."\n"
+ .'* CHECKING_CONDITION: Branch conditions are being checked for the node.'."\n"
+ .'* FAILURE: The node fails to be run.'."\n"
+ .'* SUCCESS: The node is successfully run.'."\n",
+ 'type' => 'string',
+ 'example' => 'NOT_RUN',
+ ],
+ 'CycTime' => [
+ 'description' => 'The time when the node started to be run. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since the epoch time January 1, 1970, 00:00:00 UTC.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '1590422400000',
+ ],
+ 'BeginRunningTime' => [
+ 'description' => 'The time when the instance started to be run. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since the epoch time January 1, 1970, 00:00:00 UTC.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '1590416703313',
+ ],
+ 'FinishTime' => [
+ 'description' => 'The time when the running of the node was complete. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since the epoch time January 1, 1970, 00:00:00 UTC.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '1590416703313',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message. This parameter is deprecated. You can call the GetInstanceLog operation to query the error information related to the node.'."\n",
+ 'type' => 'string',
+ 'example' => 'error message',
+ ],
+ 'CreateTime' => [
+ 'description' => 'The time when the instance was generated.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '1590416703313',
+ ],
+ 'DagId' => [
+ 'description' => 'The workflow ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '33845',
+ ],
+ 'TaskType' => [
+ 'description' => 'The scheduling type of the node. Valid values:'."\n"
+ ."\n"
+ .'* NORMAL(0): The node is an auto triggered node. The scheduling system regularly runs the node.'."\n"
+ .'* MANUAL(1): The node is a manually triggered node. The scheduling system does not regularly run the node.'."\n"
+ .'* PAUSE(2): The node is a frozen node. The scheduling system regularly runs the node but sets the status of the node to failed when the scheduling system starts to run the node.'."\n"
+ .'* SKIP(3): The node is a dry-run node. The scheduling system regularly runs the node but sets the status of the node to successful when the scheduling system starts to run the node.'."\n"
+ .'* SKIP_UNCHOOSE(4): The node is an unselected node in a temporary workflow. This type of node exists only in temporary workflows. The scheduling system sets the status of the node to successful when the scheduling system starts to run the node.'."\n"
+ .'* SKIP_CYCLE(5): The node is a node that is scheduled by the week or month and is waiting for the scheduling time to arrive. The scheduling system regularly runs the node but sets the status of the node to successful when the scheduling system starts to run the node.'."\n"
+ .'* CONDITION_UNCHOOSE(6): The node is not selected by its ancestor branch node and is run as a dry-run node.'."\n"
+ .'* REALTIME_DEPRECATED(7): The node has instances that are generated in real time but deprecated. The scheduling system sets the status of the node to successful.'."\n",
+ 'type' => 'string',
+ 'example' => 'NORMAL(0)',
+ ],
+ 'DagType' => [
+ 'description' => 'Indicates whether the instance is associated with a monitoring rule in Data Quality. Valid values:'."\n"
+ ."\n"
+ .'* 0: The instance is associated with a monitoring rule in Data Quality.'."\n"
+ .'* 1: The instance is not associated with a monitoring rule in Data Quality.'."\n",
+ 'type' => 'string',
+ 'example' => '1',
+ ],
+ 'ModifyTime' => [
+ 'description' => 'The time when the node was last modified.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '1590416703313',
+ ],
+ 'InstanceId' => [
+ 'description' => 'The instance ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '1234',
+ ],
+ 'BeginWaitResTime' => [
+ 'description' => 'The time when the instance started to wait for resources.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '1590416703313',
+ ],
+ 'Bizdate' => [
+ 'description' => 'The data timestamp of the instance. In most cases, the value is one day before the time when the instance was run.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '1590336000000',
+ ],
+ 'NodeName' => [
+ 'description' => 'The name of the node.'."\n",
+ 'type' => 'string',
+ 'example' => 'kzh',
+ ],
+ 'BeginWaitTimeTime' => [
+ 'description' => 'The time when the instance started to wait to be scheduled.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '1590416703313',
+ ],
+ 'NodeId' => [
+ 'description' => 'The node ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '33115',
+ ],
+ 'InstanceHistoryId' => [
+ 'description' => 'The historical record number of the instance.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '1',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"E6F0DBDD-5AD****\\",\\n \\"Success\\": true,\\n \\"Instances\\": [\\n {\\n \\"Status\\": \\"NOT_RUN\\",\\n \\"CycTime\\": 1590422400000,\\n \\"BeginRunningTime\\": 1590416703313,\\n \\"FinishTime\\": 1590416703313,\\n \\"ErrorMessage\\": \\"error message\\",\\n \\"CreateTime\\": 1590416703313,\\n \\"DagId\\": 33845,\\n \\"TaskType\\": \\"NORMAL(0)\\",\\n \\"DagType\\": \\"1\\",\\n \\"ModifyTime\\": 1590416703313,\\n \\"InstanceId\\": 1234,\\n \\"BeginWaitResTime\\": 1590416703313,\\n \\"Bizdate\\": 1590336000000,\\n \\"NodeName\\": \\"kzh\\",\\n \\"BeginWaitTimeTime\\": 1590416703313,\\n \\"NodeId\\": 33115,\\n \\"InstanceHistoryId\\": 1\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<ListInstanceHistoryResponse>\\n <RequestId>E6F0DBDD-5AD****</RequestId>\\n <Success>true</Success>\\n <Instances>\\n <Status>NOT_RUN</Status>\\n <CycTime>1590422400000</CycTime>\\n <BeginRunningTime>1590416703313</BeginRunningTime>\\n <FinishTime>1590416703313</FinishTime>\\n <ErrorMessage>error message</ErrorMessage>\\n <CreateTime>1590416703313</CreateTime>\\n <DagId>33845</DagId>\\n <TaskType>NORMAL(0)</TaskType>\\n <DagType>1</DagType>\\n <ModifyTime>1590416703313</ModifyTime>\\n <InstanceId>1234</InstanceId>\\n <BeginWaitResTime>1590416703313</BeginWaitResTime>\\n <Bizdate>1590336000000</Bizdate>\\n <NodeName>kzh</NodeName>\\n <BeginWaitTimeTime>1590416703313</BeginWaitTimeTime>\\n <NodeId>33115</NodeId>\\n <InstanceHistoryId>1</InstanceHistoryId>\\n </Instances>\\n</ListInstanceHistoryResponse>","errorExample":""}]',
+ 'title' => 'ListInstanceHistory',
+ ],
+ 'ListInnerNodes' => [
+ 'summary' => 'Queries information about inner nodes. For example, you can call this operation to query the inner nodes of a node group or a do-while node. You cannot call this operation to query the inner nodes of a PAI node.',
+ 'methods' => [
+ 'get',
+ 'post',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'list',
+ 'abilityTreeCode' => '146118',
+ 'abilityTreeNodes' => [
+ 'FEATUREdide7WF1GB',
+ ],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'ProgramType',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The type of the node to which the inner nodes belong.'."\n"
+ ."\n"
+ .'Valid values: 6 (Shell), 10 (ODPS SQL), 11 (ODPS MR), 23 (Data Integration), 24 (ODPS Script), 97 (PAI), 98 (node group), 99 (zero load), 221 (PyODPS 2), 225 (ODPS Spark), 227 (EMR Hive), 228 (EMR Spark), 229 (EMR Spark SQL), 230 (EMR MR), 239 (OSS object inspection), 257 (EMR Shell), 258 (EMR Spark Shell), 259 (EMR Presto), 260 (EMR Impala), 900 (real-time synchronization), 1002 (PAI inner node), 1089 (cross-tenant collaboration), 1091 (Hologres development), 1093 (Hologres SQL), 1100 (assignment), 1106 (for-each), and 1221 (PyODPS 3). You can call the ListNodes operation to query the type of the node.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'ODPS_SQL',
+ ],
+ ],
+ [
+ 'name' => 'PageNumber',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The page number. Valid values: 1 to 100.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => false,
+ 'maximum' => '100',
+ 'minimum' => '1',
+ 'example' => '1',
+ 'default' => '1',
+ ],
+ ],
+ [
+ 'name' => 'PageSize',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The number of entries per page. Default value: 10. Maximum value: 100.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => false,
+ 'maximum' => '100',
+ 'minimum' => '10',
+ 'example' => '10',
+ 'default' => '10',
+ ],
+ ],
+ [
+ 'name' => 'ProjectId',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The workspace ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => '1234',
+ ],
+ ],
+ [
+ 'name' => 'ProjectEnv',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The environment in which the node is run. Valid values: DEV and PROD. Default value: PROD.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'PROD',
+ 'default' => 'PROD',
+ ],
+ ],
+ [
+ 'name' => 'NodeName',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The name of the node to which the inner nodes belong.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'liux_test_n****',
+ ],
+ ],
+ [
+ 'name' => 'OuterNodeId',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The ID of the node group to which the inner nodes belong.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => '1234',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => 'Schema of Response',
+ 'description' => 'The returned result.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'title' => 'Id of the request',
+ 'description' => 'The request ID.'."\n",
+ 'type' => 'string',
+ 'example' => 'E6F0DBDD-5AD****',
+ ],
+ 'Success' => [
+ 'description' => 'Indicates whether the request was successful.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'Paging' => [
+ 'description' => 'The pagination information.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'PageNumber' => [
+ 'description' => 'The page number.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '1',
+ ],
+ 'PageSize' => [
+ 'description' => 'The number of entries per page. Default value: 10. Maximum value: 100.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '10',
+ ],
+ 'TotalCount' => [
+ 'description' => 'The total number of inner nodes returned.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '100',
+ ],
+ 'Nodes' => [
+ 'description' => 'The list of inner nodes.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The inner node.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'SchedulerType' => [
+ 'description' => 'The scheduling type of the inner node. Valid values:'."\n"
+ ."\n"
+ .'* NORMAL: The inner node is an auto triggered node.'."\n"
+ .'* MANUAL: The inner node is a manually triggered node. The scheduling system does not run the node on a regular basis.'."\n"
+ .'* PAUSE: The inner node is a paused node.'."\n"
+ .'* SKIP: The inner node is a dry-run node. Dry-run nodes are started as scheduled, but the scheduling system sets the status of the nodes to successful when it starts to run them.'."\n",
+ 'type' => 'string',
+ 'example' => 'NORMAL',
+ ],
+ 'RepeatInterval' => [
+ 'description' => 'The interval at which the inner node is rerun after the inner node fails to run.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '60',
+ ],
+ 'Repeatability' => [
+ 'description' => 'Indicates whether the inner node can be rerun.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'ProjectId' => [
+ 'description' => 'The workspace ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '123',
+ ],
+ 'ProgramType' => [
+ 'description' => 'The type of the inner node.'."\n",
+ 'type' => 'string',
+ 'example' => 'ODPS_SQL',
+ ],
+ 'Priority' => [
+ 'description' => 'The priority of the inner node. Valid values: 1, 3, 5, 7, and 8.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '1',
+ ],
+ 'OwnerId' => [
+ 'description' => 'The owner ID.'."\n",
+ 'type' => 'string',
+ 'example' => '1933****36551',
+ ],
+ 'Connection' => [
+ 'description' => 'The connection string.'."\n",
+ 'type' => 'string',
+ 'example' => 'odps_first',
+ ],
+ 'ParamValues' => [
+ 'description' => 'The additional parameters.'."\n",
+ 'type' => 'string',
+ 'example' => 'a=b',
+ ],
+ 'DqcType' => [
+ 'description' => 'Indicates whether the inner node is associated with a monitoring rule in Data Quality. Valid values: 0 and 1. The value 0 indicates that the inner node is associated with a monitoring rule in Data Quality. The value 1 indicates that the inner node is not associated with a monitoring rule in Data Quality.'."\n",
+ 'type' => 'string',
+ 'example' => '1',
+ ],
+ 'BaselineId' => [
+ 'description' => 'The baseline ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '1234',
+ ],
+ 'Description' => [
+ 'description' => 'The description of the inner node.'."\n",
+ 'type' => 'string',
+ 'example' => 'test',
+ ],
+ 'NodeName' => [
+ 'description' => 'The name of the inner node.'."\n",
+ 'type' => 'string',
+ 'example' => 'liux_test_n****',
+ ],
+ 'ResGroupName' => [
+ 'description' => 'The name of the resource group.'."\n",
+ 'type' => 'string',
+ 'example' => 'Default Resource Group',
+ ],
+ 'BusinessId' => [
+ 'description' => 'The workflow ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '123',
+ ],
+ 'DqcDescription' => [
+ 'description' => 'The table and partition filter expression in Data Quality that are associated with the inner node.'."\n",
+ 'type' => 'string',
+ 'example' => '[{"projectName":"ztjy_dim","tableName":"dim_user_agent_manage_area_a","partition":"ds\\u003d$[yyyy-mm-dd-1]"}]',
+ ],
+ 'CronExpress' => [
+ 'description' => 'The CRON expression.'."\n",
+ 'type' => 'string',
+ 'example' => '00 00 00 * * ?',
+ ],
+ 'NodeId' => [
+ 'description' => 'The inner node ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '12',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"E6F0DBDD-5AD****\\",\\n \\"Success\\": true,\\n \\"Paging\\": {\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 100,\\n \\"Nodes\\": [\\n {\\n \\"SchedulerType\\": \\"NORMAL\\",\\n \\"RepeatInterval\\": 60,\\n \\"Repeatability\\": true,\\n \\"ProjectId\\": 123,\\n \\"ProgramType\\": \\"ODPS_SQL\\",\\n \\"Priority\\": 1,\\n \\"OwnerId\\": \\"1933****36551\\",\\n \\"Connection\\": \\"odps_source\\",\\n \\"ParamValues\\": \\"a=b\\",\\n \\"DqcType\\": \\"1\\",\\n \\"BaselineId\\": 1234,\\n \\"Description\\": \\"test\\",\\n \\"NodeName\\": \\"liux_test_n****\\",\\n \\"ResGroupName\\": \\"Default Resource Group\\",\\n \\"BusinessId\\": 123,\\n \\"DqcDescription\\": \\"[{\\\\\\"projectName\\\\\\":\\\\\\"ztjy_dim\\\\\\",\\\\\\"tableName\\\\\\":\\\\\\"dim_user_agent_manage_area_a\\\\\\",\\\\\\"partition\\\\\\":\\\\\\"ds\\\\\\\\u003d$[yyyy-mm-dd-1]\\\\\\"}]\\",\\n \\"CronExpress\\": \\"00 00 00 * * ?\\",\\n \\"NodeId\\": 12\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<ListInnerNodesResponse>\\n <RequestId>E6F0DBDD-5AD****</RequestId>\\n <Success>true</Success>\\n <Paging>\\n <PageNumber>1</PageNumber>\\n <PageSize>10</PageSize>\\n <TotalCount>100</TotalCount>\\n <Nodes>\\n <SchedulerType>NORMAL</SchedulerType>\\n <RepeatInterval>60</RepeatInterval>\\n <Repeatability>true</Repeatability>\\n <ProjectId>123</ProjectId>\\n <ProgramType>ODPS_SQL</ProgramType>\\n <Priority>1</Priority>\\n <OwnerId>19337906836551</OwnerId>\\n <Connection>odps_source</Connection>\\n <ParamValues>a=b</ParamValues>\\n <DqcType>1</DqcType>\\n <BaselineId>1234</BaselineId>\\n <Description>test</Description>\\n <NodeName>liux_test_n****</NodeName>\\n <ResGroupName>默认资源组</ResGroupName>\\n <BusinessId>123</BusinessId>\\n <DqcDescription>[{\\"projectName\\":\\"ztjy_dim\\",\\"tableName\\":\\"dim_user_agent_manage_area_a\\",\\"partition\\":\\"ds\\\\u003d$[yyyy-mm-dd-1]\\"}]</DqcDescription>\\n <CronExpress>00 00 00 * * ?</CronExpress>\\n <NodeId>12</NodeId>\\n </Nodes>\\n </Paging>\\n</ListInnerNodesResponse>","errorExample":""}]',
+ 'title' => 'ListInnerNodes',
+ ],
+ 'OfflineNode' => [
+ 'summary' => 'Undeploys a node.',
+ 'methods' => [
+ 'post',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'readAndWrite',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'get',
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'NodeId',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The node ID. You can call the [ListNodes](~~173979~~) operation to obtain the node ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => true,
+ 'docRequired' => true,
+ 'minimum' => '2',
+ 'example' => '1234',
+ ],
+ ],
+ [
+ 'name' => 'ProjectId',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The DataWorks workspace ID. You can call the [ListProjects](~~178393~~) operation to obtain the ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => true,
+ 'docRequired' => true,
+ 'minimum' => '1',
+ 'example' => '9527',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => 'Schema of Response',
+ 'description' => 'The response parameters.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'title' => 'Id of the request',
+ 'description' => 'The request ID. You can use the request ID to query logs and troubleshoot issues.'."\n",
+ 'type' => 'string',
+ 'example' => 'E6F0DBDD-5AD****',
+ ],
+ 'Success' => [
+ 'description' => 'Indicates whether the request was successful.'."\n",
+ 'type' => 'string',
+ 'example' => 'true',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"E6F0DBDD-5AD****\\",\\n \\"Success\\": \\"true\\"\\n}","errorExample":""},{"type":"xml","example":"<OfflineNodeResponse>\\n <RequestId>E6F0DBDD-5AD****</RequestId>\\n <Success>true</Success>\\n</OfflineNodeResponse>","errorExample":""}]',
+ 'title' => 'OfflineNode',
+ ],
+ 'GetBaseline' => [
+ 'summary' => 'Queries the information about a baseline based on its ID.',
+ 'methods' => [
+ 'post',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'get',
+ 'abilityTreeCode' => '158223',
+ 'abilityTreeNodes' => [
+ 'FEATUREdideSFSFU4',
+ ],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'BaselineId',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The baseline ID. You can call the [ListBaselines](~~2261507~~) operation to query the ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => true,
+ 'example' => '123456',
+ ],
+ ],
+ [
+ 'name' => 'ProjectId',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The ID of the workspace to which the baseline belongs. You can call the [ListBaselines](~~2261507~~) operation to query the ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => true,
+ 'example' => '10000',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => 'OpenApiResultModel<PopBaselineConfigDto>',
+ 'description' => 'OpenApiResultModel'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'Success' => [
+ 'description' => 'Indicates whether the request was successful. Valid values:'."\n"
+ ."\n"
+ .'* true'."\n"
+ .'* false'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code.'."\n",
+ 'type' => 'string',
+ 'example' => '1031203110005',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message.'."\n",
+ 'type' => 'string',
+ 'example' => 'The specified parameters are invalid',
+ ],
+ 'HttpStatusCode' => [
+ 'description' => 'The HTTP status code.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '200',
+ ],
+ 'Data' => [
+ 'description' => 'The data returned.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'BaselineId' => [
+ 'title' => '基线id',
+ 'description' => 'The baseline ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '1001',
+ ],
+ 'BaselineName' => [
+ 'title' => '基线名',
+ 'description' => 'The name of the baseline.'."\n",
+ 'type' => 'string',
+ 'example' => 'Test baseline',
+ ],
+ 'ProjectId' => [
+ 'title' => '项目id',
+ 'description' => 'The workspace ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '10000',
+ ],
+ 'Owner' => [
+ 'title' => '责任人',
+ 'description' => 'The owner.'."\n",
+ 'type' => 'string',
+ 'example' => '9527952****',
+ ],
+ 'Priority' => [
+ 'title' => '优先级',
+ 'description' => 'The priority of the baseline. Valid values: 1, 3, 5, 7, and 8.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '1',
+ ],
+ 'BaselineType' => [
+ 'title' => '基线类型 (DAILY, HOURLY)',
+ 'description' => 'The type of the baseline. Valid values:'."\n"
+ ."\n"
+ .'* DAILY'."\n"
+ .'* HOURLY'."\n",
+ 'type' => 'string',
+ 'example' => 'DAILY',
+ ],
+ 'OverTimeSettings' => [
+ 'title' => '基线承诺时间设置',
+ 'description' => 'The settings of the committed completion time of the baseline.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '',
+ 'type' => 'object',
+ 'properties' => [
+ 'Cycle' => [
+ 'title' => '周期，取值范围 [1,24]',
+ 'description' => 'The period corresponding to the commitment time. The space-based line is 1, and the hourly baseline can be configured for up to 24 cycles.',
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '1',
+ ],
+ 'Time' => [
+ 'title' => '承诺时间，hh:mm格式，hh的取值范围为[0,47]，mm的取值范围为[0,59]',
+ 'description' => 'Commitment time, hh:mm format, hh value range is [0,47],mm value range is [0,59].',
+ 'type' => 'string',
+ 'example' => '00:00',
+ ],
+ ],
+ ],
+ ],
+ 'Enabled' => [
+ 'title' => '是否开启基线',
+ 'description' => 'Indicates whether the baseline is enabled.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'NodeIds' => [
+ 'title' => '基线节点列表',
+ 'description' => 'The node IDs.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'Node ID.',
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '700003****',
+ ],
+ ],
+ 'AlertEnabled' => [
+ 'title' => '是否开启告警',
+ 'description' => 'Indicates whether the alerting feature is enabled. Valid values:'."\n"
+ ."\n"
+ .'* true'."\n"
+ .'* false'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'AlertMarginThreshold' => [
+ 'title' => '预警余量，单位为分钟',
+ 'description' => 'The alert margin threshold. Unit: minutes.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '60',
+ ],
+ 'AlertSettings' => [
+ 'title' => '告警设置',
+ 'description' => 'The alert settings.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'Baseline alert configuration',
+ 'type' => 'object',
+ 'properties' => [
+ 'AlertType' => [
+ 'title' => '告警类型，BASELINE / TOPIC',
+ 'description' => 'Alert type'."\n"
+ ."\n"
+ .'- BASELINE: baseline'."\n"
+ .'- TOPIC: event',
+ 'type' => 'string',
+ 'example' => 'BASELINE',
+ ],
+ 'AlertMethods' => [
+ 'title' => '告警方式',
+ 'description' => 'Alert method list',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The alert method. The values are as follows:'."\n"
+ ."\n"
+ .'- MAIL: MAIL'."\n"
+ .'- SMS: SMS'."\n"
+ .'- PHONE: voice'."\n"
+ .'- DINGROBOTS: DingTalk robot'."\n"
+ .'- WEBHOOKS: Webhook',
+ 'type' => 'string',
+ 'example' => 'MAIL',
+ ],
+ ],
+ 'SilenceStartTime' => [
+ 'title' => '静默开始时间',
+ 'description' => 'The start time of the silence. Format: HH:mm:ss',
+ 'type' => 'string',
+ 'example' => '00:00:00',
+ ],
+ 'SilenceEndTime' => [
+ 'title' => '静默结束时间',
+ 'description' => 'The end time of the silence. The format is HH:mm:ss.',
+ 'type' => 'string',
+ 'example' => '00:00:00',
+ ],
+ 'AlertInterval' => [
+ 'title' => '事件告警间隔',
+ 'description' => 'The event alert interval, in seconds.',
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '900',
+ ],
+ 'AlertMaximum' => [
+ 'title' => '事件告警最大次数',
+ 'description' => 'The maximum number of event alerts.',
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '1',
+ ],
+ 'DingRobots' => [
+ 'title' => '钉钉机器人列表',
+ 'description' => 'DingTalk robot list.',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'DingTalk robot configuration.',
+ 'type' => 'object',
+ 'properties' => [
+ 'WebUrl' => [
+ 'description' => 'DingTalk robot address',
+ 'type' => 'string',
+ 'example' => 'https://oapi.dingtalk.com/robot/send?access_token=xxx',
+ ],
+ 'AtAll' => [
+ 'description' => 'Whether @ everyone.',
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ ],
+ ],
+ ],
+ 'Webhooks' => [
+ 'title' => 'webhook 列表',
+ 'description' => 'webhook list.',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The webhook addresses of the Enterprise WeChat or flying book Robot. Separate multiple webhook addresses with commas (,). alertMethods must include WEBHOOKS alert methods. Only DataWorks Enterprise Edition is supported.'."\n"
+ ."\n"
+ .'Available regions: China(Shanghai), China(Chengdu), China(Zhangjiakou), China(Beijing), China(Hangzhou), China(Shenzhen), China (Hong Kong), Central Europe 1 (Frankfurt), and Southeast Asia Pacific 1 (Singapore).',
+ 'type' => 'string',
+ 'example' => 'https://open.feishu.cn/open-apis/bot/v2/hook/xxx',
+ ],
+ ],
+ 'TopicTypes' => [
+ 'title' => '事件告警类型，事件特有配置',
+ 'description' => 'The list of Event Alert types.',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The type of the event alert.'."\n"
+ ."\n"
+ .'- SLOW'."\n"
+ .'- ERROR',
+ 'type' => 'string',
+ 'example' => 'SLOW',
+ ],
+ ],
+ 'BaselineAlertEnabled' => [
+ 'title' => '基线告警开关，基线特有配置',
+ 'description' => 'The baseline alarm switch.'."\n"
+ ."\n"
+ .'- true'."\n"
+ .'- false',
+ 'type' => 'boolean',
+ 'example' => 'false',
+ ],
+ 'AlertRecipientType' => [
+ 'title' => '告警接收人类型',
+ 'description' => 'The type of alert recipient.'."\n"
+ ."\n"
+ .'- OWNER: task owner'."\n"
+ .'- OTHER: designated person'."\n"
+ .'- SHIFT: SCHEDULE-duty table',
+ 'type' => 'string',
+ 'example' => 'OWNER',
+ ],
+ 'AlertRecipient' => [
+ 'title' => '告警接收人详情',
+ 'description' => 'Alert recipient details.'."\n"
+ ."\n"
+ .'AlertRecipientType is OWNER: empty'."\n"
+ .'AlertRecipientType is SHIFT_SCHEDULE: duty table uid'."\n"
+ .'AlertRecipientType is OTHER: uid list, multiple UIDs are in English, split',
+ 'type' => 'string',
+ 'example' => '123123',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'RequestId' => [
+ 'description' => 'The request ID.'."\n",
+ 'type' => 'string',
+ 'example' => 'ecb967ec-c137-48a5-860****',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"1031203110005\\",\\n \\"ErrorMessage\\": \\"The specified parameters are invalid\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Data\\": {\\n \\"BaselineId\\": 1001,\\n \\"BaselineName\\": \\"Test baseline\\",\\n \\"ProjectId\\": 10000,\\n \\"Owner\\": \\"9527952****\\",\\n \\"Priority\\": 1,\\n \\"BaselineType\\": \\"DAILY\\",\\n \\"OverTimeSettings\\": [\\n {\\n \\"Cycle\\": 1,\\n \\"Time\\": \\"00:00\\"\\n }\\n ],\\n \\"Enabled\\": true,\\n \\"NodeIds\\": [\\n 0\\n ],\\n \\"AlertEnabled\\": true,\\n \\"AlertMarginThreshold\\": 60,\\n \\"AlertSettings\\": [\\n {\\n \\"AlertType\\": \\"BASELINE\\",\\n \\"AlertMethods\\": [\\n \\"MAIL\\"\\n ],\\n \\"SilenceStartTime\\": \\"00:00:00\\",\\n \\"SilenceEndTime\\": \\"00:00:00\\",\\n \\"AlertInterval\\": 900,\\n \\"AlertMaximum\\": 1,\\n \\"DingRobots\\": [\\n {\\n \\"WebUrl\\": \\"https://oapi.dingtalk.com/robot/send?access_token=xxx\\",\\n \\"AtAll\\": true\\n }\\n ],\\n \\"Webhooks\\": [\\n \\"https://open.feishu.cn/open-apis/bot/v2/hook/xxx\\"\\n ],\\n \\"TopicTypes\\": [\\n \\"SLOW\\"\\n ],\\n \\"BaselineAlertEnabled\\": false,\\n \\"AlertRecipientType\\": \\"OWNER\\",\\n \\"AlertRecipient\\": \\"123123\\"\\n }\\n ]\\n },\\n \\"RequestId\\": \\"ecb967ec-c137-48a5-860****\\"\\n}","errorExample":""},{"type":"xml","example":"<GetBaselineResponse>\\n <Success>true</Success>\\n <ErrorCode>1031203110005</ErrorCode>\\n <ErrorMessage>The specified parameters are invalid</ErrorMessage>\\n <HttpStatusCode>200</HttpStatusCode>\\n <Data>\\n <BaselineId>1001</BaselineId>\\n <BaselineName>测试基线</BaselineName>\\n <ProjectId>10000</ProjectId>\\n <Owner>9527952****</Owner>\\n <Priority>1</Priority>\\n <BaselineType>DAILY</BaselineType>\\n <OverTimeSettings>\\n <Cycle>1</Cycle>\\n <Time>00:00</Time>\\n </OverTimeSettings>\\n <Enabled>true</Enabled>\\n <TaskIds>123123</TaskIds>\\n <AlertEnabled>true</AlertEnabled>\\n <AlertMarginThreshold>60</AlertMarginThreshold>\\n <AlertSettings>\\n <AlertType>BASELINE</AlertType>\\n <AlertMethods>MAIL</AlertMethods>\\n <SilenceStartTime>00:00:00</SilenceStartTime>\\n <SilenceEndTime>00:00:00</SilenceEndTime>\\n <AlertInterval>900</AlertInterval>\\n <AlertMaximum>1</AlertMaximum>\\n <DingRobots>\\n <WebUrl>https://oapi.dingtalk.com/robot/send?access_token=xxx</WebUrl>\\n <AtAll>true</AtAll>\\n </DingRobots>\\n <Webhooks>https://open.feishu.cn/open-apis/bot/v2/hook/xxx</Webhooks>\\n <TopicTypes>SLOW</TopicTypes>\\n <BaselineAlertEnabled>false</BaselineAlertEnabled>\\n <AlertRecipientType>OWNER</AlertRecipientType>\\n <AlertRecipient>123123</AlertRecipient>\\n </AlertSettings>\\n </Data>\\n <RequestId>ecb967ec-c137-48a5-860****</RequestId>\\n</GetBaselineResponse>","errorExample":""}]',
+ 'title' => 'GetBaseline',
+ ],
+ 'DeleteBaseline' => [
+ 'methods' => [
+ 'post',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'readAndWrite',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'delete',
+ 'abilityTreeCode' => '158727',
+ 'abilityTreeNodes' => [
+ 'FEATUREdideSFSFU4',
+ ],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'BaselineId',
+ 'in' => 'formData',
+ 'schema' => [
+ 'title' => '基线Id',
+ 'description' => 'The baseline ID. You can call the [ListBaselines](~~2261507~~) operation to query the ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => true,
+ 'example' => '1234',
+ ],
+ ],
+ [
+ 'name' => 'ProjectId',
+ 'in' => 'formData',
+ 'schema' => [
+ 'title' => '项目空间ID',
+ 'description' => 'The ID of the workspace to which the baseline belongs. You can call the ListBaselines operation to query the ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => true,
+ 'example' => '10000',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => 'OpenApiResultModel<Boolean>',
+ 'description' => 'The response parameters.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'Success' => [
+ 'description' => 'Indicates whether the request was successful. Valid values:'."\n"
+ ."\n"
+ .'* true'."\n"
+ .'* false'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code.'."\n",
+ 'type' => 'string',
+ 'example' => '1031203110000',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message.'."\n",
+ 'type' => 'string',
+ 'example' => 'Baseline deletion failed with nodes dependent on baseline',
+ ],
+ 'HttpStatusCode' => [
+ 'description' => 'The HTTP status code.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '200',
+ ],
+ 'Data' => [
+ 'description' => 'Indicates whether the deletion was successful.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'RequestId' => [
+ 'description' => 'The request ID.'."\n",
+ 'type' => 'string',
+ 'example' => '0000-ABCD-EF****',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"1031203110000\\",\\n \\"ErrorMessage\\": \\"Baseline deletion failed with nodes dependent on baseline\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Data\\": true,\\n \\"RequestId\\": \\"0000-ABCD-EF****\\"\\n}","errorExample":""},{"type":"xml","example":"<DeleteBaselineResponse>\\n <Success>true</Success>\\n <ErrorCode>1031203110000</ErrorCode>\\n <ErrorMessage>Baseline deletion failed with nodes dependent on baseline</ErrorMessage>\\n <HttpStatusCode>200</HttpStatusCode>\\n <Data>true</Data>\\n <RequestId>0000-ABCD-EF****</RequestId>\\n</DeleteBaselineResponse>","errorExample":""}]',
+ 'title' => 'DeleteBaseline',
+ 'summary' => 'Deletes a baseline based on its ID. You can delete a baseline only if the nodes in the baseline does not have ancestor nodes. You can call the UpdateBaseline operation to delete the relationships between the nodes and their ancestor nodes.',
+ ],
+ 'ListBaselines' => [
+ 'summary' => 'Obtains a list of baselines.',
+ 'methods' => [
+ 'post',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'list',
+ 'abilityTreeCode' => '158237',
+ 'abilityTreeNodes' => [
+ 'FEATUREdideSFSFU4',
+ ],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'Owner',
+ 'in' => 'formData',
+ 'schema' => [
+ 'title' => '责任人',
+ 'description' => 'The owner.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => '3726346****',
+ ],
+ ],
+ [
+ 'name' => 'ProjectId',
+ 'in' => 'formData',
+ 'schema' => [
+ 'title' => '项目空间id',
+ 'description' => 'The DataWorks workspace ID. You can log on to the [DataWorks console](https://workbench.data.aliyun.com/console) and go to the Workspace page to query the ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => true,
+ 'example' => '123456',
+ ],
+ ],
+ [
+ 'name' => 'Priority',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The priority of the baseline. Valid values: {1,3,5,7,8}.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => '1',
+ ],
+ ],
+ [
+ 'name' => 'Enable',
+ 'in' => 'formData',
+ 'schema' => [
+ 'title' => '是否开启基线',
+ 'description' => 'Specifies whether to enable the baseline. Valid values: true and false.'."\n",
+ 'type' => 'boolean',
+ 'required' => false,
+ 'example' => 'true',
+ ],
+ ],
+ [
+ 'name' => 'BaselineTypes',
+ 'in' => 'formData',
+ 'schema' => [
+ 'title' => '基线类型',
+ 'description' => 'The type of the baseline. Valid values: DAILY and HOURLY. You can specify multiple types. Separate multiple types with commas (,).'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'DAILY',
+ ],
+ ],
+ [
+ 'name' => 'SearchText',
+ 'in' => 'formData',
+ 'schema' => [
+ 'title' => '基线名模糊查询',
+ 'description' => 'The keyword in the baseline name, which is used to search for the baseline.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'baselineName',
+ ],
+ ],
+ [
+ 'name' => 'PageNumber',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The page number. Pages start from page 1. Default value: 1. Maximum value: 30.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => true,
+ 'example' => '1',
+ ],
+ ],
+ [
+ 'name' => 'PageSize',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The number of entries per page. Default value: 10. Maximum value: 100.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => true,
+ 'example' => '100',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => 'OpenApiResultModel<PopBaselineConfigDto>',
+ 'description' => 'The response parameters.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'Success' => [
+ 'description' => 'Indicates whether the request was successful. Valid values:'."\n"
+ ."\n"
+ .'* true'."\n"
+ .'* false'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code.'."\n",
+ 'type' => 'string',
+ 'example' => '103630001',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message returned if the request failed.'."\n",
+ 'type' => 'string',
+ 'example' => 'The user does not exist. 276571706358178756',
+ ],
+ 'HttpStatusCode' => [
+ 'description' => 'The HTTP status code.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '200',
+ ],
+ 'Data' => [
+ 'description' => 'The data returned.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'PageNumber' => [
+ 'description' => 'The page number.'."\n",
+ 'type' => 'string',
+ 'example' => '1',
+ ],
+ 'PageSize' => [
+ 'description' => 'The number of entries per page.'."\n",
+ 'type' => 'string',
+ 'example' => '10',
+ ],
+ 'TotalCount' => [
+ 'description' => 'The total number of baselines returned.'."\n",
+ 'type' => 'string',
+ 'example' => '100',
+ ],
+ 'Baselines' => [
+ 'description' => 'The baselines.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '',
+ 'type' => 'object',
+ 'properties' => [
+ 'BaselineId' => [
+ 'description' => 'The baseline ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '1234',
+ ],
+ 'ProjectId' => [
+ 'description' => 'The ID of the workspace to which the baseline belongs.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '9527',
+ ],
+ 'BaselineType' => [
+ 'description' => 'The type of the baseline. Valid values: DAILY and HOURLY.'."\n",
+ 'type' => 'string',
+ 'example' => 'DAILY',
+ ],
+ 'Priority' => [
+ 'description' => 'The priority of the baseline. Valid values: {1,2,5,7,8}.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '1',
+ ],
+ 'Owner' => [
+ 'description' => 'The ID of the Alibaba Cloud account used by the baseline owner. Multiple IDs can be specified. The IDs are separated by commas (,).'."\n",
+ 'type' => 'string',
+ 'example' => '952795****',
+ ],
+ 'BaselineName' => [
+ 'description' => 'The name of the baseline.'."\n",
+ 'type' => 'string',
+ 'example' => 'BaselineName',
+ ],
+ 'Enabled' => [
+ 'description' => 'Indicates whether the baseline is enabled. Valid values: true and false.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'AlertEnabled' => [
+ 'description' => 'Indicates whether the alerting feature is enabled. Valid values: true and false.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'AlertMarginThreshold' => [
+ 'description' => 'The alert margin threshold for the baseline instance. Unit: minutes.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '30',
+ ],
+ 'OverTimeSettings' => [
+ 'description' => 'The settings of the committed completion time of the baseline.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '',
+ 'type' => 'object',
+ 'properties' => [
+ 'Cycle' => [
+ 'description' => 'The cycle that corresponds to the committed completion time. For a day-level baseline, the value of this parameter is 1. For an hour-level baseline, the value of this parameter cannot exceed 24.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '1',
+ ],
+ 'Time' => [
+ 'description' => 'The committed completion time in the hh:mm format. Valid values of hh: \\[0,47]. Valid values of mm: \\[0,59].'."\n",
+ 'type' => 'string',
+ 'example' => '00:00',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'RequestId' => [
+ 'description' => 'The request ID.'."\n",
+ 'type' => 'string',
+ 'example' => '952795279527ab****',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"103630001\\",\\n \\"ErrorMessage\\": \\"The user does not exist. 276571706358178756\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Data\\": {\\n \\"PageNumber\\": \\"1\\",\\n \\"PageSize\\": \\"10\\",\\n \\"TotalCount\\": \\"100\\",\\n \\"Baselines\\": [\\n {\\n \\"BaselineId\\": 1234,\\n \\"ProjectId\\": 9527,\\n \\"BaselineType\\": \\"DAILY\\",\\n \\"Priority\\": 1,\\n \\"Owner\\": \\"952795****\\",\\n \\"BaselineName\\": \\"BaselineName\\",\\n \\"Enabled\\": true,\\n \\"AlertEnabled\\": true,\\n \\"AlertMarginThreshold\\": 30,\\n \\"OverTimeSettings\\": [\\n {\\n \\"Cycle\\": 1,\\n \\"Time\\": \\"00:00\\"\\n }\\n ]\\n }\\n ]\\n },\\n \\"RequestId\\": \\"952795279527ab****\\"\\n}","errorExample":""},{"type":"xml","example":"<ListBaselinesResponse>\\n <Success>true</Success>\\n <ErrorCode>103630001</ErrorCode>\\n <ErrorMessage>The user does not exist. 276571706358178756</ErrorMessage>\\n <HttpStatusCode>200</HttpStatusCode>\\n <Data>\\n <PageNumber>1</PageNumber>\\n <PageSize>10</PageSize>\\n <TotalCount>100</TotalCount>\\n <Baselines>\\n <BaselineId>1234</BaselineId>\\n <ProjectId>9527</ProjectId>\\n <BaselineType>DAILY</BaselineType>\\n <Priority>1</Priority>\\n <Owner>952795****</Owner>\\n <BaselineName>BaselineName</BaselineName>\\n <Enabled>true</Enabled>\\n <AlertEnabled>true</AlertEnabled>\\n <AlertMarginThreshold>30</AlertMarginThreshold>\\n <OverTimeSettings>\\n <Cycle>1</Cycle>\\n <Time>00:00</Time>\\n </OverTimeSettings>\\n </Baselines>\\n </Data>\\n <RequestId>952795279527ab****</RequestId>\\n</ListBaselinesResponse>","errorExample":""}]',
+ 'title' => 'ListBaselines',
+ ],
+ 'CreateBaseline' => [
+ 'summary' => 'Creates a baseline.',
+ 'methods' => [
+ 'post',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'readAndWrite',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'create',
+ 'abilityTreeCode' => '158238',
+ 'abilityTreeNodes' => [
+ 'FEATUREdideSFSFU4',
+ ],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'BaselineName',
+ 'in' => 'formData',
+ 'schema' => [
+ 'title' => '基线名',
+ 'description' => 'The name of the baseline.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => 'BaselineName',
+ ],
+ ],
+ [
+ 'name' => 'ProjectId',
+ 'in' => 'formData',
+ 'schema' => [
+ 'title' => '项目id',
+ 'description' => 'The DataWorks workspace ID. You can log on to the [DataWorks console](https://workbench.data.aliyun.com/console) and go to the Workspace page to query the ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => true,
+ 'example' => '10000',
+ ],
+ ],
+ [
+ 'name' => 'Owner',
+ 'in' => 'formData',
+ 'schema' => [
+ 'title' => '责任人',
+ 'description' => 'The ID of the Alibaba Cloud account used by the baseline owner.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => '1000000000001',
+ ],
+ ],
+ [
+ 'name' => 'Priority',
+ 'in' => 'formData',
+ 'schema' => [
+ 'title' => '基线优先级',
+ 'description' => 'The priority of the baseline. Valid values: {1,3,5,7,8}.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => true,
+ 'example' => '1,3,5,7,8',
+ ],
+ ],
+ [
+ 'name' => 'NodeIds',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The ancestor nodes of nodes in the baseline.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => '210001233239,210001236482',
+ ],
+ ],
+ [
+ 'name' => 'OvertimeSettings',
+ 'in' => 'formData',
+ 'style' => 'repeatList',
+ 'schema' => [
+ 'title' => '基线承诺时间',
+ 'description' => 'The settings of the committed completion time of the baseline.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The cycle.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'Cycle' => [
+ 'title' => '周期，取值范围 [1,24]',
+ 'description' => 'The cycle that corresponds to the committed completion time. For a day-level baseline, set this parameter to 1. For an hour-level baseline, set this parameter to a value that is no more than 24.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => false,
+ 'example' => '1',
+ ],
+ 'Time' => [
+ 'title' => '承诺时间，hh:mm格式，hh的取值范围为[0,47]，mm的取值范围为[0,59]',
+ 'description' => 'The committed completion time in the hh:mm format. Valid values of hh: \\[0,47]. Valid values of mm: \\[0,59].'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => '00:00',
+ ],
+ ],
+ 'required' => false,
+ ],
+ 'required' => true,
+ 'maxItems' => 144,
+ 'minItems' => 1,
+ ],
+ ],
+ [
+ 'name' => 'AlertMarginThreshold',
+ 'in' => 'formData',
+ 'schema' => [
+ 'title' => '基线预警余量',
+ 'description' => 'The alert margin threshold of the baseline. Unit: minutes.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => false,
+ 'example' => '30',
+ ],
+ ],
+ [
+ 'name' => 'BaselineType',
+ 'in' => 'formData',
+ 'schema' => [
+ 'title' => '基线类型 (DAILY, HOURLY)',
+ 'description' => 'The type of the baseline. Valid values: DAILY and HOURLY.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => 'DAILY',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => 'OpenApiResultModel<Long>',
+ 'description' => 'The response parameters.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'Success' => [
+ 'description' => 'Indicates whether the request was successful. Valid values:'."\n"
+ ."\n"
+ .'* true'."\n"
+ .'* false'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code.'."\n",
+ 'type' => 'string',
+ 'example' => '401',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message.'."\n",
+ 'type' => 'string',
+ 'example' => 'The specified parameters are invalid.',
+ ],
+ 'HttpStatusCode' => [
+ 'description' => 'The HTTP status code.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '200',
+ ],
+ 'Data' => [
+ 'description' => 'The baseline ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '100003',
+ ],
+ 'RequestId' => [
+ 'description' => 'The request ID.'."\n",
+ 'type' => 'string',
+ 'example' => 'F05080B0-CCE6-5D22-B284-34A51C5D4E28',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"401\\",\\n \\"ErrorMessage\\": \\"The specified parameters are invalid.\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Data\\": 100003,\\n \\"RequestId\\": \\"F05080B0-CCE6-5D22-B284-34A51C5D4E28\\"\\n}","errorExample":""},{"type":"xml","example":"<CreateBaselineResponse>\\n <Success>true</Success>\\n <ErrorCode>401</ErrorCode>\\n <ErrorMessage>The specified parameters are invalid.</ErrorMessage>\\n <HttpStatusCode>200</HttpStatusCode>\\n <Data>100003</Data>\\n <RequestId>F05080B0-CCE6-5D22-B284-34A51C5D4E28</RequestId>\\n</CreateBaselineResponse>","errorExample":""}]',
+ 'title' => 'CreateBaseline',
+ ],
+ 'UpdateBaseline' => [
+ 'summary' => 'Updates a baseline.',
+ 'methods' => [
+ 'post',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'readAndWrite',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'update',
+ 'abilityTreeCode' => '158726',
+ 'abilityTreeNodes' => [
+ 'FEATUREdideSFSFU4',
+ ],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'BaselineId',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The baseline ID. You can call the [ListBaselines](~~2261507~~) operation to query the ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => true,
+ 'example' => '1000010800007',
+ ],
+ ],
+ [
+ 'name' => 'ProjectId',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The workspace ID. You can call the [ListBaselines](~~2261507~~) operation to query the ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => true,
+ 'example' => '2043',
+ ],
+ ],
+ [
+ 'name' => 'BaselineName',
+ 'in' => 'formData',
+ 'schema' => [
+ 'title' => '基线名',
+ 'description' => 'The name of the baseline.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'BaselineName',
+ ],
+ ],
+ [
+ 'name' => 'Owner',
+ 'in' => 'formData',
+ 'schema' => [
+ 'title' => '责任人',
+ 'description' => 'The ID of the Alibaba Cloud account used by the baseline owner.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => '3726346****',
+ ],
+ ],
+ [
+ 'name' => 'Priority',
+ 'in' => 'formData',
+ 'schema' => [
+ 'title' => '基线优先级',
+ 'description' => 'The priority of the baseline. Valid values: {1,3,5,7,8}.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => false,
+ 'example' => '7',
+ ],
+ ],
+ [
+ 'name' => 'NodeIds',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The ancestor nodes of nodes in the baseline. Separate the ancestor nodes with commas (,). If a large number of ancestor nodes exist, we recommend that you create a zero load node and configure the zero load node as the descendant node of nodes in the baseline to facilitate node management.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => '1,2,3',
+ ],
+ ],
+ [
+ 'name' => 'OvertimeSettings',
+ 'in' => 'formData',
+ 'style' => 'json',
+ 'schema' => [
+ 'title' => '基线承诺时间',
+ 'description' => 'The settings of the committed completion time of the baseline.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The cycle.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'Cycle' => [
+ 'title' => '周期，取值范围 [1,24]',
+ 'description' => 'The cycle that corresponds to the committed completion time. For a day-level baseline, set this parameter to 1. For an hour-level baseline, set this parameter to a value that is no more than 24.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => false,
+ 'example' => '1',
+ ],
+ 'Time' => [
+ 'title' => '承诺时间，hh:mm格式，hh的取值范围为[0,47]，mm的取值范围为[0,59]',
+ 'description' => 'The committed completion time in the hh:mm format. Valid values of hh: \\[0,47]. Valid values of mm: \\[0,59].'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => '00:00',
+ ],
+ ],
+ 'required' => false,
+ ],
+ 'required' => false,
+ 'maxItems' => 144,
+ ],
+ ],
+ [
+ 'name' => 'AlertMarginThreshold',
+ 'in' => 'formData',
+ 'schema' => [
+ 'title' => '基线预警余量',
+ 'description' => 'The alert margin threshold of the baseline. Unit: minutes.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => false,
+ 'example' => '30',
+ ],
+ ],
+ [
+ 'name' => 'BaselineType',
+ 'in' => 'formData',
+ 'schema' => [
+ 'title' => '基线类型 (DAILY, HOURLY)',
+ 'description' => 'The type of the baseline. Valid values: DAILY and HOURLY.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'DAILY',
+ ],
+ ],
+ [
+ 'name' => 'Enabled',
+ 'in' => 'formData',
+ 'schema' => [
+ 'title' => '是否开启基线',
+ 'description' => 'Specifies whether to enable the baseline. Valid values: true and false.'."\n",
+ 'type' => 'boolean',
+ 'required' => false,
+ 'example' => 'true',
+ ],
+ ],
+ [
+ 'name' => 'AlertEnabled',
+ 'in' => 'formData',
+ 'schema' => [
+ 'title' => '是否开启告警',
+ 'description' => 'Specifies whether to enable the alerting feature. Valid values: true and false.'."\n",
+ 'type' => 'boolean',
+ 'required' => false,
+ 'example' => 'true',
+ ],
+ ],
+ [
+ 'name' => 'AlertSettings',
+ 'in' => 'formData',
+ 'style' => 'json',
+ 'schema' => [
+ 'title' => '告警配置',
+ 'description' => 'The alert settings of the baseline.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The alert setting of the baseline.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'AlertType' => [
+ 'title' => '告警类型，BASELINE / TOPIC',
+ 'description' => 'The type of the alert. Valid values: BASELINE and TOPIC. The value BASELINE indicates a baseline alert. The value TOPIC indicates an event alert.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'BASELINE',
+ ],
+ 'AlertMethods' => [
+ 'title' => '告警方式',
+ 'description' => 'The alert notification methods. Valid values: MAIL, SMS, PHONE, DINGROBOTS, and Webhooks. The value MAIL indicates that alert notifications are sent by email. The value SMS indicates that alert notifications are sent by text message. The value PHONE indicates that alert notifications are sent by phone call. You can use this notification method only in DataWorks Professional Edition or a more advanced edition. The value DINGROBOTS indicates that alert notifications are sent by using a DingTalk chatbot. You can use this notification method only if the RobotUrls parameter is configured. The value Webhooks indicates that alert notifications are sent by WeCom or Lark. You can use this notification method only if the Webhooks parameter is configured.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The alert notification method.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'SMS',
+ ],
+ 'required' => false,
+ ],
+ 'SilenceStartTime' => [
+ 'title' => '静默开始时间',
+ 'description' => 'The start time of silence.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => '00:00:00',
+ ],
+ 'SilenceEndTime' => [
+ 'title' => '静默结束时间',
+ 'description' => 'The end time of silence.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => '00:00:00',
+ ],
+ 'AlertInterval' => [
+ 'title' => '事件告警间隔',
+ 'description' => 'The interval at which an event alert notification is sent. Unit: minutes. Minimum value: 5. Maximum value: 1,440.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => false,
+ 'maximum' => '1440',
+ 'minimum' => '5',
+ 'example' => '1800',
+ ],
+ 'AlertMaximum' => [
+ 'title' => '事件告警最大次数',
+ 'description' => 'The maximum number of times an event alert notification is sent. Maximum value: 24.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => false,
+ 'maximum' => '288',
+ 'minimum' => '1',
+ 'example' => '1',
+ ],
+ 'DingRobots' => [
+ 'title' => '钉钉机器人列表',
+ 'description' => 'The DingTalk chatbots.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The configuration of the DingTalk chatbot.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'WebUrl' => [
+ 'description' => 'The webhook URL of the DingTalk chatbot.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'https://oapi.dingtalk.com/robot/send?access_token=xxx ',
+ ],
+ 'AtAll' => [
+ 'description' => 'Specifies whether to remind all members by using the at sign (@). Valid values: true and false.'."\n",
+ 'type' => 'boolean',
+ 'required' => false,
+ 'example' => 'false',
+ ],
+ ],
+ 'required' => false,
+ ],
+ 'required' => false,
+ 'maxItems' => 10,
+ ],
+ 'Webhooks' => [
+ 'title' => 'webhook 列表',
+ 'description' => 'The webhook URLs.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The webhook URL of the WeCom or Lark chatbot. You can specify multiple webhook URLs. Separate multiple webhook URLs with commas (,). You must specify WEBHOOKS for AlertMethods. If this parameter is set to undefined, the specified webhook URLs are cleared.'."\n"
+ ."\n"
+ .'Only DataWorks Enterprise Edition supports this parameter. The webhook URL-based alerting feature is supported in the following regions: China (Shanghai), China (Chengdu), China (Zhangjiakou), China (Beijing), China (Hangzhou), China (Shenzhen), China (Hong Kong), Germany (Frankfurt), and Singapore.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'https://open.feishu.cn/open-apis/bot/v2/hook/xxx ',
+ ],
+ 'required' => false,
+ 'maxItems' => 10,
+ ],
+ 'TopicTypes' => [
+ 'title' => '事件告警类型，事件特有配置',
+ 'description' => 'The types of event alerts, which are event-specific configurations.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The type of the event. Valid values: SLOW and ERROR. The value SLOW indicates that the running duration of a specific node in the current scheduling cycle is significantly longer than the average running duration of the node in previous scheduling cycles. The value ERROR indicates that a specific node fails to run. You can specify multiple event types. Separate multiple event types with commas (,).'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'SLOW',
+ ],
+ 'required' => false,
+ 'maxItems' => 10,
+ ],
+ 'BaselineAlertEnabled' => [
+ 'title' => '基线告警开关，基线特有配置',
+ 'description' => 'Specifies whether to enable the baseline alerting feature. This feature is specific to baselines. Valid values: true and false.'."\n",
+ 'type' => 'boolean',
+ 'required' => false,
+ 'example' => 'true',
+ ],
+ 'AlertRecipientType' => [
+ 'title' => '告警接收人类型',
+ 'description' => 'The type of the alert recipient. Valid values: OWNER, OTHER, and SHIFT_SCHEDULE. The value OWNER indicates the node owner. The value OTHER indicates specified personnel. The value SHIFT_SCHEDULE indicates personnel in a shift schedule.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'OWNER',
+ ],
+ 'AlertRecipient' => [
+ 'title' => '告警接收人详情',
+ 'description' => 'The details of the alert recipient. If you set AlertRecipientType to OWNER, leave this parameter empty. If you set AlertRecipientType to SHIFT_SCHEDULE, set this parameter to the name of the shift schedule. If you set AlertRecipientType to OTHER, set this parameter to the employee IDs of specified personnel.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => '123123',
+ ],
+ ],
+ 'required' => false,
+ ],
+ 'required' => false,
+ ],
+ ],
+ [
+ 'name' => 'RemoveNodeIds',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The ID of the node that you want to disassociate from the baseline. You can specify multiple node IDs. Separate multiple node IDs with commas (,).'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => '123,456',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => 'OpenApiResultModel<Boolean>',
+ 'description' => 'The response parameters.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'Success' => [
+ 'description' => 'Indicates whether the request was successful.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code.'."\n",
+ 'type' => 'string',
+ 'example' => '401',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message.'."\n",
+ 'type' => 'string',
+ 'example' => 'The specified parameters are invalid.',
+ ],
+ 'HttpStatusCode' => [
+ 'description' => 'The HTTP status code.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '200',
+ ],
+ 'Data' => [
+ 'description' => 'Indicates whether the baseline was updated.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'RequestId' => [
+ 'description' => 'The request ID.'."\n",
+ 'type' => 'string',
+ 'example' => '6E07E90B-D9BC-5D6B-896A-82BA41A34AE1',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"401\\",\\n \\"ErrorMessage\\": \\"The specified parameters are invalid.\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Data\\": true,\\n \\"RequestId\\": \\"6E07E90B-D9BC-5D6B-896A-82BA41A34AE1\\"\\n}","errorExample":""},{"type":"xml","example":"<UpdateBaselineResponse>\\n <Success>true</Success>\\n <ErrorCode>401</ErrorCode>\\n <ErrorMessage>The specified parameters are invalid.</ErrorMessage>\\n <HttpStatusCode>200</HttpStatusCode>\\n <Data>true</Data>\\n <RequestId>6E07E90B-D9BC-5D6B-896A-82BA41A34AE1</RequestId>\\n</UpdateBaselineResponse>","errorExample":""}]',
+ 'title' => 'UpdateBaseline',
+ ],
+ 'UpdateQualityFollower' => [
+ 'methods' => [
+ 'post',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'write',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'update',
+ 'abilityTreeCode' => '78379',
+ 'abilityTreeNodes' => [
+ 'FEATUREdideGJ7UNJ',
+ ],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'ProjectName',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The name of the compute engine or data source.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'autotest',
+ ],
+ ],
+ [
+ 'name' => 'FollowerId',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The ID of the subscription relationship.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => '1234',
+ ],
+ ],
+ [
+ 'name' => 'Follower',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The name of the subscriber.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => '1912232****',
+ ],
+ ],
+ [
+ 'name' => 'AlarmMode',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The notification method. Valid values: 1, 2, 4, 5, 6, 7, 8, and 9. The value 1 indicates that the notification is sent by email. The value 2 indicates that the notification is sent by email and text message. The value 4 indicates that the notification is sent by a DingTalk chatbot. The value 5 indicates that the notification is sent by a DingTalk chatbot to all members in a DingTalk group. The value 6 indicates that the notification is sent by Lark. The value 7 indicates that the notification is sent by WeCom. The value 8 indicates that the notification is sent by webhook. The value 9 indicates that the notification is sent by phone call.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => true,
+ 'docRequired' => true,
+ 'maximum' => '99',
+ 'minimum' => '0',
+ 'example' => '2',
+ 'enum' => [
+ '1',
+ '2',
+ '4',
+ '5',
+ '6',
+ '7',
+ '8',
+ '9',
+ ],
+ ],
+ ],
+ [
+ 'name' => 'ProjectId',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The DataWorks workspace ID. You can log on to the DataWorks console to obtain the workspace ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'docRequired' => true,
+ 'example' => '123',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'description' => 'The returned result.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'HttpStatusCode' => [
+ 'description' => 'The HTTP status code.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '200',
+ ],
+ 'Data' => [
+ 'description' => 'Indicates whether the update is successful.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message.'."\n",
+ 'type' => 'string',
+ 'example' => 'You have no permission',
+ ],
+ 'RequestId' => [
+ 'description' => 'The request ID.'."\n",
+ 'type' => 'string',
+ 'example' => '576b9457-2cf5-4****',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code.'."\n",
+ 'type' => 'string',
+ 'example' => '401',
+ ],
+ 'Success' => [
+ 'description' => 'Indicates whether the request was successful.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Data\\": true,\\n \\"ErrorMessage\\": \\"You have no permission\\",\\n \\"RequestId\\": \\"576b9457-2cf5-4****\\",\\n \\"ErrorCode\\": \\"401\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<UpdateQualityFollowerResponse>\\n <HttpStatusCode>200</HttpStatusCode>\\n <Data>true</Data>\\n <ErrorMessage>You have no permission</ErrorMessage>\\n <RequestId>576b9457-2cf5-4****</RequestId>\\n <ErrorCode>401</ErrorCode>\\n <Success>true</Success>\\n</UpdateQualityFollowerResponse>","errorExample":""}]',
+ 'title' => 'UpdateQualityFollower',
+ 'summary' => 'Updates a subscription relationship.',
+ 'requestParamsDescription' => ' ',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ ],
+ 'UpdateQualityRule' => [
+ 'methods' => [
+ 'post',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'write',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'update',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeCode' => '78380',
+ 'abilityTreeNodes' => [
+ 'FEATUREdide3WJOKE',
+ ],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'BlockType',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The strength of the monitoring rule. The strength of a monitoring rule indicates the importance of the rule. Valid values:'."\n"
+ ."\n"
+ .'* 1: indicates that the monitoring rule is a strong rule.'."\n"
+ .'* 0: indicates that the monitoring rule is a weak rule. You can specify whether a monitoring rule is a strong rule based on your business requirements. If a monitoring rule is a strong rule and the critical threshold is exceeded, a critical alert is reported and nodes that are associated with the rule are blocked from running.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => false,
+ 'maximum' => '1',
+ 'minimum' => '0',
+ 'enumValueTitles' => [],
+ 'example' => '0',
+ 'enum' => [
+ '0',
+ '1',
+ ],
+ ],
+ ],
+ [
+ 'name' => 'EntityId',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The ID of the partition filter expression. You can call the [ListQualityRules](~~173995~~) operation to obtain the ID of the partition filter expression.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'example' => '123',
+ ],
+ ],
+ [
+ 'name' => 'Comment',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The description of the monitoring rule.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'Verify the number of table rows',
+ 'maxLength' => 512,
+ ],
+ ],
+ [
+ 'name' => 'Checker',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The checker ID. Valid values: 2: indicates that the current value is compared with the average value of the previous 7 days. 3: indicates that the current value is compared with the average value of the previous 30 days. 4: indicates that the current value is compared with the value 1 day earlier. 5: indicates that the current value is compared with the value 7 days earlier. 6: indicates that the current value is compared with the value 30 days earlier. 7: indicates the variance between the current value and the value 7 days earlier. 8: indicates the variance between the current value and the value 30 days earlier. 9: indicates that the current value is compared with a fixed value. 10: indicates that the current value is compared with the value 1, 7, or 30 days earlier. 11: indicates that the current value is compared with the value of the previous cycle. You can call the [ListQualityRules](~~173995~~) operation to query the ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => false,
+ 'docRequired' => false,
+ 'example' => '9',
+ ],
+ ],
+ [
+ 'name' => 'ExpectValue',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The expected value of the monitoring rule.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => '300',
+ 'maxLength' => 128,
+ ],
+ ],
+ [
+ 'name' => 'Id',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The monitoring rule ID. You can call the [ListQualityRules](~~173995~~) operation to query the ID of the monitoring rule.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => '1234',
+ ],
+ ],
+ [
+ 'name' => 'Trend',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The trend of the monitoring result. Valid values:'."\n"
+ ."\n"
+ .'* up: increasing'."\n"
+ .'* down: decreasing'."\n"
+ .'* abs: absolute value'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'up',
+ ],
+ ],
+ [
+ 'name' => 'MethodName',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The method that is used to collect sample data, such as avg, count, sum, min, max, count_distinct, user_defined, table_count, table_size, table_dt_load_count, table_dt_refuseload_count, null_value, null_value/table_count, (table_count-count_distinct)/table_count, or table_count-count_distinct.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'table_count',
+ ],
+ ],
+ [
+ 'name' => 'Operator',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The comparison operator, such as >, >=, =, ≠, <, or <=.'."\n"
+ ."\n"
+ .'> If you set the Checker parameter to 9, you must configure the Operator parameter.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => '>',
+ 'maxLength' => 128,
+ ],
+ ],
+ [
+ 'name' => 'ProjectName',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The name of the compute engine or data source. You can log on to the [DataWorks console](https://workbench.data.aliyun.com/console) and go to the Workspace page to obtain the name of the compute engine or data source.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'autotest',
+ ],
+ ],
+ [
+ 'name' => 'Property',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The name of the field.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'id',
+ 'maxLength' => 128,
+ 'minLength' => 1,
+ ],
+ ],
+ [
+ 'name' => 'PropertyType',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The data type of the field.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'bigint',
+ 'maxLength' => 128,
+ ],
+ ],
+ [
+ 'name' => 'RuleType',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'Rule type:'."\n"
+ ."\n"
+ .'* 0: System template rule'."\n"
+ .'* 1: Custom SQL rule'."\n"
+ .'* 4: Custom template rule'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => false,
+ 'maximum' => '99',
+ 'minimum' => '0',
+ 'example' => '0',
+ ],
+ ],
+ [
+ 'name' => 'WhereCondition',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The filter condition or custom SQL statement that is used for monitoring.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'dt=$[yyyymmdd]',
+ ],
+ ],
+ [
+ 'name' => 'CriticalThreshold',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The threshold for a critical alert. The threshold indicates the deviation of the monitoring result from the expected value. You can specify a custom value for the threshold based on your business requirements. If a monitoring rule is a strong rule and the critical threshold is exceeded, a critical alert is reported and tasks that are associated with the rule are blocked from running.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => '10',
+ ],
+ ],
+ [
+ 'name' => 'WarningThreshold',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The threshold for a warning alert. The threshold specifies the deviation of the monitoring result from the expected value. You can specify a custom value for the threshold based on your business requirements.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => '5',
+ ],
+ ],
+ [
+ 'name' => 'TemplateId',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The ID of the monitoring template. You can call the [ListQualityRules](~~173995~~) operation to obtain the ID of the monitoring template.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => false,
+ 'example' => '7',
+ ],
+ ],
+ [
+ 'name' => 'RuleName',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The name of the monitoring rule.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => '123',
+ 'maxLength' => 255,
+ 'minLength' => 1,
+ ],
+ ],
+ [
+ 'name' => 'PredictType',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'Specifies whether the threshold is a dynamic threshold. Valid values:'."\n"
+ ."\n"
+ .'* 0: The threshold is not a dynamic threshold.'."\n"
+ .'* 2: The threshold is a dynamic threshold.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => false,
+ 'maximum' => '99',
+ 'minimum' => '0',
+ 'example' => '0',
+ ],
+ ],
+ [
+ 'name' => 'OpenSwitch',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'Specifies whether to enable the monitoring rule in the production environment. Valid values:'."\n"
+ ."\n"
+ .'* true: The monitoring rule is triggered when the associated auto triggered node that generates the output data starts to run.'."\n"
+ .'* false: The monitoring rule is not triggered when the associated auto triggered node that generates the output data starts to run.'."\n",
+ 'type' => 'boolean',
+ 'required' => false,
+ 'example' => 'true',
+ 'default' => 'true',
+ ],
+ ],
+ [
+ 'name' => 'ProjectId',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The DataWorks workspace ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => '26',
+ ],
+ ],
+ [
+ 'name' => 'TaskSetting',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The variable settings inserted before the custom rule. Format: x=a,y=b.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'x=a,y=b',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'description' => 'The returned result.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'HttpStatusCode' => [
+ 'description' => 'The HTTP status code.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '200',
+ ],
+ 'Data' => [
+ 'description' => 'Indicates whether the monitoring rule is updated.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message.'."\n",
+ 'type' => 'string',
+ 'example' => 'You have no permission.',
+ ],
+ 'RequestId' => [
+ 'description' => 'The request ID. You can troubleshoot issues based on the ID.'."\n",
+ 'type' => 'string',
+ 'example' => '576b9457-2cf5-4****',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code.'."\n",
+ 'type' => 'string',
+ 'example' => '0',
+ ],
+ 'Success' => [
+ 'description' => 'Indicates whether the request was successful.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'staticInfo' => [
+ 'returnType' => 'synchronous',
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Data\\": true,\\n \\"ErrorMessage\\": \\"You have no permission.\\",\\n \\"RequestId\\": \\"576b9457-2cf5-4****\\",\\n \\"ErrorCode\\": \\"0\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<UpdateQualityRuleResponse>\\n <HttpStatusCode>200</HttpStatusCode>\\n <Data>true</Data>\\n <ErrorMessage>You have no permission.</ErrorMessage>\\n <RequestId>576b9457-2cf5-4****</RequestId>\\n <ErrorCode>0</ErrorCode>\\n <Success>true</Success>\\n</UpdateQualityRuleResponse>","errorExample":""}]',
+ 'title' => 'UpdateQualityRule',
+ 'summary' => 'Updates a monitoring rule.',
+ 'requestParamsDescription' => ' ',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ ],
+ 'GetQualityRule' => [
+ 'methods' => [
+ 'post',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'get',
+ 'abilityTreeCode' => '78285',
+ 'abilityTreeNodes' => [
+ 'FEATUREdide3WJOKE',
+ ],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'RuleId',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The monitoring rule ID. You can call the [ListQualityRules](~~173995~~) operation to query the ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => true,
+ 'docRequired' => true,
+ 'maximum' => '2147483647',
+ 'minimum' => '1',
+ 'example' => '1234',
+ ],
+ ],
+ [
+ 'name' => 'ProjectName',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The name of the compute engine or data source.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'autotest',
+ ],
+ ],
+ [
+ 'name' => 'ProjectId',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The DataWorks workspace ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'docRequired' => true,
+ 'example' => '12345',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'description' => 'The returned result.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'HttpStatusCode' => [
+ 'description' => 'The HTTP status code.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '200',
+ ],
+ 'RequestId' => [
+ 'description' => 'The request ID.'."\n",
+ 'type' => 'string',
+ 'example' => '576b9457-2cf5-4****',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message.'."\n",
+ 'type' => 'string',
+ 'example' => 'You have no permission.',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code.'."\n",
+ 'type' => 'string',
+ 'example' => '401',
+ ],
+ 'Success' => [
+ 'description' => 'Indicates whether the request was successful.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'Data' => [
+ 'description' => 'Information about the retrieved rule.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'BlockType' => [
+ 'description' => 'The strength of the monitoring rule. The strength of a monitoring rule indicates the importance of the rule. Valid values:'."\n"
+ ."\n"
+ .'* 1: the monitoring rule is a strong rule.'."\n"
+ .'* 0: the monitoring rule is a weak rule. You can specify whether a monitoring rule is a strong rule based on your business requirements. If a monitoring rule is a strong rule and the critical threshold is exceeded, a critical alert is reported and tasks that are associated with the rule are blocked from running.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '1',
+ ],
+ 'OnDutyAccountName' => [
+ 'description' => 'The name of the Alibaba Cloud account that is used to configure the monitoring rule.'."\n",
+ 'type' => 'string',
+ 'example' => 'test',
+ ],
+ 'WarningThreshold' => [
+ 'description' => 'The threshold for a warning alert. The threshold indicates the deviation of the check result from the expected value. You can customize this threshold based on your business requirements.'."\n",
+ 'type' => 'string',
+ 'example' => '10',
+ ],
+ 'Property' => [
+ 'description' => 'The field whose data quality is checked based on the monitoring rule. This field is a column in the data source table that is monitored.'."\n",
+ 'type' => 'string',
+ 'example' => 'id',
+ ],
+ 'RuleType' => [
+ 'description' => 'Rule type:'."\n"
+ ."\n"
+ .'* 0: System template rule'."\n"
+ .'* 1: Custom SQL rule'."\n"
+ .'* 4: Custom template rule'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '0',
+ ],
+ 'Comment' => [
+ 'description' => 'The description of the monitoring rule.'."\n",
+ 'type' => 'string',
+ 'example' => 'Verify that the primary key is unique',
+ ],
+ 'OnDuty' => [
+ 'description' => 'The ID of the Alibaba Cloud account that is used to configure the monitoring rule.'."\n",
+ 'type' => 'string',
+ 'example' => '1822931****',
+ ],
+ 'Checker' => [
+ 'description' => 'The checker ID. The value of this parameter corresponds to the ID at the frontend and is converted from the ID of the primary key.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '9',
+ ],
+ 'FixCheck' => [
+ 'description' => 'Indicates whether the monitoring is performed based on a fixed value.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'MethodId' => [
+ 'description' => 'The ID of the task that is associated with the partition filter expression.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '8',
+ ],
+ 'CriticalThreshold' => [
+ 'description' => 'The threshold for a critical alert. The threshold indicates the deviation of the check result from the expected value. You can specify a value for the threshold based on your business requirements. If a monitoring rule is a strong rule and the critical threshold is exceeded, a critical alert is reported and tasks that are associated with the rule are blocked from running.'."\n",
+ 'type' => 'string',
+ 'example' => '20',
+ ],
+ 'PredictType' => [
+ 'description' => 'Indicates whether the threshold is a dynamic threshold. Valid values:'."\n"
+ ."\n"
+ .'* 0: The threshold is not a dynamic threshold.'."\n"
+ .'* 1: The threshold is a dynamic threshold.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '0',
+ ],
+ 'TemplateName' => [
+ 'description' => 'The name of the monitoring template.'."\n",
+ 'type' => 'string',
+ 'example' => 'SQL task table rows, 1,7, 30 days fluctuation test',
+ ],
+ 'CheckerName' => [
+ 'description' => 'The name of the checker.'."\n",
+ 'type' => 'string',
+ 'example' => 'compared with a fixed value',
+ ],
+ 'RuleName' => [
+ 'description' => 'The name of the monitoring rule.'."\n",
+ 'type' => 'string',
+ 'example' => 'View table fluctuations',
+ ],
+ 'MethodName' => [
+ 'description' => 'The method that is used to collect sample data, such as avg, count, sum, min, max, count_distinct, user_defined, table_count, table_size, table_dt_load_count, table_dt_refuseload_count, null_value, null_value/table_count, (table_count-count_distinct)/table_count, or table_count-count_distinct.'."\n",
+ 'type' => 'string',
+ 'example' => 'table_count',
+ ],
+ 'EntityId' => [
+ 'description' => 'The ID of the partition filter expression.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '165523',
+ ],
+ 'WhereCondition' => [
+ 'description' => 'The filter condition or custom SQL statement that is used for monitoring.'."\n",
+ 'type' => 'string',
+ 'example' => 'id>10',
+ ],
+ 'Operator' => [
+ 'description' => 'The comparison operator of the monitoring rule.'."\n",
+ 'type' => 'string',
+ 'example' => '>=',
+ ],
+ 'ExpectValue' => [
+ 'description' => 'The expected value.'."\n",
+ 'type' => 'string',
+ 'example' => '30',
+ ],
+ 'Trend' => [
+ 'description' => 'The trend of the check result.'."\n",
+ 'type' => 'string',
+ 'example' => 'abs',
+ ],
+ 'TemplateId' => [
+ 'description' => 'The ID of the monitoring template.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '7',
+ ],
+ 'Id' => [
+ 'description' => 'The monitoring rule ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '123232',
+ ],
+ 'OpenSwitch' => [
+ 'description' => 'Indicates whether the monitoring rule is enabled.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'TaskSetting' => [
+ 'description' => 'The variable settings inserted before the custom rule. Format: x=a,y=b.'."\n",
+ 'type' => 'string',
+ 'example' => 'x=a,y=b'."\n",
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"576b9457-2cf5-4****\\",\\n \\"ErrorMessage\\": \\"You have no permission.\\",\\n \\"ErrorCode\\": \\"401\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"BlockType\\": 1,\\n \\"OnDutyAccountName\\": \\"test\\",\\n \\"WarningThreshold\\": \\"10\\",\\n \\"Property\\": \\"id\\",\\n \\"RuleType\\": 0,\\n \\"Comment\\": \\"Verify that the primary key is unique\\",\\n \\"OnDuty\\": \\"1822931****\\",\\n \\"Checker\\": 9,\\n \\"FixCheck\\": true,\\n \\"MethodId\\": 8,\\n \\"CriticalThreshold\\": \\"20\\",\\n \\"PredictType\\": 0,\\n \\"TemplateName\\": \\"SQL task table rows, 1,7, 30 days fluctuation test\\",\\n \\"CheckerName\\": \\"compared with a fixed value\\",\\n \\"RuleName\\": \\"View table fluctuations\\",\\n \\"MethodName\\": \\"table_count\\",\\n \\"EntityId\\": 165523,\\n \\"WhereCondition\\": \\"id>10\\",\\n \\"Operator\\": \\">=\\",\\n \\"ExpectValue\\": \\"30\\",\\n \\"Trend\\": \\"abs\\",\\n \\"TemplateId\\": 7,\\n \\"Id\\": 123232,\\n \\"OpenSwitch\\": true,\\n \\"TaskSetting\\": \\"x=a,y=b\\\\n\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"<GetQualityRuleResponse>\\n <HttpStatusCode>200</HttpStatusCode>\\n <RequestId>576b9457-2cf5-4****</RequestId>\\n <ErrorMessage>You have no permission.</ErrorMessage>\\n <ErrorCode>401</ErrorCode>\\n <Success>true</Success>\\n <Data>\\n <BlockType>1</BlockType>\\n <OnDutyAccountName>test</OnDutyAccountName>\\n <WarningThreshold>10</WarningThreshold>\\n <Property>id</Property>\\n <RuleType>0</RuleType>\\n <Comment>校验主键唯一</Comment>\\n <OnDuty>1822931****</OnDuty>\\n <Checker>9</Checker>\\n <FixCheck>true</FixCheck>\\n <MethodId>8</MethodId>\\n <CriticalThreshold>20</CriticalThreshold>\\n <PredictType>0</PredictType>\\n <TemplateName>SQL task table rows, 1,7, 30 days fluctuation test</TemplateName>\\n <CheckerName>compared with a fixed value</CheckerName>\\n <RuleName>查看表波动</RuleName>\\n <MethodName>table_count</MethodName>\\n <EntityId>165523</EntityId>\\n <WhereCondition>id&gt;10</WhereCondition>\\n <Operator>&gt;=</Operator>\\n <ExpectValue>30</ExpectValue>\\n <Trend>abs</Trend>\\n <TemplateId>7</TemplateId>\\n <Id>123232</Id>\\n <OpenSwitch>true</OpenSwitch>\\n </Data>\\n</GetQualityRuleResponse>","errorExample":""}]',
+ 'title' => 'GetQualityRule',
+ 'summary' => 'Queries the information about a monitoring rule.',
+ 'requestParamsDescription' => ' ',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ ],
+ 'ListQualityRules' => [
+ 'methods' => [
+ 'post',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'get',
+ 'abilityTreeCode' => '78331',
+ 'abilityTreeNodes' => [
+ 'FEATUREdide3WJOKE',
+ ],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'ProjectName',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The name of the compute engine or data source. You can obtain the name from data source configurations.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'autotest',
+ ],
+ ],
+ [
+ 'name' => 'EntityId',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The ID of the partition filter expression. You can call the [GetQualityEntity](~~174003~~) operation to query the ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => '1234',
+ ],
+ ],
+ [
+ 'name' => 'PageNumber',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The page number.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => true,
+ 'docRequired' => true,
+ 'minimum' => '1',
+ 'example' => '1',
+ ],
+ ],
+ [
+ 'name' => 'PageSize',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The number of entries per page. Default value: 10. Maximum value: 20.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => true,
+ 'docRequired' => true,
+ 'maximum' => '20',
+ 'minimum' => '1',
+ 'example' => '20',
+ ],
+ ],
+ [
+ 'name' => 'ProjectId',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The DataWorks workspace ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => '12345',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'description' => 'The returned result.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'HttpStatusCode' => [
+ 'description' => 'The HTTP status code.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '200',
+ ],
+ 'RequestId' => [
+ 'description' => 'The request ID. You can troubleshoot errors based on the ID.'."\n",
+ 'type' => 'string',
+ 'example' => '38cbdef0-f6cf-49****',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message.'."\n",
+ 'type' => 'string',
+ 'example' => 'You have no permission.',
+ ],
+ 'Success' => [
+ 'description' => 'Indicates whether the request was successful. Valid values:'."\n"
+ ."\n"
+ .'* true'."\n"
+ .'* false'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code.'."\n",
+ 'type' => 'string',
+ 'example' => 'Invalid.Tenant.ConnectionNotExists',
+ ],
+ 'Data' => [
+ 'description' => 'The list of retrieved rules.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'PageNumber' => [
+ 'description' => 'The page number.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '1',
+ ],
+ 'PageSize' => [
+ 'description' => 'The number of entries per page. Default value: 10. Maximum value: 100.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '20',
+ ],
+ 'TotalCount' => [
+ 'description' => 'The total number of entries returned.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '400',
+ ],
+ 'Rules' => [
+ 'description' => 'The details of the validation rule.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The returned result.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'BlockType' => [
+ 'description' => 'The strength of the monitoring rule. The strength of a monitoring rule indicates the importance of the rule. Valid values:'."\n"
+ ."\n"
+ .'* 1: The monitoring rule is a strong rule.'."\n"
+ .'* 0: The monitoring rule is a weak rule. You can specify the strength of a monitoring rule based on your business requirements. If a monitoring rule is a strong rule and the critical threshold is exceeded, a critical alert is reported and tasks that are associated with the rule are blocked from running.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '0',
+ ],
+ 'OnDutyAccountName' => [
+ 'description' => 'The name of the Alibaba Cloud account that is used to configure the monitoring rule.'."\n",
+ 'type' => 'string',
+ 'example' => 'test',
+ ],
+ 'Property' => [
+ 'description' => 'The name of the field.'."\n",
+ 'type' => 'string',
+ 'example' => 'id',
+ ],
+ 'WarningThreshold' => [
+ 'description' => 'The threshold for a warning alert. The threshold specifies the deviation of the monitoring result from the expected value. You can specify a custom value for the threshold based on your business requirements.'."\n",
+ 'type' => 'string',
+ 'example' => '10',
+ ],
+ 'TableName' => [
+ 'description' => 'The name of the table.'."\n",
+ 'type' => 'string',
+ 'example' => 'dual',
+ ],
+ 'OnDuty' => [
+ 'description' => 'The name of the Alibaba Cloud account that is used to configure the monitoring rule.'."\n",
+ 'type' => 'string',
+ 'example' => '1912****',
+ ],
+ 'Comment' => [
+ 'description' => 'The description of the monitoring rule.'."\n",
+ 'type' => 'string',
+ 'example' => 'Verify table rules',
+ ],
+ 'RuleCheckerRelationId' => [
+ 'description' => 'The ID of the task that is associated with the partition filter expression.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '132323',
+ ],
+ 'FixCheck' => [
+ 'description' => 'Indicates whether the monitoring is performed based on a fixed value.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'MethodId' => [
+ 'description' => 'The ID of the task that is associated with the partition filter expression.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '21',
+ ],
+ 'TemplateName' => [
+ 'description' => 'The name of the monitoring template.'."\n",
+ 'type' => 'string',
+ 'example' => 'Number of SQL task table rows, 1, 7, and 30 days wave detection',
+ ],
+ 'Trend' => [
+ 'description' => 'The trend of the monitoring result.'."\n",
+ 'type' => 'string',
+ 'example' => 'abs',
+ ],
+ 'HistoryWarningThreshold' => [
+ 'description' => 'The historical threshold for a warning alert.'."\n",
+ 'type' => 'string',
+ 'example' => 'history max:40%,history min:10%',
+ ],
+ 'RuleType' => [
+ 'description' => 'Rule type:'."\n"
+ ."\n"
+ .'* 0: System template rule'."\n"
+ .'* 1: Custom SQL rule'."\n"
+ .'* 1: Custom template rule'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '0',
+ ],
+ 'MatchExpression' => [
+ 'description' => 'The partition filter expression.'."\n",
+ 'type' => 'string',
+ 'example' => 'dt=$[yyyymmdd]',
+ ],
+ 'ProjectName' => [
+ 'description' => 'The name of the compute engine or data source.'."\n",
+ 'type' => 'string',
+ 'example' => 'autotest',
+ ],
+ 'PropertyKey' => [
+ 'description' => 'The field that is used to associate with monitoring rules at the frontend. This parameter can be ignored.'."\n",
+ 'type' => 'string',
+ 'example' => 'table_count',
+ ],
+ 'CriticalThreshold' => [
+ 'description' => 'The threshold for a critical alert. The threshold indicates the deviation of the monitoring result from the expected value. You can specify a custom value for the threshold based on your business requirements. If a monitoring rule is a strong rule and the critical threshold is exceeded, a critical alert is reported and tasks that are associated with the rule are blocked from running.'."\n",
+ 'type' => 'string',
+ 'example' => '40',
+ ],
+ 'HistoryCriticalThreshold' => [
+ 'description' => 'The historical threshold for a critical alert.'."\n",
+ 'type' => 'string',
+ 'example' => 'history max:80%,history min:50%',
+ ],
+ 'MethodName' => [
+ 'description' => 'The method that is used to collect sample data, such as avg, count, sum, min, max, count_distinct, user_defined, table_count, table_size, table_dt_load_count, table_dt_refuseload_count, null_value, null_value/table_count, (table_count-count_distinct)/table_count, or table_count-count_distinct.'."\n",
+ 'type' => 'string',
+ 'example' => 'count/table_count',
+ ],
+ 'CheckerId' => [
+ 'description' => 'The checker ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '7',
+ ],
+ 'EntityId' => [
+ 'description' => 'The ID of the partition filter expression.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '1234',
+ ],
+ 'ExpectValue' => [
+ 'description' => 'The expected value.'."\n",
+ 'type' => 'string',
+ 'example' => '1000',
+ ],
+ 'TemplateId' => [
+ 'description' => 'The ID of the monitoring template.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '7',
+ ],
+ 'Id' => [
+ 'description' => 'The monitoring rule ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '1234',
+ ],
+ 'RuleName' => [
+ 'title' => '规则名称',
+ 'description' => 'The name of the monitoring rule.'."\n",
+ 'type' => 'string',
+ 'example' => 'test',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"38cbdef0-f6cf-49****\\",\\n \\"ErrorMessage\\": \\"You have no permission.\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"Invalid.Tenant.ConnectionNotExists\\",\\n \\"Data\\": {\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 20,\\n \\"TotalCount\\": 400,\\n \\"Rules\\": [\\n {\\n \\"BlockType\\": 0,\\n \\"OnDutyAccountName\\": \\"test\\",\\n \\"Property\\": \\"id\\",\\n \\"WarningThreshold\\": \\"10\\",\\n \\"TableName\\": \\"dual\\",\\n \\"OnDuty\\": \\"1912****\\",\\n \\"Comment\\": \\"Verify table rules\\",\\n \\"RuleCheckerRelationId\\": 132323,\\n \\"FixCheck\\": true,\\n \\"MethodId\\": 21,\\n \\"TemplateName\\": \\"Number of SQL task table rows, 1, 7, and 30 days wave detection\\",\\n \\"Trend\\": \\"abs\\",\\n \\"HistoryWarningThreshold\\": \\"history max:40%,history min:10%\\",\\n \\"RuleType\\": 0,\\n \\"MatchExpression\\": \\"dt=$[yyyymmdd]\\",\\n \\"ProjectName\\": \\"autotest\\",\\n \\"PropertyKey\\": \\"table_count\\",\\n \\"CriticalThreshold\\": \\"40\\",\\n \\"HistoryCriticalThreshold\\": \\"history max:80%,history min:50%\\",\\n \\"MethodName\\": \\"count/table_count\\",\\n \\"CheckerId\\": 7,\\n \\"EntityId\\": 1234,\\n \\"ExpectValue\\": \\"1000\\",\\n \\"TemplateId\\": 7,\\n \\"Id\\": 1234,\\n \\"RuleName\\": \\"test\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<ListQualityRulesResponse>\\n <HttpStatusCode>200</HttpStatusCode>\\n <RequestId>38cbdef0-f6cf-49****</RequestId>\\n <ErrorMessage>You have no permission.</ErrorMessage>\\n <Success>true</Success>\\n <ErrorCode>Invalid.Tenant.ConnectionNotExists</ErrorCode>\\n <Data>\\n <PageNumber>1</PageNumber>\\n <PageSize>20</PageSize>\\n <TotalCount>400</TotalCount>\\n <Rules>\\n <BlockType>0</BlockType>\\n <OnDutyAccountName>test</OnDutyAccountName>\\n <Property>id</Property>\\n <WarningThreshold>10</WarningThreshold>\\n <TableName>dual</TableName>\\n <OnDuty>1912****</OnDuty>\\n <Comment>校验表规则</Comment>\\n <RuleCheckerRelationId>132323</RuleCheckerRelationId>\\n <FixCheck>true</FixCheck>\\n <MethodId>21</MethodId>\\n <TemplateName>sql任务表行数，1、7、30天波动检测</TemplateName>\\n <Trend>abs</Trend>\\n <HistoryWarningThreshold>history max:40%,history min:10%</HistoryWarningThreshold>\\n <RuleType>0</RuleType>\\n <MatchExpression>dt=$[yyyymmdd]</MatchExpression>\\n <ProjectName>autotest</ProjectName>\\n <PropertyKey>table_count</PropertyKey>\\n <CriticalThreshold>40</CriticalThreshold>\\n <HistoryCriticalThreshold>history max:80%,history min:50%</HistoryCriticalThreshold>\\n <MethodName>count/table_count</MethodName>\\n <CheckerId>7</CheckerId>\\n <EntityId>1234</EntityId>\\n <ExpectValue>1000</ExpectValue>\\n <TemplateId>7</TemplateId>\\n <Id>1234</Id>\\n <RuleName>test</RuleName>\\n </Rules>\\n </Data>\\n</ListQualityRulesResponse>","errorExample":""}]',
+ 'title' => 'ListQualityRules',
+ 'summary' => 'Queries monitoring rules based on a partition filter expression.',
+ 'requestParamsDescription' => ' ',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ ],
+ 'CreateQualityRule' => [
+ 'methods' => [
+ 'post',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'write',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'create',
+ 'abilityTreeCode' => '78195',
+ 'abilityTreeNodes' => [
+ 'FEATUREdide3WJOKE',
+ ],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'BlockType',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The strength type of the monitoring rule. Valid values:'."\n"
+ ."\n"
+ .'* 0: The monitoring rule is a weak rule.'."\n"
+ .'* 1: The monitoring rule is a strong rule.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => true,
+ 'docRequired' => true,
+ 'maximum' => '1',
+ 'minimum' => '0',
+ 'example' => '0',
+ ],
+ ],
+ [
+ 'name' => 'EntityId',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The ID of the partition filter expression.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => true,
+ 'docRequired' => true,
+ 'maximum' => '2147483647',
+ 'minimum' => '1',
+ 'example' => '15224',
+ ],
+ ],
+ [
+ 'name' => 'Comment',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The description of the rule.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'Verification',
+ 'maxLength' => 128,
+ 'minLength' => 1,
+ ],
+ ],
+ [
+ 'name' => 'Checker',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The checker ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => false,
+ 'docRequired' => true,
+ 'minimum' => '1',
+ 'example' => '9',
+ ],
+ ],
+ [
+ 'name' => 'ExpectValue',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The expected value.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => '0',
+ ],
+ ],
+ [
+ 'name' => 'Trend',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The trend of the monitoring result. Valid values:'."\n"
+ ."\n"
+ .'* up: increasing'."\n"
+ .'* down: decreasing'."\n"
+ .'* abs: absolute value'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'abs',
+ ],
+ ],
+ [
+ 'name' => 'MethodName',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The method used to collect sample data. If you want to use a custom SQL statement as a sampling method, set this parameter to user_defined.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'docRequired' => true,
+ 'example' => 'count/table_count',
+ ],
+ ],
+ [
+ 'name' => 'Operator',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The comparison operator, such as >, >=, =, ≠, <, or <=.'."\n"
+ ."\n"
+ .'> If you set the Checker parameter to 9, you must configure the Operator parameter.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => '>',
+ ],
+ ],
+ [
+ 'name' => 'ProjectName',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The name of the compute engine or data source.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'autotest',
+ ],
+ ],
+ [
+ 'name' => 'Property',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The fields that you want to monitor. If you want to monitor all fields in a table and check the table rows, set this parameter to table_count. If you want to monitor all fields in a table and check the table size, set this parameter to table_size.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'table_id',
+ 'maxLength' => 128,
+ ],
+ ],
+ [
+ 'name' => 'PropertyType',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The data type of the fields that you want to monitor. If you want to monitor all fields in a table, set this parameter to table. If you want to monitor only a specific field, set this parameter to bigint.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'bigint',
+ ],
+ ],
+ [
+ 'name' => 'RuleType',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'Rule type:'."\n"
+ ."\n"
+ .'* 0: System template rule'."\n"
+ .'* 1: Custom SQL rule'."\n"
+ .'* 4: Custom template rule'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => true,
+ 'docRequired' => true,
+ 'maximum' => '99',
+ 'minimum' => '0',
+ 'example' => '0',
+ ],
+ ],
+ [
+ 'name' => 'WhereCondition',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The filter condition or custom SQL statement.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'table_id>1',
+ ],
+ ],
+ [
+ 'name' => 'CriticalThreshold',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The threshold for a critical alert. The threshold indicates the deviation of the monitoring result from the expected value. You can customize this threshold based on your business requirements. If a strong rule is used and a critical alert is triggered, nodes are blocked.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => '20',
+ ],
+ ],
+ [
+ 'name' => 'WarningThreshold',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The threshold for a warning alert. The threshold indicates the deviation of the monitoring result from the expected value. You can customize this threshold based on your business requirements.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => '10',
+ ],
+ ],
+ [
+ 'name' => 'TemplateId',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The template ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => false,
+ 'minimum' => '1',
+ 'example' => '7',
+ ],
+ ],
+ [
+ 'name' => 'RuleName',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The name of the monitoring rule.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => '1234',
+ 'maxLength' => 128,
+ ],
+ ],
+ [
+ 'name' => 'PredictType',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'Specifies whether the monitoring rule is a dynamic threshold rule. Valid values: 0 and 2. The value 0 indicates that the monitoring rule is not a dynamic threshold rule. The value 2 indicates that the monitoring rule is a dynamic threshold rule.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => true,
+ 'docRequired' => true,
+ 'maximum' => '99',
+ 'minimum' => '0',
+ 'example' => '0',
+ ],
+ ],
+ [
+ 'name' => 'ProjectId',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The DataWorks workspace ID. You can log on to the [DataWorks console](https://workbench.data.aliyun.com/console) and go to the Workspace page to query the ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => '10000',
+ ],
+ ],
+ [
+ 'name' => 'TaskSetting',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The variable settings inserted before the custom rule. Format: x=a,y=b.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'x=a,y=b',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'description' => 'The response parameters.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'HttpStatusCode' => [
+ 'description' => 'The HTTP status code.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '200',
+ ],
+ 'Data' => [
+ 'description' => 'The ID of the monitoring rule that you created.'."\n",
+ 'type' => 'string',
+ 'example' => '12345',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message.'."\n",
+ 'type' => 'string',
+ 'example' => 'You have no permission.',
+ ],
+ 'RequestId' => [
+ 'description' => 'The request ID.'."\n",
+ 'type' => 'string',
+ 'example' => 'ecb967ec-c137-48****',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code.'."\n",
+ 'type' => 'string',
+ 'example' => '401',
+ ],
+ 'Success' => [
+ 'description' => 'Indicates whether the request was successful.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Data\\": \\"12345\\",\\n \\"ErrorMessage\\": \\"You have no permission.\\",\\n \\"RequestId\\": \\"ecb967ec-c137-48****\\",\\n \\"ErrorCode\\": \\"401\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<CreateQualityRuleResponse>\\n <HttpStatusCode>200</HttpStatusCode>\\n <Data>12345</Data>\\n <ErrorMessage>You have no permission.</ErrorMessage>\\n <RequestId>ecb967ec-c137-48****</RequestId>\\n <ErrorCode>401</ErrorCode>\\n <Success>true</Success>\\n</CreateQualityRuleResponse>","errorExample":""}]',
+ 'title' => 'CreateQualityRule',
+ 'summary' => 'Creates a monitoring rule.',
+ 'requestParamsDescription' => ' ',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ ],
+ 'DeleteQualityFollower' => [
+ 'methods' => [
+ 'post',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'write',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'delete',
+ 'abilityTreeCode' => '78214',
+ 'abilityTreeNodes' => [
+ 'FEATUREdideGJ7UNJ',
+ ],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'ProjectName',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The name of the compute engine or data source for which the partition filter expression is configured. You can log on to the [DataWorks console](https://workbench.data.aliyun.com/console) and go to the rule configuration page of Data Quality page to obtain the name.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'autotest',
+ ],
+ ],
+ [
+ 'name' => 'FollowerId',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The ID of the subscription relationship between the partition filter expression and the subscriber. You can call the [GetQualityFollower](~~174000~~) operation to obtain the ID of the subscription relationship.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => '1234',
+ ],
+ ],
+ [
+ 'name' => 'ProjectId',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The DataWorks workspace ID. You can log on to the DataWorks console and go to the Workspace page to obtain the workspace ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'example' => '10000',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'description' => 'The returned result.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'HttpStatusCode' => [
+ 'description' => 'The HTTP status code.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '200',
+ ],
+ 'Data' => [
+ 'description' => 'Indicates whether the subscriber was successfully deleted. Valid values:'."\n"
+ ."\n"
+ .'* true: The subscriber was successfully deleted.'."\n"
+ .'* false: The subscriber failed to be deleted. You can troubleshoot errors based on the error message returned.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message returned when the subscriber failed to be deleted.'."\n",
+ 'type' => 'string',
+ 'example' => 'You have no permission.',
+ ],
+ 'RequestId' => [
+ 'description' => 'The request ID. You can troubleshoot errors based on the ID.'."\n",
+ 'type' => 'string',
+ 'example' => '6d739ef6-098a-47****',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code.'."\n",
+ 'type' => 'string',
+ 'example' => '401',
+ ],
+ 'Success' => [
+ 'description' => 'Indicates whether the request was successful. Valid values:'."\n"
+ ."\n"
+ .'* true'."\n"
+ .'* false'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Data\\": true,\\n \\"ErrorMessage\\": \\"You have no permission.\\",\\n \\"RequestId\\": \\"6d739ef6-098a-47****\\",\\n \\"ErrorCode\\": \\"401\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<DeleteQualityFollowerResponse>\\n <HttpStatusCode>200</HttpStatusCode>\\n <Data>true</Data>\\n <ErrorMessage>You have no permission.</ErrorMessage>\\n <RequestId>6d739ef6-098a-47****</RequestId>\\n <ErrorCode>401</ErrorCode>\\n <Success>true</Success>\\n</DeleteQualityFollowerResponse>","errorExample":""}]',
+ 'title' => 'DeleteQualityFollower',
+ 'summary' => 'Deletes a subscriber of a partition filter expression.',
+ 'description' => 'In Data Quality, you must configure monitoring rules based on a partition filter expression. Data Quality uses these rules to detect changes in source data and dirty data generated during the process of extract, transform, and load (ETL). This way, you can prevent tasks from producing unexpected dirty data that affects the smooth running of tasks and business decision-making. You can go to the Manage Subscriptions page to add subscribers for a partition filter expression. When the monitoring rule that is created based on the partition filter expression is triggered, the subscribers can receive notifications and troubleshoot errors at the earliest opportunity. For more information, see [Configure monitoring rules](~~73690~~).'."\n",
+ 'requestParamsDescription' => ' ',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ ],
+ 'DeleteQualityRule' => [
+ 'methods' => [
+ 'post',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'write',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'delete',
+ 'abilityTreeCode' => '78216',
+ 'abilityTreeNodes' => [
+ 'FEATUREdide3WJOKE',
+ ],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'ProjectName',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The name of the compute engine or data source.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'autotest',
+ ],
+ ],
+ [
+ 'name' => 'RuleId',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The monitoring rule ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => '1234',
+ ],
+ ],
+ [
+ 'name' => 'ProjectId',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The DataWorks workspace ID. You can log on to the DataWorks console and go to the Workspace page to query the ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => '10000',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'description' => 'The response parameters.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'HttpStatusCode' => [
+ 'description' => 'The HTTP status code.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '200',
+ ],
+ 'Data' => [
+ 'description' => 'Indicates whether the monitoring rule was deleted.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message.'."\n",
+ 'type' => 'string',
+ 'example' => 'You have no permission.',
+ ],
+ 'RequestId' => [
+ 'description' => 'The request ID.'."\n",
+ 'type' => 'string',
+ 'example' => '6d739ef6-098a-47****',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code.'."\n",
+ 'type' => 'string',
+ 'example' => '401',
+ ],
+ 'Success' => [
+ 'description' => 'Indicates whether the request was successful.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Data\\": true,\\n \\"ErrorMessage\\": \\"You have no permission.\\",\\n \\"RequestId\\": \\"6d739ef6-098a-47****\\",\\n \\"ErrorCode\\": \\"401\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<DeleteQualityRuleResponse>\\n <HttpStatusCode>200</HttpStatusCode>\\n <Data>true</Data>\\n <ErrorMessage>You have no permission.</ErrorMessage>\\n <RequestId>6d739ef6-098a-47****</RequestId>\\n <ErrorCode>401</ErrorCode>\\n <Success>true</Success>\\n</DeleteQualityRuleResponse>","errorExample":""}]',
+ 'title' => 'DeleteQualityRule',
+ 'summary' => 'Deletes a monitoring rule.',
+ 'requestParamsDescription' => ' ',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ ],
+ 'GetQualityFollower' => [
+ 'methods' => [
+ 'post',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'get',
+ 'abilityTreeCode' => '78284',
+ 'abilityTreeNodes' => [
+ 'FEATUREdideGJ7UNJ',
+ ],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'ProjectName',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The name of the engine or data source.',
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'autotest',
+ ],
+ ],
+ [
+ 'name' => 'EntityId',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The ID of the partition filter expression.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => '1234',
+ ],
+ ],
+ [
+ 'name' => 'ProjectId',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The ID of the DataWorks workspace.',
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => '27',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'description' => 'Returns the data structure.',
+ 'type' => 'object',
+ 'properties' => [
+ 'HttpStatusCode' => [
+ 'description' => 'The HTTP return code.',
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '200',
+ ],
+ 'RequestId' => [
+ 'description' => 'The ID of the request.',
+ 'type' => 'string',
+ 'example' => '38cbdef0-f6cf-49',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message.',
+ 'type' => 'string',
+ 'example' => 'You have no permission.',
+ ],
+ 'Success' => [
+ 'description' => 'Whether the call is successful.',
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code.',
+ 'type' => 'string',
+ 'example' => 'Invalid.Tenant.ConnectionNotExists',
+ ],
+ 'Data' => [
+ 'description' => 'The information about the subscription relationship.',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'Returns the data structure.',
+ 'type' => 'object',
+ 'properties' => [
+ 'FollowerAccountName' => [
+ 'description' => 'The Alibaba Cloud account name of the subscriber.',
+ 'type' => 'string',
+ 'example' => 'test',
+ ],
+ 'TableName' => [
+ 'description' => 'The name of the partitioned table.',
+ 'type' => 'string',
+ 'example' => 'dual',
+ ],
+ 'AlarmMode' => [
+ 'description' => 'The alert mode. The value is as follows:'."\n"
+ ."\n"
+ .'- 1 (Mail)'."\n"
+ .'- 2 (email and SMS)'."\n"
+ .'- 4 (DingTalk groups of robots or hook)'."\n"
+ .'- 5 (DingTalk groups of robots @ ALL)',
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '1',
+ ],
+ 'EntityId' => [
+ 'description' => 'The ID of the partition expression.',
+ 'type' => 'string',
+ 'example' => '1234',
+ ],
+ 'ProjectName' => [
+ 'description' => 'The name of the engine or data source.',
+ 'type' => 'string',
+ 'example' => 'autotest',
+ ],
+ 'Id' => [
+ 'description' => 'The ID of the subscription relationship.',
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '123',
+ ],
+ 'Follower' => [
+ 'description' => 'The subscriber to receive alert information.',
+ 'type' => 'string',
+ 'example' => '1234',
+ ],
+ 'CreateTime' => [
+ 'description' => 'The time when the data quality rule subscription configuration was created.',
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '1541576644000',
+ ],
+ 'ModifyTime' => [
+ 'description' => 'The update time of the data quality rule subscription configuration.',
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '1541576644000',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"38cbdef0-f6cf-49\\",\\n \\"ErrorMessage\\": \\"You have no permission.\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"Invalid.Tenant.ConnectionNotExists\\",\\n \\"Data\\": [\\n {\\n \\"FollowerAccountName\\": \\"test\\",\\n \\"TableName\\": \\"dual\\",\\n \\"AlarmMode\\": 1,\\n \\"EntityId\\": \\"1234\\",\\n \\"ProjectName\\": \\"autotest\\",\\n \\"Id\\": 123,\\n \\"Follower\\": \\"1234\\",\\n \\"CreateTime\\": 1541576644000,\\n \\"ModifyTime\\": 1541576644000\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<GetQualityFollowerResponse>\\n <HttpStatusCode>200</HttpStatusCode>\\n <RequestId>38cbdef0-f6cf-49</RequestId>\\n <ErrorMessage>You have no permission.</ErrorMessage>\\n <Success>true</Success>\\n <ErrorCode>Invalid.Tenant.ConnectionNotExists</ErrorCode>\\n <Data>\\n <FollowerAccountName>test</FollowerAccountName>\\n <TableName>dual</TableName>\\n <AlarmMode>1</AlarmMode>\\n <EntityId>1234</EntityId>\\n <ProjectName>autotest</ProjectName>\\n <Id>123</Id>\\n <Follower>1234</Follower>\\n <CreateTime>1541576644000</CreateTime>\\n <ModifyTime>1541576644000</ModifyTime>\\n </Data>\\n</GetQualityFollowerResponse>","errorExample":""}]',
+ 'title' => 'GetQualityFollower',
+ 'summary' => 'Queries the subscribers of a partition filter expression.',
+ 'requestParamsDescription' => ' ',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ ],
+ 'CreateQualityFollower' => [
+ 'methods' => [
+ 'post',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'write',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'create',
+ 'abilityTreeCode' => '78193',
+ 'abilityTreeNodes' => [
+ 'FEATUREdideGJ7UNJ',
+ ],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'ProjectName',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The name of the compute engine or data source.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'autotest',
+ ],
+ ],
+ [
+ 'name' => 'Follower',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The account ID of the subscriber.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => '123',
+ ],
+ ],
+ [
+ 'name' => 'AlarmMode',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The notification method. Valid values: 1, 2, 4, 5, 6, 7, 8, and 9. The value 1 indicates that the notification is sent by email. The value 2 indicates that the notification is sent by email and text message. The value 4 indicates that the notification is sent by a DingTalk chatbot. The value 5 indicates that the notification is sent by a DingTalk chatbot to all members in a DingTalk group. The value 6 indicates that the notification is sent by Lark. The value 7 indicates that the notification is sent by WeCom. The value 8 indicates that the notification is sent by webhook. The value 9 indicates that the notification is sent by phone call.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => '1',
+ 'enum' => [
+ '1',
+ '2',
+ '4',
+ '5',
+ '6',
+ '7',
+ '8',
+ '9',
+ ],
+ ],
+ ],
+ [
+ 'name' => 'EntityId',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The ID of the partition filter expression.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => '12345',
+ ],
+ ],
+ [
+ 'name' => 'ProjectId',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The DataWorks workspace ID. You can log on to the DataWorks console to query the ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => '123',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'description' => 'The response parameters.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'HttpStatusCode' => [
+ 'description' => 'The HTTP status code.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '200',
+ ],
+ 'Data' => [
+ 'description' => 'The ID of the subscription relationship.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '12345',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message.'."\n",
+ 'type' => 'string',
+ 'example' => 'You have no permission.',
+ ],
+ 'RequestId' => [
+ 'description' => 'The request ID.'."\n",
+ 'type' => 'string',
+ 'example' => 'ecb967ec-c137-48****',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code.'."\n",
+ 'type' => 'string',
+ 'example' => '401',
+ ],
+ 'Success' => [
+ 'description' => 'Indicates whether the request was successful.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Data\\": 12345,\\n \\"ErrorMessage\\": \\"You have no permission.\\",\\n \\"RequestId\\": \\"ecb967ec-c137-48****\\",\\n \\"ErrorCode\\": \\"401\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<CreateQualityFollowerResponse>\\n <HttpStatusCode>200</HttpStatusCode>\\n <Data>12345</Data>\\n <ErrorMessage>You have no permission.</ErrorMessage>\\n <RequestId>ecb967ec-c137-48****</RequestId>\\n <ErrorCode>401</ErrorCode>\\n <Success>true</Success>\\n</CreateQualityFollowerResponse>","errorExample":""}]',
+ 'title' => 'CreateQualityFollower',
+ 'summary' => 'Creates a subscriber for a partition filter expression.',
+ 'requestParamsDescription' => ' ',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ ],
+ 'DeleteQualityEntity' => [
+ 'methods' => [
+ 'post',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'write',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'delete',
+ 'abilityTreeCode' => '78213',
+ 'abilityTreeNodes' => [
+ 'FEATUREdide3WJOKE',
+ ],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'EntityId',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The ID of the partition filter expression.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => true,
+ 'docRequired' => true,
+ 'maximum' => '2147483647',
+ 'minimum' => '1',
+ 'example' => '1234',
+ ],
+ ],
+ [
+ 'name' => 'ProjectName',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The name of the compute engine or data source.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'autotest',
+ ],
+ ],
+ [
+ 'name' => 'EnvType',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The type of the compute engine or data source. The following types are supported: E-MapReduce (EMR), Hologres, AnalyticDB for PostgreSQL, CDH, MaxCompute, Kafka, and DataHub.'."\n"
+ ."\n"
+ .'Valid values:'."\n"
+ ."\n"
+ .'* odps'."\n"
+ .'* emr'."\n"
+ .'* hadoop'."\n"
+ .'* cdh'."\n"
+ .'* hybriddb_for_postgresql'."\n"
+ .'* holodb'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'ODPS',
+ 'enum' => [
+ 'odps',
+ 'emr',
+ 'hadoop',
+ 'cdh',
+ 'hybriddb_for_postgresql',
+ 'holodb',
+ ],
+ ],
+ ],
+ [
+ 'name' => 'ProjectId',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The DataWorks workspace ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => '12345',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'description' => 'The response parameters.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'HttpStatusCode' => [
+ 'description' => 'The HTTP status code.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '200',
+ ],
+ 'Data' => [
+ 'description' => 'The returned result.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message.'."\n",
+ 'type' => 'string',
+ 'example' => 'You have no permission.',
+ ],
+ 'RequestId' => [
+ 'description' => 'The request ID.'."\n",
+ 'type' => 'string',
+ 'example' => 'ecb967ec-c137-48****',
+ ],
+ 'Success' => [
+ 'description' => 'Indicates whether the request was successful.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code.'."\n",
+ 'type' => 'string',
+ 'example' => '401',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Data\\": true,\\n \\"ErrorMessage\\": \\"You have no permission.\\",\\n \\"RequestId\\": \\"ecb967ec-c137-48****\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"401\\"\\n}","errorExample":""},{"type":"xml","example":"<DeleteQualityEntityResponse>\\n <HttpStatusCode>200</HttpStatusCode>\\n <Data>true</Data>\\n <ErrorMessage>You have no permission.</ErrorMessage>\\n <RequestId>ecb967ec-c137-48****</RequestId>\\n <Success>true</Success>\\n <ErrorCode>401</ErrorCode>\\n</DeleteQualityEntityResponse>","errorExample":""}]',
+ 'title' => 'DeleteQualityEntity',
+ 'summary' => 'Deletes a partition filter expression.',
+ 'requestParamsDescription' => ' ',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ ],
+ 'GetQualityEntity' => [
+ 'methods' => [
+ 'post',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'get',
+ 'abilityTreeCode' => '78283',
+ 'abilityTreeNodes' => [
+ 'FEATUREdide3WJOKE',
+ ],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'ProjectName',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The name of the compute engine instance or data source. You can obtain the name from data source configurations.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'autotest',
+ 'maxLength' => 1024,
+ 'minLength' => 1,
+ ],
+ ],
+ [
+ 'name' => 'TableName',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The name of the partitioned table. You can call the [GetMetaTablePartition](~~173923~~) operation to obtain the name.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'dual',
+ 'maxLength' => 128,
+ 'minLength' => 1,
+ ],
+ ],
+ [
+ 'name' => 'EnvType',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The type of the compute engine or data source. Valid values:'."\n"
+ ."\n"
+ .'* cdh'."\n"
+ .'* analyticdb_for_mysql'."\n"
+ .'* odps'."\n"
+ .'* emr'."\n"
+ .'* hadoop'."\n"
+ .'* holodb'."\n"
+ .'* hybriddb_for_postgresql'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'enumValueTitles' => [],
+ 'example' => 'odps',
+ 'maxLength' => 64,
+ 'minLength' => 1,
+ ],
+ ],
+ [
+ 'name' => 'MatchExpression',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The partition filter expression.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'docRequired' => false,
+ 'example' => 'dt=$[yyyymmdd]',
+ 'maxLength' => 128,
+ 'minLength' => 1,
+ ],
+ ],
+ [
+ 'name' => 'ProjectId',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The DataWorks workspace ID. You can log on to the [DataWorks console](https://workbench.data.aliyun.com/console) and go to the Workspace page to query the ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => '12345',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'description' => '',
+ 'type' => 'object',
+ 'properties' => [
+ 'HttpStatusCode' => [
+ 'description' => 'The HTTP status code returned.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '200',
+ ],
+ 'RequestId' => [
+ 'description' => 'The ID of the request.'."\n",
+ 'type' => 'string',
+ 'example' => '6d739ef6-098a-47****',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message returned.'."\n",
+ 'type' => 'string',
+ 'example' => 'You have no permission.',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code returned.'."\n",
+ 'type' => 'string',
+ 'example' => '401',
+ ],
+ 'Success' => [
+ 'description' => 'Indicates whether the request is successful.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'Data' => [
+ 'description' => 'The information about the partition filter expression.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '',
+ 'type' => 'object',
+ 'properties' => [
+ 'RelativeNode' => [
+ 'description' => 'The information about the node with which the partition filter expression is associated. The information includes the following items:'."\n"
+ ."\n"
+ .'* ProjectName: the name of the workspace to which the node belongs.'."\n"
+ .'* NodeID: the ID of the node.'."\n",
+ 'type' => 'string',
+ 'example' => '[{"projectName":"xc_DP****","nodeId":7000026****}]',
+ ],
+ 'OnDutyAccountName' => [
+ 'description' => 'The name of the Alibaba Cloud account that is used to configure the partition filter expression.'."\n",
+ 'type' => 'string',
+ 'example' => 'test',
+ ],
+ 'Task' => [
+ 'description' => 'The node.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '0',
+ ],
+ 'TableName' => [
+ 'description' => 'The name of the partitioned table.'."\n",
+ 'type' => 'string',
+ 'example' => 'test_dqc_de****',
+ ],
+ 'Followers' => [
+ 'description' => 'The ID of the Alibaba Cloud account that is used to receive alert notifications.'."\n",
+ 'type' => 'string',
+ 'example' => '1822931****',
+ ],
+ 'OnDuty' => [
+ 'description' => 'The ID of the Alibaba Cloud account that is used to configure the partition filter expression.'."\n",
+ 'type' => 'string',
+ 'example' => '1822931****',
+ ],
+ 'MatchExpression' => [
+ 'description' => 'The partition filter expression.'."\n",
+ 'type' => 'string',
+ 'example' => 'dt=$[yyyymmdd-1]',
+ ],
+ 'CreateTime' => [
+ 'description' => 'The time when the partition filter expression was created.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '1593964800000',
+ ],
+ 'ProjectName' => [
+ 'description' => 'The name of the compute engine instance or data source.'."\n",
+ 'type' => 'string',
+ 'example' => 'autotest',
+ ],
+ 'HasRelativeNode' => [
+ 'description' => 'Indicates whether the partition filter expression is associated with a node. Valid values:'."\n"
+ ."\n"
+ .'* true: The partition filter expression is associated with a node.'."\n"
+ .'* false: The partition filter expression is not associated with a node.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'EnvType' => [
+ 'description' => 'The type of the compute engine instance or data source.'."\n",
+ 'type' => 'string',
+ 'example' => 'odps',
+ ],
+ 'EntityLevel' => [
+ 'description' => 'The level of the partition filter expression. Valid values:'."\n"
+ ."\n"
+ .'* 0: The partition filter expression is at the SQL level. This indicates that the system checks data quality after each SQL statement is executed.'."\n"
+ .'* 1: The partition filter expression is at the node level. This indicates that the system checks data quality after all the SQL statements for a node are executed.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '0',
+ ],
+ 'ModifyUser' => [
+ 'description' => 'The ID of the Alibaba Cloud account that is used to modify the partition filter expression.'."\n",
+ 'type' => 'string',
+ 'example' => '1822931****',
+ ],
+ 'Sql' => [
+ 'description' => 'Indicates that the partition filter expression is at the SQL level.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '0',
+ ],
+ 'Id' => [
+ 'description' => 'The ID of the partition filter expression.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '4003918',
+ ],
+ 'ModifyTime' => [
+ 'description' => 'The time when the partition filter expression was modified.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '1593964800000',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"6d739ef6-098a-47****\\",\\n \\"ErrorMessage\\": \\"You have no permission.\\",\\n \\"ErrorCode\\": \\"401\\",\\n \\"Success\\": true,\\n \\"Data\\": [\\n {\\n \\"RelativeNode\\": \\"[{\\\\\\"projectName\\\\\\":\\\\\\"xc_DP****\\\\\\",\\\\\\"nodeId\\\\\\":7000026****}]\\",\\n \\"OnDutyAccountName\\": \\"test\\",\\n \\"Task\\": 0,\\n \\"TableName\\": \\"test_dqc_de****\\",\\n \\"Followers\\": \\"1822931****\\",\\n \\"OnDuty\\": \\"1822931****\\",\\n \\"MatchExpression\\": \\"dt=$[yyyymmdd-1]\\",\\n \\"CreateTime\\": 1593964800000,\\n \\"ProjectName\\": \\"autotest\\",\\n \\"HasRelativeNode\\": true,\\n \\"EnvType\\": \\"odps\\",\\n \\"EntityLevel\\": 0,\\n \\"ModifyUser\\": \\"1822931****\\",\\n \\"Sql\\": 0,\\n \\"Id\\": 4003918,\\n \\"ModifyTime\\": 1593964800000\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<GetQualityEntityResponse>\\n <HttpStatusCode>200</HttpStatusCode>\\n <RequestId>6d739ef6-098a-47****</RequestId>\\n <ErrorMessage>You have no permission.</ErrorMessage>\\n <ErrorCode>401</ErrorCode>\\n <Success>true</Success>\\n <Data>\\n <RelativeNode>[{\\"projectName\\":\\"xc_DP****\\",\\"nodeId\\":7000026****}]</RelativeNode>\\n <OnDutyAccountName>test</OnDutyAccountName>\\n <Task>0</Task>\\n <TableName>test_dqc_de****</TableName>\\n <Followers>1822931****</Followers>\\n <OnDuty>1822931****</OnDuty>\\n <MatchExpression>dt=$[yyyymmdd-1]</MatchExpression>\\n <CreateTime>1593964800000</CreateTime>\\n <ProjectName>autotest</ProjectName>\\n <HasRelativeNode>true</HasRelativeNode>\\n <EnvType>odps</EnvType>\\n <EntityLevel>0</EntityLevel>\\n <ModifyUser>1822931****</ModifyUser>\\n <Sql>0</Sql>\\n <Id>4003918</Id>\\n <ModifyTime>1593964800000</ModifyTime>\\n </Data>\\n</GetQualityEntityResponse>","errorExample":""}]',
+ 'title' => 'GetQualityEntity',
+ 'summary' => 'Queries the information about a partition filter expression.',
+ 'requestParamsDescription' => ' ',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ ],
+ 'CreateQualityEntity' => [
+ 'methods' => [
+ 'post',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'write',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'create',
+ 'abilityTreeCode' => '78192',
+ 'abilityTreeNodes' => [
+ 'FEATUREdide3WJOKE',
+ ],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'ProjectName',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The name of the compute engine or data source.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'autotest',
+ ],
+ ],
+ [
+ 'name' => 'TableName',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The name of the table.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'dual',
+ 'maxLength' => 128,
+ 'minLength' => 1,
+ ],
+ ],
+ [
+ 'name' => 'EnvType',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The type of the compute engine or data source.'."\n"
+ ."\n"
+ .'Valid values:'."\n"
+ ."\n"
+ .'* odps'."\n"
+ .'* emr'."\n"
+ .'* hadoop'."\n"
+ .'* cdh'."\n"
+ .'* analyticdb_for_mysql'."\n"
+ .'* hybriddb_for_postgresql'."\n"
+ .'* holodb'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'ODPS',
+ 'maxLength' => 64,
+ 'minLength' => 1,
+ 'enum' => [
+ 'odps',
+ 'emr',
+ 'hadoop',
+ 'cdh',
+ 'analyticdb_for_mysql',
+ 'hybriddb_for_postgresql',
+ 'holodb',
+ ],
+ ],
+ ],
+ [
+ 'name' => 'MatchExpression',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The partition filter expression.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'dt=$[yyyymmdd]',
+ 'maxLength' => 128,
+ 'minLength' => 1,
+ ],
+ ],
+ [
+ 'name' => 'EntityLevel',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'This parameter is deprecated.'."\n"
+ ."\n"
+ .'The value 0 indicates that the partition filter expression is at the SQL level, and the system checks data quality after each SQL statement is executed.'."\n"
+ ."\n"
+ .'* 0'."\n"
+ .'* 1',
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => false,
+ 'docRequired' => false,
+ 'maximum' => '99',
+ 'minimum' => '0',
+ 'enumValueTitles' => [
+ '0',
+ '1',
+ ],
+ 'example' => '0',
+ 'enum' => [
+ '0',
+ '1',
+ ],
+ ],
+ ],
+ [
+ 'name' => 'ProjectId',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The DataWorks workspace ID. You can log on to the DataWorks console to query the ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => '123',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'description' => 'The response parameters.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'HttpStatusCode' => [
+ 'description' => 'The HTTP status code.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '200',
+ ],
+ 'Data' => [
+ 'description' => 'The partition filter expression ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '12345',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message.'."\n",
+ 'type' => 'string',
+ 'example' => 'Your project is not relative with your account.',
+ ],
+ 'RequestId' => [
+ 'description' => 'The request ID.'."\n",
+ 'type' => 'string',
+ 'example' => '011e1231u3****',
+ ],
+ 'Success' => [
+ 'description' => 'Indicates whether the request was successful.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code.'."\n",
+ 'type' => 'string',
+ 'example' => '401',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Data\\": 12345,\\n \\"ErrorMessage\\": \\"Your project is not relative with your account.\\",\\n \\"RequestId\\": \\"011e1231u3****\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"401\\"\\n}","errorExample":""},{"type":"xml","example":"<CreateQualityEntityResponse>\\n <HttpStatusCode>200</HttpStatusCode>\\n <Data>12345</Data>\\n <ErrorMessage>Your project is not relative with your account.</ErrorMessage>\\n <RequestId>011e1231u3****</RequestId>\\n <Success>true</Success>\\n <ErrorCode>401</ErrorCode>\\n</CreateQualityEntityResponse>","errorExample":""}]',
+ 'title' => 'CreateQualityEntity',
+ 'summary' => 'Creates a partition filter expression.',
+ 'requestParamsDescription' => ' ',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ ],
+ 'CreateQualityRelativeNode' => [
+ 'methods' => [
+ 'post',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'write',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'create',
+ 'abilityTreeCode' => '78194',
+ 'abilityTreeNodes' => [
+ 'FEATUREdide3WJOKE',
+ ],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'EnvType',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The type of the compute engine or data source.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'ODPS',
+ 'maxLength' => 40,
+ 'minLength' => 1,
+ ],
+ ],
+ [
+ 'name' => 'MatchExpression',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The partition filter expression.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'dt=$[yyyymmdd]',
+ 'maxLength' => 80,
+ 'minLength' => 1,
+ ],
+ ],
+ [
+ 'name' => 'NodeId',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The node ID. You can call the [ListNodes](~~173979~~) operation to query the ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => '12321',
+ ],
+ ],
+ [
+ 'name' => 'ProjectId',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The workspace ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => '123',
+ ],
+ ],
+ [
+ 'name' => 'TargetNodeProjectName',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The name of the workspace to which the node to be associated with the partition filter expression belongs.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'autotest',
+ 'maxLength' => 128,
+ 'minLength' => 1,
+ ],
+ ],
+ [
+ 'name' => 'ProjectName',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The name of the compute engine or data source.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'autotest',
+ 'maxLength' => 128,
+ 'minLength' => 1,
+ ],
+ ],
+ [
+ 'name' => 'TableName',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The name of the table.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'dual',
+ 'maxLength' => 128,
+ 'minLength' => 1,
+ ],
+ ],
+ [
+ 'name' => 'TargetNodeProjectId',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The ID of the workspace to which the node belongs.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => '1234',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'description' => 'The response parameters.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'HttpStatusCode' => [
+ 'description' => 'The HTTP status code.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '200',
+ ],
+ 'Data' => [
+ 'description' => 'Indicates whether the node is associated with the partition filter expression.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message.'."\n",
+ 'type' => 'string',
+ 'example' => 'You have no permission.',
+ ],
+ 'RequestId' => [
+ 'description' => 'The request ID.'."\n",
+ 'type' => 'string',
+ 'example' => 'ecb967ec-c137-48****',
+ ],
+ 'Success' => [
+ 'description' => 'Indicates whether the request was successful.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code.'."\n",
+ 'type' => 'string',
+ 'example' => '401',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Data\\": true,\\n \\"ErrorMessage\\": \\"You have no permission.\\",\\n \\"RequestId\\": \\"ecb967ec-c137-48****\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"401\\"\\n}","errorExample":""},{"type":"xml","example":"<CreateQualityRelativeNodeResponse>\\n <HttpStatusCode>200</HttpStatusCode>\\n <Data>true</Data>\\n <ErrorMessage>You have no permission.</ErrorMessage>\\n <RequestId>ecb967ec-c137-48****</RequestId>\\n <Success>true</Success>\\n <ErrorCode>401</ErrorCode>\\n</CreateQualityRelativeNodeResponse>","errorExample":""}]',
+ 'title' => 'CreateQualityRelativeNode',
+ 'summary' => 'Associates a node with a partition filter expression.',
+ 'requestParamsDescription' => ' ',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ ],
+ 'DeleteQualityRelativeNode' => [
+ 'methods' => [
+ 'post',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'write',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'delete',
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'EnvType',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The type of the compute engine or data source. Valid values:'."\n"
+ ."\n"
+ .'* cdh'."\n"
+ .'* analyticdb_for_mysql'."\n"
+ .'* odps'."\n"
+ .'* emr'."\n"
+ .'* hadoop'."\n"
+ .'* holodb'."\n"
+ .'* hybriddb_for_postgresql'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'ODPS',
+ 'maxLength' => 40,
+ 'minLength' => 1,
+ ],
+ ],
+ [
+ 'name' => 'MatchExpression',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The partition filter expression.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'dt=$[yyyymmdd]',
+ 'maxLength' => 80,
+ 'minLength' => 1,
+ ],
+ ],
+ [
+ 'name' => 'NodeId',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The ID of the node.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => '156234',
+ ],
+ ],
+ [
+ 'name' => 'ProjectId',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The ID of the workspace.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => '12345',
+ ],
+ ],
+ [
+ 'name' => 'TargetNodeProjectName',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The name of the workspace to which the node associated with the partition filter expression belongs.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'autotest',
+ 'maxLength' => 512,
+ 'minLength' => 1,
+ ],
+ ],
+ [
+ 'name' => 'ProjectName',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The name of the compute engine instance or data source.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'autotest',
+ ],
+ ],
+ [
+ 'name' => 'TableName',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The name of the table that is generated by the node.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'dual',
+ 'maxLength' => 128,
+ 'minLength' => 1,
+ ],
+ ],
+ [
+ 'name' => 'TargetNodeProjectId',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The ID of the workspace to which the node associated with the partition filter expression belongs.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => '12345',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'description' => '',
+ 'type' => 'object',
+ 'properties' => [
+ 'HttpStatusCode' => [
+ 'description' => 'The HTTP status code returned.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '200',
+ ],
+ 'Data' => [
+ 'description' => 'Indicates whether the node is disassociated from the partition filter expression.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message returned.'."\n",
+ 'type' => 'string',
+ 'example' => 'You have no permission.',
+ ],
+ 'RequestId' => [
+ 'description' => 'The ID of the request.'."\n",
+ 'type' => 'string',
+ 'example' => '6d739ef6-098a-47****',
+ ],
+ 'Success' => [
+ 'description' => 'Indicates whether the request was successful.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code returned.'."\n",
+ 'type' => 'string',
+ 'example' => '401',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Data\\": true,\\n \\"ErrorMessage\\": \\"You have no permission.\\",\\n \\"RequestId\\": \\"6d739ef6-098a-47****\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"401\\"\\n}","errorExample":""},{"type":"xml","example":"<DeleteQualityRelativeNodeResponse>\\n <HttpStatusCode>200</HttpStatusCode>\\n <Data>true</Data>\\n <ErrorMessage>You have no permission.</ErrorMessage>\\n <RequestId>6d739ef6-098a-47****</RequestId>\\n <Success>true</Success>\\n <ErrorCode>401</ErrorCode>\\n</DeleteQualityRelativeNodeResponse>","errorExample":""}]',
+ 'title' => 'DeleteQualityRelativeNode',
+ 'summary' => 'Disassociates a node from a partition filter expression.',
+ 'requestParamsDescription' => ' ',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ ],
+ 'ListQualityResultsByEntity' => [
+ 'methods' => [
+ 'post',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'get',
+ 'abilityTreeCode' => '78329',
+ 'abilityTreeNodes' => [
+ 'FEATUREdideGK4B66',
+ ],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'EntityId',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The ID of the partition filter expression. You can call the [GetQualityEntity](~~174003~~) operation to query the ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => true,
+ 'docRequired' => true,
+ 'maximum' => '2147483647',
+ 'minimum' => '1',
+ 'example' => '152322134',
+ ],
+ ],
+ [
+ 'name' => 'StartDate',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The beginning of the time range to query. Specify the time in the yyyy-MM-dd HH:mm:ss format.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => '2020-09-20 00:00:00',
+ ],
+ ],
+ [
+ 'name' => 'EndDate',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The end of the time range to query. Specify the time in the yyyy-MM-dd HH:mm:ss format.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => '2020-09-21 00:00:00',
+ ],
+ ],
+ [
+ 'name' => 'PageSize',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The number of entries per page. Default value: 10. Maximum value: 20.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => true,
+ 'docRequired' => true,
+ 'maximum' => '20',
+ 'minimum' => '1',
+ 'example' => '10',
+ ],
+ ],
+ [
+ 'name' => 'PageNumber',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The page number.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => true,
+ 'docRequired' => true,
+ 'maximum' => '2147483647',
+ 'minimum' => '1',
+ 'example' => '1',
+ ],
+ ],
+ [
+ 'name' => 'ProjectName',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The name of the compute engine or data source. You can obtain the name from data source configurations.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'autotest',
+ ],
+ ],
+ [
+ 'name' => 'ProjectId',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The DataWorks workspace ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => '12345',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'description' => 'The returned result.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'HttpStatusCode' => [
+ 'description' => 'The HTTP status code.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '200',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message.'."\n",
+ 'type' => 'string',
+ 'example' => 'You have no permission.',
+ ],
+ 'RequestId' => [
+ 'description' => 'The request ID.'."\n",
+ 'type' => 'string',
+ 'example' => 'CBA58543-00D4-41****',
+ ],
+ 'Success' => [
+ 'description' => 'Indicates whether the request was successful.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code.'."\n",
+ 'type' => 'string',
+ 'example' => '401',
+ ],
+ 'Data' => [
+ 'description' => 'The data structure of the check results.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'PageNumber' => [
+ 'description' => 'The page number.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '1',
+ ],
+ 'PageSize' => [
+ 'description' => 'The number of entries per page. Default value: 10. Maximum value: 100.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '10',
+ ],
+ 'TotalCount' => [
+ 'description' => 'The total number of entries returned.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '50',
+ ],
+ 'RuleChecks' => [
+ 'description' => 'The returned check results.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The returned check result.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'BlockType' => [
+ 'description' => 'The strength of the monitoring rule. The strength of a monitoring rule indicates the importance of the rule. Valid values:'."\n"
+ ."\n"
+ .'* 1: the monitoring rule is a strong rule.'."\n"
+ .'* 0: the monitoring rule is a weak rule. You can specify whether a monitoring rule is a strong rule based on your business requirements. If a monitoring rule is a strong rule and the critical threshold is exceeded, a critical alert is reported and tasks that are associated with the rule are blocked from running.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '0',
+ ],
+ 'WarningThreshold' => [
+ 'description' => 'The threshold for a warning alert. The threshold indicates the deviation of the check result from the expected value. You can customize this threshold based on your business requirements.'."\n",
+ 'type' => 'number',
+ 'format' => 'float',
+ 'example' => '0.1',
+ ],
+ 'Property' => [
+ 'description' => 'The field whose data quality is checked based on the monitoring rule. This field is a column in the data source table that is monitored.'."\n",
+ 'type' => 'string',
+ 'example' => 'type',
+ ],
+ 'TableName' => [
+ 'description' => 'The name of the table that is monitored.'."\n",
+ 'type' => 'string',
+ 'example' => 'dual',
+ ],
+ 'Comment' => [
+ 'description' => 'The description of the monitoring rule.'."\n",
+ 'type' => 'string',
+ 'example' => 'The description of the rule.',
+ ],
+ 'CheckResultStatus' => [
+ 'description' => 'The check result of the monitoring rule. Valid values:'."\n"
+ ."\n"
+ .'* 0: indicates that the data source table is normal.'."\n"
+ .'* 1: indicates that a warning alert is reported.'."\n"
+ .'* 2: indicates that a critical alert is reported.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '0',
+ ],
+ 'TemplateName' => [
+ 'description' => 'The name of the monitoring template.'."\n",
+ 'type' => 'string',
+ 'example' => 'Expected value verification',
+ ],
+ 'CheckerName' => [
+ 'description' => 'The name of the checker.'."\n",
+ 'type' => 'string',
+ 'example' => 'fulx',
+ ],
+ 'RuleId' => [
+ 'description' => 'The ID of the monitoring rule.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '123123232',
+ ],
+ 'FixedCheck' => [
+ 'description' => 'Indicates whether the monitoring is performed based on a fixed value. Valid values:'."\n"
+ ."\n"
+ .'* true'."\n"
+ .'* false'."\n",
+ 'type' => 'boolean',
+ 'example' => 'false',
+ ],
+ 'Op' => [
+ 'description' => 'The comparison operator.'."\n",
+ 'type' => 'string',
+ 'example' => '>',
+ ],
+ 'UpperValue' => [
+ 'description' => 'The upper limit of the predicted result. The value of this parameter is automatically generated based on the threshold that you specify.'."\n",
+ 'type' => 'number',
+ 'format' => 'float',
+ 'example' => '25555',
+ ],
+ 'ActualExpression' => [
+ 'description' => 'The monitored partition in the data source table.'."\n",
+ 'type' => 'string',
+ 'example' => 'ds=20200912',
+ ],
+ 'ExternalId' => [
+ 'description' => 'The node ID.'."\n",
+ 'type' => 'string',
+ 'example' => '1112323123',
+ ],
+ 'TimeCost' => [
+ 'description' => 'The time that was taken to run the monitoring task. Unit: seconds.'."\n",
+ 'type' => 'string',
+ 'example' => '202',
+ ],
+ 'Trend' => [
+ 'description' => 'The trend of the check result.'."\n",
+ 'type' => 'string',
+ 'example' => 'abs',
+ ],
+ 'ExternalType' => [
+ 'description' => 'The type of the scheduling system. Only CWF scheduling systems are supported.'."\n",
+ 'type' => 'string',
+ 'example' => 'CWF2',
+ ],
+ 'BizDate' => [
+ 'description' => 'The data timestamp. In most cases, if the monitored business entity is offline data, the value is one day before the monitoring is performed.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '1600704000000',
+ ],
+ 'CheckResult' => [
+ 'description' => 'The check result. The value of this parameter is the same as the value of the CheckResultStatus parameter. Valid values:'."\n"
+ ."\n"
+ .'* 0: indicates that the data source table is normal.'."\n"
+ .'* 1: indicates that a warning alert is reported.'."\n"
+ .'* 2: indicates that a critical alert is reported.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '0',
+ ],
+ 'ResultString' => [
+ 'description' => 'The string of the check result.'."\n",
+ 'type' => 'string',
+ 'example' => 'test',
+ ],
+ 'MatchExpression' => [
+ 'description' => 'The partition filter expression.'."\n",
+ 'type' => 'string',
+ 'example' => 'ds=$[yyyymmdd]',
+ ],
+ 'CheckerType' => [
+ 'description' => 'The check type. Valid values:'."\n"
+ ."\n"
+ .'* 0: indicates that the monitoring is performed based on a fixed value.'."\n"
+ .'* 1: indicates that the monitoring is performed based on a non-fixed value.'."\n"
+ .'* 2: indicates that the monitoring is performed based on a dynamic threshold.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '1',
+ ],
+ 'ProjectName' => [
+ 'description' => 'The name of the compute engine or data source for which data quality is monitored.'."\n",
+ 'type' => 'string',
+ 'example' => 'autotest',
+ ],
+ 'BeginTime' => [
+ 'description' => 'The time when the monitoring started.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '1600704000000',
+ ],
+ 'DateType' => [
+ 'description' => 'The scheduling frequency. In most cases, the value of this parameter is YMD. This value indicates year, month, and day.'."\n",
+ 'type' => 'string',
+ 'example' => 'YMD',
+ ],
+ 'CriticalThreshold' => [
+ 'description' => 'The threshold for a critical alert. The threshold indicates the deviation of the check result from the expected value. You can specify a value for the threshold based on your business requirements. If a monitoring rule is a strong rule and the critical threshold is exceeded, a critical alert is reported and tasks that are associated with the rule are blocked from running.'."\n",
+ 'type' => 'number',
+ 'format' => 'float',
+ 'example' => '0.5',
+ ],
+ 'IsPrediction' => [
+ 'description' => 'Indicates whether the check result is the same as the predicted result. Valid values:'."\n"
+ ."\n"
+ .'* true'."\n"
+ .'* false'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'RuleName' => [
+ 'description' => 'The name of the monitoring rule.'."\n",
+ 'type' => 'string',
+ 'example' => 'The name of the rule.',
+ ],
+ 'CheckerId' => [
+ 'description' => 'The checker ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '7',
+ ],
+ 'DiscreteCheck' => [
+ 'description' => 'Indicates whether the monitoring is discrete monitoring. Valid values:'."\n"
+ ."\n"
+ .'* true'."\n"
+ .'* false'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'EndTime' => [
+ 'description' => 'The deadline for querying the check result.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '1600704000000',
+ ],
+ 'MethodName' => [
+ 'description' => 'The method used to collect sample data, such as such as avg, count, sum, min, max, count_distinct, user_defined, table_count, table_size, table_dt_load_count, table_dt_refuseload_count, null_value, null_value/table_count, (table_count-count_distinct)/table_count, or table_count-count_distinct.'."\n",
+ 'type' => 'string',
+ 'example' => 'count_distinct',
+ ],
+ 'LowerValue' => [
+ 'description' => 'The lower limit of the predicted result. The value of this parameter is automatically generated based on the threshold that you specify.'."\n",
+ 'type' => 'number',
+ 'format' => 'float',
+ 'example' => '2344',
+ ],
+ 'EntityId' => [
+ 'description' => 'The ID of the partition filter expression.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '15432322',
+ ],
+ 'WhereCondition' => [
+ 'description' => 'The filter condition of the monitoring rule.'."\n",
+ 'type' => 'string',
+ 'example' => 'id>0',
+ ],
+ 'ExpectValue' => [
+ 'description' => 'The expected value.'."\n",
+ 'type' => 'number',
+ 'format' => 'float',
+ 'example' => '200',
+ ],
+ 'TemplateId' => [
+ 'description' => 'The ID of the monitoring template.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '5',
+ ],
+ 'TaskId' => [
+ 'description' => 'The monitoring task ID.'."\n",
+ 'type' => 'string',
+ 'example' => '16008552981681a0d6****',
+ ],
+ 'Id' => [
+ 'description' => 'The primary key ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '121212121',
+ ],
+ 'ReferenceValue' => [
+ 'description' => 'The historical sample values.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '',
+ 'type' => 'object',
+ 'properties' => [
+ 'DiscreteProperty' => [
+ 'description' => 'The values of the sample field that are grouped by using the GROUP BY clause. For example, the values of the Gender field are grouped by using the GROUP BY clause. In this case, the values of the DiscreteProperty parameter are Male, Female, and null.'."\n",
+ 'type' => 'string',
+ 'example' => '0',
+ ],
+ 'Value' => [
+ 'description' => 'The check value.'."\n",
+ 'type' => 'number',
+ 'format' => 'float',
+ 'example' => '19',
+ ],
+ 'BizDate' => [
+ 'description' => 'The data timestamp. In most cases, if the monitored business entity is offline data, the value is one day before the monitoring is performed.'."\n",
+ 'type' => 'string',
+ 'example' => '2020-12-03',
+ ],
+ 'SingleCheckResult' => [
+ 'description' => 'The check result.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '0',
+ ],
+ 'Threshold' => [
+ 'description' => 'The threshold.'."\n",
+ 'type' => 'number',
+ 'format' => 'float',
+ 'example' => '0.5',
+ ],
+ ],
+ ],
+ ],
+ 'SampleValue' => [
+ 'description' => 'The current sample value.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '',
+ 'type' => 'object',
+ 'properties' => [
+ 'DiscreteProperty' => [
+ 'description' => 'The values of the sample field that are grouped by using the GROUP BY clause. For example, the values of the Gender field are grouped by using the GROUP BY clause. In this case, the values of the DiscreteProperty parameter are Male, Female, and null.'."\n",
+ 'type' => 'string',
+ 'example' => '0',
+ ],
+ 'BizDate' => [
+ 'description' => 'The data timestamp. In most cases, if the monitored business entity is offline data, the value is one day before the monitoring is performed.'."\n",
+ 'type' => 'string',
+ 'example' => '2020-12-03',
+ ],
+ 'Value' => [
+ 'description' => 'The current sample value.'."\n",
+ 'type' => 'number',
+ 'format' => 'float',
+ 'example' => '19',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"ErrorMessage\\": \\"You have no permission.\\",\\n \\"RequestId\\": \\"CBA58543-00D4-41****\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"401\\",\\n \\"Data\\": {\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 50,\\n \\"RuleChecks\\": [\\n {\\n \\"BlockType\\": 0,\\n \\"WarningThreshold\\": 0.1,\\n \\"Property\\": \\"type\\",\\n \\"TableName\\": \\"dual\\",\\n \\"Comment\\": \\"The description of the rule.\\",\\n \\"CheckResultStatus\\": 0,\\n \\"TemplateName\\": \\"Expected value verification\\",\\n \\"CheckerName\\": \\"fulx\\",\\n \\"RuleId\\": 123123232,\\n \\"FixedCheck\\": false,\\n \\"Op\\": \\">\\",\\n \\"UpperValue\\": 25555,\\n \\"ActualExpression\\": \\"ds=20200912\\",\\n \\"ExternalId\\": \\"1112323123\\",\\n \\"TimeCost\\": \\"202\\",\\n \\"Trend\\": \\"abs\\",\\n \\"ExternalType\\": \\"CWF2\\",\\n \\"BizDate\\": 1600704000000,\\n \\"CheckResult\\": 0,\\n \\"ResultString\\": \\"test\\",\\n \\"MatchExpression\\": \\"ds=$[yyyymmdd]\\",\\n \\"CheckerType\\": 1,\\n \\"ProjectName\\": \\"autotest\\",\\n \\"BeginTime\\": 1600704000000,\\n \\"DateType\\": \\"YMD\\",\\n \\"CriticalThreshold\\": 0.5,\\n \\"IsPrediction\\": true,\\n \\"RuleName\\": \\"The name of the rule.\\",\\n \\"CheckerId\\": 7,\\n \\"DiscreteCheck\\": true,\\n \\"EndTime\\": 1600704000000,\\n \\"MethodName\\": \\"count_distinct\\",\\n \\"LowerValue\\": 2344,\\n \\"EntityId\\": 15432322,\\n \\"WhereCondition\\": \\"id>0\\",\\n \\"ExpectValue\\": 200,\\n \\"TemplateId\\": 5,\\n \\"TaskId\\": \\"16008552981681a0d6****\\",\\n \\"Id\\": 121212121,\\n \\"ReferenceValue\\": [\\n {\\n \\"DiscreteProperty\\": \\"0\\",\\n \\"Value\\": 19,\\n \\"BizDate\\": \\"2020-12-03\\",\\n \\"SingleCheckResult\\": 0,\\n \\"Threshold\\": 0.5\\n }\\n ],\\n \\"SampleValue\\": [\\n {\\n \\"DiscreteProperty\\": \\"0\\",\\n \\"BizDate\\": \\"2020-12-03\\",\\n \\"Value\\": 19\\n }\\n ]\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<ListQualityResultsByEntityResponse>\\n <HttpStatusCode>200</HttpStatusCode>\\n <ErrorMessage>You have no permission.</ErrorMessage>\\n <RequestId>CBA58543-00D4-41****</RequestId>\\n <Success>true</Success>\\n <ErrorCode>401</ErrorCode>\\n <Data>\\n <PageNumber>1</PageNumber>\\n <PageSize>10</PageSize>\\n <TotalCount>50</TotalCount>\\n <RuleChecks>\\n <BlockType>0</BlockType>\\n <WarningThreshold>0.1</WarningThreshold>\\n <Property>type</Property>\\n <TableName>dual</TableName>\\n <Comment>规则的描述信息。</Comment>\\n <CheckResultStatus>0</CheckResultStatus>\\n <TemplateName>字段唯一值个数期望值校验</TemplateName>\\n <CheckerName>fulx</CheckerName>\\n <RuleId>123123232</RuleId>\\n <FixedCheck>false</FixedCheck>\\n <Op>&gt;</Op>\\n <UpperValue>25555</UpperValue>\\n <ActualExpression>ds=20200912</ActualExpression>\\n <ExternalId>1112323123</ExternalId>\\n <TimeCost>202</TimeCost>\\n <Trend>abs</Trend>\\n <ExternalType>CWF2</ExternalType>\\n <BizDate>1600704000000</BizDate>\\n <CheckResult>0</CheckResult>\\n <ResultString>test</ResultString>\\n <MatchExpression>ds=$[yyyymmdd]</MatchExpression>\\n <CheckerType>1</CheckerType>\\n <ProjectName>autotest</ProjectName>\\n <BeginTime>1600704000000</BeginTime>\\n <DateType>YMD</DateType>\\n <CriticalThreshold>0.5</CriticalThreshold>\\n <IsPrediction>true</IsPrediction>\\n <RuleName>规则的名称。</RuleName>\\n <CheckerId>7</CheckerId>\\n <DiscreteCheck>true</DiscreteCheck>\\n <EndTime>1600704000000</EndTime>\\n <MethodName>count_distinct</MethodName>\\n <LowerValue>2344</LowerValue>\\n <EntityId>15432322</EntityId>\\n <WhereCondition>id&gt;0</WhereCondition>\\n <ExpectValue>200</ExpectValue>\\n <TemplateId>5</TemplateId>\\n <TaskId>16008552981681a0d6****</TaskId>\\n <Id>121212121</Id>\\n <ReferenceValue>\\n <DiscreteProperty>0</DiscreteProperty>\\n <Value>19</Value>\\n <BizDate>2020-12-03</BizDate>\\n <SingleCheckResult>0</SingleCheckResult>\\n <Threshold>0.5</Threshold>\\n </ReferenceValue>\\n <SampleValue>\\n <DiscreteProperty>0</DiscreteProperty>\\n <BizDate>2020-12-03</BizDate>\\n <Value>19</Value>\\n </SampleValue>\\n </RuleChecks>\\n </Data>\\n</ListQualityResultsByEntityResponse>","errorExample":""}]',
+ 'title' => 'ListQualityResultsByEntity',
+ 'summary' => 'Queries a list of historical check results based on a partition filter expression.',
+ 'description' => '****',
+ 'requestParamsDescription' => ' ',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ ],
+ 'ListQualityResultsByRule' => [
+ 'methods' => [
+ 'post',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'get',
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'RuleId',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The monitoring rule ID. You can use the ID and information such as a partition filter expression to perform a joint query.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => true,
+ 'docRequired' => true,
+ 'maximum' => '2147483647',
+ 'minimum' => '1',
+ 'example' => '152322134',
+ ],
+ ],
+ [
+ 'name' => 'StartDate',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The beginning of the time range to query. Specify the time in the yyyy-MM-dd HH:mm:ss format.'."\n"
+ ."\n"
+ .'This parameter is used together with the EndDate parameter. The interval between the time specified by this parameter and the time specified by the EndDate parameter cannot exceed 7 days.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => '2020-09-20 00:00:00',
+ ],
+ ],
+ [
+ 'name' => 'EndDate',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The end of the time range to query. Specify the time in the yyyy-MM-dd HH:mm:ss format.'."\n"
+ ."\n"
+ .'This parameter is used together with the StartDate parameter. The interval between the time specified by this parameter and the time specified by the StartDate parameter cannot exceed 7 days.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => '2020-09-22 00:00:00',
+ ],
+ ],
+ [
+ 'name' => 'PageSize',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The number of entries per page. Default value: 10. Maximum value: 100.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => true,
+ 'docRequired' => true,
+ 'maximum' => '20',
+ 'minimum' => '1',
+ 'example' => '10',
+ ],
+ ],
+ [
+ 'name' => 'PageNumber',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The page number.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => true,
+ 'docRequired' => true,
+ 'maximum' => '2147483647',
+ 'minimum' => '1',
+ 'example' => '1',
+ ],
+ ],
+ [
+ 'name' => 'ProjectName',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The name of the compute engine or data source for which data quality is monitored.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'autotest',
+ ],
+ ],
+ [
+ 'name' => 'ProjectId',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The DataWorks workspace ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => '12345',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'description' => 'The returned result.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'HttpStatusCode' => [
+ 'description' => 'The HTTP status code.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '200',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message.'."\n",
+ 'type' => 'string',
+ 'example' => 'You have no permission.',
+ ],
+ 'RequestId' => [
+ 'description' => 'The request ID.'."\n",
+ 'type' => 'string',
+ 'example' => 'CBA58543-00D4-41****',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code.'."\n",
+ 'type' => 'string',
+ 'example' => '401',
+ ],
+ 'Success' => [
+ 'description' => 'Indicates whether the request was successful.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'Data' => [
+ 'description' => 'The data structure of the monitoring results returned.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'PageNumber' => [
+ 'description' => 'The page number.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '1',
+ ],
+ 'PageSize' => [
+ 'description' => 'The number of entries per page. Default value: 10. Maximum value: 100.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '10',
+ ],
+ 'TotalCount' => [
+ 'description' => 'The total number of entries returned.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '200',
+ ],
+ 'RuleChecks' => [
+ 'description' => 'The returned monitoring results.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The returned result.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'BlockType' => [
+ 'description' => 'The strength of the monitoring rule. The strength of a monitoring rule indicates the importance of the rule. Valid values:'."\n"
+ ."\n"
+ .'* 1: indicates that the monitoring rule is a strong rule.'."\n"
+ .'* 0: indicates that the monitoring rule is a weak rule. You can specify the strength of a monitoring rule based on your business requirements. If a monitoring rule is a strong rule and the critical threshold is exceeded, a critical alert is reported and tasks that are associated with the rule are blocked from running.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '1',
+ ],
+ 'WarningThreshold' => [
+ 'description' => 'The threshold for a warning alert. The threshold specifies the deviation of the monitoring result from the expected value. You can specify a custom value for the threshold based on your business requirements.'."\n",
+ 'type' => 'number',
+ 'format' => 'float',
+ 'example' => '0.1',
+ ],
+ 'Property' => [
+ 'description' => 'The field whose data quality is checked based on the monitoring rule. This field is a column in the data source table that is monitored.'."\n",
+ 'type' => 'string',
+ 'example' => 'type',
+ ],
+ 'TableName' => [
+ 'description' => 'The name of the table that is monitored.'."\n",
+ 'type' => 'string',
+ 'example' => 'dual',
+ ],
+ 'Comment' => [
+ 'description' => 'The description of the monitoring rule.'."\n",
+ 'type' => 'string',
+ 'example' => 'The description of the rule.',
+ ],
+ 'CheckResultStatus' => [
+ 'description' => 'The status of the monitoring result.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '2',
+ ],
+ 'TemplateName' => [
+ 'description' => 'The name of the monitoring template.'."\n",
+ 'type' => 'string',
+ 'example' => 'Expected value verification',
+ ],
+ 'CheckerName' => [
+ 'description' => 'The name of the checker.'."\n",
+ 'type' => 'string',
+ 'example' => 'fulx',
+ ],
+ 'RuleId' => [
+ 'description' => 'The ID of the monitoring rule.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '123421',
+ ],
+ 'FixedCheck' => [
+ 'description' => 'Indicates whether the monitoring is performed based on a fixed value. Valid values:'."\n"
+ ."\n"
+ .'* true'."\n"
+ .'* false'."\n",
+ 'type' => 'boolean',
+ 'example' => 'false',
+ ],
+ 'Op' => [
+ 'description' => 'The comparison operator.'."\n",
+ 'type' => 'string',
+ 'example' => '>',
+ ],
+ 'UpperValue' => [
+ 'description' => 'The upper limit of the predicted result. The value of this parameter is automatically generated based on the threshold that you specify.'."\n",
+ 'type' => 'number',
+ 'format' => 'float',
+ 'example' => '22200',
+ ],
+ 'ActualExpression' => [
+ 'description' => 'The partition in the monitored data source table.'."\n",
+ 'type' => 'string',
+ 'example' => 'ds=20200925',
+ ],
+ 'ExternalId' => [
+ 'description' => 'The node ID.'."\n",
+ 'type' => 'string',
+ 'example' => '123112232',
+ ],
+ 'TimeCost' => [
+ 'description' => 'The time that was taken to run the monitoring task.'."\n",
+ 'type' => 'string',
+ 'example' => '10',
+ ],
+ 'Trend' => [
+ 'description' => 'The trend of the monitoring result.'."\n",
+ 'type' => 'string',
+ 'example' => 'up',
+ ],
+ 'ExternalType' => [
+ 'description' => 'The type of the scheduling system. Only CWF scheduling systems are supported.'."\n",
+ 'type' => 'string',
+ 'example' => 'CWF2',
+ ],
+ 'BizDate' => [
+ 'description' => 'The data timestamp. If the monitored business entity is offline data, the value is usually one day before the monitoring is performed.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '1600704000000',
+ ],
+ 'CheckResult' => [
+ 'description' => 'The monitoring result.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '2',
+ ],
+ 'ResultString' => [
+ 'description' => 'The string of the monitoring result.'."\n",
+ 'type' => 'string',
+ 'example' => 'ResultString',
+ ],
+ 'MatchExpression' => [
+ 'description' => 'The partition filter expression.'."\n",
+ 'type' => 'string',
+ 'example' => 'ds=$[yyyymmdd]',
+ ],
+ 'CheckerType' => [
+ 'description' => 'The type of the checker.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '0',
+ ],
+ 'ProjectName' => [
+ 'description' => 'The name of the compute engine or data source for which data quality is monitored.'."\n",
+ 'type' => 'string',
+ 'example' => 'autotest',
+ ],
+ 'BeginTime' => [
+ 'description' => 'The time when the monitoring started.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '1600704000000',
+ ],
+ 'DateType' => [
+ 'description' => 'The scheduling frequency. In most cases, the value of this parameter is YMD. This value indicates year, month, and day.'."\n",
+ 'type' => 'string',
+ 'example' => 'YMD',
+ ],
+ 'CriticalThreshold' => [
+ 'description' => 'The threshold for a critical alert. The threshold indicates the deviation of the monitoring result from the expected value. You can specify a custom value for the threshold based on your business requirements. If a monitoring rule is a strong rule and the critical threshold is exceeded, a critical alert is reported and tasks that are associated with the rule are blocked from running.'."\n",
+ 'type' => 'number',
+ 'format' => 'float',
+ 'example' => '0.6',
+ ],
+ 'IsPrediction' => [
+ 'description' => 'Indicates whether the monitoring result is the same as the predicted result. Valid values:'."\n"
+ ."\n"
+ .'* true'."\n"
+ .'* false'."\n",
+ 'type' => 'boolean',
+ 'example' => 'false',
+ ],
+ 'RuleName' => [
+ 'description' => 'The name of the monitoring rule.'."\n",
+ 'type' => 'string',
+ 'example' => 'The name of the rule.',
+ ],
+ 'CheckerId' => [
+ 'description' => 'The checker ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '7',
+ ],
+ 'DiscreteCheck' => [
+ 'description' => 'Indicates whether the monitoring is discrete monitoring. Valid values:'."\n"
+ ."\n"
+ .'* true'."\n"
+ .'* false'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'EndTime' => [
+ 'description' => 'The time when the monitoring ended.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '1600704000000',
+ ],
+ 'MethodName' => [
+ 'description' => 'The method used to collect sample data, such as such as avg, count, sum, min, max, count_distinct, user_defined, table_count, table_size, table_dt_load_count, table_dt_refuseload_count, null_value, null_value/table_count, (table_count-count_distinct)/table_count, or table_count-count_distinct.'."\n",
+ 'type' => 'string',
+ 'example' => 'max',
+ ],
+ 'LowerValue' => [
+ 'description' => 'The lower limit of the predicted result. The value of this parameter is automatically generated based on the threshold that you specify.'."\n",
+ 'type' => 'number',
+ 'format' => 'float',
+ 'example' => '2344',
+ ],
+ 'EntityId' => [
+ 'description' => 'The ID of the partition filter expression.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '14534343',
+ ],
+ 'WhereCondition' => [
+ 'description' => 'The filter condition of the monitoring task.'."\n",
+ 'type' => 'string',
+ 'example' => 'type!=\'type2\'',
+ ],
+ 'ExpectValue' => [
+ 'description' => 'The expected value.'."\n",
+ 'type' => 'number',
+ 'format' => 'float',
+ 'example' => '90',
+ ],
+ 'TemplateId' => [
+ 'description' => 'The ID of the monitoring template.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '5',
+ ],
+ 'TaskId' => [
+ 'description' => 'The monitoring task ID.'."\n",
+ 'type' => 'string',
+ 'example' => '16008552981681a0d6****',
+ ],
+ 'Id' => [
+ 'description' => 'The primary key ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '2231123',
+ ],
+ 'ReferenceValue' => [
+ 'description' => 'The historical sample values.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '',
+ 'type' => 'object',
+ 'properties' => [
+ 'DiscreteProperty' => [
+ 'description' => 'The values of the sample field that are grouped by using the GROUP BY clause. For example, the values of the Gender field are grouped by using the GROUP BY clause. In this case, the values of DiscreteProperty are Male, Female, and null.'."\n",
+ 'type' => 'string',
+ 'example' => 'type1',
+ ],
+ 'Value' => [
+ 'description' => 'The sample value.'."\n",
+ 'type' => 'number',
+ 'format' => 'float',
+ 'example' => '20',
+ ],
+ 'BizDate' => [
+ 'description' => 'The data timestamp. If the monitored business entity is offline data, the value is usually one day before the monitoring is performed.'."\n",
+ 'type' => 'string',
+ 'example' => '1600704000000',
+ ],
+ 'SingleCheckResult' => [
+ 'description' => 'The string of the monitoring result.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '2',
+ ],
+ 'Threshold' => [
+ 'description' => 'The threshold.'."\n",
+ 'type' => 'number',
+ 'format' => 'float',
+ 'example' => '0.2',
+ ],
+ ],
+ ],
+ ],
+ 'SampleValue' => [
+ 'description' => 'The current sample values.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '',
+ 'type' => 'object',
+ 'properties' => [
+ 'DiscreteProperty' => [
+ 'description' => 'The values of the sample field that are grouped by using the GROUP BY clause. For example, the values of the Gender field are grouped by using the GROUP BY clause. In this case, the values of DiscreteProperty are Male, Female, and null.'."\n",
+ 'type' => 'string',
+ 'example' => 'type2',
+ ],
+ 'BizDate' => [
+ 'description' => 'The data timestamp. If the monitored business entity is offline data, the value is usually one day before the monitoring is performed.'."\n",
+ 'type' => 'string',
+ 'example' => '1600704000000',
+ ],
+ 'Value' => [
+ 'description' => 'The sample value.'."\n",
+ 'type' => 'number',
+ 'format' => 'float',
+ 'example' => '23',
+ ],
+ ],
+ ],
+ ],
+ 'Open' => [
+ 'description' => 'Indicates whether the monitoring rule is enabled.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"ErrorMessage\\": \\"You have no permission.\\",\\n \\"RequestId\\": \\"CBA58543-00D4-41****\\",\\n \\"ErrorCode\\": \\"401\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 200,\\n \\"RuleChecks\\": [\\n {\\n \\"BlockType\\": 1,\\n \\"WarningThreshold\\": 0.1,\\n \\"Property\\": \\"type\\",\\n \\"TableName\\": \\"dual\\",\\n \\"Comment\\": \\"The description of the rule.\\",\\n \\"CheckResultStatus\\": 2,\\n \\"TemplateName\\": \\"Expected value verification\\",\\n \\"CheckerName\\": \\"fulx\\",\\n \\"RuleId\\": 123421,\\n \\"FixedCheck\\": false,\\n \\"Op\\": \\">\\",\\n \\"UpperValue\\": 22200,\\n \\"ActualExpression\\": \\"ds=20200925\\",\\n \\"ExternalId\\": \\"123112232\\",\\n \\"TimeCost\\": \\"10\\",\\n \\"Trend\\": \\"up\\",\\n \\"ExternalType\\": \\"CWF2\\",\\n \\"BizDate\\": 1600704000000,\\n \\"CheckResult\\": 2,\\n \\"ResultString\\": \\"ResultString\\",\\n \\"MatchExpression\\": \\"ds=$[yyyymmdd]\\",\\n \\"CheckerType\\": 0,\\n \\"ProjectName\\": \\"autotest\\",\\n \\"BeginTime\\": 1600704000000,\\n \\"DateType\\": \\"YMD\\",\\n \\"CriticalThreshold\\": 0.6,\\n \\"IsPrediction\\": false,\\n \\"RuleName\\": \\"The name of the rule.\\",\\n \\"CheckerId\\": 7,\\n \\"DiscreteCheck\\": true,\\n \\"EndTime\\": 1600704000000,\\n \\"MethodName\\": \\"max\\",\\n \\"LowerValue\\": 2344,\\n \\"EntityId\\": 14534343,\\n \\"WhereCondition\\": \\"type!=\'type2\'\\",\\n \\"ExpectValue\\": 90,\\n \\"TemplateId\\": 5,\\n \\"TaskId\\": \\"16008552981681a0d6****\\",\\n \\"Id\\": 2231123,\\n \\"ReferenceValue\\": [\\n {\\n \\"DiscreteProperty\\": \\"type1\\",\\n \\"Value\\": 20,\\n \\"BizDate\\": \\"1600704000000\\",\\n \\"SingleCheckResult\\": 2,\\n \\"Threshold\\": 0.2\\n }\\n ],\\n \\"SampleValue\\": [\\n {\\n \\"DiscreteProperty\\": \\"type2\\",\\n \\"BizDate\\": \\"1600704000000\\",\\n \\"Value\\": 23\\n }\\n ],\\n \\"Open\\": true\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<ListQualityResultsByRuleResponse>\\n <RequestId>CBA58543-00D4-41****</RequestId>\\n <QualityResults>\\n <TotalCount>200</TotalCount>\\n <PageSize>10</PageSize>\\n <PageNumber>1</PageNumber>\\n <RuleChecks>\\n <Op>&amp;gt;</Op>\\n <TaskId>16008552981681a0d6****</TaskId>\\n <EndTime>1600704000000</EndTime>\\n <DiscreteCheck>true</DiscreteCheck>\\n <CheckerName>fulx</CheckerName>\\n <ExpectValue>90</ExpectValue>\\n <ProjectName>autotest</ProjectName>\\n <RuleId>123421</RuleId>\\n <WarningThreshold>0.1</WarningThreshold>\\n <WhereCondition>type!=\'type2\'</WhereCondition>\\n <BeginTime>1600704000000</BeginTime>\\n <CheckResultStatus>2</CheckResultStatus>\\n <MatchExpression>ds=$[yyyymmdd]</MatchExpression>\\n <UpperValue>22200</UpperValue>\\n <IsPrediction>false</IsPrediction>\\n <CheckResult>2</CheckResult>\\n <TemplateName>字段唯一值个数期望值校验</TemplateName>\\n <TimeCost>10</TimeCost>\\n <FixedCheck>false</FixedCheck>\\n <MethodName>max</MethodName>\\n <ResultString>ResultString</ResultString>\\n <Property>type</Property>\\n <DateType>YMD</DateType>\\n <BizDate>1600704000000</BizDate>\\n <TemplateId>5</TemplateId>\\n <RuleName>这里是规则名称</RuleName>\\n <Comment>这里是规则描述信息</Comment>\\n <CriticalThreshold>0.6</CriticalThreshold>\\n <ExternalId>123112232</ExternalId>\\n <Trend>up</Trend>\\n <CheckerType>0</CheckerType>\\n <ExternalType>CWF2</ExternalType>\\n <CheckerId>7</CheckerId>\\n <EntityId>14534343</EntityId>\\n <TableName>dual</TableName>\\n <BlockType>1</BlockType>\\n <Id>2231123</Id>\\n <ActualExpression>ds=20200925</ActualExpression>\\n <LowerValue>2344</LowerValue>\\n </RuleChecks>\\n <RuleChecks>\\n <SampleValue>\\n <SingleCheckResult>2</SingleCheckResult>\\n <Value>20</Value>\\n <BizDate>1600704000000</BizDate>\\n <DiscreteProperty>type1</DiscreteProperty>\\n <Threshold>0.2</Threshold>\\n </SampleValue>\\n <SampleValue>\\n <Value>23</Value>\\n <BizDate>1600704000000</BizDate>\\n <DiscreteProperty>type2</DiscreteProperty>\\n </SampleValue>\\n <ReferenceValue>\\n <SingleCheckResult>2</SingleCheckResult>\\n <Value>20</Value>\\n <BizDate>1600704000000</BizDate>\\n <DiscreteProperty>type1</DiscreteProperty>\\n <Threshold>0.2</Threshold>\\n </ReferenceValue>\\n <ReferenceValue>\\n <Value>23</Value>\\n <BizDate>1600704000000</BizDate>\\n <DiscreteProperty>type2</DiscreteProperty>\\n </ReferenceValue>\\n </RuleChecks>\\n </QualityResults>\\n</ListQualityResultsByRuleResponse>","errorExample":""}]',
+ 'title' => 'ListQualityResultsByRule',
+ 'summary' => 'Queries monitoring results after the data quality of a data source or a compute engine is monitored based on monitoring rules.',
+ 'requestParamsDescription' => ' ',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ ],
+ 'CreateDataServiceApi' => [
+ 'methods' => [
+ 'post',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'write',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'create',
+ 'abilityTreeCode' => '78179',
+ 'abilityTreeNodes' => [
+ 'FEATUREdideZZ63WZ',
+ ],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'TenantId',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The tenant ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'docRequired' => false,
+ 'example' => '10001',
+ ],
+ ],
+ [
+ 'name' => 'ProjectId',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The workspace ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => '10000',
+ ],
+ ],
+ [
+ 'name' => 'ApiName',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The name of the API. The name must be 4 to 50 characters in length. The name can contain letters, digits, and underscores (\\_) and must start with a letter.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'Test API name'."\n",
+ ],
+ ],
+ [
+ 'name' => 'GroupId',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The business process ID.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'Business process ID',
+ ],
+ ],
+ [
+ 'name' => 'ApiMode',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The type of the API. Valid values: 0, 1, and 2. The value 0 indicates that the API is generated in wizard mode. The value 1 indicates that the API is generated in script mode. The value 2 indicates that the API is generated by registration.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => '0',
+ ],
+ ],
+ [
+ 'name' => 'RequestMethod',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The request method of the API. Valid values: 0, 1, 2, and 3. The value 0 indicates the GET method. The value 1 indicates the POST method. The value 2 indicates the PUT method. The value 3 indicates the DELETE method. APIs generated in wizard or script mode support the GET and POST methods. APIs generated by registration support the GET, POST, PUT, and DELETE methods.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => '0',
+ ],
+ ],
+ [
+ 'name' => 'ResponseContentType',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The format in which the response of the API request is returned. Valid values: 0 and 1. The value 0 indicates the JSON format. The value 1 indicates the XML format. APIs generated in wizard or script mode support the JSON format. APIs generated by registration support the JSON and XML formats.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => '0',
+ ],
+ ],
+ [
+ 'name' => 'Timeout',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The timeout period of the API request. Unit: milliseconds. Valid values: (0,30000].'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => '10000',
+ ],
+ ],
+ [
+ 'name' => 'VisibleRange',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The scope in which the API is visible. Valid values: 0 and 1. The value 0 indicates that the API is visible to all members in the workspace. The value 1 indicates that the API is visible only to its owner.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => '0',
+ ],
+ ],
+ [
+ 'name' => 'Protocols',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The protocol used by the API. Valid values: 0 and 1. The value 0 indicates HTTP. The value 1 indicates HTTPS. You can specify multiple protocols. Separate them with commas (,).'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => '0,1',
+ ],
+ ],
+ [
+ 'name' => 'WizardDetails',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The details of the API generated in wizard mode. For more information, see the WizardDetails parameter returned by the [GetDataServiceApi](~~174013~~) operation.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => '{"isPagedResponse":true,"wizardConnection":{"connectionId":122786,"tableName":"person"},"wizardRequestParameters":[{"columnName":"id","defaultValue":"","exampleValue":"1","isRequiredParameter":true,"parameterDataType":2,"parameterDescription":"","parameterName":"id","parameterOperator":0,"parameterPosition":0}],"wizardResponseParameters":[{"columnName":"id","exampleValue":"11","parameterDataType":2,"parameterDescription":"","parameterName":"id"}]}',
+ ],
+ ],
+ [
+ 'name' => 'ScriptDetails',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The details of the API generated in script mode. For more information, see the scriptDetails parameter returned by the [GetDataServiceApi](~~174013~~) operation.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => '{"isPagedResponse":false,"script":"select id as id1, name as name1 from person where id=${inputid}","scriptConnection":{"connectionId":122786,"tableName":"person"},"scriptRequestParameters":[{"defaultValue":"","exampleValue":"","isRequiredParameter":true,"parameterDataType":0,"parameterDescription":"","parameterName":"inputid","parameterOperator":0,"parameterPosition":1}],"scriptResponseParameters":[{"exampleValue":"","parameterDataType":0,"parameterDescription":"","parameterName":"id1"},{"exampleValue":"","parameterDataType":0,"parameterDescription":"","parameterName":"name1"}]}',
+ ],
+ ],
+ [
+ 'name' => 'RegistrationDetails',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The details of the API generated by registration. For more information, see the registrationDetails parameter returned by the [GetDataServiceApi](~~174013~~) operation.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => '{"failedResultSample":"fail","registrationErrorCodes":[{"errorCode":"e1","errorMessage":"msg1","errorSolution":"sol1"},{"errorCode":"e2","errorMessage":"msg2","errorSolution":"sol2"}],"registrationRequestParameters":[{"columnName":"","defaultValue":"","exampleValue":"","isRequiredParameter":true,"parameterDataType":0,"parameterDescription":"","parameterName":"id","parameterOperator":0,"parameterPosition":1},{"columnName":"","defaultValue":"xx","exampleValue":"","isRequiredParameter":true,"parameterDataType":0,"parameterDescription":"","parameterName":"cc","parameterOperator":2,"parameterPosition":2}],"serviceContentType":1,"serviceHost":"http://www.baidu.com","servicePath":"/[uid]","serviceRequestBodyDescription":"body","successfulResultSample":"success"}',
+ ],
+ ],
+ [
+ 'name' => 'ApiPath',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The path of the API. The path cannot exceed 200 characters in length. The path can contain letters, digits, underscores (\\_), and hyphens (-) and must start with a forward slash (/).'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => '/test/1',
+ ],
+ ],
+ [
+ 'name' => 'ApiDescription',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The description of the API.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'Test API description',
+ ],
+ ],
+ [
+ 'name' => 'FolderId',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The ID of the folder used to store the API. The ID of the root folder in a business process is 0. The ID of the folder created by a user must be greater than 0.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'maximum' => '9223372036854775807',
+ 'minimum' => '0',
+ 'example' => '0',
+ ],
+ ],
+ [
+ 'name' => 'SqlMode',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => '* The SQL mode. Valid values: 0: The basic mode is used.'."\n"
+ .'* 1: Mybatis is used.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'example' => '0',
+ ],
+ ],
+ [
+ 'name' => 'ResourceGroupId',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The ID of the exclusive resource group.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'example' => '3242432423',
+ ],
+ ],
+ [
+ 'name' => 'RequestContentType',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The format of the data to be requested. Valid values:'."\n"
+ ."\n"
+ .'* 0: XML format'."\n"
+ .'* 1: JSON format'."\n"
+ .'* 2: form format'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => false,
+ 'enumValueTitles' => [],
+ 'example' => '0',
+ 'enum' => [
+ '0',
+ '1',
+ '2',
+ ],
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'HttpStatusCode' => [
+ 'description' => 'The HTTP status code.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '200',
+ ],
+ 'Data' => [
+ 'description' => 'The ID of the API.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '100003',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message.'."\n",
+ 'type' => 'string',
+ 'example' => 'The connection does not exist.',
+ ],
+ 'RequestId' => [
+ 'description' => 'The request ID.'."\n",
+ 'type' => 'string',
+ 'example' => '0000-ABCD-EFG****',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code.'."\n",
+ 'type' => 'string',
+ 'example' => 'Invalid.Tenant.ConnectionNotExists',
+ ],
+ 'Success' => [
+ 'description' => 'Indicates whether the request was successful.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ ],
+ 'description' => '',
+ ],
+ ],
+ ],
+ 'errorCodes' => [
+ 403 => [
+ [
+ 'errorCode' => 'Forbidden.Access',
+ 'errorMessage' => 'Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.',
+ ],
+ ],
+ 429 => [
+ [
+ 'errorCode' => 'Throttling.Api',
+ 'errorMessage' => 'The request for this resource has exceeded your available limit.',
+ ],
+ [
+ 'errorCode' => 'Throttling.System',
+ 'errorMessage' => 'The DataWorks system is busy. Try again later.',
+ ],
+ [
+ 'errorCode' => 'Throttling.User',
+ 'errorMessage' => 'Your request is too frequent. Try again later.',
+ ],
+ ],
+ 500 => [
+ [
+ 'errorCode' => 'InternalError.System',
+ 'errorMessage' => 'An internal system error occurred. Try again later.',
+ ],
+ [
+ 'errorCode' => 'InternalError.UserId.Missing',
+ 'errorMessage' => 'An internal system error occurred. Try again later.',
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Data\\": 100003,\\n \\"ErrorMessage\\": \\"The connection does not exist.\\",\\n \\"RequestId\\": \\"0000-ABCD-EFG****\\",\\n \\"ErrorCode\\": \\"Invalid.Tenant.ConnectionNotExists\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<CreateDataServiceApiResponse>\\n <HttpStatusCode>200</HttpStatusCode>\\n <Data>100003</Data>\\n <ErrorMessage>The connection does not exist.</ErrorMessage>\\n <RequestId>0000-ABCD-EFG****</RequestId>\\n <ErrorCode>Invalid.Tenant.ConnectionNotExists</ErrorCode>\\n <Success>true</Success>\\n</CreateDataServiceApiResponse>","errorExample":""}]',
+ 'title' => 'CreateDataServiceApi',
+ 'summary' => 'Creates an API.',
+ 'requestParamsDescription' => ' ',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ ],
+ 'PublishDataServiceApi' => [
+ 'methods' => [
+ 'post',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'write',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'create',
+ 'abilityTreeCode' => '78339',
+ 'abilityTreeNodes' => [
+ 'FEATUREdideZZ63WZ',
+ ],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'TenantId',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The tenant ID. To obtain the tenant ID, perform the following steps: Log on to the [DataWorks console](https://workbench.data.aliyun.com/console). Find your workspace and go to the DataStudio page. On the DataStudio page, click the logon username in the upper-right corner and click User Info in the Menu section.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'docRequired' => false,
+ 'example' => '10002',
+ ],
+ ],
+ [
+ 'name' => 'ProjectId',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The workspace ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => '10001',
+ ],
+ ],
+ [
+ 'name' => 'ApiId',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The API ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => '10000',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'HttpStatusCode' => [
+ 'description' => 'The HTTP status code.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '200',
+ ],
+ 'Data' => [
+ 'description' => 'Indicates whether the API was published.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message.'."\n",
+ 'type' => 'string',
+ 'example' => 'The connection does not exist.',
+ ],
+ 'RequestId' => [
+ 'description' => 'The request ID.'."\n",
+ 'type' => 'string',
+ 'example' => '0000-ABCD-EFG****',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code.'."\n",
+ 'type' => 'string',
+ 'example' => 'Invalid.Tenant.ConnectionNotExists',
+ ],
+ 'Success' => [
+ 'description' => 'Indicates whether the request was successful.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ ],
+ 'description' => '',
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Data\\": true,\\n \\"ErrorMessage\\": \\"The connection does not exist.\\",\\n \\"RequestId\\": \\"0000-ABCD-EFG****\\",\\n \\"ErrorCode\\": \\"Invalid.Tenant.ConnectionNotExists\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<PublishDataServiceApiResponse>\\n <HttpStatusCode>200</HttpStatusCode>\\n <Data>true</Data>\\n <ErrorMessage>The connection does not exist.</ErrorMessage>\\n <RequestId>0000-ABCD-EFG****</RequestId>\\n <ErrorCode>Invalid.Tenant.ConnectionNotExists</ErrorCode>\\n <Success>true</Success>\\n</PublishDataServiceApiResponse>","errorExample":""}]',
+ 'title' => 'PublishDataServiceApi',
+ 'summary' => 'Publishes an API.',
+ 'requestParamsDescription' => ' ',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ ],
+ 'DeleteDataServiceApi' => [
+ 'methods' => [
+ 'post',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'write',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'delete',
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'TenantId',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The tenant ID. To obtain the tenant ID, perform the following steps: Log on to the [DataWorks console](https://workbench.data.aliyun.com/console). Find your workspace and go to the DataStudio page. On the DataStudio page, click the logon username in the upper-right corner and click User Info in the Menu section.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'docRequired' => false,
+ 'example' => '10002',
+ ],
+ ],
+ [
+ 'name' => 'ProjectId',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The ID of the workspace.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => '10001',
+ ],
+ ],
+ [
+ 'name' => 'ApiId',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The ID of the API in DataService Studio.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => '10000',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'HttpStatusCode' => [
+ 'description' => 'The HTTP status code.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '200',
+ ],
+ 'Data' => [
+ 'description' => 'Indicates whether the API was deleted.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message.'."\n",
+ 'type' => 'string',
+ 'example' => 'The connection does not exist.',
+ ],
+ 'RequestId' => [
+ 'description' => 'The request ID.'."\n",
+ 'type' => 'string',
+ 'example' => '0000-ABCD-EFG****',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code.'."\n",
+ 'type' => 'string',
+ 'example' => 'Invalid.Tenant.ConnectionNotExists',
+ ],
+ 'Success' => [
+ 'description' => 'Indicates whether the request was successful.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ ],
+ 'description' => '',
+ ],
+ ],
+ ],
+ 'errorCodes' => [
+ 403 => [
+ [
+ 'errorCode' => 'Forbidden.Access',
+ 'errorMessage' => 'Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.',
+ ],
+ ],
+ 429 => [
+ [
+ 'errorCode' => 'Throttling.Api',
+ 'errorMessage' => 'The request for this resource has exceeded your available limit.',
+ ],
+ [
+ 'errorCode' => 'Throttling.System',
+ 'errorMessage' => 'The DataWorks system is busy. Try again later.',
+ ],
+ [
+ 'errorCode' => 'Throttling.User',
+ 'errorMessage' => 'Your request is too frequent. Try again later.',
+ ],
+ ],
+ 500 => [
+ [
+ 'errorCode' => 'InternalError.System',
+ 'errorMessage' => 'An internal system error occurred. Try again later.',
+ ],
+ [
+ 'errorCode' => 'InternalError.UserId.Missing',
+ 'errorMessage' => 'An internal system error occurred. Try again later.',
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Data\\": true,\\n \\"ErrorMessage\\": \\"The connection does not exist.\\",\\n \\"RequestId\\": \\"0000-ABCD-EFG****\\",\\n \\"ErrorCode\\": \\"Invalid.Tenant.ConnectionNotExists\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<DeleteDataServiceApiResponse>\\n <HttpStatusCode>200</HttpStatusCode>\\n <Data>true</Data>\\n <ErrorMessage>The connection does not exist.</ErrorMessage>\\n <RequestId>0000-ABCD-EFG****</RequestId>\\n <ErrorCode>Invalid.Tenant.ConnectionNotExists</ErrorCode>\\n <Success>true</Success>\\n</DeleteDataServiceApiResponse>","errorExample":""}]',
+ 'title' => 'DeleteDataServiceApi',
+ 'summary' => 'Deletes an API in DataService Studio.',
+ 'requestParamsDescription' => ' ',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ ],
+ 'ListDataServiceApis' => [
+ 'methods' => [
+ 'post',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'get',
+ 'abilityTreeCode' => '78301',
+ 'abilityTreeNodes' => [
+ 'FEATUREdide7T0EJX',
+ ],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'PageNumber',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The page number. Pages start from page 1. Default value: 1.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => false,
+ 'docRequired' => true,
+ 'minimum' => '1',
+ 'example' => '1',
+ 'default' => '1',
+ ],
+ ],
+ [
+ 'name' => 'PageSize',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The number of entries per page. Valid values: 1 to 100. Default value: 10.',
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => false,
+ 'docRequired' => true,
+ 'maximum' => '50',
+ 'minimum' => '1',
+ 'example' => '10',
+ 'default' => '10',
+ ],
+ ],
+ [
+ 'name' => 'ProjectId',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The workspace ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => '10000',
+ ],
+ ],
+ [
+ 'name' => 'TenantId',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The tenant ID. To obtain the tenant ID, perform the following steps: Log on to the [DataWorks console](https://workbench.data.aliyun.com/console). Find your workspace and go to the DataStudio page. On the DataStudio page, click the logon username in the upper-right corner and click User Info in the Menu section.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'docRequired' => false,
+ 'example' => '10001',
+ ],
+ ],
+ [
+ 'name' => 'ApiNameKeyword',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The keyword in API names. The keyword is used to search for the APIs whose names contain the keyword.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'My API name',
+ ],
+ ],
+ [
+ 'name' => 'ApiPathKeyword',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The keyword in API paths. The keyword is used to search for the APIs whose paths contain the keyword.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => '/test/',
+ ],
+ ],
+ [
+ 'name' => 'CreatorId',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The ID of the Alibaba Cloud account used by the creator of the APIs. The ID is used to search for the APIs created by the creator.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => '12345',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'description' => 'The response parameters.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'HttpStatusCode' => [
+ 'description' => 'The HTTP status code.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '200',
+ ],
+ 'RequestId' => [
+ 'description' => 'The request ID.'."\n",
+ 'type' => 'string',
+ 'example' => '0000-ABCD-EFG****',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message.'."\n",
+ 'type' => 'string',
+ 'example' => 'The connection does not exist.',
+ ],
+ 'Success' => [
+ 'description' => 'Indicates whether the request was successful.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code.'."\n",
+ 'type' => 'string',
+ 'example' => 'Invalid.Tenant.ConnectionNotExists',
+ ],
+ 'Data' => [
+ 'description' => 'The data returned.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'PageNumber' => [
+ 'description' => 'The page number. The value of this parameter is the same as that of the PageNumber parameter in the request.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '1',
+ ],
+ 'PageSize' => [
+ 'description' => 'The number of entries per page. Valid values: 1 to 50. Default value: 10.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '10',
+ ],
+ 'TotalCount' => [
+ 'description' => 'The total number of entries returned.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '100',
+ ],
+ 'Apis' => [
+ 'description' => 'The list of APIs in the development state.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The returned result.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'Timeout' => [
+ 'description' => 'The timeout period of the API request. Unit: milliseconds.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '10000',
+ ],
+ 'Status' => [
+ 'description' => 'The status of the API. Valid values: 0 and 1. The value 0 indicates that the API is not published. The value 1 indicates that the API is published.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '0',
+ ],
+ 'ApiId' => [
+ 'description' => 'The API ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '10002',
+ ],
+ 'ApiMode' => [
+ 'description' => 'The type of the API. Valid values: 0, 1, and 2. The value 0 indicates that the API is generated in wizard mode. The value 1 indicates that the API is generated in script mode. The value 2 indicates that the API is generated by registration.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '0',
+ ],
+ 'ProjectId' => [
+ 'description' => 'The workspace ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '10000',
+ ],
+ 'ResponseContentType' => [
+ 'description' => 'The format in which the response of the API request is returned. Valid values: 0 and 1. The value 0 indicates the JSON format. The value 1 indicates the XML format. APIs generated in wizard or script mode support the JSON format. APIs generated by registration support the JSON and XML formats.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '0',
+ ],
+ 'CreatorId' => [
+ 'description' => 'The ID of the Alibaba Cloud account used by the creator of the API.'."\n",
+ 'type' => 'string',
+ 'example' => '1234567',
+ ],
+ 'VisibleRange' => [
+ 'description' => 'The scope in which the API is visible. Valid values: 0 and 1. The value 0 indicates that the API is visible within the workspace. The value 1 indicates that the API is visible only to its owner.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '0',
+ ],
+ 'ModifiedTime' => [
+ 'description' => 'The time when the API was last modified.'."\n",
+ 'type' => 'string',
+ 'example' => '2020-06-23T00:21:01+0800',
+ ],
+ 'OperatorId' => [
+ 'description' => 'The ID of the Alibaba Cloud account used by the user who last modified the API.'."\n",
+ 'type' => 'string',
+ 'example' => '2345678',
+ ],
+ 'GroupId' => [
+ 'description' => 'The group ID.'."\n",
+ 'type' => 'string',
+ 'example' => 'abcde123456789',
+ ],
+ 'Description' => [
+ 'description' => 'The description of the API.'."\n",
+ 'type' => 'string',
+ 'example' => 'Test API description',
+ ],
+ 'FolderId' => [
+ 'description' => 'The folder ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '0',
+ ],
+ 'RequestMethod' => [
+ 'description' => 'The request method of the API. Valid values: 0, 1, 2, and 3. The value 0 indicates the GET method. The value 1 indicates the POST method. The value 2 indicates the PUT method. The value 3 indicates the DELETE method. APIs generated in wizard or script mode support the GET and POST methods. APIs generated by registration support the GET, POST, PUT, and DELETE methods.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '0',
+ ],
+ 'CreatedTime' => [
+ 'description' => 'The time when the API was created.'."\n",
+ 'type' => 'string',
+ 'example' => '2020-06-23T00:21:01+0800',
+ ],
+ 'ApiName' => [
+ 'description' => 'The name of the API.'."\n",
+ 'type' => 'string',
+ 'example' => 'My API name',
+ ],
+ 'TenantId' => [
+ 'description' => 'The tenant ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '10000',
+ ],
+ 'ApiPath' => [
+ 'description' => 'The path of the API.'."\n",
+ 'type' => 'string',
+ 'example' => '/test/1',
+ ],
+ 'Protocols' => [
+ 'description' => 'The list of fields.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The protocol used by the API. Valid values: 0 and 1. The value 0 indicates HTTP. The value 1 indicates HTTPS. Multiple protocols are presented in a list.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '0',
+ ],
+ ],
+ 'RegistrationDetails' => [
+ 'description' => 'The details of the API generated by registration. This parameter is returned only if the API is generated by registration.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'ServiceHost' => [
+ 'description' => 'The URL of the backend service.'."\n",
+ 'type' => 'string',
+ 'example' => 'http://example.aliyundoc.com',
+ ],
+ 'ServiceContentType' => [
+ 'description' => 'The format in which the response of the API request is returned. Valid values: 0 and 1. The value 0 indicates the JSON format. The value 1 indicates the XML format. APIs generated in wizard or script mode support the JSON format. APIs generated by registration support the JSON and XML formats.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '0',
+ ],
+ 'ServicePath' => [
+ 'description' => 'The path of the backend service.'."\n",
+ 'type' => 'string',
+ 'example' => '/index',
+ ],
+ 'SuccessfulResultSample' => [
+ 'description' => 'The sample success response of the API.'."\n",
+ 'type' => 'string',
+ 'example' => '{"success": true}',
+ ],
+ 'FailedResultSample' => [
+ 'description' => 'The sample error response of the API.'."\n",
+ 'type' => 'string',
+ 'example' => '{"success": false}',
+ ],
+ 'ServiceRequestBodyDescription' => [
+ 'description' => 'The description of the request body initiated to call the backend service.'."\n",
+ 'type' => 'string',
+ 'example' => '{"abc":1}',
+ ],
+ 'RegistrationErrorCodes' => [
+ 'description' => 'The error codes returned for the API generated by registration.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '',
+ 'type' => 'object',
+ 'properties' => [
+ 'ErrorMessage' => [
+ 'description' => 'The error message.'."\n",
+ 'type' => 'string',
+ 'example' => 'fail to call',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code.'."\n",
+ 'type' => 'string',
+ 'example' => '1001',
+ ],
+ 'ErrorSolution' => [
+ 'description' => 'The solution used to fix the error.'."\n",
+ 'type' => 'string',
+ 'example' => 'retry',
+ ],
+ ],
+ ],
+ ],
+ 'RegistrationRequestParameters' => [
+ 'description' => 'The request parameters of the API generated by registration.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '',
+ 'type' => 'object',
+ 'properties' => [
+ 'ColumnName' => [
+ 'description' => 'The name of the associated field. This parameter is supported only if the API is generated in wizard mode.'."\n",
+ 'type' => 'string',
+ 'example' => 'column1',
+ ],
+ 'ParameterName' => [
+ 'description' => 'The name of the parameter.'."\n",
+ 'type' => 'string',
+ 'example' => 'name1',
+ ],
+ 'ParameterPosition' => [
+ 'description' => 'The position of the parameter. Valid values: 0, 1, 2, and 3. The value 0 indicates that the parameter is in the URL path of the request. The value 1 indicates that the parameter is in the Query parameter of the request URL. The value 2 indicates that the parameter is in the request header. The value 3 indicates that the parameter is in the request body. APIs generated in wizard or script mode support only the Query position. APIs generated by registration whose request method is GET or DELETE support the Query and Head positions. APIs generated by registration whose request method is PUT or POST support the Query, Head, and Body positions.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '0',
+ ],
+ 'ParameterDescription' => [
+ 'description' => 'The description.'."\n",
+ 'type' => 'string',
+ 'example' => 'description1',
+ ],
+ 'DefaultValue' => [
+ 'description' => 'The default value.'."\n",
+ 'type' => 'string',
+ 'example' => 'default1',
+ ],
+ 'ParameterOperator' => [
+ 'description' => 'The operator used for the value of the parameter. Valid values: 0, 1, 2, and 3. The value 0 indicates the Equal operator. The value 1 indicates the Like operator. The value 2 indicates the Const operator. The value 3 indicates the In operator. APIs generated in wizard mode support the Equal, Like, and In operators. APIs generated in script mode support the Equal operator. APIs generated by registration support the Equal and Const operators.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '0',
+ ],
+ 'ParameterDataType' => [
+ 'description' => 'The data type of the parameter. Valid values:'."\n"
+ ."\n"
+ .'* 0: String'."\n"
+ .'* 1: Int'."\n"
+ .'* 2: Long'."\n"
+ .'* 3: Float'."\n"
+ .'* 4: Double'."\n"
+ .'* 5: Boolean'."\n"
+ .'* 6: StringList'."\n"
+ .'* 7: IntList'."\n"
+ .'* 8: LongList'."\n"
+ .'* 9: FloatList'."\n"
+ .'* 10: DoubleList'."\n"
+ .'* 11: BooleanList'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '0',
+ ],
+ 'ExampleValue' => [
+ 'description' => 'The sample value.'."\n",
+ 'type' => 'string',
+ 'example' => 'example1',
+ ],
+ 'IsRequiredParameter' => [
+ 'description' => 'Indicates whether the parameter is required.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'ScriptDetails' => [
+ 'description' => 'The details of the API generated in script mode. This parameter is returned only if the API is generated in script mode.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'Script' => [
+ 'description' => 'The SQL script.'."\n",
+ 'type' => 'string',
+ 'example' => 'select a from t',
+ ],
+ 'IsPagedResponse' => [
+ 'description' => 'Indicates whether the entries are returned by page.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'ScriptRequestParameters' => [
+ 'description' => 'The request parameters of the API generated in script mode.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '',
+ 'type' => 'object',
+ 'properties' => [
+ 'ColumnName' => [
+ 'description' => 'The name of the associated field. This parameter is supported only if the API is generated in wizard mode.'."\n",
+ 'type' => 'string',
+ 'example' => 'column1',
+ ],
+ 'ParameterName' => [
+ 'description' => 'The name of the parameter.'."\n",
+ 'type' => 'string',
+ 'example' => 'param1',
+ ],
+ 'ParameterPosition' => [
+ 'description' => 'The position of the parameter. Valid values:'."\n"
+ ."\n"
+ .'* 0: indicates that the parameter is in the URL path of the request.'."\n"
+ .'* 1: indicates that the parameter is in the Query parameter of the request URL.'."\n"
+ .'* 2: indicates that the parameter is in the request header.'."\n"
+ .'* 3: indicates that the parameter is in the request body.'."\n"
+ ."\n"
+ .'APIs generated in wizard or script mode support only the Query position. APIs generated by registration whose request method is GET or DELETE support the Query and Head positions. APIs generated by registration whose request method is PUT or POST support the Query, Head, and Body positions.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '0',
+ ],
+ 'ParameterDescription' => [
+ 'description' => 'The description.'."\n",
+ 'type' => 'string',
+ 'example' => 'description1',
+ ],
+ 'DefaultValue' => [
+ 'description' => 'The default value.'."\n",
+ 'type' => 'string',
+ 'example' => 'default1',
+ ],
+ 'ParameterOperator' => [
+ 'description' => 'The operator used for the value of the parameter. Valid values:'."\n"
+ ."\n"
+ .'* 0: Equal'."\n"
+ .'* 1: Like'."\n"
+ .'* 2: Const'."\n"
+ .'* 3: In'."\n"
+ ."\n"
+ .'APIs generated in wizard mode support the Equal, Like, and In operators. APIs generated in script mode support the Equal operator. APIs generated by registration support the Equal and Const operators.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '0',
+ ],
+ 'ParameterDataType' => [
+ 'description' => 'The data type of the parameter. Valid values:'."\n"
+ ."\n"
+ .'* 0: String'."\n"
+ .'* 1: Int'."\n"
+ .'* 2: Long'."\n"
+ .'* 3: Float'."\n"
+ .'* 4: Double'."\n"
+ .'* 5: Boolean'."\n"
+ .'* 6: StringList'."\n"
+ .'* 7: IntList'."\n"
+ .'* 8: LongList'."\n"
+ .'* 9: FloatList'."\n"
+ .'* 10: DoubleList'."\n"
+ .'* 11: BooleanList'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '0',
+ ],
+ 'ExampleValue' => [
+ 'description' => 'The sample value.'."\n",
+ 'type' => 'string',
+ 'example' => 'example1',
+ ],
+ 'IsRequiredParameter' => [
+ 'description' => 'Indicates whether the parameter is required.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ ],
+ ],
+ ],
+ 'ScriptResponseParameters' => [
+ 'description' => 'The response parameters of the API generated in script mode.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '',
+ 'type' => 'object',
+ 'properties' => [
+ 'ParameterDescription' => [
+ 'description' => 'The description.'."\n",
+ 'type' => 'string',
+ 'example' => 'description2',
+ ],
+ 'ColumnName' => [
+ 'description' => 'The name of the associated field. This parameter is supported only if the API is generated in wizard mode.'."\n",
+ 'type' => 'string',
+ 'example' => 'column2',
+ ],
+ 'ParameterName' => [
+ 'description' => 'The name of the parameter.'."\n",
+ 'type' => 'string',
+ 'example' => 'param2',
+ ],
+ 'ParameterDataType' => [
+ 'description' => 'The data type of the parameter. Valid values:'."\n"
+ ."\n"
+ .'* 0: String'."\n"
+ .'* 1: Int'."\n"
+ .'* 2: Long'."\n"
+ .'* 3: Float'."\n"
+ .'* 4: Double'."\n"
+ .'* 5: Boolean'."\n"
+ .'* 6: StringList'."\n"
+ .'* 7: IntList'."\n"
+ .'* 8: LongList'."\n"
+ .'* 9: FloatList'."\n"
+ .'* 10: DoubleList'."\n"
+ .'* 11: BooleanList'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '0',
+ ],
+ 'ExampleValue' => [
+ 'description' => 'The sample value.'."\n",
+ 'type' => 'string',
+ 'example' => 'example2',
+ ],
+ ],
+ ],
+ ],
+ 'ScriptConnection' => [
+ 'description' => 'The data source information about the API generated in script mode.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'TableName' => [
+ 'description' => 'The name of the table in the data source.'."\n",
+ 'type' => 'string',
+ 'example' => 't',
+ ],
+ 'ConnectionId' => [
+ 'description' => 'The data source ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '123',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'WizardDetails' => [
+ 'description' => 'The details of the API generated in wizard mode. This parameter is returned only if the API is generated in wizard mode.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'IsPagedResponse' => [
+ 'description' => 'Indicates whether the entries are returned by page.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'WizardRequestParameters' => [
+ 'description' => 'The request parameters of the API generated in wizard mode.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '',
+ 'type' => 'object',
+ 'properties' => [
+ 'ColumnName' => [
+ 'description' => 'The name of the associated field. This parameter is supported only if the API is generated in wizard mode.'."\n",
+ 'type' => 'string',
+ 'example' => 'column1',
+ ],
+ 'ParameterName' => [
+ 'description' => 'The name of the parameter.'."\n",
+ 'type' => 'string',
+ 'example' => 'param1',
+ ],
+ 'ParameterPosition' => [
+ 'description' => 'The position of the parameter. Valid values: 0, 1, 2, and 3. The value 0 indicates that the parameter is in the URL path of the request. The value 1 indicates that the parameter is in the Query parameter of the request URL. The value 2 indicates that the parameter is in the request header. The value 3 indicates that the parameter is in the request body. APIs generated in wizard or script mode support only the Query position. APIs generated by registration whose request method is GET or DELETE support the Query and Head positions. APIs generated by registration whose request method is PUT or POST support the Query, Head, and Body positions.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '0',
+ ],
+ 'ParameterDescription' => [
+ 'description' => 'The description.'."\n",
+ 'type' => 'string',
+ 'example' => 'description1',
+ ],
+ 'DefaultValue' => [
+ 'description' => 'The default value.'."\n",
+ 'type' => 'string',
+ 'example' => 'default1',
+ ],
+ 'ParameterOperator' => [
+ 'description' => 'The operator used for the value of the parameter. Valid values: 0, 1, 2, and 3. The value 0 indicates the Equal operator. The value 1 indicates the Like operator. The value 2 indicates the Const operator. The value 3 indicates the In operator. APIs generated in wizard mode support the Equal, Like, and In operators. APIs generated in script mode support the Equal operator. APIs generated by registration support the Equal and Const operators.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '0',
+ ],
+ 'ParameterDataType' => [
+ 'description' => 'The data type of the parameter. Valid values:'."\n"
+ ."\n"
+ .'* 0: String'."\n"
+ .'* 1: Int'."\n"
+ .'* 2: Long'."\n"
+ .'* 3: Float'."\n"
+ .'* 4: Double'."\n"
+ .'* 5: Boolean'."\n"
+ .'* 6: StringList'."\n"
+ .'* 7: IntList'."\n"
+ .'* 8: LongList'."\n"
+ .'* 9: FloatList'."\n"
+ .'* 10: DoubleList'."\n"
+ .'* 11: BooleanList'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '0',
+ ],
+ 'ExampleValue' => [
+ 'description' => 'The sample value.'."\n",
+ 'type' => 'string',
+ 'example' => 'example1',
+ ],
+ 'IsRequiredParameter' => [
+ 'description' => 'Indicates whether the parameter is required.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ ],
+ ],
+ ],
+ 'WizardResponseParameters' => [
+ 'description' => 'The response parameters of the API generated in wizard mode.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '',
+ 'type' => 'object',
+ 'properties' => [
+ 'ParameterDescription' => [
+ 'description' => 'The description.'."\n",
+ 'type' => 'string',
+ 'example' => 'description2',
+ ],
+ 'ColumnName' => [
+ 'description' => 'The name of the associated field. This parameter is supported only if the API is generated in wizard mode.'."\n",
+ 'type' => 'string',
+ 'example' => 'column2',
+ ],
+ 'ParameterName' => [
+ 'description' => 'The name of the parameter.'."\n",
+ 'type' => 'string',
+ 'example' => 'param2',
+ ],
+ 'ParameterDataType' => [
+ 'description' => 'The data type of the parameter. Valid values:'."\n"
+ ."\n"
+ .'* 0: String'."\n"
+ .'* 1: Int'."\n"
+ .'* 2: Long'."\n"
+ .'* 3: Float'."\n"
+ .'* 4: Double'."\n"
+ .'* 5: Boolean'."\n"
+ .'* 6: StringList'."\n"
+ .'* 7: IntList'."\n"
+ .'* 8: LongList'."\n"
+ .'* 9: FloatList'."\n"
+ .'* 10: DoubleList'."\n"
+ .'* 11: BooleanList'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '0',
+ ],
+ 'ExampleValue' => [
+ 'description' => 'The sample value.'."\n",
+ 'type' => 'string',
+ 'example' => 'example2',
+ ],
+ ],
+ ],
+ ],
+ 'WizardConnection' => [
+ 'description' => 'The data source information about the API generated in wizard mode.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'TableName' => [
+ 'description' => 'The name of the table in the data source.'."\n",
+ 'type' => 'string',
+ 'example' => 't',
+ ],
+ 'ConnectionId' => [
+ 'description' => 'The data source ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '123',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'errorCodes' => [
+ 403 => [
+ [
+ 'errorCode' => 'Forbidden.Access',
+ 'errorMessage' => 'Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.',
+ ],
+ ],
+ 429 => [
+ [
+ 'errorCode' => 'Throttling.Api',
+ 'errorMessage' => 'The request for this resource has exceeded your available limit.',
+ ],
+ [
+ 'errorCode' => 'Throttling.System',
+ 'errorMessage' => 'The DataWorks system is busy. Try again later.',
+ ],
+ [
+ 'errorCode' => 'Throttling.User',
+ 'errorMessage' => 'Your request is too frequent. Try again later.',
+ ],
+ ],
+ 500 => [
+ [
+ 'errorCode' => 'InternalError.System',
+ 'errorMessage' => 'An internal system error occurred. Try again later.',
+ ],
+ [
+ 'errorCode' => 'InternalError.UserId.Missing',
+ 'errorMessage' => 'An internal system error occurred. Try again later.',
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"0000-ABCD-EFG****\\",\\n \\"ErrorMessage\\": \\"The connection does not exist.\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"Invalid.Tenant.ConnectionNotExists\\",\\n \\"Data\\": {\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 100,\\n \\"Apis\\": [\\n {\\n \\"Timeout\\": 10000,\\n \\"Status\\": 0,\\n \\"ApiId\\": 10002,\\n \\"ApiMode\\": 0,\\n \\"ProjectId\\": 10000,\\n \\"ResponseContentType\\": 0,\\n \\"CreatorId\\": \\"1234567\\",\\n \\"VisibleRange\\": 0,\\n \\"ModifiedTime\\": \\"2020-06-23T00:21:01+0800\\",\\n \\"OperatorId\\": \\"2345678\\",\\n \\"GroupId\\": \\"abcde123456789\\",\\n \\"Description\\": \\"Test API description\\",\\n \\"FolderId\\": 0,\\n \\"RequestMethod\\": 0,\\n \\"CreatedTime\\": \\"2020-06-23T00:21:01+0800\\",\\n \\"ApiName\\": \\"My API name\\",\\n \\"TenantId\\": 10000,\\n \\"ApiPath\\": \\"/test/1\\",\\n \\"Protocols\\": [\\n 0\\n ],\\n \\"RegistrationDetails\\": {\\n \\"ServiceHost\\": \\"http://example.aliyundoc.com\\",\\n \\"ServiceContentType\\": 0,\\n \\"ServicePath\\": \\"/index\\",\\n \\"SuccessfulResultSample\\": \\"{\\\\\\"success\\\\\\": true}\\",\\n \\"FailedResultSample\\": \\"{\\\\\\"success\\\\\\": false}\\",\\n \\"ServiceRequestBodyDescription\\": \\"{\\\\\\"abc\\\\\\":1}\\",\\n \\"RegistrationErrorCodes\\": [\\n {\\n \\"ErrorMessage\\": \\"fail to call\\",\\n \\"ErrorCode\\": \\"1001\\",\\n \\"ErrorSolution\\": \\"retry\\"\\n }\\n ],\\n \\"RegistrationRequestParameters\\": [\\n {\\n \\"ColumnName\\": \\"column1\\",\\n \\"ParameterName\\": \\"name1\\",\\n \\"ParameterPosition\\": 0,\\n \\"ParameterDescription\\": \\"description1\\",\\n \\"DefaultValue\\": \\"default1\\",\\n \\"ParameterOperator\\": 0,\\n \\"ParameterDataType\\": 0,\\n \\"ExampleValue\\": \\"example1\\",\\n \\"IsRequiredParameter\\": true\\n }\\n ]\\n },\\n \\"ScriptDetails\\": {\\n \\"Script\\": \\"select a from t\\",\\n \\"IsPagedResponse\\": true,\\n \\"ScriptRequestParameters\\": [\\n {\\n \\"ColumnName\\": \\"column1\\",\\n \\"ParameterName\\": \\"param1\\",\\n \\"ParameterPosition\\": 0,\\n \\"ParameterDescription\\": \\"description1\\",\\n \\"DefaultValue\\": \\"default1\\",\\n \\"ParameterOperator\\": 0,\\n \\"ParameterDataType\\": 0,\\n \\"ExampleValue\\": \\"example1\\",\\n \\"IsRequiredParameter\\": true\\n }\\n ],\\n \\"ScriptResponseParameters\\": [\\n {\\n \\"ParameterDescription\\": \\"description2\\",\\n \\"ColumnName\\": \\"column2\\",\\n \\"ParameterName\\": \\"param2\\",\\n \\"ParameterDataType\\": 0,\\n \\"ExampleValue\\": \\"example2\\"\\n }\\n ],\\n \\"ScriptConnection\\": {\\n \\"TableName\\": \\"t\\",\\n \\"ConnectionId\\": 123\\n }\\n },\\n \\"WizardDetails\\": {\\n \\"IsPagedResponse\\": true,\\n \\"WizardRequestParameters\\": [\\n {\\n \\"ColumnName\\": \\"column1\\",\\n \\"ParameterName\\": \\"param1\\",\\n \\"ParameterPosition\\": 0,\\n \\"ParameterDescription\\": \\"description1\\",\\n \\"DefaultValue\\": \\"default1\\",\\n \\"ParameterOperator\\": 0,\\n \\"ParameterDataType\\": 0,\\n \\"ExampleValue\\": \\"example1\\",\\n \\"IsRequiredParameter\\": true\\n }\\n ],\\n \\"WizardResponseParameters\\": [\\n {\\n \\"ParameterDescription\\": \\"description2\\",\\n \\"ColumnName\\": \\"column2\\",\\n \\"ParameterName\\": \\"param2\\",\\n \\"ParameterDataType\\": 0,\\n \\"ExampleValue\\": \\"example2\\"\\n }\\n ],\\n \\"WizardConnection\\": {\\n \\"TableName\\": \\"t\\",\\n \\"ConnectionId\\": 123\\n }\\n }\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<ListDataServiceApisResponse>\\n <HttpStatusCode>200</HttpStatusCode>\\n <RequestId>0000-ABCD-EFG****</RequestId>\\n <ErrorMessage>The connection does not exist.</ErrorMessage>\\n <Success>true</Success>\\n <ErrorCode>Invalid.Tenant.ConnectionNotExists</ErrorCode>\\n <Data>\\n <PageNumber>1</PageNumber>\\n <PageSize>10</PageSize>\\n <TotalCount>100</TotalCount>\\n <Apis>\\n <Timeout>10000</Timeout>\\n <Status>0</Status>\\n <ApiId>10002</ApiId>\\n <ApiMode>0</ApiMode>\\n <ProjectId>10000</ProjectId>\\n <ResponseContentType>0</ResponseContentType>\\n <CreatorId>1234567</CreatorId>\\n <VisibleRange>0</VisibleRange>\\n <ModifiedTime>2020-06-23T00:21:01+0800</ModifiedTime>\\n <OperatorId>2345678</OperatorId>\\n <GroupId>abcde123456789</GroupId>\\n <Description>测试API描述</Description>\\n <FolderId>0</FolderId>\\n <RequestMethod>0</RequestMethod>\\n <CreatedTime>2020-06-23T00:21:01+0800</CreatedTime>\\n <ApiName>我的API名称</ApiName>\\n <TenantId>10000</TenantId>\\n <ApiPath>/test/1</ApiPath>\\n <Protocols>0</Protocols>\\n <RegistrationDetails>\\n <ServiceHost>http://example.aliyundoc.com</ServiceHost>\\n <ServiceContentType>0</ServiceContentType>\\n <ServicePath>/index</ServicePath>\\n <SuccessfulResultSample>{\\"success\\": true}</SuccessfulResultSample>\\n <FailedResultSample>{\\"success\\": false}</FailedResultSample>\\n <ServiceRequestBodyDescription>{\\"abc\\":1}</ServiceRequestBodyDescription>\\n <RegistrationErrorCodes>\\n <ErrorMessage>fail to call</ErrorMessage>\\n <ErrorCode>1001</ErrorCode>\\n <ErrorSolution>retry</ErrorSolution>\\n </RegistrationErrorCodes>\\n <RegistrationRequestParameters>\\n <ColumnName>column1</ColumnName>\\n <ParameterName>name1</ParameterName>\\n <ParameterPosition>0</ParameterPosition>\\n <ParameterDescription>description1</ParameterDescription>\\n <DefaultValue>default1</DefaultValue>\\n <ParameterOperator>0</ParameterOperator>\\n <ParameterDataType>0</ParameterDataType>\\n <ExampleValue>example1</ExampleValue>\\n <IsRequiredParameter>true</IsRequiredParameter>\\n </RegistrationRequestParameters>\\n </RegistrationDetails>\\n <ScriptDetails>\\n <Script>select a from t</Script>\\n <IsPagedResponse>true</IsPagedResponse>\\n <ScriptRequestParameters>\\n <ColumnName>column1</ColumnName>\\n <ParameterName>param1</ParameterName>\\n <ParameterPosition>0</ParameterPosition>\\n <ParameterDescription>description1</ParameterDescription>\\n <DefaultValue>default1</DefaultValue>\\n <ParameterOperator>0</ParameterOperator>\\n <ParameterDataType>0</ParameterDataType>\\n <ExampleValue>example1</ExampleValue>\\n <IsRequiredParameter>true</IsRequiredParameter>\\n </ScriptRequestParameters>\\n <ScriptResponseParameters>\\n <ParameterDescription>description2</ParameterDescription>\\n <ColumnName>column2</ColumnName>\\n <ParameterName>param2</ParameterName>\\n <ParameterDataType>0</ParameterDataType>\\n <ExampleValue>example2</ExampleValue>\\n </ScriptResponseParameters>\\n <ScriptConnection>\\n <TableName>t</TableName>\\n <ConnectionId>123</ConnectionId>\\n </ScriptConnection>\\n </ScriptDetails>\\n <WizardDetails>\\n <IsPagedResponse>true</IsPagedResponse>\\n <WizardRequestParameters>\\n <ColumnName>column1</ColumnName>\\n <ParameterName>param1</ParameterName>\\n <ParameterPosition>0</ParameterPosition>\\n <ParameterDescription>description1</ParameterDescription>\\n <DefaultValue>default1</DefaultValue>\\n <ParameterOperator>0</ParameterOperator>\\n <ParameterDataType>0</ParameterDataType>\\n <ExampleValue>example1</ExampleValue>\\n <IsRequiredParameter>true</IsRequiredParameter>\\n </WizardRequestParameters>\\n <WizardResponseParameters>\\n <ParameterDescription>description2</ParameterDescription>\\n <ColumnName>column2</ColumnName>\\n <ParameterName>param2</ParameterName>\\n <ParameterDataType>0</ParameterDataType>\\n <ExampleValue>example2</ExampleValue>\\n </WizardResponseParameters>\\n <WizardConnection>\\n <TableName>t</TableName>\\n <ConnectionId>123</ConnectionId>\\n </WizardConnection>\\n </WizardDetails>\\n </Apis>\\n </Data>\\n</ListDataServiceApisResponse>","errorExample":""}]',
+ 'title' => 'ListDataServiceApis',
+ 'summary' => 'Queries a list of APIs in the development state.',
+ 'requestParamsDescription' => ' ',
+ 'responseParamsDescription' => 'The details of different types of APIs are returned in different parameters. The details of an API generated in wizard mode are returned in the WizardDetails parameter. The details of an API generated in script mode are returned in the ScriptDetails parameter. The details of an API generated by registration are returned in the RegistrationDetails parameter.'."\n",
+ 'extraInfo' => ' ',
+ ],
+ 'GetDataServiceApi' => [
+ 'methods' => [
+ 'post',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'get',
+ 'abilityTreeCode' => '78235',
+ 'abilityTreeNodes' => [
+ 'FEATUREdide7T0EJX',
+ ],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'TenantId',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The tenant ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'docRequired' => false,
+ 'example' => '10002',
+ ],
+ ],
+ [
+ 'name' => 'ProjectId',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The ID of the workspace.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => '10001',
+ ],
+ ],
+ [
+ 'name' => 'ApiId',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The ID of the DataService Studio API.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => '10000',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'description' => 'The response parameters.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'HttpStatusCode' => [
+ 'description' => 'The HTTP status code returned.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '200',
+ ],
+ 'RequestId' => [
+ 'description' => 'The ID of the request.'."\n",
+ 'type' => 'string',
+ 'example' => '0000-ABCD-EFG****',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message returned.'."\n",
+ 'type' => 'string',
+ 'example' => 'The specified parameters are invalid.',
+ ],
+ 'Success' => [
+ 'description' => 'Indicates whether the request was successful.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code returned.'."\n",
+ 'type' => 'string',
+ 'example' => '1031203110005',
+ ],
+ 'Data' => [
+ 'description' => 'The returned data.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'Timeout' => [
+ 'description' => 'The timeout period of the API request. Unit: milliseconds.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '10000',
+ ],
+ 'Status' => [
+ 'description' => 'The status of the API. Valid values: 0 and 1. The value 0 indicates that the API is not published. The value 1 indicates that the API is published.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '0',
+ ],
+ 'ApiId' => [
+ 'description' => 'The ID of the DataService Studio API.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '10000',
+ ],
+ 'ApiMode' => [
+ 'description' => 'The type of the API. Valid values: 0, 1, and 2. The value 0 indicates that the API is generated in wizard mode. The value 1 indicates that the API is generated in script mode. The value 2 indicates that the API is generated by registration.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '0',
+ ],
+ 'ProjectId' => [
+ 'description' => 'The ID of the workspace.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '10001',
+ ],
+ 'ResponseContentType' => [
+ 'description' => 'The format in which the response of the API request is returned. Valid values: 0 and 1. The value 0 indicates the JSON format. The value 1 indicates the XML format. APIs generated in wizard or script mode support the JSON format. APIs generated by registration support the JSON and XML formats.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '0',
+ ],
+ 'CreatorId' => [
+ 'description' => 'The ID of the Alibaba Cloud account used by the creator of the API.'."\n",
+ 'type' => 'string',
+ 'example' => '1234567',
+ ],
+ 'VisibleRange' => [
+ 'description' => 'The scope in which the API is visible. Valid values: 0 and 1. The value 0 indicates that the API is visible to the members in a specific workspace. The value 1 indicates that the API is visible only to the API creator.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '0',
+ ],
+ 'ModifiedTime' => [
+ 'description' => 'The time when the API was last modified.'."\n",
+ 'type' => 'string',
+ 'example' => '2020-06-23T00:21:01+0800',
+ ],
+ 'OperatorId' => [
+ 'description' => 'The ID of the Alibaba Cloud account used by the user who last modified the API.'."\n",
+ 'type' => 'string',
+ 'example' => '2345678',
+ ],
+ 'GroupId' => [
+ 'description' => 'The ID of the group.'."\n",
+ 'type' => 'string',
+ 'example' => 'ab123****',
+ ],
+ 'Description' => [
+ 'description' => 'The description.'."\n",
+ 'type' => 'string',
+ 'example' => 'Description of the test API'."\n",
+ ],
+ 'FolderId' => [
+ 'description' => 'The ID of the folder.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '0',
+ ],
+ 'RequestMethod' => [
+ 'description' => 'The request method of the API. Valid values: 0, 1, 2, and 3. The value 0 indicates the GET method. The value 1 indicates the POST method. The value 2 indicates the PUT method. The value 3 indicates the DELETE method. APIs generated in wizard or script mode support the GET and POST methods. APIs generated by registration support the GET, POST, PUT, and DELETE methods.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '0',
+ ],
+ 'CreatedTime' => [
+ 'description' => 'The creation time.'."\n",
+ 'type' => 'string',
+ 'example' => '2020-06-23T00:21:01+0800',
+ ],
+ 'ApiName' => [
+ 'description' => 'The name of the API.'."\n",
+ 'type' => 'string',
+ 'example' => 'Name of the test API'."\n",
+ ],
+ 'TenantId' => [
+ 'description' => 'The ID of the tenant.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '10002',
+ ],
+ 'ApiPath' => [
+ 'description' => 'The path of the API.'."\n",
+ 'type' => 'string',
+ 'example' => '/test/1',
+ ],
+ 'Protocols' => [
+ 'description' => 'The list of fields.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The protocol used by the API. Valid values: 0 and 1. The value 0 indicates that the API uses HTTP. The value 1 indicates that the API uses HTTPS. Two protocols are presented in a list.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '0',
+ ],
+ ],
+ 'RegistrationDetails' => [
+ 'description' => 'The details of the API generated by registration. This parameter is returned only if the API is generated by registration.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'ServiceHost' => [
+ 'description' => 'The address of the backend service.'."\n",
+ 'type' => 'string',
+ 'example' => 'http://example.aliyundoc.com',
+ ],
+ 'ServiceContentType' => [
+ 'description' => 'The format in which the response of the API request is returned. Valid values:'."\n"
+ ."\n"
+ .'* 0: indicates the JSON format.'."\n"
+ .'* 1: indicates the XML format.'."\n"
+ ."\n"
+ .'APIs generated in wizard or script mode support the JSON format. APIs generated by registration support the JSON and XML formats.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '0',
+ ],
+ 'ServicePath' => [
+ 'description' => 'The path of the backend service.'."\n",
+ 'type' => 'string',
+ 'example' => '/index',
+ ],
+ 'SuccessfulResultSample' => [
+ 'description' => 'Sample success responses'."\n",
+ 'type' => 'string',
+ 'example' => '{"success": true}',
+ ],
+ 'FailedResultSample' => [
+ 'description' => 'The sample error response of the API.'."\n",
+ 'type' => 'string',
+ 'example' => '{"success": false}',
+ ],
+ 'ServiceRequestBodyDescription' => [
+ 'description' => 'The description of the request body initiated to call the backend service.'."\n",
+ 'type' => 'string',
+ 'example' => '{"abc":1}',
+ ],
+ 'RegistrationErrorCodes' => [
+ 'description' => 'The error codes returned for the API generated by registration.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The returned result.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'ErrorMessage' => [
+ 'description' => 'The error message.'."\n",
+ 'type' => 'string',
+ 'example' => 'fail to call',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code.'."\n",
+ 'type' => 'string',
+ 'example' => '1001',
+ ],
+ 'ErrorSolution' => [
+ 'description' => 'The solution used to fix the error.'."\n",
+ 'type' => 'string',
+ 'example' => 'retry',
+ ],
+ ],
+ ],
+ ],
+ 'RegistrationRequestParameters' => [
+ 'description' => 'The request parameters of the API generated by registration.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The returned result.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'ColumnName' => [
+ 'description' => 'The name of the associated field. This parameter is supported only if the API is generated in wizard mode.'."\n",
+ 'type' => 'string',
+ 'example' => 'column1',
+ ],
+ 'ParameterName' => [
+ 'description' => 'The name of the parameter.'."\n",
+ 'type' => 'string',
+ 'example' => 'name1',
+ ],
+ 'ParameterPosition' => [
+ 'description' => 'The position of the parameter. Valid values:'."\n"
+ ."\n"
+ .'* 0: indicates that the parameter is in the URL path of the request.'."\n"
+ .'* 1: indicates that the parameter is in the Query parameter of the request URL.'."\n"
+ .'* 2: indicates that the parameter is in the request header.'."\n"
+ .'* 3: indicates that the parameter is in the request body.'."\n"
+ ."\n"
+ .'APIs generated in wizard or script mode support only the Query position. APIs generated by registration whose request method is GET or DELETE support the Query and Head positions. APIs generated by registration whose request method is PUT or POST support the Query, Head, and Body positions.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '0',
+ ],
+ 'ParameterDescription' => [
+ 'description' => 'The description.'."\n",
+ 'type' => 'string',
+ 'example' => 'description1',
+ ],
+ 'DefaultValue' => [
+ 'description' => 'The default value.'."\n",
+ 'type' => 'string',
+ 'example' => 'default1',
+ ],
+ 'ParameterOperator' => [
+ 'description' => 'The operator used for the value of the parameter. Valid values:'."\n"
+ ."\n"
+ .'* 0: Equal'."\n"
+ .'* 1: Like'."\n"
+ .'* 2: Const'."\n"
+ .'* 3: In'."\n"
+ ."\n"
+ .'APIs generated in wizard mode support the Equal, Like, and In operators. APIs generated in script mode support the Equal operator. APIs generated by registration support the Equal and Const operators.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '0',
+ ],
+ 'ParameterDataType' => [
+ 'description' => 'The data type of the parameter. Valid values:'."\n"
+ ."\n"
+ .'* 0: String'."\n"
+ .'* 1: Int'."\n"
+ .'* 2: Long'."\n"
+ .'* 3: Float'."\n"
+ .'* 4: Double'."\n"
+ .'* 5: Boolean'."\n"
+ .'* 6: StringList'."\n"
+ .'* 7: IntList'."\n"
+ .'* 8: LongList'."\n"
+ .'* 9: FloatList'."\n"
+ .'* 10: DoubleList'."\n"
+ .'* 11: BooleanList'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '0',
+ ],
+ 'ExampleValue' => [
+ 'description' => 'The sample value.'."\n",
+ 'type' => 'string',
+ 'example' => 'example1',
+ ],
+ 'IsRequiredParameter' => [
+ 'description' => 'Indicates whether the parameter is required.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'ScriptDetails' => [
+ 'description' => 'The details of the API generated in script mode. This parameter is returned only if the API is generated in script mode.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'Script' => [
+ 'description' => 'The SQL script.'."\n",
+ 'type' => 'string',
+ 'example' => 'select a from t',
+ ],
+ 'IsPagedResponse' => [
+ 'description' => 'Indicates whether the entries were returned by page.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'ScriptRequestParameters' => [
+ 'description' => 'The request parameters of the API generated in script mode.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The returned result.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'ColumnName' => [
+ 'description' => 'The name of the associated field. This parameter is supported only if the API is generated in wizard mode.'."\n",
+ 'type' => 'string',
+ 'example' => 'column1',
+ ],
+ 'ParameterName' => [
+ 'description' => 'The name of the parameter.'."\n",
+ 'type' => 'string',
+ 'example' => 'param1',
+ ],
+ 'ParameterPosition' => [
+ 'description' => 'The position of the parameter. Valid values: 0, 1, 2, and 3. The value 0 indicates that the parameter is in the URL path of the request. The value 1 indicates that the parameter is in the Query parameter of the request URL. The value 2 indicates that the parameter is in the request header. The value 3 indicates that the parameter is in the request body. APIs generated in wizard or script mode support only the Query position. APIs generated by registration whose request method is GET or DELETE support the Query and Head positions. APIs generated by registration whose request method is PUT or POST support the Query, Head, and Body positions.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '0',
+ ],
+ 'ParameterDescription' => [
+ 'description' => 'The description.'."\n",
+ 'type' => 'string',
+ 'example' => 'description1',
+ ],
+ 'DefaultValue' => [
+ 'description' => 'The default value.'."\n",
+ 'type' => 'string',
+ 'example' => 'default1',
+ ],
+ 'ParameterOperator' => [
+ 'description' => 'The operator used for the value of the parameter. Valid values: 0, 1, 2, and 3. The value 0 indicates the Equal operator. The value 1 indicates the Like operator. The value 2 indicates the Const operator. The value 3 indicates the In operator. APIs generated in wizard mode support the Equal, Like, and In operators. APIs generated in script mode support the Equal operator. APIs generated by registration support the Equal and Const operators.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '0',
+ ],
+ 'ParameterDataType' => [
+ 'description' => 'The data type of the parameter. Valid values:'."\n"
+ ."\n"
+ .'* 0: String'."\n"
+ .'* 1: Int'."\n"
+ .'* 2: Long'."\n"
+ .'* 3: Float'."\n"
+ .'* 4: Double'."\n"
+ .'* 5: Boolean'."\n"
+ .'* 6: StringList'."\n"
+ .'* 7: IntList'."\n"
+ .'* 8: LongList'."\n"
+ .'* 9: FloatList'."\n"
+ .'* 10: DoubleList'."\n"
+ .'* 11: BooleanList'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '0',
+ ],
+ 'ExampleValue' => [
+ 'description' => 'The sample value.'."\n",
+ 'type' => 'string',
+ 'example' => 'example1',
+ ],
+ 'IsRequiredParameter' => [
+ 'description' => 'Indicates whether the parameter is required.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ ],
+ ],
+ ],
+ 'ScriptResponseParameters' => [
+ 'description' => 'The response parameters of the API generated in script mode.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The returned result.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'ParameterDescription' => [
+ 'description' => 'The description.'."\n",
+ 'type' => 'string',
+ 'example' => 'description2',
+ ],
+ 'ColumnName' => [
+ 'description' => 'The name of the associated field. This parameter is supported only if the API is generated in wizard mode.'."\n",
+ 'type' => 'string',
+ 'example' => 'column2',
+ ],
+ 'ParameterName' => [
+ 'description' => 'The name of the parameter.'."\n",
+ 'type' => 'string',
+ 'example' => 'param2',
+ ],
+ 'ParameterDataType' => [
+ 'description' => 'The data type of the parameter. Valid values:'."\n"
+ ."\n"
+ .'* 0: String'."\n"
+ .'* 1: Int'."\n"
+ .'* 2: Long'."\n"
+ .'* 3: Float'."\n"
+ .'* 4: Double'."\n"
+ .'* 5: Boolean'."\n"
+ .'* 6: StringList'."\n"
+ .'* 7: IntList'."\n"
+ .'* 8: LongList'."\n"
+ .'* 9: FloatList'."\n"
+ .'* 10: DoubleList'."\n"
+ .'* 11: BooleanList'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '0',
+ ],
+ 'ExampleValue' => [
+ 'description' => 'The sample value.'."\n",
+ 'type' => 'string',
+ 'example' => 'example2',
+ ],
+ ],
+ ],
+ ],
+ 'ScriptConnection' => [
+ 'description' => 'The data source information of the API generated in script mode.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'TableName' => [
+ 'description' => 'The name of the table in the data source.'."\n",
+ 'type' => 'string',
+ 'example' => 't',
+ ],
+ 'ConnectionId' => [
+ 'description' => 'The ID of the data source.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '123',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'WizardDetails' => [
+ 'description' => 'The details of the API generated in wizard mode. This parameter is returned only if the API is generated in wizard mode.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'IsPagedResponse' => [
+ 'description' => 'Indicates whether the entries were returned by page.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'WizardRequestParameters' => [
+ 'description' => 'The request parameters of the API generated in wizard mode.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The returned result.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'ColumnName' => [
+ 'description' => 'The name of the associated field. This parameter is supported only if the API is generated in wizard mode.'."\n",
+ 'type' => 'string',
+ 'example' => 'column1',
+ ],
+ 'ParameterName' => [
+ 'description' => 'The name of the parameter.'."\n",
+ 'type' => 'string',
+ 'example' => 'param1',
+ ],
+ 'ParameterPosition' => [
+ 'description' => 'The position of the parameter. Valid values: 0, 1, 2, and 3. The value 0 indicates that the parameter is in the URL path of the request. The value 1 indicates that the parameter is in the Query parameter of the request URL. The value 2 indicates that the parameter is in the request header. The value 3 indicates that the parameter is in the request body. APIs generated in wizard or script mode support only the Query position. APIs generated by registration whose request method is GET or DELETE support the Query and Head positions. APIs generated by registration whose request method is PUT or POST support the Query, Head, and Body positions.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '0',
+ ],
+ 'ParameterDescription' => [
+ 'description' => 'The description.'."\n",
+ 'type' => 'string',
+ 'example' => 'description1',
+ ],
+ 'DefaultValue' => [
+ 'description' => 'The default value.'."\n",
+ 'type' => 'string',
+ 'example' => 'default1',
+ ],
+ 'ParameterOperator' => [
+ 'description' => 'The operator used for the value of the parameter. Valid values: 0, 1, 2, and 3. The value 0 indicates the Equal operator. The value 1 indicates the Like operator. The value 2 indicates the Const operator. The value 3 indicates the In operator. APIs generated in wizard mode support the Equal, Like, and In operators. APIs generated in script mode support the Equal operator. APIs generated by registration support the Equal and Const operators.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '0',
+ ],
+ 'ParameterDataType' => [
+ 'description' => 'The data type of the parameter. Valid values:'."\n"
+ ."\n"
+ .'* 0: String'."\n"
+ .'* 1: Int'."\n"
+ .'* 2: Long'."\n"
+ .'* 3: Float'."\n"
+ .'* 4: Double'."\n"
+ .'* 5: Boolean'."\n"
+ .'* 6: StringList'."\n"
+ .'* 7: IntList'."\n"
+ .'* 8: LongList'."\n"
+ .'* 9: FloatList'."\n"
+ .'* 10: DoubleList'."\n"
+ .'* 11: BooleanList'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '0',
+ ],
+ 'ExampleValue' => [
+ 'description' => 'The sample value.'."\n",
+ 'type' => 'string',
+ 'example' => 'example1',
+ ],
+ 'IsRequiredParameter' => [
+ 'description' => 'Indicates whether the parameter is required.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ ],
+ ],
+ ],
+ 'WizardResponseParameters' => [
+ 'description' => 'The response parameters of the API generated in wizard mode.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The returned result.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'ParameterDescription' => [
+ 'description' => 'The description.'."\n",
+ 'type' => 'string',
+ 'example' => 'description2',
+ ],
+ 'ColumnName' => [
+ 'description' => 'The name of the associated field. This parameter is supported only if the API is generated in wizard mode.'."\n",
+ 'type' => 'string',
+ 'example' => 'column2',
+ ],
+ 'ParameterName' => [
+ 'description' => 'The name of the parameter.'."\n",
+ 'type' => 'string',
+ 'example' => 'param2',
+ ],
+ 'ParameterDataType' => [
+ 'description' => 'The data type of the parameter. Valid values:'."\n"
+ ."\n"
+ .'* 0: String'."\n"
+ .'* 1: Int'."\n"
+ .'* 2: Long'."\n"
+ .'* 3: Float'."\n"
+ .'* 4: Double'."\n"
+ .'* 5: Boolean'."\n"
+ .'* 6: StringList'."\n"
+ .'* 7: IntList'."\n"
+ .'* 8: LongList'."\n"
+ .'* 9: FloatList'."\n"
+ .'* 10: DoubleList'."\n"
+ .'* 11: BooleanList'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '0',
+ ],
+ 'ExampleValue' => [
+ 'description' => 'The sample value.'."\n",
+ 'type' => 'string',
+ 'example' => 'example2',
+ ],
+ ],
+ ],
+ ],
+ 'WizardConnection' => [
+ 'description' => 'The data source information of the API generated in wizard mode.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'TableName' => [
+ 'description' => 'The name of the table in the data source.'."\n",
+ 'type' => 'string',
+ 'example' => 't',
+ ],
+ 'ConnectionId' => [
+ 'description' => 'The ID of the data source.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '123',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'errorCodes' => [
+ 403 => [
+ [
+ 'errorCode' => 'Forbidden.Access',
+ 'errorMessage' => 'Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.',
+ ],
+ ],
+ 429 => [
+ [
+ 'errorCode' => 'Throttling.Api',
+ 'errorMessage' => 'The request for this resource has exceeded your available limit.',
+ ],
+ [
+ 'errorCode' => 'Throttling.System',
+ 'errorMessage' => 'The DataWorks system is busy. Try again later.',
+ ],
+ [
+ 'errorCode' => 'Throttling.User',
+ 'errorMessage' => 'Your request is too frequent. Try again later.',
+ ],
+ ],
+ 500 => [
+ [
+ 'errorCode' => 'InternalError.System',
+ 'errorMessage' => 'An internal system error occurred. Try again later.',
+ ],
+ [
+ 'errorCode' => 'InternalError.UserId.Missing',
+ 'errorMessage' => 'An internal system error occurred. Try again later.',
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"0000-ABCD-EFG****\\",\\n \\"ErrorMessage\\": \\"The specified parameters are invalid.\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"1031203110005\\",\\n \\"Data\\": {\\n \\"Timeout\\": 10000,\\n \\"Status\\": 0,\\n \\"ApiId\\": 10000,\\n \\"ApiMode\\": 0,\\n \\"ProjectId\\": 10001,\\n \\"ResponseContentType\\": 0,\\n \\"CreatorId\\": \\"1234567\\",\\n \\"VisibleRange\\": 0,\\n \\"ModifiedTime\\": \\"2020-06-23T00:21:01+0800\\",\\n \\"OperatorId\\": \\"2345678\\",\\n \\"GroupId\\": \\"ab123****\\",\\n \\"Description\\": \\"测试API描述\\",\\n \\"FolderId\\": 0,\\n \\"RequestMethod\\": 0,\\n \\"CreatedTime\\": \\"2020-06-23T00:21:01+0800\\",\\n \\"ApiName\\": \\"测试API名称\\",\\n \\"TenantId\\": 10002,\\n \\"ApiPath\\": \\"/test/1\\",\\n \\"Protocols\\": [\\n 0\\n ],\\n \\"RegistrationDetails\\": {\\n \\"ServiceHost\\": \\"http://example.aliyundoc.com\\",\\n \\"ServiceContentType\\": 0,\\n \\"ServicePath\\": \\"/index\\",\\n \\"SuccessfulResultSample\\": \\"{\\\\\\"success\\\\\\": true}\\",\\n \\"FailedResultSample\\": \\"{\\\\\\"success\\\\\\": false}\\",\\n \\"ServiceRequestBodyDescription\\": \\"{\\\\\\"abc\\\\\\":1}\\",\\n \\"RegistrationErrorCodes\\": [\\n {\\n \\"ErrorMessage\\": \\"fail to call\\",\\n \\"ErrorCode\\": \\"1001\\",\\n \\"ErrorSolution\\": \\"retry\\"\\n }\\n ],\\n \\"RegistrationRequestParameters\\": [\\n {\\n \\"ColumnName\\": \\"column1\\",\\n \\"ParameterName\\": \\"name1\\",\\n \\"ParameterPosition\\": 0,\\n \\"ParameterDescription\\": \\"description1\\",\\n \\"DefaultValue\\": \\"default1\\",\\n \\"ParameterOperator\\": 0,\\n \\"ParameterDataType\\": 0,\\n \\"ExampleValue\\": \\"example1\\",\\n \\"IsRequiredParameter\\": true\\n }\\n ]\\n },\\n \\"ScriptDetails\\": {\\n \\"Script\\": \\"select a from t\\",\\n \\"IsPagedResponse\\": true,\\n \\"ScriptRequestParameters\\": [\\n {\\n \\"ColumnName\\": \\"column1\\",\\n \\"ParameterName\\": \\"param1\\",\\n \\"ParameterPosition\\": 0,\\n \\"ParameterDescription\\": \\"description1\\",\\n \\"DefaultValue\\": \\"default1\\",\\n \\"ParameterOperator\\": 0,\\n \\"ParameterDataType\\": 0,\\n \\"ExampleValue\\": \\"example1\\",\\n \\"IsRequiredParameter\\": true\\n }\\n ],\\n \\"ScriptResponseParameters\\": [\\n {\\n \\"ParameterDescription\\": \\"description2\\",\\n \\"ColumnName\\": \\"column2\\",\\n \\"ParameterName\\": \\"param2\\",\\n \\"ParameterDataType\\": 0,\\n \\"ExampleValue\\": \\"example2\\"\\n }\\n ],\\n \\"ScriptConnection\\": {\\n \\"TableName\\": \\"t\\",\\n \\"ConnectionId\\": 123\\n }\\n },\\n \\"WizardDetails\\": {\\n \\"IsPagedResponse\\": true,\\n \\"WizardRequestParameters\\": [\\n {\\n \\"ColumnName\\": \\"column1\\",\\n \\"ParameterName\\": \\"param1\\",\\n \\"ParameterPosition\\": 0,\\n \\"ParameterDescription\\": \\"description1\\",\\n \\"DefaultValue\\": \\"default1\\",\\n \\"ParameterOperator\\": 0,\\n \\"ParameterDataType\\": 0,\\n \\"ExampleValue\\": \\"example1\\",\\n \\"IsRequiredParameter\\": true\\n }\\n ],\\n \\"WizardResponseParameters\\": [\\n {\\n \\"ParameterDescription\\": \\"description2\\",\\n \\"ColumnName\\": \\"column2\\",\\n \\"ParameterName\\": \\"param2\\",\\n \\"ParameterDataType\\": 0,\\n \\"ExampleValue\\": \\"example2\\"\\n }\\n ],\\n \\"WizardConnection\\": {\\n \\"TableName\\": \\"t\\",\\n \\"ConnectionId\\": 123\\n }\\n }\\n }\\n}","errorExample":""},{"type":"xml","example":"<GetDataServiceApiResponse>\\n <HttpStatusCode>200</HttpStatusCode>\\n <RequestId>0000-ABCD-EFG****</RequestId>\\n <ErrorMessage>The specified parameters are invalid.</ErrorMessage>\\n <Success>true</Success>\\n <ErrorCode>1031203110005</ErrorCode>\\n <Data>\\n <Timeout>10000</Timeout>\\n <Status>0</Status>\\n <ApiId>10000</ApiId>\\n <ApiMode>0</ApiMode>\\n <ProjectId>10001</ProjectId>\\n <ResponseContentType>0</ResponseContentType>\\n <CreatorId>1234567</CreatorId>\\n <VisibleRange>0</VisibleRange>\\n <ModifiedTime>2020-06-23T00:21:01+0800</ModifiedTime>\\n <OperatorId>2345678</OperatorId>\\n <GroupId>ab123****</GroupId>\\n <Description>测试API描述</Description>\\n <FolderId>0</FolderId>\\n <RequestMethod>0</RequestMethod>\\n <CreatedTime>2020-06-23T00:21:01+0800</CreatedTime>\\n <ApiName>测试API名称</ApiName>\\n <TenantId>10002</TenantId>\\n <ApiPath>/test/1</ApiPath>\\n <Protocols>0</Protocols>\\n <RegistrationDetails>\\n <ServiceHost>http://example.aliyundoc.com</ServiceHost>\\n <ServiceContentType>0</ServiceContentType>\\n <ServicePath>/index</ServicePath>\\n <SuccessfulResultSample>{\\"success\\": true}</SuccessfulResultSample>\\n <FailedResultSample>{\\"success\\": false}</FailedResultSample>\\n <ServiceRequestBodyDescription>{\\"abc\\":1}</ServiceRequestBodyDescription>\\n <RegistrationErrorCodes>\\n <ErrorMessage>fail to call</ErrorMessage>\\n <ErrorCode>1001</ErrorCode>\\n <ErrorSolution>retry</ErrorSolution>\\n </RegistrationErrorCodes>\\n <RegistrationRequestParameters>\\n <ColumnName>column1</ColumnName>\\n <ParameterName>name1</ParameterName>\\n <ParameterPosition>0</ParameterPosition>\\n <ParameterDescription>description1</ParameterDescription>\\n <DefaultValue>default1</DefaultValue>\\n <ParameterOperator>0</ParameterOperator>\\n <ParameterDataType>0</ParameterDataType>\\n <ExampleValue>example1</ExampleValue>\\n <IsRequiredParameter>true</IsRequiredParameter>\\n </RegistrationRequestParameters>\\n </RegistrationDetails>\\n <ScriptDetails>\\n <Script>select a from t</Script>\\n <IsPagedResponse>true</IsPagedResponse>\\n <ScriptRequestParameters>\\n <ColumnName>column1</ColumnName>\\n <ParameterName>param1</ParameterName>\\n <ParameterPosition>0</ParameterPosition>\\n <ParameterDescription>description1</ParameterDescription>\\n <DefaultValue>default1</DefaultValue>\\n <ParameterOperator>0</ParameterOperator>\\n <ParameterDataType>0</ParameterDataType>\\n <ExampleValue>example1</ExampleValue>\\n <IsRequiredParameter>true</IsRequiredParameter>\\n </ScriptRequestParameters>\\n <ScriptResponseParameters>\\n <ParameterDescription>description2</ParameterDescription>\\n <ColumnName>column2</ColumnName>\\n <ParameterName>param2</ParameterName>\\n <ParameterDataType>0</ParameterDataType>\\n <ExampleValue>example2</ExampleValue>\\n </ScriptResponseParameters>\\n <ScriptConnection>\\n <TableName>t</TableName>\\n <ConnectionId>123</ConnectionId>\\n </ScriptConnection>\\n </ScriptDetails>\\n <WizardDetails>\\n <IsPagedResponse>true</IsPagedResponse>\\n <WizardRequestParameters>\\n <ColumnName>column1</ColumnName>\\n <ParameterName>param1</ParameterName>\\n <ParameterPosition>0</ParameterPosition>\\n <ParameterDescription>description1</ParameterDescription>\\n <DefaultValue>default1</DefaultValue>\\n <ParameterOperator>0</ParameterOperator>\\n <ParameterDataType>0</ParameterDataType>\\n <ExampleValue>example1</ExampleValue>\\n <IsRequiredParameter>true</IsRequiredParameter>\\n </WizardRequestParameters>\\n <WizardResponseParameters>\\n <ParameterDescription>description2</ParameterDescription>\\n <ColumnName>column2</ColumnName>\\n <ParameterName>param2</ParameterName>\\n <ParameterDataType>0</ParameterDataType>\\n <ExampleValue>example2</ExampleValue>\\n </WizardResponseParameters>\\n <WizardConnection>\\n <TableName>t</TableName>\\n <ConnectionId>123</ConnectionId>\\n </WizardConnection>\\n </WizardDetails>\\n </Data>\\n</GetDataServiceApiResponse>","errorExample":""}]',
+ 'title' => 'GetDataServiceApi',
+ 'summary' => 'Queries the details of a DataService Studio API in the development state.',
+ 'requestParamsDescription' => ' ',
+ 'responseParamsDescription' => 'The details about the APIs of different types are returned in different parameters. The details about the API generated in wizard mode are returned in the WizardDetails parameter. The details about the API generated in script mode are returned in the ScriptDetails parameter. The details about the API generated by registration are returned in the RegistrationDetails parameter.'."\n",
+ 'extraInfo' => ' ',
+ ],
+ 'UpdateDataServiceApi' => [
+ 'methods' => [
+ 'post',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'write',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'update',
+ 'abilityTreeCode' => '78368',
+ 'abilityTreeNodes' => [
+ 'FEATUREdideZZ63WZ',
+ ],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'TenantId',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The tenant ID. To obtain the tenant ID, perform the following steps: Log on to the [DataWorks console](https://workbench.data.aliyun.com/console). Find your workspace and go to the DataStudio page. On the DataStudio page, click the username for the logon in the upper-right corner and click User Info in the Menu section.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'docRequired' => false,
+ 'example' => '10001',
+ ],
+ ],
+ [
+ 'name' => 'ProjectId',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The ID of the workspace.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => '10001',
+ ],
+ ],
+ [
+ 'name' => 'ApiId',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The ID of the API.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => '10000',
+ ],
+ ],
+ [
+ 'name' => 'RequestMethod',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The request method of the API. Valid values: 0, 1, 2, and 3. The value 0 indicates the GET method. The value 1 indicates the POST method. The value 2 indicates the PUT method. The value 3 indicates the DELETE method. APIs generated in wizard or script mode support the GET and POST methods. APIs generated by registration support the GET, POST, PUT, and DELETE methods.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => '0',
+ ],
+ ],
+ [
+ 'name' => 'ResponseContentType',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The format in which the response of the API request is returned. Valid values: 0 and 1. The value 0 indicates the JSON format. The value 1 indicates the XML format. APIs generated in wizard or script mode support the JSON format. APIs generated by registration support the JSON and XML formats.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => '0',
+ ],
+ ],
+ [
+ 'name' => 'Timeout',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The timeout period of the API request. Unit: milliseconds. Valid values: (0,30000].'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => '10000',
+ ],
+ ],
+ [
+ 'name' => 'VisibleRange',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The scope in which the API is visible. Valid values: 0 and 1. The value 0 indicates that the API is visible within the workspace. The value 1 indicates that the API is visible only to its owner.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => '0',
+ ],
+ ],
+ [
+ 'name' => 'Protocols',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The protocol used by the API. Valid values: 0 and 1. The value 0 indicates HTTP. The value 1 indicates HTTPS. You can specify multiple protocols. Separate multiple protocols with commas (,).'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => '0,1',
+ ],
+ ],
+ [
+ 'name' => 'WizardDetails',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The details of the API generated in wizard mode. For more information, see the WizardDetails parameter returned by the [GetDataServiceApi](~~174013~~) operation.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => '{"isPagedResponse":true,"wizardConnection":{"connectionId":122786,"tableName":"person"},"wizardRequestParameters":[{"columnName":"id","defaultValue":"","exampleValue":"1","isRequiredParameter":true,"parameterDataType":2,"parameterDescription":"","parameterName":"id","parameterOperator":0,"parameterPosition":0}],"wizardResponseParameters":[{"columnName":"id","exampleValue":"11","parameterDataType":2,"parameterDescription":"","parameterName":"id"}]}',
+ ],
+ ],
+ [
+ 'name' => 'ScriptDetails',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The details of the API generated in script mode. For more information, see the ScriptDetails parameter returned by the [GetDataServiceApi](~~174013~~) operation.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => '{"isPagedResponse":false,"script":"select id as id1, name as name1 from person where id=${inputid}","scriptConnection":{"connectionId":122786,"tableName":"person"},"scriptRequestParameters":[{"defaultValue":"","exampleValue":"","isRequiredParameter":true,"parameterDataType":0,"parameterDescription":"","parameterName":"inputid","parameterOperator":0,"parameterPosition":1}],"scriptResponseParameters":[{"exampleValue":"","parameterDataType":0,"parameterDescription":"","parameterName":"id1"},{"exampleValue":"","parameterDataType":0,"parameterDescription":"","parameterName":"name1"}]}',
+ ],
+ ],
+ [
+ 'name' => 'RegistrationDetails',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The details of the API generated by registration. For more information, see the RegistrationDetails parameter returned by the [GetDataServiceApi](~~174013~~) operation.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => '{"failedResultSample":"fail","registrationErrorCodes":[{"errorCode":"e1","errorMessage":"msg1","errorSolution":"sol1"},{"errorCode":"e2","errorMessage":"msg2","errorSolution":"sol2"}],"registrationRequestParameters":[{"columnName":"","defaultValue":"","exampleValue":"","isRequiredParameter":true,"parameterDataType":0,"parameterDescription":"","parameterName":"id","parameterOperator":0,"parameterPosition":1},{"columnName":"","defaultValue":"xx","exampleValue":"","isRequiredParameter":true,"parameterDataType":0,"parameterDescription":"","parameterName":"cc","parameterOperator":2,"parameterPosition":2}],"serviceContentType":1,"serviceHost":"http://www.baidu.com","servicePath":"/[uid]","serviceRequestBodyDescription":"body","successfulResultSample":"success"}',
+ ],
+ ],
+ [
+ 'name' => 'ApiPath',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The path of the API.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => '/test/2',
+ ],
+ ],
+ [
+ 'name' => 'ApiDescription',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The description of the API.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'API description'."\n",
+ ],
+ ],
+ [
+ 'name' => 'ResourceGroupId',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The ID of the exclusive resource group.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'example' => '3242432423',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'HttpStatusCode' => [
+ 'description' => 'The HTTP status code.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '200',
+ ],
+ 'Data' => [
+ 'description' => 'Indicates whether the information about the API was updated.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message.'."\n",
+ 'type' => 'string',
+ 'example' => 'The connection does not exist.',
+ ],
+ 'RequestId' => [
+ 'description' => 'The request ID.'."\n",
+ 'type' => 'string',
+ 'example' => '0000-ABCD-EFG****',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code.'."\n",
+ 'type' => 'string',
+ 'example' => 'Invalid.Tenant.ConnectionNotExists',
+ ],
+ 'Success' => [
+ 'description' => 'Indicates whether the request was successful.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ ],
+ 'description' => '',
+ ],
+ ],
+ ],
+ 'errorCodes' => [
+ 403 => [
+ [
+ 'errorCode' => 'Forbidden.Access',
+ 'errorMessage' => 'Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.',
+ ],
+ ],
+ 429 => [
+ [
+ 'errorCode' => 'Throttling.Api',
+ 'errorMessage' => 'The request for this resource has exceeded your available limit.',
+ ],
+ [
+ 'errorCode' => 'Throttling.System',
+ 'errorMessage' => 'The DataWorks system is busy. Try again later.',
+ ],
+ [
+ 'errorCode' => 'Throttling.User',
+ 'errorMessage' => 'Your request is too frequent. Try again later.',
+ ],
+ ],
+ 500 => [
+ [
+ 'errorCode' => 'InternalError.System',
+ 'errorMessage' => 'An internal system error occurred. Try again later.',
+ ],
+ [
+ 'errorCode' => 'InternalError.UserId.Missing',
+ 'errorMessage' => 'An internal system error occurred. Try again later.',
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Data\\": true,\\n \\"ErrorMessage\\": \\"The connection does not exist.\\",\\n \\"RequestId\\": \\"0000-ABCD-EFG****\\",\\n \\"ErrorCode\\": \\"Invalid.Tenant.ConnectionNotExists\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<UpdateDataServiceApiResponse>\\n <HttpStatusCode>200</HttpStatusCode>\\n <Data>true</Data>\\n <ErrorMessage>The connection does not exist.</ErrorMessage>\\n <RequestId>0000-ABCD-EFG****</RequestId>\\n <ErrorCode>Invalid.Tenant.ConnectionNotExists</ErrorCode>\\n <Success>true</Success>\\n</UpdateDataServiceApiResponse>","errorExample":""}]',
+ 'title' => 'UpdateDataServiceApi',
+ 'summary' => 'Updates the information about an API in the development state in DataService Studio.',
+ 'requestParamsDescription' => ' ',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ ],
+ 'GetDataServicePublishedApi' => [
+ 'summary' => 'Queries the information about a DataService Studio API in the published state.',
+ 'methods' => [
+ 'post',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'get',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeCode' => '78239',
+ 'abilityTreeNodes' => [
+ 'FEATUREdide7T0EJX',
+ ],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'ProjectId',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The ID of the workspace.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => '10002',
+ ],
+ ],
+ [
+ 'name' => 'TenantId',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The tenant ID. To obtain the tenant ID, perform the following steps: Log on to the [DataWorks console](https://workbench.data.aliyun.com/console). Find your workspace and go to the DataStudio page. On the DataStudio page, click the logon username in the upper-right corner and click User Info in the Menu section.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'docRequired' => false,
+ 'example' => '10003',
+ ],
+ ],
+ [
+ 'name' => 'ApiId',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The ID of the API.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => '10001',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'HttpStatusCode' => [
+ 'description' => 'The HTTP status code returned.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '200',
+ ],
+ 'RequestId' => [
+ 'description' => 'The ID of the request.'."\n",
+ 'type' => 'string',
+ 'example' => '0000-ABCD-EFG****',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message returned.'."\n",
+ 'type' => 'string',
+ 'example' => 'The connection does not exist.',
+ ],
+ 'Success' => [
+ 'description' => 'Indicates whether the request was successful.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code returned.'."\n",
+ 'type' => 'string',
+ 'example' => 'Invalid.Tenant.ConnectionNotExists',
+ ],
+ 'Data' => [
+ 'description' => 'Information about published APIs.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'Timeout' => [
+ 'description' => 'The timeout period of the API request. Unit: milliseconds.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '10000',
+ ],
+ 'Status' => [
+ 'description' => 'The status of the API. Valid values: 0 and 1. The value 0 indicates that the API is not published. The value 1 indicates that the API is published.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '1',
+ ],
+ 'ApiId' => [
+ 'description' => 'The ID of the DataService Studio API.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '10000',
+ ],
+ 'ApiMode' => [
+ 'description' => 'The type of the API. Valid values: 0, 1, and 2. The value 0 indicates that the API is generated in wizard mode. The value 1 indicates that the API is generated in script mode. The value 2 indicates that the API is generated by registration.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '0',
+ ],
+ 'ProjectId' => [
+ 'description' => 'The ID of the workspace.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '10001',
+ ],
+ 'ResponseContentType' => [
+ 'description' => 'The format in which the response of the API request is returned. Valid values: 0 and 1. The value 0 indicates the JSON format. The value 1 indicates the XML format. APIs generated in wizard or script mode support the JSON format. APIs generated by registration support the JSON and XML formats.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '0',
+ ],
+ 'CreatorId' => [
+ 'description' => 'The ID of the Alibaba Cloud account used by the creator of the API.'."\n",
+ 'type' => 'string',
+ 'example' => '1234567',
+ ],
+ 'VisibleRange' => [
+ 'description' => 'The scope in which the API is visible. Valid values: 0 and 1. The value 0 indicates that the API is visible to the members in a specific workspace. The value 1 indicates that the API is visible only to the API creator.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '0',
+ ],
+ 'ModifiedTime' => [
+ 'description' => 'The time when the API was last modified.'."\n",
+ 'type' => 'string',
+ 'example' => '2020-06-23T00:21:01+0800',
+ ],
+ 'OperatorId' => [
+ 'description' => 'The ID of the Alibaba Cloud account used by the user who last modified the API.'."\n",
+ 'type' => 'string',
+ 'example' => '2345678',
+ ],
+ 'GroupId' => [
+ 'description' => 'The ID of the group.'."\n",
+ 'type' => 'string',
+ 'example' => 'ab12**',
+ ],
+ 'Description' => [
+ 'description' => 'The description.'."\n",
+ 'type' => 'string',
+ 'example' => 'Description of the test API'."\n",
+ ],
+ 'RequestMethod' => [
+ 'description' => 'The request method of the API. Valid values: 0, 1, 2, and 3. The value 0 indicates the GET method, the value 1 indicates the POST method, the value 2 indicates the PUT method, and the value 3 indicates the DELETE method. APIs generated in wizard or script mode support the GET and POST methods. APIs generated by registration support the GET, POST, PUT, and DELETE methods.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '0',
+ ],
+ 'CreatedTime' => [
+ 'description' => 'The creation time.'."\n",
+ 'type' => 'string',
+ 'example' => '2020-06-23T00:21:01+0800',
+ ],
+ 'ApiName' => [
+ 'description' => 'The name of the API.'."\n",
+ 'type' => 'string',
+ 'example' => 'Name of the test API'."\n",
+ ],
+ 'TenantId' => [
+ 'description' => 'The ID of the tenant.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '10001',
+ ],
+ 'ApiPath' => [
+ 'description' => 'The path of the API.'."\n",
+ 'type' => 'string',
+ 'example' => '/test/1',
+ ],
+ 'Protocols' => [
+ 'description' => 'The protocol used by the API. Valid values: 0 and 1. The value 0 indicates HTTP. The value 1 indicates HTTPS. Multiple protocols are presented in a list.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The protocol used by the API. Valid values: 0 and 1. The value 0 indicates that the API uses HTTP. The value 1 indicates that the API uses HTTPS. Two protocols are presented in a list.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '0',
+ ],
+ ],
+ 'RegistrationDetails' => [
+ 'description' => 'Registered API details. Only returned for registered APIs.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'ServiceHost' => [
+ 'description' => 'The URL of the backend service.'."\n",
+ 'type' => 'string',
+ 'example' => 'http://example.aliyundoc.com',
+ ],
+ 'ServiceContentType' => [
+ 'description' => 'The format in which the response of the API request is returned. Valid values: 0 and 1. The value 0 indicates the JSON format. The value 1 indicates the XML format. APIs generated in wizard or script mode support the JSON format. APIs generated by registration support the JSON and XML formats.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '0',
+ ],
+ 'ServicePath' => [
+ 'description' => 'The path of the backend service.'."\n",
+ 'type' => 'string',
+ 'example' => '/index',
+ ],
+ 'SuccessfulResultSample' => [
+ 'description' => 'The sample success response of the API.'."\n",
+ 'type' => 'string',
+ 'example' => '{"success": true}',
+ ],
+ 'FailedResultSample' => [
+ 'description' => 'The sample error response of the API.'."\n",
+ 'type' => 'string',
+ 'example' => '{"success": false}',
+ ],
+ 'ServiceRequestBodyDescription' => [
+ 'description' => 'The description of the request body initiated to call the backend service.'."\n",
+ 'type' => 'string',
+ 'example' => '{"abc":1}',
+ ],
+ 'RegistrationErrorCodes' => [
+ 'title' => '',
+ 'description' => 'The list of error codes for the registered API.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'ErrorMessage' => [
+ 'title' => '',
+ 'description' => 'The error message.'."\n",
+ 'type' => 'string',
+ 'example' => 'The connection does not exist.',
+ ],
+ 'ErrorCode' => [
+ 'title' => '',
+ 'description' => 'The error code.'."\n",
+ 'type' => 'string',
+ 'example' => 'Invalid.Tenant.ConnectionNotExists',
+ ],
+ 'ErrorSolution' => [
+ 'title' => '',
+ 'description' => 'The solution.'."\n",
+ 'type' => 'string',
+ 'example' => 'retry',
+ ],
+ ],
+ 'description' => '',
+ ],
+ ],
+ 'RegistrationRequestParameters' => [
+ 'title' => '',
+ 'description' => 'The list of request parameters for the registered API.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'ParameterName' => [
+ 'description' => 'The name of the parameter.'."\n",
+ 'type' => 'string',
+ 'example' => 'name1',
+ ],
+ 'ParameterPosition' => [
+ 'description' => 'The position of the parameter. Valid values: 0, 1, 2, and 3. The value 0 indicates that the parameter is in the URL path of the request. The value 1 indicates that the parameter is in the Query parameter of the request URL. The value 2 indicates that the parameter is in the request header. The value 3 indicates that the parameter is in the request body. APIs generated in wizard or script mode support only the Query position. APIs generated by registration whose request method is GET or DELETE support the Query and Head positions. APIs generated by registration whose request method is PUT or POST support the Query, Head, and Body positions.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '0',
+ ],
+ 'ParameterDescription' => [
+ 'description' => 'The description.'."\n",
+ 'type' => 'string',
+ 'example' => 'description1',
+ ],
+ 'DefaultValue' => [
+ 'description' => 'The default value.'."\n",
+ 'type' => 'string',
+ 'example' => 'default1',
+ ],
+ 'ParameterOperator' => [
+ 'description' => 'The operator used for the value of the parameter. Valid values: 0, 1, 2, and 3. The value 0 indicates the Equal operator. The value 1 indicates the Like operator. The value 2 indicates the Const operator. The value 3 indicates the In operator. APIs generated in wizard mode support the Equal, Like, and In operators. APIs generated in script mode support the Equal operator. APIs generated by registration support the Equal and Const operators.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '0',
+ ],
+ 'ExampleValue' => [
+ 'description' => 'The sample value.'."\n",
+ 'type' => 'string',
+ 'example' => 'example1',
+ ],
+ 'ParameterDataType' => [
+ 'description' => 'The data type of the parameter. Valid values:'."\n"
+ ."\n"
+ .'* 0: String'."\n"
+ .'* 1: Int'."\n"
+ .'* 2: Long'."\n"
+ .'* 3: Float'."\n"
+ .'* 4: Double'."\n"
+ .'* 5: Boolean'."\n"
+ .'* 6: StringList'."\n"
+ .'* 7: IntList'."\n"
+ .'* 8: LongList'."\n"
+ .'* 9: FloatList'."\n"
+ .'* 10: DoubleList'."\n"
+ .'* 11: BooleanList'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '0',
+ ],
+ 'IsRequiredParameter' => [
+ 'description' => 'Indicates whether the parameter is required.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ ],
+ 'description' => 'The returned result.'."\n",
+ ],
+ ],
+ ],
+ ],
+ 'ScriptDetails' => [
+ 'description' => 'The details of the API generated in script mode. This parameter is returned only if the API is generated in script mode.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'IsPagedResponse' => [
+ 'description' => 'Indicates whether the entries were returned by page.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'SuccessfulResultSample' => [
+ 'description' => 'The sample success response of the API.'."\n",
+ 'type' => 'string',
+ 'example' => '{"success": true}',
+ ],
+ 'FailedResultSample' => [
+ 'description' => 'The sample error response of the API.'."\n",
+ 'type' => 'string',
+ 'example' => '{"success": false}',
+ ],
+ 'Script' => [
+ 'description' => 'The SQL script.'."\n",
+ 'type' => 'string',
+ 'example' => 'select a from t',
+ ],
+ 'ScriptErrorCodes' => [
+ 'description' => 'The error codes returned for the API generated in script mode.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'ErrorMessage' => [
+ 'description' => 'The error message.'."\n",
+ 'type' => 'string',
+ 'example' => 'fail to call',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code.'."\n",
+ 'type' => 'string',
+ 'example' => '1001',
+ ],
+ 'ErrorSolution' => [
+ 'description' => 'The solution used to fix the error.'."\n",
+ 'type' => 'string',
+ 'example' => 'retry',
+ ],
+ ],
+ 'description' => 'The returned result.'."\n",
+ ],
+ ],
+ 'ScriptRequestParameters' => [
+ 'description' => 'The request parameters of the API generated in script mode.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'ParameterName' => [
+ 'description' => 'The name of the parameter.'."\n",
+ 'type' => 'string',
+ 'example' => 'param1',
+ ],
+ 'ParameterPosition' => [
+ 'description' => 'The position of the parameter. Valid values:'."\n"
+ ."\n"
+ .'* 0: indicates that the parameter is in the URL path of the request.'."\n"
+ .'* 1: indicates that the parameter is in the Query parameter of the request URL.'."\n"
+ .'* 2: indicates that the parameter is in the request header.'."\n"
+ .'* 3: indicates that the parameter is in the request body.'."\n"
+ ."\n"
+ .'APIs generated in wizard or script mode support only the Query position. APIs generated by registration whose request method is GET or DELETE support the Query and Head positions. APIs generated by registration whose request method is PUT or POST support the Query, Head, and Body positions.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '0',
+ ],
+ 'ParameterDescription' => [
+ 'description' => 'The description.'."\n",
+ 'type' => 'string',
+ 'example' => 'description1',
+ ],
+ 'DefaultValue' => [
+ 'description' => 'The default value.'."\n",
+ 'type' => 'string',
+ 'example' => 'default1',
+ ],
+ 'ParameterOperator' => [
+ 'description' => 'The operator used for the value of the parameter. Valid values:'."\n"
+ ."\n"
+ .'* 0: Equal'."\n"
+ .'* 1: Like'."\n"
+ .'* 2: Const'."\n"
+ .'* 3: In'."\n"
+ ."\n"
+ .'APIs generated in wizard mode support the Equal, Like, and In operators. APIs generated in script mode support the Equal operator. APIs generated by registration support the Equal and Const operators.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '0',
+ ],
+ 'ExampleValue' => [
+ 'description' => 'The sample value.'."\n",
+ 'type' => 'string',
+ 'example' => 'example1',
+ ],
+ 'ParameterDataType' => [
+ 'description' => 'The data type of the parameter. Valid values:'."\n"
+ ."\n"
+ .'* 0: String'."\n"
+ .'* 1: Int'."\n"
+ .'* 2: Long'."\n"
+ .'* 3: Float'."\n"
+ .'* 4: Double'."\n"
+ .'* 5: Boolean'."\n"
+ .'* 6: StringList'."\n"
+ .'* 7: IntList'."\n"
+ .'* 8: LongList'."\n"
+ .'* 9: FloatList'."\n"
+ .'* 10: DoubleList'."\n"
+ .'* 11: BooleanList'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '0',
+ ],
+ 'IsRequiredParameter' => [
+ 'description' => 'Indicates whether the parameter is required.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ ],
+ 'description' => 'The returned result.'."\n",
+ ],
+ ],
+ 'ScriptResponseParameters' => [
+ 'description' => 'The response parameters of the API generated in script mode.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'ParameterDescription' => [
+ 'description' => 'The description.'."\n",
+ 'type' => 'string',
+ 'example' => 'description2',
+ ],
+ 'ParameterName' => [
+ 'description' => 'The name of the parameter.'."\n",
+ 'type' => 'string',
+ 'example' => 'param2',
+ ],
+ 'ExampleValue' => [
+ 'description' => 'The sample value.'."\n",
+ 'type' => 'string',
+ 'example' => 'example2',
+ ],
+ 'ParameterDataType' => [
+ 'description' => 'The data type of the parameter. Valid values:'."\n"
+ ."\n"
+ .'* 0: String'."\n"
+ .'* 1: Int'."\n"
+ .'* 2: Long'."\n"
+ .'* 3: Float'."\n"
+ .'* 4: Double'."\n"
+ .'* 5: Boolean'."\n"
+ .'* 6: StringList'."\n"
+ .'* 7: IntList'."\n"
+ .'* 8: LongList'."\n"
+ .'* 9: FloatList'."\n"
+ .'* 10: DoubleList'."\n"
+ .'* 11: BooleanList'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '0',
+ ],
+ ],
+ 'description' => 'The returned result.'."\n",
+ ],
+ ],
+ 'ScriptConnection' => [
+ 'description' => 'The data source information of the API generated in script mode.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'TableName' => [
+ 'description' => 'The name of the table in the data source.'."\n",
+ 'type' => 'string',
+ 'example' => 't',
+ ],
+ 'ConnectionId' => [
+ 'description' => 'The ID of the data source.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '123',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'WizardDetails' => [
+ 'description' => 'The details of the API generated in wizard mode. This parameter is returned only if the API is generated in wizard mode.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'IsPagedResponse' => [
+ 'description' => 'Indicates whether the entries were returned by page.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'SuccessfulResultSample' => [
+ 'description' => 'The sample success response of the API.'."\n",
+ 'type' => 'string',
+ 'example' => '{"success": true}',
+ ],
+ 'FailedResultSample' => [
+ 'description' => 'The sample error response of the API.'."\n",
+ 'type' => 'string',
+ 'example' => '{"success": false}',
+ ],
+ 'WizardErrorCodes' => [
+ 'description' => 'The error codes returned for the API generated in wizard mode.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'ErrorMessage' => [
+ 'description' => 'The error message.'."\n",
+ 'type' => 'string',
+ 'example' => 'fail to call',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code.'."\n",
+ 'type' => 'string',
+ 'example' => '1001',
+ ],
+ 'ErrorSolution' => [
+ 'description' => 'The solution used to fix the error.'."\n",
+ 'type' => 'string',
+ 'example' => 'retry',
+ ],
+ ],
+ 'description' => 'The returned result.'."\n",
+ ],
+ ],
+ 'WizardRequestParameters' => [
+ 'description' => 'The request parameters of the API generated in wizard mode.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'ParameterName' => [
+ 'description' => 'The name of the parameter.'."\n",
+ 'type' => 'string',
+ 'example' => 'param1',
+ ],
+ 'ParameterPosition' => [
+ 'description' => 'The position of the parameter. Valid values: 0, 1, 2, and 3. The value 0 indicates that the parameter is in the URL path of the request. The value 1 indicates that the parameter is in the Query parameter of the request URL. The value 2 indicates that the parameter is in the request header. The value 3 indicates that the parameter is in the request body. APIs generated in wizard or script mode support only the Query position. APIs generated by registration whose request method is GET or DELETE support the Query and Head positions. APIs generated by registration whose request method is PUT or POST support the Query, Head, and Body positions.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '0',
+ ],
+ 'ParameterDescription' => [
+ 'description' => 'The description.'."\n",
+ 'type' => 'string',
+ 'example' => 'description1',
+ ],
+ 'DefaultValue' => [
+ 'description' => 'The default value.'."\n",
+ 'type' => 'string',
+ 'example' => 'default1',
+ ],
+ 'ParameterOperator' => [
+ 'description' => 'The operator used for the value of the parameter. Valid values: 0, 1, 2, and 3. The value 0 indicates the Equal operator. The value 1 indicates the Like operator. The value 2 indicates the Const operator. The value 3 indicates the In operator. APIs generated in wizard mode support the Equal, Like, and In operators. APIs generated in script mode support the Equal operator. APIs generated by registration support the Equal and Const operators.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '0',
+ ],
+ 'ExampleValue' => [
+ 'description' => 'The sample value.'."\n",
+ 'type' => 'string',
+ 'example' => 'example1',
+ ],
+ 'ParameterDataType' => [
+ 'description' => 'The data type of the parameter. Valid values:'."\n"
+ ."\n"
+ .'* 0: String'."\n"
+ .'* 1: Int'."\n"
+ .'* 2: Long'."\n"
+ .'* 3: Float'."\n"
+ .'* 4: Double'."\n"
+ .'* 5: Boolean'."\n"
+ .'* 6: StringList'."\n"
+ .'* 7: IntList'."\n"
+ .'* 8: LongList'."\n"
+ .'* 9: FloatList'."\n"
+ .'* 10: DoubleList'."\n"
+ .'* 11: BooleanList'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '0',
+ ],
+ 'IsRequiredParameter' => [
+ 'description' => 'Indicates whether the parameter is required.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ ],
+ 'description' => 'The returned result.'."\n",
+ ],
+ ],
+ 'WizardResponseParameters' => [
+ 'description' => 'The response parameters of the API generated in wizard mode.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The returned result.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'ParameterDescription' => [
+ 'description' => 'The description.'."\n",
+ 'type' => 'string',
+ 'example' => 'description2',
+ ],
+ 'ParameterName' => [
+ 'description' => 'The name of the parameter.'."\n",
+ 'type' => 'string',
+ 'example' => 'param2',
+ ],
+ 'ExampleValue' => [
+ 'description' => 'The sample value.'."\n",
+ 'type' => 'string',
+ 'example' => 'example2',
+ ],
+ 'ParameterDataType' => [
+ 'description' => 'The data type of the parameter. Valid values:'."\n"
+ ."\n"
+ .'* 0: String'."\n"
+ .'* 1: Int'."\n"
+ .'* 2: Long'."\n"
+ .'* 3: Float'."\n"
+ .'* 4: Double'."\n"
+ .'* 5: Boolean'."\n"
+ .'* 6: StringList'."\n"
+ .'* 7: IntList'."\n"
+ .'* 8: LongList'."\n"
+ .'* 9: FloatList'."\n"
+ .'* 10: DoubleList'."\n"
+ .'* 11: BooleanList'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '0',
+ ],
+ ],
+ ],
+ ],
+ 'WizardConnection' => [
+ 'description' => 'The data source information of the API generated in wizard mode.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'TableName' => [
+ 'description' => 'The name of the table in the data source.'."\n",
+ 'type' => 'string',
+ 'example' => 't',
+ ],
+ 'ConnectionId' => [
+ 'description' => 'The ID of the data source.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '123',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'SqlMode' => [
+ 'title' => 'SQL模式，0：基础SQL；1：高级SQL',
+ 'description' => 'The SQL mode. 0: Basic SQL; 1: Advanced SQL.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '0',
+ ],
+ ],
+ ],
+ ],
+ 'description' => '',
+ ],
+ ],
+ ],
+ 'errorCodes' => [
+ 403 => [
+ [
+ 'errorCode' => 'Forbidden.Access',
+ 'errorMessage' => 'Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.',
+ ],
+ ],
+ 429 => [
+ [
+ 'errorCode' => 'Throttling.Api',
+ 'errorMessage' => 'The request for this resource has exceeded your available limit.',
+ ],
+ [
+ 'errorCode' => 'Throttling.System',
+ 'errorMessage' => 'The DataWorks system is busy. Try again later.',
+ ],
+ [
+ 'errorCode' => 'Throttling.User',
+ 'errorMessage' => 'Your request is too frequent. Try again later.',
+ ],
+ ],
+ 500 => [
+ [
+ 'errorCode' => 'InternalError.System',
+ 'errorMessage' => 'An internal system error occurred. Try again later.',
+ ],
+ [
+ 'errorCode' => 'InternalError.UserId.Missing',
+ 'errorMessage' => 'An internal system error occurred. Try again later.',
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"0000-ABCD-EFG****\\",\\n \\"ErrorMessage\\": \\"The connection does not exist.\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"Invalid.Tenant.ConnectionNotExists\\",\\n \\"Data\\": {\\n \\"Timeout\\": 10000,\\n \\"Status\\": 1,\\n \\"ApiId\\": 10000,\\n \\"ApiMode\\": 0,\\n \\"ProjectId\\": 10001,\\n \\"ResponseContentType\\": 0,\\n \\"CreatorId\\": \\"1234567\\",\\n \\"VisibleRange\\": 0,\\n \\"ModifiedTime\\": \\"2020-06-23T00:21:01+0800\\",\\n \\"OperatorId\\": \\"2345678\\",\\n \\"GroupId\\": \\"ab12**\\",\\n \\"Description\\": \\"测试API描述\\",\\n \\"RequestMethod\\": 0,\\n \\"CreatedTime\\": \\"2020-06-23T00:21:01+0800\\",\\n \\"ApiName\\": \\"测试API名称\\",\\n \\"TenantId\\": 10001,\\n \\"ApiPath\\": \\"/test/1\\",\\n \\"Protocols\\": [\\n 0\\n ],\\n \\"RegistrationDetails\\": {\\n \\"ServiceHost\\": \\"http://www.abc.com\\",\\n \\"ServiceContentType\\": 0,\\n \\"ServicePath\\": \\"/index\\",\\n \\"SuccessfulResultSample\\": \\"{\\\\\\"success\\\\\\": true}\\",\\n \\"FailedResultSample\\": \\"{\\\\\\"success\\\\\\": false}\\",\\n \\"ServiceRequestBodyDescription\\": \\"{\\\\\\"abc\\\\\\":1}\\",\\n \\"RegistrationErrorCodes\\": [\\n {\\n \\"ErrorMessage\\": \\"The connection does not exist.\\",\\n \\"ErrorCode\\": \\"Invalid.Tenant.ConnectionNotExists\\",\\n \\"ErrorSolution\\": \\"retry\\"\\n }\\n ],\\n \\"RegistrationRequestParameters\\": [\\n {\\n \\"ParameterName\\": \\"name1\\",\\n \\"ParameterPosition\\": 0,\\n \\"ParameterDescription\\": \\"description1\\",\\n \\"DefaultValue\\": \\"default1\\",\\n \\"ParameterOperator\\": 0,\\n \\"ExampleValue\\": \\"example1\\",\\n \\"ParameterDataType\\": 0,\\n \\"IsRequiredParameter\\": true\\n }\\n ]\\n },\\n \\"ScriptDetails\\": {\\n \\"IsPagedResponse\\": true,\\n \\"SuccessfulResultSample\\": \\"{\\\\\\"success\\\\\\": true}\\",\\n \\"FailedResultSample\\": \\"{\\\\\\"success\\\\\\": false}\\",\\n \\"Script\\": \\"select a from t\\",\\n \\"ScriptErrorCodes\\": [\\n {\\n \\"ErrorMessage\\": \\"fail to call\\",\\n \\"ErrorCode\\": \\"1001\\",\\n \\"ErrorSolution\\": \\"retry\\"\\n }\\n ],\\n \\"ScriptRequestParameters\\": [\\n {\\n \\"ParameterName\\": \\"param1\\",\\n \\"ParameterPosition\\": 0,\\n \\"ParameterDescription\\": \\"description1\\",\\n \\"DefaultValue\\": \\"default1\\",\\n \\"ParameterOperator\\": 0,\\n \\"ExampleValue\\": \\"example1\\",\\n \\"ParameterDataType\\": 0,\\n \\"IsRequiredParameter\\": true\\n }\\n ],\\n \\"ScriptResponseParameters\\": [\\n {\\n \\"ParameterDescription\\": \\"description2\\",\\n \\"ParameterName\\": \\"param2\\",\\n \\"ExampleValue\\": \\"example2\\",\\n \\"ParameterDataType\\": 0\\n }\\n ],\\n \\"ScriptConnection\\": {\\n \\"TableName\\": \\"t\\",\\n \\"ConnectionId\\": 123\\n }\\n },\\n \\"WizardDetails\\": {\\n \\"IsPagedResponse\\": true,\\n \\"SuccessfulResultSample\\": \\"{\\\\\\"success\\\\\\": true}\\",\\n \\"FailedResultSample\\": \\"{\\\\\\"success\\\\\\": false}\\",\\n \\"WizardErrorCodes\\": [\\n {\\n \\"ErrorMessage\\": \\"fail to call\\",\\n \\"ErrorCode\\": \\"1001\\",\\n \\"ErrorSolution\\": \\"retry\\"\\n }\\n ],\\n \\"WizardRequestParameters\\": [\\n {\\n \\"ParameterName\\": \\"param1\\",\\n \\"ParameterPosition\\": 0,\\n \\"ParameterDescription\\": \\"description1\\",\\n \\"DefaultValue\\": \\"default1\\",\\n \\"ParameterOperator\\": 0,\\n \\"ExampleValue\\": \\"example1\\",\\n \\"ParameterDataType\\": 0,\\n \\"IsRequiredParameter\\": true\\n }\\n ],\\n \\"WizardResponseParameters\\": [\\n {\\n \\"ParameterDescription\\": \\"description2\\",\\n \\"ParameterName\\": \\"param2\\",\\n \\"ExampleValue\\": \\"example2\\",\\n \\"ParameterDataType\\": 0\\n }\\n ],\\n \\"WizardConnection\\": {\\n \\"TableName\\": \\"t\\",\\n \\"ConnectionId\\": 123\\n }\\n },\\n \\"SqlMode\\": 0\\n }\\n}","errorExample":""},{"type":"xml","example":"<GetDataServicePublishedApiResponse>\\n <HttpStatusCode>200</HttpStatusCode>\\n <RequestId>0000-ABCD-EFG****</RequestId>\\n <ErrorMessage>The connection does not exist.</ErrorMessage>\\n <Success>true</Success>\\n <ErrorCode>Invalid.Tenant.ConnectionNotExists</ErrorCode>\\n <Data>\\n <Timeout>10000</Timeout>\\n <Status>1</Status>\\n <ApiId>10000</ApiId>\\n <ApiMode>0</ApiMode>\\n <ProjectId>10001</ProjectId>\\n <ResponseContentType>0</ResponseContentType>\\n <CreatorId>1234567</CreatorId>\\n <VisibleRange>0</VisibleRange>\\n <ModifiedTime>2020-06-23T00:21:01+0800</ModifiedTime>\\n <OperatorId>2345678</OperatorId>\\n <GroupId>ab12**</GroupId>\\n <Description>测试API描述</Description>\\n <RequestMethod>0</RequestMethod>\\n <CreatedTime>2020-06-23T00:21:01+0800</CreatedTime>\\n <ApiName>测试API名称</ApiName>\\n <TenantId>10001</TenantId>\\n <ApiPath>/test/1</ApiPath>\\n <Protocols>0</Protocols>\\n <RegistrationDetails>\\n <ServiceHost>http://www.abc.com</ServiceHost>\\n <ServiceContentType>0</ServiceContentType>\\n <ServicePath>/index</ServicePath>\\n <SuccessfulResultSample>{\\"success\\": true}</SuccessfulResultSample>\\n <FailedResultSample>{\\"success\\": false}</FailedResultSample>\\n <ServiceRequestBodyDescription>{\\"abc\\":1}</ServiceRequestBodyDescription>\\n <RegistrationErrorCodes>\\n <ErrorMessage>The connection does not exist.</ErrorMessage>\\n <ErrorCode>Invalid.Tenant.ConnectionNotExists</ErrorCode>\\n <ErrorSolution>retry</ErrorSolution>\\n </RegistrationErrorCodes>\\n <RegistrationRequestParameters>\\n <ParameterName>name1</ParameterName>\\n <ParameterPosition>0</ParameterPosition>\\n <ParameterDescription>description1</ParameterDescription>\\n <DefaultValue>default1</DefaultValue>\\n <ParameterOperator>0</ParameterOperator>\\n <ExampleValue>example1</ExampleValue>\\n <ParameterDataType>0</ParameterDataType>\\n <IsRequiredParameter>true</IsRequiredParameter>\\n </RegistrationRequestParameters>\\n </RegistrationDetails>\\n <ScriptDetails>\\n <IsPagedResponse>true</IsPagedResponse>\\n <SuccessfulResultSample>{\\"success\\": true}</SuccessfulResultSample>\\n <FailedResultSample>{\\"success\\": false}</FailedResultSample>\\n <Script>select a from t</Script>\\n <ScriptErrorCodes>\\n <ErrorMessage>fail to call</ErrorMessage>\\n <ErrorCode>1001</ErrorCode>\\n <ErrorSolution>retry</ErrorSolution>\\n </ScriptErrorCodes>\\n <ScriptRequestParameters>\\n <ParameterName>param1</ParameterName>\\n <ParameterPosition>0</ParameterPosition>\\n <ParameterDescription>description1</ParameterDescription>\\n <DefaultValue>default1</DefaultValue>\\n <ParameterOperator>0</ParameterOperator>\\n <ExampleValue>example1</ExampleValue>\\n <ParameterDataType>0</ParameterDataType>\\n <IsRequiredParameter>true</IsRequiredParameter>\\n </ScriptRequestParameters>\\n <ScriptResponseParameters>\\n <ParameterDescription>description2</ParameterDescription>\\n <ParameterName>param2</ParameterName>\\n <ExampleValue>example2</ExampleValue>\\n <ParameterDataType>0</ParameterDataType>\\n </ScriptResponseParameters>\\n <ScriptConnection>\\n <TableName>t</TableName>\\n <ConnectionId>123</ConnectionId>\\n </ScriptConnection>\\n </ScriptDetails>\\n <WizardDetails>\\n <IsPagedResponse>true</IsPagedResponse>\\n <SuccessfulResultSample>{\\"success\\": true}</SuccessfulResultSample>\\n <FailedResultSample>{\\"success\\": false}</FailedResultSample>\\n <WizardErrorCodes>\\n <ErrorMessage>fail to call</ErrorMessage>\\n <ErrorCode>1001</ErrorCode>\\n <ErrorSolution>retry</ErrorSolution>\\n </WizardErrorCodes>\\n <WizardRequestParameters>\\n <ParameterName>param1</ParameterName>\\n <ParameterPosition>0</ParameterPosition>\\n <ParameterDescription>description1</ParameterDescription>\\n <DefaultValue>default1</DefaultValue>\\n <ParameterOperator>0</ParameterOperator>\\n <ExampleValue>example1</ExampleValue>\\n <ParameterDataType>0</ParameterDataType>\\n <IsRequiredParameter>true</IsRequiredParameter>\\n </WizardRequestParameters>\\n <WizardResponseParameters>\\n <ParameterDescription>description2</ParameterDescription>\\n <ParameterName>param2</ParameterName>\\n <ExampleValue>example2</ExampleValue>\\n <ParameterDataType>0</ParameterDataType>\\n </WizardResponseParameters>\\n <WizardConnection>\\n <TableName>t</TableName>\\n <ConnectionId>123</ConnectionId>\\n </WizardConnection>\\n </WizardDetails>\\n </Data>\\n</GetDataServicePublishedApiResponse>","errorExample":""}]',
+ 'title' => 'GetDataServicePublishedApi',
+ 'requestParamsDescription' => ' ',
+ 'responseParamsDescription' => 'The details about the APIs of different types are returned in different parameters. The details about the API generated in wizard mode are returned in the WizardDetails parameter. The details about the API generated in script mode are returned in the ScriptDetails parameter. The details about the API generated by registration are returned in the RegistrationDetails parameter.'."\n",
+ 'extraInfo' => ' ',
+ ],
+ 'ListDataServicePublishedApis' => [
+ 'summary' => 'Queries a list of APIs in the published state.',
+ 'methods' => [
+ 'post',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'get',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeCode' => '78306',
+ 'abilityTreeNodes' => [
+ 'FEATUREdide7T0EJX',
+ ],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'PageNumber',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The page number. Pages start from page 1. Default value: 1.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => false,
+ 'docRequired' => true,
+ 'minimum' => '1',
+ 'example' => '1',
+ 'default' => '1',
+ ],
+ ],
+ [
+ 'name' => 'PageSize',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The number of entries per page. Default is 10, and the maximum is 100.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => false,
+ 'docRequired' => true,
+ 'maximum' => '50',
+ 'minimum' => '1',
+ 'example' => '10',
+ 'default' => '10',
+ ],
+ ],
+ [
+ 'name' => 'ProjectId',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The workspace ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => '10000',
+ ],
+ ],
+ [
+ 'name' => 'TenantId',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The tenant ID. To obtain the tenant ID, perform the following steps: Log on to the [DataWorks console](https://workbench.data.aliyun.com/console). Find your workspace and go to the DataStudio page. On the DataStudio page, click the logon username in the upper-right corner and click User Info in the Menu section.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'docRequired' => false,
+ 'example' => '10001',
+ ],
+ ],
+ [
+ 'name' => 'ApiNameKeyword',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The keyword in API names. The keyword is used to search for the APIs whose names contain the keyword.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'My API name',
+ ],
+ ],
+ [
+ 'name' => 'ApiPathKeyword',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The keyword in API paths. The keyword is used to search for the APIs whose paths contain the keyword.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => '/test/',
+ ],
+ ],
+ [
+ 'name' => 'CreatorId',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The ID of the Alibaba Cloud account used by the creator of the APIs. The ID is used to search for the APIs created by the creator.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => '12345',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'HttpStatusCode' => [
+ 'description' => 'The HTTP status code.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '200',
+ ],
+ 'RequestId' => [
+ 'description' => 'The request ID.'."\n",
+ 'type' => 'string',
+ 'example' => '0000-ABCD-EFG****',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message.'."\n",
+ 'type' => 'string',
+ 'example' => 'The connection does not exist.',
+ ],
+ 'Success' => [
+ 'description' => 'Indicates whether the request was successful.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code.'."\n",
+ 'type' => 'string',
+ 'example' => 'Invalid.Tenant.ConnectionNotExists',
+ ],
+ 'Data' => [
+ 'description' => 'The data returned.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'PageNumber' => [
+ 'description' => 'The page number. The value of this parameter is the same as that of the PageNumber parameter in the request.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '1',
+ ],
+ 'PageSize' => [
+ 'description' => 'The number of entries per page. Valid values: 1 to 100. Default value: 10.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '10',
+ ],
+ 'TotalCount' => [
+ 'description' => 'The total number of entries returned.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '100',
+ ],
+ 'Apis' => [
+ 'description' => 'Information about published APIs.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'Timeout' => [
+ 'description' => 'The timeout period of the API request. Unit: milliseconds.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '10000',
+ ],
+ 'Status' => [
+ 'description' => 'The status of the API. Valid values: 0 and 1. The value 0 indicates that the API is not published. The value 1 indicates that the API is published.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '1',
+ ],
+ 'ApiId' => [
+ 'description' => 'The API ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '10002',
+ ],
+ 'ApiMode' => [
+ 'description' => 'The type of the API. Valid values: 0, 1, and 2. The value 0 indicates that the API is generated in wizard mode. The value 1 indicates that the API is generated in script mode. The value 2 indicates that the API is generated by registration.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '0',
+ ],
+ 'ProjectId' => [
+ 'description' => 'The workspace ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '10000',
+ ],
+ 'ResponseContentType' => [
+ 'description' => 'The format in which the response of the API request is returned. Valid values: 0 and 1. The value 0 indicates the JSON format. The value 1 indicates the XML format. APIs generated in wizard or script mode support the JSON format. APIs generated by registration support the JSON and XML formats.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '0',
+ ],
+ 'CreatorId' => [
+ 'description' => 'The ID of the Alibaba Cloud account used by the creator of the API.'."\n",
+ 'type' => 'string',
+ 'example' => '1234567',
+ ],
+ 'VisibleRange' => [
+ 'description' => 'The scope in which the API is visible. Valid values: 0 and 1. The value 0 indicates that the API is visible within the workspace. The value 1 indicates that the API is visible only to its owner.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '0',
+ ],
+ 'ModifiedTime' => [
+ 'description' => 'The time when the API was last modified.'."\n",
+ 'type' => 'string',
+ 'example' => '2020-06-23T00:21:01+0800',
+ ],
+ 'OperatorId' => [
+ 'description' => 'The ID of the Alibaba Cloud account used by the user who last modified the API.'."\n",
+ 'type' => 'string',
+ 'example' => '2345678',
+ ],
+ 'GroupId' => [
+ 'description' => 'The group ID.'."\n",
+ 'type' => 'string',
+ 'example' => 'ab123',
+ ],
+ 'Description' => [
+ 'description' => 'The description.'."\n",
+ 'type' => 'string',
+ 'example' => 'Test API description',
+ ],
+ 'RequestMethod' => [
+ 'description' => 'The request method of the API. Valid values: 0, 1, 2, and 3. The value 0 indicates the GET method. The value 1 indicates the POST method. The value 2 indicates the PUT method. The value 3 indicates the DELETE method. APIs generated in wizard or script mode support the GET and POST methods. APIs generated by registration support the GET, POST, PUT, and DELETE methods.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '0',
+ ],
+ 'CreatedTime' => [
+ 'description' => 'The time when the API was created.'."\n",
+ 'type' => 'string',
+ 'example' => '2020-06-23T00:21:01+0800',
+ ],
+ 'ApiName' => [
+ 'description' => 'The name of the API.'."\n",
+ 'type' => 'string',
+ 'example' => 'My API name',
+ ],
+ 'TenantId' => [
+ 'description' => 'The tenant ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '10001',
+ ],
+ 'ApiPath' => [
+ 'description' => 'The path of the API.'."\n",
+ 'type' => 'string',
+ 'example' => '/test/1',
+ ],
+ 'Protocols' => [
+ 'description' => 'The protocol used by the API. Valid values: 0 and 1. The value 0 indicates HTTP. The value 1 indicates HTTPS.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The protocol used by the API. Valid values: 0 and 1. The value 0 indicates HTTP. The value 1 indicates HTTPS.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '0',
+ ],
+ ],
+ 'RegistrationDetails' => [
+ 'description' => 'The details of the API generated by registration. This parameter is returned only if the API is generated by registration.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'ServiceHost' => [
+ 'description' => 'The URL of the backend service.'."\n",
+ 'type' => 'string',
+ 'example' => 'http://example.aliyundoc.com',
+ ],
+ 'ServiceContentType' => [
+ 'description' => 'The format in which the response of the API request is returned. Valid values: 0 and 1. The value 0 indicates the JSON format. The value 1 indicates the XML format. APIs generated in wizard or script mode support the JSON format. APIs generated by registration support the JSON and XML formats.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '0',
+ ],
+ 'ServicePath' => [
+ 'description' => 'The path of the backend service.'."\n",
+ 'type' => 'string',
+ 'example' => '/index',
+ ],
+ 'SuccessfulResultSample' => [
+ 'description' => 'The sample success response of the API.'."\n",
+ 'type' => 'string',
+ 'example' => '{"success": true}',
+ ],
+ 'FailedResultSample' => [
+ 'description' => 'The sample error response of the API.'."\n",
+ 'type' => 'string',
+ 'example' => '{"success": false}',
+ ],
+ 'ServiceRequestBodyDescription' => [
+ 'description' => 'The description of the request body initiated to call the backend service.'."\n",
+ 'type' => 'string',
+ 'example' => '{"abc":1}',
+ ],
+ 'RegistrationErrorCodes' => [
+ 'description' => 'The error codes returned for the API generated by registration.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '',
+ 'type' => 'object',
+ 'properties' => [
+ 'ErrorMessage' => [
+ 'description' => 'The error message.'."\n",
+ 'type' => 'string',
+ 'example' => 'fail to call',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code.'."\n",
+ 'type' => 'string',
+ 'example' => '1001',
+ ],
+ 'ErrorSolution' => [
+ 'description' => 'The solution used to fix the error.'."\n",
+ 'type' => 'string',
+ 'example' => 'retry',
+ ],
+ ],
+ ],
+ ],
+ 'RegistrationRequestParameters' => [
+ 'description' => 'The request parameters of the API generated by registration.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'ParameterName' => [
+ 'description' => 'The name of the parameter.'."\n",
+ 'type' => 'string',
+ 'example' => 'name1',
+ ],
+ 'ParameterPosition' => [
+ 'description' => 'The position of the parameter. Valid values:'."\n"
+ ."\n"
+ .'* 0: indicates that the parameter is in the URL path of the request.'."\n"
+ .'* 1: indicates that the parameter is in the Query parameter of the request URL.'."\n"
+ .'* 2: indicates that the parameter is in the request header.'."\n"
+ .'* 3: indicates that the parameter is in the request body.'."\n"
+ ."\n"
+ .'APIs generated in wizard or script mode support only the Query position. APIs generated by registration whose request method is GET or DELETE support the Query and Head positions. APIs generated by registration whose request method is PUT or POST support the Query, Head, and Body positions.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '0',
+ ],
+ 'ParameterDescription' => [
+ 'description' => 'The description.'."\n",
+ 'type' => 'string',
+ 'example' => 'description1',
+ ],
+ 'DefaultValue' => [
+ 'description' => 'The default value.'."\n",
+ 'type' => 'string',
+ 'example' => 'default1',
+ ],
+ 'ParameterOperator' => [
+ 'description' => 'The operator used for the value of the parameter. Valid values:'."\n"
+ ."\n"
+ .'* 0: Equal'."\n"
+ .'* 1: Like'."\n"
+ .'* 2: Const'."\n"
+ .'* 3: In'."\n"
+ ."\n"
+ .'APIs generated in wizard mode support the Equal, Like, and In operators. APIs generated in script mode support the Equal operator. APIs generated by registration support the Equal and Const operators.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '0',
+ ],
+ 'ExampleValue' => [
+ 'description' => 'The sample value.'."\n",
+ 'type' => 'string',
+ 'example' => 'example1',
+ ],
+ 'ParameterDataType' => [
+ 'description' => 'The data type of the parameter. Valid values:'."\n"
+ ."\n"
+ .'* 0: String'."\n"
+ .'* 1: Int'."\n"
+ .'* 2: Long'."\n"
+ .'* 3: Float'."\n"
+ .'* 4: Double'."\n"
+ .'* 5: Boolean'."\n"
+ .'* 6: StringList'."\n"
+ .'* 7: IntList'."\n"
+ .'* 8: LongList'."\n"
+ .'* 9: FloatList'."\n"
+ .'* 10: DoubleList'."\n"
+ .'* 11: BooleanList'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '0',
+ ],
+ 'IsRequiredParameter' => [
+ 'description' => 'Indicates whether the request parameter is required.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ ],
+ 'description' => '',
+ ],
+ ],
+ ],
+ ],
+ 'ScriptDetails' => [
+ 'description' => 'The details of the API generated in script mode. This parameter is returned only if the API is generated in script mode.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'IsPagedResponse' => [
+ 'description' => 'Indicates whether the entries are returned by page.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'SuccessfulResultSample' => [
+ 'description' => 'The sample success response of the API.'."\n",
+ 'type' => 'string',
+ 'example' => '{"success": true}',
+ ],
+ 'FailedResultSample' => [
+ 'description' => 'The sample error response of the API.'."\n",
+ 'type' => 'string',
+ 'example' => '{"success": false}',
+ ],
+ 'Script' => [
+ 'description' => 'The SQL script.'."\n",
+ 'type' => 'string',
+ 'example' => 'select a from t',
+ ],
+ 'ScriptErrorCodes' => [
+ 'description' => 'The error codes returned for the API generated in script mode.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'ErrorMessage' => [
+ 'description' => 'The error message.'."\n",
+ 'type' => 'string',
+ 'example' => 'fail to call',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code.'."\n",
+ 'type' => 'string',
+ 'example' => '1001',
+ ],
+ 'ErrorSolution' => [
+ 'description' => 'The solution used to fix the error.'."\n",
+ 'type' => 'string',
+ 'example' => 'retry',
+ ],
+ ],
+ 'description' => '',
+ ],
+ ],
+ 'ScriptRequestParameters' => [
+ 'description' => 'The request parameters of the API generated in script mode.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'ParameterName' => [
+ 'description' => 'The name of the parameter.'."\n",
+ 'type' => 'string',
+ 'example' => 'param1',
+ ],
+ 'ParameterPosition' => [
+ 'description' => 'The position of the parameter. Valid values:'."\n"
+ ."\n"
+ .'* 0: indicates that the parameter is in the URL path of the request.'."\n"
+ .'* 1: indicates that the parameter is in the Query parameter of the request URL.'."\n"
+ .'* 2: indicates that the parameter is in the request header.'."\n"
+ .'* 3: indicates that the parameter is in the request body.'."\n"
+ ."\n"
+ .'APIs generated in wizard or script mode support only the Query position. APIs generated by registration whose request method is GET or DELETE support the Query and Head positions. APIs generated by registration whose request method is PUT or POST support the Query, Head, and Body positions.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '0',
+ ],
+ 'ParameterDescription' => [
+ 'description' => 'The description.'."\n",
+ 'type' => 'string',
+ 'example' => 'description1',
+ ],
+ 'DefaultValue' => [
+ 'description' => 'The default value.'."\n",
+ 'type' => 'string',
+ 'example' => 'default1',
+ ],
+ 'ParameterOperator' => [
+ 'description' => 'The operator used for the value of the parameter. Valid values:'."\n"
+ ."\n"
+ .'* 0: Equal'."\n"
+ .'* 1: Like'."\n"
+ .'* 2: Const'."\n"
+ .'* 3: In'."\n"
+ ."\n"
+ .'APIs generated in wizard mode support the Equal, Like, and In operators. APIs generated in script mode support the Equal operator. APIs generated by registration support the Equal and Const operators.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '0',
+ ],
+ 'ExampleValue' => [
+ 'description' => 'The sample value.'."\n",
+ 'type' => 'string',
+ 'example' => 'example1',
+ ],
+ 'ParameterDataType' => [
+ 'description' => 'The data type of the parameter. Valid values:'."\n"
+ ."\n"
+ .'* 0: String'."\n"
+ .'* 1: Int'."\n"
+ .'* 2: Long'."\n"
+ .'* 3: Float'."\n"
+ .'* 4: Double'."\n"
+ .'* 5: Boolean'."\n"
+ ."\n"
+ .'Advanced scripts also support the following data types:'."\n"
+ ."\n"
+ .'* 6: StringList'."\n"
+ .'* 7: IntList'."\n"
+ .'* 8: LongList'."\n"
+ .'* 9: FloatList'."\n"
+ .'* 10: DoubleList'."\n"
+ .'* 11: BooleanList'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '0',
+ ],
+ 'IsRequiredParameter' => [
+ 'description' => 'Indicates whether the request parameter is required.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ ],
+ 'description' => '',
+ ],
+ ],
+ 'ScriptResponseParameters' => [
+ 'description' => 'The response parameters of the API generated in script mode.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'ParameterDescription' => [
+ 'description' => 'The description.'."\n",
+ 'type' => 'string',
+ 'example' => 'description2',
+ ],
+ 'ParameterName' => [
+ 'description' => 'The name of the parameter.'."\n",
+ 'type' => 'string',
+ 'example' => 'param2',
+ ],
+ 'ExampleValue' => [
+ 'description' => 'The sample value.'."\n",
+ 'type' => 'string',
+ 'example' => 'example2',
+ ],
+ 'ParameterDataType' => [
+ 'description' => 'The data type of the parameter. Valid values:'."\n"
+ ."\n"
+ .'* 0: String'."\n"
+ .'* 1: Int'."\n"
+ .'* 2: Long'."\n"
+ .'* 3: Float'."\n"
+ .'* 4: Double'."\n"
+ .'* 5: Boolean'."\n"
+ .'* 6: StringList'."\n"
+ .'* 7: IntList'."\n"
+ .'* 8: LongList'."\n"
+ .'* 9: FloatList'."\n"
+ .'* 10: DoubleList'."\n"
+ .'* 11: BooleanList'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '0',
+ ],
+ ],
+ 'description' => '',
+ ],
+ ],
+ 'ScriptConnection' => [
+ 'description' => 'The data source information about the API generated in script mode.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'TableName' => [
+ 'description' => 'The name of the table in the data source.'."\n",
+ 'type' => 'string',
+ 'example' => 't',
+ ],
+ 'ConnectionId' => [
+ 'description' => 'The data source ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '123',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'WizardDetails' => [
+ 'description' => 'The details of the API generated in wizard mode. This parameter is returned only if the API is generated in wizard mode.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'IsPagedResponse' => [
+ 'description' => 'Indicates whether the entries are returned by page.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'SuccessfulResultSample' => [
+ 'description' => 'The sample success response of the API.'."\n",
+ 'type' => 'string',
+ 'example' => '{"success": true}',
+ ],
+ 'FailedResultSample' => [
+ 'description' => 'The sample error response of the API.'."\n",
+ 'type' => 'string',
+ 'example' => '{"success": false}',
+ ],
+ 'WizardErrorCodes' => [
+ 'description' => 'The error codes returned for the API generated in wizard mode.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'ErrorMessage' => [
+ 'description' => 'The error message.'."\n",
+ 'type' => 'string',
+ 'example' => 'fail to call',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code.'."\n",
+ 'type' => 'string',
+ 'example' => '1001',
+ ],
+ 'ErrorSolution' => [
+ 'description' => 'The solution used to fix the error.'."\n",
+ 'type' => 'string',
+ 'example' => 'retry',
+ ],
+ ],
+ 'description' => '',
+ ],
+ ],
+ 'WizardRequestParameters' => [
+ 'description' => 'The request parameters of the API generated in wizard mode.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'ParameterName' => [
+ 'description' => 'The name of the parameter.'."\n",
+ 'type' => 'string',
+ 'example' => 'param1',
+ ],
+ 'ParameterPosition' => [
+ 'description' => 'The position of the parameter. Valid values: 0, 1, 2, and 3. The value 0 indicates that the parameter is in the URL path of the request. The value 1 indicates that the parameter is in the Query parameter of the request URL. The value 2 indicates that the parameter is in the request header. The value 3 indicates that the parameter is in the request body. APIs generated in wizard or script mode support only the Query position. APIs generated by registration whose request method is GET or DELETE support the Query and Head positions. APIs generated by registration whose request method is PUT or POST support the Query, Head, and Body positions.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '0',
+ ],
+ 'ParameterDescription' => [
+ 'description' => 'The description.'."\n",
+ 'type' => 'string',
+ 'example' => 'description1',
+ ],
+ 'DefaultValue' => [
+ 'description' => 'The default value.'."\n",
+ 'type' => 'string',
+ 'example' => 'default1',
+ ],
+ 'ParameterOperator' => [
+ 'description' => 'The operator used for the value of the parameter. Valid values: 0, 1, 2, and 3. The value 0 indicates the Equal operator. The value 1 indicates the Like operator. The value 2 indicates the Const operator. The value 3 indicates the In operator. APIs generated in wizard mode support the Equal, Like, and In operators. APIs generated in script mode support the Equal operator. APIs generated by registration support the Equal and Const operators.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '0',
+ ],
+ 'ExampleValue' => [
+ 'description' => 'The sample value.'."\n",
+ 'type' => 'string',
+ 'example' => 'example1',
+ ],
+ 'ParameterDataType' => [
+ 'description' => 'The data type of the parameter. Valid values:'."\n"
+ ."\n"
+ .'* 0: String'."\n"
+ .'* 1: Int'."\n"
+ .'* 2: Long'."\n"
+ .'* 3: Float'."\n"
+ .'* 4: Double'."\n"
+ .'* 5: Boolean'."\n"
+ .'* 6: StringList'."\n"
+ .'* 7: IntList'."\n"
+ .'* 8: LongList'."\n"
+ .'* 9: FloatList'."\n"
+ .'* 10: DoubleList'."\n"
+ .'* 11: BooleanList'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '0',
+ ],
+ 'IsRequiredParameter' => [
+ 'description' => 'Indicates whether the request parameter is required.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ ],
+ 'description' => '',
+ ],
+ ],
+ 'WizardResponseParameters' => [
+ 'description' => 'The response parameters of the API generated in wizard mode.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'ParameterDescription' => [
+ 'description' => 'The description.'."\n",
+ 'type' => 'string',
+ 'example' => 'description2',
+ ],
+ 'ParameterName' => [
+ 'description' => 'The name of the parameter.'."\n",
+ 'type' => 'string',
+ 'example' => 'param2',
+ ],
+ 'ExampleValue' => [
+ 'description' => 'The sample value.'."\n",
+ 'type' => 'string',
+ 'example' => 'example2',
+ ],
+ 'ParameterDataType' => [
+ 'description' => 'The data type of the parameter. Valid values:'."\n"
+ ."\n"
+ .'* 0: String'."\n"
+ .'* 1: Int'."\n"
+ .'* 2: Long'."\n"
+ .'* 3: Float'."\n"
+ .'* 4: Double'."\n"
+ .'* 5: Boolean'."\n"
+ .'* 6: StringList'."\n"
+ .'* 7: IntList'."\n"
+ .'* 8: LongList'."\n"
+ .'* 9: FloatList'."\n"
+ .'* 10: DoubleList'."\n"
+ .'* 11: BooleanList'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '0',
+ ],
+ ],
+ 'description' => '',
+ ],
+ ],
+ 'WizardConnection' => [
+ 'description' => 'The data source information about the API generated in wizard mode.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'TableName' => [
+ 'description' => 'The name of the table in the data source.'."\n",
+ 'type' => 'string',
+ 'example' => 't',
+ ],
+ 'ConnectionId' => [
+ 'description' => 'The ID of the data source.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '123',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'SqlMode' => [
+ 'title' => 'SQL模式，0：基础SQL；1：高级SQL',
+ 'description' => 'SQL mode. 0: Basic SQL; 1: Advanced SQL.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '0',
+ ],
+ ],
+ 'description' => '',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'description' => '',
+ ],
+ ],
+ ],
+ 'errorCodes' => [
+ 403 => [
+ [
+ 'errorCode' => 'Forbidden.Access',
+ 'errorMessage' => 'Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.',
+ ],
+ ],
+ 429 => [
+ [
+ 'errorCode' => 'Throttling.Api',
+ 'errorMessage' => 'The request for this resource has exceeded your available limit.',
+ ],
+ [
+ 'errorCode' => 'Throttling.System',
+ 'errorMessage' => 'The DataWorks system is busy. Try again later.',
+ ],
+ [
+ 'errorCode' => 'Throttling.User',
+ 'errorMessage' => 'Your request is too frequent. Try again later.',
+ ],
+ ],
+ 500 => [
+ [
+ 'errorCode' => 'InternalError.System',
+ 'errorMessage' => 'An internal system error occurred. Try again later.',
+ ],
+ [
+ 'errorCode' => 'InternalError.UserId.Missing',
+ 'errorMessage' => 'An internal system error occurred. Try again later.',
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"0000-ABCD-EFG****\\",\\n \\"ErrorMessage\\": \\"The connection does not exist.\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"Invalid.Tenant.ConnectionNotExists\\",\\n \\"Data\\": {\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 100,\\n \\"Apis\\": [\\n {\\n \\"Timeout\\": 10000,\\n \\"Status\\": 1,\\n \\"ApiId\\": 10002,\\n \\"ApiMode\\": 0,\\n \\"ProjectId\\": 10000,\\n \\"ResponseContentType\\": 0,\\n \\"CreatorId\\": \\"1234567\\",\\n \\"VisibleRange\\": 0,\\n \\"ModifiedTime\\": \\"2020-06-23T00:21:01+0800\\",\\n \\"OperatorId\\": \\"2345678\\",\\n \\"GroupId\\": \\"ab123\\",\\n \\"Description\\": \\"Test API description\\",\\n \\"RequestMethod\\": 0,\\n \\"CreatedTime\\": \\"2020-06-23T00:21:01+0800\\",\\n \\"ApiName\\": \\"My API name\\",\\n \\"TenantId\\": 10001,\\n \\"ApiPath\\": \\"/test/1\\",\\n \\"Protocols\\": [\\n 0\\n ],\\n \\"RegistrationDetails\\": {\\n \\"ServiceHost\\": \\"http://www.abc.com\\",\\n \\"ServiceContentType\\": 0,\\n \\"ServicePath\\": \\"/index\\",\\n \\"SuccessfulResultSample\\": \\"{\\\\\\"success\\\\\\": true}\\",\\n \\"FailedResultSample\\": \\"{\\\\\\"success\\\\\\": false}\\",\\n \\"ServiceRequestBodyDescription\\": \\"{\\\\\\"abc\\\\\\":1}\\",\\n \\"RegistrationErrorCodes\\": [\\n {\\n \\"ErrorMessage\\": \\"fail to call\\",\\n \\"ErrorCode\\": \\"1001\\",\\n \\"ErrorSolution\\": \\"retry\\"\\n }\\n ],\\n \\"RegistrationRequestParameters\\": [\\n {\\n \\"ParameterName\\": \\"name1\\",\\n \\"ParameterPosition\\": 0,\\n \\"ParameterDescription\\": \\"description1\\",\\n \\"DefaultValue\\": \\"default1\\",\\n \\"ParameterOperator\\": 0,\\n \\"ExampleValue\\": \\"example1\\",\\n \\"ParameterDataType\\": 0,\\n \\"IsRequiredParameter\\": true\\n }\\n ]\\n },\\n \\"ScriptDetails\\": {\\n \\"IsPagedResponse\\": true,\\n \\"SuccessfulResultSample\\": \\"{\\\\\\"success\\\\\\": true}\\",\\n \\"FailedResultSample\\": \\"{\\\\\\"success\\\\\\": false}\\",\\n \\"Script\\": \\"select a from t\\",\\n \\"ScriptErrorCodes\\": [\\n {\\n \\"ErrorMessage\\": \\"fail to call\\",\\n \\"ErrorCode\\": \\"1001\\",\\n \\"ErrorSolution\\": \\"retry\\"\\n }\\n ],\\n \\"ScriptRequestParameters\\": [\\n {\\n \\"ParameterName\\": \\"param1\\",\\n \\"ParameterPosition\\": 0,\\n \\"ParameterDescription\\": \\"description1\\",\\n \\"DefaultValue\\": \\"default1\\",\\n \\"ParameterOperator\\": 0,\\n \\"ExampleValue\\": \\"example1\\",\\n \\"ParameterDataType\\": 0,\\n \\"IsRequiredParameter\\": true\\n }\\n ],\\n \\"ScriptResponseParameters\\": [\\n {\\n \\"ParameterDescription\\": \\"description2\\",\\n \\"ParameterName\\": \\"param2\\",\\n \\"ExampleValue\\": \\"example2\\",\\n \\"ParameterDataType\\": 0\\n }\\n ],\\n \\"ScriptConnection\\": {\\n \\"TableName\\": \\"t\\",\\n \\"ConnectionId\\": 123\\n }\\n },\\n \\"WizardDetails\\": {\\n \\"IsPagedResponse\\": true,\\n \\"SuccessfulResultSample\\": \\"{\\\\\\"success\\\\\\": true}\\",\\n \\"FailedResultSample\\": \\"{\\\\\\"success\\\\\\": false}\\",\\n \\"WizardErrorCodes\\": [\\n {\\n \\"ErrorMessage\\": \\"fail to call\\",\\n \\"ErrorCode\\": \\"1001\\",\\n \\"ErrorSolution\\": \\"retry\\"\\n }\\n ],\\n \\"WizardRequestParameters\\": [\\n {\\n \\"ParameterName\\": \\"param1\\",\\n \\"ParameterPosition\\": 0,\\n \\"ParameterDescription\\": \\"description1\\",\\n \\"DefaultValue\\": \\"default1\\",\\n \\"ParameterOperator\\": 0,\\n \\"ExampleValue\\": \\"example1\\",\\n \\"ParameterDataType\\": 0,\\n \\"IsRequiredParameter\\": true\\n }\\n ],\\n \\"WizardResponseParameters\\": [\\n {\\n \\"ParameterDescription\\": \\"description2\\",\\n \\"ParameterName\\": \\"param2\\",\\n \\"ExampleValue\\": \\"example2\\",\\n \\"ParameterDataType\\": 0\\n }\\n ],\\n \\"WizardConnection\\": {\\n \\"TableName\\": \\"t\\",\\n \\"ConnectionId\\": 12354\\n }\\n },\\n \\"SqlMode\\": 0\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<ListDataServicePublishedApisResponse>\\n <HttpStatusCode>200</HttpStatusCode>\\n <RequestId>0000-ABCD-EFG****</RequestId>\\n <ErrorMessage>The connection does not exist.</ErrorMessage>\\n <Success>true</Success>\\n <ErrorCode>Invalid.Tenant.ConnectionNotExists</ErrorCode>\\n <Data>\\n <PageNumber>1</PageNumber>\\n <PageSize>10</PageSize>\\n <TotalCount>100</TotalCount>\\n <Apis>\\n <Timeout>10000</Timeout>\\n <Status>1</Status>\\n <ApiId>10002</ApiId>\\n <ApiMode>0</ApiMode>\\n <ProjectId>10000</ProjectId>\\n <ResponseContentType>0</ResponseContentType>\\n <CreatorId>1234567</CreatorId>\\n <VisibleRange>0</VisibleRange>\\n <ModifiedTime>2020-06-23T00:21:01+0800</ModifiedTime>\\n <OperatorId>2345678</OperatorId>\\n <GroupId>ab123</GroupId>\\n <Description>测试API描述</Description>\\n <RequestMethod>0</RequestMethod>\\n <CreatedTime>2020-06-23T00:21:01+0800</CreatedTime>\\n <ApiName>我的API名称</ApiName>\\n <TenantId>10001</TenantId>\\n <ApiPath>/test/1</ApiPath>\\n <Protocols>0</Protocols>\\n <RegistrationDetails>\\n <ServiceHost>http://www.abc.com</ServiceHost>\\n <ServiceContentType>0</ServiceContentType>\\n <ServicePath>/index</ServicePath>\\n <SuccessfulResultSample>{\\"success\\": true}</SuccessfulResultSample>\\n <FailedResultSample>{\\"success\\": false}</FailedResultSample>\\n <ServiceRequestBodyDescription>{\\"abc\\":1}</ServiceRequestBodyDescription>\\n <RegistrationErrorCodes>\\n <ErrorMessage>fail to call</ErrorMessage>\\n <ErrorCode>1001</ErrorCode>\\n <ErrorSolution>retry</ErrorSolution>\\n </RegistrationErrorCodes>\\n <RegistrationRequestParameters>\\n <ParameterName>name1</ParameterName>\\n <ParameterPosition>0</ParameterPosition>\\n <ParameterDescription>description1</ParameterDescription>\\n <DefaultValue>default1</DefaultValue>\\n <ParameterOperator>0</ParameterOperator>\\n <ExampleValue>example1</ExampleValue>\\n <ParameterDataType>0</ParameterDataType>\\n <IsRequiredParameter>true</IsRequiredParameter>\\n </RegistrationRequestParameters>\\n </RegistrationDetails>\\n <ScriptDetails>\\n <IsPagedResponse>true</IsPagedResponse>\\n <SuccessfulResultSample>{\\"success\\": true}</SuccessfulResultSample>\\n <FailedResultSample>{\\"success\\": false}</FailedResultSample>\\n <Script>select a from t</Script>\\n <ScriptErrorCodes>\\n <ErrorMessage>fail to call</ErrorMessage>\\n <ErrorCode>1001</ErrorCode>\\n <ErrorSolution>retry</ErrorSolution>\\n </ScriptErrorCodes>\\n <ScriptRequestParameters>\\n <ParameterName>param1</ParameterName>\\n <ParameterPosition>0</ParameterPosition>\\n <ParameterDescription>description1</ParameterDescription>\\n <DefaultValue>default1</DefaultValue>\\n <ParameterOperator>0</ParameterOperator>\\n <ExampleValue>example1</ExampleValue>\\n <ParameterDataType>0</ParameterDataType>\\n <IsRequiredParameter>true</IsRequiredParameter>\\n </ScriptRequestParameters>\\n <ScriptResponseParameters>\\n <ParameterDescription>description2</ParameterDescription>\\n <ParameterName>param2</ParameterName>\\n <ExampleValue>example2</ExampleValue>\\n <ParameterDataType>0</ParameterDataType>\\n </ScriptResponseParameters>\\n <ScriptConnection>\\n <TableName>t</TableName>\\n <ConnectionId>123</ConnectionId>\\n </ScriptConnection>\\n </ScriptDetails>\\n <WizardDetails>\\n <IsPagedResponse>true</IsPagedResponse>\\n <SuccessfulResultSample>{\\"success\\": true}</SuccessfulResultSample>\\n <FailedResultSample>{\\"success\\": false}</FailedResultSample>\\n <WizardErrorCodes>\\n <ErrorMessage>fail to call</ErrorMessage>\\n <ErrorCode>1001</ErrorCode>\\n <ErrorSolution>retry</ErrorSolution>\\n </WizardErrorCodes>\\n <WizardRequestParameters>\\n <ParameterName>param1</ParameterName>\\n <ParameterPosition>0</ParameterPosition>\\n <ParameterDescription>description1</ParameterDescription>\\n <DefaultValue>default1</DefaultValue>\\n <ParameterOperator>0</ParameterOperator>\\n <ExampleValue>example1</ExampleValue>\\n <ParameterDataType>0</ParameterDataType>\\n <IsRequiredParameter>true</IsRequiredParameter>\\n </WizardRequestParameters>\\n <WizardResponseParameters>\\n <ParameterDescription>description2</ParameterDescription>\\n <ParameterName>param2</ParameterName>\\n <ExampleValue>example2</ExampleValue>\\n <ParameterDataType>0</ParameterDataType>\\n </WizardResponseParameters>\\n <WizardConnection>\\n <TableName>t</TableName>\\n <ConnectionId>123</ConnectionId>\\n </WizardConnection>\\n </WizardDetails>\\n </Apis>\\n </Data>\\n</ListDataServicePublishedApisResponse>","errorExample":""}]',
+ 'title' => 'ListDataServicePublishedApis',
+ 'requestParamsDescription' => ' ',
+ 'responseParamsDescription' => 'The details of different types of APIs are returned in different parameters. The details of an API generated in wizard mode are returned in the WizardDetails parameter. The details of an API generated in script mode are returned in the ScriptDetails parameter. The details of an API generated by registration are returned in the RegistrationDetails parameter.'."\n",
+ 'extraInfo' => ' ',
+ ],
+ 'ListDataServiceApiAuthorities' => [
+ 'methods' => [
+ 'post',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'get',
+ 'abilityTreeCode' => '78300',
+ 'abilityTreeNodes' => [
+ 'FEATUREdide7T0EJX',
+ ],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'ProjectId',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The ID of the workspace.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => '10000',
+ ],
+ ],
+ [
+ 'name' => 'PageNumber',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The page number. Pages start from page 1. Default value: 1.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => false,
+ 'docRequired' => true,
+ 'minimum' => '1',
+ 'example' => '1',
+ 'default' => '1',
+ ],
+ ],
+ [
+ 'name' => 'PageSize',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The number of entries per page. Valid values: 1 to 100. Default value: 10.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => false,
+ 'docRequired' => true,
+ 'maximum' => '50',
+ 'minimum' => '1',
+ 'example' => '10',
+ 'default' => '10',
+ ],
+ ],
+ [
+ 'name' => 'TenantId',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The tenant ID. This parameter is deprecated.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'docRequired' => false,
+ 'example' => '10001',
+ ],
+ ],
+ [
+ 'name' => 'ApiNameKeyword',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The keyword in the name of the API. The keyword can be used to search for the API whose name contains the keyword.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'My API name'."\n",
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'description' => 'The response parameters.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'HttpStatusCode' => [
+ 'description' => 'The HTTP status code.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '200',
+ ],
+ 'RequestId' => [
+ 'description' => 'The request ID.'."\n",
+ 'type' => 'string',
+ 'example' => '0000-ABCD-EFG****',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message.'."\n",
+ 'type' => 'string',
+ 'example' => 'Normal'."\n",
+ ],
+ 'Success' => [
+ 'description' => 'Indicates whether the request was successful.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code.'."\n",
+ 'type' => 'string',
+ 'example' => '0',
+ ],
+ 'Data' => [
+ 'description' => 'The APIs on which other users are granted the access permissions.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'PageNumber' => [
+ 'description' => 'The page number. The value of this parameter is the same as that of the PageNumber parameter in the request.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '1',
+ ],
+ 'PageSize' => [
+ 'description' => 'The number of entries per page. Valid values: 1 to 100. Default value: 10.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '10',
+ ],
+ 'TotalCount' => [
+ 'description' => 'The total number of entries returned.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '100',
+ ],
+ 'ApiAuthorizationList' => [
+ 'description' => 'The APIs on which other users are granted the access permissions.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '',
+ 'type' => 'object',
+ 'properties' => [
+ 'ApiStatus' => [
+ 'description' => 'The status of the API. Valid values: 0 and 1. The value 0 indicates that the API is not published. The value 1 indicates that the API is published.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '0',
+ ],
+ 'ApiId' => [
+ 'description' => 'The API ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '10002',
+ ],
+ 'ModifiedTime' => [
+ 'description' => 'The time when the API was last modified.'."\n",
+ 'type' => 'string',
+ 'example' => '2020-06-23T00:21:01+0800',
+ ],
+ 'GroupId' => [
+ 'description' => 'The group ID.'."\n",
+ 'type' => 'string',
+ 'example' => 'ab123',
+ ],
+ 'ProjectId' => [
+ 'description' => 'The workspace ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '10000',
+ ],
+ 'CreatorId' => [
+ 'description' => 'The ID of the Alibaba Cloud account used by the API owner.'."\n",
+ 'type' => 'string',
+ 'example' => '12345',
+ ],
+ 'CreatedTime' => [
+ 'description' => 'The time when the API was created.'."\n",
+ 'type' => 'string',
+ 'example' => '2020-06-23T00:21:01+0800',
+ ],
+ 'ApiName' => [
+ 'description' => 'The name of the API.'."\n",
+ 'type' => 'string',
+ 'example' => 'My API name'."\n",
+ ],
+ 'TenantId' => [
+ 'description' => 'The tenant ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '10001',
+ ],
+ 'ApiPath' => [
+ 'description' => 'The path of the API.'."\n",
+ 'type' => 'string',
+ 'example' => '/test/1',
+ ],
+ 'AuthorizationRecords' => [
+ 'description' => 'The authorization records.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '',
+ 'type' => 'object',
+ 'properties' => [
+ 'EndTime' => [
+ 'description' => 'The end time of the validity period of the authorization.'."\n",
+ 'type' => 'string',
+ 'example' => '2020-06-24T00:21:01+0800',
+ ],
+ 'CreatorId' => [
+ 'description' => 'The ID of the Alibaba Cloud account used by the API owner.'."\n",
+ 'type' => 'string',
+ 'example' => '12345',
+ ],
+ 'CreatedTime' => [
+ 'description' => 'The time when the access permissions on the API were granted to other users.'."\n",
+ 'type' => 'string',
+ 'example' => '2020-06-23T00:21:01+0800',
+ ],
+ 'ProjectId' => [
+ 'description' => 'The ID of the workspace to which the access permissions on the API are granted.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '10004',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'errorCodes' => [
+ 403 => [
+ [
+ 'errorCode' => 'Forbidden.Access',
+ 'errorMessage' => 'Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.',
+ ],
+ ],
+ 429 => [
+ [
+ 'errorCode' => 'Throttling.Api',
+ 'errorMessage' => 'The request for this resource has exceeded your available limit.',
+ ],
+ [
+ 'errorCode' => 'Throttling.System',
+ 'errorMessage' => 'The DataWorks system is busy. Try again later.',
+ ],
+ [
+ 'errorCode' => 'Throttling.User',
+ 'errorMessage' => 'Your request is too frequent. Try again later.',
+ ],
+ ],
+ 500 => [
+ [
+ 'errorCode' => 'InternalError.System',
+ 'errorMessage' => 'An internal system error occurred. Try again later.',
+ ],
+ [
+ 'errorCode' => 'InternalError.UserId.Missing',
+ 'errorMessage' => 'An internal system error occurred. Try again later.',
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"0000-ABCD-EFG****\\",\\n \\"ErrorMessage\\": \\"正常\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"0\\",\\n \\"Data\\": {\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 100,\\n \\"ApiAuthorizationList\\": [\\n {\\n \\"ApiStatus\\": 0,\\n \\"ApiId\\": 10002,\\n \\"ModifiedTime\\": \\"2020-06-23T00:21:01+0800\\",\\n \\"GroupId\\": \\"ab123\\",\\n \\"ProjectId\\": 10000,\\n \\"CreatorId\\": \\"12345\\",\\n \\"CreatedTime\\": \\"2020-06-23T00:21:01+0800\\",\\n \\"ApiName\\": \\"我的API名称\\",\\n \\"TenantId\\": 10001,\\n \\"ApiPath\\": \\"/test/1\\",\\n \\"AuthorizationRecords\\": [\\n {\\n \\"EndTime\\": \\"2020-06-24T00:21:01+0800\\",\\n \\"CreatorId\\": \\"12345\\",\\n \\"CreatedTime\\": \\"2020-06-23T00:21:01+0800\\",\\n \\"ProjectId\\": 10004\\n }\\n ]\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<ListDataServiceApiAuthoritiesResponse>\\n <HttpStatusCode>200</HttpStatusCode>\\n <RequestId>0000-ABCD-EFG****</RequestId>\\n <ErrorMessage>正常</ErrorMessage>\\n <Success>false</Success>\\n <ErrorCode>0</ErrorCode>\\n <Data>\\n <PageNumber>1</PageNumber>\\n <PageSize>10</PageSize>\\n <TotalCount>100</TotalCount>\\n <ApiAuthorizationList>\\n <ApiStatus>0</ApiStatus>\\n <ApiId>10002</ApiId>\\n <ModifiedTime>2020-06-23T00:21:01+0800</ModifiedTime>\\n <GroupId>ab123</GroupId>\\n <ProjectId>10000</ProjectId>\\n <CreatorId>12345</CreatorId>\\n <CreatedTime>2020-06-23T00:21:01+0800</CreatedTime>\\n <ApiName>我的API名称</ApiName>\\n <TenantId>10001</TenantId>\\n <ApiPath>/test/1</ApiPath>\\n <AuthorizationRecords>\\n <EndTime>2020-06-24T00:21:01+0800</EndTime>\\n <CreatorId>12345</CreatorId>\\n <CreatedTime>2020-06-23T00:21:01+0800</CreatedTime>\\n <ProjectId>10004</ProjectId>\\n </AuthorizationRecords>\\n </ApiAuthorizationList>\\n </Data>\\n</ListDataServiceApiAuthoritiesResponse>","errorExample":""}]',
+ 'title' => 'ListDataServiceApiAuthorities',
+ 'summary' => 'Queries the APIs on which other users are granted the access permissions.',
+ ],
+ 'ListDataServiceAuthorizedApis' => [
+ 'methods' => [
+ 'post',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'get',
+ 'abilityTreeCode' => '78303',
+ 'abilityTreeNodes' => [
+ 'FEATUREdide7T0EJX',
+ ],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'ProjectId',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The workspace ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => '10000',
+ ],
+ ],
+ [
+ 'name' => 'PageNumber',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The page number. Pages start from page 1. Default value: 1.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => false,
+ 'docRequired' => true,
+ 'minimum' => '1',
+ 'example' => '1',
+ 'default' => '1',
+ ],
+ ],
+ [
+ 'name' => 'PageSize',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The number of entries per page. Default value: 10. Maximum value: 100.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => false,
+ 'docRequired' => true,
+ 'maximum' => '50',
+ 'minimum' => '1',
+ 'example' => '10',
+ 'default' => '10',
+ ],
+ ],
+ [
+ 'name' => 'TenantId',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The tenant ID. This parameter is deprecated.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'docRequired' => false,
+ 'example' => '10001',
+ ],
+ ],
+ [
+ 'name' => 'ApiNameKeyword',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The keyword in API names. The keyword is used to search for the APIs whose names contain the keyword.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'My API Name'."\n",
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'HttpStatusCode' => [
+ 'description' => 'The HTTP status code.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '200',
+ ],
+ 'RequestId' => [
+ 'description' => 'The request ID.'."\n",
+ 'type' => 'string',
+ 'example' => '0000-ABCD-EFG****',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message.'."\n",
+ 'type' => 'string',
+ 'example' => 'The specified parameters are invalid.',
+ ],
+ 'Success' => [
+ 'description' => 'Indicates whether the request was successful.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code.'."\n",
+ 'type' => 'string',
+ 'example' => '1031203110005',
+ ],
+ 'Data' => [
+ 'description' => 'The information about the APIs that you are authorized to access.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'PageNumber' => [
+ 'description' => 'The page number. The value of this parameter is the same as that of the PageNumber parameter in the request.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '1',
+ ],
+ 'PageSize' => [
+ 'description' => 'The number of entries per page. Default value: 10. Maximum value: 100.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '10',
+ ],
+ 'TotalCount' => [
+ 'description' => 'The total number of entries returned.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '100',
+ ],
+ 'ApiAuthorizedList' => [
+ 'description' => 'The APIs that you are authorized to access.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'ApiId' => [
+ 'description' => 'The API ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '10002',
+ ],
+ 'ApiStatus' => [
+ 'description' => 'The status of the API. Valid values: 0 and 1. The value 0 indicates that the API is not published. The value 1 indicates that the API is published.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '0',
+ ],
+ 'GrantOperatorId' => [
+ 'description' => 'The ID of the Alibaba Cloud account used by the user who granted the access permissions on the API.'."\n",
+ 'type' => 'string',
+ 'example' => '23456',
+ ],
+ 'ProjectId' => [
+ 'description' => 'The workspace ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '10000',
+ ],
+ 'CreatorId' => [
+ 'description' => 'The ID of the Alibaba Cloud account used by the API owner.'."\n",
+ 'type' => 'string',
+ 'example' => '12345',
+ ],
+ 'GrantEndTime' => [
+ 'description' => 'The expiration time of the access permissions granted on the API.'."\n",
+ 'type' => 'string',
+ 'example' => '2020-06-24T00:21:01+0800',
+ ],
+ 'ModifiedTime' => [
+ 'description' => 'The time when the API was last updated.'."\n",
+ 'type' => 'string',
+ 'example' => '2020-06-23T00:21:01+0800',
+ ],
+ 'GroupId' => [
+ 'description' => 'The group ID.'."\n",
+ 'type' => 'string',
+ 'example' => 'abcde123456789',
+ ],
+ 'GrantCreatedTime' => [
+ 'description' => 'The time when the access permissions on the API were granted.'."\n",
+ 'type' => 'string',
+ 'example' => '2020-06-23T00:21:01+0800',
+ ],
+ 'CreatedTime' => [
+ 'description' => 'The time when the API was created.'."\n",
+ 'type' => 'string',
+ 'example' => '2020-06-23T00:21:01+0800',
+ ],
+ 'ApiName' => [
+ 'description' => 'The name of the API.'."\n",
+ 'type' => 'string',
+ 'example' => 'My API Name'."\n",
+ ],
+ 'TenantId' => [
+ 'description' => 'The tenant ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '10001',
+ ],
+ 'ApiPath' => [
+ 'description' => 'The path of the API.'."\n",
+ 'type' => 'string',
+ 'example' => '/test/1',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'description' => '',
+ ],
+ ],
+ ],
+ 'errorCodes' => [
+ 403 => [
+ [
+ 'errorCode' => 'Forbidden.Access',
+ 'errorMessage' => 'Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.',
+ ],
+ ],
+ 429 => [
+ [
+ 'errorCode' => 'Throttling.Api',
+ 'errorMessage' => 'The request for this resource has exceeded your available limit.',
+ ],
+ [
+ 'errorCode' => 'Throttling.System',
+ 'errorMessage' => 'The DataWorks system is busy. Try again later.',
+ ],
+ [
+ 'errorCode' => 'Throttling.User',
+ 'errorMessage' => 'Your request is too frequent. Try again later.',
+ ],
+ ],
+ 500 => [
+ [
+ 'errorCode' => 'InternalError.System',
+ 'errorMessage' => 'An internal system error occurred. Try again later.',
+ ],
+ [
+ 'errorCode' => 'InternalError.UserId.Missing',
+ 'errorMessage' => 'An internal system error occurred. Try again later.',
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"0000-ABCD-EFG****\\",\\n \\"ErrorMessage\\": \\"The specified parameters are invalid.\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"1031203110005\\",\\n \\"Data\\": {\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 100,\\n \\"ApiAuthorizedList\\": [\\n {\\n \\"ApiId\\": 10002,\\n \\"ApiStatus\\": 0,\\n \\"GrantOperatorId\\": \\"23456\\",\\n \\"ProjectId\\": 10000,\\n \\"CreatorId\\": \\"12345\\",\\n \\"GrantEndTime\\": \\"2020-06-24T00:21:01+0800\\",\\n \\"ModifiedTime\\": \\"2020-06-23T00:21:01+0800\\",\\n \\"GroupId\\": \\"abcde123456789\\",\\n \\"GrantCreatedTime\\": \\"2020-06-23T00:21:01+0800\\",\\n \\"CreatedTime\\": \\"2020-06-23T00:21:01+0800\\",\\n \\"ApiName\\": \\"我的API名称\\",\\n \\"TenantId\\": 10001,\\n \\"ApiPath\\": \\"/test/1\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<ListDataServiceAuthorizedApisResponse>\\n <Data>\\n <ApiAuthorizedList/>\\n </Data>\\n</ListDataServiceAuthorizedApisResponse>","errorExample":""}]',
+ 'title' => 'ListDataServiceAuthorizedApis',
+ 'summary' => 'Queries the APIs that you are authorized to access.',
+ ],
+ 'AbolishDataServiceApi' => [
+ 'methods' => [
+ 'post',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'write',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'delete',
+ 'abilityTreeCode' => '78165',
+ 'abilityTreeNodes' => [
+ 'FEATUREdide7T0EJX',
+ ],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'TenantId',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The tenant ID. To obtain the tenant ID, perform the following steps: Log on to the [DataWorks console](https://workbench.data.aliyun.com/console). Find your workspace and go to the DataStudio page. On the DataStudio page, click the logon username in the upper-right corner and click User Info in the Menu section.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'docRequired' => false,
+ 'example' => '10002',
+ ],
+ ],
+ [
+ 'name' => 'ProjectId',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The ID of the workspace.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => '10001',
+ ],
+ ],
+ [
+ 'name' => 'ApiId',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The ID of the DataService Studio API.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => '10000',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'HttpStatusCode' => [
+ 'description' => 'The HTTP status code.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '200',
+ ],
+ 'Data' => [
+ 'description' => 'Indicates whether the API is unpublished.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message.'."\n",
+ 'type' => 'string',
+ 'example' => 'The connection does not exist.',
+ ],
+ 'RequestId' => [
+ 'description' => 'The request ID.'."\n",
+ 'type' => 'string',
+ 'example' => '0000-ABCD-EFG****',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code.'."\n",
+ 'type' => 'string',
+ 'example' => 'Invalid.Tenant.ConnectionNotExists',
+ ],
+ 'Success' => [
+ 'description' => 'Indicates whether the request was successful.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ ],
+ 'description' => '',
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Data\\": true,\\n \\"ErrorMessage\\": \\"The connection does not exist.\\",\\n \\"RequestId\\": \\"0000-ABCD-EFG****\\",\\n \\"ErrorCode\\": \\"Invalid.Tenant.ConnectionNotExists\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<AbolishDataServiceApiResponse>\\n <HttpStatusCode>200</HttpStatusCode>\\n <Data>true</Data>\\n <ErrorMessage>The connection does not exist.</ErrorMessage>\\n <RequestId>0000-ABCD-EFG****</RequestId>\\n <ErrorCode>Invalid.Tenant.ConnectionNotExists</ErrorCode>\\n <Success>true</Success>\\n</AbolishDataServiceApiResponse>","errorExample":""}]',
+ 'title' => 'AbolishDataServiceApi',
+ 'summary' => 'Unpublishes a DataService Studio API.',
+ 'requestParamsDescription' => ' ',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ ],
+ 'GetDataServiceApplication' => [
+ 'methods' => [
+ 'post',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'get',
+ 'abilityTreeCode' => '78236',
+ 'abilityTreeNodes' => [
+ 'FEATUREdide7T0EJX',
+ ],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'TenantId',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The tenant ID. To obtain the tenant ID, perform the following steps: Log on to the [DataWorks console](https://workbench.data.aliyun.com/console). Find your workspace and go to the DataStudio page. On the DataStudio page, click the logon username in the upper-right corner and click User Info in the Menu section.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'docRequired' => false,
+ 'example' => '10002',
+ ],
+ ],
+ [
+ 'name' => 'ProjectId',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The ID of the workspace.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => '10001',
+ ],
+ ],
+ [
+ 'name' => 'ApplicationId',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The ID of the application. You can view the information about the application in the API Gateway console.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => '10000',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'HttpStatusCode' => [
+ 'description' => 'The HTTP status code.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '200',
+ ],
+ 'RequestId' => [
+ 'description' => 'The request ID.'."\n",
+ 'type' => 'string',
+ 'example' => '0000-ABCD-EFG****',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message.'."\n",
+ 'type' => 'string',
+ 'example' => 'Normal'."\n",
+ ],
+ 'Success' => [
+ 'description' => 'Indicates whether the request was successful.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code.'."\n",
+ 'type' => 'string',
+ 'example' => '0',
+ ],
+ 'Data' => [
+ 'description' => 'The details of the application.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'ApplicationCode' => [
+ 'description' => 'The AppCode for simple authentication. You can select simple authentication or signature authentication when you call an API operation.'."\n",
+ 'type' => 'string',
+ 'example' => 'CODE123',
+ ],
+ 'ApplicationKey' => [
+ 'description' => 'The AppKey for signature authentication. You can select simple authentication or signature authentication when you call an API operation.'."\n",
+ 'type' => 'string',
+ 'example' => 'KEY123',
+ ],
+ 'ApplicationSecret' => [
+ 'description' => 'The AppSecret for signature authentication. You can select simple authentication or signature authentication when you call an API operation.'."\n",
+ 'type' => 'string',
+ 'example' => 'SECRET123',
+ ],
+ 'ProjectId' => [
+ 'description' => 'The workspace ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '10001',
+ ],
+ 'ApplicationName' => [
+ 'description' => 'The name of the application.'."\n",
+ 'type' => 'string',
+ 'example' => 'Test application'."\n",
+ ],
+ 'ApplicationId' => [
+ 'description' => 'The application ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '10000',
+ ],
+ ],
+ ],
+ ],
+ 'description' => '',
+ ],
+ ],
+ ],
+ 'errorCodes' => [
+ 403 => [
+ [
+ 'errorCode' => 'Forbidden.Access',
+ 'errorMessage' => 'Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.',
+ ],
+ ],
+ 429 => [
+ [
+ 'errorCode' => 'Throttling.Api',
+ 'errorMessage' => 'The request for this resource has exceeded your available limit.',
+ ],
+ [
+ 'errorCode' => 'Throttling.System',
+ 'errorMessage' => 'The DataWorks system is busy. Try again later.',
+ ],
+ [
+ 'errorCode' => 'Throttling.User',
+ 'errorMessage' => 'Your request is too frequent. Try again later.',
+ ],
+ ],
+ 500 => [
+ [
+ 'errorCode' => 'InternalError.System',
+ 'errorMessage' => 'An internal system error occurred. Try again later.',
+ ],
+ [
+ 'errorCode' => 'InternalError.UserId.Missing',
+ 'errorMessage' => 'An internal system error occurred. Try again later.',
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"0000-ABCD-EFG****\\",\\n \\"ErrorMessage\\": \\"正常\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"0\\",\\n \\"Data\\": {\\n \\"ApplicationCode\\": \\"CODE123\\",\\n \\"ApplicationKey\\": \\"KEY123\\",\\n \\"ApplicationSecret\\": \\"SECRET123\\",\\n \\"ProjectId\\": 10001,\\n \\"ApplicationName\\": \\"测试应用\\",\\n \\"ApplicationId\\": 10000\\n }\\n}","errorExample":""},{"type":"xml","example":"<GetDataServiceApplicationResponse>\\n <HttpStatusCode>200</HttpStatusCode>\\n <RequestId>0000-ABCD-EFG****</RequestId>\\n <ErrorMessage>正常</ErrorMessage>\\n <Success>true</Success>\\n <ErrorCode>0</ErrorCode>\\n <Data>\\n <ApplicationCode>CODE123</ApplicationCode>\\n <ApplicationKey>KEY123</ApplicationKey>\\n <ApplicationSecret>SECRET123</ApplicationSecret>\\n <ProjectId>10001</ProjectId>\\n <ApplicationName>测试应用</ApplicationName>\\n <ApplicationId>10000</ApplicationId>\\n </Data>\\n</GetDataServiceApplicationResponse>","errorExample":""}]',
+ 'title' => 'GetDataServiceApplication',
+ 'summary' => 'Queries the details of an application.',
+ 'requestParamsDescription' => ' ',
+ 'responseParamsDescription' => 'The disclosure of the ApplicationCode or ApplicationSecret parameter may threaten the security of your API resources in DataService Studio. Therefore, the values of the ApplicationCode and ApplicationSecret parameters are masked before they are returned.'."\n",
+ 'extraInfo' => ' ',
+ ],
+ 'ListDataServiceApplications' => [
+ 'methods' => [
+ 'post',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'get',
+ 'abilityTreeCode' => '78302',
+ 'abilityTreeNodes' => [
+ 'FEATUREdide7T0EJX',
+ ],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'PageNumber',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The page number. Pages start from page 1. Default value: 1.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => false,
+ 'docRequired' => true,
+ 'minimum' => '1',
+ 'example' => '1',
+ 'default' => '1',
+ ],
+ ],
+ [
+ 'name' => 'PageSize',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The number of entries per page. Default value: 10. Maximum value: 100.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => false,
+ 'docRequired' => true,
+ 'maximum' => '50',
+ 'minimum' => '1',
+ 'example' => '10',
+ 'default' => '10',
+ ],
+ ],
+ [
+ 'name' => 'ProjectIdList',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The ID of the workspace based on which you want to query the basic information of applications. You can specify multiple IDs. Separate them with commas (,). You must specify at least one workspace ID. You can specify a maximum of 50 workspace IDs.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => '10000,100001',
+ ],
+ ],
+ [
+ 'name' => 'TenantId',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The tenant ID. To obtain the tenant ID, perform the following steps: Log on to the [DataWorks console](https://workbench.data.aliyun.com/console). Find your workspace and go to the DataStudio page. On the DataStudio page, click the logon username in the upper-right corner and click User Info in the Menu section.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'docRequired' => false,
+ 'example' => '100002',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'HttpStatusCode' => [
+ 'description' => 'The HTTP status code.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '200',
+ ],
+ 'RequestId' => [
+ 'description' => 'The request ID.'."\n",
+ 'type' => 'string',
+ 'example' => '0000-ABCD-EFG***',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message.'."\n",
+ 'type' => 'string',
+ 'example' => 'Normal'."\n",
+ ],
+ 'Success' => [
+ 'description' => 'Indicates whether the request was successful.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code.'."\n",
+ 'type' => 'string',
+ 'example' => '0',
+ ],
+ 'Data' => [
+ 'description' => 'The returned data.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'PageNumber' => [
+ 'description' => 'The page number. The value of this parameter is the same as that of the PageNumber parameter in the request.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '1',
+ ],
+ 'PageSize' => [
+ 'description' => 'The number of entries per page. Default value: 10. Maximum value: 100.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '10',
+ ],
+ 'TotalCount' => [
+ 'description' => 'The total number of entries returned.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '100',
+ ],
+ 'Applications' => [
+ 'description' => 'The basic information of the applications.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'ApplicationName' => [
+ 'description' => 'The name of the application.'."\n",
+ 'type' => 'string',
+ 'example' => 'My application'."\n",
+ ],
+ 'ApplicationId' => [
+ 'description' => 'The application ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '20000',
+ ],
+ 'ProjectId' => [
+ 'description' => 'The workspace ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '10000',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'description' => '',
+ ],
+ ],
+ ],
+ 'errorCodes' => [
+ 403 => [
+ [
+ 'errorCode' => 'Forbidden.Access',
+ 'errorMessage' => 'Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.',
+ ],
+ ],
+ 429 => [
+ [
+ 'errorCode' => 'Throttling.Api',
+ 'errorMessage' => 'The request for this resource has exceeded your available limit.',
+ ],
+ [
+ 'errorCode' => 'Throttling.System',
+ 'errorMessage' => 'The DataWorks system is busy. Try again later.',
+ ],
+ [
+ 'errorCode' => 'Throttling.User',
+ 'errorMessage' => 'Your request is too frequent. Try again later.',
+ ],
+ ],
+ 500 => [
+ [
+ 'errorCode' => 'InternalError.System',
+ 'errorMessage' => 'An internal system error occurred. Try again later.',
+ ],
+ [
+ 'errorCode' => 'InternalError.UserId.Missing',
+ 'errorMessage' => 'An internal system error occurred. Try again later.',
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"0000-ABCD-EFG***\\",\\n \\"ErrorMessage\\": \\"正常\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"0\\",\\n \\"Data\\": {\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 100,\\n \\"Applications\\": [\\n {\\n \\"ApplicationName\\": \\"我的应用\\",\\n \\"ApplicationId\\": 20000,\\n \\"ProjectId\\": 10000\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<ListDataServiceApplicationsResponse>\\n <HttpStatusCode>200</HttpStatusCode>\\n <RequestId>0000-ABCD-EFG***</RequestId>\\n <ErrorMessage>正常</ErrorMessage>\\n <Success>true</Success>\\n <ErrorCode>0</ErrorCode>\\n <Data>\\n <PageNumber>1</PageNumber>\\n <PageSize>10</PageSize>\\n <TotalCount>100</TotalCount>\\n <Applications>\\n <ApplicationName>我的应用</ApplicationName>\\n <ApplicationId>20000</ApplicationId>\\n <ProjectId>10000</ProjectId>\\n </Applications>\\n </Data>\\n</ListDataServiceApplicationsResponse>","errorExample":""}]',
+ 'title' => 'ListDataServiceApplications',
+ 'summary' => 'Queries the basic information of applications.',
+ 'requestParamsDescription' => ' ',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ ],
+ 'CreateDataServiceFolder' => [
+ 'methods' => [
+ 'post',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'write',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'create',
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'TenantId',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The tenant ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'docRequired' => false,
+ 'maximum' => '9223372036854775807',
+ 'minimum' => '1',
+ 'example' => '10002',
+ ],
+ ],
+ [
+ 'name' => 'ProjectId',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The ID of the workspace.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => true,
+ 'docRequired' => true,
+ 'maximum' => '9223372036854775807',
+ 'minimum' => '1',
+ 'example' => '10001',
+ ],
+ ],
+ [
+ 'name' => 'FolderName',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The name of the folder.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'Test folder'."\n",
+ ],
+ ],
+ [
+ 'name' => 'ParentId',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The ID of the desired parent folder of the folder. The ID of the root folder in a workflow is 0. The ID of the folder created by users in a workflow is greater than 0.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => true,
+ 'docRequired' => true,
+ 'maximum' => '9223372036854775807',
+ 'minimum' => '0',
+ 'example' => '0',
+ ],
+ ],
+ [
+ 'name' => 'GroupId',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The ID of the desired workflow to which the folder belongs.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => '1000abcd',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'FolderId' => [
+ 'description' => 'The ID of the created folder.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '123',
+ ],
+ 'RequestId' => [
+ 'description' => 'The request ID.'."\n",
+ 'type' => 'string',
+ 'example' => '0000-ABCD-E****',
+ ],
+ ],
+ 'description' => '',
+ ],
+ ],
+ ],
+ 'errorCodes' => [
+ 403 => [
+ [
+ 'errorCode' => 'Forbidden.Access',
+ 'errorMessage' => 'Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.',
+ ],
+ ],
+ 429 => [
+ [
+ 'errorCode' => 'Throttling.Api',
+ 'errorMessage' => 'The request for this resource has exceeded your available limit.',
+ ],
+ [
+ 'errorCode' => 'Throttling.System',
+ 'errorMessage' => 'The DataWorks system is busy. Try again later.',
+ ],
+ [
+ 'errorCode' => 'Throttling.User',
+ 'errorMessage' => 'Your request is too frequent. Try again later.',
+ ],
+ ],
+ 500 => [
+ [
+ 'errorCode' => 'InternalError.System',
+ 'errorMessage' => 'An internal system error occurred. Try again later.',
+ ],
+ [
+ 'errorCode' => 'InternalError.UserId.Missing',
+ 'errorMessage' => 'An internal system error occurred. Try again later.',
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"FolderId\\": 123,\\n \\"RequestId\\": \\"0000-ABCD-E****\\"\\n}","errorExample":""},{"type":"xml","example":"<RequestId>0000-ABCD-E****</RequestId>\\n<FolderId>123</FolderId>","errorExample":""}]',
+ 'title' => 'CreateDataServiceFolder',
+ 'summary' => 'Creates a folder in DataService Studio.',
+ 'requestParamsDescription' => ' ',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ ],
+ 'GetDataServiceFolder' => [
+ 'methods' => [
+ 'post',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'get',
+ 'abilityTreeCode' => '78237',
+ 'abilityTreeNodes' => [
+ 'FEATUREdide7T0EJX',
+ ],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'TenantId',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The tenant ID. This parameter is deprecated. To obtain the tenant ID, perform the following steps: Log on to the [DataWorks console](https://workbench.data.aliyun.com/console). Find your workspace and go to the DataStudio page. On the DataStudio page, click the logon username in the upper-right corner and click User Info in the Menu section.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'docRequired' => false,
+ 'maximum' => '9223372036854775807',
+ 'minimum' => '1',
+ 'example' => '10003',
+ ],
+ ],
+ [
+ 'name' => 'ProjectId',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The ID of the workspace.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => true,
+ 'docRequired' => true,
+ 'maximum' => '9223372036854775807',
+ 'minimum' => '1',
+ 'example' => '10002',
+ ],
+ ],
+ [
+ 'name' => 'FolderId',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The ID of the folder.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => true,
+ 'docRequired' => true,
+ 'maximum' => '9223372036854775807',
+ 'minimum' => '1',
+ 'example' => '10001',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'description' => 'The response parameters.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'description' => 'The request ID.'."\n",
+ 'type' => 'string',
+ 'example' => '0000-ABCD-EF****',
+ ],
+ 'Folder' => [
+ 'description' => 'The details of the folder.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'ParentId' => [
+ 'description' => 'The parent folder ID. The ID of the root folder in a business process is 0, and the ID of a folder created by a user in a business process is greater than 0.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '0',
+ ],
+ 'ModifiedTime' => [
+ 'description' => 'The time when the folder was last modified.'."\n",
+ 'type' => 'string',
+ 'example' => '2020-09-24T18:37:51+0800',
+ ],
+ 'GroupId' => [
+ 'description' => 'The ID of the business process to which the folder belongs.'."\n",
+ 'type' => 'string',
+ 'example' => 'ds_1234',
+ ],
+ 'FolderId' => [
+ 'description' => 'The folder ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '11',
+ ],
+ 'ProjectId' => [
+ 'description' => 'The workspace ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '10001',
+ ],
+ 'FolderName' => [
+ 'description' => 'The name of the folder.'."\n",
+ 'type' => 'string',
+ 'example' => 'test1',
+ ],
+ 'CreatedTime' => [
+ 'description' => 'The time when the folder was created.'."\n",
+ 'type' => 'string',
+ 'example' => '2020-09-24T18:37:51+0800',
+ ],
+ 'TenantId' => [
+ 'description' => 'The tenant ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '10002',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'errorCodes' => [
+ 403 => [
+ [
+ 'errorCode' => 'Forbidden.Access',
+ 'errorMessage' => 'Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.',
+ ],
+ ],
+ 429 => [
+ [
+ 'errorCode' => 'Throttling.Api',
+ 'errorMessage' => 'The request for this resource has exceeded your available limit.',
+ ],
+ [
+ 'errorCode' => 'Throttling.System',
+ 'errorMessage' => 'The DataWorks system is busy. Try again later.',
+ ],
+ [
+ 'errorCode' => 'Throttling.User',
+ 'errorMessage' => 'Your request is too frequent. Try again later.',
+ ],
+ ],
+ 500 => [
+ [
+ 'errorCode' => 'InternalError.System',
+ 'errorMessage' => 'An internal system error occurred. Try again later.',
+ ],
+ [
+ 'errorCode' => 'InternalError.UserId.Missing',
+ 'errorMessage' => 'An internal system error occurred. Try again later.',
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"0000-ABCD-EF****\\",\\n \\"Folder\\": {\\n \\"ParentId\\": 0,\\n \\"ModifiedTime\\": \\"2020-09-24T18:37:51+0800\\",\\n \\"GroupId\\": \\"ds_1234\\",\\n \\"FolderId\\": 11,\\n \\"ProjectId\\": 10001,\\n \\"FolderName\\": \\"test1\\",\\n \\"CreatedTime\\": \\"2020-09-24T18:37:51+0800\\",\\n \\"TenantId\\": 10002\\n }\\n}","errorExample":""},{"type":"xml","example":"<GetDataServiceFolderResponse>\\n <RequestId>0000-ABCD-EF****</RequestId>\\n <Folder>\\n <ParentId>0</ParentId>\\n <ModifiedTime>2020-09-24T18:37:51+0800</ModifiedTime>\\n <GroupId>ds_1234</GroupId>\\n <FolderId>11</FolderId>\\n <ProjectId>10001</ProjectId>\\n <FolderName>test1</FolderName>\\n <CreatedTime>2020-09-24T18:37:51+0800</CreatedTime>\\n <TenantId>10002</TenantId>\\n </Folder>\\n</GetDataServiceFolderResponse>","errorExample":""}]',
+ 'title' => 'GetDataServiceFolder',
+ 'summary' => 'Queries a folder.',
+ 'requestParamsDescription' => ' ',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ ],
+ 'ListDataServiceFolders' => [
+ 'methods' => [
+ 'post',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'get',
+ 'abilityTreeCode' => '78304',
+ 'abilityTreeNodes' => [
+ 'FEATUREdide7T0EJX',
+ ],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'PageNumber',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The page number. Pages start from page 1. Default value: 1.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => false,
+ 'docRequired' => true,
+ 'maximum' => '2147483647',
+ 'minimum' => '1',
+ 'example' => '1',
+ 'default' => '1',
+ ],
+ ],
+ [
+ 'name' => 'PageSize',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The number of entries per page. Default value: 10. Maximum value: 100.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => false,
+ 'docRequired' => true,
+ 'maximum' => '50',
+ 'minimum' => '1',
+ 'example' => '10',
+ 'default' => '10',
+ ],
+ ],
+ [
+ 'name' => 'ProjectId',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The ID of the workspace.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => true,
+ 'docRequired' => true,
+ 'maximum' => '9223372036854775807',
+ 'minimum' => '1',
+ 'example' => '10001',
+ ],
+ ],
+ [
+ 'name' => 'TenantId',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The tenant ID. To obtain the tenant ID, perform the following steps: Log on to the [DataWorks console](https://workbench.data.aliyun.com/console). Find your workspace and go to the DataStudio page. On the page that appears, click the username for the logon in the upper-right corner and click User Info in the Menu section.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'docRequired' => false,
+ 'maximum' => '9223372036854775807',
+ 'minimum' => '1',
+ 'example' => '10002',
+ ],
+ ],
+ [
+ 'name' => 'GroupId',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The ID of the business process to which the folders belong.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'ds_123abc',
+ ],
+ ],
+ [
+ 'name' => 'FolderNameKeyword',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The keyword in folder names. The keyword is used to search for folders whose names contain this keyword.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'Keyword in folder names'."\n",
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'description' => 'The request ID.'."\n",
+ 'type' => 'string',
+ 'example' => '0000-ABCD-EF****',
+ ],
+ 'FolderPagingResult' => [
+ 'description' => 'The paging result for the folders.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'PageNumber' => [
+ 'description' => 'The page number. The value of this parameter is the same as that of the PageNumber parameter in the request.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '1',
+ ],
+ 'PageSize' => [
+ 'description' => 'The number of entries per page. Default value: 10. Maximum value: 100.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '10',
+ ],
+ 'TotalCount' => [
+ 'description' => 'The total number of entries returned.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '100',
+ ],
+ 'Folders' => [
+ 'description' => 'The folders.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'ParentId' => [
+ 'description' => 'The ID of the parent folder. The ID of the root folder in a business process is 0, and the ID of a folder created by a user in a business process is greater than 0.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '0',
+ ],
+ 'ModifiedTime' => [
+ 'description' => 'The time when the folder was last modified.'."\n",
+ 'type' => 'string',
+ 'example' => '2020-09-24T18:37:51+0800',
+ ],
+ 'GroupId' => [
+ 'description' => 'The ID of the business process to which the folder belongs.'."\n",
+ 'type' => 'string',
+ 'example' => 'ds_1234',
+ ],
+ 'FolderId' => [
+ 'description' => 'The folder ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '11',
+ ],
+ 'FolderName' => [
+ 'description' => 'The name of the folder.'."\n",
+ 'type' => 'string',
+ 'example' => 'test1',
+ ],
+ 'ProjectId' => [
+ 'description' => 'The workspace ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '10001',
+ ],
+ 'CreatedTime' => [
+ 'description' => 'The time when the folder was created.'."\n",
+ 'type' => 'string',
+ 'example' => '2020-09-24T18:37:51+0800',
+ ],
+ 'TenantId' => [
+ 'description' => 'The tenant ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '10002',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'description' => '',
+ ],
+ ],
+ ],
+ 'errorCodes' => [
+ 403 => [
+ [
+ 'errorCode' => 'Forbidden.Access',
+ 'errorMessage' => 'Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.',
+ ],
+ ],
+ 429 => [
+ [
+ 'errorCode' => 'Throttling.Api',
+ 'errorMessage' => 'The request for this resource has exceeded your available limit.',
+ ],
+ [
+ 'errorCode' => 'Throttling.System',
+ 'errorMessage' => 'The DataWorks system is busy. Try again later.',
+ ],
+ [
+ 'errorCode' => 'Throttling.User',
+ 'errorMessage' => 'Your request is too frequent. Try again later.',
+ ],
+ ],
+ 500 => [
+ [
+ 'errorCode' => 'InternalError.System',
+ 'errorMessage' => 'An internal system error occurred. Try again later.',
+ ],
+ [
+ 'errorCode' => 'InternalError.UserId.Missing',
+ 'errorMessage' => 'An internal system error occurred. Try again later.',
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"0000-ABCD-EF****\\",\\n \\"FolderPagingResult\\": {\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 100,\\n \\"Folders\\": [\\n {\\n \\"ParentId\\": 0,\\n \\"ModifiedTime\\": \\"2020-09-24T18:37:51+0800\\",\\n \\"GroupId\\": \\"ds_1234\\",\\n \\"FolderId\\": 11,\\n \\"FolderName\\": \\"test1\\",\\n \\"ProjectId\\": 10001,\\n \\"CreatedTime\\": \\"2020-09-24T18:37:51+0800\\",\\n \\"TenantId\\": 10002\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<ListDataServiceFoldersResponse>\\n <RequestId>0000-ABCD-EF****</RequestId>\\n <FolderPagingResult>\\n <PageNumber>1</PageNumber>\\n <PageSize>10</PageSize>\\n <TotalCount>100</TotalCount>\\n <Folders>\\n <ParentId>0</ParentId>\\n <ModifiedTime>2020-09-24T18:37:51+0800</ModifiedTime>\\n <GroupId>ds_1234</GroupId>\\n <FolderId>11</FolderId>\\n <FolderName>test1</FolderName>\\n <ProjectId>10001</ProjectId>\\n <CreatedTime>2020-09-24T18:37:51+0800</CreatedTime>\\n <TenantId>10002</TenantId>\\n </Folders>\\n </FolderPagingResult>\\n</ListDataServiceFoldersResponse>","errorExample":""}]',
+ 'title' => 'ListDataServiceFolders',
+ 'summary' => 'Queries folders.',
+ 'requestParamsDescription' => ' ',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ ],
+ 'CreateDataServiceGroup' => [
+ 'methods' => [
+ 'post',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'write',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'create',
+ 'abilityTreeCode' => '78182',
+ 'abilityTreeNodes' => [
+ 'FEATUREdide7T0EJX',
+ ],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'TenantId',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The tenant ID. This parameter is deprecated.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'docRequired' => false,
+ 'maximum' => '9223372036854775807',
+ 'minimum' => '1',
+ 'example' => '10002',
+ ],
+ ],
+ [
+ 'name' => 'ProjectId',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The ID of the workspace.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => true,
+ 'docRequired' => true,
+ 'maximum' => '9223372036854775807',
+ 'minimum' => '1',
+ 'example' => '10001',
+ ],
+ ],
+ [
+ 'name' => 'ApiGatewayGroupId',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The ID of the API group that is associated with the business process in the API Gateway console. You can log on to the API Gateway console and go to the Group Details page to view the ID.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => '1000abcd',
+ ],
+ ],
+ [
+ 'name' => 'GroupName',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The name of the business process.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'Business process name'."\n",
+ ],
+ ],
+ [
+ 'name' => 'Description',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The description of the business process.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'docRequired' => true,
+ 'example' => 'Test business process'."\n",
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'GroupId' => [
+ 'description' => 'The business process ID.'."\n",
+ 'type' => 'string',
+ 'example' => 'ds_12345',
+ ],
+ 'RequestId' => [
+ 'description' => 'The request ID.'."\n",
+ 'type' => 'string',
+ 'example' => '0000-ABCD-EF****',
+ ],
+ ],
+ 'description' => '',
+ ],
+ ],
+ ],
+ 'errorCodes' => [
+ 403 => [
+ [
+ 'errorCode' => 'Forbidden.Access',
+ 'errorMessage' => 'Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.',
+ ],
+ ],
+ 429 => [
+ [
+ 'errorCode' => 'Throttling.Api',
+ 'errorMessage' => 'The request for this resource has exceeded your available limit.',
+ ],
+ [
+ 'errorCode' => 'Throttling.System',
+ 'errorMessage' => 'The DataWorks system is busy. Try again later.',
+ ],
+ [
+ 'errorCode' => 'Throttling.User',
+ 'errorMessage' => 'Your request is too frequent. Try again later.',
+ ],
+ ],
+ 500 => [
+ [
+ 'errorCode' => 'InternalError.System',
+ 'errorMessage' => 'An internal system error occurred. Try again later.',
+ ],
+ [
+ 'errorCode' => 'InternalError.UserId.Missing',
+ 'errorMessage' => 'An internal system error occurred. Try again later.',
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"GroupId\\": \\"ds_12345\\",\\n \\"RequestId\\": \\"0000-ABCD-EF****\\"\\n}","type":"json"}]',
+ 'title' => 'CreateDataServiceGroup',
+ 'summary' => 'Creates a business process.',
+ ],
+ 'GetDataServiceGroup' => [
+ 'methods' => [
+ 'post',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'get',
+ 'abilityTreeCode' => '78238',
+ 'abilityTreeNodes' => [
+ 'FEATUREdide7T0EJX',
+ ],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'TenantId',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The tenant ID. This parameter is deprecated.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'docRequired' => false,
+ 'maximum' => '9223372036854775807',
+ 'minimum' => '1',
+ 'example' => '10002',
+ ],
+ ],
+ [
+ 'name' => 'ProjectId',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The workspace ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => true,
+ 'docRequired' => true,
+ 'maximum' => '9223372036854775807',
+ 'minimum' => '1',
+ 'example' => '10001',
+ ],
+ ],
+ [
+ 'name' => 'GroupId',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The business process ID.',
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'ds_123abc',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'description' => 'The request ID.'."\n",
+ 'type' => 'string',
+ 'example' => '0000-ABCD-EF****',
+ ],
+ 'Group' => [
+ 'description' => 'The details of the business process.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'ModifiedTime' => [
+ 'description' => 'The time when the business process was last modified.'."\n",
+ 'type' => 'string',
+ 'example' => '2020-09-24T18:37:51+0800',
+ ],
+ 'Description' => [
+ 'description' => 'The description of the business process.'."\n",
+ 'type' => 'string',
+ 'example' => 'Test'."\n",
+ ],
+ 'GroupName' => [
+ 'description' => 'The name of the business process.'."\n",
+ 'type' => 'string',
+ 'example' => 'Test'."\n",
+ ],
+ 'GroupId' => [
+ 'description' => 'The business process ID.'."\n",
+ 'type' => 'string',
+ 'example' => 'ds_123abc',
+ ],
+ 'ProjectId' => [
+ 'description' => 'The workspace ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '10002',
+ ],
+ 'ApiGatewayGroupId' => [
+ 'description' => 'The ID of the API group that is associated with the business process in the API Gateway console.'."\n",
+ 'type' => 'string',
+ 'example' => '100abc',
+ ],
+ 'CreatorId' => [
+ 'description' => 'The user identifier (UID) of the creator of the business process. The value of this parameter may be empty for creators of some existing business processes.'."\n",
+ 'type' => 'string',
+ 'example' => '10001',
+ ],
+ 'CreatedTime' => [
+ 'description' => 'The time when the business process was created.'."\n",
+ 'type' => 'string',
+ 'example' => '2020-09-24T18:37:51+0800',
+ ],
+ 'TenantId' => [
+ 'description' => 'The tenant ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '10003',
+ ],
+ ],
+ ],
+ ],
+ 'description' => '',
+ ],
+ ],
+ ],
+ 'errorCodes' => [
+ 403 => [
+ [
+ 'errorCode' => 'Forbidden.Access',
+ 'errorMessage' => 'Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.',
+ ],
+ ],
+ 429 => [
+ [
+ 'errorCode' => 'Throttling.Api',
+ 'errorMessage' => 'The request for this resource has exceeded your available limit.',
+ ],
+ [
+ 'errorCode' => 'Throttling.System',
+ 'errorMessage' => 'The DataWorks system is busy. Try again later.',
+ ],
+ [
+ 'errorCode' => 'Throttling.User',
+ 'errorMessage' => 'Your request is too frequent. Try again later.',
+ ],
+ ],
+ 500 => [
+ [
+ 'errorCode' => 'InternalError.System',
+ 'errorMessage' => 'An internal system error occurred. Try again later.',
+ ],
+ [
+ 'errorCode' => 'InternalError.UserId.Missing',
+ 'errorMessage' => 'An internal system error occurred. Try again later.',
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0000-ABCD-EF****\\",\\n \\"Group\\": {\\n \\"ModifiedTime\\": \\"2020-09-24T18:37:51+0800\\",\\n \\"Description\\": \\"业务流程描述\\",\\n \\"GroupName\\": \\"业务流程名称\\",\\n \\"GroupId\\": \\"ds_123abc\\",\\n \\"ProjectId\\": 10002,\\n \\"ApiGatewayGroupId\\": \\"100abc\\",\\n \\"CreatorId\\": \\"10001\\",\\n \\"CreatedTime\\": \\"2020-09-24T18:37:51+0800\\",\\n \\"TenantId\\": 10003\\n }\\n}","type":"json"}]',
+ 'title' => 'GetDataServiceGroup',
+ 'summary' => 'Queries a business process.',
+ ],
+ 'ListDataServiceGroups' => [
+ 'methods' => [
+ 'post',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'get',
+ 'abilityTreeCode' => '78305',
+ 'abilityTreeNodes' => [
+ 'FEATUREdide7T0EJX',
+ ],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'PageNumber',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The page number. Pages start from page 1. Default value: 1.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => false,
+ 'docRequired' => true,
+ 'maximum' => '2147483647',
+ 'minimum' => '1',
+ 'example' => '1',
+ 'default' => '1',
+ ],
+ ],
+ [
+ 'name' => 'PageSize',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The number of entries per page. Valid values: 1 to 100. Default value: 10.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => false,
+ 'docRequired' => true,
+ 'maximum' => '50',
+ 'minimum' => '1',
+ 'example' => '10',
+ 'default' => '10',
+ ],
+ ],
+ [
+ 'name' => 'ProjectId',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The workspace ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => true,
+ 'docRequired' => true,
+ 'maximum' => '9223372036854775807',
+ 'minimum' => '1',
+ 'example' => '10000',
+ ],
+ ],
+ [
+ 'name' => 'TenantId',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The tenant ID. This parameter is deprecated.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'docRequired' => false,
+ 'maximum' => '9223372036854775807',
+ 'minimum' => '1',
+ 'example' => '10001',
+ ],
+ ],
+ [
+ 'name' => 'GroupNameKeyword',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The keyword of a business process name. The keyword is used to search for business processes whose names contain this keyword.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'Test business process'."\n",
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'description' => 'The request ID.'."\n",
+ 'type' => 'string',
+ 'example' => '0000-ABCD-EF****',
+ ],
+ 'GroupPagingResult' => [
+ 'description' => 'The paging result for the business processes.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'PageNumber' => [
+ 'description' => 'The page number. The value of this parameter is the same as that of the PageNumber parameter in the request.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '1',
+ ],
+ 'PageSize' => [
+ 'description' => 'The number of entries per page. Valid values: 1 to 100. Default value: 10.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '10',
+ ],
+ 'TotalCount' => [
+ 'description' => 'The total number of entries returned.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '100',
+ ],
+ 'Groups' => [
+ 'description' => 'The business processes.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'ModifiedTime' => [
+ 'description' => 'The time when the business process was modified.'."\n",
+ 'type' => 'string',
+ 'example' => '2020-09-24T18:37:51+0800',
+ ],
+ 'Description' => [
+ 'description' => 'The description of the business process.'."\n",
+ 'type' => 'string',
+ 'example' => 'Test'."\n",
+ ],
+ 'GroupName' => [
+ 'description' => 'The name of the business process.'."\n",
+ 'type' => 'string',
+ 'example' => 'Test'."\n",
+ ],
+ 'GroupId' => [
+ 'description' => 'The business process ID.'."\n",
+ 'type' => 'string',
+ 'example' => 'ds_123abc',
+ ],
+ 'ProjectId' => [
+ 'description' => 'The workspace ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '10002',
+ ],
+ 'ApiGatewayGroupId' => [
+ 'description' => 'The ID of the API Gateway group to which the workflow is bound.'."\n",
+ 'type' => 'string',
+ 'example' => '100abc',
+ ],
+ 'CreatorId' => [
+ 'description' => 'The user identifier (UID) of the creator of the business process. The value of this parameter may be empty for creators of some existing business processes.'."\n",
+ 'type' => 'string',
+ 'example' => '10001',
+ ],
+ 'CreatedTime' => [
+ 'description' => 'The time when the business process was created.'."\n",
+ 'type' => 'string',
+ 'example' => '2020-09-24T18:37:51+0800',
+ ],
+ 'TenantId' => [
+ 'description' => 'The tenant ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '10003',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'description' => '',
+ ],
+ ],
+ ],
+ 'errorCodes' => [
+ 403 => [
+ [
+ 'errorCode' => 'Forbidden.Access',
+ 'errorMessage' => 'Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.',
+ ],
+ ],
+ 429 => [
+ [
+ 'errorCode' => 'Throttling.Api',
+ 'errorMessage' => 'The request for this resource has exceeded your available limit.',
+ ],
+ [
+ 'errorCode' => 'Throttling.System',
+ 'errorMessage' => 'The DataWorks system is busy. Try again later.',
+ ],
+ [
+ 'errorCode' => 'Throttling.User',
+ 'errorMessage' => 'Your request is too frequent. Try again later.',
+ ],
+ ],
+ 500 => [
+ [
+ 'errorCode' => 'InternalError.System',
+ 'errorMessage' => 'An internal system error occurred. Try again later.',
+ ],
+ [
+ 'errorCode' => 'InternalError.UserId.Missing',
+ 'errorMessage' => 'An internal system error occurred. Try again later.',
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"0000-ABCD-EF****\\",\\n \\"GroupPagingResult\\": {\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 100,\\n \\"Groups\\": [\\n {\\n \\"ModifiedTime\\": \\"2020-09-24T18:37:51+0800\\",\\n \\"Description\\": \\"业务流程描述\\",\\n \\"GroupName\\": \\"业务流程名称\\",\\n \\"GroupId\\": \\"ds_123abc\\",\\n \\"ProjectId\\": 10002,\\n \\"ApiGatewayGroupId\\": \\"100abc\\",\\n \\"CreatorId\\": \\"10001\\",\\n \\"CreatedTime\\": \\"2020-09-24T18:37:51+0800\\",\\n \\"TenantId\\": 10003\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<ListDataServiceGroupsResponse>\\n <GroupPagingResult>\\n <Groups/>\\n </GroupPagingResult>\\n</ListDataServiceGroupsResponse>","errorExample":""}]',
+ 'title' => 'ListDataServiceGroups',
+ 'summary' => 'Queries business processes.',
+ ],
+ 'CreateDataServiceApiAuthority' => [
+ 'methods' => [
+ 'post',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'write',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'create',
+ 'abilityTreeCode' => '78180',
+ 'abilityTreeNodes' => [
+ 'FEATUREdideWDSR97',
+ ],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'TenantId',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The tenant ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'docRequired' => false,
+ 'maximum' => '9223372036854775807',
+ 'minimum' => '1',
+ 'example' => '1004',
+ ],
+ ],
+ [
+ 'name' => 'ProjectId',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The ID of the workspace.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => true,
+ 'docRequired' => true,
+ 'maximum' => '9223372036854775807',
+ 'minimum' => '1',
+ 'example' => '10003',
+ ],
+ ],
+ [
+ 'name' => 'ApiId',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The ID of the API.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => true,
+ 'docRequired' => true,
+ 'maximum' => '9223372036854775807',
+ 'minimum' => '1',
+ 'example' => '10001',
+ ],
+ ],
+ [
+ 'name' => 'AuthorizedProjectId',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The ID of the workspace to which the access permissions on the API are granted.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => true,
+ 'docRequired' => true,
+ 'maximum' => '9223372036854775807',
+ 'minimum' => '1',
+ 'example' => '10002',
+ ],
+ ],
+ [
+ 'name' => 'EndTime',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The end time of the validity period of the access permissions. The time must be a UNIX timestamp. Unit: seconds. Example: 1600531564, which indicates 2020-09-20 00:06:04 (UTC+8).'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => true,
+ 'docRequired' => true,
+ 'maximum' => '9223372036854775807',
+ 'minimum' => '1',
+ 'example' => '1600531564',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'Success' => [
+ 'description' => 'Indicates whether the authorization was successful.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'RequestId' => [
+ 'description' => 'The request ID.'."\n",
+ 'type' => 'string',
+ 'example' => '0000-ABCD-EF****',
+ ],
+ ],
+ 'description' => '',
+ ],
+ ],
+ ],
+ 'errorCodes' => [
+ 403 => [
+ [
+ 'errorCode' => 'Forbidden.Access',
+ 'errorMessage' => 'Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.',
+ ],
+ ],
+ 429 => [
+ [
+ 'errorCode' => 'Throttling.Api',
+ 'errorMessage' => 'The request for this resource has exceeded your available limit.',
+ ],
+ [
+ 'errorCode' => 'Throttling.System',
+ 'errorMessage' => 'The DataWorks system is busy. Try again later.',
+ ],
+ [
+ 'errorCode' => 'Throttling.User',
+ 'errorMessage' => 'Your request is too frequent. Try again later.',
+ ],
+ ],
+ 500 => [
+ [
+ 'errorCode' => 'InternalError.System',
+ 'errorMessage' => 'An internal system error occurred. Try again later.',
+ ],
+ [
+ 'errorCode' => 'InternalError.UserId.Missing',
+ 'errorMessage' => 'An internal system error occurred. Try again later.',
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"0000-ABCD-EF****\\"\\n}","errorExample":""},{"type":"xml","example":"<RequestId>0000-ABCD-EFo****</RequestId>\\n<Success>true</Success>","errorExample":""}]',
+ 'title' => 'CreateDataServiceApiAuthority',
+ 'summary' => 'Grants the access permissions on an API in DataService Studio.',
+ 'requestParamsDescription' => ' ',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ ],
+ 'DeleteDataServiceApiAuthority' => [
+ 'methods' => [
+ 'post',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'write',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'delete',
+ 'abilityTreeCode' => '78205',
+ 'abilityTreeNodes' => [
+ 'FEATUREdideWDSR97',
+ ],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'TenantId',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The tenant ID. This parameter is deprecated.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'docRequired' => false,
+ 'maximum' => '9223372036854775807',
+ 'minimum' => '1',
+ 'example' => '10004',
+ ],
+ ],
+ [
+ 'name' => 'ProjectId',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The workspace ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => true,
+ 'docRequired' => true,
+ 'maximum' => '9223372036854775807',
+ 'minimum' => '1',
+ 'example' => '10003',
+ ],
+ ],
+ [
+ 'name' => 'ApiId',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The API ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => true,
+ 'docRequired' => true,
+ 'maximum' => '9223372036854775807',
+ 'minimum' => '1',
+ 'example' => '10001',
+ ],
+ ],
+ [
+ 'name' => 'AuthorizedProjectId',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The ID of the workspace from which you want to revoke the access permissions on the API.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => true,
+ 'docRequired' => true,
+ 'maximum' => '9223372036854775807',
+ 'minimum' => '1',
+ 'example' => '10002',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'Success' => [
+ 'description' => 'Indicates whether the request was successful.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'RequestId' => [
+ 'description' => 'The request ID.'."\n",
+ 'type' => 'string',
+ 'example' => '0000-ABCD-EF****',
+ ],
+ ],
+ 'description' => '',
+ ],
+ ],
+ ],
+ 'errorCodes' => [
+ 403 => [
+ [
+ 'errorCode' => 'Forbidden.Access',
+ 'errorMessage' => 'Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.',
+ ],
+ ],
+ 429 => [
+ [
+ 'errorCode' => 'Throttling.Api',
+ 'errorMessage' => 'The request for this resource has exceeded your available limit.',
+ ],
+ [
+ 'errorCode' => 'Throttling.System',
+ 'errorMessage' => 'The DataWorks system is busy. Try again later.',
+ ],
+ [
+ 'errorCode' => 'Throttling.User',
+ 'errorMessage' => 'Your request is too frequent. Try again later.',
+ ],
+ ],
+ 500 => [
+ [
+ 'errorCode' => 'InternalError.System',
+ 'errorMessage' => 'An internal system error occurred. Try again later.',
+ ],
+ [
+ 'errorCode' => 'InternalError.UserId.Missing',
+ 'errorMessage' => 'An internal system error occurred. Try again later.',
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"0000-ABCD-EF****\\"\\n}","type":"json"}]',
+ 'title' => 'DeleteDataServiceApiAuthority',
+ 'summary' => 'Revokes the access permissions on an API.',
+ ],
+ 'ListDataServiceApiTest' => [
+ 'methods' => [
+ 'get',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'get',
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'ApiId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the DataService Studio API on which tests are performed.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => '12345',
+ ],
+ ],
+ [
+ 'name' => 'PageSize',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The number of entries to return on each page. Maximum value: 100.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => false,
+ 'example' => '10',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'headers' => [],
+ 'schema' => [
+ 'description' => 'The returned result.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'description' => 'The ID of the request.'."\n",
+ 'type' => 'string',
+ 'example' => 'ESDAFWEA',
+ ],
+ 'Data' => [
+ 'description' => 'The list of test records.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The test record.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'TestId' => [
+ 'description' => 'The ID of the test.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '123',
+ ],
+ 'ApiId' => [
+ 'description' => 'The ID of the DataService Studio API on which the test is performed.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '2343',
+ ],
+ 'ParamMap' => [
+ 'description' => 'The request parameters configured for the test.'."\n",
+ 'type' => 'string',
+ 'example' => '{"name":"test"}',
+ ],
+ 'RetCode' => [
+ 'description' => 'The status code returned for the test. If the test is not complete, this parameter is not returned.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '0',
+ ],
+ 'RetResult' => [
+ 'description' => 'The result returned for the test.'."\n",
+ 'type' => 'string',
+ 'example' => '{"id":2}',
+ ],
+ 'CostTime' => [
+ 'description' => 'The time that is consumed to complete the test.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '10',
+ ],
+ 'Status' => [
+ 'description' => 'The status of the test. Valid values: RUNNING and FINISHED.'."\n",
+ 'type' => 'string',
+ 'example' => 'FINISHED',
+ ],
+ 'CreateTime' => [
+ 'description' => 'The time when the test was initiated.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '1651824913000',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'errorCodes' => [
+ 403 => [
+ [
+ 'errorCode' => 'Forbidden.Access',
+ 'errorMessage' => 'Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.',
+ ],
+ ],
+ 429 => [
+ [
+ 'errorCode' => 'Throttling.Api',
+ 'errorMessage' => 'The request for this resource has exceeded your available limit.',
+ ],
+ [
+ 'errorCode' => 'Throttling.System',
+ 'errorMessage' => 'The DataWorks system is busy. Try again later.',
+ ],
+ [
+ 'errorCode' => 'Throttling.User',
+ 'errorMessage' => 'Your request is too frequent. Try again later.',
+ ],
+ ],
+ 500 => [
+ [
+ 'errorCode' => 'InternalError.System',
+ 'errorMessage' => 'An internal system error occurred. Try again later.',
+ ],
+ [
+ 'errorCode' => 'InternalError.UserId.Missing',
+ 'errorMessage' => 'An internal system error occurred. Try again later.',
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"ESDAFWEA\\",\\n \\"Data\\": [\\n {\\n \\"TestId\\": 123,\\n \\"ApiId\\": 2343,\\n \\"ParamMap\\": \\"{\\\\\\"name\\\\\\":\\\\\\"test\\\\\\"}\\",\\n \\"RetCode\\": 0,\\n \\"RetResult\\": \\"{\\\\\\"id\\\\\\":2}\\",\\n \\"CostTime\\": 10,\\n \\"Status\\": \\"FINISHED\\",\\n \\"CreateTime\\": 1651824913000\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<ListDataServiceApiTestResponse>\\n <RequestId>ESDAFWEA</RequestId>\\n <Data>\\n <TestId>123</TestId>\\n <ApiId>2343</ApiId>\\n <ParamMap>{\\"name\\":\\"test\\"}</ParamMap>\\n <RetCode>0</RetCode>\\n <RetResult>{\\"id\\":2}</RetResult>\\n <CostTime>10</CostTime>\\n <Status>FINISHED</Status>\\n <CreateTime>1651824913000</CreateTime>\\n </Data>\\n</ListDataServiceApiTestResponse>","errorExample":""}]',
+ 'title' => 'ListDataServiceApiTest',
+ 'summary' => 'Queries the test records of a DataService Studio API. This API operation allows you to query only the test records that are generated within the previous month.',
+ ],
+ 'TestDataServiceApi' => [
+ 'methods' => [
+ 'post',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'get',
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'ApiId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the DataService Studio API on which the test is performed.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => '12343',
+ ],
+ ],
+ [
+ 'name' => 'QueryParam',
+ 'in' => 'formData',
+ 'style' => 'repeatList',
+ 'schema' => [
+ 'description' => 'The request parameters that are contained in the query.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The object that is requested to query.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'ParamKey' => [
+ 'description' => 'The name of the parameter.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'name',
+ ],
+ 'ParamValue' => [
+ 'description' => 'The value of the parameter.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'test',
+ ],
+ ],
+ 'required' => false,
+ ],
+ 'required' => false,
+ 'maxItems' => 500,
+ ],
+ ],
+ [
+ 'name' => 'BodyParams',
+ 'in' => 'formData',
+ 'style' => 'repeatList',
+ 'schema' => [
+ 'description' => 'The request parameters that are contained in the request body.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The object that is requested to query.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'ParamKey' => [
+ 'description' => 'The name of the parameter.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'name',
+ ],
+ 'ParamValue' => [
+ 'description' => 'The value of the parameter.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'test',
+ ],
+ ],
+ 'required' => false,
+ ],
+ 'required' => false,
+ 'maxItems' => 500,
+ ],
+ ],
+ [
+ 'name' => 'PathParams',
+ 'in' => 'formData',
+ 'style' => 'repeatList',
+ 'schema' => [
+ 'description' => 'The request parameters that are contained in the request path.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The object that is requested to query.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'ParamKey' => [
+ 'description' => 'The name of the parameter.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'path1',
+ ],
+ 'ParamValue' => [
+ 'description' => 'The value of the parameter.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'api',
+ ],
+ ],
+ 'required' => false,
+ ],
+ 'required' => false,
+ 'maxItems' => 500,
+ ],
+ ],
+ [
+ 'name' => 'HeadParams',
+ 'in' => 'formData',
+ 'style' => 'repeatList',
+ 'schema' => [
+ 'description' => 'The request parameters that are contained in the request header.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The object that is requested to query.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'ParamKey' => [
+ 'description' => 'The name of the parameter.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'requestId',
+ ],
+ 'ParamValue' => [
+ 'description' => 'The value of the parameter.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'abcd',
+ ],
+ ],
+ 'required' => false,
+ ],
+ 'required' => false,
+ 'maxItems' => 500,
+ ],
+ ],
+ [
+ 'name' => 'BodyContent',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The data of the request body.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => '{"name":"test"}',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'description' => 'The returned result.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'description' => 'The ID of the request.'."\n",
+ 'type' => 'string',
+ 'example' => 'abdsfewe',
+ ],
+ 'Data' => [
+ 'description' => 'The information about the test.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'TestId' => [
+ 'description' => 'The ID of the test.'."\n",
+ 'type' => 'string',
+ 'example' => '232432',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'errorCodes' => [
+ 403 => [
+ [
+ 'errorCode' => 'Forbidden.Access',
+ 'errorMessage' => 'Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.',
+ ],
+ ],
+ 429 => [
+ [
+ 'errorCode' => 'Throttling.Api',
+ 'errorMessage' => 'The request for this resource has exceeded your available limit.',
+ ],
+ [
+ 'errorCode' => 'Throttling.System',
+ 'errorMessage' => 'The DataWorks system is busy. Try again later.',
+ ],
+ [
+ 'errorCode' => 'Throttling.User',
+ 'errorMessage' => 'Your request is too frequent. Try again later.',
+ ],
+ ],
+ 500 => [
+ [
+ 'errorCode' => 'InternalError.System',
+ 'errorMessage' => 'An internal system error occurred. Try again later.',
+ ],
+ [
+ 'errorCode' => 'InternalError.UserId.Missing',
+ 'errorMessage' => 'An internal system error occurred. Try again later.',
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"abdsfewe\\",\\n \\"Data\\": {\\n \\"TestId\\": \\"232432\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"<TestDataServiceApiResponse>\\n <RequestId>abdsfewe</RequestId>\\n <Data>\\n <TestId>232432</TestId>\\n </Data>\\n</TestDataServiceApiResponse>","errorExample":""}]',
+ 'title' => 'TestDataServiceApi',
+ 'summary' => 'Tests a DataService Studio API in asynchronous mode. You can call the GetDataServiceApiTest operation to query the test result.',
+ ],
+ 'GetDataServiceApiTest' => [
+ 'methods' => [
+ 'get',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'get',
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'TestId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The Id of the test. TestDataServiceApi is executed asynchronously after the API is called and the test Id is returned. You can also use ListDataServiceApiTest to obtain the latest test Id.',
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => '123434',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'headers' => [],
+ 'schema' => [
+ 'description' => 'The returned result.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'description' => 'The request ID.'."\n",
+ 'type' => 'string',
+ 'example' => 'adssdsewe',
+ ],
+ 'Data' => [
+ 'description' => 'Return object',
+ 'type' => 'object',
+ 'properties' => [
+ 'ApiId' => [
+ 'description' => 'Test API Id',
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '12343',
+ ],
+ 'ParamMap' => [
+ 'description' => 'Test API request parameters',
+ 'type' => 'string',
+ 'example' => '{"name":"test"}',
+ ],
+ 'RetCode' => [
+ 'description' => 'The test API returns the code. If it is not completed, the data is empty.',
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '0',
+ ],
+ 'RetResult' => [
+ 'description' => 'Return data',
+ 'type' => 'string',
+ 'example' => '{"id":2}',
+ ],
+ 'DebugInfo' => [
+ 'description' => 'Debug information',
+ 'type' => 'string',
+ 'example' => '[<span style=\\"color: #92D581;\\">INFO</span>] [16:15:13.240] resource group is 498774069027041[<span style=\\"color: #92D581;\\">INFO</span>]',
+ ],
+ 'CostTime' => [
+ 'description' => 'Time consuming',
+ 'type' => 'string',
+ 'example' => '10',
+ ],
+ 'NodesDebugInfo' => [
+ 'description' => 'Node Debug information',
+ 'type' => 'string',
+ 'example' => '[<span style=\\"color: #92D581;\\">INFO</span>] [16:15:13.240] resource group is 498774069027041[<span style=\\"color: #92D581;\\">INFO</span>]',
+ ],
+ 'Status' => [
+ 'description' => 'Whether the task has been completed, including: RUNNING,FINISHED',
+ 'type' => 'string',
+ 'example' => 'FINISHED',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'errorCodes' => [
+ 403 => [
+ [
+ 'errorCode' => 'Forbidden.Access',
+ 'errorMessage' => 'Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.',
+ ],
+ ],
+ 429 => [
+ [
+ 'errorCode' => 'Throttling.Api',
+ 'errorMessage' => 'The request for this resource has exceeded your available limit.',
+ ],
+ [
+ 'errorCode' => 'Throttling.System',
+ 'errorMessage' => 'The DataWorks system is busy. Try again later.',
+ ],
+ [
+ 'errorCode' => 'Throttling.User',
+ 'errorMessage' => 'Your request is too frequent. Try again later.',
+ ],
+ ],
+ 500 => [
+ [
+ 'errorCode' => 'InternalError.System',
+ 'errorMessage' => 'An internal system error occurred. Try again later.',
+ ],
+ [
+ 'errorCode' => 'InternalError.UserId.Missing',
+ 'errorMessage' => 'An internal system error occurred. Try again later.',
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"adssd****\\",\\n \\"Data\\": {\\n \\"ApiId\\": 12343,\\n \\"ParamMap\\": \\"{\\\\\\"name\\\\\\":\\\\\\"test\\\\\\"}\\",\\n \\"RetCode\\": 0,\\n \\"RetResult\\": \\"{\\\\\\"id\\\\\\":2}\\",\\n \\"DebugInfo\\": \\"[<span style=\\\\\\\\\\\\\\"color: #92D581;\\\\\\\\\\\\\\">INFO</span>] [16:15:13.240] resource group is 498774069027041[<span style=\\\\\\\\\\\\\\"color: #92D581;\\\\\\\\\\\\\\">INFO</span>]\\",\\n \\"CostTime\\": \\"10\\",\\n \\"NodesDebugInfo\\": \\"[<span style=\\\\\\\\\\\\\\"color: #92D581;\\\\\\\\\\\\\\">INFO</span>] [16:15:13.240] resource group is 498774069027041[<span style=\\\\\\\\\\\\\\"color: #92D581;\\\\\\\\\\\\\\">INFO</span>]\\",\\n \\"Status\\": \\"FINISHED\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"<GetDataServiceApiTestResponse>\\n <RequestId>adssdsewe</RequestId>\\n <Data>\\n <ApiId>12343</ApiId>\\n <ParamMap>{\\"name\\":\\"test\\"}</ParamMap>\\n <RetCode>0</RetCode>\\n <RetResult>{\\"id\\":2}</RetResult>\\n <DebugInfo>[&lt;span style=\\\\\\"color: #92D581;\\\\\\"&gt;INFO&lt;/span&gt;] [16:15:13.240] resource group is 498774069027041[&lt;span style=\\\\\\"color: #92D581;\\\\\\"&gt;INFO&lt;/span&gt;]</DebugInfo>\\n <CostTime>10</CostTime>\\n <NodesDebugInfo>[&lt;span style=\\\\\\"color: #92D581;\\\\\\"&gt;INFO&lt;/span&gt;] [16:15:13.240] resource group is 498774069027041[&lt;span style=\\\\\\"color: #92D581;\\\\\\"&gt;INFO&lt;/span&gt;]</NodesDebugInfo>\\n <Status>FINISHED</Status>\\n </Data>\\n</GetDataServiceApiTestResponse>","errorExample":""}]',
+ 'title' => 'GetDataServiceApiTest',
+ 'summary' => 'Queries the test results of an API in DataService Studio.',
+ ],
+ 'SubmitDataServiceApi' => [
+ 'summary' => 'Submits an API in DataService Studio.',
+ 'methods' => [
+ 'post',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'update',
+ 'abilityTreeCode' => '157978',
+ 'abilityTreeNodes' => [
+ 'FEATUREdideZZ63WZ',
+ ],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'TenantId',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The tenant ID. To obtain the tenant ID, perform the following steps: Log on to the DataWorks console. Find your workspace and go to the [DataService Studio](https://ds-cn-shanghai.data.aliyun.com/) page. On the DataService Studio page, click the logon username in the upper-right corner and click User Info in the Menu section.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'example' => '10001',
+ ],
+ ],
+ [
+ 'name' => 'ProjectId',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The DataWorks workspace ID. You can log on to the [DataWorks console](https://workbench.data.aliyun.com/console) and go to the Workspace page to obtain the workspace ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => true,
+ 'example' => '10000',
+ ],
+ ],
+ [
+ 'name' => 'ApiId',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The API ID. You can call the [ListDataServiceApis](~~ListDataServiceApis~~) operation to obtain the ID.',
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => true,
+ 'example' => '12345',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => 'Schema of Response',
+ 'description' => 'The response parameters.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'description' => 'The request ID.'."\n",
+ 'type' => 'string',
+ 'example' => '0000-ABCD-EFG****',
+ ],
+ 'HttpStatusCode' => [
+ 'description' => 'The HTTP status code.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '200',
+ ],
+ 'Data' => [
+ 'description' => 'Indicates whether the API was submitted.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code.'."\n",
+ 'type' => 'string',
+ 'example' => 'Invalid.Tenant.ConnectionNotExists',
+ ],
+ 'Success' => [
+ 'description' => 'Indicates whether the request was successful.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"0000-ABCD-EFG****\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Data\\": true,\\n \\"ErrorCode\\": \\"Invalid.Tenant.ConnectionNotExists\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<SubmitDataServiceApiResponse>\\n <RequestId>0000-ABCD-EFG****</RequestId>\\n <HttpStatusCode>200</HttpStatusCode>\\n <Data>true</Data>\\n <ErrorCode>Invalid.Tenant.ConnectionNotExists</ErrorCode>\\n <Success>true</Success>\\n</SubmitDataServiceApiResponse>","errorExample":""}]',
+ 'title' => 'SubmitDataServiceApi',
+ ],
+ 'SaveDataServiceApiTestResult' => [
+ 'summary' => 'Saves the test results of an API.',
+ 'methods' => [
+ 'post',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'update',
+ 'abilityTreeCode' => '169364',
+ 'abilityTreeNodes' => [
+ 'FEATUREdideNC84FD',
+ ],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'ApiId',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The API ID. You can call the [ListDataServiceApis](~~174012~~) operation to obtain the ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => true,
+ 'example' => '417381955954827',
+ ],
+ ],
+ [
+ 'name' => 'ProjectId',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The DataWorks workspace ID. You can log on to the [DataWorks console](https://workbench.data.aliyun.com/console) and go to the Workspace page to obtain the workspace ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => true,
+ 'example' => '10001',
+ ],
+ ],
+ [
+ 'name' => 'ResultSample',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The sample success response of the API. This parameter is optional.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => '{ "data": { "totalNum": 0, "pageSize": 10, "rows": [], "pageNum": 1 }, "errCode": 0, "requestId": "0bc14a561678159140664515*****", "errMsg": "success", "apiLog": null}',
+ ],
+ ],
+ [
+ 'name' => 'FailResultSample',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The sample failure response of the API. This parameter is optional.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => '{"apiLog": null, "data": null, "errCode": 1108110622, "errMsg": "data Source query failed", "requestId": "0 bc14a **** 5902762031 ****"}',
+ ],
+ ],
+ [
+ 'name' => 'AutoGenerate',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'Specifies whether to use the test results generated by the system. If you do not configure the resultSample or failResultSample parameter, the test results generated by the system are used.'."\n",
+ 'type' => 'boolean',
+ 'required' => false,
+ 'example' => 'false',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => 'Schema of Response',
+ 'description' => 'The response parameters.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'title' => 'Id of the request',
+ 'description' => 'The request ID.'."\n",
+ 'type' => 'string',
+ 'example' => '0000-ABCD-EFG**** ',
+ ],
+ 'Data' => [
+ 'description' => 'Indicates whether the test results are saved.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'Success' => [
+ 'description' => 'Indicates whether the request was successful.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'HttpStatusCode' => [
+ 'description' => 'The HTTP status code.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '200',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'staticInfo' => [
+ 'returnType' => 'synchronous',
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"0000-ABCD-EF*****\\\\t\\",\\n \\"Data\\": true,\\n \\"Success\\": true,\\n \\"HttpStatusCode\\": 200\\n}","errorExample":""},{"type":"xml","example":"<SaveDataServiceApiTestResultResponse>\\n <RequestId>0000-ABCD-EFG****\\t</RequestId>\\n <Data>true</Data>\\n <Success>true</Success>\\n <HttpStatusCode>200</HttpStatusCode>\\n</SaveDataServiceApiTestResultResponse>","errorExample":""}]',
+ 'title' => 'SaveDataServiceApiTestResult',
+ ],
+ 'GetOpSensitiveData' => [
+ 'methods' => [
+ 'get',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'get',
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'Name',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The parameters that you can configure to query the access records. Valid values:'."\n"
+ ."\n"
+ .'* dbType'."\n"
+ .'* instanceName'."\n"
+ .'* databaseName'."\n"
+ .'* projectName'."\n"
+ .'* clusterName'."\n"
+ ."\n"
+ .'The following example shows the parameters configured to query the access records of the sensitive data in the abc database of the Hologres instance ABC: \\[ {"dbType":"hologres","instanceName":"ABC","databaseName":"abc"} ]'."\n"
+ ."\n"
+ .'You must configure the parameters based on the compute engine that you use in your business.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => '[ {"dbType":"hologres","instanceName":"ABC","databaseName":"abc"}, {"dbType":"ODPS.ODPS","projectName":"adbc"} ]',
+ ],
+ ],
+ [
+ 'name' => 'PageSize',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The number of entries per page. Minimum value: 1. Maximum value: 1000.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => true,
+ 'docRequired' => true,
+ 'maximum' => '1000',
+ 'minimum' => '1',
+ 'example' => '1',
+ ],
+ ],
+ [
+ 'name' => 'PageNo',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The page number. Valid values: 1 to 1000.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => true,
+ 'docRequired' => true,
+ 'maximum' => '1000',
+ 'minimum' => '1',
+ 'example' => '100',
+ ],
+ ],
+ [
+ 'name' => 'Date',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The date on which access records were generated. Specify the value in the yyyyMMdd format.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => '20210116',
+ ],
+ ],
+ [
+ 'name' => 'OpType',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The operation that is performed on the data. Valid values:'."\n"
+ ."\n"
+ .'* SQL_SELECT: specifies the data access operation. For example, execute a SELECT statement to query data.'."\n"
+ .'* TUNNEL_DOWNLOAD: specifies the data download operation. For example, run a Tunnel command to download data.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'SQL_SELECT',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'description' => 'The returned result.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'OpSensitiveData' => [
+ 'description' => 'The information about the access records of the sensitive data. The information includes totalCount and opRiskDatas. opRiskDatas includes the following parameters:'."\n"
+ ."\n"
+ .'* sensType: the type of the sensitive data.'."\n"
+ .'* sensLevel: the sensitivity level of the sensitive data. A larger value indicates a higher sensitivity level.'."\n"
+ .'* opType: the type of the operation.'."\n"
+ .'* sql: the SQL statement that is executed.'."\n"
+ .'* opAccount: the account that is used to perform the operation.'."\n"
+ .'* opTime: the time when the operation was performed.'."\n",
+ 'type' => 'string',
+ 'example' => '"opSensDatas": [ { "sensLevel": "L4", "opTime": "2021-02-07 00:14:51", "opAccount": "ALIYUN$dsg_test", "sensType": "Mobile phone number", "sql": "select * from dsg_demo.tbl_phonebook where phone_no = &#39;1331111****&#39;;" } ], "totalCount": 6',
+ ],
+ 'RequestId' => [
+ 'description' => 'The request ID.'."\n",
+ 'type' => 'string',
+ 'example' => '0000-ABCD-EFG****',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'errorCodes' => [
+ 400 => [
+ [
+ 'errorCode' => 'Invalid.Param',
+ 'errorMessage' => 'The request parameter is invalid.',
+ ],
+ ],
+ 403 => [
+ [
+ 'errorCode' => 'Forbidden.NoTenant',
+ 'errorMessage' => 'The tenant information cannot be obtained using user ID.',
+ ],
+ ],
+ 500 => [
+ [
+ 'errorCode' => 'InternalError.DQC.BizError',
+ 'errorMessage' => 'An internal error occurred.',
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"OpSensitiveData\\": \\"\\\\\\"opSensDatas\\\\\\": [ { \\\\\\"sensLevel\\\\\\": \\\\\\"L4\\\\\\", \\\\\\"opTime\\\\\\": \\\\\\"2021-02-07 00:14:51\\\\\\", \\\\\\"opAccount\\\\\\": \\\\\\"ALIYUN$dsg_test\\\\\\", \\\\\\"sensType\\\\\\": \\\\\\"Mobile phone number\\\\\\", \\\\\\"sql\\\\\\": \\\\\\"select * from dsg_demo.tbl_phonebook where phone_no = &#39;1331111****&#39;;\\\\\\" } ], \\\\\\"totalCount\\\\\\": 6\\",\\n \\"RequestId\\": \\"0000-ABCD-EFG****\\"\\n}","errorExample":""},{"type":"xml","example":"<GetOpSensitiveDataResponse>\\n <OpSensitiveData>\\"opSensDatas\\": [ { \\"sensLevel\\": \\"L4\\", \\"opTime\\": \\"2021-02-07 00:14:51\\", \\"opAccount\\": \\"ALIYUN$dsg_test\\", \\"sensType\\": \\"手机号\\", \\"sql\\": \\"select * from dsg_demo.tbl_phonebook where phone_no = &amp;#39;1331111****&amp;#39;;\\" } ], \\"totalCount\\": 6</OpSensitiveData>\\n <RequestId>0000-ABCD-EFG****</RequestId>\\n</GetOpSensitiveDataResponse>","errorExample":""}]',
+ 'title' => 'GetOpSensitiveData',
+ 'summary' => 'Queries the records that are generated on a specified date for access to sensitive data in all the DataWorks workspaces of a tenant.',
+ 'requestParamsDescription' => ' ',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ ],
+ 'DesensitizeData' => [
+ 'methods' => [
+ 'get',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'get',
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'Data',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The data that you want to mask.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => '15365291784',
+ ],
+ ],
+ [
+ 'name' => 'SceneCode',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The code of the data masking scenario. You can view the code on the Data Masking Management page in Data Security Guard of the DataWorks console.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => '_default_scene_code',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'DesensitizeData' => [
+ 'description' => 'The data returned after masking.'."\n",
+ 'type' => 'string',
+ 'example' => '{ "desensData": "**198807120510**" }',
+ ],
+ 'RequestId' => [
+ 'description' => 'The request ID.'."\n",
+ 'type' => 'string',
+ 'example' => 'BCA321BA-46C5-40E9-8A08-6******',
+ ],
+ ],
+ 'description' => '',
+ ],
+ ],
+ ],
+ 'errorCodes' => [
+ 403 => [
+ [
+ 'errorCode' => 'Forbidden.NoTenant',
+ 'errorMessage' => 'The tenant information cannot be obtained using user ID.',
+ ],
+ ],
+ 500 => [
+ [
+ 'errorCode' => 'InternalError.DQC.BizError',
+ 'errorMessage' => 'An internal error occurred.',
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"DesensitizeData\\": \\"{ \\\\\\"desensData\\\\\\": \\\\\\"**198807120510**\\\\\\" }\\",\\n \\"RequestId\\": \\"BCA321BA-46C5-40E9-8A08-6******\\"\\n}","errorExample":""},{"type":"xml","example":"<RequestId>BCA321BA-46C5-40E9-8A08-6******</RequestId>\\n<DesensitizeData>{ \\"desensData\\": \\"**198807120510**\\" }</DesensitizeData>","errorExample":""}]',
+ 'title' => 'DesensitizeData',
+ 'summary' => 'Masks data.',
+ 'requestParamsDescription' => ' ',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ ],
+ 'GetOpRiskData' => [
+ 'methods' => [
+ 'get',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'get',
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'PageSize',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The number of entries per page. Maximum value: 1000.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => true,
+ 'docRequired' => true,
+ 'maximum' => '1000',
+ 'minimum' => '1',
+ 'example' => '100',
+ ],
+ ],
+ [
+ 'name' => 'PageNo',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The page number. Pages start from 1.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => true,
+ 'docRequired' => true,
+ 'maximum' => '1000',
+ 'minimum' => '1',
+ 'example' => '1',
+ ],
+ ],
+ [
+ 'name' => 'Name',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The parameters that you can configure to query the access records. Valid values:'."\n"
+ ."\n"
+ .'* dbType'."\n"
+ .'* instanceName'."\n"
+ .'* databaseName'."\n"
+ .'* projectName'."\n"
+ .'* clusterName'."\n"
+ ."\n"
+ .'The following example shows the parameters configured to query the access records of the sensitive data in the abc database of the Hologres instance ABC: \\[ {"dbType":"hologres","instanceName":"ABC","databaseName":"abc"} ]'."\n"
+ ."\n"
+ .'You must configure the parameters based on the compute engine that you use in your business.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => '[ {"dbType":"hologres","instanceName":"ABC","databaseName":"abc"}, {"dbType":"ODPS.ODPS","projectName":"adbc"} ]',
+ ],
+ ],
+ [
+ 'name' => 'Date',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The date on which access records were generated. Specify the value in the yyyyMMdd format.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => '20210221',
+ ],
+ ],
+ [
+ 'name' => 'RiskType',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The method that you use to identify risks.'."\n"
+ ."\n"
+ .'* You can manually identify risks.'."\n"
+ .'* You can also use a sensitive data identification rule to identify risks. You can log on to the DataWorks console and go to the Risk Identification Rules page in Data Security Guard to obtain the name of the rule.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'Manual identification',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'description' => 'The returned results.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'RiskData' => [
+ 'description' => 'The information about the high-risk sensitive data. The information includes totalCount and opRiskDatas. opRiskDatas includes the following parameters:'."\n"
+ ."\n"
+ .'* sensType: the type of the sensitive data'."\n"
+ .'* sensLevel: the sensitivity level of the sensitive data'."\n"
+ .'* opType: the type of the operation'."\n"
+ .'* sql: the SQL statement that is executed'."\n"
+ .'* opAccount: the account that is used to perform the operation'."\n"
+ .'* opTime: the time when the operation was performed'."\n",
+ 'type' => 'string',
+ 'example' => '{'."\n"
+ .' "opRiskDatas": ['."\n"
+ .' {'."\n"
+ .' "riskType": "Hierarchical dimension, EMR engine dimension and project dimension, EMR engine project dimension operation data, export method dimension, EMR engine",'."\n"
+ .' "opTime": "2021-01-04 23:39:13",'."\n"
+ .' "opType": "SQL_SELECT",'."\n"
+ .' "opAccount": "user",'."\n"
+ .' "sensType": "Email/name/mobile phone number",'."\n"
+ .' "sql": "SELECT * FROM default.jiade_1219_test_create LIMIT 20"'."\n"
+ .' }'."\n"
+ .' ],'."\n"
+ .' "totalCount": 499'."\n"
+ .'}',
+ ],
+ 'RequestId' => [
+ 'description' => 'The request ID.'."\n",
+ 'type' => 'string',
+ 'example' => '0000-ABCD-EFG****',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'errorCodes' => [
+ 400 => [
+ [
+ 'errorCode' => 'Invalid.Param',
+ 'errorMessage' => 'The request parameter is invalid.',
+ ],
+ ],
+ 403 => [
+ [
+ 'errorCode' => 'Forbidden.NoTenant',
+ 'errorMessage' => 'The tenant information cannot be obtained using user ID.',
+ ],
+ ],
+ 500 => [
+ [
+ 'errorCode' => 'InternalError.DQC.BizError',
+ 'errorMessage' => 'An internal error occurred.',
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"RiskData\\": \\"{ \\\\\\"opRiskDatas\\\\\\": [ { \\\\\\"riskType\\\\\\": \\\\\\"Hierarchical dimension, EMR engine dimension and project dimension, EMR engine project dimension operation data, export method dimension, EMR engine\\\\\\", \\\\\\"opTime\\\\\\": \\\\\\"2021-01-04 23:39:13\\\\\\", \\\\\\"opType\\\\\\": \\\\\\"SQL_SELECT\\\\\\", \\\\\\"opAccount\\\\\\": \\\\\\"user\\\\\\", \\\\\\"sensType\\\\\\": \\\\\\"Email/name/mobile phone number\\\\\\", \\\\\\"sql\\\\\\": \\\\\\"SELECT * FROM default.jiade_1219_test_create LIMIT 20\\\\\\" } ], \\\\\\"totalCount\\\\\\": 499 }\\",\\n \\"RequestId\\": \\"0000-ABCD-EFG****\\"\\n}","errorExample":""},{"type":"xml","example":"<GetOpRiskDataResponse>\\n <RequestId>0000-ABCD-EFG****</RequestId>\\n <RiskData>{ \\"opRiskDatas\\": [ { \\"riskType\\": \\"分级维度,EMR引擎维度and项目维度,EMR引擎项目维度的操作数据,导出方式维度,EMR引擎\\", \\"opTime\\": \\"2021-01-04 23:39:13\\", \\"opType\\": \\"SQL_SELECT\\", \\"opAccount\\": \\"user\\", \\"sensType\\": \\"邮箱/姓名/手机号\\", \\"sql\\": \\"SELECT * FROM default.jiade_1219_test_create LIMIT 20\\" } ], \\"totalCount\\": 499 }</RiskData>\\n</GetOpRiskDataResponse>","errorExample":""}]',
+ 'title' => 'GetOpRiskData',
+ 'summary' => 'Queries the records that are generated on a specified date for access to the high-risk sensitive data in all the DataWorks workspaces of a tenant.',
+ 'requestParamsDescription' => ' ',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ ],
+ 'GetSensitiveData' => [
+ 'methods' => [
+ 'get',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'get',
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'PageSize',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The number of entries per page. Maximum value: 1000.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => true,
+ 'docRequired' => true,
+ 'maximum' => '1000',
+ 'minimum' => '1',
+ 'example' => '1000',
+ ],
+ ],
+ [
+ 'name' => 'PageNo',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The page number. Pages start from page 1.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => true,
+ 'docRequired' => true,
+ 'maximum' => '1000',
+ 'minimum' => '1',
+ 'example' => '1',
+ ],
+ ],
+ [
+ 'name' => 'Name',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The parameters that you can configure to query the access records. Valid values:'."\n"
+ ."\n"
+ .'* dbType'."\n"
+ .'* instanceName'."\n"
+ .'* databaseName'."\n"
+ .'* projectName'."\n"
+ .'* clusterName'."\n"
+ ."\n"
+ .'The sample value shows the parameters configured to query the access records of the sensitive data in the abc database of the Hologres instance ABC. You must configure the parameters based on the compute engine that you use in your business.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => '[ {"dbType":"hologres","instanceName":"ABC","databaseName":"abc"}, {"dbType":"ODPS.ODPS","projectName":"adbc"} ]',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'description' => 'Response parameters'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'SensitiveData' => [
+ 'description' => 'The information about the sensitive data returned. The information includes totalCount and sensDatas. sensDatas includes the following parameters:'."\n"
+ ."\n"
+ .'* guid: the ID of the metadata of the tenant. For example, the ID of the metadata in the MaxCompute compute engine is in the Project name.Table name.Column name format.'."\n"
+ .'* sensType: the type of the sensitive data.'."\n"
+ .'* sensLevel: the sensitivity level of the sensitive data'."\n",
+ 'type' => 'object',
+ 'example' => '',
+ ],
+ 'RequestId' => [
+ 'description' => 'The request ID.'."\n",
+ 'type' => 'string',
+ 'example' => '0000-ABCD-EFG****',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'errorCodes' => [
+ 400 => [
+ [
+ 'errorCode' => 'Invalid.Param',
+ 'errorMessage' => 'The request parameter is invalid.',
+ ],
+ ],
+ 403 => [
+ [
+ 'errorCode' => 'Forbidden.NoTenant',
+ 'errorMessage' => 'The tenant information cannot be obtained using user ID.',
+ ],
+ ],
+ 500 => [
+ [
+ 'errorCode' => 'InternalError.DQC.BizError',
+ 'errorMessage' => 'An internal error occurred.',
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"SensitiveData\\": {\\n \\"sensDatas\\": [\\n {\\n \\"sensLevel\\": \\"L1\\",\\n \\"guid\\": \\"dsg_demo.animal.dog\\",\\n \\"sensType\\": \\"姓名\\"\\n }\\n ],\\n \\"totalCount\\": 2171\\n },\\n \\"RequestId\\": \\"0000-ABCD-EFG****\\"\\n}","errorExample":""},{"type":"xml","example":"<GetSensitiveDataResponse>\\n <RequestId>0000-ABCD-EFG****</RequestId>\\n</GetSensitiveDataResponse>","errorExample":""}]',
+ 'title' => 'GetSensitiveData',
+ 'summary' => 'Queries the latest sensitive data in all the DataWorks workspaces of a tenant.',
+ 'requestParamsDescription' => ' ',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ ],
+ 'ScanSensitiveData' => [
+ 'methods' => [
+ 'get',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'get',
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'Data',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The data that you want to check.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => '13900001234',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'description' => 'The data returned.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'Sensitives' => [
+ 'description' => 'The check result. sensDatas indicates the rules that are used to check the sensitive data. sensDatas includes the following parameters:'."\n"
+ ."\n"
+ .'* hitCount: the number of times that the sensitive data hits the rule.'."\n"
+ .'* ruleName: the name of the rule.'."\n",
+ 'type' => 'object',
+ 'example' => '',
+ ],
+ 'RequestId' => [
+ 'description' => 'The request ID.'."\n",
+ 'type' => 'string',
+ 'example' => '0000-ABCD-EFG****',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'errorCodes' => [
+ 403 => [
+ [
+ 'errorCode' => 'Forbidden.Meta.NoTenant',
+ 'errorMessage' => 'The user is not the owner of any tenants.',
+ ],
+ ],
+ 500 => [
+ [
+ 'errorCode' => 'InternalError.DQC.BizError',
+ 'errorMessage' => 'An internal error occurred.',
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"Sensitives\\": {\\n \\"sensDatas\\": [\\n {\\n \\"hitCount\\": 1,\\n \\"ruleName\\": \\"手机号\\"\\n }\\n ]\\n },\\n \\"RequestId\\": \\"0000-ABCD-EFG****\\"\\n}","errorExample":""},{"type":"xml","example":"<ScanSensitiveDataResponse>\\n <RequestId>0000-ABCD-EFG****</RequestId>\\n</ScanSensitiveDataResponse>","errorExample":""}]',
+ 'title' => 'ScanSensitiveData',
+ 'summary' => 'Checks whether input data contains sensitive data.',
+ 'requestParamsDescription' => ' ',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ ],
+ 'DsgQuerySensResult' => [
+ 'summary' => 'Queries the identification results of sensitive data.',
+ 'methods' => [
+ 'post',
+ ],
+ 'schemes' => [
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'list',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeCode' => '215091',
+ 'abilityTreeNodes' => [
+ 'FEATUREdide64ITEV',
+ ],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'TenantId',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The tenant ID. To obtain the tenant ID, perform the following steps: Log on to the [DataWorks console](https://workbench.data.aliyun.com/console). Find your workspace and go to the DataStudio page. On the DataStudio page, click the logon username in the upper-right corner and click User Info in the Menu section.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => '10241024',
+ ],
+ ],
+ [
+ 'name' => 'DbType',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The type of the database. Valid values:'."\n"
+ ."\n"
+ .'* **ODPS.ODPS**'."\n"
+ .'* **HOLO.POSTGRES**'."\n"
+ .'* **EMR**'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'enumValueTitles' => [],
+ 'example' => 'ODPS.ODPS',
+ ],
+ ],
+ [
+ 'name' => 'ProjectName',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The name of the DataWorks workspace. You can log on to the [DataWorks console](https://workbench.data.aliyun.com/console) and go to the Workspace page to obtain the workspace name.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'project',
+ ],
+ ],
+ [
+ 'name' => 'SchemaName',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The name of the schema.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'schema',
+ ],
+ ],
+ [
+ 'name' => 'Table',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The name of the table.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'table',
+ ],
+ ],
+ [
+ 'name' => 'Col',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The name of the field.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'col',
+ ],
+ ],
+ [
+ 'name' => 'NodeName',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The name of a data category.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'Personal information',
+ ],
+ ],
+ [
+ 'name' => 'Level',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The sensitivity level of the field.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => '3',
+ ],
+ ],
+ [
+ 'name' => 'SensStatus',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The sensitivity status of the field.'."\n"
+ ."\n"
+ .'* 1: indicates sensitive.'."\n"
+ .'* \\-1: indicates non-sensitive.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'enumValueTitles' => [],
+ 'example' => '1',
+ ],
+ ],
+ [
+ 'name' => 'SensitiveId',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The sensitive field ID.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => '10241024',
+ ],
+ ],
+ [
+ 'name' => 'SensitiveName',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The name of the sensitive field.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'name',
+ ],
+ ],
+ [
+ 'name' => 'Order',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The sorting method. Valid values:'."\n"
+ ."\n"
+ .'* DESC'."\n"
+ .'* ASC'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'enumValueTitles' => [],
+ 'example' => 'DESC',
+ ],
+ ],
+ [
+ 'name' => 'OrderField',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The field used for sorting.'."\n"
+ ."\n"
+ .'* gmt_create'."\n"
+ .'* gmt_modified'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'gmt_create',
+ ],
+ ],
+ [
+ 'name' => 'PageNo',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The page number. Pages start from page 1.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => false,
+ 'example' => '1',
+ ],
+ ],
+ [
+ 'name' => 'PageSize',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The number of entries per page. Default value: 10. Maximum value: 20.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => false,
+ 'example' => '10',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => 'OpenApiResultModel',
+ 'description' => 'The returned data.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'Success' => [
+ 'description' => 'Indicates whether the request was successful.'."\n"
+ ."\n"
+ .'* true'."\n"
+ .'* false'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code.'."\n",
+ 'type' => 'string',
+ 'example' => '400',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message.'."\n",
+ 'type' => 'string',
+ 'example' => 'Missing parameter',
+ ],
+ 'HttpStatusCode' => [
+ 'description' => 'The HTTP status code.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '400',
+ ],
+ 'Data' => [
+ 'description' => 'The data returned.'."\n",
+ 'type' => 'any',
+ 'example' => '1234',
+ ],
+ 'RequestId' => [
+ 'description' => 'The request ID.'."\n",
+ 'type' => 'string',
+ 'example' => '900000001',
+ ],
+ 'DynamicErrorCode' => [
+ 'description' => 'The error code. The value is the same as that of ErrorCode.'."\n",
+ 'type' => 'string',
+ 'example' => '400',
+ ],
+ 'DynamicErrorMessage' => [
+ 'description' => 'The error message. The value is the same as that of ErrorMessage.'."\n",
+ 'type' => 'string',
+ 'example' => 'Missing parameter',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'errorCodes' => [
+ 400 => [
+ [
+ 'errorCode' => 'BADPARAMETERS',
+ 'errorMessage' => 'Parameters are missing or in the wrong format.',
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"400\\",\\n \\"ErrorMessage\\": \\"Missing parameter\\",\\n \\"HttpStatusCode\\": 400,\\n \\"Data\\": \\"1234\\",\\n \\"RequestId\\": \\"900000001\\",\\n \\"DynamicErrorCode\\": \\"400\\",\\n \\"DynamicErrorMessage\\": \\"Missing parameter\\"\\n}","errorExample":""},{"type":"xml","example":"<DsgQuerySensResultResponse>\\n <Success>true</Success>\\n <ErrorCode>400</ErrorCode>\\n <ErrorMessage>缺少参数</ErrorMessage>\\n <HttpStatusCode>400</HttpStatusCode>\\n <Data>1234</Data>\\n <RequestId>900000001</RequestId>\\n <DynamicErrorCode>400</DynamicErrorCode>\\n <DynamicErrorMessage>缺少参数</DynamicErrorMessage>\\n</DsgQuerySensResultResponse>","errorExample":""}]',
+ 'title' => 'DsgQuerySensResult',
+ 'description' => 'The query capability of the API operation is similar to the query feature in Data Security Guard in the DataWorks console. The API operation can be used to query the identification results of sensitive data of a tenant based on the association with the tenant ID.'."\n"
+ ."\n"
+ .'* You can search for a specific identification result based on filter conditions such as data source type and workspace.'."\n"
+ .'* You can sort the identification results of sensitive data of a tenant based on the values of a field in ascending or descending order.'."\n"
+ .'* This operation supports paged query.'."\n",
+ ],
+ 'QueryDefaultTemplate' => [
+ 'summary' => 'Queries the default data category and data sensitivity level template defined by Data Security Guard.',
+ 'methods' => [
+ 'post',
+ ],
+ 'schemes' => [
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'get',
+ 'abilityTreeCode' => '212265',
+ 'abilityTreeNodes' => [
+ 'FEATUREdideBVSRMP',
+ ],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'TenantId',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The tenant ID. To obtain the tenant ID, perform the following steps: Log on to the [DataWorks console](https://workbench.data.aliyun.com/console). Find your workspace and go to the DataStudio page. On the DataStudio page, click the logon username in the upper-right corner and click User Info in the Menu section.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => '10241024',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => 'OpenApiResultModel',
+ 'description' => 'The returned data.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'Success' => [
+ 'description' => 'Indicates whether the request was successful. Valid values:'."\n"
+ ."\n"
+ .'* true'."\n"
+ .'* false'."\n",
+ 'type' => 'boolean',
+ 'required' => true,
+ 'example' => 'true',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => '9990030003',
+ 'default' => 'null',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => 'Parameter error',
+ 'default' => 'null',
+ ],
+ 'HttpStatusCode' => [
+ 'description' => 'The HTTP status code.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => true,
+ 'example' => '400',
+ ],
+ 'Data' => [
+ 'description' => 'The returned data about the default data category and data sensitivity level template. The data is in the JSON array format.'."\n",
+ 'type' => 'any',
+ 'required' => true,
+ 'example' => '[{"gmtModified":1709022365000,"fileName":"default file","isDelete":false,"isDefaultTemplate":true}]',
+ ],
+ 'RequestId' => [
+ 'description' => 'The request ID. You can locate logs and troubleshoot issues based on the ID.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => '102400001',
+ 'default' => 'null',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'errorCodes' => [
+ 400 => [
+ [
+ 'errorCode' => 'BADPARAMETERS',
+ 'errorMessage' => 'Parameters are missing or in the wrong format.',
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"9990030003\\",\\n \\"ErrorMessage\\": \\"Parameter error\\",\\n \\"HttpStatusCode\\": 400,\\n \\"Data\\": \\"[{\\\\\\"gmtModified\\\\\\":1709022365000,\\\\\\"fileName\\\\\\":\\\\\\"default file\\\\\\",\\\\\\"isDelete\\\\\\":false,\\\\\\"isDefaultTemplate\\\\\\":true}]\\",\\n \\"RequestId\\": \\"102400001\\"\\n}","errorExample":""},{"type":"xml","example":"<QueryDefaultTemplateResponse>\\n <Success>true</Success>\\n <ErrorCode>9990030003</ErrorCode>\\n <ErrorMessage>参数错误</ErrorMessage>\\n <HttpStatusCode>400</HttpStatusCode>\\n <Data>[{\\"gmtModified\\":1709022365000,\\"fileName\\":\\"默认文件\\",\\"isDelete\\":false,\\"isDefaultTemplate\\":true}]</Data>\\n <RequestId>102400001</RequestId>\\n</QueryDefaultTemplateResponse>","errorExample":""}]',
+ 'title' => 'QueryDefaultTemplate',
+ ],
+ 'DsgStopSensIdentify' => [
+ 'summary' => 'Stops a sensitive data identification task.',
+ 'methods' => [
+ 'post',
+ ],
+ 'schemes' => [
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'none',
+ 'abilityTreeCode' => '213660',
+ 'abilityTreeNodes' => [
+ 'FEATUREdide1B7LSC',
+ ],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'TenantId',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The tenant ID. To obtain the tenant ID, perform the following steps: Log on to the [DataWorks console](https://workbench.data.aliyun.com/console). Find your workspace and go to the DataStudio page. On the DataStudio page, click the logon username in the upper-right corner and click User Info in the Menu section.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => '10241024',
+ ],
+ ],
+ [
+ 'name' => 'JobId',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The ID of the sensitive data identification task. You can call the [DsgRunSensIdentify](~~2744039~~) operation to obtain the task ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => true,
+ 'example' => '1000001',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => 'OpenApiResultModel',
+ 'description' => 'The returned data.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'Success' => [
+ 'description' => 'Indicates whether the request was successful. Valid values:'."\n"
+ ."\n"
+ .'* true'."\n"
+ .'* false'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code.'."\n",
+ 'type' => 'string',
+ 'example' => '9990030003',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message.'."\n",
+ 'type' => 'string',
+ 'example' => 'Missing parameter',
+ ],
+ 'HttpStatusCode' => [
+ 'description' => 'The HTTP status code.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '200',
+ ],
+ 'Data' => [
+ 'description' => 'The returned data, which is of the Boolean type.'."\n",
+ 'type' => 'any',
+ 'example' => 'true',
+ ],
+ 'RequestId' => [
+ 'description' => 'The request ID.'."\n",
+ 'type' => 'string',
+ 'example' => '10000001',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'errorCodes' => [
+ 400 => [
+ [
+ 'errorCode' => 'BADPARAMETERS',
+ 'errorMessage' => 'Parameters are missing or in the wrong format.',
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"9990030003\\",\\n \\"ErrorMessage\\": \\"Missing parameter\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Data\\": \\"true\\",\\n \\"RequestId\\": \\"10000111\\"\\n}","errorExample":""},{"type":"xml","example":"<DsgStopSensIdentifyResponse>\\n <Success>true</Success>\\n <ErrorCode>9990030003</ErrorCode>\\n <ErrorMessage>缺少参数</ErrorMessage>\\n <HttpStatusCode>200</HttpStatusCode>\\n <Data>true</Data>\\n <RequestId>10000001</RequestId>\\n</DsgStopSensIdentifyResponse>","errorExample":""}]',
+ 'title' => 'DsgStopSensIdentify',
+ ],
+ 'QuerySensClassification' => [
+ 'summary' => 'Queries data categories.',
+ 'methods' => [
+ 'post',
+ ],
+ 'schemes' => [
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'get',
+ 'abilityTreeCode' => '212270',
+ 'abilityTreeNodes' => [
+ 'FEATUREdideBVSRMP',
+ ],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'TemplateId',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The ID of the template defined by Data Security Guard. You can call the [QueryDefaultTemplate](~~2743948~~) operation to query the ID.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => 'e1970541-6cf5-4d23-b101-d5b66f6e1024',
+ ],
+ ],
+ [
+ 'name' => 'TenantId',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The tenant ID. To obtain the tenant ID, perform the following steps: Log on to the [DataWorks console](https://workbench.data.aliyun.com/console). Find your workspace and go to the DataStudio page. On the DataStudio page, click the logon username in the upper-right corner and click User Info in the Menu section.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => '10241024',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => 'OpenApiResultModel',
+ 'description' => 'The response parameters.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'Success' => [
+ 'description' => 'Indicates whether the request was successful. Valid values:'."\n"
+ ."\n"
+ .'* true'."\n"
+ .'* false'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code.'."\n",
+ 'type' => 'string',
+ 'example' => '9990030003',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message.'."\n",
+ 'type' => 'string',
+ 'example' => 'Missing parameter',
+ ],
+ 'HttpStatusCode' => [
+ 'description' => 'The HTTP status code.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '400',
+ ],
+ 'Data' => [
+ 'description' => 'The returned data about data categories. The data is in the JSON format.'."\n",
+ 'type' => 'any',
+ 'example' => '[{ "nodeName": "teset1", "sensitiveNotNull": true, "nodeId": "1aac2e35-b437-486b-95c7-a5ae48371024", "nodeOldId": "1aac2e35-b437-486b-95c7-a5ae48371024", "parentId": "0" }]',
+ ],
+ 'RequestId' => [
+ 'description' => 'The request ID.'."\n",
+ 'type' => 'string',
+ 'example' => '10000001',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'errorCodes' => [
+ 400 => [
+ [
+ 'errorCode' => 'BADPARAMETERS',
+ 'errorMessage' => 'Parameters are missing or in the wrong format.',
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"9990030003\\",\\n \\"ErrorMessage\\": \\"Missing parameter\\",\\n \\"HttpStatusCode\\": 400,\\n \\"Data\\": \\"[{ \\\\\\"nodeName\\\\\\": \\\\\\"teset1\\\\\\", \\\\\\"sensitiveNotNull\\\\\\": true, \\\\\\"nodeId\\\\\\": \\\\\\"1aac2e35-b437-486b-95c7-a5ae48371024\\\\\\", \\\\\\"nodeOldId\\\\\\": \\\\\\"1aac2e35-b437-486b-95c7-a5ae48371024\\\\\\", \\\\\\"parentId\\\\\\": \\\\\\"0\\\\\\" }]\\",\\n \\"RequestId\\": \\"10000001\\"\\n}","errorExample":""},{"type":"xml","example":"<QuerySensClassificationResponse>\\n <Success>true</Success>\\n <ErrorCode>9990030003</ErrorCode>\\n <ErrorMessage>缺少参数</ErrorMessage>\\n <HttpStatusCode>400</HttpStatusCode>\\n <Data>[{ \\"nodeName\\": \\"teset1\\", \\"sensitiveNotNull\\": true, \\"nodeId\\": \\"1aac2e35-b437-486b-95c7-a5ae48371024\\", \\"nodeOldId\\": \\"1aac2e35-b437-486b-95c7-a5ae48371024\\", \\"parentId\\": \\"0\\" }]</Data>\\n <RequestId>10000001</RequestId>\\n</QuerySensClassificationResponse>","errorExample":""}]',
+ 'title' => 'QuerySensClassification',
+ ],
+ 'QuerySensLevel' => [
+ 'summary' => 'Queries data sensitivity levels in Data Security Guard.',
+ 'methods' => [
+ 'post',
+ ],
+ 'schemes' => [
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'get',
+ 'abilityTreeCode' => '212269',
+ 'abilityTreeNodes' => [
+ 'FEATUREdidePQ4SAC',
+ ],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'TemplateId',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The ID of the template defined by Data Security Guard. You can call the [QueryDefaultTemplate](~~2743948~~) operation to query the ID.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => 'e1970541-6cf5-4d23-b101-d5b66f6e10af',
+ ],
+ ],
+ [
+ 'name' => 'tenantId',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The tenant ID. To obtain the tenant ID, perform the following steps: Log on to the [DataWorks console](https://workbench.data.aliyun.com/console). Find your workspace and go to the DataStudio page. On the DataStudio page, click the logon username in the upper-right corner and click User Info in the Menu section.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => '10241024',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => 'OpenApiResultModel',
+ 'description' => 'The response parameters.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'Success' => [
+ 'description' => 'Indicates whether the request was successful. Valid values:'."\n"
+ ."\n"
+ .'* true'."\n"
+ .'* false'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code.'."\n",
+ 'type' => 'string',
+ 'example' => '9990030003',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message.'."\n",
+ 'type' => 'string',
+ 'example' => 'Missing parameter',
+ ],
+ 'HttpStatusCode' => [
+ 'description' => 'The HTTP status code.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '200',
+ ],
+ 'Data' => [
+ 'description' => 'The returned data about data sensitivity levels. The data is in the JSON array format.'."\n",
+ 'type' => 'any',
+ 'example' => '[{"level":1,"isSensitive":false,"levelName":"1level"},{"level":2,"isSensitive":false,"levelName":"2level"}]',
+ ],
+ 'RequestId' => [
+ 'description' => 'The request ID.'."\n",
+ 'type' => 'string',
+ 'example' => '10000001',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'errorCodes' => [
+ 400 => [
+ [
+ 'errorCode' => 'BADPARAMETERS',
+ 'errorMessage' => 'Parameters are missing or in the wrong format.',
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"9990030003\\",\\n \\"ErrorMessage\\": \\"Missing parameter\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Data\\": \\"[{\\\\\\"level\\\\\\":1,\\\\\\"isSensitive\\\\\\":false,\\\\\\"levelName\\\\\\":\\\\\\"1level\\\\\\"},{\\\\\\"level\\\\\\":2,\\\\\\"isSensitive\\\\\\":false,\\\\\\"levelName\\\\\\":\\\\\\"2level\\\\\\"}]\\",\\n \\"RequestId\\": \\"10000001\\"\\n}","errorExample":""},{"type":"xml","example":"<QuerySensLevelResponse>\\n <Success>true</Success>\\n <ErrorCode>9990030003</ErrorCode>\\n <ErrorMessage>缺少参数</ErrorMessage>\\n <HttpStatusCode>200</HttpStatusCode>\\n <Data>[{\\"level\\":1,\\"isSensitive\\":false,\\"levelName\\":\\"1level\\"},{\\"level\\":2,\\"isSensitive\\":false,\\"levelName\\":\\"2level\\"}]</Data>\\n <RequestId>10000001</RequestId>\\n</QuerySensLevelResponse>","errorExample":""}]',
+ 'title' => 'QuerySensLevel',
+ ],
+ 'QueryRecognizeRulesType' => [
+ 'summary' => 'Queries the built-in sensitive data identification rule that is used to configure a sensitive field.',
+ 'methods' => [
+ 'post',
+ ],
+ 'schemes' => [
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'get',
+ 'abilityTreeCode' => '212274',
+ 'abilityTreeNodes' => [
+ 'FEATUREdideDCM5VK',
+ ],
+ ],
+ 'parameters' => [],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => 'OpenApiResultModel',
+ 'description' => 'The response parameters.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'Success' => [
+ 'description' => 'Indicates whether the request was successful. Valid values:'."\n"
+ ."\n"
+ .'* true'."\n"
+ .'* false'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code.'."\n",
+ 'type' => 'string',
+ 'example' => '9990030003',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message.'."\n",
+ 'type' => 'string',
+ 'example' => 'Missing parameter',
+ ],
+ 'HttpStatusCode' => [
+ 'description' => 'The HTTP status code.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '200',
+ ],
+ 'Data' => [
+ 'description' => 'The returned data about the built-in sensitive data identification rule that is used to configure a sensitive field. The data is in the JSON format.'."\n",
+ 'type' => 'any',
+ 'example' => '{ "HttpStatusCode": 200, "Data": [ { "Regular Expression": "1" }, { "Recognize Rule": "2" }, { "Sample Library": "3" }, { "Model": "4" } ], "Success": true }',
+ ],
+ 'RequestId' => [
+ 'description' => 'The request ID.'."\n",
+ 'type' => 'string',
+ 'example' => '10000001',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'errorCodes' => [
+ 400 => [
+ [
+ 'errorCode' => 'BADPARAMETERS',
+ 'errorMessage' => 'Parameters are missing or in the wrong format.',
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"9990030002\\",\\n \\"ErrorMessage\\": \\"Missing parameter\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Data\\": \\"{ \\\\\\"HttpStatusCode\\\\\\": 200, \\\\\\"Data\\\\\\": [ { \\\\\\"Regular Expression\\\\\\": \\\\\\"1\\\\\\" }, { \\\\\\"Recognize Rule\\\\\\": \\\\\\"2\\\\\\" }, { \\\\\\"Sample Library\\\\\\": \\\\\\"3\\\\\\" }, { \\\\\\"Model\\\\\\": \\\\\\"4\\\\\\" } ], \\\\\\"Success\\\\\\": true }\\",\\n \\"RequestId\\": \\"10000001\\"\\n}","errorExample":""},{"type":"xml","example":"<QueryRecognizeRulesTypeResponse>\\n <Success>true</Success>\\n <ErrorCode>9990030003</ErrorCode>\\n <ErrorMessage>缺少参数</ErrorMessage>\\n <HttpStatusCode>200</HttpStatusCode>\\n <Data>{ \\"HttpStatusCode\\": 200, \\"Data\\": [ { \\"Regular Expression\\": \\"1\\" }, { \\"Recognize Rule\\": \\"2\\" }, { \\"Sample Library\\": \\"3\\" }, { \\"Model\\": \\"4\\" } ], \\"Success\\": true }</Data>\\n <RequestId>10000001</RequestId>\\n</QueryRecognizeRulesTypeResponse>","errorExample":""}]',
+ 'title' => 'QueryRecognizeRulesType',
+ ],
+ 'DsgRunSensIdentify' => [
+ 'methods' => [
+ 'post',
+ ],
+ 'schemes' => [
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'none',
+ 'abilityTreeCode' => '212734',
+ 'abilityTreeNodes' => [
+ 'FEATUREdide1B7LSC',
+ ],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'TenantId',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The tenant ID. To obtain the tenant ID, perform the following steps: Log on to the [DataWorks console](https://workbench.data.aliyun.com/console). Find your workspace and go to the DataStudio page. On the DataStudio page, click the logon username in the upper-right corner and click User Info in the Menu section.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => '10241024',
+ ],
+ ],
+ [
+ 'name' => 'EsMetaParams',
+ 'in' => 'formData',
+ 'style' => 'json',
+ 'schema' => [
+ 'description' => 'The parameters that you need to configure to scan specified metadata.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The parameter that you need to configure to scan specified metadata.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'DbType' => [
+ 'description' => 'The type of the data source. Valid values:'."\n"
+ ."\n"
+ .'* ODPS.ODPS'."\n"
+ .'* EMR'."\n"
+ .'* HOLO.POSTGRES'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'ODPS.ODPS',
+ ],
+ 'ClusterId' => [
+ 'description' => 'The cluster ID. You can obtain the ID based on the data source you use.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => '101010',
+ ],
+ 'ProjectName' => [
+ 'description' => 'The name of the DataWorks workspace. You can log on to the [DataWorks console](https://workbench.data.aliyun.com/console) and go to the Workspace page to query the name.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => '1666676756691024',
+ ],
+ 'SchemaName' => [
+ 'description' => 'The name of the schema.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'default',
+ ],
+ 'TableName' => [
+ 'description' => 'The name of the table.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'table1',
+ ],
+ 'TableNameList' => [
+ 'description' => 'The names of the tables.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The name of the table.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'table1,table2',
+ ],
+ 'required' => false,
+ ],
+ 'User' => [
+ 'description' => 'The username of the operator. We recommend that you enter the username of your Alibaba Cloud account.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'xxx-uat',
+ ],
+ 'InstanceId' => [
+ 'description' => 'The instance ID. You can obtain the ID based on the data source you use.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'example' => 'hgprecn-cn-9lb37k181024',
+ ],
+ ],
+ 'required' => false,
+ ],
+ 'required' => false,
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => 'DataWorksResult',
+ 'description' => 'The returned data.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'ErrorCode' => [
+ 'description' => 'The error code.'."\n",
+ 'type' => 'string',
+ 'example' => '9990030003',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message.'."\n",
+ 'type' => 'string',
+ 'example' => 'Missing parameter',
+ ],
+ 'Success' => [
+ 'description' => 'Indicates whether the request was successful. Valid values:'."\n"
+ ."\n"
+ .'* true'."\n"
+ .'* false'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'Data' => [
+ 'description' => 'The ID of the generated sensitive data identification task. The value is of the INT 64 type.'."\n",
+ 'type' => 'any',
+ 'example' => '1000001',
+ ],
+ 'HttpStatusCode' => [
+ 'description' => 'The HTTP status code.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '400',
+ ],
+ 'RequestId' => [
+ 'description' => 'The request ID.'."\n",
+ 'type' => 'string',
+ 'example' => '10000001',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'errorCodes' => [
+ 400 => [
+ [
+ 'errorCode' => 'BADPARAMETERS',
+ 'errorMessage' => 'Parameters are missing or in the wrong format.',
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"ErrorCode\\": \\"9990030003\\",\\n \\"ErrorMessage\\": \\"Missing parameter\\",\\n \\"Success\\": true,\\n \\"Data\\": \\"1000001\\",\\n \\"HttpStatusCode\\": 400,\\n \\"RequestId\\": \\"10000001\\"\\n}","errorExample":""},{"type":"xml","example":"<DsgRunSensIdentifyResponse>\\n <ErrorCode>9990030003</ErrorCode>\\n <ErrorMessage>缺少参数</ErrorMessage>\\n <Success>true</Success>\\n <Data>1000001</Data>\\n <HttpStatusCode>400</HttpStatusCode>\\n <RequestId>10000001</RequestId>\\n</DsgRunSensIdentifyResponse>","errorExample":""}]',
+ 'title' => 'DsgRunSensIdentify',
+ 'summary' => 'Starts a sensitive data identification task in Data Security Guard.',
+ ],
+ 'DeleteRecognizeRule' => [
+ 'summary' => 'Deletes sensitive field types.',
+ 'methods' => [
+ 'post',
+ ],
+ 'schemes' => [
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'delete',
+ 'abilityTreeCode' => '212271',
+ 'abilityTreeNodes' => [
+ 'FEATUREdideDCM5VK',
+ ],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'SensitiveId',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The ID of the sensitive field. You can call the [QuerySensNodeInfo](~~2747189~~) operation to query the ID.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => '27f5f5e2-ec60-4567-b1e4-779ac3681024',
+ ],
+ ],
+ [
+ 'name' => 'TenantId',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The tenant ID. To obtain the tenant ID, perform the following steps: Log on to the [DataWorks console](https://workbench.data.aliyun.com/console). Find your workspace and go to the DataStudio page. On the DataStudio page, click the logon username in the upper-right corner and click User Info in the Menu section.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => '10241024',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => 'OpenApiResultModel',
+ 'description' => 'The returned data.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'Success' => [
+ 'description' => 'Indicates whether the request was successful.'."\n"
+ ."\n"
+ .'* true'."\n"
+ .'* false'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code.'."\n",
+ 'type' => 'string',
+ 'example' => '9990030003',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message.'."\n",
+ 'type' => 'string',
+ 'example' => 'Missing parameter',
+ ],
+ 'HttpStatusCode' => [
+ 'description' => 'The HTTP status code.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '200',
+ ],
+ 'Data' => [
+ 'description' => 'The returned data about whether the deletion is successful.'."\n",
+ 'type' => 'any',
+ 'example' => '{ "HttpStatusCode": 200, "Success": true }',
+ ],
+ 'RequestId' => [
+ 'description' => 'The request ID.'."\n",
+ 'type' => 'string',
+ 'example' => '10000001',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'errorCodes' => [
+ 400 => [
+ [
+ 'errorCode' => 'BADPARAMETERS',
+ 'errorMessage' => 'Parameters are missing or in the wrong format.',
+ ],
+ [
+ 'errorCode' => 'SENSITIVEDELETEERROR',
+ 'errorMessage' => 'The sensitive field is not allowed to delete. Check sensitive field status and binding desensitization rule.',
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"9990030003\\",\\n \\"ErrorMessage\\": \\"Missing parameter\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Data\\": \\"{ \\\\\\"HttpStatusCode\\\\\\": 200, \\\\\\"Success\\\\\\": true }\\",\\n \\"RequestId\\": \\"10000001\\"\\n}","errorExample":""},{"type":"xml","example":"<DeleteRecognizeRuleResponse>\\n <Success>true</Success>\\n <ErrorCode>9990030003</ErrorCode>\\n <ErrorMessage>缺少参数</ErrorMessage>\\n <HttpStatusCode>200</HttpStatusCode>\\n <Data>{ \\"HttpStatusCode\\": 200, \\"Success\\": true }</Data>\\n <RequestId>10000001</RequestId>\\n</DeleteRecognizeRuleResponse>","errorExample":""}]',
+ 'title' => 'DeleteRecognizeRule',
+ ],
+ 'QuerySensNodeInfo' => [
+ 'summary' => 'Queries sensitive data identification rules.',
+ 'methods' => [
+ 'post',
+ ],
+ 'schemes' => [
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'list',
+ 'abilityTreeCode' => '217792',
+ 'abilityTreeNodes' => [
+ 'FEATUREdideDCM5VK',
+ ],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'TemplateId',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The ID of the data category and data sensitivity level template. You can call the [QueryDefaultTemplate](~~2743948~~) operation to query the ID.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => 'e1970541-6cf5-4d23-b101-d5b66f6e1024',
+ ],
+ ],
+ [
+ 'name' => 'TenantId',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The tenant ID. To obtain the tenant ID, perform the following steps: Log on to the [DataWorks console](https://workbench.data.aliyun.com/console). Find your workspace and go to the DataStudio page. On the DataStudio page, click the logon username in the upper-right corner and click User Info in the Menu section.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => '10241024',
+ ],
+ ],
+ [
+ 'name' => 'NodeId',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The ID of the data category. You can call the [QuerySensClassification](~~2746850~~) operation or log on to the [DataWorks console](https://workbench.data.aliyun.com/console) and go to the Data Security Guard page to obtain the ID.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => '0ce67949-0810-400f-a24a-cc5ffafe1024',
+ ],
+ ],
+ [
+ 'name' => 'SensitiveName',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The name of the sensitive field. You can log on to the [DataWorks console](https://workbench.data.aliyun.com/console) and go to the Data Security Guard page to obtain the name.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'ID card',
+ ],
+ ],
+ [
+ 'name' => 'PageNo',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The page number. Pages start from page 1.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => false,
+ 'example' => '1',
+ ],
+ ],
+ [
+ 'name' => 'PageSize',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The number of entries per page. Valid values: 10 to 1000. The recommended number of entries per page ranges from 10 to 100.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => false,
+ 'example' => '10',
+ ],
+ ],
+ [
+ 'name' => 'status',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The status of the sensitive field. Valid values:'."\n"
+ ."\n"
+ .'* 0: draft'."\n"
+ .'* 1: published'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => false,
+ 'example' => '0',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => 'OpenApiResultModel',
+ 'description' => 'The response parameters.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'Success' => [
+ 'description' => 'Indicates whether the request was successful. Valid values:'."\n"
+ ."\n"
+ .'* true'."\n"
+ .'* false'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code.'."\n",
+ 'type' => 'string',
+ 'example' => '9990030003',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message.'."\n",
+ 'type' => 'string',
+ 'example' => 'Missing parameter',
+ ],
+ 'HttpStatusCode' => [
+ 'description' => 'The HTTP status code.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '200',
+ ],
+ 'Data' => [
+ 'description' => 'The returned business data in the JSON format.'."\n",
+ 'type' => 'any',
+ 'example' => '{"success": true, "httpStatusCode": 200, "data": { "result": [ { "sensitiveName": "certificate expiration date", "sensitiveId": "fd4ff5a2-9537-43d1-8e4f-1d0b5ffaac12", "status": 0, "templateName": "built-in classification and grading template", "keyRuleId": "228248921215042 certificate expiration date"} ], "totalCount": 1, "currentPage": 1, "pageSize": 10 }, "requestId": 10000001}',
+ ],
+ 'RequestId' => [
+ 'description' => 'The request ID.'."\n",
+ 'type' => 'string',
+ 'example' => '10000001',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'errorCodes' => [
+ 400 => [
+ [
+ 'errorCode' => 'BADPARAMETERS',
+ 'errorMessage' => 'Parameters are missing or in the wrong format.',
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"9990030003\\",\\n \\"ErrorMessage\\": \\"Missing parameter\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Data\\": \\"{\\\\\\"success\\\\\\": true, \\\\\\"httpStatusCode\\\\\\": 200, \\\\\\"data\\\\\\": { \\\\\\"result\\\\\\": [ { \\\\\\"sensitiveName\\\\\\": \\\\\\"certificate expiration date\\\\\\", \\\\\\"sensitiveId\\\\\\": \\\\\\"fd4ff5a2-9537-43d1-8e4f-1d0b5ffaac12\\\\\\", \\\\\\"status\\\\\\": 0, \\\\\\"templateName\\\\\\": \\\\\\"built-in classification and grading template\\\\\\", \\\\\\"keyRuleId\\\\\\": \\\\\\"228248921215042 certificate expiration date\\\\\\"} ], \\\\\\"totalCount\\\\\\": 1, \\\\\\"currentPage\\\\\\": 1, \\\\\\"pageSize\\\\\\": 10 }, \\\\\\"requestId\\\\\\": 10000001}\\",\\n \\"RequestId\\": \\"10000001\\"\\n}","errorExample":""},{"type":"xml","example":"<QuerySensNodeInfoResponse>\\n <Success>true</Success>\\n <ErrorCode>9990030003</ErrorCode>\\n <ErrorMessage>缺少参数</ErrorMessage>\\n <HttpStatusCode>200</HttpStatusCode>\\n <Data>{ \\"success\\": true, \\"httpStatusCode\\": 200, \\"data\\": { \\"result\\": [ { \\"sensitiveName\\": \\"证件到期日期\\", \\"sensitiveId\\": \\"fd4ff5a2-9537-43d1-8e4f-1d0b5ffaac12\\", \\"status\\": 0, \\"templateName\\": \\"内置分类分级模板\\", \\"keyRuleId\\": \\"228248921215042证件到期日期\\" } ], \\"totalCount\\": 1, \\"currentPage\\": 1, \\"pageSize\\": 10 }, \\"requestId\\": 10000001 }</Data>\\n <RequestId>10000001</RequestId>\\n</QuerySensNodeInfoResponse>","errorExample":""}]',
+ 'title' => 'QuerySensNodeInfo',
+ ],
+ 'AddRecognizeRule' => [
+ 'summary' => 'Adds a sensitive field that is defined based on the category and sensitivity level of data in Data Security Guard.',
+ 'methods' => [
+ 'post',
+ ],
+ 'schemes' => [
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'create',
+ 'abilityTreeCode' => '212268',
+ 'abilityTreeNodes' => [
+ 'FEATUREdideBVSRMP',
+ ],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'TenantId',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The tenant ID. To obtain the tenant ID, perform the following steps: Log on to the [DataWorks console](https://workbench.data.aliyun.com/console). Find your workspace and go to the DataStudio page. On the DataStudio page, click the logon username in the upper-right corner and click User Info in the Menu section.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => '10241024',
+ ],
+ ],
+ [
+ 'name' => 'AccountName',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The Alibaba Cloud account that is used to create a sensitive data identification rule. Enter the username of the Alibaba Cloud account.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => 'dsg-uat',
+ ],
+ ],
+ [
+ 'name' => 'SensitiveName',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The name of the custom sensitive field. Enter a string that is less than 128 characters in length.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => 'name',
+ ],
+ ],
+ [
+ 'name' => 'TemplateId',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The template ID. You can call the [QueryDefaultTemplate](~~2743948~~) operation to obtain the template ID.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => 'e1970541-6cf5-4d23-b101-d5b66f6e1024',
+ ],
+ ],
+ [
+ 'name' => 'NodeId',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The ID of the data category. You can call the [QuerySensClassification](~~2746850~~) operation to query the ID of all data categories. Then, you can select a data category to create a sensitive field. Enter the ID of the selected data category.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => '0ce67949-0810-400f-a24a-cc5ffafe1024',
+ ],
+ ],
+ [
+ 'name' => 'NodeParent',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The information about the parent data category of the current data category. You can call the [QuerySensClassification](~~2746850~~) operation to obtain the ID of a data category.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => 'Customer/personal/personal_Natural _Information/personal basic_profile_information',
+ ],
+ ],
+ [
+ 'name' => 'Level',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The sensitivity level of the sensitive field. You can select one from all sensitivity levels that are defined in a template as the sensitivity level of the sensitive field, such as level 1 to level 10.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => '1',
+ ],
+ ],
+ [
+ 'name' => 'LevelName',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The name of the sensitivity level. You can call the [QueryDefaultTemplate](~~2743948~~) operation to obtain the name of the sensitivity level in the related template.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'Confidential',
+ ],
+ ],
+ [
+ 'name' => 'SensitiveDescription',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The description of the sensitive field. Enter a string that is less than 128 characters in length.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'This is a sensitive field that identifies the name.',
+ ],
+ ],
+ [
+ 'name' => 'OperationType',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The type of the arithmetic operation. Valid values:'."\n"
+ ."\n"
+ .'* 0: OR'."\n"
+ .'* 1: AND'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => true,
+ 'example' => '0',
+ ],
+ ],
+ [
+ 'name' => 'RecognizeRulesType',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The type of the sensitive data identification rule. Valid values:'."\n"
+ ."\n"
+ .'* 1: regular expression'."\n"
+ .'* 2: built-in rule'."\n"
+ .'* 3: sample library'."\n"
+ .'* 4: self-generated data identification model'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => '1',
+ ],
+ ],
+ [
+ 'name' => 'RecognizeRules',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The content of the sensitive data identification rule. You can call the [QuerySensNodeInfo](~~2747189~~) operation to query the value of the current parameter for a built-in sensitive field.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => '{"contentRule":{"_clazz":"com.alipay.dsgclient.sdk.dsg.fastscan.engine.cond.GenderCond"},"_clazz":"com.alipay.dsg.dal.model.RuleContent"}',
+ ],
+ ],
+ [
+ 'name' => 'ContentScan',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'Identifies content. You can call the [QuerySensNodeInfo](~~2747189~~) operation to query the value of the current parameter for a built-in sensitive field.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => '{"_clazz":"com.alipay.dsgclient.sdk.dsg.fastscan.engine.cond.NationalityCond"}',
+ ],
+ ],
+ [
+ 'name' => 'HitThreshold',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The hit ratio threshold. If more than 60%, which is a sample hit ratio threshold, of all sample data records hit the Name Entity Recognition (NER) model, the sensitive field is hit. The value can be an integer from 0 to 100.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => false,
+ 'example' => '50',
+ ],
+ ],
+ [
+ 'name' => 'ColScan',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'Scans fields. The system identifies only fields that are assigned with values.'."\n"
+ ."\n"
+ .'* The value must be in the ${Project name}.${Table name}.${Field name} or ${Project name}.${Schema name}.${Table name}.${Field name} format.'."\n"
+ .'* *Wildcards are supported. For example, the asterisk (\\*) in default.table.column1\\* can be used to match any content following default.table.column1, such as default.table.column10.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'default.qujian.*',
+ ],
+ ],
+ [
+ 'name' => 'ColExclude',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'Excludes fields. The system does not identify fields that are assigned with values.'."\n"
+ ."\n"
+ .'* The value must be in the ${Project name}.${Table name}.${Field name} or ${Project name}.${Schema name}.${Table name}.${Field name} format.'."\n"
+ .'* *Wildcards are supported. For example, the asterisk (\\*) in default.table.column1\\* can be used to match any content following default.table.column1, such as default.table.column10.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'default.qujian.*6',
+ ],
+ ],
+ [
+ 'name' => 'CommentScan',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'Scans content. The value is the text of each field comment in your data asset. Fuzzy match is supported.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'test',
+ ],
+ ],
+ [
+ 'name' => 'Status',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The status of the sensitive field. Valid values:'."\n"
+ ."\n"
+ .'* 0: draft'."\n"
+ .'* 1: effective'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => false,
+ 'example' => '0',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => 'OpenApiResultModel',
+ 'description' => 'The response parameters.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'Success' => [
+ 'description' => 'Indicates whether the request was successful.'."\n"
+ ."\n"
+ .'* true'."\n"
+ .'* false'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code.'."\n",
+ 'type' => 'string',
+ 'example' => '9990030003',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message.'."\n",
+ 'type' => 'string',
+ 'example' => 'Missing parameter',
+ ],
+ 'HttpStatusCode' => [
+ 'description' => 'The HTTP status code.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '200',
+ ],
+ 'Data' => [
+ 'description' => 'The returned result in the JSON format.'."\n",
+ 'type' => 'any',
+ 'example' => '{ "HttpStatusCode": 200, "Success": true }',
+ ],
+ 'RequestId' => [
+ 'description' => 'The request ID.'."\n",
+ 'type' => 'string',
+ 'example' => '10000001',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'errorCodes' => [
+ 400 => [
+ [
+ 'errorCode' => 'BADPARAMETERS',
+ 'errorMessage' => 'Parameters are missing or in the wrong format.',
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"9990030003\\",\\n \\"ErrorMessage\\": \\"Missing parameter\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Data\\": \\"{ \\\\\\"HttpStatusCode\\\\\\": 200, \\\\\\"Success\\\\\\": true }\\",\\n \\"RequestId\\": \\"10000001\\"\\n}","errorExample":""},{"type":"xml","example":"<AddRecognizeRuleResponse>\\n <Success>true</Success>\\n <ErrorCode>9990030003</ErrorCode>\\n <ErrorMessage>缺少参数</ErrorMessage>\\n <HttpStatusCode>200</HttpStatusCode>\\n <Data>{ \\"HttpStatusCode\\": 200, \\"Success\\": true }</Data>\\n <RequestId>10000001</RequestId>\\n</AddRecognizeRuleResponse>","errorExample":""}]',
+ 'title' => 'AddRecognizeRule',
+ ],
+ 'EditRecognizeRule' => [
+ 'summary' => 'Edits a sensitive field that is defined based on the category and sensitivity level of data in Data Security Guard.',
+ 'methods' => [
+ 'post',
+ ],
+ 'schemes' => [
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'update',
+ 'abilityTreeCode' => '212267',
+ 'abilityTreeNodes' => [
+ 'FEATUREdideDCM5VK',
+ ],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'TenantId',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The tenant ID. To obtain the tenant ID, perform the following steps: Log on to the [DataWorks console](https://workbench.data.aliyun.com/console). Find your workspace and go to the DataStudio page. On the DataStudio page, click the logon username in the upper-right corner and click User Info in the Menu section.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => '10241024',
+ ],
+ ],
+ [
+ 'name' => 'AccountName',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The Alibaba Cloud account that is used to create the sensitive data identification rule. Enter the username of the Alibaba Cloud account.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => 'dsg-uat',
+ ],
+ ],
+ [
+ 'name' => 'SensitiveId',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The sensitive field ID. You can call the [QuerySensNodeInfo](~~2747189~~) operation to query the IDs of all sensitive fields. You can also call the [QueryRecognizeRuleDetail](~~2766023~~) operation to query the IDs of specific sensitive fields.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => '1a928de7-3962-4e07-93ac-e1973baa1024',
+ ],
+ ],
+ [
+ 'name' => 'SensitiveName',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The name of the custom sensitive field. Enter a string that is less than 128 characters in length.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => 'name'."\n",
+ ],
+ ],
+ [
+ 'name' => 'NodeId',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The ID of the data category. You can call the [QuerySensClassification](~~2746850~~) operation to query the ID of all data categories. Then, you can select a data category to create a sensitive field. Enter the ID of the selected data category.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => '0ce67949-0810-400f-a24a-cc5ffafe1024',
+ ],
+ ],
+ [
+ 'name' => 'NodeParent',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The information about the parent data category of the current data category. You can call the [QuerySensClassification](~~2746850~~) operation to obtain the ID of a data category.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => 'Customer/personal/personal_Natural_Information/personal_basic_profile_information',
+ ],
+ ],
+ [
+ 'name' => 'TemplateId',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The template ID. You can call the [QueryDefaultTemplate](~~2743948~~) operation to obtain the template ID.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => 'e1970541-6cf5-4d23-b101-d5b66f6e1024',
+ ],
+ ],
+ [
+ 'name' => 'level',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The sensitivity level of the sensitive field. You can select one from all sensitivity levels that are defined in a template as the sensitivity level of the sensitive field, such as level 1 to level 10.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => '1',
+ ],
+ ],
+ [
+ 'name' => 'LevelName',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The name of the sensitivity level. You can call the [QueryDefaultTemplate](~~2743948~~) operation to obtain the name of the sensitivity level in the related template.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'Confidential',
+ ],
+ ],
+ [
+ 'name' => 'SensitiveDescription',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The description of the sensitive field. Enter a string that is less than 128 characters in length.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'This is a sensitive field that identifies the name.',
+ ],
+ ],
+ [
+ 'name' => 'Status',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The status of the sensitive field. Valid values:'."\n"
+ ."\n"
+ .'* 0: draft'."\n"
+ .'* 1: effective'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => false,
+ 'example' => '0',
+ ],
+ ],
+ [
+ 'name' => 'OperationType',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The type of the arithmetic operation. Valid values:'."\n"
+ ."\n"
+ .'* 0: OR'."\n"
+ .'* 1: AND'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => true,
+ 'example' => '0',
+ ],
+ ],
+ [
+ 'name' => 'RecognizeRulesType',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The type of the sensitive data identification rule. Valid values:'."\n"
+ ."\n"
+ .'* 1: regular expression'."\n"
+ .'* 2: built-in rule'."\n"
+ .'* 3: sample library'."\n"
+ .'* 4: self-generated data identification model'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => '1',
+ ],
+ ],
+ [
+ 'name' => 'RecognizeRules',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The content of the sensitive data identification rule. You can call the [QuerySensNodeInfo](~~2747189~~) operation to query the value of the current parameter for a built-in sensitive field.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => '{"contentRule":{"_clazz":"com.alipay.dsgclient.sdk.dsg.fastscan.engine.cond.GenderCond"},"_clazz":"com.alipay.dsg.dal.model.RuleContent"}',
+ ],
+ ],
+ [
+ 'name' => 'ContentScan',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'Identifies content. You can call the [QuerySensNodeInfo](~~2747189~~) operation to query the value of the current parameter for a built-in sensitive field.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => '{"_clazz":"com.alipay.dsgclient.sdk.dsg.fastscan.engine.cond.NationalityCond"}',
+ ],
+ ],
+ [
+ 'name' => 'ColScan',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'Scans fields. The system identifies only fields that are assigned with values.'."\n"
+ ."\n"
+ .'* The value must be in the ${Project name}.${Table name}.${Field name} or ${Project name}.${Schema name}.${Table name}.${Field name} format.'."\n"
+ .'* *Wildcards are supported. For example, the asterisk (\\*) in default.table.column1\\* can be used to match any content following default.table.column1, such as default.table.column10.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'default.qujian.*',
+ ],
+ ],
+ [
+ 'name' => 'ColExclude',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'Excludes fields. The system does not identify fields that are assigned with values.'."\n"
+ ."\n"
+ .'* The value must be in the ${Project name}.${Table name}.${Field name} or ${Project name}.${Schema name}.${Table name}.${Field name} format.'."\n"
+ .'* *Wildcards are supported. For example, the asterisk (\\*) in default.table.column1\\* can be used to match any content following default.table.column1, such as default.table.column10.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'default.qujian.*6',
+ ],
+ ],
+ [
+ 'name' => 'CommentScan',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'Scans content. The value is the text of each field comment in your data asset. Fuzzy match is supported.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'test',
+ ],
+ ],
+ [
+ 'name' => 'HitThreshold',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The hit ratio threshold. If more than 60%, which is a sample hit ratio threshold, of all sample data records hit the Name Entity Recognition (NER) model, the sensitive field is hit. The value can be an integer from 0 to 100.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => false,
+ 'example' => '50',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => 'OpenApiResultModel',
+ 'description' => 'The response parameters.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'Success' => [
+ 'description' => 'Indicates whether the request was successful. Valid values:'."\n"
+ ."\n"
+ .'* true'."\n"
+ .'* false'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code.'."\n",
+ 'type' => 'string',
+ 'example' => '9990030003',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message.'."\n",
+ 'type' => 'string',
+ 'example' => 'Missing parameter',
+ ],
+ 'HttpStatusCode' => [
+ 'description' => 'The HTTP status code.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '200',
+ ],
+ 'Data' => [
+ 'description' => 'The returned result in the JSON format.'."\n",
+ 'type' => 'any',
+ 'example' => '{ "HttpStatusCode": 200, "Success": true }',
+ ],
+ 'RequestId' => [
+ 'description' => 'The request ID.'."\n",
+ 'type' => 'string',
+ 'example' => '10000001',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'errorCodes' => [
+ 400 => [
+ [
+ 'errorCode' => 'BADPARAMETERS',
+ 'errorMessage' => 'Parameters are missing or in the wrong format.',
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"9990030003\\",\\n \\"ErrorMessage\\": \\"Missing parameter\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Data\\": \\"{ \\\\\\"HttpStatusCode\\\\\\": 200, \\\\\\"Success\\\\\\": true }\\",\\n \\"RequestId\\": \\"10000001\\"\\n}","errorExample":""},{"type":"xml","example":"<EditRecognizeRuleResponse>\\n <Success>true</Success>\\n <ErrorCode>9990030003</ErrorCode>\\n <ErrorMessage>缺少参数</ErrorMessage>\\n <HttpStatusCode>200</HttpStatusCode>\\n <Data>{ \\"HttpStatusCode\\": 200, \\"Success\\": true }</Data>\\n <RequestId>10000001</RequestId>\\n</EditRecognizeRuleResponse>","errorExample":""}]',
+ 'title' => 'EditRecognizeRule',
+ ],
+ 'QueryRecognizeDataByRuleType' => [
+ 'summary' => 'Queries the type of a sensitive data identification rule.',
+ 'methods' => [
+ 'post',
+ ],
+ 'schemes' => [
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'get',
+ 'abilityTreeCode' => '212273',
+ 'abilityTreeNodes' => [
+ 'FEATUREdideDCM5VK',
+ ],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'RecognizeRulesType',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The type of a sensitive data identification rule. You can call the [QueryRecognizeRulesType](~~2746905~~) operation to obtain the type of the rule.'."\n"
+ ."\n"
+ .'* 1: regular expression'."\n"
+ .'* 2: built-in rule'."\n"
+ .'* 3: sample library'."\n"
+ .'* 4: self-generated data identification model'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => '2',
+ ],
+ ],
+ [
+ 'name' => 'TenantId',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The tenant ID. To obtain the tenant ID, perform the following steps: Log on to the [DataWorks console](https://workbench.data.aliyun.com/console). Find your workspace and go to the DataStudio page. On the DataStudio page, click the logon username in the upper-right corner and click User Info in the Menu section.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => '10241024',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => 'DataWorksResult',
+ 'description' => 'The response parameters.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'ErrorCode' => [
+ 'description' => 'The error code.'."\n",
+ 'type' => 'string',
+ 'example' => '9990030003',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message.'."\n",
+ 'type' => 'string',
+ 'example' => 'Missing parameter',
+ ],
+ 'Success' => [
+ 'description' => 'Indicates whether the request was successful. Valid values:'."\n"
+ ."\n"
+ .'* true'."\n"
+ .'* false'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'Data' => [
+ 'description' => 'The returned result in the JSON format.'."\n",
+ 'type' => 'any',
+ 'example' => '[{"custom": false, "name": "EducationDegree", "localeName": "EducationDegree", "templateJsonStr": "{&quot;_clazz&quot;:&quot;com.alipay.dsgclient.sdk.dsg.fastscan.engine.cond.EducationDegreeCond&quot;}", "desc": ""}]',
+ ],
+ 'HttpStatusCode' => [
+ 'description' => 'The HTTP status code.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '200',
+ ],
+ 'RequestId' => [
+ 'description' => 'The request ID. You can locate logs and troubleshoot issues based on the ID.'."\n",
+ 'type' => 'string',
+ 'example' => '10000001',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'errorCodes' => [
+ 400 => [
+ [
+ 'errorCode' => 'BADPARAMETERS',
+ 'errorMessage' => 'Parameters are missing or in the wrong format.',
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"ErrorCode\\": \\"9990030003\\",\\n \\"ErrorMessage\\": \\"Missing parameter\\",\\n \\"Success\\": true,\\n \\"Data\\": \\"[{\\\\\\"custom\\\\\\": false, \\\\\\"name\\\\\\": \\\\\\"EducationDegree\\\\\\", \\\\\\"localeName\\\\\\": \\\\\\"EducationDegree\\\\\\", \\\\\\"templateJsonStr\\\\\\": \\\\\\"{&quot;_clazz&quot;:&quot;com.alipay.dsgclient.sdk.dsg.fastscan.engine.cond.EducationDegreeCond&quot;}\\\\\\", \\\\\\"desc\\\\\\": \\\\\\"\\\\\\"}]\\",\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"100000012\\"\\n}","errorExample":""},{"type":"xml","example":"<QueryRecognizeDataByRuleTypeResponse>\\n <ErrorCode>9990030003</ErrorCode>\\n <ErrorMessage>缺少参数</ErrorMessage>\\n <Success>true</Success>\\n <Data>[{\\"custom\\": false, \\"name\\": \\"EducationDegree\\", \\"localeName\\": \\"EducationDegree\\", \\"templateJsonStr\\": \\"{&amp;quot;_clazz&amp;quot;:&amp;quot;com.alipay.dsgclient.sdk.dsg.fastscan.engine.cond.EducationDegreeCond&amp;quot;}\\", \\"desc\\": \\"\\"}]</Data>\\n <HttpStatusCode>200</HttpStatusCode>\\n <RequestId>10000001</RequestId>\\n</QueryRecognizeDataByRuleTypeResponse>","errorExample":""}]',
+ 'title' => 'QueryRecognizeDataByRuleType',
+ ],
+ 'QueryRecognizeRuleDetail' => [
+ 'summary' => 'Queries the details of a specified sensitive field in Data Security Guard.',
+ 'methods' => [
+ 'post',
+ ],
+ 'schemes' => [
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'get',
+ 'abilityTreeCode' => '212990',
+ 'abilityTreeNodes' => [
+ 'FEATUREdideDCM5VK',
+ ],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'SensitiveName',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The name of the sensitive field. To obtain the name of the sensitive field, call the [QuerySensNodeInfo](~~2747189~~) operation or log on to the [DataWorks console](https://workbench.data.aliyun.com/console) and go to the Data Category and Sensitivity Level page.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => 'Name',
+ ],
+ ],
+ [
+ 'name' => 'TenantId',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The tenant ID. To obtain the tenant ID, perform the following steps: Log on to the [DataWorks console](https://workbench.data.aliyun.com/console). Find your workspace and go to the DataStudio page. On the DataStudio page, click the logon username in the upper-right corner and click User Info in the Menu section.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => '10241024',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => 'OpenApiResultModel',
+ 'description' => 'The response parameters.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'Success' => [
+ 'description' => 'Indicates whether the request was successful.'."\n"
+ ."\n"
+ .'* true'."\n"
+ .'* false'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code.'."\n",
+ 'type' => 'string',
+ 'example' => '9990030003',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message.'."\n",
+ 'type' => 'string',
+ 'example' => 'Missing parameter',
+ ],
+ 'HttpStatusCode' => [
+ 'description' => 'The HTTP status code.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '200',
+ ],
+ 'Data' => [
+ 'description' => 'The details of the sensitive field in the JSON format.'."\n",
+ 'type' => 'any',
+ 'example' => '{"nodeName":"basic unit overview","gmtModified":1709017449000,"hitThreshold":30,"sensitiveName":"mobile-yinni","templateId":"8222abeb-9784-4417-b420-0322926d5cbf","recognizeRulesType":2,"delete":false,"bydAccuracy":1,"colScan":"," defineType ":1,": ydAccuracy ":{" contentRule ":))," operationType ":0}," nodeParent ":" unit/unit basic information/unit basic overview "," level ":6," keyRuleId ":" 228248921215042mobile-yinni "," isDelete ":false," levelName ":" 6level "," sensitive ":false," operationType ":0," sourceName ": dsg-test-zuoyue","nodeId":"bea2fc81-90c9-45f3-b7a9-26d534208a0d","status":1}',
+ ],
+ 'RequestId' => [
+ 'description' => 'The request ID. You can locate logs and troubleshoot issues based on the ID.'."\n",
+ 'type' => 'string',
+ 'example' => '10000001',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'errorCodes' => [
+ 400 => [
+ [
+ 'errorCode' => 'BADPARAMETERS',
+ 'errorMessage' => 'Parameters are missing or in the wrong format.',
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"9990030003\\",\\n \\"ErrorMessage\\": \\"Missing parameter\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Data\\": \\"{\\\\\\"nodeName\\\\\\":\\\\\\"basic unit overview\\\\\\",\\\\\\"gmtModified\\\\\\":1709017449000,\\\\\\"hitThreshold\\\\\\":30,\\\\\\"sensitiveName\\\\\\":\\\\\\"mobile-yinni\\\\\\",\\\\\\"templateId\\\\\\":\\\\\\"8222abeb-9784-4417-b420-0322926d5cbf\\\\\\",\\\\\\"recognizeRulesType\\\\\\":2,\\\\\\"delete\\\\\\":false,\\\\\\"bydAccuracy\\\\\\":1,\\\\\\"colScan\\\\\\":\\\\\\",\\\\\\" defineType \\\\\\":1,\\\\\\": ydAccuracy \\\\\\":{\\\\\\" contentRule \\\\\\":)),\\\\\\" operationType \\\\\\":0},\\\\\\" nodeParent \\\\\\":\\\\\\" unit/unit basic information/unit basic overview \\\\\\",\\\\\\" level \\\\\\":6,\\\\\\" keyRuleId \\\\\\":\\\\\\" 228248921215042mobile-yinni \\\\\\",\\\\\\" isDelete \\\\\\":false,\\\\\\" levelName \\\\\\":\\\\\\" 6level \\\\\\",\\\\\\" sensitive \\\\\\":false,\\\\\\" operationType \\\\\\":0,\\\\\\" sourceName \\\\\\": dsg-test-zuoyue\\\\\\",\\\\\\"nodeId\\\\\\":\\\\\\"bea2fc81-90c9-45f3-b7a9-26d534208a0d\\\\\\",\\\\\\"status\\\\\\":1}\\",\\n \\"RequestId\\": \\"100000012\\"\\n}","errorExample":""},{"type":"xml","example":"<QueryRecognizeRuleDetailResponse>\\n <Success>true</Success>\\n <ErrorCode>9990030003</ErrorCode>\\n <ErrorMessage>缺少参数</ErrorMessage>\\n <HttpStatusCode>200</HttpStatusCode>\\n <Data>{\\"nodeName\\":\\"单位基本概况\\",\\"gmtModified\\":1709017449000,\\"hitThreshold\\":30,\\"sensitiveName\\":\\"mobile-yinni\\",\\"templateId\\":\\"8222abeb-9784-4417-b420-0322926d5cbf\\",\\"recognizeRulesType\\":2,\\"delete\\":false,\\"bydAccuracy\\":1,\\"colScan\\":\\"\\",\\"defineType\\":1,\\"ydAccuracy\\":1,\\"contentRule\\":{\\"contentRule\\":{},\\"operationType\\":0},\\"nodeParent\\":\\"单位/单位基本信息/单位基本概况\\",\\"level\\":6,\\"keyRuleId\\":\\"228248921215042mobile-yinni\\",\\"isDelete\\":false,\\"levelName\\":\\"6level\\",\\"sensitive\\":false,\\"operationType\\":0,\\"sourceName\\":\\"dsg-test-zuoyue\\",\\"nodeId\\":\\"bea2fc81-90c9-45f3-b7a9-26d534208a0d\\",\\"status\\":1}</Data>\\n <RequestId>10000001</RequestId>\\n</QueryRecognizeRuleDetailResponse>","errorExample":""}]',
+ 'title' => 'QueryRecognizeRuleDetail',
+ ],
+ 'DsgUserGroupGetOdpsRoleGroups' => [
+ 'methods' => [
+ 'get',
+ ],
+ 'schemes' => [
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'get',
+ 'abilityTreeCode' => '220985',
+ 'abilityTreeNodes' => [
+ 'FEATUREdideRZM9W6',
+ ],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'ProjectName',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The name of the MaxCompute project. You can call the [DsgPlatformQueryProjectsAndSchemaFromMeta](~~2786303~~) operation to query a list of MaxCompute projects.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => 'test_project',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => 'OpenApiResultModel<List<String>>',
+ 'description' => 'The data returned.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'Success' => [
+ 'description' => 'Indicates whether the request was successful. Valid values:'."\n"
+ ."\n"
+ .'* true'."\n"
+ .'* false'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code.'."\n",
+ 'type' => 'string',
+ 'example' => '1029030003',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message.'."\n",
+ 'type' => 'string',
+ 'example' => 'param error',
+ ],
+ 'HttpStatusCode' => [
+ 'description' => 'The HTTP status code.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '400',
+ ],
+ 'Data' => [
+ 'description' => 'The data returned.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The name of the MaxCompute role.'."\n",
+ 'type' => 'string',
+ 'example' => 'test_role',
+ ],
+ ],
+ 'RequestId' => [
+ 'description' => 'The request ID. You can use the ID to locate logs and troubleshoot issues.'."\n",
+ 'type' => 'string',
+ 'example' => '102400001',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'errorCodes' => [
+ 400 => [
+ [
+ 'errorCode' => 'USERGROUP.ACCOUNTLISTSIZE.ERROR',
+ 'errorMessage' => 'The number of account exceeds the limit.',
+ ],
+ [
+ 'errorCode' => 'USERGROUP.ID.ERROR',
+ 'errorMessage' => 'The user group ID does not match the tenant or does not exist.',
+ ],
+ [
+ 'errorCode' => 'USERGROUP.LISTSIZE.ERROR',
+ 'errorMessage' => 'The number of user groups exceeds the limit.',
+ ],
+ [
+ 'errorCode' => 'USERGROUP.PAGESIZE.ERROR',
+ 'errorMessage' => 'Page size is too large, maximum of 100.',
+ ],
+ [
+ 'errorCode' => 'USERACCOUNT.OWNER.ERROR',
+ 'errorMessage' => 'User list or owner user does not exist.',
+ ],
+ [
+ 'errorCode' => 'PARAMS.ERROR',
+ 'errorMessage' => 'param error.',
+ ],
+ ],
+ 403 => [
+ [
+ 'errorCode' => 'PERMISSION.DENIED.ERROR',
+ 'errorMessage' => 'Permission denied',
+ ],
+ ],
+ 500 => [
+ [
+ 'errorCode' => 'UNKNOWN.ERROR',
+ 'errorMessage' => 'unknown error.',
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"1029030003\\",\\n \\"ErrorMessage\\": \\"param error\\",\\n \\"HttpStatusCode\\": 400,\\n \\"Data\\": [\\n \\"test_role\\"\\n ],\\n \\"RequestId\\": \\"102400001\\"\\n}","errorExample":""},{"type":"xml","example":"<DsgUserGroupGetOdpsRoleGroupsResponse>\\n <Success>true</Success>\\n <ErrorCode>1029030003</ErrorCode>\\n <ErrorMessage>param error</ErrorMessage>\\n <HttpStatusCode>400</HttpStatusCode>\\n <Data>test_role</Data>\\n <RequestId>102400001</RequestId>\\n</DsgUserGroupGetOdpsRoleGroupsResponse>","errorExample":""}]',
+ 'title' => 'DsgUserGroupGetOdpsRoleGroups',
+ 'summary' => 'Queries a list of MaxCompute roles that can be selected by the members of a user group when the user group is created or modified by the tenant in Data Security Guard.',
+ ],
+ 'DsgDesensPlanAddOrUpdate' => [
+ 'summary' => 'Adds or modifies a data masking rule.',
+ 'methods' => [
+ 'post',
+ ],
+ 'schemes' => [
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'list',
+ 'abilityTreeCode' => '219759',
+ 'abilityTreeNodes' => [
+ 'FEATUREdideRZM9W6',
+ ],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'DesensRules',
+ 'in' => 'query',
+ 'style' => 'json',
+ 'schema' => [
+ 'description' => 'A collection of data masking rules that you want to add or modify.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '',
+ 'type' => 'object',
+ 'properties' => [
+ 'Id' => [
+ 'description' => 'The ID of the data masking rule. You can call the [DsgDesensPlanQueryList](~~2786578~~) operation to query the ID of the data masking rule.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => false,
+ 'example' => '123',
+ ],
+ 'DataType' => [
+ 'description' => 'The sensitive field type.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => 'phone',
+ ],
+ 'RuleName' => [
+ 'description' => 'The name of the data masking rule.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => 'phone_hash',
+ ],
+ 'Status' => [
+ 'description' => 'The status of the data masking rule. Valid values:'."\n"
+ ."\n"
+ .'* 0: expired'."\n"
+ .'* 1: effective'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => false,
+ 'example' => '1',
+ ],
+ 'SceneIds' => [
+ 'description' => 'The level-2 data masking scenario.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The ID of the level-2 data masking scenario. Make sure that the data masking rule in which the sensitive field type determined by the DataType parameter is specified is not configured for the level-2 data masking scenario that you use. You can call the [DsgSceneQuerySceneListByName](~~2786322~~) to query the ID of the data masking scenario.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => false,
+ 'example' => '123',
+ ],
+ 'required' => true,
+ ],
+ 'Owner' => [
+ 'description' => 'The owner of the data masking rule.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => 'test_user',
+ ],
+ 'CheckWatermark' => [
+ 'description' => 'Specifies whether to add a watermark. Valid values:'."\n"
+ ."\n"
+ .'* true'."\n"
+ .'* false'."\n",
+ 'type' => 'boolean',
+ 'required' => false,
+ 'example' => 'true',
+ ],
+ 'DesensPlan' => [
+ 'description' => 'The data masking rule.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'DesensPlanType' => [
+ 'description' => 'The masking method configured in the data masking rule. Valid values:'."\n"
+ ."\n"
+ .'* hash'."\n"
+ .'* mapping'."\n"
+ .'* mask'."\n"
+ .'* charreplacement'."\n"
+ .'* intervalselect'."\n"
+ .'* decimalpoint'."\n"
+ .'* emptydesens'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => 'hash',
+ ],
+ 'ExtParam' => [
+ 'description' => 'The parameters for the data masking rule.'."\n",
+ 'type' => 'object',
+ 'required' => false,
+ 'additionalProperties' => [
+ 'type' => 'any',
+ 'description' => 'The parameter configurations of the data masking rule. You can add different parameters based on the data masking rule that you want to configure. For more information, see the following example.'."\n",
+ 'example' => '{ "algo": "MD5", "salt":6 }',
+ ],
+ ],
+ ],
+ 'required' => true,
+ ],
+ ],
+ 'required' => false,
+ ],
+ 'required' => true,
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => 'OpenApiResultModel<Boolean>',
+ 'description' => 'OpenApiResultModel'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'Success' => [
+ 'description' => 'Indicates whether the request was successful. Valid values: true false'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code.'."\n",
+ 'type' => 'string',
+ 'example' => '1029030003',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message.'."\n",
+ 'type' => 'string',
+ 'example' => 'param error',
+ ],
+ 'HttpStatusCode' => [
+ 'description' => 'The HTTP status code.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '400',
+ ],
+ 'Data' => [
+ 'description' => 'The execution result of adding or modifying a data masking rule.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'RequestId' => [
+ 'description' => 'The request ID. You can locate logs and troubleshoot issues based on the ID.'."\n",
+ 'type' => 'string',
+ 'example' => '102400001',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'errorCodes' => [
+ 400 => [
+ [
+ 'errorCode' => 'PARAMS.ERROR',
+ 'errorMessage' => 'param error.',
+ ],
+ [
+ 'errorCode' => 'DESENSPLAN.DATATYPE.ERROR',
+ 'errorMessage' => 'Sensitive type already has a desensitization rule.',
+ ],
+ [
+ 'errorCode' => 'DESENSPLAN.DATATYPENOTEXIST.ERROR',
+ 'errorMessage' => 'Sensitive type not exist.',
+ ],
+ [
+ 'errorCode' => 'DESENSPLAN.ID.ERROR',
+ 'errorMessage' => 'Desensitization rule ID does not exist.',
+ ],
+ [
+ 'errorCode' => 'DESENSPLAN.PAGESIZE.ERROR',
+ 'errorMessage' => 'Page size is too large, maximum of 100.',
+ ],
+ [
+ 'errorCode' => 'DESENSPLAN.PARAM.ERROR',
+ 'errorMessage' => 'Desensitization rule parameter error.',
+ ],
+ [
+ 'errorCode' => 'DESENSPLAN.SCENECODE.ERROR',
+ 'errorMessage' => 'Scene code does not exist.',
+ ],
+ [
+ 'errorCode' => 'DESENSPLAN.SCENEID.ERROR',
+ 'errorMessage' => 'Scene ID does not exist.',
+ ],
+ [
+ 'errorCode' => 'DESENSPLAN.SCENEIDLEVEL.ERROR',
+ 'errorMessage' => 'The scene is not a secondary scene.',
+ ],
+ [
+ 'errorCode' => 'DESENSPLAN.SIZE.ERROR',
+ 'errorMessage' => 'The number of desens plan exceeds the limit.',
+ ],
+ ],
+ 403 => [
+ [
+ 'errorCode' => 'PERMISSION.DENIED.ERROR',
+ 'errorMessage' => 'Permission denied',
+ ],
+ ],
+ 500 => [
+ [
+ 'errorCode' => 'UNKNOWN.ERROR',
+ 'errorMessage' => 'unknown error.',
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"1029030003\\",\\n \\"ErrorMessage\\": \\"param error\\",\\n \\"HttpStatusCode\\": 400,\\n \\"Data\\": true,\\n \\"RequestId\\": \\"102400001\\"\\n}","errorExample":""},{"type":"xml","example":"<DsgDesensPlanAddOrUpdateResponse>\\n <Success>true</Success>\\n <ErrorCode>1029030003</ErrorCode>\\n <ErrorMessage>param error</ErrorMessage>\\n <HttpStatusCode>400</HttpStatusCode>\\n <Data>true</Data>\\n <RequestId>102400001</RequestId>\\n</DsgDesensPlanAddOrUpdateResponse>","errorExample":""}]',
+ 'title' => 'DsgDesensPlanAddOrUpdate',
+ 'requestParamsDescription' => 'The ExtParam parameter is a dynamic parameter. The value of the ExtParam parameter varies based on the data masking rule. The following example shows how to configure the parameters:'."\n"
+ ."\n"
+ .' Hash:'."\n"
+ .' {'."\n"
+ .' "algo": "MD5",'."\n"
+ .' "salt": 6'."\n"
+ .' }'."\n"
+ .' Pseudonym:'."\n"
+ .' {'."\n"
+ .' "charset": "Aa",'."\n"
+ .' "salt": 6'."\n"
+ .' }'."\n"
+ .' Mask:'."\n"
+ .' {'."\n"
+ .' "before": 3,'."\n"
+ .' "after": 4'."\n"
+ .' }'."\n"
+ .' Custom mask:'."\n"
+ .' {'."\n"
+ .' "separatorList": ['."\n"
+ .' {'."\n"
+ .' "desens": true,'."\n"
+ .' "left": 3'."\n"
+ .' },'."\n"
+ .' {'."\n"
+ .' "desens": false,'."\n"
+ .' "left": 6'."\n"
+ .' },'."\n"
+ .' {'."\n"
+ .' "desens": true,'."\n"
+ .' "left": -99'."\n"
+ .' }'."\n"
+ .' ]'."\n"
+ .' }'."\n"
+ .' Sample value character replacement:'."\n"
+ .' {'."\n"
+ .' "library": "test_library",'."\n"
+ .' "position": 3'."\n"
+ .' }'."\n"
+ .' Fixed value character replacement:'."\n"
+ .' {'."\n"
+ .' "replace": "repData",'."\n"
+ .' "position": 3'."\n"
+ .' }'."\n"
+ .' Random character replacement:'."\n"
+ .' {'."\n"
+ .' "replace": "repData"'."\n"
+ .' }'."\n"
+ .' Custom character replacement:'."\n"
+ .' {'."\n"
+ .' "separatorList": ['."\n"
+ .' {'."\n"
+ .' "desensParam": {'."\n"
+ .' "replace": "repData"'."\n"
+ .' },'."\n"
+ .' "left": 3'."\n"
+ .' },'."\n"
+ .' {'."\n"
+ .' "desensParam": {'."\n"
+ .' "library": "test_library"'."\n"
+ .' },'."\n"
+ .' "left": 6'."\n"
+ .' },'."\n"
+ .' {'."\n"
+ .' "desensParam": {'."\n"
+ .' },'."\n"
+ .' "left": 99'."\n"
+ .' }'."\n"
+ .' ]'."\n"
+ .' }'."\n"
+ .' Range change:'."\n"
+ .' {'."\n"
+ .' "intervalselects": ['."\n"
+ .' {'."\n"
+ .' "desens": "1",'."\n"
+ .' "interval": ['."\n"
+ .' "1",'."\n"
+ .' "100"'."\n"
+ .' ]'."\n"
+ .' }'."\n"
+ .' ]'."\n"
+ .' }'."\n"
+ .' Rounding:'."\n"
+ .' {'."\n"
+ .' "point":3'."\n"
+ .' }'."\n"
+ .' Left empty:'."\n"
+ .' {}'."\n"
+ ."\n"
+ .'You can call the [DsgQueryDefaultTemplates](~~2786306~~) operation to query the supported data masking methods and related rules.'."\n",
+ ],
+ 'DsgPlatformQueryProjectsAndSchemaFromMeta' => [
+ 'summary' => 'Queries a list of compute engines of different types in the current tenant.',
+ 'methods' => [
+ 'get',
+ ],
+ 'schemes' => [
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'list',
+ 'abilityTreeCode' => '219458',
+ 'abilityTreeNodes' => [
+ 'FEATUREdideRZM9W6',
+ ],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'EngineName',
+ 'in' => 'query',
+ 'schema' => [
+ 'title' => '引擎名称',
+ 'description' => 'The type of the compute engine. Valid values:'."\n"
+ ."\n"
+ .'* ODPS.ODPS'."\n"
+ .'* EMR'."\n"
+ .'* HOLO.POSTGRES'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => 'EMR',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => 'OpenApiResultModel<List<QueryProjectsAndSchemaFromMetaVO>>',
+ 'description' => 'OpenApiResultModel\\<List>'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'Success' => [
+ 'description' => 'Indicates whether the request was successful. Valid values:'."\n"
+ ."\n"
+ .'* true'."\n"
+ .'* false'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code.'."\n",
+ 'type' => 'string',
+ 'example' => '1029030003',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message.'."\n",
+ 'type' => 'string',
+ 'example' => 'param error',
+ ],
+ 'HttpStatusCode' => [
+ 'description' => 'The HTTP status code.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '400',
+ ],
+ 'Data' => [
+ 'description' => 'The data returned.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '',
+ 'type' => 'object',
+ 'properties' => [
+ 'Project' => [
+ 'description' => 'The name of the compute engine.'."\n",
+ 'type' => 'string',
+ 'example' => 'emr_test_project',
+ ],
+ 'ClusterId' => [
+ 'description' => 'The ID of the EMR cluster. This parameter is generated only when the request parameter EngineName is set to EMR.'."\n",
+ 'type' => 'string',
+ 'example' => 'c-12345',
+ ],
+ ],
+ ],
+ ],
+ 'RequestId' => [
+ 'description' => 'The request ID. You can use the ID to locate logs and troubleshoot issues.'."\n",
+ 'type' => 'string',
+ 'example' => '102400001',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'errorCodes' => [
+ 400 => [
+ [
+ 'errorCode' => 'PARAMS.ERROR',
+ 'errorMessage' => 'param error.',
+ ],
+ [
+ 'errorCode' => 'ENGINE.NOT.ALLOW',
+ 'errorMessage' => 'engine not allow.',
+ ],
+ ],
+ 403 => [
+ [
+ 'errorCode' => 'PERMISSION.DENIED.ERROR',
+ 'errorMessage' => 'Permission denied',
+ ],
+ ],
+ 500 => [
+ [
+ 'errorCode' => 'UNKNOWN.ERROR',
+ 'errorMessage' => 'unknown error.',
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"1029030003\\",\\n \\"ErrorMessage\\": \\"param error\\",\\n \\"HttpStatusCode\\": 400,\\n \\"Data\\": [\\n {\\n \\"Project\\": \\"emr_test_project\\",\\n \\"ClusterId\\": \\"c-12345\\"\\n }\\n ],\\n \\"RequestId\\": \\"102400001\\"\\n}","errorExample":""},{"type":"xml","example":"<DsgPlatformQueryProjectsAndSchemaFromMetaResponse>\\n <Success>true</Success>\\n <ErrorCode>1029030003</ErrorCode>\\n <ErrorMessage>param error</ErrorMessage>\\n <HttpStatusCode>400</HttpStatusCode>\\n <Data>\\n <Project>emr_test_project</Project>\\n <ClusterId>c-12345</ClusterId>\\n </Data>\\n <RequestId>102400001</RequestId>\\n</DsgPlatformQueryProjectsAndSchemaFromMetaResponse>","errorExample":""}]',
+ 'title' => 'DsgPlatformQueryProjectsAndSchemaFromMeta',
+ ],
+ 'DsgUserGroupDelete' => [
+ 'summary' => 'Deletes a user group configured in Data Security Guard.',
+ 'methods' => [
+ 'post',
+ ],
+ 'schemes' => [
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'list',
+ 'abilityTreeCode' => '219457',
+ 'abilityTreeNodes' => [
+ 'FEATUREdideRZM9W6',
+ ],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'Ids',
+ 'in' => 'query',
+ 'style' => 'json',
+ 'schema' => [
+ 'description' => 'The information about the user group.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The user group ID. You can call the [DsgUserGroupQueryList](~~2786441~~) operation to query the user group ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'example' => '123',
+ ],
+ 'required' => false,
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => 'OpenApiResultModel<Boolean>',
+ 'description' => 'OpenApiResultModel'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'Success' => [
+ 'description' => 'Indicates whether the request was successful. Valid values:'."\n"
+ ."\n"
+ .'* true'."\n"
+ .'* false'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code.'."\n",
+ 'type' => 'string',
+ 'example' => '1029030003',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message.'."\n",
+ 'type' => 'string',
+ 'example' => 'param error',
+ ],
+ 'HttpStatusCode' => [
+ 'description' => 'The HTTP status code.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '400',
+ ],
+ 'Data' => [
+ 'description' => 'The operation result. Valid values:'."\n"
+ ."\n"
+ .'* true: The user group is deleted.'."\n"
+ .'* false: The user group fails to be deleted.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'RequestId' => [
+ 'description' => 'The request ID. You can locate logs and troubleshoot issues based on the ID.'."\n",
+ 'type' => 'string',
+ 'example' => '102400001',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'errorCodes' => [
+ 400 => [
+ [
+ 'errorCode' => 'USERGROUP.ACCOUNTLISTSIZE.ERROR',
+ 'errorMessage' => 'The number of account exceeds the limit.',
+ ],
+ [
+ 'errorCode' => 'USERGROUP.ID.ERROR',
+ 'errorMessage' => 'The user group ID does not match the tenant or does not exist.',
+ ],
+ [
+ 'errorCode' => 'USERGROUP.LISTSIZE.ERROR',
+ 'errorMessage' => 'The number of user groups exceeds the limit.',
+ ],
+ [
+ 'errorCode' => 'USERGROUP.PAGESIZE.ERROR',
+ 'errorMessage' => 'Page size is too large, maximum of 100.',
+ ],
+ [
+ 'errorCode' => 'USERACCOUNT.OWNER.ERROR',
+ 'errorMessage' => 'User list or owner user does not exist.',
+ ],
+ [
+ 'errorCode' => 'PARAMS.ERROR',
+ 'errorMessage' => 'param error.',
+ ],
+ ],
+ 403 => [
+ [
+ 'errorCode' => 'PERMISSION.DENIED.ERROR',
+ 'errorMessage' => 'Permission denied',
+ ],
+ ],
+ 500 => [
+ [
+ 'errorCode' => 'UNKNOWN.ERROR',
+ 'errorMessage' => 'unknown error.',
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"1029030003\\",\\n \\"ErrorMessage\\": \\"param error\\",\\n \\"HttpStatusCode\\": 400,\\n \\"Data\\": true,\\n \\"RequestId\\": \\"102400001\\"\\n}","errorExample":""},{"type":"xml","example":"<DsgUserGroupDeleteResponse>\\n <Success>true</Success>\\n <ErrorCode>1029030003</ErrorCode>\\n <ErrorMessage>param error</ErrorMessage>\\n <HttpStatusCode>400</HttpStatusCode>\\n <Data>true</Data>\\n <RequestId>102400001</RequestId>\\n</DsgUserGroupDeleteResponse>","errorExample":""}]',
+ 'title' => 'DsgUserGroupDelete',
+ ],
+ 'DsgWhiteListDeleteList' => [
+ 'summary' => 'Deletes a data masking whitelist configured in Data Security Guard.',
+ 'methods' => [
+ 'post',
+ ],
+ 'schemes' => [
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'list',
+ 'abilityTreeCode' => '219462',
+ 'abilityTreeNodes' => [
+ 'FEATUREdideRZM9W6',
+ ],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'Ids',
+ 'in' => 'query',
+ 'style' => 'json',
+ 'schema' => [
+ 'description' => 'The IDs of the whitelists.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The whitelist ID. You can call the [DsgWhiteListQueryList](~~2786508~~) operation to obtain the whitelist ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => false,
+ 'example' => '123',
+ ],
+ 'required' => true,
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => 'OpenApiResultModel<Boolean>',
+ 'description' => 'OpenApiResultModel'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'Success' => [
+ 'description' => 'Indicates whether the request was successful. Valid values:'."\n"
+ ."\n"
+ .'* true'."\n"
+ .'* false'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code.'."\n",
+ 'type' => 'string',
+ 'example' => '1029030003',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message.'."\n",
+ 'type' => 'string',
+ 'example' => 'param error',
+ ],
+ 'HttpStatusCode' => [
+ 'description' => 'The HTTP status code.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '400',
+ ],
+ 'Data' => [
+ 'description' => 'The operation result. Valid values:'."\n"
+ ."\n"
+ .'* true: The operation is successful.'."\n"
+ .'* false: The operation failed.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'RequestId' => [
+ 'description' => 'The request ID. You can locate logs and troubleshoot issues based on the ID.'."\n",
+ 'type' => 'string',
+ 'example' => '102400001',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'errorCodes' => [
+ 400 => [
+ [
+ 'errorCode' => 'WHITELIST.DESENSID.ERROR',
+ 'errorMessage' => 'The desensitization rule ID does not match or does not exist with the tenant.',
+ ],
+ [
+ 'errorCode' => 'WHITELIST.ENDTIME.ERROR',
+ 'errorMessage' => 'end time cannot be earlier than start time.',
+ ],
+ [
+ 'errorCode' => 'WHITELIST.ID.ERROR',
+ 'errorMessage' => 'The whitelist ID does not match or does not exist with the tenant.',
+ ],
+ [
+ 'errorCode' => 'WHITELIST.MCPROJECT.ERROR',
+ 'errorMessage' => 'The projectName on the bottom layer desensitization whitelist of MC cannot be empty.',
+ ],
+ [
+ 'errorCode' => 'WHITELIST.PAGESIZE.ERROR',
+ 'errorMessage' => 'Page size is too large, maximum of 100.',
+ ],
+ [
+ 'errorCode' => 'WHITELIST.SIZE.ERROR',
+ 'errorMessage' => 'The number of white list exceeds the limit.',
+ ],
+ [
+ 'errorCode' => 'WHITELIST.STARTTIME.ERROR',
+ 'errorMessage' => 'start time cannot be earlier than today.',
+ ],
+ [
+ 'errorCode' => 'WHITELIST.TIMEFORMAT.ERROR',
+ 'errorMessage' => 'The time format is incorrect, please use yyyy MM dd HH: mm: ss format.',
+ ],
+ [
+ 'errorCode' => 'WHITELIST.USERGROUP.ERROR',
+ 'errorMessage' => 'The user group ID does not match or does not exist with the tenant.',
+ ],
+ [
+ 'errorCode' => 'WHITELIST.USERGROUPEMPTY.ERROR',
+ 'errorMessage' => 'User group ID cannot be empty.',
+ ],
+ [
+ 'errorCode' => 'WHITELIST.USERGROUPLISTSIZE.ERROR',
+ 'errorMessage' => 'The number of user group exceeds the limit.',
+ ],
+ [
+ 'errorCode' => 'PARAMS.ERROR',
+ 'errorMessage' => 'param error.',
+ ],
+ ],
+ 403 => [
+ [
+ 'errorCode' => 'PERMISSION.DENIED.ERROR',
+ 'errorMessage' => 'Permission denied',
+ ],
+ ],
+ 500 => [
+ [
+ 'errorCode' => 'UNKNOWN.ERROR',
+ 'errorMessage' => 'unknown error.',
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"1029030003\\",\\n \\"ErrorMessage\\": \\"param error\\",\\n \\"HttpStatusCode\\": 400,\\n \\"Data\\": true,\\n \\"RequestId\\": \\"102400001\\"\\n}","errorExample":""},{"type":"xml","example":"<DsgWhiteListDeleteListResponse>\\n <Success>true</Success>\\n <ErrorCode>1029030003</ErrorCode>\\n <ErrorMessage>param error</ErrorMessage>\\n <HttpStatusCode>400</HttpStatusCode>\\n <Data>true</Data>\\n <RequestId>102400001</RequestId>\\n</DsgWhiteListDeleteListResponse>","errorExample":""}]',
+ 'title' => 'DsgWhiteListDeleteList',
+ ],
+ 'DsgScenedDeleteScene' => [
+ 'summary' => 'Deletes a level-2 data masking scenario created in Data Security Guard.',
+ 'methods' => [
+ 'post',
+ ],
+ 'schemes' => [
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'list',
+ 'abilityTreeCode' => '219460',
+ 'abilityTreeNodes' => [
+ 'FEATUREdideRZM9W6',
+ ],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'Ids',
+ 'in' => 'query',
+ 'style' => 'json',
+ 'schema' => [
+ 'description' => 'The IDs of level-2 data masking scenarios.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The ID of the level-2 data masking scenario. You can call the [DsgSceneQuerySceneListByName](~~2786322~~) operation to query the ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => false,
+ 'example' => '123',
+ ],
+ 'required' => true,
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => 'OpenApiResultModel<Boolean>',
+ 'description' => 'The response parameters.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'Success' => [
+ 'description' => 'Indicates whether the request was successful. Valid values:'."\n"
+ ."\n"
+ .'* true'."\n"
+ .'* false'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code.'."\n",
+ 'type' => 'string',
+ 'example' => '1029030003',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message.'."\n",
+ 'type' => 'string',
+ 'example' => 'param error',
+ ],
+ 'HttpStatusCode' => [
+ 'description' => 'The HTTP status code.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '400',
+ ],
+ 'Data' => [
+ 'description' => 'The operation result. Valid values:'."\n"
+ ."\n"
+ .'* true: The operation is successful.'."\n"
+ .'* false: The operation failed.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'RequestId' => [
+ 'description' => 'The request ID.'."\n",
+ 'type' => 'string',
+ 'example' => '102400001',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'errorCodes' => [
+ 400 => [
+ [
+ 'errorCode' => 'DESENSSCENE.ID.ERROR',
+ 'errorMessage' => 'The desensitization scenario ID does not match or does not exist with the tenant.',
+ ],
+ [
+ 'errorCode' => 'DESENSSCENE.IDLEVEL.ERROR',
+ 'errorMessage' => 'The desensitization scenario is not a secondary scenario.',
+ ],
+ [
+ 'errorCode' => 'DESENSSCENE.PROJECT.ERROR',
+ 'errorMessage' => 'The project space does not exist.',
+ ],
+ [
+ 'errorCode' => 'DESENSSCENE.SIZE.ERROR',
+ 'errorMessage' => 'The number of desens scene exceeds the limit.',
+ ],
+ [
+ 'errorCode' => 'DESENSSCENE.UESRGROUP.ERROR',
+ 'errorMessage' => 'The user group ID does not match the tenant or does not exist.',
+ ],
+ [
+ 'errorCode' => 'PARAMS.ERROR',
+ 'errorMessage' => 'param error.',
+ ],
+ ],
+ 403 => [
+ [
+ 'errorCode' => 'PERMISSION.DENIED.ERROR',
+ 'errorMessage' => 'Permission denied',
+ ],
+ ],
+ 500 => [
+ [
+ 'errorCode' => 'UNKNOWN.ERROR',
+ 'errorMessage' => 'unknown error.',
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"1029030003\\",\\n \\"ErrorMessage\\": \\"param error\\",\\n \\"HttpStatusCode\\": 400,\\n \\"Data\\": true,\\n \\"RequestId\\": \\"102400001\\"\\n}","errorExample":""},{"type":"xml","example":"<DsgScenedDeleteSceneResponse>\\n <Success>true</Success>\\n <ErrorCode>1029030003</ErrorCode>\\n <ErrorMessage>param error</ErrorMessage>\\n <HttpStatusCode>400</HttpStatusCode>\\n <Data>true</Data>\\n <RequestId>102400001</RequestId>\\n</DsgScenedDeleteSceneResponse>","errorExample":""}]',
+ 'title' => 'DsgScenedDeleteScene',
+ ],
+ 'DsgDesensPlanDelete' => [
+ 'summary' => 'Deletes a data masking rule created in Data Security Guard.',
+ 'methods' => [
+ 'post',
+ ],
+ 'schemes' => [
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'delete',
+ 'abilityTreeCode' => '219620',
+ 'abilityTreeNodes' => [
+ 'FEATUREdideRZM9W6',
+ ],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'Ids',
+ 'in' => 'query',
+ 'style' => 'json',
+ 'schema' => [
+ 'description' => 'A collection of data masking rules.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The ID of the data masking rule. You can call the [DsgDesensPlanQueryList](~~2786578~~) operation to query the ID of the data masking rule.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => false,
+ 'example' => '123',
+ ],
+ 'required' => true,
+ ],
+ ],
+ [
+ 'name' => 'SceneCode',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The code of the level-1 data masking scenario to which the rule belongs. Valid values:'."\n"
+ ."\n"
+ .'* dataworks_display_desense_code: masking of displayed data in DataStudio and Data Map'."\n"
+ .'* maxcompute_desense_code: data masking at the MaxCompute compute engine layer'."\n"
+ .'* maxcompute_new_desense_code: data masking at the MaxCompute compute engine layer (new)'."\n"
+ .'* hologres_display_desense_code: data masking at the Hologres compute engine layer'."\n"
+ .'* dataworks_data_integration_desense_code: static data masking in Data Integration'."\n"
+ .'* dataworks_analysis_desense_code: masking of displayed data in DataAnalysis'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => 'dataworks_display_desense_code',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => 'OpenApiResultModel<Boolean>',
+ 'description' => 'OpenApiResultModel'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'Success' => [
+ 'description' => 'Indicates whether the request was successful. Valid values:'."\n"
+ ."\n"
+ .'* true'."\n"
+ .'* false'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code.'."\n",
+ 'type' => 'string',
+ 'example' => '1029030003',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message.'."\n",
+ 'type' => 'string',
+ 'example' => 'param error',
+ ],
+ 'HttpStatusCode' => [
+ 'description' => 'The HTTP status code.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '400',
+ ],
+ 'Data' => [
+ 'description' => 'The operation result. Valid values:'."\n"
+ ."\n"
+ .'* true: The operation is successful.'."\n"
+ .'* false: The operation fails.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'RequestId' => [
+ 'description' => 'The request ID. You can locate logs and troubleshoot issues based on the ID.'."\n",
+ 'type' => 'string',
+ 'example' => '102400001',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'errorCodes' => [
+ 400 => [
+ [
+ 'errorCode' => 'PARAMS.ERROR',
+ 'errorMessage' => 'param error.',
+ ],
+ [
+ 'errorCode' => 'DESENSPLAN.DATATYPE.ERROR',
+ 'errorMessage' => 'Sensitive type already has a desensitization rule.',
+ ],
+ [
+ 'errorCode' => 'DESENSPLAN.DATATYPENOTEXIST.ERROR',
+ 'errorMessage' => 'Sensitive type not exist.',
+ ],
+ [
+ 'errorCode' => 'DESENSPLAN.ID.ERROR',
+ 'errorMessage' => 'Desensitization rule ID does not exist.',
+ ],
+ [
+ 'errorCode' => 'DESENSPLAN.PAGESIZE.ERROR',
+ 'errorMessage' => 'Page size is too large, maximum of 100.',
+ ],
+ [
+ 'errorCode' => 'DESENSPLAN.PARAM.ERROR',
+ 'errorMessage' => 'Desensitization rule parameter error.',
+ ],
+ [
+ 'errorCode' => 'DESENSPLAN.SCENECODE.ERROR',
+ 'errorMessage' => 'Scene code does not exist.',
+ ],
+ [
+ 'errorCode' => 'DESENSPLAN.SCENEID.ERROR',
+ 'errorMessage' => 'Scene ID does not exist.',
+ ],
+ [
+ 'errorCode' => 'DESENSPLAN.SCENEIDLEVEL.ERROR',
+ 'errorMessage' => 'The scene is not a secondary scene.',
+ ],
+ [
+ 'errorCode' => 'DESENSPLAN.SIZE.ERROR',
+ 'errorMessage' => 'The number of desens plan exceeds the limit.',
+ ],
+ ],
+ 403 => [
+ [
+ 'errorCode' => 'PERMISSION.DENIED.ERROR',
+ 'errorMessage' => 'Permission denied',
+ ],
+ ],
+ 500 => [
+ [
+ 'errorCode' => 'UNKNOWN.ERROR',
+ 'errorMessage' => 'unknown error.',
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"1029030003\\",\\n \\"ErrorMessage\\": \\"param error\\",\\n \\"HttpStatusCode\\": 400,\\n \\"Data\\": true,\\n \\"RequestId\\": \\"102400001\\"\\n}","errorExample":""},{"type":"xml","example":"<DsgDesensPlanDeleteResponse>\\n <Success>true</Success>\\n <ErrorCode>1029030003</ErrorCode>\\n <ErrorMessage>param error</ErrorMessage>\\n <HttpStatusCode>400</HttpStatusCode>\\n <Data>true</Data>\\n <RequestId>102400001</RequestId>\\n</DsgDesensPlanDeleteResponse>","errorExample":""}]',
+ 'title' => 'DsgDesensPlanDelete',
+ ],
+ 'DsgDesensPlanUpdateStatus' => [
+ 'summary' => 'Modifies the status of a data masking rule.',
+ 'methods' => [
+ 'post',
+ ],
+ 'schemes' => [
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'update',
+ 'abilityTreeCode' => '219619',
+ 'abilityTreeNodes' => [
+ 'FEATUREdideRZM9W6',
+ ],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'Ids',
+ 'in' => 'query',
+ 'style' => 'json',
+ 'schema' => [
+ 'description' => 'A collection of IDs of the data masking rules of which the status you want to modify.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The ID of the data masking rule. You can call the [DsgDesensPlanQueryList](~~2786578~~) operation to query the ID of the data masking rule.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => false,
+ 'example' => '123',
+ ],
+ 'required' => true,
+ ],
+ ],
+ [
+ 'name' => 'SceneCode',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The code of the level-1 data masking scenario to which the rule belongs. Valid values:'."\n"
+ ."\n"
+ .'* dataworks_display_desense_code: masking of displayed data in DataStudio and Data Map'."\n"
+ .'* maxcompute_desense_code: data masking at the MaxCompute compute engine layer'."\n"
+ .'* maxcompute_new_desense_code: data masking at the MaxCompute compute engine layer (new)'."\n"
+ .'* hologres_display_desense_code: data masking at the Hologres compute engine layer'."\n"
+ .'* dataworks_data_integration_desense_code: static data masking in Data Integration'."\n"
+ .'* dataworks_analysis_desense_code: masking of displayed data in DataAnalysis'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => 'dataworks_display_desense_code',
+ ],
+ ],
+ [
+ 'name' => 'Status',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The status of the data masking rule. Valid values:'."\n"
+ ."\n"
+ .'* 0: expired'."\n"
+ .'* 1: effective'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => true,
+ 'example' => '1',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => 'OpenApiResultModel<Boolean>',
+ 'description' => 'OpenApiResultModel'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'Success' => [
+ 'description' => 'Indicates whether the request was successful. Valid values:'."\n"
+ ."\n"
+ .'* true'."\n"
+ .'* false'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code.'."\n",
+ 'type' => 'string',
+ 'example' => '1029030003',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message.'."\n",
+ 'type' => 'string',
+ 'example' => 'param error',
+ ],
+ 'HttpStatusCode' => [
+ 'description' => 'The HTTP status code.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '400',
+ ],
+ 'Data' => [
+ 'description' => 'The operation result. Valid values:'."\n"
+ ."\n"
+ .'* true: The operation is successful.'."\n"
+ .'* false: The operation fails.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'RequestId' => [
+ 'description' => 'The request ID. You can locate logs and troubleshoot issues based on the ID.'."\n",
+ 'type' => 'string',
+ 'example' => '102400001',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'errorCodes' => [
+ 400 => [
+ [
+ 'errorCode' => 'PARAMS.ERROR',
+ 'errorMessage' => 'param error.',
+ ],
+ [
+ 'errorCode' => 'DESENSPLAN.DATATYPE.ERROR',
+ 'errorMessage' => 'Sensitive type already has a desensitization rule.',
+ ],
+ [
+ 'errorCode' => 'DESENSPLAN.DATATYPENOTEXIST.ERROR',
+ 'errorMessage' => 'Sensitive type not exist.',
+ ],
+ [
+ 'errorCode' => 'DESENSPLAN.ID.ERROR',
+ 'errorMessage' => 'Desensitization rule ID does not exist.',
+ ],
+ [
+ 'errorCode' => 'DESENSPLAN.PAGESIZE.ERROR',
+ 'errorMessage' => 'Page size is too large, maximum of 100.',
+ ],
+ [
+ 'errorCode' => 'DESENSPLAN.PARAM.ERROR',
+ 'errorMessage' => 'Desensitization rule parameter error.',
+ ],
+ [
+ 'errorCode' => 'DESENSPLAN.SCENECODE.ERROR',
+ 'errorMessage' => 'Scene code does not exist.',
+ ],
+ [
+ 'errorCode' => 'DESENSPLAN.SCENEID.ERROR',
+ 'errorMessage' => 'Scene ID does not exist.',
+ ],
+ [
+ 'errorCode' => 'DESENSPLAN.SCENEIDLEVEL.ERROR',
+ 'errorMessage' => 'The scene is not a secondary scene.',
+ ],
+ [
+ 'errorCode' => 'DESENSPLAN.SIZE.ERROR',
+ 'errorMessage' => 'The number of desens plan exceeds the limit.',
+ ],
+ ],
+ 403 => [
+ [
+ 'errorCode' => 'PERMISSION.DENIED.ERROR',
+ 'errorMessage' => 'Permission denied',
+ ],
+ ],
+ 500 => [
+ [
+ 'errorCode' => 'UNKNOWN.ERROR',
+ 'errorMessage' => 'unknown error.',
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"1029030003\\",\\n \\"ErrorMessage\\": \\"param error\\",\\n \\"HttpStatusCode\\": 400,\\n \\"Data\\": true,\\n \\"RequestId\\": \\"102400001\\"\\n}","errorExample":""},{"type":"xml","example":"<DsgDesensPlanUpdateStatusResponse>\\n <Success>true</Success>\\n <ErrorCode>1029030003</ErrorCode>\\n <ErrorMessage>param error</ErrorMessage>\\n <HttpStatusCode>400</HttpStatusCode>\\n <Data>true</Data>\\n <RequestId>102400001</RequestId>\\n</DsgDesensPlanUpdateStatusResponse>","errorExample":""}]',
+ 'title' => 'DsgDesensPlanUpdateStatus',
+ ],
+ 'DsgWhiteListQueryList' => [
+ 'summary' => 'Queries a data masking whitelist.',
+ 'methods' => [
+ 'get',
+ ],
+ 'schemes' => [
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'list',
+ 'abilityTreeCode' => '219250',
+ 'abilityTreeNodes' => [
+ 'FEATUREdideRZM9W6',
+ ],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'PageNumber',
+ 'in' => 'query',
+ 'schema' => [
+ 'title' => '页码',
+ 'description' => 'The page number.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => true,
+ 'example' => '1',
+ ],
+ ],
+ [
+ 'name' => 'PageSize',
+ 'in' => 'query',
+ 'schema' => [
+ 'title' => '页大小',
+ 'description' => 'The number of entries per page. Maximum value: 100.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => true,
+ 'example' => '10',
+ ],
+ ],
+ [
+ 'name' => 'SceneId',
+ 'in' => 'query',
+ 'schema' => [
+ 'title' => '二级场景Id',
+ 'description' => 'The ID of the level-2 data masking scenario. You can call the [DsgSceneQuerySceneListByName](~~2786322~~) operation to query the list of IDs.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => true,
+ 'example' => '123',
+ ],
+ ],
+ [
+ 'name' => 'DataType',
+ 'in' => 'query',
+ 'schema' => [
+ 'title' => '敏感类型关键字',
+ 'description' => 'The keyword of the sensitive field type.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'phone',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => 'OpenApiResultModel<PagingResultModel<WhiteListQueryListVO>>',
+ 'description' => 'OpenApiResultModel\\<PagingResultModel>'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'Success' => [
+ 'description' => 'Indicates whether the request was successful. Valid values:'."\n"
+ ."\n"
+ .'* true'."\n"
+ .'* false'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code.'."\n",
+ 'type' => 'string',
+ 'example' => '1029030003',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message.'."\n",
+ 'type' => 'string',
+ 'example' => 'param error',
+ ],
+ 'HttpStatusCode' => [
+ 'description' => 'The HTTP status code.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '400',
+ ],
+ 'PageData' => [
+ 'description' => 'The pagination information.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'PageNumber' => [
+ 'description' => 'The page number.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '1',
+ ],
+ 'PageSize' => [
+ 'description' => 'The number of entries per page.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '10',
+ ],
+ 'TotalCount' => [
+ 'description' => 'The total number of data masking whitelists.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '100',
+ ],
+ 'Data' => [
+ 'description' => 'A collection of whitelists.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '',
+ 'type' => 'object',
+ 'properties' => [
+ 'Id' => [
+ 'description' => 'The ID of the data masking whitelist.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '123',
+ ],
+ 'Type' => [
+ 'description' => 'The sensitive field type.'."\n",
+ 'type' => 'string',
+ 'example' => 'phone',
+ ],
+ 'UserGroups' => [
+ 'description' => 'A collection of user group names.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The name of the user group.'."\n",
+ 'type' => 'string',
+ 'example' => 'test_group',
+ ],
+ ],
+ 'GmtCreate' => [
+ 'description' => 'The time when the whitelist was created.'."\n",
+ 'type' => 'string',
+ 'example' => '2024-05-09 15:46:20',
+ ],
+ 'GmtModified' => [
+ 'description' => 'The time when the whitelist was modified.'."\n",
+ 'type' => 'string',
+ 'example' => '2024-05-09 15:46:20',
+ ],
+ 'RuleId' => [
+ 'description' => 'The ID of the data masking rule.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '123',
+ ],
+ 'SceneId' => [
+ 'description' => 'The ID of the level-2 data masking scenario.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '123',
+ ],
+ 'StartTime' => [
+ 'description' => 'The time when the data masking whitelist takes effect cannot be earlier than the current time. Unit: days.'."\n",
+ 'type' => 'string',
+ 'example' => '2024-05-09 15:46:20',
+ ],
+ 'EndTime' => [
+ 'description' => 'The expiration time of the data masking whitelist cannot be earlier than the time when the data masking whitelist takes effect. Unit: days.'."\n",
+ 'type' => 'string',
+ 'example' => '2024-05-10 15:46:20',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'RequestId' => [
+ 'description' => 'The request ID. You can use the ID to locate logs and troubleshoot issues.'."\n",
+ 'type' => 'string',
+ 'example' => '102400001',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'errorCodes' => [
+ 400 => [
+ [
+ 'errorCode' => 'WHITELIST.DESENSID.ERROR',
+ 'errorMessage' => 'The desensitization rule ID does not match or does not exist with the tenant.',
+ ],
+ [
+ 'errorCode' => 'WHITELIST.ENDTIME.ERROR',
+ 'errorMessage' => 'end time cannot be earlier than start time.',
+ ],
+ [
+ 'errorCode' => 'WHITELIST.ID.ERROR',
+ 'errorMessage' => 'The whitelist ID does not match or does not exist with the tenant.',
+ ],
+ [
+ 'errorCode' => 'WHITELIST.MCPROJECT.ERROR',
+ 'errorMessage' => 'The projectName on the bottom layer desensitization whitelist of MC cannot be empty.',
+ ],
+ [
+ 'errorCode' => 'WHITELIST.PAGESIZE.ERROR',
+ 'errorMessage' => 'Page size is too large, maximum of 100.',
+ ],
+ [
+ 'errorCode' => 'WHITELIST.SIZE.ERROR',
+ 'errorMessage' => 'The number of white list exceeds the limit.',
+ ],
+ [
+ 'errorCode' => 'WHITELIST.STARTTIME.ERROR',
+ 'errorMessage' => 'start time cannot be earlier than today.',
+ ],
+ [
+ 'errorCode' => 'WHITELIST.TIMEFORMAT.ERROR',
+ 'errorMessage' => 'The time format is incorrect, please use yyyy MM dd HH: mm: ss format.',
+ ],
+ [
+ 'errorCode' => 'WHITELIST.USERGROUP.ERROR',
+ 'errorMessage' => 'The user group ID does not match or does not exist with the tenant.',
+ ],
+ [
+ 'errorCode' => 'WHITELIST.USERGROUPEMPTY.ERROR',
+ 'errorMessage' => 'User group ID cannot be empty.',
+ ],
+ [
+ 'errorCode' => 'WHITELIST.USERGROUPLISTSIZE.ERROR',
+ 'errorMessage' => 'The number of user group exceeds the limit.',
+ ],
+ [
+ 'errorCode' => 'PARAMS.ERROR',
+ 'errorMessage' => 'param error.',
+ ],
+ ],
+ 403 => [
+ [
+ 'errorCode' => 'PERMISSION.DENIED.ERROR',
+ 'errorMessage' => 'Permission denied',
+ ],
+ ],
+ 500 => [
+ [
+ 'errorCode' => 'UNKNOWN.ERROR',
+ 'errorMessage' => 'unknown error.',
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"1029030003\\",\\n \\"ErrorMessage\\": \\"param error\\",\\n \\"HttpStatusCode\\": 400,\\n \\"PageData\\": {\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 100,\\n \\"Data\\": [\\n {\\n \\"Id\\": 123,\\n \\"Type\\": \\"phone\\",\\n \\"UserGroups\\": [\\n \\"test_group\\"\\n ],\\n \\"GmtCreate\\": \\"2024-05-09 15:46:20\\",\\n \\"GmtModified\\": \\"2024-05-09 15:46:20\\",\\n \\"RuleId\\": 123,\\n \\"SceneId\\": 123,\\n \\"StartTime\\": \\"2024-05-09 15:46:20\\",\\n \\"EndTime\\": \\"2024-05-10 15:46:20\\"\\n }\\n ]\\n },\\n \\"RequestId\\": \\"102400001\\"\\n}","errorExample":""},{"type":"xml","example":"<DsgWhiteListQueryListResponse>\\n <Success>true</Success>\\n <ErrorCode>1029030003</ErrorCode>\\n <ErrorMessage>param error</ErrorMessage>\\n <HttpStatusCode>400</HttpStatusCode>\\n <PageData>\\n <PageNumber>1</PageNumber>\\n <PageSize>10</PageSize>\\n <TotalCount>100</TotalCount>\\n <Data>\\n <Id>123</Id>\\n <Type>phone</Type>\\n <UserGroups>test_group</UserGroups>\\n <GmtCreate>2024-05-09 15:46:20</GmtCreate>\\n <GmtModified>2024-05-09 15:46:20</GmtModified>\\n <RuleId>123</RuleId>\\n <SceneId>123</SceneId>\\n <StartTime>2024-05-09 15:46:20</StartTime>\\n <EndTime>2024-05-10 15:46:20</EndTime>\\n </Data>\\n </PageData>\\n <RequestId>102400001</RequestId>\\n</DsgWhiteListQueryListResponse>","errorExample":""}]',
+ 'title' => 'DsgWhiteListQueryList',
+ ],
+ 'DsgSceneAddOrUpdateScene' => [
+ 'summary' => 'Adds or modifies a level-2 data masking scenario.',
+ 'methods' => [
+ 'post',
+ ],
+ 'schemes' => [
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'list',
+ 'abilityTreeCode' => '219459',
+ 'abilityTreeNodes' => [
+ 'FEATUREdideRZM9W6',
+ ],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'scenes',
+ 'in' => 'query',
+ 'style' => 'json',
+ 'schema' => [
+ 'description' => 'The information about the level-2 data masking scenario.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The information about the level-2 data masking scenario.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'id' => [
+ 'description' => 'The ID of the level-2 data masking scenario.'."\n"
+ ."\n"
+ .'* If you do not configure this parameter, the current operation is to add a level-2 data masking scenario.'."\n"
+ .'* If you configure this parameter, the current operation is to modify a level-2 data masking scenario. You can call the [DsgSceneQuerySceneListByName](~~2786322~~) operation to query the ID of the level-2 data masking scenario.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => '123',
+ ],
+ 'sceneName' => [
+ 'description' => 'The name of the level-2 data masking scenario.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => 'dev_scene',
+ ],
+ 'sceneCode' => [
+ 'description' => 'The code of the level-1 data masking scenario to which the level-2 data masking scenario belongs. Valid values:'."\n"
+ ."\n"
+ .'* dataworks_display_desense_code: masking of displayed data in DataStudio and Data Map'."\n"
+ .'* maxcompute_desense_code: data masking at the MaxCompute compute engine layer'."\n"
+ .'* maxcompute_new_desense_code: data masking at the MaxCompute compute engine layer (new)'."\n"
+ .'* dataworks_analysis_desense_code: masking of displayed data in DataAnalysis'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => 'dataworks_display_desense_code',
+ ],
+ 'projects' => [
+ 'description' => 'The information about the compute engine for which the data masking scenario takes effect.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The information about the compute engine for which the data masking scenario takes effect.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'clusterId' => [
+ 'description' => 'If the data masking scenario takes effect for an E-MapReduce (EMR) compute engine, enter the ID of an EMR cluster. This parameter is required only when you use an EMR compute engine.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'c-1234',
+ ],
+ 'projectName' => [
+ 'description' => 'The name of the compute engine instance for which the data masking scenario takes effect.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'dev_project',
+ ],
+ 'dbType' => [
+ 'description' => 'The type of the compute engine for which the data masking scenario takes effect. Valid values:'."\n"
+ ."\n"
+ .'* ODPS: ODPS.ODPS'."\n"
+ .'* HOLO: HOLO.POSTGRES'."\n"
+ .'* EMR: EMR'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'ODPS.ODPS',
+ ],
+ ],
+ 'required' => false,
+ ],
+ 'required' => false,
+ ],
+ 'desc' => [
+ 'description' => 'The description.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'Test scenarios',
+ ],
+ 'userGroupIds' => [
+ 'description' => 'The information about the user group for which the data masking scenario takes effect.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The ID of the user group for which the data masking scenario takes effect. You can call the [DsgUserGroupQueryList](~~2786441~~) operation to query the user group ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'example' => '123',
+ ],
+ 'required' => false,
+ ],
+ ],
+ 'required' => false,
+ ],
+ 'required' => true,
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => 'OpenApiResultModel<Boolean>',
+ 'description' => 'OpenApiResultModel'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'Success' => [
+ 'description' => 'Indicates whether the request was successful. Valid values:'."\n"
+ ."\n"
+ .'* true'."\n"
+ .'* false'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code.'."\n",
+ 'type' => 'string',
+ 'example' => '1029030003',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message.'."\n",
+ 'type' => 'string',
+ 'example' => 'param error',
+ ],
+ 'HttpStatusCode' => [
+ 'description' => 'The HTTP status code.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '400',
+ ],
+ 'Data' => [
+ 'description' => 'The operation result.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'RequestId' => [
+ 'description' => 'The request ID. You can use the ID to locate logs and troubleshoot issues.'."\n",
+ 'type' => 'string',
+ 'example' => '102400001',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'errorCodes' => [
+ 400 => [
+ [
+ 'errorCode' => 'DESENSSCENE.ID.ERROR',
+ 'errorMessage' => 'The desensitization scenario ID does not match or does not exist with the tenant.',
+ ],
+ [
+ 'errorCode' => 'DESENSSCENE.IDLEVEL.ERROR',
+ 'errorMessage' => 'The desensitization scenario is not a secondary scenario.',
+ ],
+ [
+ 'errorCode' => 'DESENSSCENE.PROJECT.ERROR',
+ 'errorMessage' => 'The project space does not exist.',
+ ],
+ [
+ 'errorCode' => 'DESENSSCENE.SIZE.ERROR',
+ 'errorMessage' => 'The number of desens scene exceeds the limit.',
+ ],
+ [
+ 'errorCode' => 'DESENSSCENE.UESRGROUP.ERROR',
+ 'errorMessage' => 'The user group ID does not match the tenant or does not exist.',
+ ],
+ [
+ 'errorCode' => 'PARAMS.ERROR',
+ 'errorMessage' => 'param error.',
+ ],
+ ],
+ 403 => [
+ [
+ 'errorCode' => 'PERMISSION.DENIED.ERROR',
+ 'errorMessage' => 'Permission denied',
+ ],
+ ],
+ 500 => [
+ [
+ 'errorCode' => 'UNKNOWN.ERROR',
+ 'errorMessage' => 'unknown error.',
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"1029030003\\",\\n \\"ErrorMessage\\": \\"param error\\",\\n \\"HttpStatusCode\\": 400,\\n \\"Data\\": true,\\n \\"RequestId\\": \\"102400001\\"\\n}","errorExample":""},{"type":"xml","example":"<DsgSceneAddOrUpdateSceneResponse>\\n <Success>true</Success>\\n <ErrorCode>1029030003</ErrorCode>\\n <ErrorMessage>param error</ErrorMessage>\\n <HttpStatusCode>400</HttpStatusCode>\\n <Data>true</Data>\\n <RequestId>102400001</RequestId>\\n</DsgSceneAddOrUpdateSceneResponse>","errorExample":""}]',
+ 'title' => 'DsgSceneAddOrUpdateScene',
+ ],
+ 'DsgSceneQuerySceneListByName' => [
+ 'summary' => 'Queries a list of data masking scenarios.',
+ 'methods' => [
+ 'get',
+ ],
+ 'schemes' => [
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'list',
+ 'abilityTreeCode' => '219224',
+ 'abilityTreeNodes' => [
+ 'FEATUREdideRZM9W6',
+ ],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'SceneName',
+ 'in' => 'query',
+ 'schema' => [
+ 'title' => '场景名称关键字',
+ 'description' => 'The name of the data masking scenario. A fuzzy match is performed in the platform based on a keyword to search for the data masking scenario.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'dev_',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => 'OpenApiResultModel<List<DsgSceneVO>>',
+ 'description' => 'OpenApiResultModel\\<List>'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'Success' => [
+ 'description' => 'Indicates whether the request was successful. Valid values:'."\n"
+ ."\n"
+ .'* true'."\n"
+ .'* false'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code.'."\n",
+ 'type' => 'string',
+ 'example' => '1029030003',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message.'."\n",
+ 'type' => 'string',
+ 'example' => 'param error',
+ ],
+ 'HttpStatusCode' => [
+ 'description' => 'The HTTP status code.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '400',
+ ],
+ 'Data' => [
+ 'description' => 'The returned data.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The returned data.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'Id' => [
+ 'description' => 'The ID of the data masking scenario.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '123',
+ ],
+ 'SceneCode' => [
+ 'description' => 'The code of the level-1 data masking scenario. Valid values:'."\n"
+ ."\n"
+ .'* dataworks_display_desense_code: masking of displayed data in DataStudio and Data Map'."\n"
+ .'* maxcompute_desense_code: data masking at the MaxCompute compute engine layer'."\n"
+ .'* maxcompute_new_desense_code: data masking at the MaxCompute compute engine layer (new)'."\n"
+ .'* hologres_display_desense_code: data masking at the Hologres compute engine layer'."\n"
+ .'* dataworks_data_integration_desense_code: static data masking in Data Integration'."\n"
+ .'* dataworks_analysis_desense_code: masking of displayed data in DataAnalysis'."\n",
+ 'type' => 'string',
+ 'example' => 'dataworks_display_desense_code',
+ ],
+ 'Desc' => [
+ 'description' => 'The description of the data masking scenario.'."\n",
+ 'type' => 'string',
+ 'example' => 'Test scenarios',
+ ],
+ 'SceneName' => [
+ 'description' => 'The name of the data masking scenario.'."\n",
+ 'type' => 'string',
+ 'example' => 'test_scene',
+ ],
+ 'UserGroups' => [
+ 'description' => 'The list of user groups in the data masking scenario. Separate user groups with commas (,).'."\n",
+ 'type' => 'string',
+ 'example' => 'user1,user2',
+ ],
+ 'SceneLevel' => [
+ 'description' => 'The level of the data masking scenario. Valid values:'."\n"
+ ."\n"
+ .'* 0: level-1 data masking scenario'."\n"
+ .'* 1: level-2 data masking scenario'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '1',
+ ],
+ 'Projects' => [
+ 'description' => 'The information about the compute engine for which the data masking scenario takes effect.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The information about the compute engine for which the data masking scenario takes effect.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'DbType' => [
+ 'description' => 'The type of the compute engine. Valid values:'."\n"
+ ."\n"
+ .'* ODPS: ODPS.ODPS'."\n"
+ .'* HOLO: HOLO.POSTGRES'."\n"
+ .'* EMR: EMR'."\n",
+ 'type' => 'string',
+ 'example' => 'ODPS.ODPS',
+ ],
+ 'ProjectName' => [
+ 'description' => 'The name of the compute engine.'."\n",
+ 'type' => 'string',
+ 'example' => 'dev_project',
+ ],
+ 'ClusterId' => [
+ 'description' => 'The ID of the EMR cluster. This parameter is returned only when the data scope that takes effect in the data masking scenario is an EMR compute engine.'."\n",
+ 'type' => 'string',
+ 'example' => 'c-1234',
+ ],
+ ],
+ ],
+ ],
+ 'Children' => [
+ 'description' => 'The information about multiple levels of data masking scenarios.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'If multiple levels of data masking scenarios exist, which indicates that a data masking scenario contains sub-level data masking scenarios, the value of this parameter is the information about the sub-level data masking scenarios. The parameters are the same as the outer parameters.'."\n",
+ 'type' => 'any',
+ 'example' => '$ref',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'RequestId' => [
+ 'description' => 'The request ID. You can locate logs and troubleshoot issues based on the ID.'."\n",
+ 'type' => 'string',
+ 'example' => '102400001',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'errorCodes' => [
+ 400 => [
+ [
+ 'errorCode' => 'DESENSSCENE.ID.ERROR',
+ 'errorMessage' => 'The desensitization scenario ID does not match or does not exist with the tenant.',
+ ],
+ [
+ 'errorCode' => 'DESENSSCENE.IDLEVEL.ERROR',
+ 'errorMessage' => 'The desensitization scenario is not a secondary scenario.',
+ ],
+ [
+ 'errorCode' => 'DESENSSCENE.PROJECT.ERROR',
+ 'errorMessage' => 'The project space does not exist.',
+ ],
+ [
+ 'errorCode' => 'DESENSSCENE.SIZE.ERROR',
+ 'errorMessage' => 'The number of desens scene exceeds the limit.',
+ ],
+ [
+ 'errorCode' => 'DESENSSCENE.UESRGROUP.ERROR',
+ 'errorMessage' => 'The user group ID does not match the tenant or does not exist.',
+ ],
+ [
+ 'errorCode' => 'PARAMS.ERROR',
+ 'errorMessage' => 'param error.',
+ ],
+ ],
+ 403 => [
+ [
+ 'errorCode' => 'PERMISSION.DENIED.ERROR',
+ 'errorMessage' => 'Permission denied',
+ ],
+ ],
+ 500 => [
+ [
+ 'errorCode' => 'UNKNOWN.ERROR',
+ 'errorMessage' => 'unknown error.',
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"1029030003\\",\\n \\"ErrorMessage\\": \\"param error\\",\\n \\"HttpStatusCode\\": 400,\\n \\"Data\\": [\\n {\\n \\"Id\\": 123,\\n \\"SceneCode\\": \\"dataworks_display_desense_code\\",\\n \\"Desc\\": \\"Test scenarios\\",\\n \\"SceneName\\": \\"test_scene\\",\\n \\"UserGroups\\": \\"user1,user2\\",\\n \\"SceneLevel\\": 1,\\n \\"Projects\\": [\\n {\\n \\"DbType\\": \\"ODPS.ODPS\\",\\n \\"ProjectName\\": \\"dev_project\\",\\n \\"ClusterId\\": \\"c-123456\\"\\n }\\n ],\\n \\"Children\\": [\\n \\"$ref\\"\\n ]\\n }\\n ],\\n \\"RequestId\\": \\"102400001\\"\\n}","errorExample":""},{"type":"xml","example":"<DsgSceneQuerySceneListByNameResponse>\\n <Success>true</Success>\\n <ErrorCode>1029030003</ErrorCode>\\n <ErrorMessage>param error</ErrorMessage>\\n <HttpStatusCode>400</HttpStatusCode>\\n <Data>\\n <Id>123</Id>\\n <SceneCode>dataworks_display_desense_code</SceneCode>\\n <Desc>测试用场景</Desc>\\n <SceneName>test_scene</SceneName>\\n <UserGroups>user1,user2</UserGroups>\\n <SceneLevel>1</SceneLevel>\\n <Projects>\\n <DbType>ODPS.ODPS</DbType>\\n <ProjectName>dev_project</ProjectName>\\n <ClusterId>c-1234</ClusterId>\\n </Projects>\\n <Children>$ref</Children>\\n </Data>\\n <RequestId>102400001</RequestId>\\n</DsgSceneQuerySceneListByNameResponse>","errorExample":""}]',
+ 'title' => 'DsgSceneQuerySceneListByName',
+ ],
+ 'DsgUserGroupAddOrUpdate' => [
+ 'summary' => 'Adds or modifies a user group.',
+ 'methods' => [
+ 'post',
+ ],
+ 'schemes' => [
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'list',
+ 'abilityTreeCode' => '219456',
+ 'abilityTreeNodes' => [
+ 'FEATUREdideRZM9W6',
+ ],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'UserGroups',
+ 'in' => 'query',
+ 'style' => 'json',
+ 'schema' => [
+ 'description' => 'The information about the user group.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '',
+ 'type' => 'object',
+ 'properties' => [
+ 'Id' => [
+ 'description' => 'The user group ID.'."\n"
+ ."\n"
+ .'* If you do not configure this parameter, the current operation is to add a user group.'."\n"
+ .'* If you configure this parameter, the current operation is to modify a user group. You can call the [DsgUserGroupQueryList](~~2786441~~) operation to query the user group ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'example' => '123',
+ ],
+ 'Name' => [
+ 'description' => 'The name of the user group.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => 'yun_group',
+ ],
+ 'Owner' => [
+ 'description' => 'The owner of the user group.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => 'user1',
+ ],
+ 'Accounts' => [
+ 'description' => 'The users in the group.'."\n"
+ ."\n"
+ .'* If a user group is created by using an Alibaba Cloud account and a RAM role, you can call the [DsgUserGroupQueryUserList](~~2786445~~) operation to query the users in the group.'."\n"
+ .'* If a user group is created by using a MaxCompute role, you can call the [DsgUserGroupQueryUserList](~~2785695~~) operation to query the users in the group.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The username or MaxCompute role. This parameter must be configured based on the value of the UserGroupType parameter.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'user1',
+ ],
+ 'required' => true,
+ ],
+ 'ProjectName' => [
+ 'description' => 'The name of the MaxCompute project. You must configure this parameter when you create a MaxCompute user group.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'dev_project',
+ ],
+ 'UserGroupType' => [
+ 'description' => 'The type of the user group. Valid values:'."\n"
+ ."\n"
+ .'* 1: Alibaba Cloud account'."\n"
+ .'* 2: RAM role'."\n"
+ .'* 3: MaxCompute role'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => true,
+ 'example' => '1',
+ ],
+ ],
+ 'required' => true,
+ ],
+ 'required' => true,
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => 'OpenApiResultModel<Boolean>',
+ 'description' => 'OpenApiResultModel'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'Success' => [
+ 'description' => 'Indicates whether the request was successful. Valid values:'."\n"
+ ."\n"
+ .'* true'."\n"
+ .'* false'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code.'."\n",
+ 'type' => 'string',
+ 'example' => '1029030003',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message.'."\n",
+ 'type' => 'string',
+ 'example' => 'param error',
+ ],
+ 'HttpStatusCode' => [
+ 'description' => 'The HTTP status code.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '400',
+ ],
+ 'Data' => [
+ 'description' => 'The operation result. Valid values:'."\n"
+ ."\n"
+ .'* true: The operation is successful.'."\n"
+ .'* false: The operation fails.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'RequestId' => [
+ 'description' => 'The request ID. You can use the ID to locate logs and troubleshoot issues.'."\n",
+ 'type' => 'string',
+ 'example' => '102400001',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'errorCodes' => [
+ 400 => [
+ [
+ 'errorCode' => 'USERGROUP.ACCOUNTLISTSIZE.ERROR',
+ 'errorMessage' => 'The number of account exceeds the limit.',
+ ],
+ [
+ 'errorCode' => 'USERGROUP.ID.ERROR',
+ 'errorMessage' => 'The user group ID does not match the tenant or does not exist.',
+ ],
+ [
+ 'errorCode' => 'USERGROUP.LISTSIZE.ERROR',
+ 'errorMessage' => 'The number of user groups exceeds the limit.',
+ ],
+ [
+ 'errorCode' => 'USERGROUP.PAGESIZE.ERROR',
+ 'errorMessage' => 'Page size is too large, maximum of 100.',
+ ],
+ [
+ 'errorCode' => 'USERACCOUNT.OWNER.ERROR',
+ 'errorMessage' => 'User list or owner user does not exist.',
+ ],
+ [
+ 'errorCode' => 'PARAMS.ERROR',
+ 'errorMessage' => 'param error.',
+ ],
+ ],
+ 403 => [
+ [
+ 'errorCode' => 'PERMISSION.DENIED.ERROR',
+ 'errorMessage' => 'Permission denied',
+ ],
+ ],
+ 500 => [
+ [
+ 'errorCode' => 'UNKNOWN.ERROR',
+ 'errorMessage' => 'unknown error.',
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"1029030003\\",\\n \\"ErrorMessage\\": \\"param error\\",\\n \\"HttpStatusCode\\": 400,\\n \\"Data\\": true,\\n \\"RequestId\\": \\"102400001\\"\\n}","errorExample":""},{"type":"xml","example":"<DsgUserGroupAddOrUpdateResponse>\\n <Success>true</Success>\\n <ErrorCode>1029030003</ErrorCode>\\n <ErrorMessage>param error</ErrorMessage>\\n <HttpStatusCode>400</HttpStatusCode>\\n <Data>true</Data>\\n <RequestId>102400001</RequestId>\\n</DsgUserGroupAddOrUpdateResponse>","errorExample":""}]',
+ 'title' => 'DsgUserGroupAddOrUpdate',
+ ],
+ 'DsgUserGroupQueryList' => [
+ 'summary' => 'Queries a list of user groups in Data Security Guard.',
+ 'methods' => [
+ 'get',
+ ],
+ 'schemes' => [
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'list',
+ 'abilityTreeCode' => '219454',
+ 'abilityTreeNodes' => [
+ 'FEATUREdideRZM9W6',
+ ],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'PageNumber',
+ 'in' => 'query',
+ 'schema' => [
+ 'title' => '页码',
+ 'description' => 'The page number.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => true,
+ 'example' => '1',
+ ],
+ ],
+ [
+ 'name' => 'PageSize',
+ 'in' => 'query',
+ 'schema' => [
+ 'title' => '页大小',
+ 'description' => 'The number of entries per page. Maximum value: 100.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => true,
+ 'example' => '10',
+ ],
+ ],
+ [
+ 'name' => 'Name',
+ 'in' => 'query',
+ 'schema' => [
+ 'title' => '用户组名称',
+ 'description' => 'The keyword of the user group name. A fuzzy match is performed based on the keyword to search for the user group.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'yun_group',
+ ],
+ ],
+ [
+ 'name' => 'Owner',
+ 'in' => 'query',
+ 'schema' => [
+ 'title' => '负责人',
+ 'description' => 'The owner of the user group.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'user1',
+ ],
+ ],
+ [
+ 'name' => 'ProjectName',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The name of the compute engine. If you want to query the information about a MaxCompute user group, you need to configure this parameter.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'dev_project',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => 'OpenApiResultModel<PagingResultModel<UserGroupQueryListVO>>',
+ 'description' => 'The response parameters.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'Success' => [
+ 'description' => 'Indicates whether the request was successful. Valid values:'."\n"
+ ."\n"
+ .'* true'."\n"
+ .'* false'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code.'."\n",
+ 'type' => 'string',
+ 'example' => '1029030003',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message.'."\n",
+ 'type' => 'string',
+ 'example' => 'param error',
+ ],
+ 'HttpStatusCode' => [
+ 'description' => 'The HTTP status code.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '400',
+ ],
+ 'PageData' => [
+ 'description' => 'The pagination information.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'PageNumber' => [
+ 'description' => 'The page number.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '1',
+ ],
+ 'PageSize' => [
+ 'description' => 'The number of entries per page. Maximum value: 100.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '10',
+ ],
+ 'TotalCount' => [
+ 'description' => 'The total number of user groups returned.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '100',
+ ],
+ 'Data' => [
+ 'description' => 'The user groups.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '',
+ 'type' => 'object',
+ 'properties' => [
+ 'Accounts' => [
+ 'description' => 'The usernames in the user group.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The username.'."\n",
+ 'type' => 'string',
+ 'example' => 'user1',
+ ],
+ ],
+ 'Id' => [
+ 'description' => 'The user group ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '123',
+ ],
+ 'GmtCreate' => [
+ 'description' => 'The time when the user group was created.'."\n",
+ 'type' => 'string',
+ 'example' => '2024-05-10 17:14:44',
+ ],
+ 'GmtModified' => [
+ 'description' => 'The time when the user group was modified.'."\n",
+ 'type' => 'string',
+ 'example' => '2024-05-10 17:14:44',
+ ],
+ 'Name' => [
+ 'description' => 'The name of the user group.'."\n",
+ 'type' => 'string',
+ 'example' => 'test_group',
+ ],
+ 'Owner' => [
+ 'description' => 'The owner of the user group.'."\n",
+ 'type' => 'string',
+ 'example' => 'user1',
+ ],
+ ],
+ ],
+ 'example' => '',
+ ],
+ ],
+ ],
+ 'RequestId' => [
+ 'description' => 'The request ID.'."\n",
+ 'type' => 'string',
+ 'example' => '102400001',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'errorCodes' => [
+ 400 => [
+ [
+ 'errorCode' => 'PARAMS.ERROR',
+ 'errorMessage' => 'param error.',
+ ],
+ [
+ 'errorCode' => 'USERGROUP.ACCOUNTLISTSIZE.ERROR',
+ 'errorMessage' => 'The number of account exceeds the limit.',
+ ],
+ [
+ 'errorCode' => 'USERGROUP.ID.ERROR',
+ 'errorMessage' => 'The user group ID does not match the tenant or does not exist.',
+ ],
+ [
+ 'errorCode' => 'USERGROUP.LISTSIZE.ERROR',
+ 'errorMessage' => 'The number of user groups exceeds the limit.',
+ ],
+ [
+ 'errorCode' => 'USERGROUP.PAGESIZE.ERROR',
+ 'errorMessage' => 'Page size is too large, maximum of 100.',
+ ],
+ [
+ 'errorCode' => 'USERACCOUNT.OWNER.ERROR',
+ 'errorMessage' => 'User list or owner user does not exist.',
+ ],
+ ],
+ 403 => [
+ [
+ 'errorCode' => 'PERMISSION.DENIED.ERROR',
+ 'errorMessage' => 'Permission denied',
+ ],
+ ],
+ 500 => [
+ [
+ 'errorCode' => 'UNKNOWN.ERROR',
+ 'errorMessage' => 'unknown error.',
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"1029030003\\",\\n \\"ErrorMessage\\": \\"param error\\",\\n \\"HttpStatusCode\\": 400,\\n \\"PageData\\": {\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 100,\\n \\"Data\\": [\\n {\\n \\"Accounts\\": [\\n \\"user1\\"\\n ],\\n \\"Id\\": 123,\\n \\"GmtCreate\\": \\"2024-05-10 17:14:44\\",\\n \\"GmtModified\\": \\"2024-05-10 17:14:44\\",\\n \\"Name\\": \\"test_group\\",\\n \\"Owner\\": \\"user1\\"\\n }\\n ]\\n },\\n \\"RequestId\\": \\"102400001\\"\\n}","errorExample":""},{"type":"xml","example":"<DsgUserGroupQueryListResponse>\\n <Success>true</Success>\\n <ErrorCode>1029030003</ErrorCode>\\n <ErrorMessage>param error</ErrorMessage>\\n <HttpStatusCode>400</HttpStatusCode>\\n <PageData>\\n <PageNumber>1</PageNumber>\\n <PageSize>10</PageSize>\\n <TotalCount>100</TotalCount>\\n <Data>\\n <Accounts>user1</Accounts>\\n <Id>123</Id>\\n <GmtCreate>2024-05-10 17:14:44</GmtCreate>\\n <GmtModified>2024-05-10 17:14:44</GmtModified>\\n <Name>test_group</Name>\\n <Owner>user1</Owner>\\n </Data>\\n </PageData>\\n <RequestId>102400001</RequestId>\\n</DsgUserGroupQueryListResponse>","errorExample":""}]',
+ 'title' => 'DsgUserGroupQueryList',
+ ],
+ 'DsgUserGroupQueryUserList' => [
+ 'summary' => 'Queries a list of users or roles of the current tenant.',
+ 'methods' => [
+ 'get',
+ ],
+ 'schemes' => [
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'list',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeCode' => '219455',
+ 'abilityTreeNodes' => [
+ 'FEATUREdideRZM9W6',
+ ],
+ ],
+ 'parameters' => [],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => 'OpenApiResultModel<List<UserGroupQueryUserListVO>>',
+ 'description' => 'The response parameters.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'Success' => [
+ 'description' => 'Indicates whether the request was successful. Valid values:'."\n"
+ ."\n"
+ .'* true'."\n"
+ .'* false'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code.'."\n",
+ 'type' => 'string',
+ 'example' => '1029030003',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message.'."\n",
+ 'type' => 'string',
+ 'example' => 'param error',
+ ],
+ 'HttpStatusCode' => [
+ 'description' => 'The HTTP status code.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '400',
+ ],
+ 'Data' => [
+ 'description' => 'The returned result.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '',
+ 'type' => 'object',
+ 'properties' => [
+ 'AccountName' => [
+ 'description' => 'The name of the user.'."\n",
+ 'type' => 'string',
+ 'example' => 'user1',
+ ],
+ 'YunAccount' => [
+ 'description' => 'The name of the Alibaba Cloud account or RAM role. The return value of this parameter must be used if the user group is created by using an Alibaba Cloud account or a RAM role.'."\n",
+ 'type' => 'string',
+ 'example' => 'user:user1',
+ ],
+ 'AccountType' => [
+ 'description' => 'The type of the user. Valid values:'."\n"
+ ."\n"
+ .'* 1 to 5: Alibaba Cloud account'."\n"
+ .'* 6: RAM role'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '2',
+ ],
+ 'BaseId' => [
+ 'description' => 'The user ID or role ID.'."\n",
+ 'type' => 'string',
+ 'example' => '234',
+ ],
+ 'ParentAccountId' => [
+ 'description' => 'The parent user ID. This parameter is required if a RAM user is used.'."\n",
+ 'type' => 'string',
+ 'example' => '123',
+ ],
+ ],
+ ],
+ ],
+ 'RequestId' => [
+ 'description' => 'The request ID.'."\n",
+ 'type' => 'string',
+ 'example' => '102400001',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'errorCodes' => [
+ 400 => [
+ [
+ 'errorCode' => 'USERGROUP.ACCOUNTLISTSIZE.ERROR',
+ 'errorMessage' => 'The number of account exceeds the limit.',
+ ],
+ [
+ 'errorCode' => 'USERGROUP.ID.ERROR',
+ 'errorMessage' => 'The user group ID does not match the tenant or does not exist.',
+ ],
+ [
+ 'errorCode' => 'USERGROUP.LISTSIZE.ERROR',
+ 'errorMessage' => 'The number of user groups exceeds the limit.',
+ ],
+ [
+ 'errorCode' => 'USERGROUP.PAGESIZE.ERROR',
+ 'errorMessage' => 'Page size is too large, maximum of 100.',
+ ],
+ [
+ 'errorCode' => 'USERACCOUNT.OWNER.ERROR',
+ 'errorMessage' => 'User list or owner user does not exist.',
+ ],
+ [
+ 'errorCode' => 'PARAMS.ERROR',
+ 'errorMessage' => 'param error.',
+ ],
+ ],
+ 403 => [
+ [
+ 'errorCode' => 'PERMISSION.DENIED.ERROR',
+ 'errorMessage' => 'Permission denied',
+ ],
+ ],
+ 500 => [
+ [
+ 'errorCode' => 'UNKNOWN.ERROR',
+ 'errorMessage' => 'unknown error.',
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"1029030003\\",\\n \\"ErrorMessage\\": \\"param error\\",\\n \\"HttpStatusCode\\": 400,\\n \\"Data\\": [\\n {\\n \\"AccountName\\": \\"user1\\",\\n \\"YunAccount\\": \\"user:user1\\",\\n \\"AccountType\\": 2,\\n \\"BaseId\\": \\"234\\",\\n \\"ParentAccountId\\": \\"123\\"\\n }\\n ],\\n \\"RequestId\\": \\"102400001\\"\\n}","errorExample":""},{"type":"xml","example":"<DsgUserGroupQueryUserListResponse>\\n <Success>true</Success>\\n <ErrorCode>1029030003</ErrorCode>\\n <ErrorMessage>param error</ErrorMessage>\\n <HttpStatusCode>400</HttpStatusCode>\\n <Data>\\n <AccountName>user1</AccountName>\\n <YunAccount>user:user1</YunAccount>\\n <AccountType>2</AccountType>\\n <BaseId>234</BaseId>\\n <ParentAccountId>123</ParentAccountId>\\n </Data>\\n <RequestId>102400001</RequestId>\\n</DsgUserGroupQueryUserListResponse>","errorExample":""}]',
+ 'title' => 'DsgUserGroupQueryUserList',
+ ],
+ 'DsgDesensPlanQueryList' => [
+ 'summary' => 'Queries a list of data masking rules.',
+ 'methods' => [
+ 'get',
+ ],
+ 'schemes' => [
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'list',
+ 'abilityTreeCode' => '219758',
+ 'abilityTreeNodes' => [
+ 'FEATUREdideRZM9W6',
+ ],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'PageNumber',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The page number.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => true,
+ 'example' => '1',
+ ],
+ ],
+ [
+ 'name' => 'PageSize',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The number of entries per page. Maximum value: 100.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => true,
+ 'example' => '10',
+ ],
+ ],
+ [
+ 'name' => 'SceneId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the level-2 data masking scenario. You can call the [DsgSceneQuerySceneListByName](~~2786322~~) operation to query the list of IDs.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => true,
+ 'example' => '123',
+ ],
+ ],
+ [
+ 'name' => 'RuleName',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The name of the sensitive field.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'phone',
+ ],
+ ],
+ [
+ 'name' => 'Owner',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The owner of the data masking rule.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'user1',
+ ],
+ ],
+ [
+ 'name' => 'Status',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The status of the data masking rule. Valid values:'."\n"
+ ."\n"
+ .'* 0: expired'."\n"
+ .'* 1: effective'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => false,
+ 'example' => '1',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => 'OpenApiResultModel<PagingResultModel<DesensPlanQueryListVO>>',
+ 'description' => 'OpenApiResultModel\\<PagingResultModel>'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'Success' => [
+ 'description' => 'Indicates whether the request was successful. Valid values:'."\n"
+ ."\n"
+ .'* true'."\n"
+ .'* false'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code.'."\n",
+ 'type' => 'string',
+ 'example' => '1029030003',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message.'."\n",
+ 'type' => 'string',
+ 'example' => 'param error',
+ ],
+ 'HttpStatusCode' => [
+ 'description' => 'The HTTP status code.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '400',
+ ],
+ 'PageData' => [
+ 'description' => 'The pagination information.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'PageNumber' => [
+ 'description' => 'The page number.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '1',
+ ],
+ 'PageSize' => [
+ 'description' => 'The number of entries per page. Maximum value: 100.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '10',
+ ],
+ 'TotalCount' => [
+ 'description' => 'The number of data masking rules.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '100',
+ ],
+ 'Data' => [
+ 'description' => 'The information about the data masking rule.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '',
+ 'type' => 'object',
+ 'properties' => [
+ 'Id' => [
+ 'title' => '脱敏规则id',
+ 'description' => 'The ID of the data masking rule.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '123',
+ ],
+ 'DataType' => [
+ 'title' => '敏感类型',
+ 'description' => 'The sensitive field type.'."\n",
+ 'type' => 'string',
+ 'example' => 'phone',
+ ],
+ 'RuleName' => [
+ 'title' => '脱敏规则名称',
+ 'description' => 'The name of the data masking rule.'."\n",
+ 'type' => 'string',
+ 'example' => 'phone_hash',
+ ],
+ 'DesensPlan' => [
+ 'title' => '脱敏规则详情',
+ 'description' => 'The details of the data masking rule.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'DesensPlanType' => [
+ 'description' => 'The type of the data masking rule.'."\n",
+ 'type' => 'string',
+ 'example' => 'hash',
+ ],
+ 'ExtParam' => [
+ 'description' => 'The parameters for the data masking rule. For more information about the parameters, see the [DsgDesensPlanAddOrUpdate](~~2786295~~) API reference.'."\n",
+ 'type' => 'object',
+ 'additionalProperties' => [
+ 'type' => 'any',
+ 'example' => '"extParam": { "algo":"MD5", "salt":"5" }',
+ 'description' => 'The details of the data masking rule parameters.'."\n",
+ ],
+ ],
+ ],
+ ],
+ 'Owner' => [
+ 'title' => '负责人',
+ 'description' => 'The owner of the data masking rule.'."\n",
+ 'type' => 'string',
+ 'example' => 'user1',
+ ],
+ 'GmtCreate' => [
+ 'title' => '规则创建时间',
+ 'description' => 'The time when the data masking rule was created.'."\n",
+ 'type' => 'string',
+ 'example' => '2024-05-09 15:46:20',
+ ],
+ 'GmtModified' => [
+ 'title' => '规则修改时间',
+ 'description' => 'The time when the data masking rule was modified.'."\n",
+ 'type' => 'string',
+ 'example' => '2024-05-09 15:46:20',
+ ],
+ 'Status' => [
+ 'title' => '生效状态0/1',
+ 'description' => 'The status of the data masking rule. Valid values:'."\n"
+ ."\n"
+ .'* 0: expired'."\n"
+ .'* 1: effective'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '1',
+ ],
+ 'DesensWay' => [
+ 'title' => '脱敏方式',
+ 'description' => 'The data masking method.'."\n",
+ 'type' => 'string',
+ 'example' => 'HASH',
+ ],
+ 'DesenMode' => [
+ 'title' => '脱敏方式类型',
+ 'description' => 'The type of the data masking method.'."\n",
+ 'type' => 'string',
+ 'example' => 'HASH',
+ ],
+ 'DesensRule' => [
+ 'title' => '脱敏规则',
+ 'description' => 'The data masking rule.'."\n",
+ 'type' => 'string',
+ 'example' => 'HASH',
+ ],
+ 'SceneCode' => [
+ 'title' => '一级场景code',
+ 'description' => 'The code of the level-1 data masking scenario to which the rule belongs. Valid values:'."\n"
+ ."\n"
+ .'* dataworks_display_desense_code: masking of displayed data in DataStudio and Data Map'."\n"
+ .'* maxcompute_desense_code: data masking at the MaxCompute compute engine layer'."\n"
+ .'* maxcompute_new_desense_code: data masking at the MaxCompute compute engine layer (new)'."\n"
+ .'* hologres_display_desense_code: data masking at the Hologres compute engine layer'."\n"
+ .'* dataworks_data_integration_desense_code: static data masking in Data Integration'."\n"
+ .'* dataworks_analysis_desense_code: masking of displayed data in DataAnalysis'."\n",
+ 'type' => 'string',
+ 'example' => 'dataworks_display_desense_code',
+ ],
+ 'CheckWatermark' => [
+ 'title' => '是否插入水印',
+ 'description' => 'Indicates whether a watermark is added. Valid values:'."\n"
+ ."\n"
+ .'* true'."\n"
+ .'* false'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'SceneName' => [
+ 'title' => '二级场景名称',
+ 'description' => 'The name of the level-2 data masking scenario to which the data masking rule belongs.'."\n",
+ 'type' => 'string',
+ 'example' => 'test_scene',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'RequestId' => [
+ 'description' => 'The request ID. You can use the ID to locate logs and troubleshoot issues.'."\n",
+ 'type' => 'string',
+ 'example' => '102400001',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'errorCodes' => [
+ 400 => [
+ [
+ 'errorCode' => 'DESENSPLAN.DATATYPE.ERROR',
+ 'errorMessage' => 'Sensitive type already has a desensitization rule.',
+ ],
+ [
+ 'errorCode' => 'DESENSPLAN.DATATYPENOTEXIST.ERROR',
+ 'errorMessage' => 'Sensitive type not exist.',
+ ],
+ [
+ 'errorCode' => 'DESENSPLAN.ID.ERROR',
+ 'errorMessage' => 'Desensitization rule ID does not exist.',
+ ],
+ [
+ 'errorCode' => 'DESENSPLAN.PAGESIZE.ERROR',
+ 'errorMessage' => 'Page size is too large, maximum of 100.',
+ ],
+ [
+ 'errorCode' => 'DESENSPLAN.PARAM.ERROR',
+ 'errorMessage' => 'Desensitization rule parameter error.',
+ ],
+ [
+ 'errorCode' => 'DESENSPLAN.SCENECODE.ERROR',
+ 'errorMessage' => 'Scene code does not exist.',
+ ],
+ [
+ 'errorCode' => 'DESENSPLAN.SCENEID.ERROR',
+ 'errorMessage' => 'Scene ID does not exist.',
+ ],
+ [
+ 'errorCode' => 'DESENSPLAN.SCENEIDLEVEL.ERROR',
+ 'errorMessage' => 'The scene is not a secondary scene.',
+ ],
+ [
+ 'errorCode' => 'DESENSPLAN.SIZE.ERROR',
+ 'errorMessage' => 'The number of desens plan exceeds the limit.',
+ ],
+ [
+ 'errorCode' => 'PARAMS.ERROR',
+ 'errorMessage' => 'param error.',
+ ],
+ ],
+ 403 => [
+ [
+ 'errorCode' => 'PERMISSION.DENIED.ERROR',
+ 'errorMessage' => 'Permission denied',
+ ],
+ ],
+ 500 => [
+ [
+ 'errorCode' => 'UNKNOWN.ERROR',
+ 'errorMessage' => 'unknown error.',
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"1029030003\\",\\n \\"ErrorMessage\\": \\"param error\\",\\n \\"HttpStatusCode\\": 400,\\n \\"PageData\\": {\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 100,\\n \\"Data\\": [\\n {\\n \\"Id\\": 123,\\n \\"DataType\\": \\"phone\\",\\n \\"RuleName\\": \\"phone_hash\\",\\n \\"DesensPlan\\": {\\n \\"DesensPlanType\\": \\"hash\\",\\n \\"ExtParam\\": {\\n \\"key\\": \\"\\\\\\"extParam\\\\\\": { \\\\\\"algo\\\\\\":\\\\\\"MD5\\\\\\", \\\\\\"salt\\\\\\":\\\\\\"5\\\\\\" }\\"\\n }\\n },\\n \\"Owner\\": \\"user1\\",\\n \\"GmtCreate\\": \\"2024-05-09 15:46:20\\",\\n \\"GmtModified\\": \\"2024-05-09 15:46:20\\",\\n \\"Status\\": 1,\\n \\"DesensWay\\": \\"HASH\\",\\n \\"DesenMode\\": \\"HASH\\",\\n \\"DesensRule\\": \\"HASH\\",\\n \\"SceneCode\\": \\"dataworks_display_desense_code\\",\\n \\"CheckWatermark\\": true,\\n \\"SceneName\\": \\"test_scene\\"\\n }\\n ]\\n },\\n \\"RequestId\\": \\"102400001\\"\\n}","errorExample":""},{"type":"xml","example":"<DsgDesensPlanQueryListResponse>\\n <Success>true</Success>\\n <ErrorCode>1029030003</ErrorCode>\\n <ErrorMessage>param error</ErrorMessage>\\n <HttpStatusCode>400</HttpStatusCode>\\n <PageData>\\n <PageNumber>1</PageNumber>\\n <PageSize>10</PageSize>\\n <TotalCount>100</TotalCount>\\n <Data>\\n <Id>123</Id>\\n <DataType>phone</DataType>\\n <RuleName>phone_hash</RuleName>\\n <DesensPlan>\\n <DesensPlanType>hash</DesensPlanType>\\n <ExtParam>\\n <key>\\"extParam\\": { \\"algo\\":\\"MD5\\", \\"salt\\":\\"5\\" }</key>\\n </ExtParam>\\n </DesensPlan>\\n <Owner>user1</Owner>\\n <GmtCreate>2024-05-09 15:46:20</GmtCreate>\\n <GmtModified>2024-05-09 15:46:20</GmtModified>\\n <Status>1</Status>\\n <DesensWay>HASH</DesensWay>\\n <DesenMode>HASH</DesenMode>\\n <DesensRule>HASH</DesensRule>\\n <SceneCode>dataworks_display_desense_code</SceneCode>\\n <CheckWatermark>true</CheckWatermark>\\n <SceneName>test_scene</SceneName>\\n </Data>\\n </PageData>\\n <RequestId>102400001</RequestId>\\n</DsgDesensPlanQueryListResponse>","errorExample":""}]',
+ 'title' => 'DsgDesensPlanQueryList',
+ ],
+ 'DsgWhiteListAddOrUpdate' => [
+ 'summary' => 'Adds or modifies a data masking whitelist.',
+ 'methods' => [
+ 'post',
+ ],
+ 'schemes' => [
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'list',
+ 'abilityTreeCode' => '219461',
+ 'abilityTreeNodes' => [
+ 'FEATUREdideRZM9W6',
+ ],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'WhiteLists',
+ 'in' => 'query',
+ 'style' => 'json',
+ 'schema' => [
+ 'description' => 'A collection of whitelists.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '',
+ 'type' => 'object',
+ 'properties' => [
+ 'RuleId' => [
+ 'description' => 'The ID of the data masking rule. You can call the [DsgDesensPlanQueryList](~~2786578~~) operation to query the ID of the data masking rule.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => true,
+ 'example' => '123',
+ ],
+ 'Id' => [
+ 'description' => 'The ID of the data masking whitelist.'."\n"
+ ."\n"
+ .'* If you do not configure this parameter, the current operation is to add a data masking whitelist.'."\n"
+ .'* If you configure this parameter, the current operation is to modify a data masking whitelist. You can call the [DsgWhiteListQueryList](~~2786508~~) operation to query the whitelist ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => false,
+ 'example' => '123',
+ ],
+ 'StartTime' => [
+ 'description' => 'The beginning of the time range to query.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => '2024-04-10 00:00:00',
+ ],
+ 'EndTime' => [
+ 'description' => 'The end of the time range to query. If you enter null, the whitelist is valid permanently.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'null',
+ ],
+ 'UserGroupIds' => [
+ 'description' => 'A collection of user group IDs.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The user group ID. You can call the [DsgUserGroupQueryList](~~2786441~~) operation to query the user group ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => false,
+ 'example' => '123',
+ ],
+ 'required' => true,
+ ],
+ ],
+ 'required' => false,
+ ],
+ 'required' => true,
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => 'OpenApiResultModel<Boolean>',
+ 'description' => 'The returned results.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'Success' => [
+ 'description' => 'Indicates whether the request was successful. Valid values:'."\n"
+ ."\n"
+ .'* true'."\n"
+ .'* false'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code.'."\n",
+ 'type' => 'string',
+ 'example' => '1029030003',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message.'."\n",
+ 'type' => 'string',
+ 'example' => 'param error',
+ ],
+ 'HttpStatusCode' => [
+ 'description' => 'The HTTP status code.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '400',
+ ],
+ 'Data' => [
+ 'description' => 'The operation result. Valid values:'."\n"
+ ."\n"
+ .'* true: The operation is successful.'."\n"
+ .'* false: The operation fails.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'RequestId' => [
+ 'description' => 'The request ID. You can locate logs and troubleshoot issues based on the ID.'."\n",
+ 'type' => 'string',
+ 'example' => '102400001',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'errorCodes' => [
+ 400 => [
+ [
+ 'errorCode' => 'WHITELIST.DESENSID.ERROR',
+ 'errorMessage' => 'The desensitization rule ID does not match or does not exist with the tenant.',
+ ],
+ [
+ 'errorCode' => 'WHITELIST.ENDTIME.ERROR',
+ 'errorMessage' => 'end time cannot be earlier than start time.',
+ ],
+ [
+ 'errorCode' => 'WHITELIST.ID.ERROR',
+ 'errorMessage' => 'The whitelist ID does not match or does not exist with the tenant.',
+ ],
+ [
+ 'errorCode' => 'WHITELIST.MCPROJECT.ERROR',
+ 'errorMessage' => 'The projectName on the bottom layer desensitization whitelist of MC cannot be empty.',
+ ],
+ [
+ 'errorCode' => 'WHITELIST.PAGESIZE.ERROR',
+ 'errorMessage' => 'Page size is too large, maximum of 100.',
+ ],
+ [
+ 'errorCode' => 'WHITELIST.SIZE.ERROR',
+ 'errorMessage' => 'The number of white list exceeds the limit.',
+ ],
+ [
+ 'errorCode' => 'WHITELIST.STARTTIME.ERROR',
+ 'errorMessage' => 'start time cannot be earlier than today.',
+ ],
+ [
+ 'errorCode' => 'WHITELIST.TIMEFORMAT.ERROR',
+ 'errorMessage' => 'The time format is incorrect, please use yyyy MM dd HH: mm: ss format.',
+ ],
+ [
+ 'errorCode' => 'WHITELIST.USERGROUP.ERROR',
+ 'errorMessage' => 'The user group ID does not match or does not exist with the tenant.',
+ ],
+ [
+ 'errorCode' => 'WHITELIST.USERGROUPEMPTY.ERROR',
+ 'errorMessage' => 'User group ID cannot be empty.',
+ ],
+ [
+ 'errorCode' => 'WHITELIST.USERGROUPLISTSIZE.ERROR',
+ 'errorMessage' => 'The number of user group exceeds the limit.',
+ ],
+ [
+ 'errorCode' => 'PARAMS.ERROR',
+ 'errorMessage' => 'param error.',
+ ],
+ ],
+ 403 => [
+ [
+ 'errorCode' => 'PERMISSION.DENIED.ERROR',
+ 'errorMessage' => 'Permission denied',
+ ],
+ ],
+ 500 => [
+ [
+ 'errorCode' => 'UNKNOWN.ERROR',
+ 'errorMessage' => 'unknown error.',
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"1029030003\\",\\n \\"ErrorMessage\\": \\"param error\\",\\n \\"HttpStatusCode\\": 400,\\n \\"Data\\": true,\\n \\"RequestId\\": \\"102400001\\"\\n}","errorExample":""},{"type":"xml","example":"<DsgWhiteListAddOrUpdateResponse>\\n <Success>true</Success>\\n <ErrorCode>1029030003</ErrorCode>\\n <ErrorMessage>param error</ErrorMessage>\\n <HttpStatusCode>400</HttpStatusCode>\\n <Data>true</Data>\\n <RequestId>102400001</RequestId>\\n</DsgWhiteListAddOrUpdateResponse>","errorExample":""}]',
+ 'title' => 'DsgWhiteListAddOrUpdate',
+ ],
+ 'DsgQueryDefaultTemplates' => [
+ 'summary' => 'Queries a list of available sensitive field type templates and the data masking rules supported by the templates. You can refer to the response parameters of this operation to configure a data masking rule.',
+ 'methods' => [
+ 'get',
+ ],
+ 'schemes' => [
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'list',
+ 'abilityTreeCode' => '219249',
+ 'abilityTreeNodes' => [
+ 'FEATUREdideRZM9W6',
+ ],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'SceneId',
+ 'in' => 'query',
+ 'schema' => [
+ 'title' => '二级场景id',
+ 'description' => 'The ID of the level-2 data masking scenario. You can call the [DsgSceneQuerySceneListByName](~~2786322~~) operation to query the list of IDs.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => true,
+ 'example' => '123',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => 'OpenApiResultModel<List<QueryDefaultTemplatesVO>>',
+ 'description' => 'OpenApiResultModel\\<List>'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'Success' => [
+ 'description' => 'Indicates whether the request was successful. Valid values:'."\n"
+ ."\n"
+ .'* true'."\n"
+ .'* false'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code.'."\n",
+ 'type' => 'string',
+ 'example' => '1029030003',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message.'."\n",
+ 'type' => 'string',
+ 'example' => 'param error',
+ ],
+ 'HttpStatusCode' => [
+ 'description' => 'The HTTP status code.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '400',
+ ],
+ 'Data' => [
+ 'description' => 'The data returned.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '',
+ 'type' => 'object',
+ 'properties' => [
+ 'DataType' => [
+ 'description' => 'The sensitive field type.'."\n",
+ 'type' => 'string',
+ 'example' => 'phone',
+ ],
+ 'DesensPlanTemplate' => [
+ 'description' => 'The supported data masking methods and parameter descriptions.'."\n",
+ 'type' => 'object',
+ 'additionalProperties' => [
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'Name' => [
+ 'type' => 'string',
+ 'example' => 'hash',
+ 'description' => 'The name of the data masking method.'."\n",
+ ],
+ 'SupportWaterMark' => [
+ 'type' => 'boolean',
+ 'example' => 'true',
+ 'description' => 'Indicates whether a watermark is added. Valid values:'."\n"
+ ."\n"
+ .'* true: allow'."\n"
+ .'* false: disallow'."\n",
+ ],
+ 'ExtParamTemplate' => [
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'any',
+ 'description' => 'The supported data masking rules and related parameter configurations, which are in the JSON format. The returned results are used to describe the parameters of a data masking rule. You cannot use the results as input parameters to create or modify a data masking rule.'."\n",
+ 'example' => '{ "key": "algo", "valueEnum": [ "MD5", "SHA256", "SHA512", "SM3" ], "valueType": "string" }, { "key": "salt", "valueEnum": [ 1, 2, 3, 4, 5, 6, 7, 8, 9 ], "valueType": "int" }',
+ ],
+ 'description' => 'The data masking parameters and their descriptions.'."\n",
+ ],
+ ],
+ 'description' => '',
+ ],
+ 'description' => 'The information about the data masking method and parameters.'."\n",
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'RequestId' => [
+ 'description' => 'The request ID. You can use the ID to locate logs and troubleshoot issues.'."\n",
+ 'type' => 'string',
+ 'example' => '102400001',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'errorCodes' => [
+ 400 => [
+ [
+ 'errorCode' => 'DESENSTEMPLATE.SCENE.ERROR',
+ 'errorMessage' => 'Scene ID does not exist.',
+ ],
+ [
+ 'errorCode' => 'DESENSTEMPLATE.SCENELEVEL.ERROR',
+ 'errorMessage' => 'The scene is not a secondary scene.',
+ ],
+ [
+ 'errorCode' => 'PARAMS.ERROR',
+ 'errorMessage' => 'param error.',
+ ],
+ ],
+ 403 => [
+ [
+ 'errorCode' => 'PERMISSION.DENIED.ERROR',
+ 'errorMessage' => 'Permission denied',
+ ],
+ ],
+ 500 => [
+ [
+ 'errorCode' => 'UNKNOWN.ERROR',
+ 'errorMessage' => 'unknown error.',
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"1029030003\\",\\n \\"ErrorMessage\\": \\"param error\\",\\n \\"HttpStatusCode\\": 400,\\n \\"Data\\": [\\n {\\n \\"DataType\\": \\"phone\\",\\n \\"DesensPlanTemplate\\": {\\n \\"key\\": [\\n {\\n \\"Name\\": \\"hash\\",\\n \\"SupportWaterMark\\": true,\\n \\"ExtParamTemplate\\": [\\n \\"{ \\\\\\"key\\\\\\": \\\\\\"algo\\\\\\", \\\\\\"valueEnum\\\\\\": [ \\\\\\"MD5\\\\\\", \\\\\\"SHA256\\\\\\", \\\\\\"SHA512\\\\\\", \\\\\\"SM3\\\\\\" ], \\\\\\"valueType\\\\\\": \\\\\\"string\\\\\\" }, { \\\\\\"key\\\\\\": \\\\\\"salt\\\\\\", \\\\\\"valueEnum\\\\\\": [ 1, 2, 3, 4, 5, 6, 7, 8, 9 ], \\\\\\"valueType\\\\\\": \\\\\\"int\\\\\\" }\\"\\n ]\\n }\\n ]\\n }\\n }\\n ],\\n \\"RequestId\\": \\"102400001\\"\\n}","errorExample":""},{"type":"xml","example":"<DsgQueryDefaultTemplatesResponse>\\n <Success>true</Success>\\n <ErrorCode>1029030003</ErrorCode>\\n <ErrorMessage>param error</ErrorMessage>\\n <HttpStatusCode>400</HttpStatusCode>\\n <Data>\\n <DataType>phone</DataType>\\n <DesensPlanTemplate>\\n <Name>hash</Name>\\n <SupportWaterMark>true</SupportWaterMark>\\n <ExtParamTemplate>{ \\"key\\": \\"algo\\", \\"valueEnum\\": [ \\"MD5\\", \\"SHA256\\", \\"SHA512\\", \\"SM3\\" ], \\"valueType\\": \\"string\\" }, { \\"key\\": \\"salt\\", \\"valueEnum\\": [ 1, 2, 3, 4, 5, 6, 7, 8, 9 ], \\"valueType\\": \\"int\\" }</ExtParamTemplate>\\n </DesensPlanTemplate>\\n </Data>\\n <RequestId>102400001</RequestId>\\n</DsgQueryDefaultTemplatesResponse>","errorExample":""}]',
+ 'title' => 'DsgQueryDefaultTemplates',
+ ],
+ 'CreateImportMigration' => [
+ 'methods' => [
+ 'post',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'readAndWrite',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'update',
+ 'abilityTreeCode' => '78187',
+ 'abilityTreeNodes' => [
+ 'FEATUREdide8FM783',
+ ],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'ProjectId',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The DataWorks workspace ID. You can log on to the DataWorks console and go to the Workspace page to obtain the workspace ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => true,
+ 'docRequired' => true,
+ 'minimum' => '2',
+ 'example' => '123456',
+ ],
+ ],
+ [
+ 'name' => 'Name',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The name of the import task. The name must be unique within the workspace.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'test_import_001',
+ ],
+ ],
+ [
+ 'name' => 'PackageType',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The type of the import package. Valid values:'."\n"
+ ."\n"
+ .'* DATAWORKS_MODEL (standard format)'."\n"
+ .'* DATAWORKS_V2 (Apsara Stack DataWorks V3.6.1 to V3.11)'."\n"
+ .'* DATAWORKS_V3 (Apsara Stack DataWorks V3.12 and later)'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'DATAWORKS_MODEL',
+ 'enum' => [
+ 'DATAWORKS_MODEL',
+ 'DATAWOKRS_V2',
+ 'DATAWORKS_V3',
+ 'SPEC',
+ ],
+ ],
+ ],
+ [
+ 'name' => 'PackageFile',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The path of the import package. **The import package must be uploaded. Example of the upload method:**'."\n"
+ ."\n"
+ .'```java'."\n"
+ .' Config config = new Config();'."\n"
+ .' config.setAccessKeyId(accessId);'."\n"
+ .' config.setAccessKeySecret(accessKey);'."\n"
+ .' config.setEndpoint(popEndpoint);'."\n"
+ .' config.setRegionId(regionId);'."\n"
+ ."\n"
+ .' Client client = new Client(config);'."\n"
+ ."\n"
+ .' CreateImportMigrationAdvanceRequest request = new CreateImportMigrationAdvanceRequest();'."\n"
+ .' request.setName("test_migration_api_" + System.currentTimeMillis());'."\n"
+ .' request.setProjectId(123456L); '."\n"
+ .' request.setPackageType("DATAWORKS_MODEL");'."\n"
+ .' request.setPackageFileObject(new FileInputStream("/home/admin/Downloads/test.zip"));'."\n"
+ ."\n"
+ .' RuntimeOptions runtime = new RuntimeOptions();'."\n"
+ .' CreateImportMigrationResponse response = client.createImportMigrationAdvance(request, runtime);'."\n"
+ .'```'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => '/home/admin/xxx/import.zip',
+ 'isFileTransferUrl' => true,
+ ],
+ ],
+ [
+ 'name' => 'ResourceGroupMap',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The mapping between the resource group for scheduling and the resource group for Data Integration. The keys and values in the mapping are the identifiers of the resource groups. Specify the mapping in the following format:'."\n"
+ ."\n"
+ .'```json'."\n"
+ .'{'."\n"
+ .' "SCHEDULER_RESOURCE_GROUP": {'."\n"
+ .' "xxx": "yyy"'."\n"
+ .' },'."\n"
+ .' "DI_RESOURCE_GROUP": {'."\n"
+ .' "ccc": "dfdd"'."\n"
+ .' }'."\n"
+ .'}'."\n"
+ .'```'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'docRequired' => false,
+ 'example' => '{"SCHEDULER_RESOURCE_GROUP": {"xxx":"yyy"},"DI_RESOURCE_GROUP":{"ccc":"ddd"}}',
+ ],
+ ],
+ [
+ 'name' => 'WorkspaceMap',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The mapping between the prefixes for the names of the source and destination workspaces. When the system performs the import operation, the prefix for the name of the source workspace in the import package is replaced based on the mapping.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'docRequired' => false,
+ 'example' => '{"test_workspace_src": "test_workspace_target"}',
+ ],
+ ],
+ [
+ 'name' => 'CalculateEngineMap',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The mapping between the source compute engine instance and the destination compute engine instance. The following types of compute engine instances are supported: MaxCompute, E-MapReduce (EMR), Hadoop CDH, and Hologres.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'docRequired' => true,
+ 'example' => '{ "ODPS": { "zxy_8221431_engine": "wzp_kaifazheban_engine" }, "EMR": { "aaaa": "bbb" } }',
+ ],
+ ],
+ [
+ 'name' => 'CommitRule',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The rule configured for automatically committing and deploying the import task. The rule contains the following parameters:'."\n"
+ ."\n"
+ .'* resourceAutoCommit: specifies whether resources are automatically committed. The value true indicates yes and the value false indicates no.'."\n"
+ .'* resourceAutoDeploy: specifies whether resources are automatically deployed. The value true indicates yes and the value false indicates no.'."\n"
+ .'* functionAutoCommit: specifies whether the function is automatically committed. The value true indicates yes and the value false indicates no.'."\n"
+ .'* functionAutoDeploy: specifies whether the function is automatically deployed. The value true indicates yes and the value false indicates no.'."\n"
+ .'* tableAutoCommitToDev: specifies whether the table is automatically committed to the development environment. The value true indicates yes and the value false indicates no.'."\n"
+ .'* tableAutoCommitToProd: specifies whether the table is automatically committed to the production environment. The value true indicates yes and the value false indicates no.'."\n"
+ .'* ignoreLock: specifies whether the lock is automatically ignored when an import task is locked. The value true indicates yes and the value false indicates no. If you set this parameter to true for an import task, you can forcefully update the task even if the task is locked.'."\n"
+ .'* fileAutoCommit: specifies whether the file is automatically committed. The value true indicates yes and the value false indicates no.'."\n"
+ .'* fileAutoDeploy: specifies whether the file is automatically deployed. The value true indicates yes and the value false indicates no.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'docRequired' => true,
+ 'example' => '{ "resourceAutoCommit": false, "resourceAutoDeploy": false, "functionAutoCommit": false, "functionAutoDeploy": false, "tableAutoCommitToDev": false, "tableAutoCommitToProd": false, "ignoreLock": false, "fileAutoCommit": false, "fileAutoDeploy": false }',
+ ],
+ ],
+ [
+ 'name' => 'Description',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The description of the import package.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'docRequired' => false,
+ 'example' => 'test description',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'description' => 'The returned data.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'HttpStatusCode' => [
+ 'description' => 'The HTTP status code.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '200',
+ ],
+ 'Data' => [
+ 'description' => 'The import task ID. The ID is used as an input parameter if you want the system to run the import task or you want to obtain the running progress of the import task.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '123456',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message.'."\n",
+ 'type' => 'string',
+ 'example' => 'test error message',
+ ],
+ 'RequestId' => [
+ 'description' => 'The request ID. You can locate logs and troubleshoot issues based on the ID.'."\n",
+ 'type' => 'string',
+ 'example' => 'ADFASDFASDFA-ADFASDF-ASDFADSDF-AFFADS',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code.'."\n",
+ 'type' => 'string',
+ 'example' => '110001123456',
+ ],
+ 'Success' => [
+ 'description' => 'Indicates whether the request was successful.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Data\\": 123456,\\n \\"ErrorMessage\\": \\"test error message\\",\\n \\"RequestId\\": \\"ADFASDFASDFA-ADFASDF-ASDFADSDF-AFFADS\\",\\n \\"ErrorCode\\": \\"110001123456\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<CreateImportMigrationResponse>\\n <HttpStatusCode>200</HttpStatusCode>\\n <Data>123456</Data>\\n <ErrorMessage>test error message</ErrorMessage>\\n <RequestId>ADFASDFASDFA-ADFASDF-ASDFADSDF-AFFADS</RequestId>\\n <ErrorCode>110001123456</ErrorCode>\\n <Success>true</Success>\\n</CreateImportMigrationResponse>","errorExample":""}]',
+ 'title' => 'CreateImportMigration',
+ 'summary' => 'Creates an import task. The import task contains the import packages of data sources, nodes, and tables.',
+ 'description' => 'The import package must be uploaded. Example of the upload method:'."\n"
+ ."\n"
+ .' Config config = new Config();'."\n"
+ .' config.setAccessKeyId(accessId);'."\n"
+ .' config.setAccessKeySecret(accessKey);'."\n"
+ .' config.setEndpoint(popEndpoint);'."\n"
+ .' config.setRegionId(regionId);'."\n"
+ .' '."\n"
+ .' Client client = new Client(config);'."\n"
+ ."\n"
+ .' CreateImportMigrationAdvanceRequest request = new CreateImportMigrationAdvanceRequest();'."\n"
+ .' request.setName("test_migration_api_" + System.currentTimeMillis());'."\n"
+ .' request.setProjectId(123456L); '."\n"
+ .' request.setPackageType("DATAWORKS_MODEL");'."\n"
+ .' request.setPackageFileObject(new FileInputStream("/home/admin/Downloads/test.zip"));'."\n"
+ ."\n"
+ .' RuntimeOptions runtime = new RuntimeOptions();'."\n"
+ .' CreateImportMigrationResponse response = client.createImportMigrationAdvance(request, runtime);'."\n"
+ .' ...'."\n",
+ 'requestParamsDescription' => ' ',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ ],
+ 'GetMigrationProcess' => [
+ 'methods' => [
+ 'post',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'none',
+ 'abilityTreeCode' => '78271',
+ 'abilityTreeNodes' => [
+ 'FEATUREdide8FM783',
+ ],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'ProjectId',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The workspace ID. You can log on to the DataWorks console and go to the Workspace page to query the ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => true,
+ 'docRequired' => true,
+ 'minimum' => '2',
+ 'example' => '123456',
+ ],
+ ],
+ [
+ 'name' => 'MigrationId',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The migration package ID. You can call the CreateImportMigration operation to query the ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => true,
+ 'docRequired' => true,
+ 'minimum' => '1',
+ 'example' => '123456',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'description' => 'The response parameters.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'HttpStatusCode' => [
+ 'description' => 'The HTTP status code.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '200',
+ ],
+ 'RequestId' => [
+ 'description' => 'The request ID.'."\n",
+ 'type' => 'string',
+ 'example' => 'SADFSDFSD-SDFSDF-XDXCVX-ESWW',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message.'."\n",
+ 'type' => 'string',
+ 'example' => 'test error msg',
+ ],
+ 'Success' => [
+ 'description' => 'Indicates whether the request was successful.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code.'."\n",
+ 'type' => 'string',
+ 'example' => '110001123456',
+ ],
+ 'Data' => [
+ 'description' => 'The progress information of the migration task, including the names of all steps in and status of the migration task.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '',
+ 'type' => 'object',
+ 'properties' => [
+ 'TaskStatus' => [
+ 'description' => 'The running status of the step in the migration task. Valid values:'."\n"
+ ."\n"
+ .'* INIT'."\n"
+ .'* RUNNING'."\n"
+ .'* FAILURE'."\n"
+ .'* SUCCESS'."\n",
+ 'type' => 'string',
+ 'example' => 'SUCCESS',
+ ],
+ 'TaskName' => [
+ 'description' => 'The name of the step in the migration task.'."\n",
+ 'type' => 'string',
+ 'example' => 'IMPORE_PREPARE',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"SADFSDFSD-SDFSDF-XDXCVX-ESWW\\",\\n \\"ErrorMessage\\": \\"test error msg\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"110001123456\\",\\n \\"Data\\": [\\n {\\n \\"TaskStatus\\": \\"SUCCESS\\",\\n \\"TaskName\\": \\"IMPORE_PREPARE\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<GetMigrationProcessResponse>\\n <HttpStatusCode>200</HttpStatusCode>\\n <RequestId>SADFSDFSD-SDFSDF-XDXCVX-ESWW</RequestId>\\n <ErrorMessage>test error msg</ErrorMessage>\\n <Success>true</Success>\\n <ErrorCode>110001123456</ErrorCode>\\n <Data>\\n <TaskStatus>SUCCESS</TaskStatus>\\n <TaskName>IMPORE_PREPARE</TaskName>\\n </Data>\\n</GetMigrationProcessResponse>","errorExample":""}]',
+ 'title' => 'GetMigrationProcess',
+ 'summary' => 'Queries the progress of a migration task.',
+ 'requestParamsDescription' => ' ',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ ],
+ 'StartMigration' => [
+ 'methods' => [
+ 'post',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'readAndWrite',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'update',
+ 'abilityTreeCode' => '78357',
+ 'abilityTreeNodes' => [
+ 'FEATUREdide8FM783',
+ ],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'ProjectId',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The workspace ID. You can log on to the DataWorks console and go to the Workspace page to obtain the workspace ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => true,
+ 'docRequired' => true,
+ 'minimum' => '2',
+ 'example' => '123456',
+ ],
+ ],
+ [
+ 'name' => 'MigrationId',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The migration package ID. You can call the [CreateImportMigration](~~206094~~) operation to query the ID of the import package and call the [CreateExportMigration](~~349325~~) operation to query the ID of the export package.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => true,
+ 'docRequired' => true,
+ 'minimum' => '2',
+ 'example' => '123456',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'HttpStatusCode' => [
+ 'description' => 'The HTTP status code.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '200',
+ ],
+ 'Data' => [
+ 'description' => 'Indicates whether the migration task is started. Valid values:'."\n"
+ ."\n"
+ .'* true: The migration task is started.'."\n"
+ .'* false: The migration task fails to be started.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message.'."\n",
+ 'type' => 'string',
+ 'example' => 'test error msg',
+ ],
+ 'RequestId' => [
+ 'description' => 'The request ID.'."\n",
+ 'type' => 'string',
+ 'example' => 'FSDFSDF-WERWER-XVCX-DSFSDF',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code.'."\n",
+ 'type' => 'string',
+ 'example' => '110001123445',
+ ],
+ 'Success' => [
+ 'description' => 'Indicates whether the request was successful.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ ],
+ 'description' => '',
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Data\\": true,\\n \\"ErrorMessage\\": \\"test error msg\\",\\n \\"RequestId\\": \\"FSDFSDF-WERWER-XVCX-DSFSDF\\",\\n \\"ErrorCode\\": \\"110001123445\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<StartMigrationResponse>\\n <HttpStatusCode>200</HttpStatusCode>\\n <Data>true</Data>\\n <ErrorMessage>test error msg</ErrorMessage>\\n <RequestId>FSDFSDF-WERWER-XVCX-DSFSDF</RequestId>\\n <ErrorCode>110001123445</ErrorCode>\\n <Success>true</Success>\\n</StartMigrationResponse>","errorExample":""}]',
+ 'title' => 'StartMigration',
+ 'summary' => 'Starts a migration task.',
+ 'requestParamsDescription' => ' ',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ ],
+ 'CreateExportMigration' => [
+ 'summary' => 'Creates an export task. You can use this operation to create an export task but cannot use this operation to start the created export task.',
+ 'methods' => [
+ 'post',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'readAndWrite',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'none',
+ 'abilityTreeCode' => '86657',
+ 'abilityTreeNodes' => [
+ 'FEATUREdide8FM783',
+ ],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'ProjectId',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The DataWorks workspace ID. You can log on to the [DataWorks console](https://workbench.data.aliyun.com/console) and go to the Workspace page to obtain the workspace ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => true,
+ 'example' => '12345',
+ ],
+ ],
+ [
+ 'name' => 'Name',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The name of the export task.'."\n"
+ ."\n"
+ .'The name of each export task must be unique. You must ensure that no duplicate export task exists in the current workspace.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => 'test_export_01',
+ ],
+ ],
+ [
+ 'name' => 'ExportMode',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The export mode of the export task. Valid values:'."\n"
+ ."\n"
+ .'* FULL: The export task is used to export all data objects.'."\n"
+ .'* INCREMENTAL: The export task is used to export data objects that were modified since the specified point in time. If you set this parameter to INCREMENTAL, you must configure the IncrementalSince parameter.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => 'FULL',
+ 'enum' => [
+ 'FULL',
+ 'INCREMENTAL',
+ ],
+ ],
+ ],
+ [
+ 'name' => 'IncrementalSince',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The start time of the incremental export task.'."\n"
+ ."\n"
+ .'The IncrementalSince parameter takes effect only when the ExportMode parameter is set to INCREMENTAL.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'example' => '1589904000000',
+ ],
+ ],
+ [
+ 'name' => 'ExportObjectStatus',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The status of the data objects that you want to export in the export task. The system exports data objects in the state that is specified by this parameter. Valid values:'."\n"
+ ."\n"
+ .'* SAVED'."\n"
+ .'* SUBMITTED'."\n"
+ .'* DEPLOYED'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'SAVED',
+ 'default' => 'SAVED',
+ 'enum' => [
+ 'SAVED',
+ 'SUBMITTED',
+ 'DEPLOYED',
+ ],
+ ],
+ ],
+ [
+ 'name' => 'Description',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The description of the export task.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'test',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'description' => 'The returned result.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'description' => 'The request ID. You can locate logs and troubleshoot issues based on the ID.'."\n",
+ 'type' => 'string',
+ 'example' => '34267E2E-0335-1A60-A1F0-ADA530890CBA',
+ ],
+ 'Data' => [
+ 'description' => 'The export task ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '1234',
+ ],
+ 'Success' => [
+ 'description' => 'Indicates whether the request was successful. Valid values:'."\n"
+ ."\n"
+ .'* true'."\n"
+ .'* false'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"34267E2E-0335-1A60-A1F0-ADA530890CBA\\",\\n \\"Data\\": 1234,\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<CreateExportMigrationResponse>\\n <RequestId>34267E2E-0335-1A60-A1F0-ADA530890CBA</RequestId>\\n <Data>1234</Data>\\n <Success>true</Success>\\n</CreateExportMigrationResponse>","errorExample":""}]',
+ 'title' => 'CreateExportMigration',
+ ],
+ 'GetMigrationSummary' => [
+ 'summary' => 'Queries the information about a migration task.',
+ 'methods' => [
+ 'post',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'none',
+ 'abilityTreeCode' => '86668',
+ 'abilityTreeNodes' => [
+ 'FEATUREdide8FM783',
+ ],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'ProjectId',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The DataWorks workspace ID. You can log on to the [DataWorks console](https://workbench.data.aliyun.com/console) and go to the Workspace page to obtain the workspace ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => true,
+ 'docRequired' => true,
+ 'minimum' => '2',
+ 'example' => '12345',
+ ],
+ ],
+ [
+ 'name' => 'MigrationId',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The migration task ID.'."\n"
+ ."\n"
+ .'You can call the [CreateImportMigration](~~2780280~~) operation to obtain the ID of the import task and call the [CreateExportMigration](~~2780281~~) operation to obtain the ID of the export task.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => true,
+ 'docRequired' => true,
+ 'minimum' => '1',
+ 'example' => '1234',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'description' => 'The response parameters.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'description' => 'The request ID. You can use the request ID to query logs and troubleshoot issues.'."\n",
+ 'type' => 'string',
+ 'example' => '19999A96-71BA-2845-B455-ED620EF4E37F',
+ ],
+ 'Success' => [
+ 'description' => 'Indicates whether the request was successful. Valid values:'."\n"
+ ."\n"
+ .'* true'."\n"
+ .'* false'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'Data' => [
+ 'description' => 'The details of the migration task.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'MigrationId' => [
+ 'description' => 'The task ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '1234',
+ ],
+ 'Name' => [
+ 'description' => 'The task name.'."\n",
+ 'type' => 'string',
+ 'example' => 'test_export_01',
+ ],
+ 'GmtCreate' => [
+ 'description' => 'The time when the task was created.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '1589904000000',
+ ],
+ 'GmtModified' => [
+ 'description' => 'The time when the task was modified.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '1589904000000',
+ ],
+ 'CreateUser' => [
+ 'description' => 'The ID of the user who created the task.'."\n",
+ 'type' => 'string',
+ 'example' => '982293332403****',
+ ],
+ 'OpUser' => [
+ 'description' => 'The ID of the user who managed the task.'."\n",
+ 'type' => 'string',
+ 'example' => '982293332403****',
+ ],
+ 'Status' => [
+ 'description' => 'The status of the migration task. Valid values:'."\n"
+ ."\n"
+ .'* INIT'."\n"
+ .'* EDITING'."\n"
+ .'* IMPORTING'."\n"
+ .'* IMPORT_ERROR'."\n"
+ .'* IMPORT_SUCCESS'."\n"
+ .'* EXPORTING'."\n"
+ .'* EXPORT_ERROR'."\n"
+ .'* EXPORT_SUCCESS'."\n"
+ .'* REVOKED'."\n"
+ .'* PARTIAL_SUCCESS'."\n",
+ 'type' => 'string',
+ 'example' => 'EXPORT_SUCCESS',
+ ],
+ 'ProjectId' => [
+ 'description' => 'The ID of the DataWorks workspace to which the migration task belongs.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '12345',
+ ],
+ 'DownloadUrl' => [
+ 'description' => 'The URL that is used to download the package of the export task. You can use the URL to download the package of the export task.'."\n",
+ 'type' => 'string',
+ 'example' => 'https://shanghai-xxx-oss.oss-cn-shanghai.aliyuncs.com/pre/store/f10_bf47_b4fa7df0860f.zip?Expires=1639540903&OSSAccessKeyId=XXXXXXeF4Lv5j&Signature=qxxxxx',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"19999A96-71BA-1845-B455-ED620EF4E37F\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"MigrationId\\": 1234,\\n \\"Name\\": \\"test_export_01\\",\\n \\"GmtCreate\\": 1589904000000,\\n \\"GmtModified\\": 1589904000000,\\n \\"CreateUser\\": \\"982293332403****\\",\\n \\"OpUser\\": \\"982293332403****\\",\\n \\"Status\\": \\"EXPORT_SUCCESS\\",\\n \\"ProjectId\\": 12345,\\n \\"DownloadUrl\\": \\"https://shanghai-xxx-oss.oss-cn-shanghai.aliyuncs.com/pre/store/f10_bf47_b4fa7df0860f.zip?Expires=1639540903&OSSAccessKeyId=****&Signature=qxxxxx\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"<GetMigrationSummaryResponse>\\n <RequestId>19999A96-71BA-1845-B455-ED620EF4E37F</RequestId>\\n <Success>true</Success>\\n <Data>\\n <MigrationId>1234</MigrationId>\\n <Name>test_export_01</Name>\\n <GmtCreate>1589904000000</GmtCreate>\\n <GmtModified>1589904000000</GmtModified>\\n <CreateUser>982293332403****</CreateUser>\\n <OpUser>982293332403****</OpUser>\\n <Status>EXPORT_SUCCESS</Status>\\n <ProjectId>12345</ProjectId>\\n <DownloadUrl>https://shanghai-xxx-oss.oss-cn-shanghai.aliyuncs.com/pre/store/f10_bf47_b4fa7df0860f.zip?Expires=1639540903&amp;OSSAccessKeyId=XXXXXXeF4Lv5j&amp;Signature=qxxxxx</DownloadUrl>\\n </Data>\\n</GetMigrationSummaryResponse>","errorExample":""}]',
+ 'title' => 'GetMigrationSummary',
+ ],
+ 'ListMigrations' => [
+ 'summary' => 'Queries a list of migration tasks.',
+ 'methods' => [
+ 'post',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'none',
+ 'abilityTreeCode' => '134647',
+ 'abilityTreeNodes' => [
+ 'FEATUREdide8FM783',
+ ],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'ProjectId',
+ 'in' => 'formData',
+ 'schema' => [
+ 'title' => 'Workspace Id',
+ 'description' => 'The DataWorks workspace ID. You can log on to the [DataWorks console](https://workbench.data.aliyun.com/console) and go to the Workspace page to obtain the workspace ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => true,
+ 'docRequired' => true,
+ 'minimum' => '2',
+ 'exclusiveMinimum' => false,
+ 'example' => '12345',
+ ],
+ ],
+ [
+ 'name' => 'MigrationType',
+ 'in' => 'formData',
+ 'schema' => [
+ 'title' => 'Migration operation type, IMPORT/EXPORT',
+ 'description' => 'The migration task type. Valid values: IMPORT and EXPORT.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'enumValueTitles' => [],
+ 'example' => 'IMPORT',
+ 'enum' => [
+ 'IMPORT',
+ 'EXPORT',
+ ],
+ ],
+ ],
+ [
+ 'name' => 'Owner',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The owner ID.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => '193379****',
+ ],
+ ],
+ [
+ 'name' => 'PageNumber',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The page number. Default value: 1. Maximum value: 100.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => false,
+ 'maximum' => '100',
+ 'minimum' => '1',
+ 'example' => '1',
+ 'default' => '1',
+ ],
+ ],
+ [
+ 'name' => 'PageSize',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The number of entries per page. Default value: 10. Maximum value: 100.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => false,
+ 'maximum' => '100',
+ 'minimum' => '10',
+ 'example' => '10',
+ 'default' => '10',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'description' => 'The response parameters.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'description' => 'The request ID.'."\n",
+ 'type' => 'string',
+ 'example' => 'F9198AA3-9010-53D5-9714-DC4461427D3E',
+ ],
+ 'Success' => [
+ 'description' => 'Indicates whether the request was successful. Valid values:'."\n"
+ ."\n"
+ .'* true'."\n"
+ .'* false'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'Data' => [
+ 'description' => 'The returned data.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'Migrations' => [
+ 'description' => 'The list of migration tasks.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The migration task.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'Id' => [
+ 'description' => 'The primary key ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '436064',
+ ],
+ 'Name' => [
+ 'description' => 'The name of the migration task.'."\n",
+ 'type' => 'string',
+ 'example' => 'test_task_1638498642279',
+ ],
+ 'PackageType' => [
+ 'description' => 'The type of the import or export package. Valid values:'."\n"
+ ."\n"
+ .'* DWMA (standard format)'."\n"
+ .'* DATAWORKS_MODEL (standard format)'."\n"
+ .'* DATAWORKS_V2 (Apsara Stack DataWorks V3.6.1 to V3.11)'."\n"
+ .'* DATAWORKS_V3 (Apsara Stack DataWorks V3.12 and later)'."\n"
+ ."\n"
+ .'The DWMA and DATAWORKS_MODEL types are interchangeable.'."\n",
+ 'type' => 'string',
+ 'enumValueTitles' => [],
+ 'example' => 'DATAWORKS_MODEL',
+ ],
+ 'MigrationType' => [
+ 'description' => 'The type of the migration task. Valid values:'."\n"
+ ."\n"
+ .'* IMPORT'."\n"
+ .'* EXPORT'."\n",
+ 'type' => 'string',
+ 'enumValueTitles' => [],
+ 'example' => 'EXPORT',
+ ],
+ 'CreateTime' => [
+ 'description' => 'The time when the migration task was created.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '123124123123123',
+ ],
+ 'UpdateTime' => [
+ 'description' => 'The time when the migration task was last updated.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '123123123123123',
+ ],
+ 'CreateUser' => [
+ 'description' => 'The ID of the user who created the migration task.'."\n",
+ 'type' => 'string',
+ 'example' => '123123****',
+ ],
+ 'CreateUserName' => [
+ 'description' => 'The name of the user who created the migration task.'."\n",
+ 'type' => 'string',
+ 'example' => '3h1_test',
+ ],
+ 'UpdateUser' => [
+ 'description' => 'The ID of the user who last updated the migration task.'."\n",
+ 'type' => 'string',
+ 'example' => '1231****',
+ ],
+ 'UpdateUserName' => [
+ 'description' => 'The name of the user who last updated the migration task.'."\n",
+ 'type' => 'string',
+ 'example' => '3h1_test',
+ ],
+ 'ProjectId' => [
+ 'description' => 'The ID of the DataWorks workspace to which the task belongs.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '72132',
+ ],
+ 'TenantId' => [
+ 'description' => 'The tenant ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '16307',
+ ],
+ 'Status' => [
+ 'description' => 'The status of the migration task. Valid values:'."\n"
+ ."\n"
+ .'* INIT: The migration task is in the initial state.'."\n"
+ .'* EDITING: The migration task is being edited.'."\n"
+ .'* RUNNING: The migration task is running.'."\n"
+ .'* FAILURE: The migration task fails to run.'."\n"
+ .'* SUCCESS: The migration task is successfully run.'."\n",
+ 'type' => 'string',
+ 'enumValueTitles' => [],
+ 'example' => 'SUCCESS',
+ ],
+ 'Message' => [
+ 'description' => 'The error message returned.'."\n",
+ 'type' => 'string',
+ 'example' => 'An internal system error occurred. datasource kafka region is not cn-chengdu, can\'t open network for it',
+ ],
+ 'DownloadUrl' => [
+ 'description' => 'The URL that is used to download the package of the export task. You can use the URL to download the package of the export task.'."\n",
+ 'type' => 'string',
+ 'example' => 'http://geoip-sdk-user.oss-cn-zhangjiakou.aliyuncs.com/product/v1/ipv4/trace/v1.20220424123842.dex?Expires=1650780849&OSSAccessKeyId=XXXXXXeF4Lv5j&Signature=qxxxxx',
+ ],
+ 'Description' => [
+ 'description' => 'The description of the export task.'."\n",
+ 'type' => 'string',
+ 'example' => 'Automated Test creation',
+ ],
+ ],
+ ],
+ ],
+ 'PageNumber' => [
+ 'description' => 'The page number.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '1',
+ ],
+ 'PageSize' => [
+ 'description' => 'The number of entries per page. Default value: 10. Maximum value: 50.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '10',
+ ],
+ 'TotalCount' => [
+ 'description' => 'The total number of entries.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '20',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"F9198AA3-9010-53D5-9714-DC4****\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"Migrations\\": [\\n {\\n \\"Id\\": 436064,\\n \\"Name\\": \\"test_task_1638498642279\\",\\n \\"PackageType\\": \\"DATAWORKS_MODEL\\",\\n \\"MigrationType\\": \\"EXPORT\\",\\n \\"CreateTime\\": 123124123123123,\\n \\"UpdateTime\\": 123123123123123,\\n \\"CreateUser\\": \\"123123****\\",\\n \\"CreateUserName\\": \\"3h1_test\\",\\n \\"UpdateUser\\": \\"1231****\\",\\n \\"UpdateUserName\\": \\"3h1_test\\",\\n \\"ProjectId\\": 72132,\\n \\"TenantId\\": 16307,\\n \\"Status\\": \\"SUCCESS\\",\\n \\"Message\\": \\"An internal system error occurred. datasource kafka region is not cn-chengdu, can\'t open network for it\\",\\n \\"DownloadUrl\\": \\"http://geoip-sdk-user.oss-cn-zhangjiakou.aliyuncs.com/product/v1/ipv4/trace/v1.20220424123842.dex?Expires=1650780849&OSSAccessKeyId=*****&Signature=qxxxxx\\",\\n \\"Description\\": \\"Automated Test creation\\"\\n }\\n ],\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 20\\n }\\n}","errorExample":""},{"type":"xml","example":"<ListMigrationsResponse>\\n <RequestId>F9198AA3-9010-53D5-9714-DC4461427D3E</RequestId>\\n <Success>true</Success>\\n <Data>\\n <Migrations>\\n <Id>436064</Id>\\n <Name>test_task_1638498642279</Name>\\n <PackageType>DATAWORKS_MODEL</PackageType>\\n <MigrationType>EXPORT</MigrationType>\\n <CreateTime>123124123123123</CreateTime>\\n <UpdateTime>123123123123123</UpdateTime>\\n <CreateUser>123123****</CreateUser>\\n <CreateUserName>3h1_test</CreateUserName>\\n <UpdateUser>1231****</UpdateUser>\\n <UpdateUserName>3h1_test</UpdateUserName>\\n <ProjectId>72132</ProjectId>\\n <TenantId>16307</TenantId>\\n <Status>SUCCESS</Status>\\n <Message>An internal system error occurred. datasource kafka region is not cn-chengdu, can\'t open network for it</Message>\\n <DownloadUrl>http://geoip-sdk-user.oss-cn-zhangjiakou.aliyuncs.com/product/v1/ipv4/trace/v1.20220424123842.dex?Expires=1650780849&amp;OSSAccessKeyId=XXXXXXeF4Lv5j&amp;Signature=qxxxxx</DownloadUrl>\\n <Description>自动化测试创建</Description>\\n </Migrations>\\n <PageNumber>1</PageNumber>\\n <PageSize>10</PageSize>\\n <TotalCount>20</TotalCount>\\n </Data>\\n</ListMigrationsResponse>","errorExample":""}]',
+ 'title' => 'ListMigrations',
+ ],
+ 'CreatePermissionApplyOrder' => [
+ 'summary' => 'Creates a permission request order.',
+ 'methods' => [
+ 'post',
+ 'get',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'readAndWrite',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'create',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeCode' => '78190',
+ 'abilityTreeNodes' => [
+ 'FEATUREdide0DCVNY',
+ ],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'ApplyUserIds',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the Alibaba Cloud account for which you want to request permissions. If you want to request permissions for multiple Alibaba Cloud accounts, separate the IDs of the accounts with commas (,).'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => '267842600408993176,267842600408993177',
+ ],
+ ],
+ [
+ 'name' => 'Deadline',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The expiration time of the permissions that you request. This value is a UNIX timestamp. The default value is January 1, 2065. If LabelSecurity is disabled for the MaxCompute project in which you want to request permissions on the fields of a table, or the security level of the fields is 0 or is lower than or equal to the security level of the Alibaba Cloud account for which you want to request permissions, you can request only permanent permissions. You can go to the Workspace Management page in the DataWorks console, click MaxCompute Management in the left-side navigation pane, and then check whether column-level access control is enabled. You can go to your DataWorks workspace, view the security level of the fields in Data Map, and then view the security level of the Alibaba Cloud account on the User Management page.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'example' => '1617115071885',
+ ],
+ ],
+ [
+ 'name' => 'ApplyReason',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The reason for your request. The administrator determines whether to approve the request based on the reason.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'I need to use this table',
+ ],
+ ],
+ [
+ 'name' => 'MaxComputeProjectName',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The name of the MaxCompute project you request access to.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'docRequired' => false,
+ 'example' => 'aMaxcomputeProjectName',
+ ],
+ ],
+ [
+ 'name' => 'WorkspaceId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The DataWorks workspace ID to which the MaxCompute project belongs for permission requests. You can check the workspace ID on the DataWorks workspace configuration page.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => false,
+ 'docRequired' => false,
+ 'maximum' => '999999',
+ 'minimum' => '0',
+ 'example' => '12345',
+ ],
+ ],
+ [
+ 'name' => 'OrderType',
+ 'in' => 'query',
+ 'allowEmptyValue' => true,
+ 'schema' => [
+ 'description' => 'The request type. The only supported value is 1, which represents an object ACL permission request.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'deprecated' => true,
+ 'required' => false,
+ 'example' => '1',
+ 'enum' => [
+ '1',
+ ],
+ ],
+ ],
+ [
+ 'name' => 'EngineType',
+ 'in' => 'query',
+ 'allowEmptyValue' => true,
+ 'schema' => [
+ 'description' => 'The type of compute engine for permission requests. Currently only supports ODPS, which means only MaxCompute compute engine permissions are supported.'."\n",
+ 'type' => 'string',
+ 'deprecated' => true,
+ 'required' => false,
+ 'example' => 'odps',
+ 'enum' => [
+ 'odps',
+ ],
+ ],
+ ],
+ [
+ 'name' => 'ApplyObject',
+ 'in' => 'query',
+ 'style' => 'repeatList',
+ 'schema' => [
+ 'description' => 'The list of requested objects.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'Response parameters.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'Actions' => [
+ 'description' => 'The type of permissions requested. Use commas (,) to separate multiple permission types in a single request. Currently only supports Select, Describe, Drop, Alter, Update, and Download permission types.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'Select,Describe',
+ ],
+ 'ColumnMetaList' => [
+ 'description' => 'The list of column objects.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'Response parameters.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'Name' => [
+ 'description' => 'Permissions for the target columns. Enter the column names here. If applying for permissions on the entire table, enter all column names of the table. Permissions for specific columns can only be requested if labelSecurity is enabled for the MaxCompute project. Otherwise, you can only apply for permissions on the entire table.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'aColumnName',
+ ],
+ 'Actions' => [
+ 'description' => '',
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'Select',
+ ],
+ ],
+ 'required' => false,
+ ],
+ 'required' => false,
+ 'maxItems' => 200,
+ ],
+ 'Name' => [
+ 'description' => 'The object you request access to. Currently, only permission requests for MaxCompute tables are supported. The name of the target table needs to be entered here.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'aTableName',
+ ],
+ ],
+ 'required' => false,
+ ],
+ 'required' => true,
+ 'maxItems' => 50,
+ ],
+ ],
+ [
+ 'name' => 'ApplyType',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => '',
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'MaxComputeTable',
+ 'default' => 'MaxComputeTable',
+ 'enum' => [
+ 'MaxComputeTable',
+ 'DLFSchema',
+ 'DLFTable',
+ 'DLFColumn',
+ 'DsApiDeploy',
+ ],
+ ],
+ ],
+ [
+ 'name' => 'CatalogName',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => '',
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'hive',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'description' => 'The returned result.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'description' => 'The request ID.'."\n",
+ 'type' => 'string',
+ 'example' => '0bc1ec92159376****',
+ ],
+ 'FlowId' => [
+ 'description' => 'The request order ID.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The request order ID. If you request permissions on multiple objects but each object has a different request approver, one request order is generated for each object and is sent to the related approver. In this case, an array is returned.'."\n",
+ 'type' => 'string',
+ 'example' => 'ee276e6e-5d34-46d8-b848-bca7879ed233',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"0bc1ec92159376****\\",\\n \\"FlowId\\": [\\n \\"ee276e6e-5d34-46d8-b848-bca7879ed233\\"\\n ]\\n}","errorExample":""},{"type":"xml","example":"<CreatePermissionApplyOrderResponse>\\n <RequestId>0bc1ec92159376****</RequestId>\\n <FlowId>ee276e6e-5d34-46d8-b848-bca7879ed233</FlowId>\\n</CreatePermissionApplyOrderResponse>","errorExample":""}]',
+ 'title' => 'CreatePermissionApplyOrder',
+ 'requestParamsDescription' => ' ',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ ],
+ 'GetPermissionApplyOrderDetail' => [
+ 'summary' => 'Queries the details of a permission request order.',
+ 'methods' => [
+ 'post',
+ 'get',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'systemTags' => [
+ 'operationType' => 'get',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeCode' => '78280',
+ 'abilityTreeNodes' => [
+ 'FEATUREdideGWNJ45',
+ ],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'FlowId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the permission request order. You can call the [ListPermissionApplyOrders](~~211008~~) operation to obtain the ID.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => '48f36729-05f9-4a40-9286-933fd940f30a',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'description' => 'The returned result.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'description' => 'The request ID.'."\n",
+ 'type' => 'string',
+ 'example' => '0bc1ec92159376****',
+ ],
+ 'ApplyOrderDetail' => [
+ 'description' => 'Details of the permission request order.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'ApplyBaseId' => [
+ 'description' => 'The ID of the Alibaba Cloud account that was used to submit the permission request order.'."\n",
+ 'type' => 'string',
+ 'example' => '267842600408993176',
+ ],
+ 'ApplyTimestamp' => [
+ 'description' => 'The time when the permission request order was submitted. The value is a UNIX timestamp.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '1615284086000',
+ ],
+ 'FlowId' => [
+ 'description' => 'The ID of the permission request order.'."\n",
+ 'type' => 'string',
+ 'example' => 'ad8da78d-8135-455e-9486-27cf213fc140',
+ ],
+ 'FlowStatus' => [
+ 'description' => 'The status of the permission request order. Valid values:'."\n"
+ ."\n"
+ .'* 1: to be processed'."\n"
+ .'* 2: approved and authorized'."\n"
+ .'* 3: approved but authorization failed'."\n"
+ .'* 4: rejected'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '2',
+ ],
+ 'ApproveAccountList' => [
+ 'description' => 'The list of Alibaba Cloud accounts that are used to process the permission request order.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '',
+ 'type' => 'object',
+ 'properties' => [
+ 'BaseId' => [
+ 'description' => 'The ID of the Alibaba Cloud account that is used to process the permission request order.'."\n",
+ 'type' => 'string',
+ 'example' => '182293110403****',
+ ],
+ ],
+ ],
+ ],
+ 'GranteeObjectList' => [
+ 'description' => 'The information about the account that is used to request permissions.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '',
+ 'type' => 'object',
+ 'properties' => [
+ 'GranteeType' => [
+ 'description' => 'The type of the subject that requests permissions. The value is fixed as 1, which indicates users.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '1',
+ ],
+ 'GranteeTypeSub' => [
+ 'description' => 'The subtype of the subject that requests permissions. Valid values:'."\n"
+ ."\n"
+ .'* 101: production account'."\n"
+ .'* 103: individual account'."\n"
+ .'* 105: account that requests permissions for others'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '103',
+ ],
+ 'GranteeName' => [
+ 'description' => 'The name of the account that is used to request permissions. The name is in the same format as that of the account used to access the MaxCompute project.'."\n"
+ ."\n"
+ .'* If the account is an Alibaba Cloud account, the value is in the ALIYUN$+Account name format.'."\n"
+ .'* If the account is a RAM user, the value is in the RAM$+Account name format.'."\n",
+ 'type' => 'string',
+ 'example' => 'RAM$dataworks_3h1_1:StsRamUser(StsRamUser)',
+ ],
+ 'GranteeId' => [
+ 'description' => 'The ID of the account that is used to request permissions.'."\n",
+ 'type' => 'string',
+ 'example' => '267842600408993176',
+ ],
+ ],
+ ],
+ ],
+ 'ApproveContent' => [
+ 'description' => 'The content of the permission request.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'ApplyReason' => [
+ 'description' => 'The reason of the permission request. The administrator processes the request based on the reason.'."\n",
+ 'type' => 'string',
+ 'example' => 'I need to use this table',
+ ],
+ 'Deadline' => [
+ 'description' => 'The expiration time of the permissions that you request. The value is a UNIX timestamp. If LabelSecurity is disabled for the MaxCompute project in which you want to request permissions on the fields of a table, or the security level of the fields is 0 or is lower than or equal to the security level of the Alibaba Cloud account for which you want to request permissions, you can request only permanent permissions.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '1617115071885',
+ ],
+ 'OrderType' => [
+ 'description' => 'The type of the permission request order. The parameter value is 1 and cannot be changed. This value indicates ACL-based authorization.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '1',
+ ],
+ 'ProjectMeta' => [
+ 'description' => 'The information about the project and workspace that are associated with the object on which you request permissions.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'MaxComputeProjectName' => [
+ 'description' => 'The MaxCompute project to which the object on which you request permissions belongs.'."\n",
+ 'type' => 'string',
+ 'example' => 'aMaxComputeProject',
+ ],
+ 'WorkspaceId' => [
+ 'description' => 'The ID of the DataWorks workspace that is associated with the object on which you request permissions.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '12345',
+ ],
+ 'ObjectMetaList' => [
+ 'description' => 'The details about the object on which you request permissions.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The returned data.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'ObjectName' => [
+ 'description' => 'The name of the table on which you request permissions.'."\n",
+ 'type' => 'string',
+ 'example' => 'aTableName',
+ ],
+ 'ColumnMetaList' => [
+ 'description' => 'The information about the column fields in the object on which you request permissions.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The returned data.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'ColumnName' => [
+ 'description' => 'The name of the column on which you request permissions.'."\n",
+ 'type' => 'string',
+ 'example' => 'aColumnName',
+ ],
+ 'ColumnComment' => [
+ 'description' => 'The description of the column on which you request permissions.'."\n",
+ 'type' => 'string',
+ 'example' => 'Field description',
+ ],
+ 'SecurityLevel' => [
+ 'description' => 'The security level of the column on which you request permissions. Valid values: 0 to 9.'."\n",
+ 'type' => 'string',
+ 'example' => '9',
+ ],
+ 'ColumnActions' => [
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'string',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'Actions' => [
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'string',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'FinishAapprovalTimestamp' => [
+ 'description' => '',
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '1757496687000',
+ ],
+ 'FinishApprovalComment' => [
+ 'description' => '',
+ 'type' => 'string',
+ 'example' => 'agree',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"0bc1ec92159376****\\",\\n \\"ApplyOrderDetail\\": {\\n \\"ApplyBaseId\\": \\"26784260040899****\\",\\n \\"ApplyTimestamp\\": 1615284086000,\\n \\"FlowId\\": \\"ad8da78d-8135-455e-9486-27cf213f****\\",\\n \\"FlowStatus\\": 2,\\n \\"ApproveAccountList\\": [\\n {\\n \\"BaseId\\": \\"182293110403****\\"\\n }\\n ],\\n \\"GranteeObjectList\\": [\\n {\\n \\"GranteeType\\": 1,\\n \\"GranteeTypeSub\\": 103,\\n \\"GranteeName\\": \\"RAM$dataworks_3h1_1:StsRamUser(StsRamUser)\\",\\n \\"GranteeId\\": \\"26784260040899****\\"\\n }\\n ],\\n \\"ApproveContent\\": {\\n \\"ApplyReason\\": \\"I need to use this table\\",\\n \\"Deadline\\": 1617115071885,\\n \\"OrderType\\": 1,\\n \\"ProjectMeta\\": {\\n \\"MaxComputeProjectName\\": \\"aMaxComputeProject\\",\\n \\"WorkspaceId\\": 123456,\\n \\"ObjectMetaList\\": [\\n {\\n \\"ObjectName\\": \\"aTableName\\",\\n \\"ColumnMetaList\\": [\\n {\\n \\"ColumnName\\": \\"aColumnName\\",\\n \\"ColumnComment\\": \\"Field description\\",\\n \\"SecurityLevel\\": \\"9\\",\\n \\"ColumnActions\\": [\\n \\"\\"\\n ]\\n }\\n ],\\n \\"Actions\\": [\\n \\"\\"\\n ]\\n }\\n ]\\n }\\n },\\n \\"FinishAapprovalTimestamp\\": 1757496687000,\\n \\"FinishApprovalComment\\": \\"agree\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"<GetPermissionApplyOrderDetailResponse>\\n <RequestId>0bc1ec92159376****</RequestId>\\n <ApplyOrderDetail>\\n <ApplyBaseId>26784260040899****</ApplyBaseId>\\n <ApplyTimestamp>1615284086000</ApplyTimestamp>\\n <FlowId>ad8da78d-8135-455e-9486-27cf213f****</FlowId>\\n <FlowStatus>2</FlowStatus>\\n <ApproveAccountList>\\n <BaseId>182293110403****</BaseId>\\n </ApproveAccountList>\\n <GranteeObjectList>\\n <GranteeType>1</GranteeType>\\n <GranteeTypeSub>103</GranteeTypeSub>\\n <GranteeName>RAM$dataworks_3h1_1:StsRamUser(StsRamUser)</GranteeName>\\n <GranteeId>26784260040899****</GranteeId>\\n </GranteeObjectList>\\n <ApproveContent>\\n <ApplyReason>I need to use this table</ApplyReason>\\n <Deadline>1617115071885</Deadline>\\n <OrderType>1</OrderType>\\n <ProjectMeta>\\n <MaxComputeProjectName>aMaxComputeProject</MaxComputeProjectName>\\n <WorkspaceId>12345</WorkspaceId>\\n <ObjectMetaList>\\n <ObjectName>aTableName</ObjectName>\\n <ColumnMetaList>\\n <ColumnName>aColumnName</ColumnName>\\n <ColumnComment>字段描述</ColumnComment>\\n <SecurityLevel>9</SecurityLevel>\\n </ColumnMetaList>\\n </ObjectMetaList>\\n </ProjectMeta>\\n </ApproveContent>\\n </ApplyOrderDetail>\\n</GetPermissionApplyOrderDetailResponse>","errorExample":""}]',
+ 'title' => 'GetPermissionApplyOrderDetail',
+ 'requestParamsDescription' => ' ',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ ],
+ 'ListPermissionApplyOrders' => [
+ 'summary' => 'Queries a list of permission requests.',
+ 'methods' => [
+ 'post',
+ 'get',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'list',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeCode' => '78323',
+ 'abilityTreeNodes' => [
+ 'FEATUREdide0DCVNY',
+ ],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'FlowStatus',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The status of the permission request. Valid values:'."\n"
+ ."\n"
+ .'* 1: Pending approval'."\n"
+ .'* 2: Approved and authorization succeeded'."\n"
+ .'* 3: Approved but authorization failed'."\n"
+ .'* 4: Rejected'."\n"
+ .'* 5: Withdrawn'."\n"
+ ."\n"
+ .'Valid values:'."\n"
+ ."\n"
+ .'* 0'."\n"
+ .'* 1'."\n"
+ .'* 2'."\n"
+ .'* 3'."\n"
+ .'* 4'."\n"
+ .'* 5'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => false,
+ 'example' => '1',
+ 'enum' => [
+ '0',
+ '1',
+ '2',
+ '3',
+ '4',
+ '5',
+ ],
+ ],
+ ],
+ [
+ 'name' => 'WorkspaceId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the workspace to which the permission request belongs. If you do not specify this parameter, permission requests from all workspaces are returned. To obtain the workspace ID, log on to the DataWorks console and navigate to the workspace configuration page.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => false,
+ 'example' => '12345',
+ ],
+ ],
+ [
+ 'name' => 'OrderType',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'This parameter is deprecated and does not take effect.'."\n"
+ ."\n"
+ .'Valid values:'."\n"
+ ."\n"
+ .'* 1'."\n"
+ .'* 0'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => false,
+ 'docRequired' => false,
+ 'maximum' => '1',
+ 'minimum' => '0',
+ 'example' => '1',
+ 'enum' => [
+ '1',
+ '0',
+ ],
+ ],
+ ],
+ [
+ 'name' => 'MaxComputeProjectName',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The name of the MaxCompute project with which the permission request order is associated. If you do not specify the parameter, the permission request orders of all MaxCompute projects are returned.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'aMaxComputeProject',
+ ],
+ ],
+ [
+ 'name' => 'TableName',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The name of the table with which the permission request order is associated. If you do not specify the parameter, the permission request orders of all tables are returned.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'aTableName',
+ ],
+ ],
+ [
+ 'name' => 'StartTime',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The beginning of the time range to query. You can query all the permissions request orders that have been submitted after the time. The parameter value is a UNIX timestamp. If you do not specify the parameter, all permission request orders are queried.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'example' => '1616200471885',
+ ],
+ ],
+ [
+ 'name' => 'EndTime',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The end of the time range to query. You can query all the permissions request orders that have been submitted before the time. The parameter value is a UNIX timestamp. If you do not specify the parameter, all permission request orders that are submitted before the current time are queried.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'example' => '1617200471885',
+ ],
+ ],
+ [
+ 'name' => 'EngineType',
+ 'in' => 'query',
+ 'allowEmptyValue' => true,
+ 'schema' => [
+ 'description' => 'This parameter is deprecated and does not take effect.'."\n"
+ ."\n"
+ .'Valid values:'."\n"
+ ."\n"
+ .'* odps'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'docRequired' => false,
+ 'example' => 'odps',
+ 'enum' => [
+ 'odps',
+ ],
+ ],
+ ],
+ [
+ 'name' => 'PageNum',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The page number for pagination. The value must be a positive integer greater than or equal to 1. Default value: 1.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => false,
+ 'example' => '1',
+ 'default' => '1',
+ ],
+ ],
+ [
+ 'name' => 'PageSize',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The number of entries per page. Default value: 10. Maximum value: 100.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => false,
+ 'example' => '100',
+ 'default' => '10',
+ ],
+ ],
+ [
+ 'name' => 'QueryType',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The query type for permission requests. Valid values:'."\n"
+ ."\n"
+ .'* 0: Permission requests submitted by me'."\n"
+ .'* 1: Permission requests pending my approval'."\n"
+ .'* 2: All permission requests'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => true,
+ 'docRequired' => true,
+ 'maximum' => '2',
+ 'minimum' => '0',
+ 'example' => '1',
+ 'enum' => [
+ '0',
+ '1',
+ '2',
+ ],
+ ],
+ ],
+ [
+ 'name' => 'ApplyType',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The type of permission request. Valid values:'."\n"
+ ."\n"
+ .'* MaxComputeTable: Permission request for MaxCompute tables'."\n"
+ .'* MaxComputeFunction: Permission request for MaxCompute functions'."\n"
+ .'* MaxComputeResource: Permission request for MaxCompute resources'."\n"
+ .'* DLFSchema: Permission request for DLF 1.0 schemas'."\n"
+ .'* DLFTable: Permission request for DLF 1.0 tables'."\n"
+ .'* DLFColumn: Permission request for DLF 1.0 columns'."\n"
+ .'* DsApiDeploy: Permission request for publishing data services'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'MaxComputeTable',
+ 'default' => 'MaxComputeTable',
+ 'enum' => [
+ 'MaxComputeTable',
+ 'MaxComputeFunction',
+ 'MaxComputeResource',
+ 'DLFSchema',
+ 'DLFTable',
+ 'DLFColumn',
+ 'HologresTable',
+ 'StarRocksTable',
+ 'StarRocksSchema',
+ 'EmrSchema',
+ 'EmrTable',
+ 'LindormTable',
+ 'DsApiDeploy',
+ 'DIJobs',
+ 'ExtensionSet',
+ 'DgcCheckerOperation',
+ ],
+ ],
+ ],
+ [
+ 'name' => 'CatalogName',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The name of the data catalog to query.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'hive',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'description' => 'The response.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'description' => 'The request ID.'."\n",
+ 'type' => 'string',
+ 'example' => '0bc1ec92159376****',
+ ],
+ 'ApplyOrders' => [
+ 'description' => 'The paginated query results of permission requests.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'PageSize' => [
+ 'description' => 'The number of entries per page.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '10',
+ ],
+ 'PageNumber' => [
+ 'description' => 'The page number.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '1',
+ ],
+ 'TotalCount' => [
+ 'description' => 'The total number of permission requests returned.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '150',
+ ],
+ 'ApplyOrder' => [
+ 'description' => 'The list of permission requests.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The response.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'ApplyBaseId' => [
+ 'description' => 'The Alibaba Cloud account ID of the user who submitted the permission request.'."\n",
+ 'type' => 'string',
+ 'example' => '267842600408993176',
+ ],
+ 'ApplyTimestamp' => [
+ 'description' => 'The time when the permission request was submitted, in Unix timestamp format.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '1615284086000',
+ ],
+ 'FlowId' => [
+ 'description' => 'The permission request ID.'."\n",
+ 'type' => 'string',
+ 'example' => 'ad8da78d-8135-455e-9486-27cf213fc140',
+ ],
+ 'FlowStatus' => [
+ 'description' => 'The status of the permission request. Valid values:'."\n"
+ ."\n"
+ .'* 1: Pending approval'."\n"
+ .'* 2: Approved and authorization succeeded'."\n"
+ .'* 3: Approved but authorization failed'."\n"
+ .'* 4: Rejected'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '2',
+ ],
+ 'ApproveContent' => [
+ 'description' => 'The content of the permission request.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'ApplyReason' => [
+ 'description' => 'The reason for the permission request, which is used by administrators for evaluation and approval.'."\n",
+ 'type' => 'string',
+ 'example' => 'I need to use this table',
+ ],
+ 'OrderType' => [
+ 'description' => 'The type of permission request. Only the value 1 is supported, which indicates an ACL permission request for objects.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '1',
+ ],
+ 'ProjectMeta' => [
+ 'description' => 'The content of the requested object.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'WorkspaceName' => [
+ 'description' => 'The name of the DataWorks workspace that contains the MaxCompute project for which permissions are requested.'."\n",
+ 'type' => 'string',
+ 'example' => 'aWorkspaceName',
+ ],
+ 'ObjectMetaList' => [
+ 'description' => 'The information about the requested object.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The response.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'ObjectName' => [
+ 'description' => 'The name of the requested table.'."\n",
+ 'type' => 'string',
+ 'example' => 'aTableName',
+ ],
+ 'Actions' => [
+ 'description' => 'The operation type.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The permission types requested. Separate multiple permission types with commas (,). Valid values: Select, Describe, Drop, Alter, Update, and Download.'."\n",
+ 'type' => 'string',
+ 'example' => 'Select,Describe',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'FinishApprovalTimestamp' => [
+ 'description' => 'The final approval timestamp. Displayed as a Unix timestamp.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '1757496687000',
+ ],
+ 'FinishApprovalComment' => [
+ 'description' => 'The final approval comment.'."\n",
+ 'type' => 'string',
+ 'example' => 'agree',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"0bc1ec92159376****\\",\\n \\"ApplyOrders\\": {\\n \\"PageSize\\": 10,\\n \\"PageNumber\\": 1,\\n \\"TotalCount\\": 150,\\n \\"ApplyOrder\\": [\\n {\\n \\"ApplyBaseId\\": \\"267842600408993176\\",\\n \\"ApplyTimestamp\\": 1615284086000,\\n \\"FlowId\\": \\"ad8da78d-8135-455e-9486-27cf213fc140\\",\\n \\"FlowStatus\\": 2,\\n \\"ApproveContent\\": {\\n \\"ApplyReason\\": \\"I need to use this table\\",\\n \\"OrderType\\": 1,\\n \\"ProjectMeta\\": {\\n \\"WorkspaceName\\": \\"aWorkspaceName\\",\\n \\"ObjectMetaList\\": [\\n {\\n \\"ObjectName\\": \\"aTableName\\",\\n \\"Actions\\": [\\n \\"Select,Describe\\"\\n ]\\n }\\n ]\\n }\\n },\\n \\"FinishApprovalTimestamp\\": 1757496687000,\\n \\"FinishApprovalComment\\": \\"agree\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<ListPermissionApplyOrdersResponse>\\n <RequestId>0bc1ec92159376****</RequestId>\\n <ApplyOrders>\\n <PageSize>10</PageSize>\\n <PageNumber>1</PageNumber>\\n <TotalCount>150</TotalCount>\\n <ApplyOrder>\\n <ApplyBaseId>267842600408993176</ApplyBaseId>\\n <ApplyTimestamp>1615284086000</ApplyTimestamp>\\n <FlowId>ad8da78d-8135-455e-9486-27cf213fc140</FlowId>\\n <FlowStatus>2</FlowStatus>\\n <ApproveContent>\\n <ApplyReason>I need to use this table</ApplyReason>\\n <OrderType>1</OrderType>\\n <ProjectMeta>\\n <WorkspaceName>aWorkspaceName</WorkspaceName>\\n <ObjectMetaList>\\n <ObjectName>aTableName</ObjectName>\\n <Actions>Select,Describe</Actions>\\n </ObjectMetaList>\\n </ProjectMeta>\\n </ApproveContent>\\n </ApplyOrder>\\n </ApplyOrders>\\n</ListPermissionApplyOrdersResponse>","errorExample":""}]',
+ 'title' => 'ListPermissionApplyOrders',
+ 'requestParamsDescription' => ' ',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ ],
+ 'ApprovePermissionApplyOrder' => [
+ 'methods' => [
+ 'post',
+ 'get',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'readAndWrite',
+ 'deprecated' => false,
+ 'systemTags' => [],
+ 'parameters' => [
+ [
+ 'name' => 'FlowId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the permission request order. You can call the ListPermissionApplyOrders operation to obtain the order ID.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => '48f36729-05f9-4a40-9286-933fd940f30a',
+ ],
+ ],
+ [
+ 'name' => 'ApproveComment',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The comment on the order.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'agree',
+ ],
+ ],
+ [
+ 'name' => 'ApproveAction',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The action for the permission request order. Valid values:'."\n"
+ ."\n"
+ .'* 1: approve'."\n"
+ .'* 2: reject'."\n"
+ ."\n"
+ .'<!---->'."\n"
+ ."\n"
+ .'* 0'."\n"
+ .'* 1'."\n"
+ .'* 2\\.'."\n"
+ .'* 3\\.'."\n"
+ .'* 4'."\n"
+ .'* 5'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => true,
+ 'docRequired' => true,
+ 'maximum' => '5',
+ 'minimum' => '0',
+ 'enumValueTitles' => [],
+ 'example' => '1',
+ 'enum' => [
+ '0',
+ '1',
+ '2',
+ '3',
+ '4',
+ '5',
+ ],
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'ApproveSuccess' => [
+ 'description' => 'Indicates whether the permission request order is processed.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'RequestId' => [
+ 'description' => 'The request ID.'."\n",
+ 'type' => 'string',
+ 'example' => '0bc1ec92159376****',
+ ],
+ ],
+ 'description' => '',
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"ApproveSuccess\\": true,\\n \\"RequestId\\": \\"0bc1ec92159376****\\"\\n}","errorExample":""},{"type":"xml","example":"<RequestId>0bc1ec92159376****</RequestId>\\n<ApproveSuccess>true</ApproveSuccess>","errorExample":""}]',
+ 'title' => 'ApprovePermissionApplyOrder',
+ 'summary' => 'Processes a permission request order.',
+ 'requestParamsDescription' => ' ',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ ],
+ 'RevokeTablePermission' => [
+ 'methods' => [
+ 'post',
+ 'get',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'readAndWrite',
+ 'systemTags' => [],
+ 'parameters' => [
+ [
+ 'name' => 'WorkspaceId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the DataWorks workspace with which the MaxCompute project is associated. You can log on to the DataWorks console and go to the Workspace page to obtain the ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => true,
+ 'docRequired' => true,
+ 'maximum' => '9999999',
+ 'minimum' => '1',
+ 'example' => '12345',
+ ],
+ ],
+ [
+ 'name' => 'MaxComputeProjectName',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The name of the MaxCompute project to which the table belongs. You can log on to the DataWorks console and go to the SettingCenter page to obtain the name of the MaxCompute project that you associate with the workspace.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'aMaxcomputeProjectName',
+ ],
+ ],
+ [
+ 'name' => 'TableName',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The name of the MaxCompute table. You can call the [SearchMetaTables](~~173919~~) operation to query the name of the MaxCompute table.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'aTableName',
+ ],
+ ],
+ [
+ 'name' => 'Actions',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The permissions that you want to revoke. Separate multiple permissions with commas (,). You can revoke only the SELECT, DESCRIBE, and DOWNLOAD permissions on MaxCompute tables.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'Select,Describe',
+ ],
+ ],
+ [
+ 'name' => 'RevokeUserName',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The Alibaba Cloud account from which you want to revoke permissions. Specify this parameter in the format that is the same as the format of the account used to access the MaxCompute project.'."\n"
+ ."\n"
+ .'* If the account is an Alibaba Cloud account, the value is in the ALIYUN$+Account name format.'."\n"
+ .'* If the account is a RAM user, the value is in the RAM$+Account name format.'."\n"
+ ."\n"
+ .'You must specify either this parameter or the RevokeUserId parameter. If you specify both this parameter and the RevokeUserId parameter and the parameter values are different, the value of the RevokeUserId parameter prevails.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'RAM$dataworks_3h1_1:stsramuser',
+ ],
+ ],
+ [
+ 'name' => 'RevokeUserId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the Alibaba Cloud account from which you want to revoke permissions. You can log on to the DataWorks console and go to the Security Settings page to obtain the ID. You must specify either this parameter or the RevokeUserName parameter. If you specify both this parameter and the RevokeUserName parameter and the parameter values are different, the value of this parameter prevails.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => '267842600408993176',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'RevokeSuccess' => [
+ 'description' => 'Indicates whether the permissions are revoked.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'RequestId' => [
+ 'description' => 'The request ID.'."\n",
+ 'type' => 'string',
+ 'example' => '0bc1ec92159376****',
+ ],
+ ],
+ 'description' => '',
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"RevokeSuccess\\": true,\\n \\"RequestId\\": \\"0bc1ec92159376****\\"\\n}","errorExample":""},{"type":"xml","example":"<RevokeSuccess>true</RevokeSuccess>\\n<RequestId>0bc1ec92159376****</RequestId>","errorExample":""}]',
+ 'title' => 'RevokeTablePermission',
+ 'summary' => 'Revokes permissions on a table from a user.',
+ 'requestParamsDescription' => ' ',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ ],
+ 'ListExtensions' => [
+ 'summary' => 'Queries a list of extensions.',
+ 'methods' => [
+ 'get',
+ 'post',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'get',
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'PageNumber',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The page number.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => false,
+ 'example' => '1',
+ ],
+ ],
+ [
+ 'name' => 'PageSize',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The number of entries per page.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => false,
+ 'example' => '10',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => 'Schema of Response',
+ 'description' => 'The response parameters.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'title' => 'Id of the request',
+ 'description' => 'Id of the request'."\n",
+ 'type' => 'string',
+ 'example' => '0000-ABCD-EFG',
+ ],
+ 'PagingInfo' => [
+ 'description' => 'The pagination information.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'PageNumber' => [
+ 'description' => 'The page number.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '1',
+ ],
+ 'PageSize' => [
+ 'description' => 'The number of entries per page.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '10',
+ ],
+ 'TotalCount' => [
+ 'description' => 'The total number of entries returned.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '12',
+ ],
+ 'Extensions' => [
+ 'description' => 'The list of extensions.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The extensions.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'Status' => [
+ 'description' => 'The state of the extension. Valid values: 0: Testing 1: Publishing 3: Disabled 4: Processing 5: Approved 6: Approve Failed'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '0',
+ ],
+ 'ExtensionDesc' => [
+ 'description' => 'The description of the extension.'."\n",
+ 'type' => 'string',
+ 'example' => 'This is a description',
+ ],
+ 'ExtensionName' => [
+ 'description' => 'The name of the extension.'."\n",
+ 'type' => 'string',
+ 'example' => 'Extension name',
+ ],
+ 'Owner' => [
+ 'description' => 'The ID of the RAM user.'."\n",
+ 'type' => 'string',
+ 'example' => '2003****',
+ ],
+ 'ExtensionCode' => [
+ 'description' => 'The unique code of the extension.'."\n",
+ 'type' => 'string',
+ 'example' => 'Extension Code',
+ ],
+ 'BindEventList' => [
+ 'description' => 'The list of extension point events.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The extension point event.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'EventName' => [
+ 'description' => 'The name of the event.'."\n",
+ 'type' => 'string',
+ 'example' => 'File submission pre-event',
+ ],
+ 'EventCode' => [
+ 'description' => 'The code of the event.'."\n",
+ 'type' => 'string',
+ 'example' => 'commit-file',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"0000-ABCD-****\\",\\n \\"PagingInfo\\": {\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 12,\\n \\"Extensions\\": [\\n {\\n \\"Status\\": 0,\\n \\"ExtensionDesc\\": \\"This is a description\\",\\n \\"ExtensionName\\": \\"Extension name\\",\\n \\"Owner\\": \\"2003****\\",\\n \\"ExtensionCode\\": \\"Extension Code\\",\\n \\"BindEventList\\": [\\n {\\n \\"EventName\\": \\"File submission pre-event\\",\\n \\"EventCode\\": \\"commit-file\\"\\n }\\n ]\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<ListExtensionsResponse>\\n <RequestId>0000-ABCD-EFG</RequestId>\\n <PagingInfo>\\n <PageNumber>1</PageNumber>\\n <PageSize>10</PageSize>\\n <TotalCount>12</TotalCount>\\n <Extensions>\\n <Status>0</Status>\\n <ExtensionDesc>这是一个描述</ExtensionDesc>\\n <ExtensionName>扩展程序名称</ExtensionName>\\n <Owner>2003****</Owner>\\n <ExtensionCode>扩展程序码</ExtensionCode>\\n <BindEventList>\\n <EventName>文件提交前置事件</EventName>\\n <EventCode>commit-file</EventCode>\\n </BindEventList>\\n </Extensions>\\n </PagingInfo>\\n</ListExtensionsResponse>","errorExample":""}]',
+ 'title' => 'ListExtensions',
+ ],
+ 'GetExtension' => [
+ 'summary' => 'Queries the details of an extension.',
+ 'methods' => [
+ 'get',
+ 'post',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'get',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeNodes' => [
+ 'FEATUREdideZKHMWN',
+ ],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'ExtensionCode',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The unique code of the extension.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'ce4*********086da5',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => 'Schema of Response',
+ 'description' => 'The returned result.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'title' => 'Id of the request',
+ 'description' => 'The request ID. You can use the request ID to query logs and troubleshoot issues.'."\n",
+ 'type' => 'string',
+ 'example' => '0000-ABCD-EFG',
+ ],
+ 'Extension' => [
+ 'description' => 'The details of the extension.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'ExtensionCode' => [
+ 'description' => 'The unique code of the extension.'."\n",
+ 'type' => 'string',
+ 'example' => 'ce4*********086da5',
+ ],
+ 'ExtensionName' => [
+ 'description' => 'The name of the extension.'."\n",
+ 'type' => 'string',
+ 'example' => 'Extension name',
+ ],
+ 'ExtensionDesc' => [
+ 'description' => 'The description of the extension.'."\n",
+ 'type' => 'string',
+ 'example' => 'This is a description',
+ ],
+ 'HelpDocUrl' => [
+ 'description' => 'The URL of the help documentation of the extension.'."\n",
+ 'type' => 'string',
+ 'example' => 'https://www.aliyun.com/',
+ ],
+ 'Status' => [
+ 'description' => 'The state of the extension. 0: Testing, 1: Publishing, 3: Disabled, 4: Processing, 5: Approved, 6: Approve Failed'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '0',
+ ],
+ 'ProjectTesting' => [
+ 'description' => 'The workspace for testing. If the extension is being tested, the extension can be used only in the workspace for testing.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '13552',
+ ],
+ 'DetailUrl' => [
+ 'description' => 'The URL of the extension details page, on which users can view the details of the process blocked by the extension.'."\n",
+ 'type' => 'string',
+ 'example' => 'https://www.aliyun.com/',
+ ],
+ 'ParameterSetting' => [
+ 'description' => 'The parameter settings of the extension. For more information, see [Configure extension parameters](~~405354~~).'."\n",
+ 'type' => 'string',
+ 'example' => 'extension.project.disabled=projectId1,projectId2,projectId3',
+ ],
+ 'OptionSetting' => [
+ 'description' => 'The options defined for the extension.'."\n",
+ 'type' => 'string',
+ 'example' => 'Option configuration',
+ ],
+ 'BindEventList' => [
+ 'description' => 'The list of extension points.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The details of the extension point.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'EventCode' => [
+ 'description' => 'The code of the extension point event.'."\n",
+ 'type' => 'string',
+ 'example' => 'commit-file',
+ ],
+ 'EventName' => [
+ 'description' => 'The name of the extension point event.'."\n",
+ 'type' => 'string',
+ 'example' => 'File submission pre-event',
+ ],
+ ],
+ ],
+ ],
+ 'EventCategoryList' => [
+ 'description' => 'The list of event types.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The details of the event type.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'CategoryCode' => [
+ 'description' => 'The code of the event type.'."\n",
+ 'type' => 'string',
+ 'example' => 'file-change',
+ ],
+ 'CategoryName' => [
+ 'description' => 'The name of the event type.'."\n",
+ 'type' => 'string',
+ 'example' => 'File change event',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"0000-ABCD-EFG\\",\\n \\"Extension\\": {\\n \\"ExtensionCode\\": \\"ce4*********086da5\\",\\n \\"ExtensionName\\": \\"Extension name\\",\\n \\"ExtensionDesc\\": \\"This is a description\\",\\n \\"HelpDocUrl\\": \\"https://www.aliyun.com/\\",\\n \\"Status\\": 0,\\n \\"ProjectTesting\\": 1355211,\\n \\"DetailUrl\\": \\"https://www.aliyun.com/\\",\\n \\"ParameterSetting\\": \\"extension.project.disabled=projectId1,projectId2,projectId3\\",\\n \\"OptionSetting\\": \\"Option configuration\\",\\n \\"BindEventList\\": [\\n {\\n \\"EventCode\\": \\"commit-file\\",\\n \\"EventName\\": \\"File submission pre-event\\\\n\\"\\n }\\n ],\\n \\"EventCategoryList\\": [\\n {\\n \\"CategoryCode\\": \\"file-change\\",\\n \\"CategoryName\\": \\"File change event\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<GetExtensionResponse>\\n <RequestId>0000-ABCD-EFG</RequestId>\\n <Extension>\\n <ExtensionCode>ce4*********086da5</ExtensionCode>\\n <ExtensionName>扩展程序名称</ExtensionName>\\n <ExtensionDesc>这是一个描述</ExtensionDesc>\\n <HelpDocUrl>https://www.aliyun.com/</HelpDocUrl>\\n <Status>0</Status>\\n <ProjectTesting>13552</ProjectTesting>\\n <DetailUrl>https://www.aliyun.com/</DetailUrl>\\n <ParameterSetting>extension.project.disabled=projectId1,projectId2,projectId3</ParameterSetting>\\n <OptionSetting>选项配置</OptionSetting>\\n <BindEventList>\\n <EventCode>commit-file</EventCode>\\n <EventName>文件提交前置事件</EventName>\\n </BindEventList>\\n <EventCategoryList>\\n <CategoryCode>file-change</CategoryCode>\\n <CategoryName>文件变更事件</CategoryName>\\n </EventCategoryList>\\n </Extension>\\n</GetExtensionResponse>","errorExample":""}]',
+ 'title' => 'GetExtension',
+ ],
+ 'GetOptionValueForProject' => [
+ 'summary' => 'Queries the option settings of an extension in a workspace.',
+ 'methods' => [
+ 'post',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'get',
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'ExtensionCode',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The unique code of the extension.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'ce4*********086da5',
+ ],
+ ],
+ [
+ 'name' => 'ProjectId',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The workspace ID.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => '234',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => 'Schema of Response',
+ 'description' => 'The response parameters.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'title' => 'Id of the request',
+ 'description' => 'The request ID.'."\n",
+ 'type' => 'string',
+ 'example' => 'E6F0DBDD-5AD****',
+ ],
+ 'OptionValue' => [
+ 'description' => 'The data returned In the example, cuNumber is a custom key.'."\n",
+ 'type' => 'string',
+ 'example' => '{"cuNumber":"0"}',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"E6F0DBDD-5AD****\\",\\n \\"OptionValue\\": \\"{\\\\\\"cuNumber\\\\\\":\\\\\\"0\\\\\\"}\\"\\n}","errorExample":""},{"type":"xml","example":"<GetOptionValueForProjectResponse>\\n <RequestId>E6F0DBDD-5AD****</RequestId>\\n <OptionValue>{\\"cuNumber\\":\\"0\\"}</OptionValue>\\n</GetOptionValueForProjectResponse>","errorExample":""}]',
+ 'title' => 'GetOptionValueForProject',
+ ],
+ 'ListEnabledExtensionsForProject' => [
+ 'summary' => 'Queries a list of built-in and custom extensions that are enabled in a workspace.',
+ 'methods' => [
+ 'post',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'list',
+ 'abilityTreeCode' => '158027',
+ 'abilityTreeNodes' => [
+ 'FEATUREdideRWC5F7',
+ ],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'EventCode',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The code of the extension point event.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => 'commit-file',
+ ],
+ ],
+ [
+ 'name' => 'ProjectId',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The DataWorks workspace ID. You can log on to the [DataWorks console](https://workbench.data.aliyun.com/console?spm=a2c4g.11186623.0.0.6b4d4941azHd2k) and go to the Workspace page to obtain the workspace ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => true,
+ 'example' => '10000',
+ ],
+ ],
+ [
+ 'name' => 'FileType',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The type of the code for the file.'."\n"
+ ."\n"
+ .'Valid values: 6 (Shell), 10 (ODPS SQL), 11 (ODPS MR), 24 (ODPS Script), 99 (zero load), 221 (PyODPS 2), 225 (ODPS Spark), 227 (EMR Hive), 228 (EMR Spark), 229 (EMR Spark SQL), 230 (EMR MR), 239 (OSS object inspection), 257 (EMR Shell), 258 (EMR Spark Shell), 259 (EMR Presto), 260 (EMR Impala), 900 (real-time synchronization), 1089 (cross-tenant collaboration), 1091 (Hologres development), 1093 (Hologres SQL), 1100 (assignment), and 1221 (PyODPS 3).'."\n"
+ ."\n"
+ .'You can call the [ListFileType](~~212428~~) operation to query the type of the code for the file.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => '10',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => 'Schema of Response',
+ 'description' => 'The returned result.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'title' => 'Id of the request',
+ 'description' => 'The request ID.'."\n",
+ 'type' => 'string',
+ 'example' => '4F2CA7ED-27E5-59EA-A8C4-F1F7A1FF0B22',
+ ],
+ 'Extensions' => [
+ 'description' => 'The extensions.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The extensions.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'ExtensionCode' => [
+ 'description' => 'The unique code of the extension.'."\n",
+ 'type' => 'string',
+ 'example' => 'a94a8e23bc0b4dfab9a5e4d2f374d645',
+ ],
+ 'ExtensionName' => [
+ 'description' => 'The name of the extension.'."\n",
+ 'type' => 'string',
+ 'example' => 'max_pt function is not allowed.',
+ ],
+ 'TenantId' => [
+ 'description' => 'The tenant ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '529889518659842',
+ ],
+ 'CreateUser' => [
+ 'description' => 'The creator of the extension.'."\n",
+ 'type' => 'string',
+ 'example' => '3444434343555',
+ ],
+ 'ModifyUser' => [
+ 'description' => 'The modifier of the extension.'."\n",
+ 'type' => 'string',
+ 'example' => '34452335611988',
+ ],
+ 'ExtensionDesc' => [
+ 'description' => 'The description of the extension.'."\n",
+ 'type' => 'string',
+ 'example' => 'ODPS SQL compatible Spark engine detection',
+ ],
+ 'Owner' => [
+ 'description' => 'The owner ID.'."\n",
+ 'type' => 'string',
+ 'example' => '21323672*******55500',
+ ],
+ 'ParameterSetting' => [
+ 'description' => 'The parameter settings of the extension. For more information, see [Configure extension parameters](~~405354~~).'."\n",
+ 'type' => 'string',
+ 'example' => 'extension.fileType.23.deploy-file.enabled=true',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"4F2CA7ED-27E5-59EA-A8C4-F1F7A1FF0B22\\",\\n \\"Extensions\\": [\\n {\\n \\"ExtensionCode\\": \\"a94a8e23bc0b4dfab9a5e4d2f374d645\\",\\n \\"ExtensionName\\": \\"max_pt function is not allowed.\\",\\n \\"TenantId\\": 0,\\n \\"CreateUser\\": \\"3444434343555\\",\\n \\"ModifyUser\\": \\"34452335611988\\",\\n \\"ExtensionDesc\\": \\"ODPS SQL compatible Spark engine detection\\",\\n \\"Owner\\": \\"21323672*******55500\\",\\n \\"ParameterSetting\\": \\"extension.fileType.23.deploy-file.enabled=true\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<ListEnabledExtensionsForProjectResponse>\\n <RequestId>4F2CA7ED-27E5-59EA-A8C4-F1F7A1FF0B22</RequestId>\\n <Extensions>\\n <ExtensionCode>a94a8e23bc0b4dfab9a5e4d2f374d645</ExtensionCode>\\n <ExtensionName>不允许使用max_pt函数</ExtensionName>\\n <TenantId>529889518659842</TenantId>\\n <CreateUser>3444434343555</CreateUser>\\n <ModifyUser>34452335611988</ModifyUser>\\n <ExtensionDesc>ODPS SQL兼容Spark引擎检测</ExtensionDesc>\\n <Owner>21323672*******55500</Owner>\\n <ParameterSetting>extension.fileType.23.deploy-file.enabled=true</ParameterSetting>\\n <GmtCreate>1660117173</GmtCreate>\\n <GmtModified>1569308162000</GmtModified>\\n </Extensions>\\n</ListEnabledExtensionsForProjectResponse>","errorExample":""}]',
+ 'title' => 'ListEnabledExtensionsForProject',
+ 'description' => 'For information about codes of extension point events, see [Development references: Extension point event codes](~~463357~~).'."\n",
+ ],
+ 'CallbackExtension' => [
+ 'summary' => 'Sends the processing result of an extension point event by an extension to DataWorks.',
+ 'methods' => [
+ 'post',
+ ],
+ 'schemes' => [
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'readAndWrite',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'none',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeCode' => '191317',
+ 'abilityTreeNodes' => [
+ 'FEATUREdideRWC5F7',
+ ],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'ExtensionCode',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The unique code of the extension.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => '8abcb91f-d266-4073-b907-2ed670378ed1',
+ ],
+ ],
+ [
+ 'name' => 'MessageId',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The message ID in DataWorks OpenEvent. You can obtain the ID from a received message when an extension point event is triggered.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => '03400b03-b721-4c34-8727-2d6884077091',
+ ],
+ ],
+ [
+ 'name' => 'CheckResult',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The check status of the extension point event. Valid values:'."\n"
+ ."\n"
+ .'* OK: The event passes the check.'."\n"
+ .'* FAIL: The event fails to pass the check. You must check and handle the reported error at the earliest opportunity to ensure that your program is run as expected.'."\n"
+ .'* WARN: The event passes the check, but an alert is reported.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => 'FAIL',
+ 'enum' => [
+ 'OK',
+ 'FAIL',
+ 'WARN',
+ ],
+ ],
+ ],
+ [
+ 'name' => 'CheckMessage',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The check message of the extension point event. If CheckResult is set to FAIL, you must provide the failure cause.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'The xxx rule is hit. Modify it and try again.',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => 'Schema of Response',
+ 'description' => 'The data returned.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'title' => 'Id of the request',
+ 'description' => 'The request ID.'."\n",
+ 'type' => 'string',
+ 'example' => '7C352CB7-CD88-50CF-9D0D-E81BDF020E7F',
+ ],
+ 'Success' => [
+ 'description' => 'Indicates whether the request was successful. Valid values:'."\n"
+ ."\n"
+ .'true'."\n"
+ ."\n"
+ .'false'."\n",
+ 'type' => 'string',
+ 'example' => 'true',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'staticInfo' => [
+ 'returnType' => 'synchronous',
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"7C352CB7-CD88-50CF-9D0D-E81BDF020E7F\\",\\n \\"Success\\": \\"true\\"\\n}","errorExample":""},{"type":"xml","example":"<CallbackExtensionResponse>\\n <RequestId>7C352CB7-CD88-50CF-9D0D-E81BDF020E7F</RequestId>\\n <Success>true</Success>\\n</CallbackExtensionResponse>","errorExample":""}]',
+ 'title' => 'CallbackExtension',
+ ],
+ 'ListCheckProcesses' => [
+ 'summary' => 'Queries the check results of extension point events.',
+ 'methods' => [
+ 'get',
+ 'post',
+ ],
+ 'schemes' => [
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'list',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeCode' => '240968',
+ 'abilityTreeNodes' => [
+ 'FEATUREdide63BO88',
+ ],
+ 'tenantRelevance' => 'tenant',
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'ProjectId',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The ID of the workspace.',
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'example' => '123465',
+ ],
+ ],
+ [
+ 'name' => 'EventCode',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'Extension point event encoding.',
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => 'commit-file',
+ ],
+ ],
+ [
+ 'name' => 'Operator',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The operator ID.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => '123333232',
+ ],
+ ],
+ [
+ 'name' => 'PageSize',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The number of entries per page.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => false,
+ 'maximum' => '100',
+ 'minimum' => '10',
+ 'example' => '10',
+ 'default' => '10',
+ ],
+ ],
+ [
+ 'name' => 'PageNumber',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The page number. Default value: 1.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => false,
+ 'example' => '1',
+ 'default' => '1',
+ ],
+ ],
+ [
+ 'name' => 'Status',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The check status of the extension. Valid values:'."\n"
+ ."\n"
+ .'* CHECKING'."\n"
+ .'* PASSED'."\n"
+ .'* BLOCKED'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'True',
+ 'enum' => [
+ 'CHECKING',
+ 'PASSED',
+ 'BLOCKED',
+ ],
+ ],
+ ],
+ [
+ 'name' => 'MessageId',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The message ID in DataWorks OpenEvent. You can obtain the ID from a received message when an extension point event is triggered.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => '03400b03-b721-4c34-8727-2****1',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => 'Schema of Response',
+ 'description' => 'The response parameters.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'title' => 'Id of the request',
+ 'description' => 'The ID of the request.',
+ 'type' => 'string',
+ 'example' => '0000-ABCD-EF****',
+ ],
+ 'PagingInfo' => [
+ 'description' => 'The pagination information.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'PageNumber' => [
+ 'description' => 'The page number.',
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '1',
+ ],
+ 'PageSize' => [
+ 'description' => 'The number of entries displayed on each page.',
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '10',
+ ],
+ 'TotalCount' => [
+ 'description' => 'The total number of entries returned.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '12',
+ ],
+ 'CheckProcesses' => [
+ 'description' => 'The check details of the extension.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'ProjectId' => [
+ 'description' => 'The ID of the DataWorks workspace.',
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '32563',
+ ],
+ 'Status' => [
+ 'description' => 'The status of the extender check.'."\n"
+ .'- CHECKING CHECKING'."\n"
+ .'- PASSED the pass check'."\n"
+ .'- BLOCKED check failed',
+ 'type' => 'string',
+ 'example' => 'CHECKING',
+ ],
+ 'EventCode' => [
+ 'description' => 'Extension point event encoding.',
+ 'type' => 'string',
+ 'example' => 'commit-file',
+ ],
+ 'EventName' => [
+ 'description' => 'The name of the extension point event.',
+ 'type' => 'string',
+ 'example' => 'DnsEvent',
+ ],
+ 'EventNameEn' => [
+ 'description' => 'The English name of the event.',
+ 'type' => 'string',
+ 'example' => 'Pre-event for Node Commit',
+ ],
+ 'ProcessName' => [
+ 'description' => 'The name of the check object, such as the file name or node name.'."\n",
+ 'type' => 'string',
+ 'example' => 'odps_sql_test',
+ ],
+ 'MessageId' => [
+ 'description' => 'DataWorks the message ID of the open message. After an extended point event is triggered, you can obtain the message ID from the received event message.',
+ 'type' => 'string',
+ 'example' => 'b824a5de-4223-4315-af3e-c4449d236db4',
+ ],
+ 'ProcessId' => [
+ 'description' => 'The ID of the process instance.',
+ 'type' => 'string',
+ 'example' => 'rdk_generate_d395da25-b0d3-4114-b2a5-d0247444a661_none_3496903_365203',
+ ],
+ 'Operator' => [
+ 'description' => 'The operator ID.'."\n",
+ 'type' => 'string',
+ 'example' => '297635',
+ ],
+ ],
+ 'description' => '',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'staticInfo' => [
+ 'returnType' => 'synchronous',
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0000-ABCD-EF****\\",\\n \\"PagingInfo\\": {\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 12,\\n \\"CheckProcesses\\": [\\n {\\n \\"ProjectId\\": 32563,\\n \\"Status\\": \\"CHECKING\\",\\n \\"EventCode\\": \\"commit-file\\",\\n \\"EventName\\": \\"DnsEvent\\",\\n \\"EventNameEn\\": \\"Pre-event for Node Commit\\",\\n \\"ProcessName\\": \\"odps_sql_test\\",\\n \\"MessageId\\": \\"b824a5de-4223-4315-af3e-c4449d236db4\\",\\n \\"ProcessId\\": \\"rdk_generate_d395da25-b0d3-4114-b2a5-d0247444a661_none_3496903_365203\\",\\n \\"Operator\\": \\"297635\\"\\n }\\n ]\\n }\\n}","type":"json"}]',
+ 'title' => 'ListCheckProcesses',
+ ],
+ 'UpdateTableAddColumn' => [
+ 'summary' => 'Updates the fields in a MaxCompute table.',
+ 'methods' => [
+ 'post',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'write',
+ 'deprecated' => true,
+ 'systemTags' => [
+ 'operationType' => 'update',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeCode' => '78383',
+ 'abilityTreeNodes' => [
+ 'FEATUREdideRZEBFC',
+ ],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'TableGuid',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The globally unique identifier (GUID) of the MaxCompute table. Specify the GUID in the odps.projectName.tableName format.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'odps.engine_name.table_name',
+ ],
+ ],
+ [
+ 'name' => 'Column',
+ 'in' => 'formData',
+ 'style' => 'repeatList',
+ 'schema' => [
+ 'description' => 'The fields.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The field.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'ColumnNameCn' => [
+ 'description' => 'The display name of the field.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'Chinese',
+ ],
+ 'ColumnName' => [
+ 'description' => 'The name of the field.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => 'abc',
+ ],
+ 'Comment' => [
+ 'description' => 'The comment of the field.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'Remarks',
+ ],
+ 'ColumnType' => [
+ 'description' => 'The type of the field. For more information, see MaxCompute field types.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => 'string',
+ ],
+ ],
+ 'required' => false,
+ ],
+ 'required' => true,
+ 'maxItems' => 100,
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'description' => 'The response parameters.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'description' => 'The request ID.'."\n",
+ 'type' => 'string',
+ 'example' => 'abc',
+ ],
+ 'TaskInfo' => [
+ 'description' => 'The information about the request task. After a request task is submitted, it is divided into multiple subtasks that are run in sequence. After the current subtask is complete, the next subtask starts to run. After all subtasks are complete, the request task is complete. If a request task is aborted due to one of the following issues, address the issue based on the error code and initiate the request task again:'."\n"
+ ."\n"
+ .'* The request task fails to be submitted.'."\n"
+ .'* After the request task is submitted, a subtask fails to run.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'Status' => [
+ 'description' => 'The status of the current subtask. Valid values:'."\n"
+ ."\n"
+ .'* operating: The subtask is running.'."\n"
+ .'* success: The subtask succeeds.'."\n"
+ .'* failure: The subtask fails to run. For more information about the error details, see the Content parameter.'."\n",
+ 'type' => 'string',
+ 'example' => 'success',
+ ],
+ 'NextTaskId' => [
+ 'description' => 'The ID of the subtask that you want to run. If this parameter is left empty, all subtasks are complete.'."\n",
+ 'type' => 'string',
+ 'example' => 'abc1',
+ ],
+ 'TaskId' => [
+ 'description' => 'The ID of the current subtask.'."\n",
+ 'type' => 'string',
+ 'example' => 'abc2',
+ ],
+ 'Content' => [
+ 'description' => 'The details about the status of the current subtask.'."\n"
+ ."\n"
+ .'* If the current subtask is successful, success is returned.'."\n"
+ .'* If the current subtask fails, the error details are displayed.'."\n",
+ 'type' => 'string',
+ 'example' => 'success',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'errorCodes' => [
+ 403 => [
+ [
+ 'errorCode' => 'Forbidden.Access',
+ 'errorMessage' => 'Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.',
+ ],
+ ],
+ 429 => [
+ [
+ 'errorCode' => 'Throttling.Api',
+ 'errorMessage' => 'The request for this resource has exceeded your available limit.',
+ ],
+ [
+ 'errorCode' => 'Throttling.Api.Risk',
+ 'errorMessage' => 'The request for this resource has exceeded your daily available limit.',
+ ],
+ [
+ 'errorCode' => 'Throttling.System',
+ 'errorMessage' => 'The DataWorks system is busy. Try again later.',
+ ],
+ [
+ 'errorCode' => 'Throttling.User',
+ 'errorMessage' => 'Your request is too frequent. Try again later.',
+ ],
+ ],
+ 500 => [
+ [
+ 'errorCode' => 'InternalError.System',
+ 'errorMessage' => 'An internal system error occurred. Try again later.',
+ ],
+ [
+ 'errorCode' => 'InternalError.UserId.Missing',
+ 'errorMessage' => 'An internal system error occurred. Try again later.',
+ ],
+ ],
+ ],
+ 'staticInfo' => [
+ 'noSubstitutionReason' => '无替代API，历史原因导致该API被标记为弃用。',
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"abc\\",\\n \\"TaskInfo\\": {\\n \\"Status\\": \\"success\\",\\n \\"NextTaskId\\": \\"abc1\\",\\n \\"TaskId\\": \\"abc2\\",\\n \\"Content\\": \\"success\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"<UpdateTableAddColumnResponse>\\n <TaskInfo>\\n <Status>success</Status>\\n <TaskId>abc2</TaskId>\\n <Content>success</Content>\\n <NextTaskId>abc1</NextTaskId>\\n </TaskInfo>\\n <RequestId>abc</RequestId>\\n</UpdateTableAddColumnResponse>","errorExample":""}]',
+ 'title' => 'UpdateTableAddColumn',
+ 'requestParamsDescription' => ' ',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ ],
+ 'GetMetaTableFullInfo' => [
+ 'summary' => 'Queries the complete information about a table, including information about fields in the table.',
+ 'methods' => [
+ 'get',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => true,
+ 'systemTags' => [
+ 'operationType' => 'get',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeCode' => '78264',
+ 'abilityTreeNodes' => [
+ 'FEATUREdideRZEBFC',
+ ],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'TableGuid',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The unique identifier of the table. You can call the [GetMetaDBTableList](~~173916~~) operation to query the unique identifier of the table.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'docRequired' => true,
+ 'example' => 'odps.engine_name.table_name',
+ ],
+ ],
+ [
+ 'name' => 'PageNum',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The page number requested for pagination.',
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => false,
+ 'example' => '1',
+ ],
+ ],
+ [
+ 'name' => 'PageSize',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The number of items per page, with a default of 10 and a maximum of 100.',
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => false,
+ 'example' => '10',
+ ],
+ ],
+ [
+ 'name' => 'ClusterId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the EMR cluster. This parameter is required only if you set the DataSourceType parameter to emr.'."\n"
+ ."\n"
+ .'You can log on to the [EMR console](https://emr.console.aliyun.com/?spm=a2c4g.11186623.0.0.965cc5c2GeiHet#/cn-hangzhou) to query the ID.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'C-010A704DA760****',
+ ],
+ ],
+ [
+ 'name' => 'DatabaseName',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The name of the database. This parameter is required only if you set the DataSourceType parameter to emr.'."\n"
+ ."\n"
+ .'You can call the [ListMetaDB](~~185662~~) operation to query the database name.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'abc',
+ ],
+ ],
+ [
+ 'name' => 'TableName',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The name of the table in the EMR cluster. This parameter is required only if you set the DataSourceType parameter to emr.'."\n"
+ ."\n"
+ .'You can call the [GetMetaDBTableList](~~173916~~) operation to query the table name.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'abc',
+ ],
+ ],
+ [
+ 'name' => 'DataSourceType',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The type of the data source. Set the value to emr.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'emr',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'description' => 'The response parameters.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'HttpStatusCode' => [
+ 'description' => 'The HTTP status code.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '200',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message.'."\n",
+ 'type' => 'string',
+ 'example' => 'The specified parameters are invalid.',
+ ],
+ 'RequestId' => [
+ 'description' => 'The request ID.'."\n",
+ 'type' => 'string',
+ 'example' => '0bc1411515937****',
+ ],
+ 'Success' => [
+ 'description' => 'Indicates whether the request was successful.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code.'."\n",
+ 'type' => 'string',
+ 'example' => '1031203110005',
+ ],
+ 'Data' => [
+ 'description' => 'The business data.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'TableName' => [
+ 'description' => 'The name of the table.'."\n",
+ 'type' => 'string',
+ 'example' => 'table_name',
+ ],
+ 'Comment' => [
+ 'description' => 'The comment on the table.'."\n",
+ 'type' => 'string',
+ 'example' => 'comment',
+ ],
+ 'LifeCycle' => [
+ 'description' => 'The lifecycle of the table. Unit: days.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '5',
+ ],
+ 'CreateTime' => [
+ 'description' => 'The time when the table was created. A timestamp is returned for this parameter. You can convert the timestamp to the related date based on the time zone that you use.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '1589870293000',
+ ],
+ 'ProjectName' => [
+ 'description' => 'The name of the workspace to which the table belongs.'."\n",
+ 'type' => 'string',
+ 'example' => 'test',
+ ],
+ 'ProjectId' => [
+ 'description' => 'The ID of the workspace to which the table belongs.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '22',
+ ],
+ 'OwnerId' => [
+ 'description' => 'The ID of the table owner.'."\n",
+ 'type' => 'string',
+ 'example' => '123',
+ ],
+ 'EnvType' => [
+ 'description' => 'The type of the environment. Valid values:'."\n"
+ ."\n"
+ .'* 0: indicates that the table resides in the development environment.'."\n"
+ .'* 1: indicates that the table resides in the production environment.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '1',
+ ],
+ 'LastAccessTime' => [
+ 'description' => 'The time when the table was last accessed. A timestamp is returned for this parameter. You can convert the timestamp to the related date based on the time zone that you use.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '1589870294000',
+ ],
+ 'DataSize' => [
+ 'description' => 'The size of the storage space that is consumed by the table. Unit: bytes.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '10',
+ ],
+ 'LastModifyTime' => [
+ 'description' => 'The time when the table was last updated. A timestamp is returned for this parameter. You can convert the timestamp to the related date based on the time zone that you use.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '1589870294000',
+ ],
+ 'DatabaseName' => [
+ 'description' => 'The name of the database.'."\n",
+ 'type' => 'string',
+ 'example' => 'abc',
+ ],
+ 'IsVisible' => [
+ 'description' => 'The scope in which the table is visible. Valid values:'."\n"
+ ."\n"
+ .'* 0: indicates that the table is visible to workspace members.'."\n"
+ .'* 1: indicates that the table is visible to users within a tenant.'."\n"
+ .'* 2: indicates that the table is visible to all tenants.'."\n"
+ .'* 3: indicates that the table is visible only to the table owner.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '1',
+ ],
+ 'TotalColumnCount' => [
+ 'description' => 'The total number of fields.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '22',
+ ],
+ 'TableGuid' => [
+ 'description' => 'The unique identifier of the table.'."\n",
+ 'type' => 'string',
+ 'example' => 'odps.engine_name.table_name',
+ ],
+ 'PartitionKeys' => [
+ 'description' => 'The partition key column.'."\n",
+ 'type' => 'string',
+ 'example' => 'abc',
+ ],
+ 'LastDdlTime' => [
+ 'description' => 'The time when the schema of the table was last changed. A timestamp is returned for this parameter. You can convert the timestamp to the related date based on the time zone that you use.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '1589870294000',
+ ],
+ 'Location' => [
+ 'description' => 'The storage path of the Hive table.'."\n",
+ 'type' => 'string',
+ 'example' => 'hdfs://localhost:777/user/hadoop/test.txt',
+ ],
+ 'ClusterId' => [
+ 'description' => 'The EMR cluster ID.'."\n",
+ 'type' => 'string',
+ 'example' => 'C-010A704DA760****',
+ ],
+ 'TenantId' => [
+ 'description' => 'The tenant ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '12345',
+ ],
+ 'Schema' => [
+ 'description' => 'The schema information of the table.'."\n",
+ 'type' => 'string',
+ 'example' => 'default',
+ ],
+ 'ColumnList' => [
+ 'description' => 'The fields in the table.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The field in the table.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'ColumnName' => [
+ 'description' => 'The name of the field.'."\n",
+ 'type' => 'string',
+ 'example' => '1',
+ ],
+ 'ColumnGuid' => [
+ 'description' => 'The unique identifier of the field.'."\n",
+ 'type' => 'string',
+ 'example' => 'odps.engine_name.table_name.1',
+ ],
+ 'IsPartitionColumn' => [
+ 'description' => 'Indicates whether the field is a partition field. Valid values:'."\n"
+ ."\n"
+ .'* true'."\n"
+ .'* false'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'Comment' => [
+ 'description' => 'The remarks of the field.'."\n",
+ 'type' => 'string',
+ 'example' => 'comment',
+ ],
+ 'ColumnType' => [
+ 'description' => 'The data type of the field.'."\n",
+ 'type' => 'string',
+ 'example' => 'string',
+ ],
+ 'IsPrimaryKey' => [
+ 'description' => 'Indicates whether the field is a primary key. Valid values:'."\n"
+ ."\n"
+ .'* true'."\n"
+ .'* false'."\n",
+ 'type' => 'boolean',
+ 'example' => 'false',
+ ],
+ 'Position' => [
+ 'description' => 'The sequence number of the field.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '1',
+ ],
+ 'Caption' => [
+ 'description' => 'The description of the field.'."\n",
+ 'type' => 'string',
+ 'example' => 'data comment',
+ ],
+ 'IsForeignKey' => [
+ 'description' => 'Indicates whether the field is a foreign key. Valid values:'."\n"
+ ."\n"
+ .'* true'."\n"
+ .'* false'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'errorCodes' => [
+ 400 => [
+ [
+ 'errorCode' => 'InvalidParameter.Meta.CommonError',
+ 'errorMessage' => 'The specified parameter is invalid.',
+ ],
+ [
+ 'errorCode' => 'InvalidParameter.Meta.Illegal',
+ 'errorMessage' => 'The app guid parameter is invalid.',
+ ],
+ [
+ 'errorCode' => 'InvalidParameter.Meta.IllegalDate',
+ 'errorMessage' => 'The date format is invalid.',
+ ],
+ [
+ 'errorCode' => 'InvalidParameter.Meta.IllegalPageError',
+ 'errorMessage' => 'The parameter for paging is invalid.',
+ ],
+ [
+ 'errorCode' => 'InvalidParameter.Meta.NotExist',
+ 'errorMessage' => 'The object does not exist.',
+ ],
+ [
+ 'errorCode' => 'InternalError.Meta.NoCalcEngine',
+ 'errorMessage' => 'An error occurred while retrieving the compute engine based on the MaxCompute project.',
+ ],
+ ],
+ 403 => [
+ [
+ 'errorCode' => 'Forbidden.Meta.NoTenant',
+ 'errorMessage' => 'The user is not the owner of any tenants.',
+ ],
+ [
+ 'errorCode' => 'Forbidden.Access',
+ 'errorMessage' => 'Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.',
+ ],
+ ],
+ 429 => [
+ [
+ 'errorCode' => 'Throttling.Api',
+ 'errorMessage' => 'The request for this resource has exceeded your available limit.',
+ ],
+ [
+ 'errorCode' => 'Throttling.Api.Risk',
+ 'errorMessage' => 'The request for this resource has exceeded your daily available limit.',
+ ],
+ [
+ 'errorCode' => 'Throttling.System',
+ 'errorMessage' => 'The DataWorks system is busy. Try again later.',
+ ],
+ [
+ 'errorCode' => 'Throttling.User',
+ 'errorMessage' => 'Your request is too frequent. Try again later.',
+ ],
+ ],
+ 500 => [
+ [
+ 'errorCode' => 'InternalError.System',
+ 'errorMessage' => 'An internal system error occurred. Try again later.',
+ ],
+ [
+ 'errorCode' => 'InternalError.UserId.Missing',
+ 'errorMessage' => 'An internal system error occurred. Try again later.',
+ ],
+ [
+ 'errorCode' => 'InternalError.Meta.TenantTimeOut',
+ 'errorMessage' => 'Failed to connect to the interface network.',
+ ],
+ [
+ 'errorCode' => 'InternalError.Meta.Unknown',
+ 'errorMessage' => 'An unknown error occurred while processing your request.',
+ ],
+ ],
+ ],
+ 'staticInfo' => [
+ 'noSubstitutionReason' => '无替代API，历史原因导致该API被标记为弃用。',
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"ErrorMessage\\": \\"The specified parameters are invalid.\\",\\n \\"RequestId\\": \\"0bc1411515937****\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"1031203110005\\",\\n \\"Data\\": {\\n \\"TableName\\": \\"table_name\\",\\n \\"Comment\\": \\"comment\\",\\n \\"LifeCycle\\": 5,\\n \\"CreateTime\\": 1589870293000,\\n \\"ProjectName\\": \\"test\\",\\n \\"ProjectId\\": 22,\\n \\"OwnerId\\": \\"123\\",\\n \\"EnvType\\": 1,\\n \\"LastAccessTime\\": 1589870294000,\\n \\"DataSize\\": 10,\\n \\"LastModifyTime\\": 1589870294000,\\n \\"DatabaseName\\": \\"abc\\",\\n \\"IsVisible\\": 1,\\n \\"TotalColumnCount\\": 22,\\n \\"TableGuid\\": \\"odps.engine_name.table_name\\",\\n \\"PartitionKeys\\": \\"abc\\",\\n \\"LastDdlTime\\": 1589870294000,\\n \\"Location\\": \\"hdfs://localhost:777/user/hadoop/test.txt\\",\\n \\"ClusterId\\": \\"C-010A704DA760****\\",\\n \\"TenantId\\": 12345,\\n \\"Schema\\": \\"default\\",\\n \\"ColumnList\\": [\\n {\\n \\"ColumnName\\": \\"1\\",\\n \\"ColumnGuid\\": \\"odps.engine_name.table_name.1\\",\\n \\"IsPartitionColumn\\": true,\\n \\"Comment\\": \\"comment\\",\\n \\"ColumnType\\": \\"string\\",\\n \\"IsPrimaryKey\\": false,\\n \\"Position\\": 1,\\n \\"Caption\\": \\"data comment\\",\\n \\"IsForeignKey\\": true\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<GetMetaTableFullInfoResponse>\\n <HttpStatusCode>200</HttpStatusCode>\\n <ErrorMessage>The specified parameters are invalid.</ErrorMessage>\\n <RequestId>0bc1411515937****</RequestId>\\n <Success>true</Success>\\n <ErrorCode>1031203110005</ErrorCode>\\n <Data>\\n <TableName>table_name</TableName>\\n <Comment>comment</Comment>\\n <LifeCycle>5</LifeCycle>\\n <CreateTime>1589870293000</CreateTime>\\n <ProjectName>test</ProjectName>\\n <ProjectId>22</ProjectId>\\n <OwnerId>123</OwnerId>\\n <EnvType>1</EnvType>\\n <LastAccessTime>1589870294000</LastAccessTime>\\n <DataSize>10</DataSize>\\n <LastModifyTime>1589870294000</LastModifyTime>\\n <DatabaseName>abc</DatabaseName>\\n <IsVisible>1</IsVisible>\\n <TotalColumnCount>22</TotalColumnCount>\\n <TableGuid>odps.engine_name.table_name</TableGuid>\\n <PartitionKeys>abc</PartitionKeys>\\n <LastDdlTime>1589870294000</LastDdlTime>\\n <Location>hdfs://localhost:777/user/hadoop/test.txt</Location>\\n <ClusterId>C-010A704DA760****</ClusterId>\\n <TenantId>12345</TenantId>\\n <Schema>default</Schema>\\n <ColumnList>\\n <ColumnName>1</ColumnName>\\n <ColumnGuid>odps.engine_name.table_name.1</ColumnGuid>\\n <IsPartitionColumn>true</IsPartitionColumn>\\n <Comment>comment</Comment>\\n <ColumnType>string</ColumnType>\\n <IsPrimaryKey>false</IsPrimaryKey>\\n <Position>1</Position>\\n <Caption>data comment</Caption>\\n <IsForeignKey>true</IsForeignKey>\\n </ColumnList>\\n </Data>\\n</GetMetaTableFullInfoResponse>","errorExample":""}]',
+ 'title' => 'GetMetaTableFullInfo',
+ 'description' => 'You can call this operation to query only the information about a table of the E-MapReduce (EMR) compute engine type.'."\n",
+ 'requestParamsDescription' => ' ',
+ 'responseParamsDescription' => ' ',
+ 'translator' => 'machine',
+ ],
+ 'GetDDLJobStatus' => [
+ 'summary' => 'Queries the status of a table creation, update, or deletion task.',
+ 'methods' => [
+ 'get',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => true,
+ 'systemTags' => [
+ 'operationType' => 'get',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeNodes' => [
+ 'FEATUREdideX3KVYR',
+ ],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'TaskId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the DDL task.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'abc',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'description' => 'The request ID.'."\n",
+ 'type' => 'string',
+ 'example' => 'abc',
+ ],
+ 'Data' => [
+ 'description' => 'The details of the task.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'Status' => [
+ 'description' => 'The status of the task.'."\n",
+ 'type' => 'string',
+ 'example' => 'success',
+ ],
+ 'NextTaskId' => [
+ 'description' => 'The ID of the ongoing task. If no value is returned for this parameter, all subtasks are complete.'."\n",
+ 'type' => 'string',
+ 'example' => 'abc1',
+ ],
+ 'TaskId' => [
+ 'description' => 'The task ID.'."\n",
+ 'type' => 'string',
+ 'example' => 'abc',
+ ],
+ 'Content' => [
+ 'description' => 'The content of the task.'."\n",
+ 'type' => 'string',
+ 'example' => 'success',
+ ],
+ ],
+ ],
+ ],
+ 'description' => '',
+ ],
+ ],
+ ],
+ 'errorCodes' => [
+ 403 => [
+ [
+ 'errorCode' => 'Forbidden.Access',
+ 'errorMessage' => 'Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.',
+ ],
+ ],
+ 429 => [
+ [
+ 'errorCode' => 'Throttling.Api',
+ 'errorMessage' => 'The request for this resource has exceeded your available limit.',
+ ],
+ [
+ 'errorCode' => 'Throttling.Api.Risk',
+ 'errorMessage' => 'The request for this resource has exceeded your daily available limit.',
+ ],
+ [
+ 'errorCode' => 'Throttling.System',
+ 'errorMessage' => 'The DataWorks system is busy. Try again later.',
+ ],
+ [
+ 'errorCode' => 'Throttling.User',
+ 'errorMessage' => 'Your request is too frequent. Try again later.',
+ ],
+ ],
+ 500 => [
+ [
+ 'errorCode' => 'InternalError.System',
+ 'errorMessage' => 'An internal system error occurred. Try again later.',
+ ],
+ [
+ 'errorCode' => 'InternalError.UserId.Missing',
+ 'errorMessage' => 'An internal system error occurred. Try again later.',
+ ],
+ ],
+ ],
+ 'staticInfo' => [
+ 'noSubstitutionReason' => '无替代API，历史原因导致该API被标记为弃用。',
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"abc\\",\\n \\"Data\\": {\\n \\"Status\\": \\"success\\",\\n \\"NextTaskId\\": \\"abc1\\",\\n \\"TaskId\\": \\"abc\\",\\n \\"Content\\": \\"success\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"<RequestId>abc</RequestId>\\n<Data>\\n <Status>success</Status>\\n <TaskId>abc</TaskId>\\n <Content>success</Content>\\n <NextTaskId>abc1</NextTaskId>\\n</Data>","errorExample":""}]',
+ 'title' => 'GetDDLJobStatus',
+ 'requestParamsDescription' => ' ',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ ],
+ 'DeleteTable' => [
+ 'summary' => 'Deletes a MaxCompute table.',
+ 'methods' => [
+ 'post',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'write',
+ 'deprecated' => true,
+ 'systemTags' => [
+ 'operationType' => 'delete',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeCode' => '78218',
+ 'abilityTreeNodes' => [
+ 'FEATUREdideRZEBFC',
+ ],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'ProjectId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the DataWorks workspace.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'docRequired' => true,
+ 'maximum' => '9223372036854775807',
+ 'minimum' => '1',
+ 'example' => '101',
+ ],
+ ],
+ [
+ 'name' => 'TableName',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The name of the MaxCompute table.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'table1',
+ ],
+ ],
+ [
+ 'name' => 'EnvType',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The type of the compute engine or data source. Valid values:'."\n"
+ ."\n"
+ .'* cdh'."\n"
+ .'* analyticdb_for_mysql'."\n"
+ .'* odps'."\n"
+ .'* emr'."\n"
+ .'* hadoop'."\n"
+ .'* holodb'."\n"
+ .'* hybriddb_for_postgresql'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => false,
+ 'docRequired' => true,
+ 'maximum' => '1',
+ 'minimum' => '0',
+ 'example' => '1',
+ ],
+ ],
+ [
+ 'name' => 'AppGuid',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The globally unique identifier (GUID) of the MaxCompute project. Specify the GUID in the odps.{projectName} format.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'odps.test',
+ ],
+ ],
+ [
+ 'name' => 'Schema',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The schema information of the table. You need to enter the schema information of the table if you enable the table schema in MaxCompute.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'default',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'description' => 'The ID of the request.'."\n",
+ 'type' => 'string',
+ 'example' => 'abcde',
+ ],
+ 'TaskInfo' => [
+ 'description' => 'The information about the task that is used to delete the table.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'Status' => [
+ 'description' => 'The status of the task that is complete.'."\n",
+ 'type' => 'string',
+ 'example' => 'success',
+ ],
+ 'NextTaskId' => [
+ 'description' => 'The ID of the task that is running.'."\n",
+ 'type' => 'string',
+ 'example' => 'abc1',
+ ],
+ 'TaskId' => [
+ 'description' => 'The ID of the task that is complete.'."\n",
+ 'type' => 'string',
+ 'example' => 'abc',
+ ],
+ 'Content' => [
+ 'description' => 'The content of the task.'."\n",
+ 'type' => 'string',
+ 'example' => 'success',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'errorCodes' => [
+ 403 => [
+ [
+ 'errorCode' => 'Forbidden.Access',
+ 'errorMessage' => 'Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.',
+ ],
+ ],
+ 429 => [
+ [
+ 'errorCode' => 'Throttling.Api',
+ 'errorMessage' => 'The request for this resource has exceeded your available limit.',
+ ],
+ [
+ 'errorCode' => 'Throttling.Api.Risk',
+ 'errorMessage' => 'The request for this resource has exceeded your daily available limit.',
+ ],
+ [
+ 'errorCode' => 'Throttling.System',
+ 'errorMessage' => 'The DataWorks system is busy. Try again later.',
+ ],
+ [
+ 'errorCode' => 'Throttling.User',
+ 'errorMessage' => 'Your request is too frequent. Try again later.',
+ ],
+ ],
+ 500 => [
+ [
+ 'errorCode' => 'InternalError.System',
+ 'errorMessage' => 'An internal system error occurred. Try again later.',
+ ],
+ [
+ 'errorCode' => 'InternalError.UserId.Missing',
+ 'errorMessage' => 'An internal system error occurred. Try again later.',
+ ],
+ ],
+ ],
+ 'staticInfo' => [
+ 'noSubstitutionReason' => '无替代API，历史原因导致该API被标记为弃用。',
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"abcde\\",\\n \\"TaskInfo\\": {\\n \\"Status\\": \\"success\\",\\n \\"NextTaskId\\": \\"abc1\\",\\n \\"TaskId\\": \\"abc\\",\\n \\"Content\\": \\"success\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"<TaskInfo>\\n <Status>success</Status>\\n <TaskId>abc</TaskId>\\n <Content>success</Content>\\n <NextTaskId>abc1</NextTaskId>\\n</TaskInfo>\\n<RequestId>abcde</RequestId>","errorExample":""}]',
+ 'title' => 'DeleteTable',
+ 'requestParamsDescription' => ' ',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ ],
+ 'UpdateTable' => [
+ 'summary' => 'Updates a MaxCompute table.',
+ 'methods' => [
+ 'post',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'write',
+ 'deprecated' => true,
+ 'systemTags' => [
+ 'operationType' => 'update',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeCode' => '78382',
+ 'abilityTreeNodes' => [
+ 'FEATUREdideX3KVYR',
+ ],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'IsView',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'Specifies whether the table is a view. Valid values: 0 and 1. The value 0 indicates that the table is not a view. The value 1 indicates that the table is a view. This parameter is deprecated. Do not use this parameter.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => false,
+ 'example' => '0',
+ ],
+ ],
+ [
+ 'name' => 'Visibility',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The scope in which the table is visible. Valid values: 0, 1, and 2. The value 0 indicates that the table is invisible to all workspace members. The value 1 indicates that the table is visible to all workspace members. The value 2 indicates that the table is visible to workspace members.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => false,
+ 'example' => '1',
+ ],
+ ],
+ [
+ 'name' => 'LifeCycle',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The lifecycle of the table. Unit: days. If this parameter is left empty, the table is permanently stored.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => false,
+ 'example' => '10',
+ ],
+ ],
+ [
+ 'name' => 'CategoryId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the associated category.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'maximum' => '9223372036854775807',
+ 'minimum' => '1',
+ 'example' => '101',
+ ],
+ ],
+ [
+ 'name' => 'LogicalLevelId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the logical level.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'maximum' => '9223372036854775807',
+ 'minimum' => '1',
+ 'example' => '101',
+ ],
+ ],
+ [
+ 'name' => 'PhysicsLevelId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the physical layer.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'maximum' => '9223372036854775807',
+ 'minimum' => '1',
+ 'example' => '101',
+ ],
+ ],
+ [
+ 'name' => 'ExternalTableType',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The type of the external table. Valid values: 0, 1, 2, and 3. The value 0 indicates that the external table is an OSS external table. The value 1 indicates that the external table is a Tablestore external table. The value 2 indicates that the external table is a volume external table. The value 3 indicates that the external table is a MySQL external table. This parameter is deprecated. Do not use this parameter.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => '1',
+ ],
+ ],
+ [
+ 'name' => 'Location',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The storage location of the external table. This parameter is deprecated. Do not use this parameter.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'location',
+ ],
+ ],
+ [
+ 'name' => 'ProjectId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The DataWorks workspace ID. You can log on to the DataWorks console to obtain the ID of the DataWorks workspace.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'maximum' => '9223372036854775807',
+ 'minimum' => '1',
+ 'example' => '101',
+ ],
+ ],
+ [
+ 'name' => 'TableName',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The name of the MaxCompute table.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'abc',
+ ],
+ ],
+ [
+ 'name' => 'Endpoint',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The endpoint of MaxCompute. If you do not specify this parameter, the endpoint of the MaxCompute project is used.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'odps://',
+ ],
+ ],
+ [
+ 'name' => 'EnvType',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The environment of the DataWorks workspace. Valid values: 0 and 1. The value 0 indicates the development environment. The value 1 indicates the production environment.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => false,
+ 'example' => '1',
+ ],
+ ],
+ [
+ 'name' => 'AppGuid',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The unique identifier of the MaxCompute project. Specify the GUID in the odps.{projectName} format.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'odps.test',
+ ],
+ ],
+ [
+ 'name' => 'CreateIfNotExists',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'Specifies whether the table exists. Valid values:'."\n"
+ ."\n"
+ .'* true: The table exists.'."\n"
+ .'* false: The table does not exist.'."\n"
+ ."\n"
+ .'This parameter is deprecated. Do not use this parameter.'."\n",
+ 'type' => 'boolean',
+ 'required' => false,
+ 'example' => 'true',
+ ],
+ ],
+ [
+ 'name' => 'HasPart',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'Specifies whether the table that you want to update is a partitioned table. Valid values: 0 and 1. The value 0 indicates that the table is not a partitioned table. The value 1 indicates that the table is a partitioned table. This parameter is deprecated. Do not use this parameter. The Column.N.isPartitionCol parameter is used instead of the HasPart parameter to specify whether the MaxCompute table is a partitioned table. If the Column.N.isPartitionCol parameter is set to 1, the MaxCompute table is a partitioned table.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => false,
+ 'example' => '0',
+ ],
+ ],
+ [
+ 'name' => 'Comment',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The comment.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'comment',
+ ],
+ ],
+ [
+ 'name' => 'Schema',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The schema information of the table. You need to enter the schema information of the table if you enable the table schema in MaxCompute.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'default',
+ ],
+ ],
+ [
+ 'name' => 'Columns',
+ 'in' => 'formData',
+ 'style' => 'repeatList',
+ 'schema' => [
+ 'description' => 'The list of fields.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '',
+ 'type' => 'object',
+ 'properties' => [
+ 'ColumnNameCn' => [
+ 'description' => 'The display name of the field.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => '',
+ ],
+ 'ColumnName' => [
+ 'description' => 'The name of the field.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => 'abc',
+ ],
+ 'Comment' => [
+ 'description' => 'The comment of the field.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'comment',
+ ],
+ 'ColumnType' => [
+ 'description' => 'The type of the field. For more information, see MaxCompute field types.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => 'string',
+ ],
+ 'SeqNumber' => [
+ 'description' => 'The sequence number of the field. If the field is a partition field, this parameter is not supported.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => false,
+ 'example' => '1',
+ ],
+ 'Length' => [
+ 'description' => 'The length of the field.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => false,
+ 'example' => '10',
+ ],
+ 'IsPartitionCol' => [
+ 'description' => 'Specifies whether the field is a partition field. Valid values: 0 and 1. The value 0 indicates that the field is not a partition field. The value 1 indicates that the field is a partition field.'."\n",
+ 'type' => 'boolean',
+ 'required' => false,
+ 'example' => '0',
+ ],
+ ],
+ 'required' => false,
+ ],
+ 'required' => false,
+ 'maxItems' => 100,
+ ],
+ ],
+ [
+ 'name' => 'Themes',
+ 'in' => 'formData',
+ 'style' => 'repeatList',
+ 'schema' => [
+ 'description' => 'The list of fields.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '',
+ 'type' => 'object',
+ 'properties' => [
+ 'ThemeId' => [
+ 'description' => 'The ID of the associated topic.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'maximum' => '9223372036854775807',
+ 'minimum' => '1',
+ 'example' => '101',
+ ],
+ 'ThemeLevel' => [
+ 'description' => 'The level that corresponds to the topic ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => false,
+ 'example' => '101',
+ ],
+ ],
+ 'required' => false,
+ ],
+ 'required' => false,
+ 'maxItems' => 100,
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'description' => 'The returned result.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'description' => 'The request ID.'."\n",
+ 'type' => 'string',
+ 'example' => 'abcde',
+ ],
+ 'TaskInfo' => [
+ 'description' => 'The information about the request task. After a request task is submitted, it is divided into multiple subtasks that are run in sequence. After the current subtask is complete, the next subtask starts to run. After all subtasks are complete, the request task is complete. If a request task is terminated due to one of the following issues, address the issue based on the error code and initiate the request task again:'."\n"
+ ."\n"
+ .'* The request task fails to be submitted.'."\n"
+ .'* After the request task is submitted, a subtask fails to run.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'Status' => [
+ 'description' => 'The status of the current subtask. Valid values:'."\n"
+ ."\n"
+ .'* operating: The subtask is running.'."\n"
+ .'* success: The subtask succeeds.'."\n"
+ .'* failure: The subtask fails to run. For more information about the error details, see the Content parameter.'."\n",
+ 'type' => 'string',
+ 'example' => 'success',
+ ],
+ 'NextTaskId' => [
+ 'description' => 'The ID of the subtask that you want to run. If this parameter is left empty, all subtasks are complete. You can call the [GetDDLJobStatus](~~185659~~) operation to query the status of the subtask based on the subtask ID.'."\n",
+ 'type' => 'string',
+ 'example' => 'abc1',
+ ],
+ 'TaskId' => [
+ 'description' => 'The ID of the current subtask.'."\n",
+ 'type' => 'string',
+ 'example' => 'abc',
+ ],
+ 'Content' => [
+ 'description' => 'The details about the status of the current subtask. Valid values:'."\n"
+ ."\n"
+ .'* If the current subtask is successful, success is returned.'."\n"
+ .'* If the current subtask fails, the error details are displayed.'."\n",
+ 'type' => 'string',
+ 'example' => 'success',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'errorCodes' => [
+ 403 => [
+ [
+ 'errorCode' => 'Forbidden.Access',
+ 'errorMessage' => 'Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.',
+ ],
+ ],
+ 429 => [
+ [
+ 'errorCode' => 'Throttling.Api',
+ 'errorMessage' => 'The request for this resource has exceeded your available limit.',
+ ],
+ [
+ 'errorCode' => 'Throttling.Api.Risk',
+ 'errorMessage' => 'The request for this resource has exceeded your daily available limit.',
+ ],
+ [
+ 'errorCode' => 'Throttling.System',
+ 'errorMessage' => 'The DataWorks system is busy. Try again later.',
+ ],
+ [
+ 'errorCode' => 'Throttling.User',
+ 'errorMessage' => 'Your request is too frequent. Try again later.',
+ ],
+ ],
+ 500 => [
+ [
+ 'errorCode' => 'InternalError.System',
+ 'errorMessage' => 'An internal system error occurred. Try again later.',
+ ],
+ [
+ 'errorCode' => 'InternalError.UserId.Missing',
+ 'errorMessage' => 'An internal system error occurred. Try again later.',
+ ],
+ ],
+ ],
+ 'staticInfo' => [
+ 'noSubstitutionReason' => '无替代API，历史原因导致该API被标记为弃用。',
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"abcde\\",\\n \\"TaskInfo\\": {\\n \\"Status\\": \\"success\\",\\n \\"NextTaskId\\": \\"abc1\\",\\n \\"TaskId\\": \\"abc\\",\\n \\"Content\\": \\"success\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"<UpdateTableResponse>\\n <TaskInfo>\\n <Status>success</Status>\\n <TaskId>abc</TaskId>\\n <Content>success</Content>\\n <NextTaskId>abc1</NextTaskId>\\n </TaskInfo>\\n <RequestId>abcde</RequestId>\\n</UpdateTableResponse>","errorExample":""}]',
+ 'title' => 'UpdateTable',
+ 'requestParamsDescription' => ' ',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ ],
+ 'CreateTable' => [
+ 'summary' => 'Creates a MaxCompute table or view.',
+ 'methods' => [
+ 'post',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'write',
+ 'deprecated' => true,
+ 'systemTags' => [
+ 'operationType' => 'create',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeCode' => '78197',
+ 'abilityTreeNodes' => [
+ 'FEATUREdideRZEBFC',
+ ],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'IsView',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'Specifies whether to create a view or table. Valid values:'."\n"
+ ."\n"
+ .'* 0: Create a table.'."\n"
+ .'* 1: Create a view.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => false,
+ 'example' => '0',
+ ],
+ ],
+ [
+ 'name' => 'Visibility',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'Specifies whether the table or workspace is visible. Valid values:'."\n"
+ ."\n"
+ .'* 0: Both the table and workspace are invisible.'."\n"
+ .'* 1: Both the table and workspace are visible.'."\n"
+ .'* 2: Only the workspace is visible.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => false,
+ 'example' => '1',
+ ],
+ ],
+ [
+ 'name' => 'LifeCycle',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The lifecycle of the table. Unit: days. By default, this parameter is left empty, which indicates that the table is permanently stored.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => false,
+ 'example' => '10',
+ ],
+ ],
+ [
+ 'name' => 'CategoryId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the associated category. You can call the [GetMetaCategory](~~173932~~) operation to query the IDs of all categories that can be associated.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'maximum' => '9223372036854775807',
+ 'minimum' => '1',
+ 'example' => '101',
+ ],
+ ],
+ [
+ 'name' => 'LogicalLevelId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the logical level.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'maximum' => '9223372036854775807',
+ 'minimum' => '1',
+ 'example' => '101',
+ ],
+ ],
+ [
+ 'name' => 'PhysicsLevelId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the physical level.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'maximum' => '9223372036854775807',
+ 'minimum' => '1',
+ 'example' => '101',
+ ],
+ ],
+ [
+ 'name' => 'ExternalTableType',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The storage type of the external table. Valid values:'."\n"
+ ."\n"
+ .'* 0: Object Storage Service (OSS)'."\n"
+ .'* 1: Tablestore'."\n"
+ .'* 2: Volume'."\n"
+ .'* 3: MySQL'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => '0',
+ ],
+ ],
+ [
+ 'name' => 'Location',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The storage location of the external table.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'location',
+ ],
+ ],
+ [
+ 'name' => 'ProjectId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The DataWorks workspace ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'maximum' => '9223372036854775807',
+ 'minimum' => '1',
+ 'example' => '23',
+ ],
+ ],
+ [
+ 'name' => 'TableName',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The name of the table.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'tableName1',
+ ],
+ ],
+ [
+ 'name' => 'Endpoint',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The endpoint of MaxCompute.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'odps://abc',
+ ],
+ ],
+ [
+ 'name' => 'EnvType',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The environment type of the DataWorks workspace. Valid values:'."\n"
+ ."\n"
+ .'* 0: development environment'."\n"
+ .'* 1: production environment'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => false,
+ 'example' => '1',
+ ],
+ ],
+ [
+ 'name' => 'AppGuid',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the MaxCompute project. Specify the ID in the odps.{projectName} format.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'odps.test',
+ ],
+ ],
+ [
+ 'name' => 'Comment',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The comment.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'comment',
+ ],
+ ],
+ [
+ 'name' => 'HasPart',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'Specifies whether to create a MaxCompute partitioned table. Valid values: 1 and 0. The value 1 indicates a partitioned table. The value 0 indicates a non-partitioned table. This parameter is deprecated. Do not use this parameter. The Column.N.isPartitionCol parameter is used to specify whether to create a MaxCompute partitioned table. If the Column.N.isPartitionCol parameter is set to true, a MaxCompute partitioned table is created.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => false,
+ 'example' => '0',
+ ],
+ ],
+ [
+ 'name' => 'ClientToken',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'A reserved parameter.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'reserved',
+ ],
+ ],
+ [
+ 'name' => 'Schema',
+ 'in' => 'query',
+ 'allowEmptyValue' => false,
+ 'schema' => [
+ 'description' => 'The schema information of the table. You need to enter the schema information of the table if you enable the table schema in MaxCompute.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'default',
+ ],
+ ],
+ [
+ 'name' => 'Columns',
+ 'in' => 'formData',
+ 'style' => 'repeatList',
+ 'schema' => [
+ 'description' => 'The list of fields. A maximum of 1,000 fields are supported.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The field.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'ColumnNameCn' => [
+ 'description' => 'The display name of the field.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'columnName in chinese',
+ ],
+ 'ColumnName' => [
+ 'description' => 'The name of the field. You can configure a maximum of 1,000 fields when you call the CreateTable operation to create a table.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => 'columnName1',
+ ],
+ 'Comment' => [
+ 'description' => 'The comment of the field.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'comment',
+ ],
+ 'ColumnType' => [
+ 'description' => 'The data type of the field. For information about supported data types, see [Data type editions](~~27821~~) in MaxCompute documentation.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => 'string',
+ ],
+ 'SeqNumber' => [
+ 'description' => 'The sequence number of the field. You can use this parameter to specify how fields are sorted in a table. By default, fields are sorted based on the order in which requests are created. If the field is a partition field, this parameter is not supported.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => false,
+ 'example' => '1',
+ ],
+ 'Length' => [
+ 'description' => 'The length of the field. For more information, see [MaxCompute data type editions](~~159541~~).'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => false,
+ 'example' => '10',
+ ],
+ 'IsPartitionCol' => [
+ 'description' => 'Specifies whether the field is a partition field.'."\n",
+ 'type' => 'boolean',
+ 'required' => false,
+ 'example' => 'true',
+ ],
+ ],
+ 'required' => false,
+ ],
+ 'required' => true,
+ 'maxItems' => 1000,
+ ],
+ ],
+ [
+ 'name' => 'Themes',
+ 'in' => 'formData',
+ 'style' => 'repeatList',
+ 'schema' => [
+ 'description' => 'The list of themes.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '',
+ 'type' => 'object',
+ 'properties' => [
+ 'ThemeId' => [
+ 'description' => 'The theme ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'maximum' => '9223372036854775807',
+ 'minimum' => '1',
+ 'example' => '101',
+ ],
+ 'ThemeLevel' => [
+ 'description' => 'The level that corresponds to the theme ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => false,
+ 'example' => '101',
+ ],
+ ],
+ 'required' => false,
+ ],
+ 'required' => false,
+ 'maxItems' => 100,
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'description' => 'The response parameters.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'description' => 'The request ID.'."\n",
+ 'type' => 'string',
+ 'example' => 'abcdef',
+ ],
+ 'TaskInfo' => [
+ 'description' => 'The information about the request task. After a request task is submitted, it is divided into multiple subtasks that are run in sequence. After the current subtask is complete, the next subtask starts to run. After all subtasks are complete, the request task is complete.'."\n"
+ ."\n"
+ .'If a request task is aborted due to one of the following issues, address the issue based on the error code and initiate the request task again:'."\n"
+ ."\n"
+ .'* The request task fails to be submitted.'."\n"
+ .'* After the request task is submitted, a subtask fails to run.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'Status' => [
+ 'description' => 'The status of the current subtask. Valid values:'."\n"
+ ."\n"
+ .'* operating: The subtask is running.'."\n"
+ .'* success: The subtask succeeds.'."\n"
+ .'* failure: The subtask fails to run. For more information about the error details, see the Content parameter.'."\n",
+ 'type' => 'string',
+ 'example' => 'success',
+ ],
+ 'NextTaskId' => [
+ 'description' => 'The ID of the subtask that you want to run. If this parameter is left empty, all subtasks are complete.'."\n",
+ 'type' => 'string',
+ 'example' => 'abc1',
+ ],
+ 'TaskId' => [
+ 'description' => 'The ID of the current subtask.'."\n",
+ 'type' => 'string',
+ 'example' => 'abc',
+ ],
+ 'Content' => [
+ 'description' => 'The details about the status of the current subtask.'."\n"
+ ."\n"
+ .'* If the current subtask is successful, success is returned.'."\n"
+ .'* If the current subtask fails, the error details are displayed.'."\n",
+ 'type' => 'string',
+ 'example' => 'success',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'errorCodes' => [
+ 403 => [
+ [
+ 'errorCode' => 'Forbidden.Access',
+ 'errorMessage' => 'Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.',
+ ],
+ ],
+ 429 => [
+ [
+ 'errorCode' => 'Throttling.Api',
+ 'errorMessage' => 'The request for this resource has exceeded your available limit.',
+ ],
+ [
+ 'errorCode' => 'Throttling.Api.Risk',
+ 'errorMessage' => 'The request for this resource has exceeded your daily available limit.',
+ ],
+ [
+ 'errorCode' => 'Throttling.System',
+ 'errorMessage' => 'The DataWorks system is busy. Try again later.',
+ ],
+ [
+ 'errorCode' => 'Throttling.User',
+ 'errorMessage' => 'Your request is too frequent. Try again later.',
+ ],
+ ],
+ 500 => [
+ [
+ 'errorCode' => 'InternalError.System',
+ 'errorMessage' => 'An internal system error occurred. Try again later.',
+ ],
+ [
+ 'errorCode' => 'InternalError.UserId.Missing',
+ 'errorMessage' => 'An internal system error occurred. Try again later.',
+ ],
+ ],
+ ],
+ 'staticInfo' => [
+ 'noSubstitutionReason' => '无替代API，历史原因导致该API被标记为弃用。',
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"abcdef\\",\\n \\"TaskInfo\\": {\\n \\"Status\\": \\"success\\",\\n \\"NextTaskId\\": \\"abc1\\",\\n \\"TaskId\\": \\"abc\\",\\n \\"Content\\": \\"success\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"<CreateTableResponse>\\n <TaskInfo>\\n <Status>success</Status>\\n <TaskId>abc</TaskId>\\n <Content>success</Content>\\n <NextTaskId>abc1</NextTaskId>\\n </TaskInfo>\\n <RequestId>abcdef</RequestId>\\n</CreateTableResponse>","errorExample":""}]',
+ 'title' => 'CreateTable',
+ 'requestParamsDescription' => ' ',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ ],
+ 'CheckFileDeployment' => [
+ 'methods' => [
+ 'post',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'readAndWrite',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'update',
+ 'abilityTreeCode' => '78171',
+ 'abilityTreeNodes' => [
+ 'FEATUREdide4AR6E0',
+ 'FEATUREdide8FM783',
+ ],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'CheckerInstanceId',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The ID of the instance to which the file checker belongs. You can obtain the ID from the CheckerInstanceId parameter in the check event logs returned by DataWorks.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => '66_123455623_2',
+ ],
+ ],
+ [
+ 'name' => 'Status',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The check status of the file that you want to deploy. Valid values:'."\n"
+ ."\n"
+ .'* OK: The file passes the check.'."\n"
+ .'* WARN: The file passes the check, but an alert is reported.'."\n"
+ .'* FAIL: The file fails the check.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'OK',
+ 'enum' => [
+ 'OK',
+ 'FAIL',
+ 'WARN',
+ ],
+ ],
+ ],
+ [
+ 'name' => 'CheckDetailUrl',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'This parameter is deprecated.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'https://result.aliyun.com/?checkerInstanceId=',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'description' => 'The request ID. You can use the ID to troubleshoot issues.'."\n",
+ 'type' => 'string',
+ 'example' => '86d5a5ac-0cc0-4c5f-a374-a15713b252ab',
+ ],
+ ],
+ 'description' => '',
+ ],
+ ],
+ ],
+ 'errorCodes' => [
+ 403 => [
+ [
+ 'errorCode' => 'Forbidden.Access',
+ 'errorMessage' => 'Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.',
+ ],
+ ],
+ 429 => [
+ [
+ 'errorCode' => 'Throttling.Api',
+ 'errorMessage' => 'The request for this resource has exceeded your available limit.',
+ ],
+ [
+ 'errorCode' => 'Throttling.System',
+ 'errorMessage' => 'The DataWorks system is busy. Try again later.',
+ ],
+ [
+ 'errorCode' => 'Throttling.User',
+ 'errorMessage' => 'Your request is too frequent. Try again later.',
+ ],
+ ],
+ 500 => [
+ [
+ 'errorCode' => 'InternalError.System',
+ 'errorMessage' => 'An internal system error occurred. Try again later.',
+ ],
+ [
+ 'errorCode' => 'InternalError.UserId.Missing',
+ 'errorMessage' => 'An internal system error occurred. Try again later.',
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"86d5a5ac-0cc0-4c5f-a374-a15713b252ab\\"\\n}","errorExample":""},{"type":"xml","example":"<RequestId>86d5a5ac-0cc0-4c5f-a374-a15713b252ab</RequestId>","errorExample":""}]',
+ 'title' => 'CheckFileDeployment',
+ 'summary' => 'Returns the check events of a file. After you commit your file that is created on the DataStudio page, the system checks the file and returns check events before the system deploys the file. You must determine whether the check can be continued based on the events. You can call this operation to return the check events for the file that you want to deploy to DataWorks.',
+ 'requestParamsDescription' => ' ',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ ],
+ 'ListRefDISyncTasks' => [
+ 'methods' => [
+ 'post',
+ 'get',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ [
+ 'PrivateKey' => [],
+ ],
+ [
+ 'APP' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'get',
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'ProjectId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The DataWorks workspace ID. You can log on to the [DataWorks console](https://workbench.data.aliyun.com/console) and go to the Workspace page to obtain the ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => true,
+ 'docRequired' => true,
+ 'maximum' => '10000000000',
+ 'minimum' => '1',
+ 'example' => '10000',
+ ],
+ ],
+ [
+ 'name' => 'DatasourceName',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The name of the data source. You can call the [ListDataSources](~~211431~~) operation to query the name of the data source.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'mysql_datasource',
+ ],
+ ],
+ [
+ 'name' => 'TaskType',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The type of the synchronization task that you want to query. Valid values:'."\n"
+ ."\n"
+ .'* DI_OFFLINE: batch synchronization task'."\n"
+ .'* DI_REALTIME: real-time synchronization task'."\n"
+ ."\n"
+ .'You can call the ListRefDISyncTasks operation to query only one type of the task.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'DI_OFFLINE',
+ ],
+ ],
+ [
+ 'name' => 'RefType',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The condition used to filter synchronization tasks. Valid values:'."\n"
+ ."\n"
+ .'* from: queries the synchronization tasks that use the data source as the source.'."\n"
+ .'* to: queries the synchronization tasks that use the data source as the destination.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'from',
+ ],
+ ],
+ [
+ 'name' => 'PageNumber',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The page number. Valid values: 1 to 100.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'docRequired' => true,
+ 'minimum' => '1',
+ 'example' => '1',
+ 'default' => '1',
+ ],
+ ],
+ [
+ 'name' => 'PageSize',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The number of entries per page.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'maximum' => '100000',
+ 'minimum' => '1',
+ 'example' => '100',
+ 'default' => '100',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'Success' => [
+ 'description' => 'Indicates whether the request was successful. Valid values:'."\n"
+ ."\n"
+ .'* true'."\n"
+ .'* false'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'RequestId' => [
+ 'description' => 'The request ID. You can locate logs and troubleshoot issues based on the ID.'."\n",
+ 'type' => 'string',
+ 'example' => '0bc1411515937635973****',
+ ],
+ 'Data' => [
+ 'description' => 'The returned result.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'DISyncTasks' => [
+ 'description' => 'The details of the synchronization tasks. In most cases, a data source is used by multiple synchronization tasks. Therefore, the value of this parameter is an array. The following parameters are the elements in the array. The sample values of these parameters show the details of a synchronization task.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '',
+ 'type' => 'object',
+ 'properties' => [
+ 'DiSourceDatasource' => [
+ 'description' => 'The source of the synchronization task. If the synchronization task has multiple sources, the return value is a JSON array, such as \\\\"odps_writer\\\\", \\\\"mysql\\\\". If the RefType parameter is set to from, the synchronization tasks that use the specified data source as the source are returned. In this case, the value of this parameter indicates the specified data source.'."\n",
+ 'type' => 'string',
+ 'example' => '[\\"odps_writer\\"]',
+ ],
+ 'TaskType' => [
+ 'description' => 'The type of the synchronization task. Valid values:'."\n"
+ ."\n"
+ .'* DI_OFFLINE: batch synchronization task'."\n"
+ .'* DI_REALTIME: real-time synchronization task'."\n",
+ 'type' => 'string',
+ 'example' => 'DI_OFFLINE',
+ ],
+ 'DiDestinationDatasource' => [
+ 'description' => 'The destination of the synchronization task. If the synchronization task has multiple destinations, the return value is a JSON array, such as \\\\"odps_writer\\\\", \\\\"mysql\\\\". If the RefType parameter is set to to, the synchronization tasks that use the specified data source as the destination are returned. In this case, the value of this parameter indicates the specified data source.'."\n",
+ 'type' => 'string',
+ 'example' => '[\\"qcc_polardb2\\"]',
+ ],
+ 'NodeName' => [
+ 'description' => 'The name of the synchronization task.'."\n",
+ 'type' => 'string',
+ 'example' => 'abcd1234',
+ ],
+ 'NodeId' => [
+ 'description' => 'The ID of the synchronization task.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '100000',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'description' => '',
+ ],
+ ],
+ ],
+ 'errorCodes' => [
+ 400 => [
+ [
+ 'errorCode' => 'Invalid.DI.Parameter',
+ 'errorMessage' => 'The parameter is invalid.',
+ ],
+ [
+ 'errorCode' => 'Invalid.DI.Parameter.File.Existed',
+ 'errorMessage' => 'The file name already exists.',
+ ],
+ ],
+ 403 => [
+ [
+ 'errorCode' => 'Forbidden.DI.NoPrivilege',
+ 'errorMessage' => 'No access.',
+ ],
+ ],
+ 500 => [
+ [
+ 'errorCode' => 'InternalError.DI.Parameter',
+ 'errorMessage' => 'A DI internal error occurred.',
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"0bc1411515937635973****\\",\\n \\"Data\\": {\\n \\"DISyncTasks\\": [\\n {\\n \\"DiSourceDatasource\\": \\"[\\\\\\\\\\\\\\"odps_writer\\\\\\\\\\\\\\"]\\",\\n \\"TaskType\\": \\"DI_OFFLINE\\",\\n \\"DiDestinationDatasource\\": \\"[\\\\\\\\\\\\\\"qcc_polardb2\\\\\\\\\\\\\\"]\\",\\n \\"NodeName\\": \\"abcd1234\\",\\n \\"NodeId\\": 100000\\n }\\n ]\\n }\\n}","type":"json"}]',
+ 'title' => 'ListRefDISyncTasks',
+ 'summary' => 'Queries synchronization tasks in Data Integration that use a specific data source.',
+ ],
+ 'ExportDataSources' => [
+ 'methods' => [
+ 'get',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ [
+ 'APP' => [],
+ ],
+ [
+ 'PrivateKey' => [],
+ ],
+ ],
+ 'operationType' => 'readAndWrite',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'get',
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'ProjectId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the DataWorks workspace to which the data sources belong. You can call the [ListProjects](~~178393~~) operation to query the ID of the workspace.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => true,
+ 'docRequired' => true,
+ 'maximum' => '10000000000',
+ 'minimum' => '1',
+ 'example' => '10000',
+ ],
+ ],
+ [
+ 'name' => 'Name',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The keyword contained in the names of the data sources that you want to export. You can specify only one keyword. For example, if you set this parameter to test, you can call the ExportDataSources operation to export all data sources whose names contain test in the workspace.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'docRequired' => true,
+ 'example' => 'test',
+ ],
+ ],
+ [
+ 'name' => 'DataSourceType',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The type of the data source. Valid values:'."\n"
+ ."\n"
+ .'* odps'."\n"
+ .'* mysql'."\n"
+ .'* rds'."\n"
+ .'* oss'."\n"
+ .'* sqlserver'."\n"
+ .'* polardb'."\n"
+ .'* oracle'."\n"
+ .'* mongodb'."\n"
+ .'* emr'."\n"
+ .'* postgresql'."\n"
+ .'* analyticdb_for_mysql'."\n"
+ .'* hybriddb_for_postgresql'."\n"
+ .'* holo'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'rds',
+ ],
+ ],
+ [
+ 'name' => 'SubType',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The subtype of the data source. This parameter takes effect only when the DataSourceType parameter is set to rds.'."\n"
+ ."\n"
+ .'If the value of the DataSourceType parameter is rds, the value of this parameter can be mysql, sqlserver, or postgresql.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'mysql',
+ ],
+ ],
+ [
+ 'name' => 'EnvType',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The environment in which the data source resides. Valid values:'."\n"
+ ."\n"
+ .'* 0: development environment'."\n"
+ .'* 1: production environment'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => false,
+ 'example' => '1',
+ ],
+ ],
+ [
+ 'name' => 'PageSize',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The number of entries per page. Default value: 10. Maximum value: 100.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => false,
+ 'maximum' => '100',
+ 'example' => '10',
+ 'default' => '10',
+ ],
+ ],
+ [
+ 'name' => 'PageNumber',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The page number. Pages start from page 1.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => false,
+ 'maximum' => '100',
+ 'minimum' => '1',
+ 'example' => '1',
+ 'default' => '1',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'HttpStatusCode' => [
+ 'description' => 'The HTTP status code returned. Valid values:'."\n"
+ ."\n"
+ .'* 200: The request was successful.'."\n"
+ .'* Other values: The request failed. You can troubleshoot issues based on the HTTP status code returned.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '200',
+ ],
+ 'RequestId' => [
+ 'description' => 'The request ID. You can locate logs and troubleshoot issues based on the ID.'."\n",
+ 'type' => 'string',
+ 'example' => '0bc14115159376359****',
+ ],
+ 'Success' => [
+ 'description' => 'Indicates whether the request was successful. Valid values:'."\n"
+ ."\n"
+ .'* true'."\n"
+ .'* false'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'Data' => [
+ 'description' => 'The information about the exported data sources.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'PageNumber' => [
+ 'description' => 'The page number. Pages start from page 1.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '10',
+ ],
+ 'PageSize' => [
+ 'description' => 'The number of entries per page.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '1',
+ ],
+ 'TotalCount' => [
+ 'description' => 'The total number of entries returned.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '100',
+ ],
+ 'DataSources' => [
+ 'description' => 'The details of the exported data sources. The value is an array. The following parameters are the elements in the array. The sample values of these parameters show the details of a sample data source.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'Status' => [
+ 'description' => 'Indicates whether the data source is available. Valid values:'."\n"
+ ."\n"
+ .'* 1: The data source is available.'."\n"
+ .'* 0: The data source is unavailable.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '1',
+ ],
+ 'ProjectId' => [
+ 'description' => 'The ID of the DataWorks workspace to which the data source belongs.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '123',
+ ],
+ 'SubType' => [
+ 'description' => 'The subtype of the data source. This parameter takes effect only when the DataSourceType parameter is set to rds.'."\n"
+ ."\n"
+ .'If the value of the DataSourceType parameter is rds, the value of this parameter can be mysql, sqlserver, or postgresql.'."\n",
+ 'type' => 'string',
+ 'example' => 'mysql',
+ ],
+ 'GmtModified' => [
+ 'description' => 'The time when the data source was last modified. Example: Mar 17, 2021 4:09:32 PM.'."\n",
+ 'type' => 'string',
+ 'example' => 'Mar 17, 2021 4:09:32 PM',
+ ],
+ 'EnvType' => [
+ 'description' => 'The environment in which the data source resides. Valid values:'."\n"
+ ."\n"
+ .'* 0: development environment'."\n"
+ .'* 1: production environment'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '1',
+ ],
+ 'ConnectStatus' => [
+ 'description' => 'Indicates whether the data source is connected to an exclusive resource group. Valid values:'."\n"
+ ."\n"
+ .'* 1: The data source is connected to at least one exclusive resource group.'."\n"
+ .'* 0: The data source is not connected to any exclusive resource group.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '1',
+ ],
+ 'Sequence' => [
+ 'description' => 'The sequence number of the data source.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '300',
+ ],
+ 'Description' => [
+ 'description' => 'The description of the data source.'."\n",
+ 'type' => 'string',
+ 'example' => 'a connection',
+ ],
+ 'DataSourceType' => [
+ 'description' => 'The type of the data source. Valid values:'."\n"
+ ."\n"
+ .'* odps'."\n"
+ .'* mysql'."\n"
+ .'* rds'."\n"
+ .'* oss'."\n"
+ .'* sqlserver'."\n"
+ .'* polardb'."\n"
+ .'* oracle'."\n"
+ .'* mongodb'."\n"
+ .'* emr'."\n"
+ .'* postgresql'."\n"
+ .'* analyticdb_for_mysql'."\n"
+ .'* hybriddb_for_postgresql'."\n"
+ .'* holo'."\n",
+ 'type' => 'string',
+ 'example' => 'rds',
+ ],
+ 'GmtCreate' => [
+ 'description' => 'The time when the data source was created. Example: Mar 17, 2021 4:09:32 PM.'."\n",
+ 'type' => 'string',
+ 'example' => 'Mar 17, 2021 4:09:32 PM',
+ ],
+ 'DefaultEngine' => [
+ 'description' => 'Indicates whether the compute engine that is added as the data source is the default compute engine. Valid values:'."\n"
+ ."\n"
+ .'* true: The compute engine is the default compute engine.'."\n"
+ .'* false: The compute engine is not the default compute engine.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'false',
+ ],
+ 'Shared' => [
+ 'description' => 'Indicates whether the data source can be shared. Valid values:'."\n"
+ ."\n"
+ .'* true: The data source can be shared.'."\n"
+ .'* false: The data source cannot be shared.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'false',
+ ],
+ 'Operator' => [
+ 'description' => 'The ID of the user who exported the data source.'."\n",
+ 'type' => 'string',
+ 'example' => '193543050****',
+ ],
+ 'Name' => [
+ 'description' => 'The name of the data source.'."\n",
+ 'type' => 'string',
+ 'example' => 'abc',
+ ],
+ 'Content' => [
+ 'description' => 'The configuration of the data source.'."\n",
+ 'type' => 'string',
+ 'example' => '{"pubEndpoint":"http://service.cn.maxcompute.aliyun.com/api","accessId":"TMP.3KecGjvzy3i8MYfn2BGHgF7EHGyBFZcHm7GgngrABVRyvvKQrfF5kskR36xP361C3dqwbGo7SGYptAeGyiTwHXqLaBUvYC","securityToken":null,"endpoint":"http://service.cn.maxcompute.aliyun-inc.com/api","accessKey":"***","name":"PRE_PROJECT_A_engine","project":"PRE_PROJECT_A","vpcEndpoint":"http://service.cn.maxcompute.aliyun-inc.com/api","region":"cn-shanghai","authType":"2"}',
+ ],
+ 'Id' => [
+ 'description' => 'The data source ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '1',
+ ],
+ 'BindingCalcEngineId' => [
+ 'description' => 'The ID of the compute engine that is added as the data source.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '123',
+ ],
+ 'TenantId' => [
+ 'description' => 'The ID of the Alibaba Cloud account to which the data source belongs.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '1234567',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'description' => '',
+ ],
+ ],
+ ],
+ 'errorCodes' => [
+ 400 => [
+ [
+ 'errorCode' => 'Invalid.DI.Parameter',
+ 'errorMessage' => 'The parameter is invalid.',
+ ],
+ ],
+ 403 => [
+ [
+ 'errorCode' => 'Forbidden.DI.NoPrivilege',
+ 'errorMessage' => 'No access.',
+ ],
+ ],
+ 500 => [
+ [
+ 'errorCode' => 'InternalError.DI.Parameter',
+ 'errorMessage' => 'A DI internal error occurred.',
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"0bc14115159376359****\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"PageNumber\\": 10,\\n \\"PageSize\\": 1,\\n \\"TotalCount\\": 100,\\n \\"DataSources\\": [\\n {\\n \\"Status\\": 1,\\n \\"ProjectId\\": 123,\\n \\"SubType\\": \\"mysql\\",\\n \\"GmtModified\\": \\"Mar 17, 2021 4:09:32 PM\\",\\n \\"EnvType\\": 1,\\n \\"ConnectStatus\\": 1,\\n \\"Sequence\\": 300,\\n \\"Description\\": \\"a connection\\",\\n \\"DataSourceType\\": \\"rds\\",\\n \\"GmtCreate\\": \\"Mar 17, 2021 4:09:32 PM\\",\\n \\"DefaultEngine\\": false,\\n \\"Shared\\": false,\\n \\"Operator\\": \\"193543050****\\",\\n \\"Name\\": \\"abc\\",\\n \\"Content\\": \\"{\\\\\\"pubEndpoint\\\\\\":\\\\\\"http://service.cn.maxcompute.aliyun.com/api\\\\\\",\\\\\\"accessId\\\\\\":\\\\\\"TMP.3KecGjvzy3i8MYfn2BGHgF7EHGyBFZcHm7GgngrABVRyvvKQrfF5kskR36xP361C3dqwbGo7SGYptAeGyiTwHXqLaBUvYC\\\\\\",\\\\\\"securityToken\\\\\\":null,\\\\\\"endpoint\\\\\\":\\\\\\"http://service.cn.maxcompute.aliyun-inc.com/api\\\\\\",\\\\\\"accessKey\\\\\\":\\\\\\"***\\\\\\",\\\\\\"name\\\\\\":\\\\\\"PRE_PROJECT_A_engine\\\\\\",\\\\\\"project\\\\\\":\\\\\\"PRE_PROJECT_A\\\\\\",\\\\\\"vpcEndpoint\\\\\\":\\\\\\"http://service.cn.maxcompute.aliyun-inc.com/api\\\\\\",\\\\\\"region\\\\\\":\\\\\\"cn-shanghai\\\\\\",\\\\\\"authType\\\\\\":\\\\\\"2\\\\\\"}\\",\\n \\"Id\\": 1,\\n \\"BindingCalcEngineId\\": 123,\\n \\"TenantId\\": 1234567\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<RequestId>0bc14115159376359****</RequestId>\\n<HttpStatusCode>200</HttpStatusCode>\\n<Data>\\n <TotalCount>100</TotalCount>\\n <PageSize>1</PageSize>\\n <PageNumber>10</PageNumber>\\n <DataSources>\\n <Status>1</Status>\\n <Operator>193543050****</Operator>\\n <ConnectStatus>1</ConnectStatus>\\n <SubType>mysql</SubType>\\n <Description>a connection</Description>\\n <BindingCalcEngineId>123</BindingCalcEngineId>\\n <ProjectId>123</ProjectId>\\n <GmtModified>Mar 17, 2021 4:09:32 PM</GmtModified>\\n <Sequence>300</Sequence>\\n <Shared>false</Shared>\\n <EnvType>1</EnvType>\\n <Name>abc</Name>\\n <DefaultEngine>false</DefaultEngine>\\n <TenantId>1234567</TenantId>\\n <GmtCreate>Mar 17, 2021 4:09:32 PM</GmtCreate>\\n <Content>{\\"pubEndpoint\\":\\"http://service.cn.maxcompute.aliyun.com/api\\",\\"accessId\\":\\"TMP.3KecGjvzy3i8MYfn2BGHgF7EHGyBFZcHm7GgngrABVRyvvKQrfF5kskR36xP361C3dqwbGo7SGYptAeGyiTwHXqLaBUvYC\\",\\"securityToken\\":null,\\"endpoint\\":\\"http://service.cn.maxcompute.aliyun-inc.com/api\\",\\"accessKey\\":\\"***\\",\\"name\\":\\"PRE_PROJECT_A_engine\\",\\"project\\":\\"PRE_PROJECT_A\\",\\"vpcEndpoint\\":\\"http://service.cn.maxcompute.aliyun-inc.com/api\\",\\"region\\":\\"cn-shanghai\\",\\"authType\\":\\"2\\"}</Content>\\n <DataSourceType>rds</DataSourceType>\\n <Id>1</Id>\\n </DataSources>\\n</Data>\\n<Success>true</Success>","errorExample":""}]',
+ 'title' => 'ExportDataSources',
+ 'summary' => 'Exports a list of data sources.',
+ 'requestParamsDescription' => ' ',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ ],
+ 'ImportDataSources' => [
+ 'methods' => [
+ 'post',
+ 'get',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ [
+ 'APP' => [],
+ ],
+ [
+ 'PrivateKey' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [],
+ 'parameters' => [
+ [
+ 'name' => 'ProjectId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The DataWorks workspace ID. You can log on to the [DataWorks console](https://workbench.data.aliyun.com/console) and go to the Workspace page to obtain the ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => true,
+ 'docRequired' => true,
+ 'maximum' => '10000000000',
+ 'minimum' => '1',
+ 'example' => '10000',
+ ],
+ ],
+ [
+ 'name' => 'DataSources',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The configurations of the data sources that you want to import. The Name, DataSourceType, SubType, Description, Content, and EnvType parameters are required. For more information about the parameters, see [CreateDataSource](~~211429~~).'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => '[{"SubType":"","DataSourceType":"mysql","EnvType":1,"Name":"mysql_dms2","Description":"aaa","Content":"{\\"database\\":\\"mysql_chengdu_old\\",\\"password\\":\\"***\\",\\"instanceName\\":\\"rm-2vcrckb37163g7l3w\\",\\"regionId\\":\\"cn-chengdu\\",\\"tag\\":\\"rds\\",\\"rdsOwnerId\\":\\"333\\",\\"username\\":\\"mysql_chengdu2\\"}"},{"SubType":"","DataSourceType":"mysql","EnvType":1,"Name":"mysql_dms2","Description":"aaa","Content":"{\\"database\\":\\"mysql_chengdu_old\\",\\"password\\":\\"***\\",\\"instanceName\\":\\"rm-2vcrckb37163g7l3w\\",\\"regionId\\":\\"cn-chengdu\\",\\"tag\\":\\"rds\\",\\"rdsOwnerId\\":\\"143\\",\\"username\\":\\"mysql_chengdu2\\"}"}]',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'Success' => [
+ 'description' => 'Indicates whether the request was successful. Valid values:'."\n"
+ ."\n"
+ .'* true'."\n"
+ .'* false'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'RequestId' => [
+ 'description' => 'The request ID. You can locate logs and troubleshoot issues based on the ID.'."\n",
+ 'type' => 'string',
+ 'example' => '0bc1411515937635973****',
+ ],
+ 'Data' => [
+ 'description' => 'The information about the imported data sources.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'Status' => [
+ 'description' => 'Indicates whether the data sources were imported. Valid values:'."\n"
+ ."\n"
+ .'* true: All data sources were imported.'."\n"
+ .'* false: Specific data sources failed to be imported. You can troubleshoot issues based on the Message parameter.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'Message' => [
+ 'description' => 'The reason why the data sources failed to be imported. If the data sources were imported, this parameter is left empty.'."\n",
+ 'type' => 'string',
+ 'example' => ' Data source DEV XXX already exists',
+ ],
+ ],
+ ],
+ ],
+ 'description' => '',
+ ],
+ ],
+ ],
+ 'errorCodes' => [
+ 400 => [
+ [
+ 'errorCode' => 'Invalid.DI.Parameter',
+ 'errorMessage' => 'The parameter is invalid.',
+ ],
+ ],
+ 403 => [
+ [
+ 'errorCode' => 'Forbidden.DI.NoPrivilege',
+ 'errorMessage' => 'No access.',
+ ],
+ ],
+ 500 => [
+ [
+ 'errorCode' => 'InternalError.DI.Parameter',
+ 'errorMessage' => 'A DI internal error occurred.',
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"0bc1411515937635973****\\",\\n \\"Data\\": {\\n \\"Status\\": true,\\n \\"Message\\": \\" Data source DEV XXX already exists\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"<RequestId>0bc1411515937635973****</RequestId>\\n<Data>\\n <Status>true</Status>\\n <Message> Data source DEV XXX already exists</Message>\\n</Data>\\n<Success>true</Success>","errorExample":""}]',
+ 'title' => 'ImportDataSources',
+ 'summary' => 'Imports data sources from your on-premises machine to a specific DataWorks workspace.',
+ 'description' => 'You can import self-managed data sources or data sources that are exported from other DataWorks workspaces to a specific DataWorks workspace.'."\n"
+ ."\n"
+ .'* To import a self-managed data source to a DataWorks workspace, the data source type must be supported by DataWorks. For more information about the types of data sources supported by DataWorks, see [Supported data stores](~~181656~~).'."\n"
+ .'* For more information about how to export data sources from DataWorks workspaces to your on-premises machine, see [ExportDataSources](~~279570~~).'."\n",
+ 'requestParamsDescription' => ' ',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ ],
+ 'UpdateClusterConfigs' => [
+ 'summary' => 'Updates the configurations of submodules in a workspace. You can configure SPARK parameters.',
+ 'methods' => [
+ 'post',
+ ],
+ 'schemes' => [
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'update',
+ 'abilityTreeCode' => '231401',
+ 'abilityTreeNodes' => [
+ 'FEATUREdideDGBIGO',
+ ],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'ClusterId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the cluster associated with DataWorks.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => true,
+ 'example' => '1234',
+ ],
+ ],
+ [
+ 'name' => 'ProjectId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the workspace.',
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => true,
+ 'example' => '5678',
+ ],
+ ],
+ [
+ 'name' => 'ConfigType',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The configuration type of the cluster. Valid values:'."\n"
+ ."\n"
+ .'* SPARK_CONF: SPARK parameters'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'enumValueTitles' => [],
+ 'example' => 'SPARK_CONF',
+ ],
+ ],
+ [
+ 'name' => 'ConfigValues',
+ 'in' => 'formData',
+ 'style' => 'json',
+ 'schema' => [
+ 'description' => 'The configuration information of the cluster submodule.',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The configuration information of the cluster in a module.',
+ 'required' => false,
+ '$ref' => '#/components/schemas/ClusterConfig',
+ ],
+ 'required' => true,
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => 'OpenApiMetaResultModel',
+ 'description' => 'The returned data.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'Data' => [
+ 'description' => 'Indicates whether the update was successful. Valid values:'."\n"
+ ."\n"
+ .'* true'."\n"
+ .'* false'."\n",
+ 'type' => 'boolean',
+ 'enumValueTitles' => [],
+ 'example' => 'true',
+ ],
+ 'RequestId' => [
+ 'description' => 'The ID of the request. It is used to locate logs and troubleshoot problems.',
+ 'type' => 'string',
+ 'example' => '0000-ABCD-E****',
+ ],
+ 'Success' => [
+ 'description' => 'Indicates whether the request was successful. Valid values:'."\n"
+ ."\n"
+ .'* true'."\n"
+ .'* false'."\n",
+ 'type' => 'boolean',
+ 'enumValueTitles' => [],
+ 'example' => 'true',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code.',
+ 'type' => 'string',
+ 'example' => '101011005',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message.',
+ 'type' => 'string',
+ 'example' => 'Invalid.Cluster.ClusterNotFound',
+ ],
+ 'HttpStatusCode' => [
+ 'description' => 'The HTTP status code.',
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '200',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'staticInfo' => [
+ 'returnType' => 'synchronous',
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": true,\\n \\"RequestId\\": \\"0000-ABCD-E****\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"101011005\\",\\n \\"ErrorMessage\\": \\"Invalid.Cluster.ClusterNotFound\\",\\n \\"HttpStatusCode\\": 200\\n}","type":"json"}]',
+ 'title' => 'UpdateClusterConfigs',
+ ],
+ 'ListClusterConfigs' => [
+ 'summary' => 'Queries the configurations of submodules in a workspace. You can query information about SPARK parameters.',
+ 'methods' => [
+ 'get',
+ ],
+ 'schemes' => [
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'get',
+ 'abilityTreeCode' => '231400',
+ 'abilityTreeNodes' => [
+ 'FEATUREdideDGBIGO',
+ ],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'ClusterId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the cluster generated by DataWorks.',
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => true,
+ 'example' => '1234',
+ ],
+ ],
+ [
+ 'name' => 'ProjectId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the DataWorks workspace.',
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => true,
+ 'example' => '5678',
+ ],
+ ],
+ [
+ 'name' => 'ConfigType',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The configuration type of the cluster. Valid values:'."\n"
+ ."\n"
+ .'* SPARK_CONF: SPARK parameters.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'enumValueTitles' => [],
+ 'example' => 'SPARK_CONF',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'description' => 'The returned data.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'ClusterConfigs' => [
+ 'description' => 'A list of configurations of cluster modules.',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The configuration information of a cluster on a module.',
+ '$ref' => '#/components/schemas/ClusterConfig',
+ ],
+ ],
+ 'RequestId' => [
+ 'description' => 'The request ID. You can locate logs and troubleshoot issues based on the ID.'."\n",
+ 'type' => 'string',
+ 'example' => '0000-ABCD-E****',
+ ],
+ 'Success' => [
+ 'description' => 'Indicates whether the request was successful. Valid values:'."\n"
+ ."\n"
+ .'* true'."\n"
+ .'* false'."\n",
+ 'type' => 'boolean',
+ 'enumValueTitles' => [],
+ 'example' => 'true',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code.'."\n",
+ 'type' => 'string',
+ 'example' => '101011005',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message.'."\n",
+ 'type' => 'string',
+ 'example' => 'Invalid.Cluster.ClusterNotFound',
+ ],
+ 'HttpStatusCode' => [
+ 'description' => 'The HTTP status code.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '200',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'staticInfo' => [
+ 'returnType' => 'synchronous',
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"ClusterConfigs\\": [\\n {\\n \\"ModuleName\\": \\"ide\\",\\n \\"ConfigValue\\": \\"{\\\\\\"spark.driver.memory\\\\\\":\\\\\\"1g\\\\\\"}\\",\\n \\"EnableOverwrite\\": false\\n }\\n ],\\n \\"RequestId\\": \\"0000-ABCD-*****\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"101011005\\",\\n \\"ErrorMessage\\": \\"Invalid.Cluster.ClusterNotFound\\",\\n \\"HttpStatusCode\\": 200\\n}","type":"json"}]',
+ 'title' => 'ListClusterConfigs',
+ ],
+ 'ListClusters' => [
+ 'summary' => 'Queries clusters that are registered in DataWorks. E-MapReduce (EMR) clusters and Cloudera\'s Distribution Including Apache Hadoop (CDH) clusters are supported.',
+ 'methods' => [
+ 'get',
+ ],
+ 'schemes' => [
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'get',
+ 'abilityTreeCode' => '231398',
+ 'abilityTreeNodes' => [
+ 'FEATUREdideDGBIGO',
+ ],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'ClusterType',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The type of the cluster. Valid values:'."\n"
+ ."\n"
+ .'* CDH: CDH cluster'."\n"
+ .'* EMR: EMR cluster'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'enumValueTitles' => [],
+ 'example' => 'EMR',
+ ],
+ ],
+ [
+ 'name' => 'PageNumber',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The page number. Pages start from page 1.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => false,
+ 'example' => '1',
+ ],
+ ],
+ [
+ 'name' => 'PageSize',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The number of entries per page. Default value: 10. Maximum value: 100.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => false,
+ 'example' => '10',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'description' => 'The returned data.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'Data' => [
+ 'description' => 'The returns data.',
+ 'type' => 'object',
+ 'properties' => [
+ 'PageNumber' => [
+ 'description' => 'The page number.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '1',
+ ],
+ 'PageSize' => [
+ 'description' => 'The number of entries per page.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '10',
+ ],
+ 'TotalCount' => [
+ 'description' => 'The total number of entries returned.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '100',
+ ],
+ 'Clusters' => [
+ 'description' => 'List of cluster information.',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'Cluster information',
+ '$ref' => '#/components/schemas/Cluster',
+ ],
+ ],
+ ],
+ ],
+ 'RequestId' => [
+ 'description' => 'The request ID. You can use the request ID to query logs and troubleshoot issues.'."\n",
+ 'type' => 'string',
+ 'example' => '0000-ABCD-E****',
+ ],
+ 'Success' => [
+ 'description' => 'Indicates whether the request was successful. Valid values:'."\n"
+ ."\n"
+ .'* true'."\n"
+ .'* false'."\n",
+ 'type' => 'boolean',
+ 'enumValueTitles' => [],
+ 'example' => 'true',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code.'."\n",
+ 'type' => 'string',
+ 'example' => '101011005',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message.'."\n",
+ 'type' => 'string',
+ 'example' => 'Invalid.Cluster.ClusterNotFound',
+ ],
+ 'HttpStatusCode' => [
+ 'description' => 'The HTTP status code.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '200',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'staticInfo' => [
+ 'returnType' => 'synchronous',
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": {\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 100,\\n \\"Clusters\\": [\\n {\\n \\"ClusterId\\": 1234,\\n \\"ClusterBizId\\": \\"c-d8a7523****\\"\\n }\\n ]\\n },\\n \\"RequestId\\": \\"0000-ABCD-E****\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"101011005\\",\\n \\"ErrorMessage\\": \\"Invalid.Cluster.ClusterNotFound\\",\\n \\"HttpStatusCode\\": 200\\n}","type":"json"}]',
+ 'title' => 'ListClusters',
+ ],
+ 'ListEntitiesByTags' => [
+ 'summary' => 'Queries a list of entities by tag. Only entities of the maxcompute-table type are supported.',
+ 'methods' => [
+ 'get',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'list',
+ 'abilityTreeCode' => '187376',
+ 'abilityTreeNodes' => [
+ 'FEATUREdideRZEBFC',
+ ],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'EntityType',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The type of the entity.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => 'maxcompute-table',
+ ],
+ ],
+ [
+ 'name' => 'Tags',
+ 'in' => 'query',
+ 'style' => 'json',
+ 'schema' => [
+ 'description' => 'The tags.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The tag.'."\n",
+ 'required' => false,
+ '$ref' => '#/components/schemas/UserEntityTag',
+ ],
+ 'required' => true,
+ 'maxItems' => 10,
+ ],
+ ],
+ [
+ 'name' => 'NextToken',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The pagination token that is used in the next request to retrieve a new page of results.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => '12345',
+ 'default' => '0',
+ ],
+ ],
+ [
+ 'name' => 'PageSize',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The number of entries per page. Default value: 10. Valid values: 1 to 100.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => false,
+ 'maximum' => '1000',
+ 'example' => '10',
+ 'default' => '10',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => 'OpenApiMetaResultModel',
+ 'description' => 'The response parameters.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'Data' => [
+ 'description' => 'The data returned.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'NextToken' => [
+ 'description' => 'A pagination token. It can be used in the next request to retrieve a new page of results.'."\n",
+ 'type' => 'string',
+ 'example' => '12345',
+ ],
+ 'EntityList' => [
+ 'description' => 'The entities.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The entity.'."\n",
+ '$ref' => '#/components/schemas/Entity',
+ ],
+ ],
+ ],
+ ],
+ 'RequestId' => [
+ 'description' => 'The request ID.'."\n",
+ 'type' => 'string',
+ 'example' => '0000-ABCD-E****',
+ ],
+ 'Success' => [
+ 'description' => 'Indicates whether the request was successful. Valid values:'."\n"
+ ."\n"
+ .'true\\'."\n"
+ .'false'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code.'."\n",
+ 'type' => 'string',
+ 'example' => '101011005',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message.'."\n",
+ 'type' => 'string',
+ 'example' => 'Invalid.Entity.EntityTypeNotSupported',
+ ],
+ 'HttpStatusCode' => [
+ 'description' => 'The HTTP status code.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '200',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'staticInfo' => [
+ 'returnType' => 'synchronous',
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"Data\\": {\\n \\"NextToken\\": \\"12345\\",\\n \\"EntityList\\": [\\n {\\n \\"QualifiedName\\": \\"maxcompute_table.563f0357118d05ef145d6bddf2966cc23e86ca8f2f013f915e565afdf09f7a23\\",\\n \\"TenantId\\": 12345,\\n \\"EntityContent\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n }\\n }\\n ]\\n },\\n \\"RequestId\\": \\"0000-ABCD-E****\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"101011005\\",\\n \\"ErrorMessage\\": \\"Invalid.Entity.EntityTypeNotSupported\\",\\n \\"HttpStatusCode\\": 200\\n}","errorExample":""},{"type":"xml","example":"<ListEntitiesByTagsResponse>\\n <Data>\\n <NextToken>12345</NextToken>\\n <EntityList>\\n <QualifiedName>maxcompute_table.563f0357118d05ef145d6bddf2966cc23e86ca8f2f013f915e565afdf09f7a23</QualifiedName>\\n <TenantId>12345</TenantId>\\n </EntityList>\\n </Data>\\n <RequestId>0000-ABCD-E****</RequestId>\\n <Success>true</Success>\\n <ErrorCode>101011005</ErrorCode>\\n <ErrorMessage>Invalid.Entity.EntityTypeNotSupported</ErrorMessage>\\n <HttpStatusCode>200</HttpStatusCode>\\n</ListEntitiesByTagsResponse>","errorExample":""}]',
+ 'title' => 'ListEntitiesByTags',
+ ],
+ 'RemoveEntityTags' => [
+ 'summary' => 'Removes tags from an entity. Only entities of the maxcompute-table type are supported.',
+ 'methods' => [
+ 'post',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'write',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'update',
+ 'abilityTreeCode' => '187380',
+ 'abilityTreeNodes' => [
+ 'FEATUREdideRZEBFC',
+ ],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'QualifiedName',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The unique identifier of the entity. Example: maxcompute-table.projectA.tableA.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => 'maxcompute-table.projectA.tableA',
+ ],
+ ],
+ [
+ 'name' => 'TagKeys',
+ 'in' => 'formData',
+ 'style' => 'json',
+ 'schema' => [
+ 'description' => 'The tag keys.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The tag key.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'priority',
+ ],
+ 'required' => true,
+ 'maxItems' => 100,
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => 'OpenApiMetaResultModel',
+ 'description' => 'The response parameters.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'Data' => [
+ 'description' => 'Indicates whether the call was successful. Valid values:'."\n"
+ ."\n"
+ .'true\\'."\n"
+ .'false'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'RequestId' => [
+ 'description' => 'The request ID.'."\n",
+ 'type' => 'string',
+ 'example' => '0000-ABCD-E****',
+ ],
+ 'Success' => [
+ 'description' => 'Indicates whether the request was successful. Valid values:'."\n"
+ ."\n"
+ .'true\\'."\n"
+ .'false'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code.'."\n",
+ 'type' => 'string',
+ 'example' => '101011005',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message.'."\n",
+ 'type' => 'string',
+ 'example' => 'Invalid.Entity.EntityTypeNotSupported',
+ ],
+ 'HttpStatusCode' => [
+ 'description' => 'The HTTP status code.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '200',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'staticInfo' => [
+ 'returnType' => 'synchronous',
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"Data\\": true,\\n \\"RequestId\\": \\"0000-ABCD-E****\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"101011005\\",\\n \\"ErrorMessage\\": \\"Invalid.Entity.EntityTypeNotSupported\\",\\n \\"HttpStatusCode\\": 200\\n}","errorExample":""},{"type":"xml","example":"<RemoveEntityTagsResponse>\\n <Data>true</Data>\\n <RequestId>0000-ABCD-E****</RequestId>\\n <Success>true</Success>\\n <ErrorCode>101011005</ErrorCode>\\n <ErrorMessage>Invalid.Entity.EntityTypeNotSupported</ErrorMessage>\\n <HttpStatusCode>200</HttpStatusCode>\\n</RemoveEntityTagsResponse>","errorExample":""}]',
+ 'title' => 'RemoveEntityTags',
+ ],
+ 'SetEntityTags' => [
+ 'summary' => 'Configures tags for an entity. Only entities of the maxcompute-table type are supported.',
+ 'methods' => [
+ 'post',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'write',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'update',
+ 'abilityTreeCode' => '187379',
+ 'abilityTreeNodes' => [
+ 'FEATUREdideRZEBFC',
+ ],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'QualifiedName',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The unique identifier of the entity. Example: maxcompute-table.projectA.tableA.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => 'maxcompute-table.projectA.tableA',
+ ],
+ ],
+ [
+ 'name' => 'Tags',
+ 'in' => 'formData',
+ 'style' => 'json',
+ 'schema' => [
+ 'description' => 'The tags.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The tag.'."\n",
+ 'required' => false,
+ '$ref' => '#/components/schemas/UserEntityTag',
+ ],
+ 'required' => false,
+ 'maxItems' => 100,
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => 'OpenApiMetaResultModel',
+ 'description' => 'The response parameters.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'Data' => [
+ 'description' => 'Indicates whether the call was successful. Valid values:'."\n"
+ ."\n"
+ .'true and false.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'RequestId' => [
+ 'description' => 'The request ID.'."\n",
+ 'type' => 'string',
+ 'example' => '0000-ABCD-E****',
+ ],
+ 'Success' => [
+ 'description' => 'Indicates whether the request was successful. Valid values:'."\n"
+ ."\n"
+ .'true and false.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code.'."\n",
+ 'type' => 'string',
+ 'example' => '101011005',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message.'."\n",
+ 'type' => 'string',
+ 'example' => 'Invalid.Entity.EntityTypeNotSupported',
+ ],
+ 'HttpStatusCode' => [
+ 'description' => 'The HTTP status code.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '200',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'staticInfo' => [
+ 'returnType' => 'synchronous',
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"Data\\": true,\\n \\"RequestId\\": \\"0000-ABCD-E****\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"101011005\\",\\n \\"ErrorMessage\\": \\"Invalid.Entity.EntityTypeNotSupported\\",\\n \\"HttpStatusCode\\": 200\\n}","errorExample":""},{"type":"xml","example":"<SetEntityTagsResponse>\\n <Data>true</Data>\\n <RequestId>0000-ABCD-E****</RequestId>\\n <Success>true</Success>\\n <ErrorCode>101011005</ErrorCode>\\n <ErrorMessage>Invalid.Entity.EntityTypeNotSupported</ErrorMessage>\\n <HttpStatusCode>200</HttpStatusCode>\\n</SetEntityTagsResponse>","errorExample":""}]',
+ 'title' => 'SetEntityTags',
+ ],
+ 'ListEntityTags' => [
+ 'summary' => 'Queries a list of tags of an entity. Only entities of the maxcompute-table type are supported.',
+ 'methods' => [
+ 'get',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'list',
+ 'abilityTreeCode' => '187352',
+ 'abilityTreeNodes' => [
+ 'FEATUREdideRZEBFC',
+ ],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'QualifiedName',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The unique identifier of the entity. Example: maxcompute-table.projectA.tableA.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => 'maxcompute-table.projectA.tableA',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => 'OpenApiMetaResultModel',
+ 'description' => 'The response parameters.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'Data' => [
+ 'description' => 'The tags.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The tag.'."\n",
+ '$ref' => '#/components/schemas/UserEntityTag',
+ ],
+ ],
+ 'RequestId' => [
+ 'description' => 'The request ID.'."\n",
+ 'type' => 'string',
+ 'example' => '0000-ABCD-E****',
+ ],
+ 'Success' => [
+ 'description' => 'Indicates whether the request was successful. Valid values:'."\n"
+ ."\n"
+ .'true\\'."\n"
+ .'false'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code.'."\n",
+ 'type' => 'string',
+ 'example' => '101011005',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message.'."\n",
+ 'type' => 'string',
+ 'example' => 'Invalid.Entity.EntityTypeNotSupported',
+ ],
+ 'HttpStatusCode' => [
+ 'description' => 'The HTTP status code.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '200',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'staticInfo' => [
+ 'returnType' => 'synchronous',
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"Data\\": [\\n {\\n \\"TagKey\\": \\"priority\\",\\n \\"TagValue\\": \\"p1\\"\\n }\\n ],\\n \\"RequestId\\": \\"0000-ABCD-E****\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"101011005\\",\\n \\"ErrorMessage\\": \\"Invalid.Entity.EntityTypeNotSupported\\",\\n \\"HttpStatusCode\\": 200\\n}","errorExample":""},{"type":"xml","example":"<ListEntityTagsResponse>\\n <Data>\\n <TagKey>priority</TagKey>\\n <TagValue>p1</TagValue>\\n </Data>\\n <RequestId>0000-ABCD-E****</RequestId>\\n <Success>true</Success>\\n <ErrorCode>101011005</ErrorCode>\\n <ErrorMessage>Invalid.Entity.EntityTypeNotSupported</ErrorMessage>\\n <HttpStatusCode>200</HttpStatusCode>\\n</ListEntityTagsResponse>","errorExample":""}]',
+ 'title' => 'ListEntityTags',
+ ],
+ 'SetDataSourceShare' => [
+ 'methods' => [
+ 'post',
+ 'get',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ [
+ 'PrivateKey' => [],
+ ],
+ [
+ 'APP' => [],
+ ],
+ ],
+ 'operationType' => 'write',
+ 'deprecated' => true,
+ 'systemTags' => [],
+ 'parameters' => [
+ [
+ 'name' => 'ProjectId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the DataWorks workspace to which the data source belongs. You can call the [ListProjects](~~178393~~) operation to query the ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => true,
+ 'docRequired' => true,
+ 'maximum' => '10000000000',
+ 'minimum' => '1',
+ 'example' => '10000',
+ ],
+ ],
+ [
+ 'name' => 'DatasourceName',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The name of the data source that you want to share.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'mysql_name',
+ ],
+ ],
+ [
+ 'name' => 'EnvType',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The environment in which the data source is used. Valid values:'."\n"
+ ."\n"
+ .'* 0: development environment'."\n"
+ .'* 1: production environment'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'docRequired' => true,
+ 'example' => '1',
+ ],
+ ],
+ [
+ 'name' => 'ProjectPermissions',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The DataWorks workspace to which you want to share the data source. If you configure this parameter, all members of the specified DataWorks workspace can view and use the data source. The value of this parameter is a JSON array. Example: \\[{"projectId":1000,"permission":"WRITE","sharedName":"PX_DATAHUB1.shared_name"}], Parameter description:'."\n"
+ ."\n"
+ .'* projectId: the ID of the DataWorks workspace to which you want to share the data source.'."\n"
+ .'* permission: the mode in which the data source is shared. Valid values: READ and WRITE. The value READ indicates that all members of the specified workspace can read data from the data source, but cannot modify the data. The value WRITE indicates that all members of the specified workspace can modify the data in the data source.'."\n"
+ .'* sharedName: the name of the data source that you want to share.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => '[{"projectId":1000,"permission":"WRITE","sharedName":"PX_DATAHUB1.shared_name"}]',
+ ],
+ ],
+ [
+ 'name' => 'UserPermissions',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The user to whom you want to share the data source. If you configure this parameter, the specified user can view or use the data source. The value of this parameter is a JSON array. Example: \\[{"projectId":10000,"users":\\[{"userId":"276184575345452131","permission":"WRITE"}],"sharedName":"PX_DATAHUB1.shared_name"}], Parameter description:'."\n"
+ ."\n"
+ .'* projectId: the ID of the DataWorks workspace. If you configure the UserPermissions parameter, the specified user can view or use the data source only in the specified DataWorks workspace.'."\n"
+ .'* userId: the ID of the user to whom you want to share the data source.'."\n"
+ .'* permission: the mode in which the data source is shared. Valid values: READ and WRITE. The value READ indicates that the specified user can read data from the data source, but cannot modify the data. The value WRITE indicates that the specified user can modify the data in the data source.'."\n"
+ .'* sharedName: the name of the data source that you want to share.'."\n"
+ ."\n"
+ .'If the ProjectPermissions and UserPermissions parameters are both left empty, the specified data source is not shared to any DataWorks workspace or user. If neither of the parameters is left empty, both parameters take effect.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => '[{"projectId":10000,"users":[{"userId":"276184575345452131","permission":"WRITE"}],"sharedName":"PX_DATAHUB1.shared_name"}]',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'Success' => [
+ 'description' => 'Indicates whether the request was successful. Valid values:'."\n"
+ ."\n"
+ .'* true'."\n"
+ .'* false'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'RequestId' => [
+ 'description' => 'The request ID.'."\n",
+ 'type' => 'string',
+ 'example' => '0000-ABCD-EFG ',
+ ],
+ 'Data' => [
+ 'description' => 'The information about the sharing operation.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'Status' => [
+ 'description' => 'Indicates whether the data source was shared. Valid values:'."\n"
+ ."\n"
+ .'* success.'."\n"
+ .'* fail. You can view the value of the Message parameter to identify the cause of the failure.'."\n",
+ 'type' => 'string',
+ 'example' => 'success',
+ ],
+ 'Message' => [
+ 'description' => 'The reason why the data source failed to be shared. If the data source is successfully shared, the value of this parameter is an empty string.'."\n",
+ 'type' => 'string',
+ 'example' => 'datasource is wrong',
+ ],
+ ],
+ ],
+ ],
+ 'description' => '',
+ ],
+ ],
+ ],
+ 'errorCodes' => [
+ 400 => [
+ [
+ 'errorCode' => 'Invalid.DI.Parameter',
+ 'errorMessage' => 'The parameter is invalid.',
+ ],
+ ],
+ 403 => [
+ [
+ 'errorCode' => 'Forbidden.DI.NoPrivilege',
+ 'errorMessage' => 'No access.',
+ ],
+ ],
+ 500 => [
+ [
+ 'errorCode' => 'InternalError.DI.Parameter',
+ 'errorMessage' => 'A DI internal error occurred.',
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"0000-ABCD-EFG\\\\t\\",\\n \\"Data\\": {\\n \\"Status\\": \\"success\\",\\n \\"Message\\": \\"datasource is wrong\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"<RequestId>0000-ABCD-EFG\\t</RequestId>\\n<Data>\\n <Status>success</Status>\\n <Message>datasource is wrong</Message>\\n</Data>\\n<Success>true</Success>","errorExample":""}]',
+ 'title' => 'SetDataSourceShare',
+ 'summary' => 'Shares a data source to a specific DataWorks workspace or a specific user.',
+ 'requestParamsDescription' => ' ',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ ],
+ 'CreateConnection' => [
+ 'summary' => 'Adds a data source.',
+ 'methods' => [
+ 'post',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'write',
+ 'deprecated' => true,
+ 'systemTags' => [
+ 'operationType' => 'create',
+ 'riskType' => 'high',
+ 'chargeType' => 'free',
+ 'abilityTreeNodes' => [
+ 'FEATUREdide7FTVFZ',
+ ],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'ProjectId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the workspace with which the data source is associated. You can call the [ListProjects](~~178393~~) operation to query the ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => '1',
+ ],
+ ],
+ [
+ 'name' => 'Name',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The name of the data source.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'abc',
+ ],
+ ],
+ [
+ 'name' => 'Description',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The description of the connection string.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'abc',
+ ],
+ ],
+ [
+ 'name' => 'ConnectionType',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The type of the connection string. Valid values:'."\n"
+ ."\n"
+ .'* odps'."\n"
+ .'* mysql'."\n"
+ .'* rds'."\n"
+ .'* oss'."\n"
+ .'* sqlserver'."\n"
+ .'* polardb'."\n"
+ .'* oracle'."\n"
+ .'* mongodb'."\n"
+ .'* emr'."\n"
+ .'* postgresql'."\n"
+ .'* analyticdb_for_mysql'."\n"
+ .'* hybriddb_for_postgresql'."\n"
+ .'* holo'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'rds',
+ ],
+ ],
+ [
+ 'name' => 'SubType',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The subtype of the connection string. This parameter is used for scenarios where a type includes subtypes. The following type and subtypes are supported:'."\n"
+ ."\n"
+ .'* Type: `rds`'."\n"
+ .'* Subtypes: `mysql`, `sqlserver`, and `postgresql`.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'mysql',
+ ],
+ ],
+ [
+ 'name' => 'EnvType',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The environment in which the data source is used. Valid values: 0 and 1. The value 0 indicates the development environment. The value 1 indicates the production environment.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => '1',
+ ],
+ ],
+ [
+ 'name' => 'Content',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The details of the data source. Examples of details of some common data sources:'."\n"
+ ."\n"
+ .'* odps'."\n"
+ ."\n"
+ .'<!---->'."\n"
+ ."\n"
+ .' {'."\n"
+ .' "accessId": "xssssss",'."\n"
+ .' "accessKey": "xsaxsaxsa",'."\n"
+ .' "authType": 2,'."\n"
+ .' "endpoint": "http://service.odps.aliyun.com/api",'."\n"
+ .' "project": "xsaxsax",'."\n"
+ .' "tag": "public"'."\n"
+ .' }'."\n"
+ ."\n"
+ .'* mysql'."\n"
+ ."\n"
+ .'<!---->'."\n"
+ ."\n"
+ .' {'."\n"
+ .' "database": "xsaxsa",'."\n"
+ .' "instanceName": "rm-xsaxsa",'."\n"
+ .' "password": "xsaxsa",'."\n"
+ .' "rdsOwnerId": "xasxsa",'."\n"
+ .' "regionId": "cn-shanghai",'."\n"
+ .' "tag": "rds",'."\n"
+ .' "username": "xsaxsa"'."\n"
+ .' }'."\n"
+ ."\n"
+ .'* rds'."\n"
+ ."\n"
+ .'<!---->'."\n"
+ ."\n"
+ .' {'."\n"
+ .' "configType": 1,'."\n"
+ .' "tag": "rds",'."\n"
+ .' "database": "xsaxsa",'."\n"
+ .' "username": "xsaxsa",'."\n"
+ .' "password": "xssaxsa$32050",'."\n"
+ .' "instanceName": "rm-xsaxs",'."\n"
+ .' "rdsOwnerId": "11111111"'."\n"
+ .' }'."\n"
+ ."\n"
+ .'* oss'."\n"
+ ."\n"
+ .'<!---->'."\n"
+ ."\n"
+ .' {'."\n"
+ .' "accessId": "sssssxx",'."\n"
+ .' "accessKey": "xsaxaxsaxs",'."\n"
+ .' "bucket": "xsa-xs-xs",'."\n"
+ .' "endpoint": "http://oss-cn-shanghai.aliyuncs.com",'."\n"
+ .' "tag": "public"'."\n"
+ .' }'."\n"
+ ."\n"
+ .'* sqlserver'."\n"
+ ."\n"
+ .'<!---->'."\n"
+ ."\n"
+ .' {'."\n"
+ .' "jdbcUrl": "jdbc:sqlserver://xsaxsa-xsaxsa.database.xxx.cn:123;DatabaseName=xsxs-xsxs",'."\n"
+ .' "password": "sdasda$fs",'."\n"
+ .' "tag": "public",'."\n"
+ .' "username": "sxaxacdacdd"'."\n"
+ .' }'."\n"
+ ."\n"
+ .'* polardb'."\n"
+ ."\n"
+ .'<!---->'."\n"
+ ."\n"
+ .' {'."\n"
+ .' "clusterId": "pc-sdadsadsa",'."\n"
+ .' "database": "dsadsadsa",'."\n"
+ .' "ownerId": "121212122",'."\n"
+ .' "password": "sdasdafssa",'."\n"
+ .' "region": "cn-shanghai",'."\n"
+ .' "tag": "polardb",'."\n"
+ .' "username": "asdadsads"'."\n"
+ .' }'."\n"
+ ."\n"
+ .'* oracle'."\n"
+ ."\n"
+ .'<!---->'."\n"
+ ."\n"
+ .' {'."\n"
+ .' "jdbcUrl": "jdbc:oracle:saaa:@xxxxx:1521:PROD",'."\n"
+ .' "password": "sxasaxsa",'."\n"
+ .' "tag": "public",'."\n"
+ .' "username": "sasfadfa"'."\n"
+ .' }'."\n"
+ ."\n"
+ .'* mongodb'."\n"
+ ."\n"
+ .'<!---->'."\n"
+ ."\n"
+ .' {'."\n"
+ .' "address": "[\\"xsaxxsa.mongodb.rds.aliyuncs.com:3717\\"]",'."\n"
+ .' "database": "admin",'."\n"
+ .' "password": "sadsda@",'."\n"
+ .' "tag": "public",'."\n"
+ .' "username": "dsadsadas"'."\n"
+ .' }'."\n"
+ ."\n"
+ .'* emr'."\n"
+ ."\n"
+ .'<!---->'."\n"
+ ."\n"
+ .' {'."\n"
+ .' "accessId": "xsaxsa",'."\n"
+ .' "emrClusterId": "C-dsads",'."\n"
+ .' "emrResourceQueueName": "default",'."\n"
+ .' "emrEndpoint": "emr.aliyuncs.com",'."\n"
+ .' "accessKey": "dsadsad",'."\n"
+ .' "emrUserId": "224833315798889783",'."\n"
+ .' "name": "sasdsadsa",'."\n"
+ .' "emrAccessMode": "simple",'."\n"
+ .' "region": "cn-shanghai",'."\n"
+ .' "authType": "2",'."\n"
+ .' "emrProjectId": "FP-sdadsad"'."\n"
+ .' }'."\n"
+ ."\n"
+ .'* postgresql'."\n"
+ ."\n"
+ .'<!---->'."\n"
+ ."\n"
+ .' {'."\n"
+ .' "jdbcUrl": "jdbc:postgresql://xxxx:1921/ssss",'."\n"
+ .' "password": "sdadsads",'."\n"
+ .' "tag": "public",'."\n"
+ .' "username": "sdsasda"'."\n"
+ .' }'."\n"
+ ."\n"
+ .'* analyticdb_for_mysql'."\n"
+ ."\n"
+ .'<!---->'."\n"
+ ."\n"
+ .' {'."\n"
+ .' "instanceId": "am-sadsada",'."\n"
+ .' "database": "xsxsx",'."\n"
+ .' "username": "xsxsa",'."\n"
+ .' "password": "asdadsa",'."\n"
+ .' "connectionString": "am-xssxsxs.ads.aliyuncs.com:3306"'."\n"
+ .' }'."\n"
+ ."\n"
+ .'* hybriddb_for_postgresql'."\n"
+ ."\n"
+ .'<!---->'."\n"
+ ."\n"
+ .' {'."\n"
+ .' "connectionString": "gp-xsaxsaxa-master.gpdbmaster.rds.aliyuncs.com",'."\n"
+ .' "database": "xsaxsaxas",'."\n"
+ .' "password": "xsaxsaxsa@11",'."\n"
+ .' "instanceId": "gp-xsaxsaxsa",'."\n"
+ .' "port": "541132",'."\n"
+ .' "ownerId": "xsaxsaxsas",'."\n"
+ .' "username": "sadsad"'."\n"
+ .' }'."\n"
+ ."\n"
+ .'* holo'."\n"
+ ."\n"
+ .'<!---->'."\n"
+ ."\n"
+ .' {'."\n"
+ .' "accessId": "xsaxsaxs",'."\n"
+ .' "accessKey": "xsaxsaxsa",'."\n"
+ .' "database": "xsaxsaxsa",'."\n"
+ .' "instanceId": "xsaxa",'."\n"
+ .' "tag": "aliyun"'."\n"
+ .' }'."\n"
+ ."\n"
+ .'* kafka'."\n"
+ ."\n"
+ .'<!---->'."\n"
+ ."\n"
+ .' {'."\n"
+ .' "instanceId": "xsax-cn-xsaxsa",'."\n"
+ .' "regionId": "cn-shanghai",'."\n"
+ .' "tag": "aliyun",'."\n"
+ .' "ownerId": "1212121212112"'."\n"
+ .' }'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => '{"database":"dbname","instanceName":"instancename","password":"password","rdsOwnerId":"123","username":"username"}',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'HttpStatusCode' => [
+ 'description' => 'The HTTP status code.'."\n",
+ 'type' => 'string',
+ 'example' => '200',
+ ],
+ 'Data' => [
+ 'description' => 'The data source ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '123',
+ ],
+ 'RequestId' => [
+ 'description' => 'The request ID.'."\n",
+ 'type' => 'string',
+ 'example' => '0bc141151593763****',
+ ],
+ 'Success' => [
+ 'description' => 'Indicates whether the request was successful.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ ],
+ 'description' => '',
+ ],
+ ],
+ ],
+ 'errorCodes' => [
+ 400 => [
+ [
+ 'errorCode' => 'Invalid.Tenant.ConnectionNotExists',
+ 'errorMessage' => 'The connection does not exist.',
+ ],
+ [
+ 'errorCode' => 'Invalid.Tenant.ProjectNotExists',
+ 'errorMessage' => 'The project does not exist.',
+ ],
+ [
+ 'errorCode' => 'Invalid.Tenant.UserNotInProject',
+ 'errorMessage' => 'The user is not in the project.',
+ ],
+ [
+ 'errorCode' => 'ConnectionAlreadyExist',
+ 'errorMessage' => 'The connection with envType %s and name %s already exists.',
+ ],
+ [
+ 'errorCode' => 'DataSource.CheckRamRoleFailure',
+ 'errorMessage' => 'Failed to check the RAM role. AccountId %s. roleArn %s.',
+ ],
+ [
+ 'errorCode' => 'DataSource.ConnectionStrProperty.PatternNotMatch',
+ 'errorMessage' => 'The pattern value %s is invalid. The correct pattern is %s.',
+ ],
+ [
+ 'errorCode' => 'Invalid.DataSource.DataSourceTypeNotSupport',
+ 'errorMessage' => 'The dataSourceType %s and subType %s are not supported.',
+ ],
+ [
+ 'errorCode' => 'Invalid.Param.Odps.EngineIdOrConnectStrEmpty',
+ 'errorMessage' => 'Either the compute engine ID or the connection string must be specified when data source type is ODPS.',
+ ],
+ [
+ 'errorCode' => 'MissingParam.ConnectionStr.Property',
+ 'errorMessage' => 'You must specify property %s required by the data source connection string.',
+ ],
+ [
+ 'errorCode' => 'Invalid.DataSource.DataSourceTypeNotExist',
+ 'errorMessage' => 'The data source type %s does not exist.',
+ ],
+ ],
+ 403 => [
+ [
+ 'errorCode' => 'Invalid.Tenant.UserIsNotProjectOwnerOrAdmin',
+ 'errorMessage' => 'The user is not a project administrator or owner.',
+ ],
+ [
+ 'errorCode' => 'Invalid.Tenant.UserNotInTenant',
+ 'errorMessage' => 'The user is not in tenant.',
+ ],
+ ],
+ ],
+ 'staticInfo' => [
+ 'substitutions' => [
+ 'dataworks-public::2020-05-18::CreateDataSource',
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": \\"200\\",\\n \\"Data\\": 123,\\n \\"RequestId\\": \\"0bc141151593763****\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<RequestId>0bc141151593763****</RequestId>\\n<HttpStatusCode>200</HttpStatusCode>\\n<Data>123</Data>\\n<Success>true</Success>","errorExample":""}]',
+ 'title' => 'CreateConnection',
+ 'requestParamsDescription' => ' ',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ ],
+ 'CreateDagComplement' => [
+ 'methods' => [
+ 'post',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'readAndWrite',
+ 'deprecated' => true,
+ 'systemTags' => [
+ 'operationType' => 'create',
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'ProjectEnv',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => '',
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'PROD',
+ 'enum' => [
+ 'PROD',
+ 'DEV',
+ ],
+ ],
+ ],
+ [
+ 'name' => 'StartBizDate',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => '',
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => '2020-05-20 00:00:00',
+ ],
+ ],
+ [
+ 'name' => 'Name',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => '',
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'xm_test',
+ ],
+ ],
+ [
+ 'name' => 'RootNodeId',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => '',
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => '1234',
+ ],
+ ],
+ [
+ 'name' => 'IncludeNodeIds',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => '',
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => '74324,74325',
+ ],
+ ],
+ [
+ 'name' => 'ExcludeNodeIds',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => '',
+ 'type' => 'string',
+ 'required' => false,
+ 'docRequired' => false,
+ 'example' => ' 1234',
+ ],
+ ],
+ [
+ 'name' => 'BizBeginTime',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => '',
+ 'type' => 'string',
+ 'required' => false,
+ 'docRequired' => false,
+ 'example' => '00:00:00',
+ ],
+ ],
+ [
+ 'name' => 'BizEndTime',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => '',
+ 'type' => 'string',
+ 'required' => false,
+ 'docRequired' => false,
+ 'example' => '23:00:00',
+ ],
+ ],
+ [
+ 'name' => 'Parallelism',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => '',
+ 'type' => 'boolean',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'false',
+ ],
+ ],
+ [
+ 'name' => 'EndBizDate',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => '',
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => '2020-05-21 00:00:00',
+ ],
+ ],
+ [
+ 'name' => 'NodeParams',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => '',
+ 'type' => 'string',
+ 'required' => false,
+ 'docRequired' => false,
+ 'example' => '{74324:"key1=val1 key2=val"}',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'HttpStatusCode' => [
+ 'description' => '',
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '200',
+ ],
+ 'RequestId' => [
+ 'description' => '',
+ 'type' => 'string',
+ 'example' => 'E6F0DBDD-5AD****',
+ ],
+ 'ErrorMessage' => [
+ 'description' => '',
+ 'type' => 'string',
+ 'example' => 'The connection does not exist.',
+ ],
+ 'Success' => [
+ 'description' => '',
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'ErrorCode' => [
+ 'description' => '',
+ 'type' => 'string',
+ 'example' => 'Invalid.Tenant.ConnectionNotExists',
+ ],
+ 'Data' => [
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '',
+ 'type' => 'integer',
+ 'example' => '111',
+ 'format' => 'int64',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"E6F0DBDD-5AD****\\",\\n \\"ErrorMessage\\": \\"The connection does not exist.\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"Invalid.Tenant.ConnectionNotExists\\",\\n \\"Data\\": [\\n 111\\n ]\\n}","errorExample":""},{"type":"xml","example":"<RequestId>E6F0DBDD-5AD****</RequestId>\\n<HttpStatusCode>200</HttpStatusCode>\\n<Data>111</Data>\\n<ErrorCode>Invalid.Tenant.ConnectionNotExists</ErrorCode>\\n<ErrorMessage>The connection does not exist.</ErrorMessage>\\n<Success>true</Success>","errorExample":""}]',
+ 'title' => 'CreateDagComplement',
+ 'requestParamsDescription' => ' ',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ ],
+ 'CreateDagTest' => [
+ 'methods' => [
+ 'post',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'readAndWrite',
+ 'deprecated' => true,
+ 'systemTags' => [
+ 'operationType' => 'create',
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'ProjectEnv',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => '',
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'PROD',
+ 'enum' => [
+ 'PROD',
+ 'DEV',
+ ],
+ ],
+ ],
+ [
+ 'name' => 'Bizdate',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => '',
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => '2020-05-26 00:00:00',
+ ],
+ ],
+ [
+ 'name' => 'Name',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => '',
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'xm_create_test',
+ ],
+ ],
+ [
+ 'name' => 'NodeId',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => '',
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => '1234',
+ ],
+ ],
+ [
+ 'name' => 'NodeParams',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => '',
+ 'type' => 'string',
+ 'required' => false,
+ 'docRequired' => false,
+ 'example' => 'bizdate=$bizdate tbods=$tbods',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'HttpStatusCode' => [
+ 'description' => '',
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '200',
+ ],
+ 'Data' => [
+ 'description' => '',
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '3333333',
+ ],
+ 'ErrorMessage' => [
+ 'description' => '',
+ 'type' => 'string',
+ 'example' => 'The connection does not exist.',
+ ],
+ 'RequestId' => [
+ 'description' => '',
+ 'type' => 'string',
+ 'example' => 'E6F0DBDD-5AD****',
+ ],
+ 'ErrorCode' => [
+ 'description' => '',
+ 'type' => 'string',
+ 'example' => 'Invalid.Tenant.ConnectionNotExists',
+ ],
+ 'Success' => [
+ 'description' => '',
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Data\\": 3333333,\\n \\"ErrorMessage\\": \\"The connection does not exist.\\",\\n \\"RequestId\\": \\"E6F0DBDD-5AD****\\",\\n \\"ErrorCode\\": \\"Invalid.Tenant.ConnectionNotExists\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<RequestId>E6F0DBDD-5AD****</RequestId>\\n<HttpStatusCode>200</HttpStatusCode>\\n<Data>3333333</Data>\\n<ErrorCode>Invalid.Tenant.ConnectionNotExists</ErrorCode>\\n<ErrorMessage>The connection does not exist.</ErrorMessage>\\n<Success>true</Success>","errorExample":""}]',
+ 'title' => 'CreateDagTest',
+ 'requestParamsDescription' => ' ',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ ],
+ 'CreateManualDag' => [
+ 'methods' => [
+ 'post',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'readAndWrite',
+ 'deprecated' => true,
+ 'systemTags' => [
+ 'operationType' => 'create',
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'ProjectEnv',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The environment type of Operation Center. Valid values: PROD and DEV.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => '',
+ 'enum' => [
+ 'PROD',
+ 'DEV',
+ ],
+ ],
+ ],
+ [
+ 'name' => 'ProjectName',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The name of the workspace to which the manually triggered workflow belongs.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'test_workspace',
+ ],
+ ],
+ [
+ 'name' => 'FlowName',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The name of the manually triggered workflow.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'test_workflow',
+ ],
+ ],
+ [
+ 'name' => 'BizDate',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The data timestamp. The value of the data timestamp must be one or more days before the current date. For example, if the current date is November 11, 2020, set the value to 2020-11-10 00:00:00 or earlier. Configure this parameter in the YYYY-MM-DD 00:00:00 format.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => '2020-11-11 00:00:00',
+ ],
+ ],
+ [
+ 'name' => 'NodeParameters',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The parameters transmitted between nodes in the manually triggered workflow. The parameters are in the following JSON format: `{ "<ID of a node in the manually triggered workflow>": "Scheduling parameter settings of the node, which are in the same format as the parameters in the Scheduling Parameter section on the Properties tab of the DataStudio page", "<ID of a node in the manually triggered workflow>": "Scheduling parameter settings of the node, which are in the same format as the parameters in the Scheduling Parameter section on the Properties tab of the DataStudio page" }`'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'docRequired' => true,
+ 'example' => '{"20000123121": "key1=val2 key2=val2", "20000123124": "kkkk=vvvvv aaaa=bbbb"}',
+ ],
+ ],
+ [
+ 'name' => 'DagParameters',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The parameters of the manually triggered workflow, which are synchronized to all the instances in the directed acyclic graph (DAG) of the workflow. If a workflow parameter specified in DagParameters is referenced as a scheduling parameter of a node, the value of the scheduling parameter is replaced with the value of the workflow parameter.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'docRequired' => false,
+ 'example' => '{"kaaaa": "vaaaaa", "kbbbb": "vbbbbb"}',
+ ],
+ ],
+ [
+ 'name' => 'IncludeNodeIds',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The IDs of the nodes that you want to run.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => '74324,74325',
+ ],
+ ],
+ [
+ 'name' => 'ExcludeNodeIds',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The IDs of the nodes that do not need to be run.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => '123,456',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'description' => 'The response parameters.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'DagId' => [
+ 'description' => 'The ID of the DAG for the manually triggered workflow. You can call an operation with this parameter as a request parameter to query the details and states of the nodes in the manually triggered workflow.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '700000123123141',
+ ],
+ 'RequestId' => [
+ 'description' => 'The request ID.'."\n",
+ 'type' => 'string',
+ 'example' => 'AASFDFSDFG-DFSDF-DFSDFD-SDFSDF',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"DagId\\": 700000123123141,\\n \\"RequestId\\": \\"AASFDFSDFG-DFSDF-DFSDFD-SDFSDF\\"\\n}","errorExample":""},{"type":"xml","example":"<CreateManualDagResponse>\\n <DagId>700000123123141</DagId>\\n <RequestId>AASFDFSDFG-DFSDF-DFSDFD-SDFSDF</RequestId>\\n</CreateManualDagResponse>","errorExample":""}]',
+ 'title' => 'CreateManualDag',
+ 'summary' => 'Triggers a manually triggered workflow to run. Before you call this operation, make sure that the manually triggered workflow is committed and deployed. You can find the manually triggered workflow on the Operation Center page only after the manually triggered workflow is committed and deployed.',
+ 'requestParamsDescription' => ' ',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ ],
+ 'DeleteConnection' => [
+ 'summary' => 'Removes a data source.',
+ 'methods' => [
+ 'post',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'write',
+ 'deprecated' => true,
+ 'systemTags' => [
+ 'operationType' => 'delete',
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'ConnectionId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The data source ID. You can call the [ListConnection](~~173911~~) operation to query the ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => '1',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'HttpStatusCode' => [
+ 'description' => 'The HTTP status code.'."\n",
+ 'type' => 'string',
+ 'example' => '200',
+ ],
+ 'Data' => [
+ 'description' => 'Indicates whether the data source was removed.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'RequestId' => [
+ 'description' => 'The request ID.'."\n",
+ 'type' => 'string',
+ 'example' => '0bc1411515937635****',
+ ],
+ 'Success' => [
+ 'description' => 'Indicates whether the request was successful.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ ],
+ 'description' => '',
+ ],
+ ],
+ ],
+ 'errorCodes' => [
+ 400 => [
+ [
+ 'errorCode' => 'Invalid.Tenant.ConnectionNotExists',
+ 'errorMessage' => 'The connection does not exist.',
+ ],
+ [
+ 'errorCode' => 'Invalid.Tenant.ProjectNotExists',
+ 'errorMessage' => 'The project does not exist.',
+ ],
+ [
+ 'errorCode' => 'Invalid.Tenant.UserNotInProject',
+ 'errorMessage' => 'The user is not in the project.',
+ ],
+ ],
+ 403 => [
+ [
+ 'errorCode' => 'Invalid.Tenant.UserIsNotProjectOwnerOrAdmin',
+ 'errorMessage' => 'The user is not a project administrator or owner.',
+ ],
+ [
+ 'errorCode' => 'Invalid.Tenant.UserNotInTenant',
+ 'errorMessage' => 'The user is not in tenant.',
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": \\"200\\",\\n \\"Data\\": true,\\n \\"RequestId\\": \\"0bc1411515937635****\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<RequestId>0bc1411515937635****</RequestId>\\n<HttpStatusCode>200</HttpStatusCode>\\n<Data>true</Data>\\n<Success>true</Success>","errorExample":""}]',
+ 'title' => 'DeleteConnection',
+ 'requestParamsDescription' => ' ',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ ],
+ 'UpdateConnection' => [
+ 'summary' => 'Updates a data source.',
+ 'methods' => [
+ 'put',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'write',
+ 'deprecated' => true,
+ 'systemTags' => [
+ 'operationType' => 'update',
+ 'riskType' => 'high',
+ 'chargeType' => 'free',
+ 'abilityTreeNodes' => [
+ 'FEATUREdide7FTVFZ',
+ ],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'Description',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The description of the data source.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'abc',
+ ],
+ ],
+ [
+ 'name' => 'EnvType',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The environment in which the data source is used. Valid values: 0 and 1. The value 0 indicates the development environment. The value 1 indicates the production environment.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => false,
+ 'docRequired' => true,
+ 'example' => '1',
+ ],
+ ],
+ [
+ 'name' => 'Content',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The details of the data source. Examples of details of some common data sources:'."\n"
+ ."\n"
+ .'* odps'."\n"
+ ."\n"
+ .'<!---->'."\n"
+ ."\n"
+ .' {'."\n"
+ .' "accessId": "xssssss",'."\n"
+ .' "accessKey": "xsaxsaxsa",'."\n"
+ .' "authType": 2,'."\n"
+ .' "endpoint": "http://service.odps.aliyun.com/api",'."\n"
+ .' "project": "xsaxsax",'."\n"
+ .' "tag": "public"'."\n"
+ .' }'."\n"
+ ."\n"
+ .'* mysql'."\n"
+ ."\n"
+ .'<!---->'."\n"
+ ."\n"
+ .' {'."\n"
+ .' "database": "xsaxsa",'."\n"
+ .' "instanceName": "rm-xsaxsa",'."\n"
+ .' "password": "xsaxsa",'."\n"
+ .' "rdsOwnerId": "xasxsa",'."\n"
+ .' "regionId": "cn-shanghai",'."\n"
+ .' "tag": "rds",'."\n"
+ .' "username": "xsaxsa"'."\n"
+ .' }'."\n"
+ ."\n"
+ .'* rds'."\n"
+ ."\n"
+ .'<!---->'."\n"
+ ."\n"
+ .' {'."\n"
+ .' "configType": 1,'."\n"
+ .' "tag": "rds",'."\n"
+ .' "database": "xsaxsa",'."\n"
+ .' "username": "xsaxsa",'."\n"
+ .' "password": "xssaxsa$32050",'."\n"
+ .' "instanceName": "rm-xsaxs",'."\n"
+ .' "rdsOwnerId": "11111111"'."\n"
+ .' }'."\n"
+ ."\n"
+ .'* oss'."\n"
+ ."\n"
+ .'<!---->'."\n"
+ ."\n"
+ .' {'."\n"
+ .' "accessId": "sssssxx",'."\n"
+ .' "accessKey": "xsaxaxsaxs",'."\n"
+ .' "bucket": "xsa-xs-xs",'."\n"
+ .' "endpoint": "http://oss-cn-shanghai.aliyuncs.com",'."\n"
+ .' "tag": "public"'."\n"
+ .' }'."\n"
+ ."\n"
+ .'* sqlserver'."\n"
+ ."\n"
+ .'<!---->'."\n"
+ ."\n"
+ .' {'."\n"
+ .' "jdbcUrl": "jdbc:sqlserver://xsaxsa-xsaxsa.database.xxx.cn:123;DatabaseName=xsxs-xsxs",'."\n"
+ .' "password": "sdasda$fs",'."\n"
+ .' "tag": "public",'."\n"
+ .' "username": "sxaxacdacdd"'."\n"
+ .' }'."\n"
+ ."\n"
+ .'* polardb'."\n"
+ ."\n"
+ .'<!---->'."\n"
+ ."\n"
+ .' {'."\n"
+ .' "clusterId": "pc-sdadsadsa",'."\n"
+ .' "database": "dsadsadsa",'."\n"
+ .' "ownerId": "121212122",'."\n"
+ .' "password": "sdasdafssa",'."\n"
+ .' "region": "cn-shanghai",'."\n"
+ .' "tag": "polardb",'."\n"
+ .' "username": "asdadsads"'."\n"
+ .' }'."\n"
+ ."\n"
+ .'* oracle'."\n"
+ ."\n"
+ .'<!---->'."\n"
+ ."\n"
+ .' {'."\n"
+ .' "jdbcUrl": "jdbc:oracle:saaa:@xxxxx:1521:PROD",'."\n"
+ .' "password": "sxasaxsa",'."\n"
+ .' "tag": "public",'."\n"
+ .' "username": "sasfadfa"'."\n"
+ .' }'."\n"
+ ."\n"
+ .'* mongodb'."\n"
+ ."\n"
+ .'<!---->'."\n"
+ ."\n"
+ .' {'."\n"
+ .' "address": "[\\"xsaxxsa.mongodb.rds.aliyuncs.com:3717\\"]",'."\n"
+ .' "database": "admin",'."\n"
+ .' "password": "sadsda@",'."\n"
+ .' "tag": "public",'."\n"
+ .' "username": "dsadsadas"'."\n"
+ .' }'."\n"
+ ."\n"
+ .'* emr'."\n"
+ ."\n"
+ .'<!---->'."\n"
+ ."\n"
+ .' {'."\n"
+ .' "accessId": "xsaxsa",'."\n"
+ .' "emrClusterId": "C-dsads",'."\n"
+ .' "emrResourceQueueName": "default",'."\n"
+ .' "emrEndpoint": "emr.aliyuncs.com",'."\n"
+ .' "accessKey": "dsadsad",'."\n"
+ .' "emrUserId": "224833315798889783",'."\n"
+ .' "name": "sasdsadsa",'."\n"
+ .' "emrAccessMode": "simple",'."\n"
+ .' "region": "cn-shanghai",'."\n"
+ .' "authType": "2",'."\n"
+ .' "emrProjectId": "FP-sdadsad"'."\n"
+ .' }'."\n"
+ ."\n"
+ .'* postgresql'."\n"
+ ."\n"
+ .'<!---->'."\n"
+ ."\n"
+ .' {'."\n"
+ .' "jdbcUrl": "jdbc:postgresql://xxxx:1921/ssss",'."\n"
+ .' "password": "sdadsads",'."\n"
+ .' "tag": "public",'."\n"
+ .' "username": "sdsasda"'."\n"
+ .' }'."\n"
+ ."\n"
+ .'* analyticdb_for_mysql'."\n"
+ ."\n"
+ .'<!---->'."\n"
+ ."\n"
+ .' {'."\n"
+ .' "instanceId": "am-sadsada",'."\n"
+ .' "database": "xsxsx",'."\n"
+ .' "username": "xsxsa",'."\n"
+ .' "password": "asdadsa",'."\n"
+ .' "connectionString": "am-xssxsxs.ads.aliyuncs.com:3306"'."\n"
+ .' }'."\n"
+ ."\n"
+ .'* hybriddb_for_postgresql'."\n"
+ ."\n"
+ .'<!---->'."\n"
+ ."\n"
+ .' {'."\n"
+ .' "connectionString": "gp-xsaxsaxa-master.gpdbmaster.rds.aliyuncs.com",'."\n"
+ .' "database": "xsaxsaxas",'."\n"
+ .' "password": "xsaxsaxsa@11",'."\n"
+ .' "instanceId": "gp-xsaxsaxsa",'."\n"
+ .' "port": "541132",'."\n"
+ .' "ownerId": "xsaxsaxsas",'."\n"
+ .' "username": "sadsad"'."\n"
+ .' }'."\n"
+ ."\n"
+ .'* holo'."\n"
+ ."\n"
+ .'<!---->'."\n"
+ ."\n"
+ .' {'."\n"
+ .' "accessId": "xsaxsaxs",'."\n"
+ .' "accessKey": "xsaxsaxsa",'."\n"
+ .' "database": "xsaxsaxsa",'."\n"
+ .' "instanceId": "xsaxa",'."\n"
+ .' "tag": "aliyun"'."\n"
+ .' }'."\n"
+ ."\n"
+ .'* kafka'."\n"
+ ."\n"
+ .'<!---->'."\n"
+ ."\n"
+ .' {'."\n"
+ .' "instanceId": "xsax-cn-xsaxsa",'."\n"
+ .' "regionId": "cn-shanghai",'."\n"
+ .' "tag": "aliyun",'."\n"
+ .' "ownerId": "1212121212112"'."\n"
+ .' }'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'docRequired' => true,
+ 'example' => '{"database":"dbname","instanceName":"instancename","password":"password","rdsOwnerId":"123","username":"username"}',
+ ],
+ ],
+ [
+ 'name' => 'Status',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The status of the data source. Valid values: ENABLED and DISABLED. The value ENABLED indicates that the data source is in the normal state. The value DISABLED indicates that the data source is in an abnormal state.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'ENABLED',
+ ],
+ ],
+ [
+ 'name' => 'ConnectionId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The data source ID. You can call the [ListConnections](~~173911~~) operation to query the ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => '1',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'HttpStatusCode' => [
+ 'description' => 'The HTTP status code.'."\n",
+ 'type' => 'string',
+ 'example' => '200',
+ ],
+ 'Data' => [
+ 'description' => 'Indicates whether the data source is updated.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'RequestId' => [
+ 'description' => 'The request ID.'."\n",
+ 'type' => 'string',
+ 'example' => '0bc14115159376359****',
+ ],
+ 'Success' => [
+ 'description' => 'Indicates whether the request was successful.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ ],
+ 'description' => '',
+ ],
+ ],
+ ],
+ 'errorCodes' => [
+ 400 => [
+ [
+ 'errorCode' => 'Invalid.Tenant.ConnectionNotExists',
+ 'errorMessage' => 'The connection does not exist.',
+ ],
+ [
+ 'errorCode' => 'Invalid.Tenant.ProjectNotExists',
+ 'errorMessage' => 'The project does not exist.',
+ ],
+ [
+ 'errorCode' => 'Invalid.Tenant.UserNotInProject',
+ 'errorMessage' => 'The user is not in the project.',
+ ],
+ [
+ 'errorCode' => 'Invalid.DataSource.DataSourceStatus',
+ 'errorMessage' => 'The specified dataSourceStatus %s is invalid.',
+ ],
+ ],
+ 403 => [
+ [
+ 'errorCode' => 'Invalid.Tenant.UserIsNotProjectOwnerOrAdmin',
+ 'errorMessage' => 'The user is not a project administrator or owner.',
+ ],
+ [
+ 'errorCode' => 'Invalid.Tenant.UserNotInTenant',
+ 'errorMessage' => 'The user is not in tenant.',
+ ],
+ ],
+ ],
+ 'staticInfo' => [
+ 'substitutions' => [
+ 'dataworks-public::2020-05-18::UpdateDataSource',
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": \\"200\\",\\n \\"Data\\": true,\\n \\"RequestId\\": \\"0bc14115159376359****\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<RequestId>0bc14115159376359****</RequestId>\\n<HttpStatusCode>200</HttpStatusCode>\\n<Data>true</Data>\\n<Success>true</Success>","errorExample":""}]',
+ 'title' => 'UpdateConnection',
+ 'requestParamsDescription' => ' ',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ ],
+ 'ListConnections' => [
+ 'summary' => 'Queries a list of data sources.',
+ 'methods' => [
+ 'get',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => true,
+ 'systemTags' => [
+ 'operationType' => 'get',
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'ProjectId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the workspace to which the data source belongs. You can call the [ListProjects](~~178393~~) operation to query the ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => '76086',
+ ],
+ ],
+ [
+ 'name' => 'Name',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The name of the data source that you want to query.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'docRequired' => true,
+ 'example' => 'abc',
+ ],
+ ],
+ [
+ 'name' => 'ConnectionType',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The type of the data source. Valid values:'."\n"
+ ."\n"
+ .'* odps'."\n"
+ .'* mysql'."\n"
+ .'* rds'."\n"
+ .'* oss'."\n"
+ .'* sqlserver'."\n"
+ .'* polardb'."\n"
+ .'* oracle'."\n"
+ .'* mongodb'."\n"
+ .'* emr'."\n"
+ .'* postgresql'."\n"
+ .'* analyticdb_for_mysql'."\n"
+ .'* hybriddb_for_postgresql'."\n"
+ .'* holo'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'rds',
+ ],
+ ],
+ [
+ 'name' => 'SubType',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The subtype of the data source. This parameter is used in scenarios where a type includes subtypes. The following type and subtypes are supported:'."\n"
+ ."\n"
+ .'* Type: `rds`'."\n"
+ .'* Subtypes: `mysql`, `sqlserver`, and `postgresql`'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'mysql',
+ ],
+ ],
+ [
+ 'name' => 'Status',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The status of the data source. Valid values:'."\n"
+ ."\n"
+ .'* ENABLED'."\n"
+ .'* DISABLED'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => '1',
+ ],
+ ],
+ [
+ 'name' => 'EnvType',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The environment in which the data source is used. Valid values: 0 and 1. The value 0 indicates the development environment. The value 1 indicates the production environment.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => false,
+ 'example' => '1',
+ ],
+ ],
+ [
+ 'name' => 'PageSize',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The number of entries per page. Default value: 10. Maximum value: 100.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => false,
+ 'example' => '10',
+ ],
+ ],
+ [
+ 'name' => 'PageNumber',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The page number. Pages start from page 1.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => false,
+ 'example' => '1',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'HttpStatusCode' => [
+ 'description' => 'The HTTP status code.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '200',
+ ],
+ 'RequestId' => [
+ 'description' => 'The request ID.'."\n",
+ 'type' => 'string',
+ 'example' => '0bc14115159376359****',
+ ],
+ 'Success' => [
+ 'description' => 'Indicates whether the request was successful.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'Data' => [
+ 'description' => 'The query results for data sources that are returned on multiple pages.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'PageNumber' => [
+ 'description' => 'The page number.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '1',
+ ],
+ 'PageSize' => [
+ 'description' => 'The number of entries per page. Default value: 10. Maximum value: 100.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '20',
+ ],
+ 'TotalCount' => [
+ 'description' => 'The total number of data sources returned.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '3',
+ ],
+ 'Connections' => [
+ 'description' => 'The data sources.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'Status' => [
+ 'description' => 'The status of the data source. Valid values:'."\n"
+ ."\n"
+ .'* 1: The data source is normal.'."\n"
+ .'* 2: The data source is disabled.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '1',
+ ],
+ 'ConnectionType' => [
+ 'description' => 'The type of the data source. Valid values:'."\n"
+ ."\n"
+ .'* odps'."\n"
+ .'* mysql'."\n"
+ .'* rds'."\n"
+ .'* oss'."\n"
+ .'* sqlserver'."\n"
+ .'* polardb'."\n"
+ .'* oracle'."\n"
+ .'* mongodb'."\n"
+ .'* emr'."\n"
+ .'* postgresql'."\n"
+ .'* analyticdb_for_mysql'."\n"
+ .'* hybriddb_for_postgresql'."\n"
+ .'* holo'."\n",
+ 'type' => 'string',
+ 'example' => 'mysql',
+ ],
+ 'ProjectId' => [
+ 'description' => 'The ID of the workspace with which the data source is associated.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '123',
+ ],
+ 'SubType' => [
+ 'description' => 'The subtype of the data source. This parameter is used in scenarios where a type includes subtypes. The following type and subtypes are supported:'."\n"
+ ."\n"
+ .'* Type: `rds`'."\n"
+ .'* Subtypes: `mysql`, `sqlserver`, and `postgresql`.'."\n",
+ 'type' => 'string',
+ 'example' => 'mysql',
+ ],
+ 'GmtModified' => [
+ 'description' => 'The time when the data source was last modified. Example: Mar 17, 2021 4:09:32 PM.'."\n",
+ 'type' => 'string',
+ 'example' => 'Mar 17, 2021 4:09:32 PM',
+ ],
+ 'EnvType' => [
+ 'description' => 'The environment in which the data source is used. Valid values:'."\n"
+ ."\n"
+ .'* 0: development environment'."\n"
+ .'* 1: production environment'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '1',
+ ],
+ 'ConnectStatus' => [
+ 'description' => 'The status of the data source. Valid values:'."\n"
+ ."\n"
+ .'* 1: The data source is normal.'."\n"
+ .'* 2: The data source is disabled.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '1',
+ ],
+ 'Sequence' => [
+ 'description' => 'The field that is used to sort data sources. Data sources are sorted in descending order based on the value of this parameter.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '300',
+ ],
+ 'Description' => [
+ 'description' => 'The description of the data source.'."\n",
+ 'type' => 'string',
+ 'example' => 'a connection',
+ ],
+ 'GmtCreate' => [
+ 'description' => 'The time when the data source was created. Example: Mar 17, 2021 4:09:32 PM.'."\n",
+ 'type' => 'string',
+ 'example' => 'Mar 17, 2021 4:09:32 PM',
+ ],
+ 'DefaultEngine' => [
+ 'description' => 'Indicates whether the compute engine that is associated with the data source is the default compute engine used by data sources of the same type.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'false',
+ ],
+ 'Shared' => [
+ 'description' => 'Indicates whether the data source is a shared data source.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'false',
+ ],
+ 'Operator' => [
+ 'description' => 'The ID of the Alibaba Cloud account that is used to last modify the data source.'."\n",
+ 'type' => 'string',
+ 'example' => '193543050****',
+ ],
+ 'Name' => [
+ 'description' => 'The name of the data source.'."\n",
+ 'type' => 'string',
+ 'example' => 'abc',
+ ],
+ 'Content' => [
+ 'description' => 'The details of the data source. Examples of details of some common data sources:'."\n"
+ ."\n"
+ .'* odps'."\n"
+ ."\n"
+ .'<!---->'."\n"
+ ."\n"
+ .' {'."\n"
+ .' "accessId": "xssssss",'."\n"
+ .' "accessKey": "xsaxsaxsa",'."\n"
+ .' "authType": 2,'."\n"
+ .' "endpoint": "http://service.odps.aliyun.com/api",'."\n"
+ .' "project": "xsaxsax",'."\n"
+ .' "tag": "public"'."\n"
+ .' }'."\n"
+ ."\n"
+ .'* mysql'."\n"
+ ."\n"
+ .'<!---->'."\n"
+ ."\n"
+ .' {'."\n"
+ .' "database": "xsaxsa",'."\n"
+ .' "instanceName": "rm-xsaxsa",'."\n"
+ .' "password": "xsaxsa",'."\n"
+ .' "rdsOwnerId": "xasxsa",'."\n"
+ .' "regionId": "cn-shanghai",'."\n"
+ .' "tag": "rds",'."\n"
+ .' "username": "xsaxsa"'."\n"
+ .' }'."\n"
+ ."\n"
+ .'* rds'."\n"
+ ."\n"
+ .'<!---->'."\n"
+ ."\n"
+ .' {'."\n"
+ .' "configType": 1,'."\n"
+ .' "tag": "rds",'."\n"
+ .' "database": "xsaxsa",'."\n"
+ .' "username": "xsaxsa",'."\n"
+ .' "password": "xssaxsa$32050",'."\n"
+ .' "instanceName": "rm-xsaxs",'."\n"
+ .' "rdsOwnerId": "11111111"'."\n"
+ .' }'."\n"
+ ."\n"
+ .'* oss'."\n"
+ ."\n"
+ .'<!---->'."\n"
+ ."\n"
+ .' {'."\n"
+ .' "accessId": "sssssxx",'."\n"
+ .' "accessKey": "xsaxaxsaxs",'."\n"
+ .' "bucket": "xsa-xs-xs",'."\n"
+ .' "endpoint": "http://oss-cn-shanghai.aliyuncs.com",'."\n"
+ .' "tag": "public"'."\n"
+ .' }'."\n"
+ ."\n"
+ .'* sqlserver'."\n"
+ ."\n"
+ .'<!---->'."\n"
+ ."\n"
+ .' {'."\n"
+ .' "jdbcUrl": "jdbc:sqlserver://xsaxsa-xsaxsa.database.xxx.cn:123;DatabaseName=xsxs-xsxs",'."\n"
+ .' "password": "sdasda$fs",'."\n"
+ .' "tag": "public",'."\n"
+ .' "username": "sxaxacdacdd"'."\n"
+ .' }'."\n"
+ ."\n"
+ .'* polardb'."\n"
+ ."\n"
+ .'<!---->'."\n"
+ ."\n"
+ .' {'."\n"
+ .' "clusterId": "pc-sdadsadsa",'."\n"
+ .' "database": "dsadsadsa",'."\n"
+ .' "ownerId": "121212122",'."\n"
+ .' "password": "sdasdafssa",'."\n"
+ .' "region": "cn-shanghai",'."\n"
+ .' "tag": "polardb",'."\n"
+ .' "username": "asdadsads"'."\n"
+ .' }'."\n"
+ ."\n"
+ .'* oracle'."\n"
+ ."\n"
+ .'<!---->'."\n"
+ ."\n"
+ .' {'."\n"
+ .' "jdbcUrl": "jdbc:oracle:saaa:@xxxxx:1521:PROD",'."\n"
+ .' "password": "sxasaxsa",'."\n"
+ .' "tag": "public",'."\n"
+ .' "username": "sasfadfa"'."\n"
+ .' }'."\n"
+ ."\n"
+ .'* mongodb'."\n"
+ ."\n"
+ .'<!---->'."\n"
+ ."\n"
+ .' {'."\n"
+ .' "address": "[\\"xsaxxsa.mongodb.rds.aliyuncs.com:3717\\"]",'."\n"
+ .' "database": "admin",'."\n"
+ .' "password": "sadsda@",'."\n"
+ .' "tag": "public",'."\n"
+ .' "username": "dsadsadas"'."\n"
+ .' }'."\n"
+ ."\n"
+ .'* emr'."\n"
+ ."\n"
+ .'<!---->'."\n"
+ ."\n"
+ .' {'."\n"
+ .' "accessId": "xsaxsa",'."\n"
+ .' "emrClusterId": "C-dsads",'."\n"
+ .' "emrResourceQueueName": "default",'."\n"
+ .' "emrEndpoint": "emr.aliyuncs.com",'."\n"
+ .' "accessKey": "dsadsad",'."\n"
+ .' "emrUserId": "224833315798889783",'."\n"
+ .' "name": "sasdsadsa",'."\n"
+ .' "emrAccessMode": "simple",'."\n"
+ .' "region": "cn-shanghai",'."\n"
+ .' "authType": "2",'."\n"
+ .' "emrProjectId": "FP-sdadsad"'."\n"
+ .' }'."\n"
+ ."\n"
+ .'* postgresql'."\n"
+ ."\n"
+ .'<!---->'."\n"
+ ."\n"
+ .' {'."\n"
+ .' "jdbcUrl": "jdbc:postgresql://xxxx:1921/ssss",'."\n"
+ .' "password": "sdadsads",'."\n"
+ .' "tag": "public",'."\n"
+ .' "username": "sdsasda"'."\n"
+ .' }'."\n"
+ ."\n"
+ .'* analyticdb_for_mysql'."\n"
+ ."\n"
+ .'<!---->'."\n"
+ ."\n"
+ .' {'."\n"
+ .' "instanceId": "am-sadsada",'."\n"
+ .' "database": "xsxsx",'."\n"
+ .' "username": "xsxsa",'."\n"
+ .' "password": "asdadsa",'."\n"
+ .' "connectionString": "am-xssxsxs.ads.aliyuncs.com:3306"'."\n"
+ .' }'."\n"
+ ."\n"
+ .'* hybriddb_for_postgresql'."\n"
+ ."\n"
+ .'<!---->'."\n"
+ ."\n"
+ .' {'."\n"
+ .' "connectionString": "gp-xsaxsaxa-master.gpdbmaster.rds.aliyuncs.com",'."\n"
+ .' "database": "xsaxsaxas",'."\n"
+ .' "password": "xsaxsaxsa@11",'."\n"
+ .' "instanceId": "gp-xsaxsaxsa",'."\n"
+ .' "port": "541132",'."\n"
+ .' "ownerId": "xsaxsaxsas",'."\n"
+ .' "username": "sadsad"'."\n"
+ .' }'."\n"
+ ."\n"
+ .'* holo'."\n"
+ ."\n"
+ .'<!---->'."\n"
+ ."\n"
+ .' {'."\n"
+ .' "accessId": "xsaxsaxs",'."\n"
+ .' "accessKey": "xsaxsaxsa",'."\n"
+ .' "database": "xsaxsaxsa",'."\n"
+ .' "instanceId": "xsaxa",'."\n"
+ .' "tag": "aliyun"'."\n"
+ .' }'."\n"
+ ."\n"
+ .'* kafka'."\n"
+ ."\n"
+ .'<!---->'."\n"
+ ."\n"
+ .' {'."\n"
+ .' "instanceId": "xsax-cn-xsaxsa",'."\n"
+ .' "regionId": "cn-shanghai",'."\n"
+ .' "tag": "aliyun",'."\n"
+ .' "ownerId": "1212121212112"'."\n"
+ .' }'."\n",
+ 'type' => 'string',
+ 'example' => '{\\"database\\":\\"xxx\\",\\"instanceName\\":\\"xxx\\",\\"password\\":\\"xxx\\",\\"rdsOwnerId\\":\\"xxx\\",\\"tag\\":\\"rds\\",\\"username\\":\\"xxx\\"}',
+ ],
+ 'Id' => [
+ 'description' => 'The data source ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '1',
+ ],
+ 'BindingCalcEngineId' => [
+ 'description' => 'The ID of the compute engine with which the data source is associated.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '123',
+ ],
+ 'TenantId' => [
+ 'description' => 'The tenant ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '1234567',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'description' => '',
+ ],
+ ],
+ ],
+ 'errorCodes' => [
+ 400 => [
+ [
+ 'errorCode' => 'Invalid.Tenant.ConnectionNotExists',
+ 'errorMessage' => 'The connection does not exist.',
+ ],
+ [
+ 'errorCode' => 'Invalid.Tenant.ProjectNotExists',
+ 'errorMessage' => 'The project does not exist.',
+ ],
+ [
+ 'errorCode' => 'Invalid.Tenant.UserNotInProject',
+ 'errorMessage' => 'The user is not in the project.',
+ ],
+ ],
+ 403 => [
+ [
+ 'errorCode' => 'Invalid.Tenant.UserIsNotProjectOwnerOrAdmin',
+ 'errorMessage' => 'The user is not a project administrator or owner.',
+ ],
+ [
+ 'errorCode' => 'Invalid.Tenant.UserNotInTenant',
+ 'errorMessage' => 'The user is not in tenant.',
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"0bc14115159376359****\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 20,\\n \\"TotalCount\\": 3,\\n \\"Connections\\": [\\n {\\n \\"Status\\": 1,\\n \\"ConnectionType\\": \\"mysql\\",\\n \\"ProjectId\\": 123,\\n \\"SubType\\": \\"mysql\\",\\n \\"GmtModified\\": \\"Mar 17, 2021 4:09:32 PM\\",\\n \\"EnvType\\": 1,\\n \\"ConnectStatus\\": 1,\\n \\"Sequence\\": 300,\\n \\"Description\\": \\"a connection\\",\\n \\"GmtCreate\\": \\"Mar 17, 2021 4:09:32 PM\\",\\n \\"DefaultEngine\\": false,\\n \\"Shared\\": false,\\n \\"Operator\\": \\"193543050****\\",\\n \\"Name\\": \\"abc\\",\\n \\"Content\\": \\"{\\\\\\\\\\\\\\"database\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"xxx\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"instanceName\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"xxx\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"password\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"xxx\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"rdsOwnerId\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"xxx\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"tag\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"rds\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"username\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"xxx\\\\\\\\\\\\\\"}\\",\\n \\"Id\\": 1,\\n \\"BindingCalcEngineId\\": 123,\\n \\"TenantId\\": 1234567\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<RequestId>0bc14115159****</RequestId>\\n<HttpStatusCode>200</HttpStatusCode>\\n<Data>\\n <Connections>\\n <Operator>193543050****</Operator>\\n <Status>1</Status>\\n <ConnectStatus>1</ConnectStatus>\\n <Description>a connection</Description>\\n <SubType>mysql</SubType>\\n <BindingCalcEngineId>123</BindingCalcEngineId>\\n <ConnectionType>mysql</ConnectionType>\\n <GmtModified>Oct 10, 2019 3:42:53 PM</GmtModified>\\n <ProjectId>123</ProjectId>\\n <Sequence>300</Sequence>\\n <Shared>false</Shared>\\n <EnvType>1</EnvType>\\n <DefaultEngine>false</DefaultEngine>\\n <Name>abc</Name>\\n <GmtCreate>Oct 10, 2019 3:42:53 PM</GmtCreate>\\n <TenantId>1234567</TenantId>\\n <Content>{\\\\\\"database\\\\\\":\\\\\\"xxx\\\\\\",\\\\\\"instanceName\\\\\\":\\\\\\"xxx\\\\\\",\\\\\\"password\\\\\\":\\\\\\"xxx\\\\\\",\\\\\\"rdsOwnerId\\\\\\":\\\\\\"xxx\\\\\\",\\\\\\"tag\\\\\\":\\\\\\"rds\\\\\\",\\\\\\"username\\\\\\":\\\\\\"xxx\\\\\\"}</Content>\\n <Id>1</Id>\\n </Connections>\\n <TotalCount>3</TotalCount>\\n <PageSize>20</PageSize>\\n <PageNumber>1</PageNumber>\\n</Data>\\n<Success>true</Success>","errorExample":""}]',
+ 'title' => 'ListConnections',
+ 'requestParamsDescription' => ' ',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ ],
+ 'GetProjectDetail' => [
+ 'summary' => 'Queries the information about a DataWorks workspace.',
+ 'methods' => [
+ 'post',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => true,
+ 'systemTags' => [
+ 'operationType' => 'get',
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'ProjectId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The DataWorks workspace ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => '27',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'HttpStatusCode' => [
+ 'description' => 'The HTTP status code.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '200',
+ ],
+ 'RequestId' => [
+ 'description' => 'The request ID.'."\n",
+ 'type' => 'string',
+ 'example' => '0bc1411515937635973****',
+ ],
+ 'Success' => [
+ 'description' => 'Indicates whether the request was successful.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'Data' => [
+ 'description' => 'The information about the workspace.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'Status' => [
+ 'description' => 'The status of the workspace.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '0',
+ ],
+ 'ResidentArea' => [
+ 'description' => 'The type of the workspace. Valid values: private and swap.'."\n",
+ 'type' => 'string',
+ 'example' => 'private',
+ ],
+ 'ProjectId' => [
+ 'description' => 'The workspace ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '27',
+ ],
+ 'ProjectIdentifier' => [
+ 'description' => 'The unique identifier of the workspace.'."\n",
+ 'type' => 'string',
+ 'example' => 'abc',
+ ],
+ 'ProjectName' => [
+ 'description' => 'The display name of the workspace.'."\n",
+ 'type' => 'string',
+ 'example' => 'abc',
+ ],
+ 'IsAllowDownload' => [
+ 'description' => 'Indicates whether the download operation is allowed.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '1',
+ ],
+ 'ProjectMode' => [
+ 'description' => 'The mode of the workspace. The value 2 indicates that the workspace is in basic mode. The value 3 indicates that the workspace is in standard mode.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '1',
+ ],
+ 'ProjectDescription' => [
+ 'description' => 'The description of the workspace.'."\n",
+ 'type' => 'string',
+ 'example' => 'abc',
+ ],
+ 'GmtModified' => [
+ 'description' => 'The time when the workspace was last modified.'."\n",
+ 'type' => 'string',
+ 'example' => 'Dec 3, 2019 9:12:20 PM',
+ ],
+ 'ProjectOwnerBaseId' => [
+ 'description' => 'The ID of the Alibaba Cloud account used by the workspace owner.'."\n",
+ 'type' => 'string',
+ 'example' => '18229311****',
+ ],
+ 'DevelopmentType' => [
+ 'description' => 'The development type of the workspace. The value is fixed to 4.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '4',
+ ],
+ 'DefaultDiResourceGroupIdentifier' => [
+ 'description' => 'The identifier of the shared resource group for Data Integration on which nodes are run.'."\n",
+ 'type' => 'string',
+ 'example' => 'group_280749521****',
+ ],
+ 'GmtCreate' => [
+ 'description' => 'The time when the workspace was created.'."\n",
+ 'type' => 'string',
+ 'example' => 'Oct 10, 2019 3:42:53 PM',
+ ],
+ 'SchedulerMaxRetryTimes' => [
+ 'description' => 'The default maximum number of automatic reruns that are allowed after an error occurs.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '3',
+ ],
+ 'ProtectedMode' => [
+ 'description' => 'Indicates whether the workspace protection feature is enabled.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '1',
+ ],
+ 'TenantId' => [
+ 'description' => 'The tenant ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '280749521950784',
+ ],
+ 'SchedulerRetryInterval' => [
+ 'description' => 'The interval between automatic reruns after an error occurs.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '120000',
+ ],
+ 'EnvTypes' => [
+ 'description' => 'The environments of workspaces in different modes. Workspaces in basic mode provide only the production environment. Workspaces in standard mode provide both the development environment and the production environment.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The environment of the workspace in a different mode. Workspaces in basic mode provide only the production environment. Workspaces in standard mode provide both the development environment and the production environment.'."\n",
+ 'type' => 'string',
+ 'example' => '["PROD"]',
+ ],
+ ],
+ 'ResourceManagerResourceGroupId' => [
+ 'description' => 'The resource group ID.'."\n",
+ 'type' => 'string',
+ 'example' => 'rg-acfmzbn7pti3zfa',
+ ],
+ 'Tags' => [
+ 'description' => 'The tag information.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '',
+ 'type' => 'object',
+ 'properties' => [
+ 'Key' => [
+ 'description' => 'The tag key.'."\n",
+ 'type' => 'string',
+ 'example' => 'Env',
+ ],
+ 'Value' => [
+ 'description' => 'The tag value.'."\n",
+ 'type' => 'string',
+ 'example' => 'Test',
+ ],
+ ],
+ ],
+ ],
+ 'DisableDevelopment' => [
+ 'description' => 'Indicates whether the Develop role is disabled. Valid values:'."\n"
+ ."\n"
+ .'* **false** (default)'."\n"
+ .'* **true**'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'UseProxyOdpsAccount' => [
+ 'description' => 'Indicates whether a proxy account is used to access the MaxCompute compute engine.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'TablePrivacyMode' => [
+ 'description' => 'Indicates whether the MaxCompute tables in the workspace are visible to the users within a tenant. Valid values:'."\n"
+ ."\n"
+ .'* 0: The MaxCompute tables in the workspace are not visible to the users within a tenant.'."\n"
+ .'* 1: The MaxCompute tables in the workspace are visible to the users within a tenant.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '1',
+ ],
+ 'IsDefault' => [
+ 'description' => 'Indicates whether the workspace is a default workspace. Valid values:'."\n"
+ ."\n"
+ .'* 1: The workspace is a default workspace.'."\n"
+ .'* 0: The workspace is not a default workspace.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '1',
+ ],
+ ],
+ ],
+ ],
+ 'description' => '',
+ ],
+ ],
+ ],
+ 'errorCodes' => [
+ 400 => [
+ [
+ 'errorCode' => 'Invalid.Tenant.ConnectionNotExists',
+ 'errorMessage' => 'The connection does not exist.',
+ ],
+ [
+ 'errorCode' => 'Invalid.Tenant.ProjectNotExists',
+ 'errorMessage' => 'The project does not exist.',
+ ],
+ [
+ 'errorCode' => 'Invalid.Tenant.UserNotInProject',
+ 'errorMessage' => 'The user is not in the project.',
+ ],
+ ],
+ 403 => [
+ [
+ 'errorCode' => 'Invalid.Tenant.UserIsNotProjectOwnerOrAdmin',
+ 'errorMessage' => 'The user is not a project administrator or owner.',
+ ],
+ [
+ 'errorCode' => 'Invalid.Tenant.UserNotInTenant',
+ 'errorMessage' => 'The user is not in tenant.',
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"0bc1411515937635973****\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"Status\\": 0,\\n \\"ResidentArea\\": \\"private\\",\\n \\"ProjectId\\": 27,\\n \\"ProjectIdentifier\\": \\"abc\\",\\n \\"ProjectName\\": \\"abc\\",\\n \\"IsAllowDownload\\": 1,\\n \\"ProjectMode\\": 1,\\n \\"ProjectDescription\\": \\"abc\\",\\n \\"GmtModified\\": \\"Dec 3, 2019 9:12:20 PM\\",\\n \\"ProjectOwnerBaseId\\": \\"18229311****\\",\\n \\"DevelopmentType\\": 4,\\n \\"DefaultDiResourceGroupIdentifier\\": \\"group_280749521****\\",\\n \\"GmtCreate\\": \\"Oct 10, 2019 3:42:53 PM\\",\\n \\"SchedulerMaxRetryTimes\\": 3,\\n \\"ProtectedMode\\": 1,\\n \\"TenantId\\": 280749521950784,\\n \\"SchedulerRetryInterval\\": 120000,\\n \\"EnvTypes\\": [\\n \\"[\\\\\\"PROD\\\\\\"]\\"\\n ],\\n \\"ResourceManagerResourceGroupId\\": \\"rg-acfmzbn7pti3zfa\\",\\n \\"Tags\\": [\\n {\\n \\"Key\\": \\"Env\\",\\n \\"Value\\": \\"Test\\"\\n }\\n ],\\n \\"DisableDevelopment\\": true,\\n \\"UseProxyOdpsAccount\\": true,\\n \\"TablePrivacyMode\\": 1,\\n \\"IsDefault\\": 1\\n }\\n}","errorExample":""},{"type":"xml","example":"<data>\\n <appkey/>\\n <baseProject>false</baseProject>\\n <defaultDiResourceGroupIdentifier>group_280749521****</defaultDiResourceGroupIdentifier>\\n <destination>28</destination>\\n <devStorageQuota>64</devStorageQuota>\\n <developmentType>4</developmentType>\\n <disableDevelopment>false</disableDevelopment>\\n <envTypes>PROD</envTypes>\\n <gmtCreate>Oct 10, 2019 3:42:53 PM</gmtCreate>\\n <gmtModified>Dec 3, 2019 9:12:20 PM</gmtModified>\\n <isAllowDownload>1</isAllowDownload>\\n <isDefault>0</isDefault>\\n <maxFlowNode>30</maxFlowNode>\\n <prodStorageQuota>64</prodStorageQuota>\\n <projectId>27</projectId>\\n <projectIdentifier>abc</projectIdentifier>\\n <projectMode>2</projectMode>\\n <projectName>abc</projectName>\\n <projectOwnerBaseId>18229311****</projectOwnerBaseId>\\n <protectedMode>1</protectedMode>\\n <residentArea>private</residentArea>\\n <schedulerMaxRetryTimes>3</schedulerMaxRetryTimes>\\n <schedulerRetryInterval>120000</schedulerRetryInterval>\\n <status>0</status>\\n <tablePrivacyMode>0</tablePrivacyMode>\\n <tenantId>280749521950784</tenantId>\\n <useProxyOdpsAccount>false</useProxyOdpsAccount>\\n</data>\\n<httpStatusCode>200</httpStatusCode>\\n<requestId>0bc1ec9b15973****</requestId>\\n<success>true</success>","errorExample":""}]',
+ 'title' => 'GetProjectDetail',
+ 'requestParamsDescription' => ' ',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ ],
+ 'ListNodeIO' => [
+ 'methods' => [
+ 'post',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => true,
+ 'systemTags' => [
+ 'operationType' => 'get',
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'NodeId',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The node ID. You can call the [ListNodes](~~173979~~) operation to query the ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => true,
+ 'docRequired' => true,
+ 'minimum' => '2',
+ 'example' => '1234',
+ 'isFileTransferUrl' => false,
+ ],
+ ],
+ [
+ 'name' => 'ProjectEnv',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The runtime environment. Valid values: DEV and PROD.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'PROD',
+ 'isFileTransferUrl' => false,
+ 'enum' => [
+ 'PROD',
+ 'DEV',
+ ],
+ ],
+ ],
+ [
+ 'name' => 'IoType',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'Specifies whether to query the information about ancestor or descendant nodes of the current node. Valid values: input and output.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'output',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'HttpStatusCode' => [
+ 'description' => 'The HTTP status code.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '200',
+ ],
+ 'RequestId' => [
+ 'description' => 'The request ID.'."\n",
+ 'type' => 'string',
+ 'example' => 'E6F0DBDD-5AD****',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message.'."\n",
+ 'type' => 'string',
+ 'example' => 'The project does not exist.',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code.'."\n",
+ 'type' => 'string',
+ 'example' => 'Invalid.Tenant.ProjectNotExists',
+ ],
+ 'Success' => [
+ 'description' => 'Indicates whether the request was successful.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'Data' => [
+ 'description' => 'The node information.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'TableName' => [
+ 'description' => 'The name of the input or output table.'."\n",
+ 'type' => 'string',
+ 'example' => 'dataworks_a.datastudio_tenant_waitres_alarm',
+ ],
+ 'Data' => [
+ 'description' => 'The name of the ancestor or descendant node.'."\n",
+ 'type' => 'string',
+ 'example' => 'dataworks_a.1234_out',
+ ],
+ 'NodeId' => [
+ 'description' => 'The node ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '123123',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'description' => '',
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"E6F0DBDD-5AD****\\",\\n \\"ErrorMessage\\": \\"The project does not exist.\\",\\n \\"ErrorCode\\": \\"Invalid.Tenant.ProjectNotExists\\",\\n \\"Success\\": true,\\n \\"Data\\": [\\n {\\n \\"TableName\\": \\"dataworks_a.datastudio_tenant_waitres_alarm\\",\\n \\"Data\\": \\"dataworks_a.1234_out\\",\\n \\"NodeId\\": 123123\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<RequestId>E6F0DBDD-5AD****</RequestId>\\n<HttpStatusCode>200</HttpStatusCode>\\n<Data>\\n <NodeId>123123</NodeId>\\n <TableName>dataworks_a.datastudio_tenant_waitres_alarm</TableName>\\n <Data>dataworks_a.1234_out</Data>\\n</Data>\\n<ErrorCode>Invalid.Tenant.ProjectNotExists</ErrorCode>\\n<ErrorMessage>The project does not exist.</ErrorMessage>\\n<Success>true</Success>","errorExample":""}]',
+ 'title' => 'ListNodeIO',
+ 'summary' => 'Queries the information about one level of ancestor or descendant nodes of a node.',
+ 'requestParamsDescription' => ' ',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ ],
+ 'GetInstanceStatusCount' => [
+ 'methods' => [
+ 'post',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => true,
+ 'systemTags' => [
+ 'operationType' => 'get',
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'ProjectId',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The workspace ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => true,
+ 'docRequired' => true,
+ 'maximum' => '9223372036854775807',
+ 'minimum' => '1',
+ 'example' => '1234',
+ 'isFileTransferUrl' => false,
+ ],
+ ],
+ [
+ 'name' => 'ProjectEnv',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The runtime environment. Valid values: PROD and DEV.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'PROD',
+ 'isFileTransferUrl' => false,
+ 'enum' => [
+ 'PROD',
+ 'DEV',
+ ],
+ ],
+ ],
+ [
+ 'name' => 'BizDate',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The data timestamp of instances.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => '2020-01-01',
+ 'isFileTransferUrl' => false,
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'description' => 'The request ID.'."\n",
+ 'type' => 'string',
+ 'example' => '0000-ABCD-EFG****',
+ ],
+ 'StatusCount' => [
+ 'description' => 'The statistics of instances.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'FailureCount' => [
+ 'description' => 'The number of instances that failed.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '1',
+ ],
+ 'WaitTimeCount' => [
+ 'description' => 'The number of instances that are waiting for their scheduling time to arrive.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '1',
+ ],
+ 'RunningCount' => [
+ 'description' => 'The number of instances that are running.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '1',
+ ],
+ 'SuccessCount' => [
+ 'description' => 'The number of instances that are successfully run.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '1',
+ ],
+ 'TotalCount' => [
+ 'description' => 'The total number of instances returned.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '1',
+ ],
+ 'NotRunCount' => [
+ 'description' => 'The number of instances that are not run.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '1',
+ ],
+ 'WaitResCount' => [
+ 'description' => 'The number of instances that are waiting for resources.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '1',
+ ],
+ ],
+ ],
+ ],
+ 'description' => '',
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"0000-ABCD-EFG****\\",\\n \\"StatusCount\\": {\\n \\"FailureCount\\": 1,\\n \\"WaitTimeCount\\": 1,\\n \\"RunningCount\\": 1,\\n \\"SuccessCount\\": 1,\\n \\"TotalCount\\": 1,\\n \\"NotRunCount\\": 1,\\n \\"WaitResCount\\": 1\\n }\\n}","errorExample":""},{"type":"xml","example":"<StatusCount>\\n <TotalCount>1</TotalCount>\\n <RunningCount>1</RunningCount>\\n <FailureCount>1</FailureCount>\\n <WaitResCount>1</WaitResCount>\\n <NotRunCount>1</NotRunCount>\\n <SuccessCount>1</SuccessCount>\\n <WaitTimeCount>1</WaitTimeCount>\\n</StatusCount>\\n<RequestId>0000-ABCD-EFG****</RequestId>","errorExample":""}]',
+ 'title' => 'GetInstanceStatusCount',
+ 'summary' => 'Queries the statistics of instances in different states.',
+ 'requestParamsDescription' => ' ',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ ],
+ 'ListProgramTypeCount' => [
+ 'methods' => [
+ 'post',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => true,
+ 'systemTags' => [
+ 'operationType' => 'get',
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'ProjectId',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The workspace ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => true,
+ 'docRequired' => true,
+ 'maximum' => '9223372036854775807',
+ 'minimum' => '1',
+ 'example' => '1234',
+ 'isFileTransferUrl' => false,
+ ],
+ ],
+ [
+ 'name' => 'ProjectEnv',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The environment of the workspace. Valid values: PROD and DEV.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'PROD',
+ 'isFileTransferUrl' => false,
+ 'enum' => [
+ 'PROD',
+ 'DEV',
+ ],
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'description' => 'The request ID.'."\n",
+ 'type' => 'string',
+ 'example' => 'E6F0DBDD-5AD****',
+ ],
+ 'ProgramTypeAndCounts' => [
+ 'description' => 'The list of node types and quantity.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'Count' => [
+ 'description' => 'The number of nodes.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '3',
+ ],
+ 'ProgramType' => [
+ 'description' => 'The node type.'."\n",
+ 'type' => 'string',
+ 'example' => 'ODPS_SQL',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'description' => '',
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"E6F0DBDD-5AD****\\",\\n \\"ProgramTypeAndCounts\\": [\\n {\\n \\"Count\\": 3,\\n \\"ProgramType\\": \\"ODPS_SQL\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<RequestId>E6F0DBDD-5AD****</RequestId>\\n<ProgramTypeAndCounts>\\n <ProgramType>ODPS_SQL</ProgramType>\\n <Count>3</Count>\\n</ProgramTypeAndCounts>","errorExample":""}]',
+ 'title' => 'ListProgramTypeCount',
+ 'summary' => 'Queries the distribution of different types of nodes.',
+ 'requestParamsDescription' => ' ',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ ],
+ 'GetManualDagInstances' => [
+ 'methods' => [
+ 'post',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => true,
+ 'systemTags' => [
+ 'operationType' => 'get',
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'ProjectEnv',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The environment of Operation Center. Valid values: PROD and DEV.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'RPOD',
+ 'enum' => [
+ 'PROD',
+ 'DEV',
+ ],
+ ],
+ ],
+ [
+ 'name' => 'ProjectName',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The name of the workspace to which the manually triggered workflow belongs. You can log on to the DataWorks console and go to the Workspace Settings panel to query the name.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'test_workspace',
+ ],
+ ],
+ [
+ 'name' => 'DagId',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The ID of the directed acyclic graph (DAG) for the manually triggered workflow. You can call the [CreateManualDag](~~189728~~) operation to query the ID.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => '7000001231241',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'description' => 'The response parameters.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'description' => 'The request ID.'."\n",
+ 'type' => 'string',
+ 'example' => 'SDFSDFSDF-SDFSDF-SDFDSF-SDFSDF',
+ ],
+ 'Instances' => [
+ 'description' => 'The instances in the manually triggered workflow.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '',
+ 'type' => 'object',
+ 'properties' => [
+ 'Status' => [
+ 'description' => 'The status of the instance. Valid values:'."\n"
+ ."\n"
+ .'* NOT_RUN: The instance is not run.'."\n"
+ .'* WAIT_TIME: The instance is waiting for its scheduling time to arrive.'."\n"
+ .'* WAIT_RESOURCE: The instance is waiting for resources.'."\n"
+ .'* RUNNING: The instance is running.'."\n"
+ .'* CHECKING: Data quality is being checked for the instance.'."\n"
+ .'* CHECKING_CONDITION: Branch conditions are being checked for the instance.'."\n"
+ .'* FAILURE: The instance fails to be run.'."\n"
+ .'* SUCCESS: The instance is successfully run.'."\n",
+ 'type' => 'string',
+ 'example' => 'WAIT_TIME',
+ ],
+ 'BeginRunningTime' => [
+ 'description' => 'The time when the instance started to run.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '1605178414676',
+ ],
+ 'BizDate' => [
+ 'description' => 'The data timestamp of the instance. In most cases, the value is one day before the time when the instance was run.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '1605178414676',
+ ],
+ 'CycTime' => [
+ 'description' => 'The time when the instance was scheduled to run.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '1605178414676',
+ ],
+ 'FinishTime' => [
+ 'description' => 'The time when the instance finished running.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '1605178414676',
+ ],
+ 'CreateTime' => [
+ 'description' => 'The time when the instance was generated.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '1605178414676',
+ ],
+ 'DagId' => [
+ 'description' => 'The ID of the DAG for the manually triggered workflow.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '350850491',
+ ],
+ 'InstanceId' => [
+ 'description' => 'The ID of the instance in the manually triggered workflow.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '11726873619',
+ ],
+ 'BeginWaitResTime' => [
+ 'description' => 'The time when the instance started to wait for resources.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '1605178414676',
+ ],
+ 'TaskType' => [
+ 'description' => 'The scheduling type of the node that generates the instance. Valid values:'."\n"
+ ."\n"
+ .'* NORMAL(0): The node is an auto triggered node. The scheduling system regularly runs the node.'."\n"
+ .'* MANUAL(1): The node is a manually triggered node. The scheduling system does not regularly run the node.'."\n"
+ .'* PAUSE(2): The node is a paused node. The scheduling system regularly runs the node but sets the status of the node to failed when the scheduling system starts to run the node.'."\n"
+ .'* SKIP(3): The node is a dry-run node. The scheduling system regularly runs the node but sets the status of the node to successful when the scheduling system starts to run the node.'."\n"
+ .'* SKIP_UNCHOOSE(4): The node is an unselected node in a temporary workflow. This type of node exists only in temporary workflows. The scheduling system sets the status of the node to successful when the scheduling system starts to run the node.'."\n"
+ .'* SKIP_CYCLE(5): The node is a node that is scheduled by week or month and is waiting for the scheduling time to arrive. The scheduling system regularly runs the node but sets the status of the node to successful when the scheduling system starts to run the node.'."\n"
+ .'* CONDITION_UNCHOOSE(6): The node is not selected by its ancestor branch node and is run as a dry-run node.'."\n"
+ .'* REALTIME_DEPRECATED(7): The node has instances that are generated in real time but deprecated. The scheduling system sets the status of the node to successful.'."\n",
+ 'type' => 'string',
+ 'example' => 'NORMAL(0)',
+ ],
+ 'ParamValues' => [
+ 'description' => 'The parameters related to the instance.'."\n",
+ 'type' => 'string',
+ 'example' => 'xxx',
+ ],
+ 'DagType' => [
+ 'description' => 'The type of the manually triggered workflow.'."\n",
+ 'type' => 'string',
+ 'example' => '5',
+ ],
+ 'NodeName' => [
+ 'description' => 'The name of the node.'."\n",
+ 'type' => 'string',
+ 'example' => 'test2',
+ ],
+ 'BeginWaitTimeTime' => [
+ 'description' => 'The time when the instance started to wait to be scheduled.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '1605178414676',
+ ],
+ 'NodeId' => [
+ 'description' => 'The ID of the node in the manually triggered workflow.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '37851',
+ ],
+ 'ModifyTime' => [
+ 'description' => 'The time when the instance was last modified.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '1605178414676',
+ ],
+ 'CreateUser' => [
+ 'description' => 'The user who performed the operation.'."\n",
+ 'type' => 'string',
+ 'example' => 'xxx',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"SDFSDFSDF-SDFSDF-SDFDSF-SDFSDF\\",\\n \\"Instances\\": [\\n {\\n \\"Status\\": \\"WAIT_TIME\\",\\n \\"BeginRunningTime\\": 1605178414676,\\n \\"BizDate\\": 1605178414676,\\n \\"CycTime\\": 1605178414676,\\n \\"FinishTime\\": 1605178414676,\\n \\"CreateTime\\": 1605178414676,\\n \\"DagId\\": 350850491,\\n \\"InstanceId\\": 11726873619,\\n \\"BeginWaitResTime\\": 1605178414676,\\n \\"TaskType\\": \\"NORMAL(0)\\",\\n \\"ParamValues\\": \\"xxx\\",\\n \\"DagType\\": \\"5\\",\\n \\"NodeName\\": \\"test2\\",\\n \\"BeginWaitTimeTime\\": 1605178414676,\\n \\"NodeId\\": 37851,\\n \\"ModifyTime\\": 1605178414676,\\n \\"CreateUser\\": \\"xxx\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<GetManualDagInstancesResponse>\\n <RequestId>SDFSDFSDF-SDFSDF-SDFDSF-SDFSDF</RequestId>\\n <Instances>\\n <Status>WAIT_TIME</Status>\\n <BeginRunningTime>1605178414676</BeginRunningTime>\\n <BizDate>1605178414676</BizDate>\\n <CycTime>1605178414676</CycTime>\\n <FinishTime>1605178414676</FinishTime>\\n <CreateTime>1605178414676</CreateTime>\\n <DagId>350850491</DagId>\\n <InstanceId>11726873619</InstanceId>\\n <BeginWaitResTime>1605178414676</BeginWaitResTime>\\n <TaskType>NORMAL(0)</TaskType>\\n <ParamValues>xxx</ParamValues>\\n <DagType>5</DagType>\\n <NodeName>test2</NodeName>\\n <BeginWaitTimeTime>1605178414676</BeginWaitTimeTime>\\n <NodeId>37851</NodeId>\\n <ModifyTime>1605178414676</ModifyTime>\\n <CreateUser>xxx</CreateUser>\\n </Instances>\\n</GetManualDagInstancesResponse>","errorExample":""}]',
+ 'title' => 'GetManualDagInstances',
+ 'summary' => 'Queries the information about instances in a manually triggered workflow.',
+ 'requestParamsDescription' => ' ',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ ],
+ 'SearchNodesByOutput' => [
+ 'methods' => [
+ 'post',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => true,
+ 'systemTags' => [
+ 'operationType' => 'get',
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'ProjectEnv',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The environment of Operation Center. Valid values: PROD and DEV.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'PROD',
+ 'enum' => [
+ 'PROD',
+ 'DEV',
+ ],
+ ],
+ ],
+ [
+ 'name' => 'Outputs',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The output names of the node. If you specify multiple output names, separate them with commas (,).'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'aaaaa.1231412_out,bbbb.12313123_out',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'HttpStatusCode' => [
+ 'description' => 'The HTTP status code.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '200',
+ ],
+ 'Data' => [
+ 'description' => 'The map returned. The key in the map indicates an output name, and the value in the map indicates the information about the node that generates the output.'."\n",
+ 'type' => 'object',
+ 'example' => '{ "test_0709_1.630003558_out": { "nodeId": 21673, "nodeName": "hour_sql", "ownerId": 123123123124, "cronExpress": "00 00 00-23/2 * * ?", "repeatability": true, "programType": "ODPS_SQL", "projectId": 11111, "schedulerType": "NORMAL", "priority": 1, "baselineId": 20001721, "connection": "odps_first" }, "test_0709_1.630003556_out": { "nodeId": 21671, "nodeName": "start", "ownerId": 123141231231, "cronExpress": "00 */10 00-23 * * ?", "repeatability": true, "programType": "VIRTUAL", "projectId": 1111, "schedulerType": "NORMAL", "priority": 1, "baselineId": 20001721 } }',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message.'."\n",
+ 'type' => 'string',
+ 'example' => 'The connection does not exist.',
+ ],
+ 'RequestId' => [
+ 'description' => 'The request ID.'."\n",
+ 'type' => 'string',
+ 'example' => 'SDFSDFSDF-asdfDFSDF-SDFSDf-SDfSFD',
+ ],
+ 'Success' => [
+ 'description' => 'Indicates whether the request was successful.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code.'."\n",
+ 'type' => 'string',
+ 'example' => 'Invalid.Tenant.ConnectionNotExists',
+ ],
+ ],
+ 'description' => '',
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Data\\": {\\n \\"test_0709_1.630003558_out\\": {\\n \\"nodeId\\": 21673,\\n \\"nodeName\\": \\"hour_sql\\",\\n \\"ownerId\\": 123123123124,\\n \\"cronExpress\\": \\"00 00 00-23/2 * * ?\\",\\n \\"repeatability\\": true,\\n \\"programType\\": \\"ODPS_SQL\\",\\n \\"projectId\\": 11111,\\n \\"schedulerType\\": \\"NORMAL\\",\\n \\"priority\\": 1,\\n \\"baselineId\\": 20001721,\\n \\"connection\\": \\"odps_first\\"\\n },\\n \\"test_0709_1.630003556_out\\": {\\n \\"nodeId\\": 21671,\\n \\"nodeName\\": \\"start\\",\\n \\"ownerId\\": 123141231231,\\n \\"cronExpress\\": \\"00 */10 00-23 * * ?\\",\\n \\"repeatability\\": true,\\n \\"programType\\": \\"VIRTUAL\\",\\n \\"projectId\\": 1111,\\n \\"schedulerType\\": \\"NORMAL\\",\\n \\"priority\\": 1,\\n \\"baselineId\\": 20001721\\n }\\n },\\n \\"ErrorMessage\\": \\"The connection does not exist.\\",\\n \\"RequestId\\": \\"SDFSDFSDF-asdfDFSDF-SDFSDf-SDfSFD\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"Invalid.Tenant.ConnectionNotExists\\"\\n}","errorExample":""},{"type":"xml","example":"<success>true</success>\\n<httpStatusCode>200</httpStatusCode>\\n<data>\\n <test_0709_1.630003558_out>\\n <nodeId>21673</nodeId>\\n <nodeName>hour_sql</nodeName>\\n <ownerId>123123123124</ownerId>\\n <cronExpress>00 00 00-23/2 * * ?</cronExpress>\\n <repeatability>true</repeatability>\\n <programType>ODPS_SQL</programType>\\n <projectId>11111</projectId>\\n <schedulerType>NORMAL</schedulerType>\\n <priority>1</priority>\\n <baselineId>20001721</baselineId>\\n <connection>odps_first</connection>\\n </test_0709_1.630003558_out>\\n <test_0709_1.630003556_out>\\n <nodeId>21671</nodeId>\\n <nodeName>start</nodeName>\\n <ownerId>123141231231</ownerId>\\n <cronExpress>00 */10 00-23 * * ?</cronExpress>\\n <repeatability>true</repeatability>\\n <programType>VIRTUAL</programType>\\n <projectId>1111</projectId>\\n <schedulerType>NORMAL</schedulerType>\\n <priority>1</priority>\\n <baselineId>20001721</baselineId>\\n </test_0709_1.630003556_out>\\n</data>","errorExample":""}]',
+ 'title' => 'SearchNodesByOutput',
+ 'summary' => 'Queries a node based on the output.',
+ 'requestParamsDescription' => ' ',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ ],
+ 'GetNodeTypeListInfo' => [
+ 'methods' => [
+ 'post',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => true,
+ 'systemTags' => [
+ 'operationType' => 'get',
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'ProjectId',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The DataWorks workspace ID. You can click the Workspace Manage icon in the upper-right corner of the DataStudio page to go to the Workspace page and query the ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'docRequired' => true,
+ 'example' => '10000',
+ ],
+ ],
+ [
+ 'name' => 'ProjectIdentifier',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The unique identifier of the DataWorks workspace. You can view the identifier in the upper part of the DataStudio page. You can also select another identifier to switch to another workspace. You must configure either this parameter or the ProjectId parameter to determine the DataWorks workspace to which the operation is applied.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'dw_project',
+ ],
+ ],
+ [
+ 'name' => 'PageNumber',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The page number.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => true,
+ 'docRequired' => true,
+ 'maximum' => '100',
+ 'minimum' => '1',
+ 'example' => '1',
+ ],
+ ],
+ [
+ 'name' => 'PageSize',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The number of entries per page. Maximum value: 100.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => true,
+ 'docRequired' => true,
+ 'maximum' => '100',
+ 'minimum' => '0',
+ 'example' => '50',
+ ],
+ ],
+ [
+ 'name' => 'Keyword',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The name of the node type. You can log on to the DataWorks console, go to the DataStudio page, and then view the name of a specific node type on the left side of the page. You can view the English or Chinese name of a specific node type, but the language specified to present the name must be the same as the language specified by the Locale parameter. Fuzzy match is supported. If this parameter is not configured, the names of all node types are returned.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'ODPS SQ',
+ ],
+ ],
+ [
+ 'name' => 'Locale',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The language that you use for the query. Valid values: zh-CN and en-US.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'zh-CN',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'description' => 'The request ID.'."\n",
+ 'type' => 'string',
+ 'example' => '0000-ABCD-EFG****',
+ ],
+ 'NodeTypeInfoList' => [
+ 'description' => 'The list of node types.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'PageNumber' => [
+ 'description' => 'The page number.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '1',
+ ],
+ 'PageSize' => [
+ 'description' => 'The number of entries per page.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '50',
+ ],
+ 'TotalCount' => [
+ 'description' => 'The total number of entries returned.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '127',
+ ],
+ 'NodeTypeInfo' => [
+ 'description' => 'The information about a node type.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'NodeTypeName' => [
+ 'description' => 'The name of the node type.'."\n",
+ 'type' => 'string',
+ 'example' => 'ODPS SQL',
+ ],
+ 'NodeType' => [
+ 'description' => 'The type of the node, which is specified by a number.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '10',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'description' => '',
+ ],
+ ],
+ ],
+ 'errorCodes' => [
+ 403 => [
+ [
+ 'errorCode' => 'Forbidden.Access',
+ 'errorMessage' => 'Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.',
+ ],
+ ],
+ 429 => [
+ [
+ 'errorCode' => 'Throttling.Api',
+ 'errorMessage' => 'The request for this resource has exceeded your available limit.',
+ ],
+ [
+ 'errorCode' => 'Throttling.System',
+ 'errorMessage' => 'The DataWorks system is busy. Try again later.',
+ ],
+ [
+ 'errorCode' => 'Throttling.User',
+ 'errorMessage' => 'Your request is too frequent. Try again later.',
+ ],
+ ],
+ 500 => [
+ [
+ 'errorCode' => 'InternalError.System',
+ 'errorMessage' => 'An internal system error occurred. Try again later.',
+ ],
+ [
+ 'errorCode' => 'InternalError.UserId.Missing',
+ 'errorMessage' => 'An internal system error occurred. Try again later.',
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"0000-ABCD-EFG****\\",\\n \\"NodeTypeInfoList\\": {\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 50,\\n \\"TotalCount\\": 127,\\n \\"NodeTypeInfo\\": [\\n {\\n \\"NodeTypeName\\": \\"ODPS SQL\\",\\n \\"NodeType\\": 10\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<RequestId>0000-ABCD-EFG****</RequestId>\\n<NodeTypeInfoList>\\n <TotalCount>127</TotalCount>\\n <PageSize>50</PageSize>\\n <PageNumber>1</PageNumber>\\n <NodeTypeInfo>\\n <NodeTypeName>ODPS SQL</NodeTypeName>\\n <NodeType>10</NodeType>\\n </NodeTypeInfo>\\n</NodeTypeInfoList>","errorExample":""}]',
+ 'title' => 'GetNodeTypeListInfo',
+ 'summary' => 'Queries the information about node types, including the code and name of a node type.',
+ 'requestParamsDescription' => ' ',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ ],
+ 'GetNodeOnBaseline' => [
+ 'methods' => [
+ 'post',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => true,
+ 'systemTags' => [
+ 'operationType' => 'get',
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'BaselineId',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The baseline ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => '1234',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'HttpStatusCode' => [
+ 'description' => 'The HTTP status code.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '200',
+ ],
+ 'RequestId' => [
+ 'description' => 'The request ID.'."\n",
+ 'type' => 'string',
+ 'example' => '0000-ABCD-E****',
+ ],
+ 'ErrorMessage' => [
+ 'description' => 'The error message.'."\n",
+ 'type' => 'string',
+ 'example' => 'The specified parameters are invalid.',
+ ],
+ 'ErrorCode' => [
+ 'description' => 'The error code.'."\n",
+ 'type' => 'string',
+ 'example' => '1031203110005',
+ ],
+ 'Success' => [
+ 'description' => 'Indicates whether the request was successful.'."\n",
+ 'type' => 'string',
+ 'example' => 'true',
+ ],
+ 'Data' => [
+ 'description' => 'The list of nodes.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'Owner' => [
+ 'description' => 'The ID of the Alibaba Cloud account used by the node owner.'."\n",
+ 'type' => 'string',
+ 'example' => '9527952****',
+ ],
+ 'NodeName' => [
+ 'description' => 'The name of the node.'."\n",
+ 'type' => 'string',
+ 'example' => '',
+ ],
+ 'NodeId' => [
+ 'description' => 'The node ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '1234',
+ ],
+ 'ProjectId' => [
+ 'description' => 'The ID of the workspace to which the node belongs.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '1234',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'description' => '',
+ ],
+ ],
+ ],
+ 'errorCodes' => [
+ 403 => [
+ [
+ 'errorCode' => 'Forbidden.Access',
+ 'errorMessage' => 'Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.',
+ ],
+ ],
+ 429 => [
+ [
+ 'errorCode' => 'Throttling.Api',
+ 'errorMessage' => 'The request for this resource has exceeded your available limit.',
+ ],
+ [
+ 'errorCode' => 'Throttling.Api.Risk',
+ 'errorMessage' => 'The request for this resource has exceeded your daily available limit.',
+ ],
+ [
+ 'errorCode' => 'Throttling.Resource',
+ 'errorMessage' => 'You have reached the limit for the resource. Please contact us by submitting a ticket.',
+ ],
+ [
+ 'errorCode' => 'Throttling.System',
+ 'errorMessage' => 'The DataWorks system is busy. Try again later.',
+ ],
+ [
+ 'errorCode' => 'Throttling.User',
+ 'errorMessage' => 'Your request is too frequent. Try again later.',
+ ],
+ ],
+ 500 => [
+ [
+ 'errorCode' => 'Forbidden.Not.Server',
+ 'errorMessage' => 'The dataworksAPI service is not available in this area. Please try it in another area.',
+ ],
+ [
+ 'errorCode' => 'Forbidden.Wkbench.BaselineNoPermission',
+ 'errorMessage' => 'You are not authorized to access the baseline.',
+ ],
+ [
+ 'errorCode' => 'Forbidden.Wkbench.ProjectNoPermission',
+ 'errorMessage' => 'You are not authorized to access the workspace.',
+ ],
+ [
+ 'errorCode' => 'InternalError.System',
+ 'errorMessage' => 'An internal system error occurred. Try again later.',
+ ],
+ [
+ 'errorCode' => 'InternalError.UserId.Missing',
+ 'errorMessage' => 'An internal system error occurred. Try again later.',
+ ],
+ [
+ 'errorCode' => 'InternalError.Wkbench.ServiceError',
+ 'errorMessage' => 'An internal error occurred.',
+ ],
+ [
+ 'errorCode' => 'Invalid.Wkbench.Parameter',
+ 'errorMessage' => 'The specified parameters are invalid.',
+ ],
+ [
+ 'errorCode' => 'Invalid.Wkbench.BaselineNotExist',
+ 'errorMessage' => 'The baseline does not exist.',
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"0000-ABCD-E****\\",\\n \\"ErrorMessage\\": \\"The specified parameters are invalid.\\",\\n \\"ErrorCode\\": \\"1031203110005\\",\\n \\"Success\\": \\"true\\",\\n \\"Data\\": [\\n {\\n \\"Owner\\": \\"9527952****\\",\\n \\"NodeName\\": \\"节点名称\\",\\n \\"NodeId\\": 1234,\\n \\"ProjectId\\": 1234\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<RequestId>0000-ABCD-E****</RequestId>\\n<HttpStatusCode>200</HttpStatusCode>\\n<Data>\\n <Owner>9527952****</Owner>\\n <NodeName>节点名称</NodeName>\\n <NodeId>1234</NodeId>\\n <ProjectId>1234</ProjectId>\\n</Data>\\n<ErrorCode>1031203110005</ErrorCode>\\n<ErrorMessage>The specified parameters are invalid.</ErrorMessage>\\n<Success>true</Success>","errorExample":""}]',
+ 'title' => 'GetNodeOnBaseline',
+ 'summary' => 'Queries the nodes associated with a baseline.',
+ 'requestParamsDescription' => ' ',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ ],
+ 'GetSuccessInstanceTrend' => [
+ 'methods' => [
+ 'post',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => true,
+ 'systemTags' => [
+ 'operationType' => 'get',
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'ProjectId',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The DataWorks workspace ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => true,
+ 'docRequired' => true,
+ 'maximum' => '99999999999',
+ 'minimum' => '2',
+ 'example' => '9527',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'description' => 'The request ID.'."\n",
+ 'type' => 'string',
+ 'example' => '952795279527ab****',
+ ],
+ 'InstanceStatusTrend' => [
+ 'description' => 'The trend of statistics on the instance status in different time periods.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'TodayTrend' => [
+ 'description' => 'The trend on the current day.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'TimePoint' => [
+ 'description' => 'The point in time. Valid values: 00:00 to 23:00.'."\n",
+ 'type' => 'string',
+ 'example' => '01:00',
+ ],
+ 'Count' => [
+ 'description' => 'The number of instances.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '10',
+ ],
+ ],
+ ],
+ ],
+ 'YesterdayTrend' => [
+ 'description' => 'The trend on the previous day.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'TimePoint' => [
+ 'description' => 'The point in time. Valid values: 00:00 to 23:00.'."\n",
+ 'type' => 'string',
+ 'example' => '01:00',
+ ],
+ 'Count' => [
+ 'description' => 'The number of instances.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '10',
+ ],
+ ],
+ ],
+ ],
+ 'AvgTrend' => [
+ 'description' => 'The average trend.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'TimePoint' => [
+ 'description' => 'The point in time. Valid values: 00:00 to 23:00.'."\n",
+ 'type' => 'string',
+ 'example' => '01:00',
+ ],
+ 'Count' => [
+ 'description' => 'The number of instances.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '10',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'description' => '',
+ ],
+ ],
+ ],
+ 'errorCodes' => [
+ 403 => [
+ [
+ 'errorCode' => 'ResourceNotAuthorized.Api',
+ 'errorMessage' => 'You are not authorized to access the resources.',
+ ],
+ [
+ 'errorCode' => 'Forbidden.Access',
+ 'errorMessage' => 'Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.',
+ ],
+ ],
+ 429 => [
+ [
+ 'errorCode' => 'Throttling.Api',
+ 'errorMessage' => 'The request for this resource has exceeded your available limit.',
+ ],
+ [
+ 'errorCode' => 'Throttling.Api.Risk',
+ 'errorMessage' => 'The request for this resource has exceeded your daily available limit.',
+ ],
+ [
+ 'errorCode' => 'Throttling.Resource',
+ 'errorMessage' => 'You have reached the limit for the resource. Please contact us by submitting a ticket.',
+ ],
+ [
+ 'errorCode' => 'Throttling.System',
+ 'errorMessage' => 'The DataWorks system is busy. Try again later.',
+ ],
+ [
+ 'errorCode' => 'Throttling.User',
+ 'errorMessage' => 'Your request is too frequent. Try again later.',
+ ],
+ ],
+ 500 => [
+ [
+ 'errorCode' => 'Forbidden.Not.Server',
+ 'errorMessage' => 'The dataworksAPI service is not available in this area. Please try it in another area.',
+ ],
+ [
+ 'errorCode' => 'InternalError.System',
+ 'errorMessage' => 'An internal system error occurred. Try again later.',
+ ],
+ [
+ 'errorCode' => 'InternalError.UserId.Missing',
+ 'errorMessage' => 'An internal system error occurred. Try again later.',
+ ],
+ [
+ 'errorCode' => 'Forbidden.Wkbench.ProjectNoPermission',
+ 'errorMessage' => 'You are not authorized to access the workspace.',
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"952795279527ab****\\",\\n \\"InstanceStatusTrend\\": {\\n \\"TodayTrend\\": [\\n {\\n \\"TimePoint\\": \\"01:00\\",\\n \\"Count\\": 10\\n }\\n ],\\n \\"YesterdayTrend\\": [\\n {\\n \\"TimePoint\\": \\"01:00\\",\\n \\"Count\\": 10\\n }\\n ],\\n \\"AvgTrend\\": [\\n {\\n \\"TimePoint\\": \\"01:00\\",\\n \\"Count\\": 10\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<RequestId>952795279527ab****</RequestId>\\n<InstanceStatusTrend>\\n <YesterdayTrend>\\n <TimePoint>01:00</TimePoint>\\n <Count>10</Count>\\n </YesterdayTrend>\\n <YesterdayTrend>\\n <TimePoint>01:00</TimePoint>\\n <Count>10</Count>\\n </YesterdayTrend>\\n <YesterdayTrend>\\n <TimePoint>01:00</TimePoint>\\n <Count>10</Count>\\n </YesterdayTrend>\\n <AvgTrend>\\n <TimePoint>01:00</TimePoint>\\n <Count>10</Count>\\n </AvgTrend>\\n <AvgTrend>\\n <TimePoint>01:00</TimePoint>\\n <Count>10</Count>\\n </AvgTrend>\\n <AvgTrend>\\n <TimePoint>01:00</TimePoint>\\n <Count>10</Count>\\n </AvgTrend>\\n <TodayTrend>\\n <TimePoint>01:00</TimePoint>\\n <Count>10</Count>\\n </TodayTrend>\\n <TodayTrend>\\n <TimePoint>01:00</TimePoint>\\n <Count>10</Count>\\n </TodayTrend>\\n <TodayTrend>\\n <TimePoint>01:00</TimePoint>\\n <Count>10</Count>\\n </TodayTrend>\\n</InstanceStatusTrend>","errorExample":""}]',
+ 'title' => 'GetSuccessInstanceTrend',
+ 'summary' => 'Queries the statistics of instances in different periods of a day.',
+ 'requestParamsDescription' => ' ',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ ],
+ 'GetInstanceCountTrend' => [
+ 'methods' => [
+ 'post',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => true,
+ 'systemTags' => [
+ 'operationType' => 'get',
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'ProjectId',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The DataWorks workspace ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => true,
+ 'docRequired' => true,
+ 'maximum' => '99999999999',
+ 'minimum' => '2',
+ 'example' => '10000',
+ ],
+ ],
+ [
+ 'name' => 'BeginDate',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The beginning of the time range to query, accurate to the day. Specify the time in the ISO 8601 standard in the yyyy-MM-dd\'T\'HH:mm:ssZ format. The time must be in UTC.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => '2020-04-02T00:00:00+0800',
+ ],
+ ],
+ [
+ 'name' => 'EndDate',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The end of the time range to query, accurate to the day. Specify the time in the ISO 8601 standard in the yyyy-MM-dd\'T\'HH:mm:ssZ format. The time must be in UTC.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => '2020-09-10T00:00:00+0800',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'description' => 'The request ID.'."\n",
+ 'type' => 'string',
+ 'example' => '95279527adhfj****',
+ ],
+ 'InstanceCounts' => [
+ 'description' => 'The quantity trend of instances.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'Date' => [
+ 'description' => 'The data timestamp.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '1600963200000',
+ ],
+ 'Count' => [
+ 'description' => 'The number of instances.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '9527',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'description' => '',
+ ],
+ ],
+ ],
+ 'errorCodes' => [
+ 403 => [
+ [
+ 'errorCode' => 'ResourceNotAuthorized.Api',
+ 'errorMessage' => 'You are not authorized to access the resources.',
+ ],
+ [
+ 'errorCode' => 'Forbidden.Access',
+ 'errorMessage' => 'Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.',
+ ],
+ ],
+ 429 => [
+ [
+ 'errorCode' => 'Throttling.Api',
+ 'errorMessage' => 'The request for this resource has exceeded your available limit.',
+ ],
+ [
+ 'errorCode' => 'Throttling.Api.Risk',
+ 'errorMessage' => 'The request for this resource has exceeded your daily available limit.',
+ ],
+ [
+ 'errorCode' => 'Throttling.Resource',
+ 'errorMessage' => 'You have reached the limit for the resource. Please contact us by submitting a ticket.',
+ ],
+ [
+ 'errorCode' => 'Throttling.System',
+ 'errorMessage' => 'The DataWorks system is busy. Try again later.',
+ ],
+ [
+ 'errorCode' => 'Throttling.User',
+ 'errorMessage' => 'Your request is too frequent. Try again later.',
+ ],
+ ],
+ 500 => [
+ [
+ 'errorCode' => 'Forbidden.Not.Server',
+ 'errorMessage' => 'The dataworksAPI service is not available in this area. Please try it in another area.',
+ ],
+ [
+ 'errorCode' => 'InternalError.System',
+ 'errorMessage' => 'An internal system error occurred. Try again later.',
+ ],
+ [
+ 'errorCode' => 'InternalError.UserId.Missing',
+ 'errorMessage' => 'An internal system error occurred. Try again later.',
+ ],
+ [
+ 'errorCode' => 'Forbidden.Wkbench.NoProject',
+ 'errorMessage' => 'You have not joined any project.',
+ ],
+ [
+ 'errorCode' => 'Invalid.Wkbench.Parameter',
+ 'errorMessage' => 'The specified parameters are invalid.',
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"95279527adhfj****\\",\\n \\"InstanceCounts\\": [\\n {\\n \\"Date\\": 1600963200000,\\n \\"Count\\": 9527\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<RequestId>95279527adhfj****</RequestId>\\n<InstanceCounts>\\n <Count>9527</Count>\\n <Date>1600963200000</Date>\\n</InstanceCounts>","errorExample":""}]',
+ 'title' => 'GetInstanceCountTrend',
+ 'summary' => 'Queries the quantity trend of auto triggered instances.',
+ 'requestParamsDescription' => ' ',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ ],
+ 'GetInstanceConsumeTimeRank' => [
+ 'methods' => [
+ 'post',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => true,
+ 'systemTags' => [
+ 'operationType' => 'get',
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'ProjectId',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The DataWorks workspace ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => true,
+ 'docRequired' => true,
+ 'maximum' => '99999999999',
+ 'minimum' => '2',
+ 'example' => '100000',
+ ],
+ ],
+ [
+ 'name' => 'Bizdate',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The data timestamp, accurate to the day. Specify the time in the ISO 8601 standard in the yyyy-MM-dd\'T\'HH:mm:ssZ format. The time must be in UTC.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => '2020-09-21T00:00:00+0800',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'description' => 'The request ID.'."\n",
+ 'type' => 'string',
+ 'example' => '6347364dadsfadf****',
+ ],
+ 'InstanceConsumeTimeRank' => [
+ 'description' => 'The ranking record of the running durations of instances.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'UpdateTime' => [
+ 'description' => 'The timestamp when the ranking was updated.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '1600963200000',
+ ],
+ 'ConsumeTimeRank' => [
+ 'description' => 'The ranking data of the running durations of instances.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'Owner' => [
+ 'description' => 'The ID of the Alibaba Cloud account used by the node owner.'."\n",
+ 'type' => 'string',
+ 'example' => '952795279527',
+ ],
+ 'NodeName' => [
+ 'description' => 'The name of the node.'."\n",
+ 'type' => 'string',
+ 'example' => '',
+ ],
+ 'Bizdate' => [
+ 'description' => 'The data timestamp of the instance.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '1600963200000',
+ ],
+ 'InstanceId' => [
+ 'description' => 'The instance ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '95279527',
+ ],
+ 'PrgType' => [
+ 'description' => 'The type of the node.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '10',
+ ],
+ 'NodeId' => [
+ 'description' => 'The node ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '9527',
+ ],
+ 'Consumed' => [
+ 'description' => 'The running duration of the instance. Unit: seconds.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '1000',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'description' => '',
+ ],
+ ],
+ ],
+ 'errorCodes' => [
+ 403 => [
+ [
+ 'errorCode' => 'ResourceNotAuthorized.Api',
+ 'errorMessage' => 'You are not authorized to access the resources.',
+ ],
+ [
+ 'errorCode' => 'Forbidden.Access',
+ 'errorMessage' => 'Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.',
+ ],
+ ],
+ 429 => [
+ [
+ 'errorCode' => 'Throttling.Api',
+ 'errorMessage' => 'The request for this resource has exceeded your available limit.',
+ ],
+ [
+ 'errorCode' => 'Throttling.Api.Risk',
+ 'errorMessage' => 'The request for this resource has exceeded your daily available limit.',
+ ],
+ [
+ 'errorCode' => 'Throttling.Resource',
+ 'errorMessage' => 'You have reached the limit for the resource. Please contact us by submitting a ticket.',
+ ],
+ [
+ 'errorCode' => 'Throttling.System',
+ 'errorMessage' => 'The DataWorks system is busy. Try again later.',
+ ],
+ [
+ 'errorCode' => 'Throttling.User',
+ 'errorMessage' => 'Your request is too frequent. Try again later.',
+ ],
+ ],
+ 500 => [
+ [
+ 'errorCode' => 'Forbidden.Not.Server',
+ 'errorMessage' => 'The dataworksAPI service is not available in this area. Please try it in another area.',
+ ],
+ [
+ 'errorCode' => 'InternalError.System',
+ 'errorMessage' => 'An internal system error occurred. Try again later.',
+ ],
+ [
+ 'errorCode' => 'InternalError.UserId.Missing',
+ 'errorMessage' => 'An internal system error occurred. Try again later.',
+ ],
+ [
+ 'errorCode' => 'Forbidden.Wkbench.ProjectNoPermission',
+ 'errorMessage' => 'You are not authorized to access the workspace.',
+ ],
+ [
+ 'errorCode' => 'Invalid.Wkbench.Parameter',
+ 'errorMessage' => 'The specified parameters are invalid.',
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"6347364dadsfadf****\\",\\n \\"InstanceConsumeTimeRank\\": {\\n \\"UpdateTime\\": 1600963200000,\\n \\"ConsumeTimeRank\\": [\\n {\\n \\"Owner\\": \\"952795279527\\",\\n \\"NodeName\\": \\"节点名称\\",\\n \\"Bizdate\\": 1600963200000,\\n \\"InstanceId\\": 95279527,\\n \\"PrgType\\": 10,\\n \\"NodeId\\": 9527,\\n \\"Consumed\\": 1000\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<RequestId>6347364dadsfadf****</RequestId>\\n<InstanceConsumeTimeRank>\\n <ConsumeTimeRank>\\n <PrgType>10</PrgType>\\n <Owner>952795279527</Owner>\\n <NodeName>节点名称</NodeName>\\n <InstanceId>95279527</InstanceId>\\n <NodeId>9527</NodeId>\\n <Consumed>1000</Consumed>\\n <Bizdate>1600963200000</Bizdate>\\n </ConsumeTimeRank>\\n <UpdateTime>1600963200000</UpdateTime>\\n</InstanceConsumeTimeRank>","errorExample":""}]',
+ 'title' => 'GetInstanceConsumeTimeRank',
+ 'summary' => 'Queries the ranking of the running durations of instances.',
+ 'requestParamsDescription' => ' ',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ ],
+ 'GetInstanceErrorRank' => [
+ 'methods' => [
+ 'post',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => true,
+ 'systemTags' => [
+ 'operationType' => 'get',
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'ProjectId',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The DataWorks workspace ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => true,
+ 'docRequired' => true,
+ 'maximum' => '99999999999',
+ 'minimum' => '2',
+ 'example' => '9527',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'description' => 'The request ID.'."\n",
+ 'type' => 'string',
+ 'example' => '952795279527****',
+ ],
+ 'InstanceErrorRank' => [
+ 'description' => 'The ranking data of nodes on which errors occurred.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'UpdateTime' => [
+ 'description' => 'The timestamp at which the rankings were updated.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '1600963200000',
+ ],
+ 'ErrorRank' => [
+ 'description' => 'The ranking data of nodes on which errors occurred within the last month.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'Owner' => [
+ 'description' => 'The ID of the Alibaba Cloud account used by the node owner.'."\n",
+ 'type' => 'string',
+ 'example' => '952795279527',
+ ],
+ 'NodeName' => [
+ 'description' => 'The name of the node.'."\n",
+ 'type' => 'string',
+ 'example' => '',
+ ],
+ 'ProjectId' => [
+ 'description' => 'The DataWorks workspace ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '9527',
+ ],
+ 'NodeId' => [
+ 'description' => 'The node ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '9527',
+ ],
+ 'Count' => [
+ 'description' => 'The number of errors that occurred on the node.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '5',
+ ],
+ 'PrgType' => [
+ 'description' => 'The type of the node.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '10',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'description' => '',
+ ],
+ ],
+ ],
+ 'errorCodes' => [
+ 403 => [
+ [
+ 'errorCode' => 'ResourceNotAuthorized.Api',
+ 'errorMessage' => 'You are not authorized to access the resources.',
+ ],
+ [
+ 'errorCode' => 'Forbidden.Access',
+ 'errorMessage' => 'Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.',
+ ],
+ ],
+ 429 => [
+ [
+ 'errorCode' => 'Throttling.Api',
+ 'errorMessage' => 'The request for this resource has exceeded your available limit.',
+ ],
+ [
+ 'errorCode' => 'Throttling.Api.Risk',
+ 'errorMessage' => 'The request for this resource has exceeded your daily available limit.',
+ ],
+ [
+ 'errorCode' => 'Throttling.Resource',
+ 'errorMessage' => 'You have reached the limit for the resource. Please contact us by submitting a ticket.',
+ ],
+ [
+ 'errorCode' => 'Throttling.System',
+ 'errorMessage' => 'The DataWorks system is busy. Try again later.',
+ ],
+ [
+ 'errorCode' => 'Throttling.User',
+ 'errorMessage' => 'Your request is too frequent. Try again later.',
+ ],
+ ],
+ 500 => [
+ [
+ 'errorCode' => 'Forbidden.Not.Server',
+ 'errorMessage' => 'The dataworksAPI service is not available in this area. Please try it in another area.',
+ ],
+ [
+ 'errorCode' => 'InternalError.System',
+ 'errorMessage' => 'An internal system error occurred. Try again later.',
+ ],
+ [
+ 'errorCode' => 'InternalError.UserId.Missing',
+ 'errorMessage' => 'An internal system error occurred. Try again later.',
+ ],
+ [
+ 'errorCode' => 'Forbidden.Wkbench.ProjectNoPermission',
+ 'errorMessage' => 'You are not authorized to access the workspace.',
+ ],
+ [
+ 'errorCode' => 'Invalid.Wkbench.Parameter',
+ 'errorMessage' => 'The specified parameters are invalid.',
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"952795279527****\\",\\n \\"InstanceErrorRank\\": {\\n \\"UpdateTime\\": 1600963200000,\\n \\"ErrorRank\\": [\\n {\\n \\"Owner\\": \\"952795279527\\",\\n \\"NodeName\\": \\"节点名称\\",\\n \\"ProjectId\\": 9527,\\n \\"NodeId\\": 9527,\\n \\"Count\\": 5,\\n \\"PrgType\\": 10\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<RequestId>952795279527****</RequestId>\\n<InstanceErrorRank>\\n <ErrorRank>\\n <PrgType>10</PrgType>\\n <Owner>952795279527</Owner>\\n <NodeName>节点名称</NodeName>\\n <NodeId>9527</NodeId>\\n <ProjectId>9527</ProjectId>\\n <Count>5</Count>\\n </ErrorRank>\\n <UpdateTime>1600963200000</UpdateTime>\\n</InstanceErrorRank>","errorExample":""}]',
+ 'title' => 'GetInstanceErrorRank',
+ 'summary' => 'Queries the ranking of nodes on which errors occur within the last month.',
+ 'requestParamsDescription' => ' ',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ ],
+ ],
+ 'endpoints' => [
+ [
+ 'regionId' => 'cn-wulanchabu',
+ 'endpoint' => 'dataworks.cn-wulanchabu.aliyuncs.com',
+ ],
+ [
+ 'regionId' => 'cn-beijing',
+ 'endpoint' => 'dataworks.cn-beijing.aliyuncs.com',
+ ],
+ [
+ 'regionId' => 'cn-shanghai',
+ 'endpoint' => 'dataworks.cn-shanghai.aliyuncs.com',
+ ],
+ [
+ 'regionId' => 'cn-hongkong',
+ 'endpoint' => 'dataworks.cn-hongkong.aliyuncs.com',
+ ],
+ [
+ 'regionId' => 'cn-zhangjiakou',
+ 'endpoint' => 'dataworks.cn-zhangjiakou.aliyuncs.com',
+ ],
+ [
+ 'regionId' => 'cn-shenzhen',
+ 'endpoint' => 'dataworks.cn-shenzhen.aliyuncs.com',
+ ],
+ [
+ 'regionId' => 'ap-northeast-1',
+ 'endpoint' => 'dataworks.ap-northeast-1.aliyuncs.com',
+ ],
+ [
+ 'regionId' => 'cn-chengdu',
+ 'endpoint' => 'dataworks.cn-chengdu.aliyuncs.com',
+ ],
+ [
+ 'regionId' => 'ap-southeast-1',
+ 'endpoint' => 'dataworks.ap-southeast-1.aliyuncs.com',
+ ],
+ [
+ 'regionId' => 'ap-southeast-3',
+ 'endpoint' => 'dataworks.ap-southeast-3.aliyuncs.com',
+ ],
+ [
+ 'regionId' => 'ap-southeast-5',
+ 'endpoint' => 'dataworks.ap-southeast-5.aliyuncs.com',
+ ],
+ [
+ 'regionId' => 'cn-hangzhou',
+ 'endpoint' => 'dataworks.cn-hangzhou.aliyuncs.com',
+ ],
+ [
+ 'regionId' => 'us-east-1',
+ 'endpoint' => 'dataworks.us-east-1.aliyuncs.com',
+ ],
+ [
+ 'regionId' => 'eu-west-1',
+ 'endpoint' => 'dataworks.eu-west-1.aliyuncs.com',
+ ],
+ [
+ 'regionId' => 'us-west-1',
+ 'endpoint' => 'dataworks.us-west-1.aliyuncs.com',
+ ],
+ [
+ 'regionId' => 'eu-central-1',
+ 'endpoint' => 'dataworks.eu-central-1.aliyuncs.com',
+ ],
+ [
+ 'regionId' => 'me-east-1',
+ 'endpoint' => 'dataworks.me-east-1.aliyuncs.com',
+ ],
+ [
+ 'regionId' => 'me-central-1',
+ 'endpoint' => 'dataworks.me-central-1.aliyuncs.com',
+ ],
+ [
+ 'regionId' => 'cn-shenzhen-finance-1',
+ 'endpoint' => 'dataworks.cn-shenzhen-finance-1.aliyuncs.com',
+ ],
+ [
+ 'regionId' => 'cn-shanghai-finance-1',
+ 'endpoint' => 'dataworks.cn-shanghai-finance-1.aliyuncs.com',
+ ],
+ [
+ 'regionId' => 'cn-hangzhou-finance',
+ 'endpoint' => 'dataworks.aliyuncs.com',
+ ],
+ [
+ 'regionId' => 'ap-northeast-2',
+ 'endpoint' => 'dataworks.ap-northeast-2.aliyuncs.com',
+ ],
+ ],
+];
generated by cgit v1.2.3 (git 2.46.0) at 2026-03-07 16:25:16 +0000