diff options
| author | Zhineng Li <[email protected]> | 2026-02-13 10:54:11 +0800 |
|---|---|---|
| committer | Zhineng Li <[email protected]> | 2026-02-13 10:54:11 +0800 |
| commit | 7347bac4ab7e136157fc94777e6cf87ef9e08599 (patch) | |
| tree | 0dec367dac6e152161a6f7cc0dba6ebbef1f34a2 /data/zh_cn/dataworks-public | |
| download | acs-metadata-full-1.0.0+20260212.tar.gz acs-metadata-full-1.0.0+20260212.zip | |
first commitHEADv1.0.0+20260212main
Diffstat (limited to 'data/zh_cn/dataworks-public')
| -rw-r--r-- | data/zh_cn/dataworks-public/2018-06-01/api-docs.php | 2785 | ||||
| -rw-r--r-- | data/zh_cn/dataworks-public/2020-05-18/api-docs.php | 66429 | ||||
| -rw-r--r-- | data/zh_cn/dataworks-public/2024-05-18/api-docs.php | 58613 |
3 files changed, 127827 insertions, 0 deletions
diff --git a/data/zh_cn/dataworks-public/2018-06-01/api-docs.php b/data/zh_cn/dataworks-public/2018-06-01/api-docs.php new file mode 100644 index 0000000..3721bb9 --- /dev/null +++ b/data/zh_cn/dataworks-public/2018-06-01/api-docs.php @@ -0,0 +1,2785 @@ +<?php return [ + 'version' => '1.0', + 'info' => [ + 'style' => 'RPC', + 'product' => 'dataworks-public', + 'version' => '2018-06-01', + ], + 'directories' => [ + [ + 'id' => 60061, + 'title' => '流程', + 'type' => 'directory', + 'children' => [ + 'CreateManualDag', + 'DeleteFile', + 'SearchManualDagNodeInstance', + ], + ], + [ + 'id' => 60066, + 'title' => 'HIVE', + 'type' => 'directory', + 'children' => [ + 'DescribeEmrHiveTable', + 'ListEmrHiveAuditLogs', + 'ListEmrHiveDatabases', + 'ListEmrHiveTables', + 'ListHiveTableLineages', + 'ListHiveColumnLineages', + 'ListTablePartitions', + ], + ], + [ + 'id' => 0, + 'title' => '其它', + 'type' => 'directory', + 'children' => [ + 'OpenDataWorksStandardService', + 'SendTaskMetaCallback', + 'SetSwitchValue', + 'GetDataServiceApiContext', + 'GetDataServiceContextUpdateEvent', + 'GetDataServiceConnection', + 'GetDataServiceApiAuthMapContext', + 'GetDataServiceFunction', + ], + ], + ], + 'components' => [ + 'schemas' => [], + ], + 'apis' => [ + 'CreateManualDag' => [ + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [ + 'operationType' => 'none', + 'abilityTreeCode' => '78125', + 'abilityTreeNodes' => [ + 'FEATUREdideVFMENL', + ], + ], + 'parameters' => [ + [ + 'name' => 'ProjectName', + 'in' => 'query', + 'schema' => [ + 'description' => '项目名称。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'test_project', + ], + ], + [ + 'name' => 'FlowName', + 'in' => 'query', + 'schema' => [ + 'description' => '手动业务流程名称。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'test_flow', + ], + ], + [ + 'name' => 'DagPara', + 'in' => 'query', + 'schema' => [ + 'description' => '业务流程参数。', + 'type' => 'string', + 'required' => false, + 'example' => 'param_k1=param_v1 param_k2=param_v2', + ], + ], + [ + 'name' => 'NodePara', + 'in' => 'query', + 'schema' => [ + 'description' => '节点参数，节点ID到节点参数的map。如果节点有多个参数，在节点参数值中用空格分隔。', + 'type' => 'string', + 'required' => false, + 'example' => '{"103180025": "test=$[yyyy-mm-dd]"}', + ], + ], + [ + 'name' => 'Bizdate', + 'in' => 'query', + 'schema' => [ + 'description' => '业务日期。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '2018-12-12 00:00:00', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'ReturnCode' => [ + 'description' => '响应代码编号，0标识成功。', + 'type' => 'string', + 'example' => '0', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '2d9ce-38ef-4923-baf6-391a7e656', + ], + 'ReturnValue' => [ + 'description' => '返回值，此处返回手动业务流程的运行实例ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1244311235', + ], + 'ReturnErrorSolution' => [ + 'description' => '如果异常，会显示异常的解决方案信息。', + 'type' => 'string', + 'example' => 'test', + ], + 'ReturnMessage' => [ + 'description' => '异常信息。', + 'type' => 'string', + 'example' => 'test', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"ReturnCode\\": \\"0\\",\\n \\"RequestId\\": \\"2d9ce-38ef-4923-baf6-391a7e656\\",\\n \\"ReturnValue\\": 1244311235,\\n \\"ReturnErrorSolution\\": \\"test\\",\\n \\"ReturnMessage\\": \\"test\\"\\n}","errorExample":""},{"type":"xml","example":"<CreateManualDagMetaResponse>\\r\\n<requestId>D394A-96-4C7-96E-FCDEB0AB3</requestId>\\r\\n\\t<returnCode>0</returnCode>\\r\\n\\t<returnErrorSolution></returnErrorSolution>\\r\\n\\t<returnMessage></returnMessage>\\r\\n\\t<returnValue>13245685</returnValue>\\r\\n</CreateManualDagMetaResponse>","errorExample":""}]', + 'title' => '触发手动业务流程执行', + 'summary' => '触发手动业务流程执行。', + 'description' => 'CreateManualDag不支持开发环境调用，仅支持生产环境调用。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DeleteFile' => [ + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'abilityTreeCode' => '78128', + 'abilityTreeNodes' => [ + 'FEATUREdide8FM783', + ], + ], + 'parameters' => [ + [ + 'name' => 'ProjectId', + 'in' => 'formData', + 'schema' => [ + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'docRequired' => true, + ], + ], + [ + 'name' => 'ProjectIdentifier', + 'in' => 'formData', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'FileId', + 'in' => 'formData', + 'schema' => [ + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + 'ErrorMessage' => [ + 'type' => 'string', + ], + 'RequestId' => [ + 'type' => 'string', + ], + 'ErrorCode' => [ + 'type' => 'string', + ], + 'Success' => [ + 'type' => 'boolean', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'Forbidden.Access', + 'errorMessage' => 'Access is forbidden. Activate DataWorks first.', + ], + [ + '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.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' => '', + ], + 'SearchManualDagNodeInstance' => [ + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '78147', + 'abilityTreeNodes' => [ + 'FEATUREdide7WF1GB', + ], + ], + 'parameters' => [ + [ + 'name' => 'ProjectName', + 'in' => 'query', + 'schema' => [ + 'description' => '项目名称。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'test_odps_project', + ], + ], + [ + 'name' => 'DagId', + 'in' => 'query', + 'schema' => [ + 'description' => '手动业务流程运行实例ID，**createManualDag**接口返回的值。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + 'example' => '123434234', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '2d9ced66-38ef-4923-baf6-391dd3a7e656', + ], + 'ErrMsg' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'test', + ], + 'ErrCode' => [ + 'description' => '错误码。', + 'type' => 'string', + 'example' => '0', + ], + 'Success' => [ + 'description' => '是否成功。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Data' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'NodeInsInfo' => [ + 'description' => '返回的手动业务流程内部运行任务的列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => '任务状态：'."\n" + ."\n" + .'- 未运行：上游实例未全部成功。例如，NOT_RUN(1, "未运行")。'."\n" + ."\n" + .'- 等待定时时间（dueTime/cycleTime）到来。例如，WAIT_TIME(2, "等待时间")。'."\n" + ."\n" + .'- 已经下发到执行引擎，在等待排队调度执行。例如，WAIT_RESOURCE(3, "等待资源")。'."\n" + ."\n" + .'- 执行中。例如，RUNNING(4, "运行中")。'."\n" + ."\n" + .'- 执行完毕，已经下发进行数据校验。例如，CHECKING(7, "校验中")。'."\n" + ."\n" + .'- 执行完毕，正在进行分支条件校验。例如，CHECKING_CONDITION(8, "条件检测中")。'."\n" + ."\n" + .'- 执行失败。例如，FAILURE(5, "运行失败")。'."\n" + ."\n" + .'- 执行成功。例如，SUCCESS(6, "运行成功")。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '6', + ], + 'BeginRunningTime' => [ + 'description' => '开始运行时间。', + 'type' => 'string', + 'example' => '2018-12-12 00:00:00', + ], + 'FinishTime' => [ + 'description' => '任务结束时间。', + 'type' => 'string', + 'example' => '2018-12-12 00:00:00', + ], + 'ParaValue' => [ + 'description' => '任务参数信息。', + 'type' => 'string', + 'example' => 'param_k1=param_v1', + ], + 'CreateTime' => [ + 'description' => '创建时间。', + 'type' => 'string', + 'example' => '2018-12-12 00:00:00', + ], + 'DagId' => [ + 'description' => '业务流程运行实例ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '12434232423', + ], + 'InstanceId' => [ + 'description' => '任务实例ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '12322434112', + ], + 'BeginWaitResTime' => [ + 'description' => '开始等待资源的时间点。', + 'type' => 'string', + 'example' => '2018-12-12 00:00:00', + ], + 'DagType' => [ + 'description' => '业务流程类型，5标识手动业务流程。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '5', + ], + 'NodeName' => [ + 'description' => '任务节点名称。', + 'type' => 'string', + 'example' => 'test_node', + ], + 'Bizdate' => [ + 'description' => '业务日期。', + 'type' => 'string', + 'example' => '2018-12-12 00:00:00', + ], + 'BeginWaitTimeTime' => [ + 'description' => '开始等待时间的时间点。', + 'type' => 'string', + 'example' => '2018-12-12 00:00:00', + ], + 'ModifyTime' => [ + 'description' => '修改时间。', + 'type' => 'string', + 'example' => '2018-12-12 00:00:00', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"2d9ced66-38ef-4923-baf6-391dd3a7e656\\",\\n \\"ErrMsg\\": \\"test\\",\\n \\"ErrCode\\": \\"0\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"NodeInsInfo\\": [\\n {\\n \\"Status\\": 6,\\n \\"BeginRunningTime\\": \\"2018-12-12 00:00:00\\",\\n \\"FinishTime\\": \\"2018-12-12 00:00:00\\",\\n \\"ParaValue\\": \\"param_k1=param_v1\\",\\n \\"CreateTime\\": \\"2018-12-12 00:00:00\\",\\n \\"DagId\\": 12434232423,\\n \\"InstanceId\\": 12322434112,\\n \\"BeginWaitResTime\\": \\"2018-12-12 00:00:00\\",\\n \\"DagType\\": 5,\\n \\"NodeName\\": \\"test_node\\",\\n \\"Bizdate\\": \\"2018-12-12 00:00:00\\",\\n \\"BeginWaitTimeTime\\": \\"2018-12-12 00:00:00\\",\\n \\"ModifyTime\\": \\"2018-12-12 00:00:00\\"\\n }\\n ]\\n }\\n}","errorExample":" {}"},{"type":"xml","example":"<SearchManualDagNodeInstanceMetaResponse>\\r\\n <data>\\r\\n\\t\\t<beginRunningTime>1564019679966</beginRunningTime>\\r\\n\\t\\t<beginWaitResTime>1564019679966</beginWaitResTime>\\r\\n\\t\\t<beginWaitTimeTime>1564019679506</beginWaitTimeTime>\\r\\n\\t\\t<bizdate>1559318400000</bizdate>\\r\\n\\t\\t<createTime>1564019679464</createTime>\\r\\n\\t\\t<dagId>332455685</dagId>\\r\\n\\t\\t<dagType>5</dagType>\\r\\n\\t\\t<finishTime>1564019679966</finishTime>\\r\\n\\t\\t<instanceId>2427622331</instanceId>\\r\\n\\t\\t<modifyTime>1564019679966</modifyTime>\\r\\n\\t\\t<nodeName>vi</nodeName>\\r\\n\\t\\t<status>6</status>\\r\\n\\t</data>\\r\\n\\t<errCode>0</errCode>\\r\\n\\t<errMsg></errMsg>\\r\\n\\t<requestId>E1729535-8C06-43F6-B1EA-6236F60A68E9</requestId>\\r\\n\\t<success>true</success>\\r\\n</SearchManualDagNodeInstanceMetaResponse>","errorExample":""}]', + 'title' => '查询已触发的手动业务流程信息', + 'summary' => '状态和名称等信息，包括运行中和运行完成的实例。', + 'description' => '**endpoint**：dataworks.[RegionId].aliyuncs.com '."\n" + .'> [RegionId] 指具体的某个Region，例如cn-shanghai、cn-beijing。'."\n" + ."\n" + .'**product**：dataworks-public'."\n" + ."\n" + .'SearchManualDagNodeInstance不支持开发环境调用，仅支持生产环境调用。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeEmrHiveTable' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'ClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'EMR集群的ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'C-D033DD5FB82436A6', + ], + ], + [ + 'name' => 'DatabaseName', + 'in' => 'query', + 'schema' => [ + 'description' => 'EMR Hive数据库的名称。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'default', + ], + ], + [ + 'name' => 'TableName', + 'in' => 'query', + 'schema' => [ + 'description' => 'EMR Hive表的名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'pt_table_090901_emr', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'ErrorMessage' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'test', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'E6F0DBDD-5AD8-4870-A6A0', + ], + 'ErrorCode' => [ + 'description' => '错误码。', + 'type' => 'string', + 'example' => '0', + ], + 'Data' => [ + 'description' => '返回数据。', + 'type' => 'object', + 'properties' => [ + 'TableParameters' => [ + 'description' => 'HIVE表的参数JSON串。', + 'type' => 'string', + 'example' => '{\\"transient_lastDdlTime\\":\\"1568031823\\",\\"bucketing_version\\":\\"2\\",\\"comment\\":\\"RANDOM GENERATED TEST DATA BY FUNCTION OF RANDOM_TEST_DATA\\"}', + ], + 'Owner' => [ + 'description' => '所有者。', + 'type' => 'string', + 'example' => 'root', + ], + 'TableName' => [ + 'description' => 'EMR Hive表的名称。', + 'type' => 'string', + 'example' => 'pt_table_090901_emr', + ], + 'TableDesc' => [ + 'description' => '表的描述信息。', + 'type' => 'string', + 'example' => 'RANDOM GENERATED TEST DATA BY FUNCTION OF RANDOM_TEST_DATA', + ], + 'IsCompressed' => [ + 'description' => '是否压缩。', + 'type' => 'boolean', + 'example' => 'false', + ], + 'GmtModified' => [ + 'description' => '修改时间，指元数据信息。', + 'type' => 'string', + 'example' => '2019-09-09 20:41:28', + ], + 'SerializationLib' => [ + 'description' => '序列化反序列化设置。', + 'type' => 'string', + 'example' => 'org.apache.hadoop.hive.serde2.lazy.LazySimpleSerDe', + ], + 'OwnerId' => [ + 'description' => '所有者的Aliyun UID。', + 'type' => 'string', + 'example' => '1861276710322536', + ], + 'TableSize' => [ + 'description' => '以字节为单位的表的物理大小。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '552', + ], + 'LastAccessTime' => [ + 'description' => '最后的访问时间。', + 'type' => 'string', + 'example' => '1970-01-01 08:00:00', + ], + 'TableComment' => [ + 'description' => '表的注释信息。', + 'type' => 'string', + 'example' => 'RANDOM GENERATED TEST DATA BY FUNCTION OF RANDOM_TEST_DATA', + ], + 'LastModifyTime' => [ + 'description' => '最后的修改时间。', + 'type' => 'string', + 'example' => '2019-09-09 20:23:47', + ], + 'DatabaseName' => [ + 'description' => 'Hive数据库的名称。', + 'type' => 'string', + 'example' => 'default', + ], + 'IsTemporary' => [ + 'description' => '是否为临时表。', + 'type' => 'boolean', + 'example' => 'false', + ], + 'GmtCreate' => [ + 'description' => '创建时间。', + 'type' => 'string', + 'example' => '2019-09-09 20:41:28', + ], + 'OutputFormat' => [ + 'description' => 'Hive表的输出格式。', + 'type' => 'string', + 'example' => 'org.apache.hadoop.hive.ql.io.HiveIgnoreKeyTextOutputFormat', + ], + 'TableType' => [ + 'description' => '表的类型。', + 'type' => 'string', + 'example' => 'MANAGED_TABLE', + ], + 'OwnerType' => [ + 'description' => 'Owner类型。', + 'type' => 'string', + 'example' => 'USER', + ], + 'PartitionKeys' => [ + 'description' => '分区字段的名称列表。', + 'type' => 'string', + 'example' => 'DS,HR,REGION', + ], + 'ClusterBizId' => [ + 'description' => 'EMR集群的ID。', + 'type' => 'string', + 'example' => 'C-D033DD5FB82436A6', + ], + 'Location' => [ + 'description' => 'HDFS或OSS等存放路径。', + 'type' => 'string', + 'example' => 'hdfs://emr-header-1.cluster-136574:9000/user/hive/warehouse/pt_table_090901_emr', + ], + 'ClusterBizName' => [ + 'description' => 'EMR集群的名称。', + 'type' => 'string', + 'example' => 'EHMC测试', + ], + 'InputFormat' => [ + 'description' => 'Hive表的输入格式。', + 'type' => 'string', + 'example' => 'org.apache.hadoop.mapred.TextInputFormat', + ], + 'Columns' => [ + 'description' => '字段列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ColumnName' => [ + 'description' => '字段的名称。', + 'type' => 'string', + 'example' => 'double', + ], + 'ColumnComment' => [ + 'description' => '字段的注释。', + 'type' => 'string', + 'example' => 'BALANCE FIELD', + ], + 'Comment' => [ + 'description' => '字段的注释。', + 'type' => 'string', + 'example' => 'BALANCE FIELD', + ], + 'ColumnType' => [ + 'description' => '字段的数据类型。', + 'type' => 'string', + 'example' => 'double', + ], + 'GmtCreate' => [ + 'description' => '创建时间，指元数据信息。', + 'type' => 'string', + 'example' => '2019-09-09 20:23:47', + ], + 'GmtModified' => [ + 'description' => '修改时间，指元数据信息。', + 'type' => 'string', + 'example' => '2019-09-09 20:23:47', + ], + 'ColumnPosition' => [ + 'description' => '字段的位置。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"ErrorMessage\\": \\"test\\",\\n \\"RequestId\\": \\"E6F0DBDD-5AD8-4870-A6A0\\",\\n \\"ErrorCode\\": \\"0\\",\\n \\"Data\\": {\\n \\"TableParameters\\": \\"{\\\\\\\\\\\\\\"transient_lastDdlTime\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"1568031823\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"bucketing_version\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"2\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"comment\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"RANDOM GENERATED TEST DATA BY FUNCTION OF RANDOM_TEST_DATA\\\\\\\\\\\\\\"}\\",\\n \\"Owner\\": \\"root\\",\\n \\"TableName\\": \\"pt_table_090901_emr\\",\\n \\"TableDesc\\": \\"RANDOM GENERATED TEST DATA BY FUNCTION OF RANDOM_TEST_DATA\\",\\n \\"IsCompressed\\": false,\\n \\"GmtModified\\": \\"2019-09-09 20:41:28\\",\\n \\"SerializationLib\\": \\"org.apache.hadoop.hive.serde2.lazy.LazySimpleSerDe\\",\\n \\"OwnerId\\": \\"1861276710322536\\",\\n \\"TableSize\\": 552,\\n \\"LastAccessTime\\": \\"1970-01-01 08:00:00\\",\\n \\"TableComment\\": \\"RANDOM GENERATED TEST DATA BY FUNCTION OF RANDOM_TEST_DATA\\",\\n \\"LastModifyTime\\": \\"2019-09-09 20:23:47\\",\\n \\"DatabaseName\\": \\"default\\",\\n \\"IsTemporary\\": false,\\n \\"GmtCreate\\": \\"2019-09-09 20:41:28\\",\\n \\"OutputFormat\\": \\"org.apache.hadoop.hive.ql.io.HiveIgnoreKeyTextOutputFormat\\",\\n \\"TableType\\": \\"MANAGED_TABLE\\",\\n \\"OwnerType\\": \\"USER\\",\\n \\"PartitionKeys\\": \\"DS,HR,REGION\\",\\n \\"ClusterBizId\\": \\"C-D033DD5FB82436A6\\",\\n \\"Location\\": \\"hdfs://emr-header-1.cluster-136574:9000/user/hive/warehouse/pt_table_090901_emr\\",\\n \\"ClusterBizName\\": \\"EHMC测试\\",\\n \\"InputFormat\\": \\"org.apache.hadoop.mapred.TextInputFormat\\",\\n \\"Columns\\": [\\n {\\n \\"ColumnName\\": \\"double\\",\\n \\"ColumnComment\\": \\"BALANCE FIELD\\",\\n \\"Comment\\": \\"BALANCE FIELD\\",\\n \\"ColumnType\\": \\"double\\",\\n \\"GmtCreate\\": \\"2019-09-09 20:23:47\\",\\n \\"GmtModified\\": \\"2019-09-09 20:23:47\\",\\n \\"ColumnPosition\\": 1\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<errorCode>0</errorCode>\\n<errorMsg>success</errorMsg>\\n<requestId>6212847D-86BE-4E5D-A147-FF5****</requestId>\\n<data>\\n <clusterBizId>C-D033DD5FB8****</clusterBizId>\\n <tableName>pt_table_090901_emr</tableName>\\n <tableType>MANAGED_TABLE</tableType>\\n <TableSize>552</TableSize>\\n <owner>root</owner>\\n <ownerType/>\\n <isTemporary>false</isTemporary>\\n <serializationLib>org.apache.hadoop.hive.serde2.lazy.LazySimpleSerDe</serializationLib>\\n <inputFormat>org.apache.hadoop.mapred.TextInputFormat</inputFormat>\\n <outputFormat>org.apache.hadoop.hive.ql.io.HiveIgnoreKeyTextOutputFormat</outputFormat>\\n <location>hdfs://emr-header-1.cluster-136574:9000/user/hive/warehouse/pt_table_090901_emr</location>\\n <lastAccessTime>1970-01-01 08:00:00</lastAccessTime>\\n <gmtCreate>2019-09-09 20:23:47</gmtCreate>\\n <gmtModified>2019-09-09 20:23:47</gmtModified>\\n <tableComment>RANDOM GENERATED TEST DATA BY FUNCTION OF RANDOM_TEST_DATA</tableComment>\\n <tableParameters>{\\"transient_lastDdlTime\\":\\"1568031823\\",\\"bucketing_version\\":\\"2\\",\\"comment\\":\\"RANDOM GENERATED TEST DATA BY FUNCTION OF RANDOM_TEST_DATA\\"}</tableParameters>\\n <partitionKeys>DS,HR,REGION</partitionKeys>\\n <isCompressed>false</isCompressed>\\n <clusterBizName>EHMC测试****</clusterBizName>\\n <databaseName>default</databaseName>\\n <ownerId>1861276****</ownerId>\\n <tableDesc>RANDOM GENERATED TEST DATA BY FUNCTION OF RANDOM_TEST_DATA</tableDesc>\\n <lastModifyTime>2019-09-09 20:23:47</lastModifyTime>\\n <columns>\\n <columnPosition>4</columnPosition>\\n <columnName>gender</columnName>\\n <columnType>boolean</columnType>\\n <columnComment>GENDER FIELD</columnComment>\\n <gmtCreate>2019-09-09 20:23:47</gmtCreate>\\n <gmtModified>2019-09-09 20:23:47</gmtModified>\\n <comment>GENDER FIELD</comment>\\n </columns>\\n <columns>\\n <columnPosition>3</columnPosition>\\n <columnName>balance</columnName>\\n <columnType>double</columnType>\\n <columnComment>BALANCE FIELD</columnComment>\\n <gmtCreate>2019-09-09 20:23:47</gmtCreate>\\n <gmtModified>2019-09-09 20:23:47</gmtModified>\\n <comment>BALANCE FIELD</comment>\\n </columns>\\n <columns>\\n <columnPosition>2</columnPosition>\\n <columnName>age</columnName>\\n <columnType>bigint</columnType>\\n <columnComment>AGE FIELD</columnComment>\\n <gmtCreate>2019-09-09 20:23:47</gmtCreate>\\n <gmtModified>2019-09-09 20:23:47</gmtModified>\\n <comment>AGE FIELD</comment>\\n </columns>\\n <columns>\\n <columnPosition>2</columnPosition>\\n <columnName>REGION</columnName>\\n <columnType>string</columnType>\\n <columnComment>PARTITIONED BY REGION</columnComment>\\n <gmtCreate>2019-09-09 20:23:47</gmtCreate>\\n <gmtModified>2019-09-09 20:23:47</gmtModified>\\n <comment>PARTITIONED BY REGION</comment>\\n </columns>\\n <columns>\\n <columnPosition>1</columnPosition>\\n <columnName>tag</columnName>\\n <columnType>string</columnType>\\n <columnComment>TAG FIELD</columnComment>\\n <gmtCreate>2019-09-09 20:23:47</gmtCreate>\\n <gmtModified>2019-09-09 20:23:47</gmtModified>\\n <comment>TAG FIELD</comment>\\n </columns>\\n <columns>\\n <columnPosition>1</columnPosition>\\n <columnName>HR</columnName>\\n <columnType>string</columnType>\\n <columnComment>PARTITIONED BY SINGLE DAY HOUR</columnComment>\\n <gmtCreate>2019-09-09 20:23:47</gmtCreate>\\n <gmtModified>2019-09-09 20:23:47</gmtModified>\\n <comment>PARTITIONED BY SINGLE DAY HOUR</comment>\\n </columns>\\n <columns>\\n <columnPosition>0</columnPosition>\\n <columnName>name</columnName>\\n <columnType>string</columnType>\\n <columnComment>NAME FIELD</columnComment>\\n <gmtCreate>2019-09-09 20:23:47</gmtCreate>\\n <gmtModified>2019-09-09 20:23:47</gmtModified>\\n <comment>NAME FIELD</comment>\\n </columns>\\n <columns>\\n <columnPosition>0</columnPosition>\\n <columnName>DS</columnName>\\n <columnType>string</columnType>\\n <columnComment>PARTITIONED BY SINGLE DAY</columnComment>\\n <gmtCreate>2019-09-09 20:23:47</gmtCreate>\\n <gmtModified>2019-09-09 20:23:47</gmtModified>\\n <comment>PARTITIONED BY SINGLE DAY</comment>\\n </columns>\\n <columns>\\n <columnPosition>5</columnPosition>\\n <columnName>birthday</columnName>\\n <columnType>string</columnType>\\n <columnComment>BIRTHDAY FIELD</columnComment>\\n <gmtCreate>2019-09-09 20:23:47</gmtCreate>\\n <gmtModified>2019-09-09 20:23:47</gmtModified>\\n <comment>BIRTHDAY FIELD</comment>\\n </columns>\\n</data>","errorExample":""}]', + 'title' => '获取EMR HIVE表元数据详情信息', + 'summary' => '获取EMR HIVE表元数据的详情信息，包括Column列表。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'ListEmrHiveAuditLogs' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'ClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'EMR集群的标识。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'C-D033DD5FB82436A6', + ], + ], + [ + 'name' => 'DatabaseName', + 'in' => 'query', + 'schema' => [ + 'description' => '数据库的名称。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'default', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '页码。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'docRequired' => true, + 'minimum' => '1', + 'example' => '2', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '页宽（每页记录数量）。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'docRequired' => true, + 'maximum' => '100', + 'minimum' => '1', + 'example' => '2', + ], + ], + [ + 'name' => 'TableName', + 'in' => 'query', + 'schema' => [ + 'description' => '表的名称。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'test_table', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '表示开始时间（10位时间戳），EndTime-StartTime需要满足小于等于86400。'."\n" + .'两个输入值可以同时为空，返回（current-86400, current）时间段内的审计日志。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1586509407', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '表示结束时间（10位时间戳），EndTime-StartTime需要满足小于等于86400。'."\n" + .'两个输入值可以同时为空，返回（current-86400, current）时间段内的审计日志。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1586509710', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'ErrorMessage' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'success', + ], + 'RequestId' => [ + 'description' => '请求标识。', + 'type' => 'string', + 'example' => '58D5334A-B013-430E', + ], + 'ErrorCode' => [ + 'description' => '错误码。', + 'type' => 'string', + 'example' => '0', + ], + 'Data' => [ + 'description' => '返回数据。', + 'type' => 'object', + 'properties' => [ + 'PageNumber' => [ + 'description' => '页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'PageSize' => [ + 'description' => '页宽（每页记录数量）。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'TotalCount' => [ + 'description' => '总记录量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '5', + ], + 'PagedData' => [ + 'description' => '分页获取的数据。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Operation' => [ + 'description' => '操作。', + 'type' => 'string', + 'example' => 'CREATE_TABLE', + ], + 'User' => [ + 'description' => '用户。', + 'type' => 'string', + 'example' => 'root', + ], + 'EventTime' => [ + 'description' => '事件的发生时间。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1564019679506', + ], + 'Table' => [ + 'description' => '数据表。', + 'type' => 'string', + 'example' => 'test_table', + ], + 'Database' => [ + 'description' => '数据库。', + 'type' => 'string', + 'example' => 'default', + ], + 'Groups' => [ + 'type' => 'array', + 'items' => [ + 'description' => '用户组。', + 'type' => 'string', + 'example' => 'root', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"ErrorMessage\\": \\"success\\",\\n \\"RequestId\\": \\"58D5334A-B013-430E\\",\\n \\"ErrorCode\\": \\"0\\",\\n \\"Data\\": {\\n \\"PageNumber\\": 2,\\n \\"PageSize\\": 2,\\n \\"TotalCount\\": 5,\\n \\"PagedData\\": [\\n {\\n \\"Operation\\": \\"CREATE_TABLE\\",\\n \\"User\\": \\"root\\",\\n \\"EventTime\\": 1564019679506,\\n \\"Table\\": \\"test_table\\",\\n \\"Database\\": \\"default\\",\\n \\"Groups\\": [\\n \\"root\\"\\n ]\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<errorCode>0</errorCode>\\n<errorMsg>success</errorMsg>\\n<requestId>E6F0DBDD-5AD8-4870-A6A0-B8FD5B****</requestId>\\n<data>\\n <pageNumber>2</pageNumber>\\n <pageSize>2</pageSize>\\n <totalCount>5</totalCount>\\n <pagedData>\\n <database>wj_db_01</database>\\n <groups>root</groups>\\n <operation>CREATE_TABLE</operation>\\n <table>wj_table_03</table>\\n <user>root</user>\\n </pagedData>\\n</data>","errorExample":""}]', + 'title' => '查看Hive元数据的审计日志', + 'summary' => '查看Hive元数据的审计日志。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'ListEmrHiveDatabases' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'ClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'EMR集群的ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'C-D033DD5FB82436A6', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'ErrorMessage' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'test', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'D9A61DC0-B922-421B-B706', + ], + 'ErrorCode' => [ + 'description' => '错误码。', + 'type' => 'string', + 'example' => '0', + ], + 'Data' => [ + 'description' => '返回数据。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'description' => '数据库的类型。', + 'type' => 'string', + 'example' => 'HIVE', + ], + 'Status' => [ + 'description' => '数据库的状态。', + 'type' => 'string', + 'example' => '-', + ], + 'Owner' => [ + 'description' => '数据库的所有者。', + 'type' => 'string', + 'example' => 'public', + ], + 'Comment' => [ + 'description' => 'Hive数据库的注释。', + 'type' => 'string', + 'example' => 'Default Hive database', + ], + 'GmtModified' => [ + 'description' => '修改时间戳，指元数据信息。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1568010630000', + ], + 'OwnerId' => [ + 'description' => '数据库所有者的Aliyun Uid。', + 'type' => 'string', + 'example' => '18612767', + ], + 'Parameters' => [ + 'description' => 'Hive数据库参数JSON串。', + 'type' => 'string', + 'example' => '{}', + ], + 'Region' => [ + 'description' => 'Hive数据库所属集群的所在地域。', + 'type' => 'string', + 'example' => 'cn-shanghai', + ], + 'GmtCreate' => [ + 'description' => '创建时间戳，指元数据信息。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1568010630000', + ], + 'OwnerType' => [ + 'description' => '所有者的类型。', + 'type' => 'string', + 'example' => 'ROLE', + ], + 'Name' => [ + 'description' => 'Hive数据库的名称。', + 'type' => 'string', + 'example' => 'default', + ], + 'Location' => [ + 'description' => 'Hive数据库的存储位置。', + 'type' => 'string', + 'example' => 'hdfs://emr-header-1.cluster-136574:9000/user/hive/warehouse', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"ErrorMessage\\": \\"test\\",\\n \\"RequestId\\": \\"D9A61DC0-B922-421B-B706\\",\\n \\"ErrorCode\\": \\"0\\",\\n \\"Data\\": [\\n {\\n \\"Type\\": \\"HIVE\\",\\n \\"Status\\": \\"-\\",\\n \\"Owner\\": \\"public\\",\\n \\"Comment\\": \\"Default Hive database\\",\\n \\"GmtModified\\": 1568010630000,\\n \\"OwnerId\\": \\"18612767\\",\\n \\"Parameters\\": \\"{}\\",\\n \\"Region\\": \\"cn-shanghai\\",\\n \\"GmtCreate\\": 1568010630000,\\n \\"OwnerType\\": \\"ROLE\\",\\n \\"Name\\": \\"default\\",\\n \\"Location\\": \\"hdfs://emr-header-1.cluster-136574:9000/user/hive/warehouse\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<errorCode>0</errorCode>\\n<errorMessage>success</errorMessage>\\n<requestId>D9A61DC0-B922-421B-B706-B2****</requestId>\\n<data>\\n <name>default</name>\\n <type>HIVE</type>\\n <owner>public</owner>\\n <ownerId>18612767****</ownerId>\\n <comment>Default Hive database</comment>\\n <location>hdfs://emr-header-1.cluster-136574:9000/user/hive/warehouse</location>\\n <status/>\\n <parameters>{}</parameters>\\n <gmtCreate>1568010630000</gmtCreate>\\n <gmtModified>1568010630000</gmtModified>\\n <ownerType>ROLE</ownerType>\\n <region>cn-shanghai</region>\\n</data>\\n<data>\\n <name>house_db_0909</name>\\n <type>HIVE</type>\\n <owner>root</owner>\\n <ownerId>18612767103****</ownerId>\\n <comment>?????0909</comment>\\n <location>hdfs://emr-header-1.cluster-136574:9000/user/hive/warehouse/house_db_0909.db</location>\\n <status/>\\n <parameters>{}</parameters>\\n <gmtCreate>1568010341000</gmtCreate>\\n <gmtModified>1568010341000</gmtModified>\\n <ownerType>USER</ownerType>\\n <region>cn-shanghai</region>\\n</data>\\n<data>\\n <name>twitter_db</name>\\n <type>HIVE</type>\\n <owner>admin</owner>\\n <ownerId>1861276710****</ownerId>\\n <location>hdfs://emr-header-1.cluster-136574:9000/user/hive/warehouse/twitter_db.db</location>\\n <status/>\\n <parameters>{}</parameters>\\n <gmtCreate>1568178228000</gmtCreate>\\n <gmtModified>1568178228000</gmtModified>\\n <ownerType>USER</ownerType>\\n <region>cn-shanghai</region>\\n</data>","errorExample":""}]', + 'title' => '获取EMR集群下Hive数据库列表', + 'summary' => '获取EMR集群下的Hive数据库列表（不分页）。', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'ListEmrHiveTables' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'ClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'EMR集群的ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'C-D033DD5FB82436A6', + ], + ], + [ + 'name' => 'DatabaseName', + 'in' => 'query', + 'schema' => [ + 'description' => 'EMR Hive数据库的名称。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'default', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '页码。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'docRequired' => true, + 'minimum' => '1', + 'example' => '2', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '页宽（每页记录数量）。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'docRequired' => true, + 'maximum' => '100', + 'minimum' => '1', + 'example' => '2', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'ErrorMessage' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'test', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'E6F0DBDD-5AD8-4870-A6A0', + ], + 'ErrorCode' => [ + 'description' => '错误码。', + 'type' => 'string', + 'example' => '0', + ], + 'Data' => [ + 'description' => '返回数据。', + 'type' => 'object', + 'properties' => [ + 'PageNumber' => [ + 'description' => '页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'PageSize' => [ + 'description' => '页宽（每页记录数量）。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'TotalCount' => [ + 'description' => '总记录量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '5', + ], + 'PagedData' => [ + 'description' => '分页获取的数据。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'TableParameters' => [ + 'description' => 'Hive表参数JSON串。', + 'type' => 'string', + 'example' => '{\\"transient_lastDdlTime\\":\\"1568031823\\",\\"bucketing_version\\":\\"2\\",\\"comment\\":\\"RANDOM GENERATED TEST DATA BY FUNCTION OF RANDOM_TEST_DATA\\"}', + ], + 'Owner' => [ + 'description' => '所有者。', + 'type' => 'string', + 'example' => 'root', + ], + 'TableName' => [ + 'description' => '表的名称。', + 'type' => 'string', + 'example' => 'pt_table_090901_emr_orc', + ], + 'TableDesc' => [ + 'description' => '表的描述信息。', + 'type' => 'string', + 'example' => 'RANDOM GENERATED TEST DATA BY FUNCTION OF RANDOM_TEST_DATA', + ], + 'IsCompressed' => [ + 'description' => '是否启用了压缩。', + 'type' => 'boolean', + 'example' => 'false', + ], + 'GmtModified' => [ + 'description' => '编辑时间，指元数据。', + 'type' => 'string', + 'example' => '2019-09-09 20:23:47', + ], + 'SerializationLib' => [ + 'description' => 'Hive表的序列化、反序列化设置。', + 'type' => 'string', + 'example' => 'org.apache.hadoop.hive.serde2.lazy.LazySimpleSerDe', + ], + 'OwnerId' => [ + 'description' => '所有者的Aliyun Uid。', + 'type' => 'string', + 'example' => '18612767103****', + ], + 'LastAccessTime' => [ + 'description' => '最后访问的时间。', + 'type' => 'string', + 'example' => '1970-01-01 08:00:00', + ], + 'TableComment' => [ + 'description' => '表注释，同表在Hive库中的Comment。', + 'type' => 'string', + 'example' => 'RANDOM GENERATED TEST DATA BY FUNCTION OF RANDOM_TEST_DATA', + ], + 'LastModifyTime' => [ + 'description' => '最后修改的时间。', + 'type' => 'string', + 'example' => '2019-09-09 20:23:47', + ], + 'DatabaseName' => [ + 'description' => '表所在数据库的名称。', + 'type' => 'string', + 'example' => 'default', + ], + 'IsTemporary' => [ + 'description' => '是否为临时表。', + 'type' => 'boolean', + 'example' => 'false', + ], + 'GmtCreate' => [ + 'description' => '创建时间，指元数据。', + 'type' => 'string', + 'example' => '2019-09-09 20:23:47', + ], + 'OutputFormat' => [ + 'description' => '表的输出格式。', + 'type' => 'string', + 'example' => 'org.apache.hadoop.hive.ql.io.HiveIgnoreKeyTextOutputFormat', + ], + 'TableType' => [ + 'description' => '表的类型。', + 'type' => 'string', + 'example' => 'MANAGED_TABLE', + ], + 'OwnerType' => [ + 'description' => '所有者的类型。', + 'type' => 'string', + 'example' => 'ROLE', + ], + 'PartitionKeys' => [ + 'description' => '分区字段列表（仅限分区表）。', + 'type' => 'string', + 'example' => 'DS,HR,REGION', + ], + 'ClusterBizId' => [ + 'description' => 'EMR集群的标识。', + 'type' => 'string', + 'example' => 'C-D033DD5FB82436A6', + ], + 'Location' => [ + 'description' => '表的存储路径。', + 'type' => 'string', + 'example' => 'hdfs://emr-header-1.cluster-136574:9000/user/hive/warehouse/pt_table_090901_emr', + ], + 'ClusterBizName' => [ + 'description' => 'EMR集群的名称。', + 'type' => 'string', + 'example' => 'EHMC测试', + ], + 'InputFormat' => [ + 'description' => '表的输入格式。', + 'type' => 'string', + 'example' => 'org.apache.hadoop.hive.ql.io.orc.OrcInputFormat', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"ErrorMessage\\": \\"test\\",\\n \\"RequestId\\": \\"E6F0DBDD-5AD8-4870-A6A0\\",\\n \\"ErrorCode\\": \\"0\\",\\n \\"Data\\": {\\n \\"PageNumber\\": 2,\\n \\"PageSize\\": 2,\\n \\"TotalCount\\": 5,\\n \\"PagedData\\": [\\n {\\n \\"TableParameters\\": \\"{\\\\\\\\\\\\\\"transient_lastDdlTime\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"1568031823\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"bucketing_version\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"2\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"comment\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"RANDOM GENERATED TEST DATA BY FUNCTION OF RANDOM_TEST_DATA\\\\\\\\\\\\\\"}\\",\\n \\"Owner\\": \\"root\\",\\n \\"TableName\\": \\"pt_table_090901_emr_orc\\",\\n \\"TableDesc\\": \\"RANDOM GENERATED TEST DATA BY FUNCTION OF RANDOM_TEST_DATA\\",\\n \\"IsCompressed\\": false,\\n \\"GmtModified\\": \\"2019-09-09 20:23:47\\",\\n \\"SerializationLib\\": \\"org.apache.hadoop.hive.serde2.lazy.LazySimpleSerDe\\",\\n \\"OwnerId\\": \\"18612767103****\\",\\n \\"LastAccessTime\\": \\"1970-01-01 08:00:00\\",\\n \\"TableComment\\": \\"RANDOM GENERATED TEST DATA BY FUNCTION OF RANDOM_TEST_DATA\\",\\n \\"LastModifyTime\\": \\"2019-09-09 20:23:47\\",\\n \\"DatabaseName\\": \\"default\\",\\n \\"IsTemporary\\": false,\\n \\"GmtCreate\\": \\"2019-09-09 20:23:47\\",\\n \\"OutputFormat\\": \\"org.apache.hadoop.hive.ql.io.HiveIgnoreKeyTextOutputFormat\\",\\n \\"TableType\\": \\"MANAGED_TABLE\\",\\n \\"OwnerType\\": \\"ROLE\\",\\n \\"PartitionKeys\\": \\"DS,HR,REGION\\",\\n \\"ClusterBizId\\": \\"C-D033DD5FB82436A6\\",\\n \\"Location\\": \\"hdfs://emr-header-1.cluster-136574:9000/user/hive/warehouse/pt_table_090901_emr\\",\\n \\"ClusterBizName\\": \\"EHMC测试\\",\\n \\"InputFormat\\": \\"org.apache.hadoop.hive.ql.io.orc.OrcInputFormat\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<errorCode>0</errorCode>\\n<errorMsg>success</errorMsg>\\n<requestId>E6F0DBDD-5AD8-4870-A6A0-B8FD5B****</requestId>\\n<data>\\n <pageNumber>2</pageNumber>\\n <pageSize>2</pageSize>\\n <totalCount>5</totalCount>\\n <pagedData>\\n <clusterBizId>C-D033DD5FB****</clusterBizId>\\n <tableName>pt_table_090901_emr_orc</tableName>\\n <tableType>MANAGED_TABLE</tableType>\\n <owner>root</owner>\\n <ownerType/>\\n <isTemporary>false</isTemporary>\\n <serializationLib>org.apache.hadoop.hive.ql.io.orc.OrcSerde</serializationLib>\\n <inputFormat>org.apache.hadoop.hive.ql.io.orc.OrcInputFormat</inputFormat>\\n <outputFormat>org.apache.hadoop.hive.ql.io.orc.OrcOutputFormat</outputFormat>\\n <location>hdfs://emr-header-1.cluster-136574:9000/user/hive/warehouse/pt_table_090901_emr_orc</location>\\n <lastAccessTime>1970-01-01 08:00:00</lastAccessTime>\\n <gmtCreate>2019-09-09 20:41:28</gmtCreate>\\n <gmtModified>2019-09-09 20:41:28</gmtModified>\\n <tableComment>RANDOM GENERATED TEST DATA BY FUNCTION OF RANDOM_TEST_DATA</tableComment>\\n <tableParameters>{\\"orc.compress\\":\\"ZLIB\\",\\"transient_lastDdlTime\\":\\"1568032884\\",\\"bucketing_version\\":\\"2\\",\\"comment\\":\\"RANDOM GENERATED TEST DATA BY FUNCTION OF RANDOM_TEST_DATA\\"}</tableParameters>\\n <partitionKeys>DS,HR,REGION</partitionKeys>\\n <isCompressed>false</isCompressed>\\n <clusterBizName>EHMC测试****</clusterBizName>\\n <databaseName>default</databaseName>\\n <ownerId>18612767****</ownerId>\\n <lastModifyTime>2019-09-09 20:41:28</lastModifyTime>\\n <tableDesc>RANDOM GENERATED TEST DATA BY FUNCTION OF RANDOM_TEST_DATA</tableDesc>\\n </pagedData>\\n <pagedData>\\n <clusterBizId>C-D033DD5FB8****</clusterBizId>\\n <tableName>pt_table_090901_emr</tableName>\\n <tableType>MANAGED_TABLE</tableType>\\n <owner>root</owner>\\n <ownerType/>\\n <isTemporary>false</isTemporary>\\n <serializationLib>org.apache.hadoop.hive.serde2.lazy.LazySimpleSerDe</serializationLib>\\n <inputFormat>org.apache.hadoop.mapred.TextInputFormat</inputFormat>\\n <outputFormat>org.apache.hadoop.hive.ql.io.HiveIgnoreKeyTextOutputFormat</outputFormat>\\n <location>hdfs://emr-header-1.cluster-136574:9000/user/hive/warehouse/pt_table_090901_emr</location>\\n <lastAccessTime>1970-01-01 08:00:00</lastAccessTime>\\n <gmtCreate>2019-09-09 20:23:47</gmtCreate>\\n <gmtModified>2019-09-09 20:23:47</gmtModified>\\n <tableComment>RANDOM GENERATED TEST DATA BY FUNCTION OF RANDOM_TEST_DATA</tableComment>\\n <tableParameters>{\\"transient_lastDdlTime\\":\\"1568031823\\",\\"bucketing_version\\":\\"2\\",\\"comment\\":\\"RANDOM GENERATED TEST DATA BY FUNCTION OF RANDOM_TEST_DATA\\"}</tableParameters>\\n <partitionKeys>DS,HR,REGION</partitionKeys>\\n <isCompressed>false</isCompressed>\\n <clusterBizName>EHMC测试****</clusterBizName>\\n <databaseName>default</databaseName>\\n <ownerId>1861276710322536</ownerId>\\n <lastModifyTime>2019-09-09 20:23:47</lastModifyTime>\\n <tableDesc>RANDOM GENERATED TEST DATA BY FUNCTION OF RANDOM_TEST_DATA</tableDesc>\\n </pagedData>\\n</data>","errorExample":""}]', + 'title' => '获取集群指定库下的Hive表列表', + 'summary' => '获取集群指定库下的Hive表列表。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'ListHiveTableLineages' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'ClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'EMR集群的ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'C-D033DD5FB82436A6', + ], + ], + [ + 'name' => 'DatabaseName', + 'in' => 'query', + 'schema' => [ + 'description' => 'EMR HIVE数据库的名称。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'default', + ], + ], + [ + 'name' => 'TableName', + 'in' => 'query', + 'schema' => [ + 'description' => 'EMR HIVE表的名称。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'pt_table_090901_emr', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'ErrorMessage' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'test', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '691CA452-D37A-4ED0-9441', + ], + 'ErrorCode' => [ + 'description' => '错误码。', + 'type' => 'string', + 'example' => '0', + ], + 'Data' => [ + 'description' => '返回数据。', + 'type' => 'object', + 'properties' => [ + 'UpstreamNumber' => [ + 'description' => '上游血缘的数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'DownstreamNumber' => [ + 'description' => '下游血缘的数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '3', + ], + 'UpstreamLineages' => [ + 'description' => '上游血缘列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'TableName' => [ + 'description' => '表的名称。', + 'type' => 'string', + 'example' => 'pt_table_090901_emr_orc', + ], + 'ModifiedTime' => [ + 'description' => '修改时间。', + 'type' => 'string', + 'example' => '2020-01-09 18:16:37', + ], + 'QueryText' => [ + 'description' => '任务对应的语句。', + 'type' => 'string', + 'example' => 'create table parquet_example_0407 select id as one,name as two,salary as three from PTtable_0407_emr', + ], + 'JobId' => [ + 'description' => '任务的ID。', + 'type' => 'string', + 'example' => 'job_1234567055_0006', + ], + 'CreateTime' => [ + 'description' => '创建时间。', + 'type' => 'string', + 'example' => '2020-01-09 18:16:15', + ], + 'DatabaseName' => [ + 'description' => '数据库的名称。', + 'type' => 'string', + 'example' => 'default', + ], + 'Engine' => [ + 'description' => '引擎信息。', + 'type' => 'string', + 'example' => 'mr', + ], + 'Source' => [ + 'description' => '血缘来源，例如HIVE。', + 'type' => 'string', + 'example' => 'HIVE', + ], + 'ClusterId' => [ + 'description' => 'EMR集群的标识。', + 'type' => 'string', + 'example' => 'C-D033DD5FB82436A6', + ], + ], + ], + ], + 'DownstreamLineages' => [ + 'description' => '下游血缘列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'TableName' => [ + 'description' => '表的名称。', + 'type' => 'string', + 'example' => 'pt_table_090901_emr_orc', + ], + 'ModifiedTime' => [ + 'description' => '修改时间。', + 'type' => 'string', + 'example' => '2020-01-09 18:16:37', + ], + 'QueryText' => [ + 'description' => '任务对应的语句。', + 'type' => 'string', + 'example' => 'create table parquet_example_0407 select id as one,name as two,salary as three from PTtable_0407_emr', + ], + 'JobId' => [ + 'description' => '任务的ID。', + 'type' => 'string', + 'example' => 'job_1234567055_0006', + ], + 'CreateTime' => [ + 'description' => '创建时间。', + 'type' => 'string', + 'example' => '2020-01-09 18:16:15', + ], + 'DatabaseName' => [ + 'description' => '数据库的名称。', + 'type' => 'string', + 'example' => 'default', + ], + 'Engine' => [ + 'description' => '引擎信息。', + 'type' => 'string', + 'example' => 'mr', + ], + 'Source' => [ + 'description' => '血缘来源，例如HIVE。', + 'type' => 'string', + 'example' => 'HIVE', + ], + 'ClusterId' => [ + 'description' => 'EMR集群的标识。', + 'type' => 'string', + 'example' => 'C-D033DD5FB82436A6', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"ErrorMessage\\": \\"test\\",\\n \\"RequestId\\": \\"691CA452-D37A-4ED0-9441\\",\\n \\"ErrorCode\\": \\"0\\",\\n \\"Data\\": {\\n \\"UpstreamNumber\\": 0,\\n \\"DownstreamNumber\\": 3,\\n \\"UpstreamLineages\\": [\\n {\\n \\"TableName\\": \\"pt_table_090901_emr_orc\\",\\n \\"ModifiedTime\\": \\"2020-01-09 18:16:37\\",\\n \\"QueryText\\": \\"create table parquet_example_0407 select id as one,name as two,salary as three from PTtable_0407_emr\\",\\n \\"JobId\\": \\"job_1234567055_0006\\",\\n \\"CreateTime\\": \\"2020-01-09 18:16:15\\",\\n \\"DatabaseName\\": \\"default\\",\\n \\"Engine\\": \\"mr\\",\\n \\"Source\\": \\"HIVE\\",\\n \\"ClusterId\\": \\"C-D033DD5FB82436A6\\"\\n }\\n ],\\n \\"DownstreamLineages\\": [\\n {\\n \\"TableName\\": \\"pt_table_090901_emr_orc\\",\\n \\"ModifiedTime\\": \\"2020-01-09 18:16:37\\",\\n \\"QueryText\\": \\"create table parquet_example_0407 select id as one,name as two,salary as three from PTtable_0407_emr\\",\\n \\"JobId\\": \\"job_1234567055_0006\\",\\n \\"CreateTime\\": \\"2020-01-09 18:16:15\\",\\n \\"DatabaseName\\": \\"default\\",\\n \\"Engine\\": \\"mr\\",\\n \\"Source\\": \\"HIVE\\",\\n \\"ClusterId\\": \\"C-D033DD5FB82436A6\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<errorCode>0</errorCode>\\n<errorMsg>success</errorMsg>\\n<requestId>691CA452-D37A-4ED0-9441-16F57****</requestId>\\n<data>\\n <upstreamNumber>0</upstreamNumber>\\n <downstreamNumber>3</downstreamNumber>\\n <downstreamLineages>\\n <modifiedTime>2019-11-10 11:33:52</modifiedTime>\\n <QueryText>create table parquet_example_0407 select id as one,name as two,salary as three from PTtable_0407_emr</QueryText>\\n <databaseName>default</databaseName>\\n <engine>mr</engine>\\n <JobId>job_1234567055_0006</JobId>\\n <createTime>2019-11-10 11:33:52</createTime>\\n <clusterId>C-D033DD5FB****</clusterId>\\n <source>HIVE</source>\\n <tableName>pt_table_090901_emr_child</tableName>\\n </downstreamLineages>\\n <downstreamLineages>\\n <modifiedTime>2020-01-09 18:16:15</modifiedTime>\\n <QueryText>insert OVERWRITE table parquet_example_0407 select id as one,name as two,salary as three from PTtable_0407_emr</QueryText>\\n <databaseName>default</databaseName>\\n <engine>mr</engine>\\n <JobId>job_1234567055_0006</JobId>\\n <createTime>2020-01-09 18:16:15</createTime>\\n <clusterId>C-D033DD5****</clusterId>\\n <source>HIVE</source>\\n <tableName>pt_table_090901_emr_orc</tableName>\\n </downstreamLineages>\\n <downstreamLineages>\\n <modifiedTime>2020-01-09 18:16:37</modifiedTime>\\n <QueryText>create table parquet_example_0407 select id as one,name as two,salary as three from PTtable_0407_emr</QueryText>\\n <databaseName>default</databaseName>\\n <engine>mr</engine>\\n <JobId>job_1234567055_0006</JobId>\\n <createTime>2020-01-09 18:16:37</createTime>\\n <clusterId>C-D033DD5FB8****</clusterId>\\n <source>HIVE</source>\\n <tableName>pt_table_0909_emr_orc</tableName>\\n </downstreamLineages>\\n</data>","errorExample":""}]', + 'title' => '获取Hive表的血缘信息', + 'summary' => '获取Hive表的血缘信息。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'ListHiveColumnLineages' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'ClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'EMR集群的标识。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'C-D033DD5FB82436A6', + ], + ], + [ + 'name' => 'DatabaseName', + 'in' => 'query', + 'schema' => [ + 'description' => '数据库的名称。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'default', + ], + ], + [ + 'name' => 'TableName', + 'in' => 'query', + 'schema' => [ + 'description' => '表的名称。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'test_table', + ], + ], + [ + 'name' => 'ColumnName', + 'in' => 'query', + 'schema' => [ + 'description' => '字段的名称。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'balance', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'ErrorMessage' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'success', + ], + 'RequestId' => [ + 'description' => '请求标识。', + 'type' => 'string', + 'example' => '58D5334A-B013-430E', + ], + 'ErrorCode' => [ + 'description' => '错误码。', + 'type' => 'string', + 'example' => '0', + ], + 'Data' => [ + 'description' => '返回数据。', + 'type' => 'object', + 'properties' => [ + 'UpstreamNumber' => [ + 'description' => '上游血缘数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'DownstreamNumber' => [ + 'description' => '下游血缘的数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '3', + ], + 'UpstreamLineages' => [ + 'description' => '上游血缘。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ColumnName' => [ + 'description' => '字段的名称。', + 'type' => 'string', + 'example' => 'balance', + ], + 'DirectUpperTableNumber' => [ + 'description' => '直接上游的表数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'TableName' => [ + 'description' => '表的名称。', + 'type' => 'string', + 'example' => 'pt_table_090901_emr_child', + ], + 'ModifiedTime' => [ + 'description' => '修改时间。', + 'type' => 'string', + 'example' => '2019-11-10 11:33:51', + ], + 'CreateTime' => [ + 'description' => '创建时间。', + 'type' => 'string', + 'example' => '2019-11-10 11:33:51', + ], + 'DirectDownTableNumber' => [ + 'description' => '直接下游的表数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'DatabaseName' => [ + 'description' => '数据库的名称。', + 'type' => 'string', + 'example' => 'default', + ], + 'DirectDownColumnNumber' => [ + 'description' => '直接下游的字段数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'DirectUpperColumnNumber' => [ + 'description' => '直接上游的字段数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'Source' => [ + 'description' => '血缘来源，例如HIVE。', + 'type' => 'string', + 'example' => 'HIVE', + ], + 'ClusterId' => [ + 'description' => 'EMR集群的标识。', + 'type' => 'string', + 'example' => 'C-D033DD5FB82436A6', + ], + ], + ], + ], + 'DownstreamLineages' => [ + 'description' => '下游血缘。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ColumnName' => [ + 'description' => '字段的名称。', + 'type' => 'string', + 'example' => 'balance', + ], + 'DirectUpperTableNumber' => [ + 'description' => '直接上游的表数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'TableName' => [ + 'description' => '表的名称。', + 'type' => 'string', + 'example' => 'pt_table_090901_emr_child', + ], + 'ModifiedTime' => [ + 'description' => '创建时间。', + 'type' => 'string', + 'example' => '2019-11-10 11:33:52', + ], + 'CreateTime' => [ + 'description' => '创建时间。', + 'type' => 'string', + 'example' => '2019-11-10 11:33:52', + ], + 'DirectDownTableNumber' => [ + 'description' => '直接下游的表数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'DatabaseName' => [ + 'description' => '数据库的名称。', + 'type' => 'string', + 'example' => 'default', + ], + 'DirectDownColumnNumber' => [ + 'description' => '直接下游的字段数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'DirectUpperColumnNumber' => [ + 'description' => '直接上游的字段数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Source' => [ + 'description' => '血缘来源，例如HIVE。', + 'type' => 'string', + 'example' => 'HIVE', + ], + 'ClusterId' => [ + 'description' => 'EMR集群的标识。', + 'type' => 'string', + 'example' => 'C-D033DD5FB82436A6', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"ErrorMessage\\": \\"success\\",\\n \\"RequestId\\": \\"58D5334A-B013-430E\\",\\n \\"ErrorCode\\": \\"0\\",\\n \\"Data\\": {\\n \\"UpstreamNumber\\": 0,\\n \\"DownstreamNumber\\": 3,\\n \\"UpstreamLineages\\": [\\n {\\n \\"ColumnName\\": \\"balance\\",\\n \\"DirectUpperTableNumber\\": 1,\\n \\"TableName\\": \\"pt_table_090901_emr_child\\",\\n \\"ModifiedTime\\": \\"2019-11-10 11:33:51\\",\\n \\"CreateTime\\": \\"2019-11-10 11:33:51\\",\\n \\"DirectDownTableNumber\\": 0,\\n \\"DatabaseName\\": \\"default\\",\\n \\"DirectDownColumnNumber\\": 1,\\n \\"DirectUpperColumnNumber\\": 2,\\n \\"Source\\": \\"HIVE\\",\\n \\"ClusterId\\": \\"C-D033DD5FB82436A6\\"\\n }\\n ],\\n \\"DownstreamLineages\\": [\\n {\\n \\"ColumnName\\": \\"balance\\",\\n \\"DirectUpperTableNumber\\": 1,\\n \\"TableName\\": \\"pt_table_090901_emr_child\\",\\n \\"ModifiedTime\\": \\"2019-11-10 11:33:52\\",\\n \\"CreateTime\\": \\"2019-11-10 11:33:52\\",\\n \\"DirectDownTableNumber\\": 0,\\n \\"DatabaseName\\": \\"default\\",\\n \\"DirectDownColumnNumber\\": 0,\\n \\"DirectUpperColumnNumber\\": 1,\\n \\"Source\\": \\"HIVE\\",\\n \\"ClusterId\\": \\"C-D033DD5FB82436A6\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<errorCode>0</errorCode>\\n<errorMessage>success</errorMessage>\\n<requestId>58D5334A-B013-430E-AF34-CD21****</requestId>\\n<data>\\n <upstreamNumber>0</upstreamNumber>\\n <downstreamNumber>3</downstreamNumber>\\n <downstreamLineages>\\n <modifiedTime>2019-11-10 11:33:51</modifiedTime>\\n <directDownColumnNumber>1</directDownColumnNumber>\\n <clusterId>C-D033DD5F****</clusterId>\\n <source>HIVE</source>\\n <tableName>pt_table_090901_emr_child</tableName>\\n <directDownTableNumber>1</directDownTableNumber>\\n <directUpperTableNumber>2</directUpperTableNumber>\\n <createTime>2019-11-10 11:33:51</createTime>\\n <directUpperColumnNumber>2</directUpperColumnNumber>\\n <columnName>balance</columnName>\\n </downstreamLineages>\\n <downstreamLineages>\\n <modifiedTime>2019-11-10 11:33:52</modifiedTime>\\n <directDownColumnNumber>0</directDownColumnNumber>\\n <clusterId>C-D033DD5F****</clusterId>\\n <source>HIVE</source>\\n <tableName>pt_table_090901_emr_orc</tableName>\\n <directDownTableNumber>0</directDownTableNumber>\\n <directUpperTableNumber>1</directUpperTableNumber>\\n <createTime>2019-11-10 11:33:52</createTime>\\n <directUpperColumnNumber>1</directUpperColumnNumber>\\n <columnName>balance</columnName>\\n </downstreamLineages>\\n <downstreamLineages>\\n <modifiedTime>2019-11-10 11:33:52</modifiedTime>\\n <directDownColumnNumber>0</directDownColumnNumber>\\n <clusterId>C-D033DD5F****</clusterId>\\n <source>HIVE</source>\\n <tableName>pt_table_0909_emr_orc</tableName>\\n <directDownTableNumber>0</directDownTableNumber>\\n <directUpperTableNumber>1</directUpperTableNumber>\\n <createTime>2019-11-10 11:33:52</createTime>\\n <directUpperColumnNumber>1</directUpperColumnNumber>\\n <columnName>balance</columnName>\\n </downstreamLineages>\\n</data>","errorExample":""}]', + 'title' => '获取指定字段的上下游血缘信息', + 'summary' => '获取指定字段的上下游血缘信息。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'ListTablePartitions' => [ + 'summary' => '获取EMR HIVE表的分区列表。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREdideE9OA4H', + ], + ], + 'parameters' => [ + [ + 'name' => 'ClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '集群标识。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'C-2A51D3826C701234', + ], + ], + [ + 'name' => 'DatabaseName', + 'in' => 'query', + 'schema' => [ + 'description' => '数据库名称。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'default', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '页码。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'docRequired' => true, + 'minimum' => '1', + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '页宽。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'docRequired' => true, + 'maximum' => '100', + 'minimum' => '1', + 'example' => '10', + ], + ], + [ + 'name' => 'TableName', + 'in' => 'query', + 'schema' => [ + 'description' => '表名称。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'test_table', + ], + ], + [ + 'name' => 'Order', + 'in' => 'query', + 'schema' => [ + 'description' => '升降序。升序为ASC，降序为DESC。', + 'type' => 'string', + 'required' => false, + 'example' => 'ASC/DESC', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'ErrorMessage' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'success', + ], + 'RequestId' => [ + 'description' => '请求标识。', + 'type' => 'string', + 'example' => 'UUID', + ], + 'ErrorCode' => [ + 'description' => '错误码。', + 'type' => 'string', + 'example' => '0', + ], + 'Data' => [ + 'description' => '返回数据。', + 'type' => 'object', + 'properties' => [ + 'TotalCount' => [ + 'description' => '总数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '3', + ], + 'PageSize' => [ + 'description' => '页宽。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'PagedData' => [ + 'description' => '分页数据。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'PartitionPath' => [ + 'description' => '分区的路径，例如HDFS路径。', + 'type' => 'string', + 'example' => 'hdfs://emr-header-1.cluster-136574:9000/user/hive/warehouse/pt_table_090901_emr_child/ds=20190909/hr=20/region=shanghai', + ], + 'PartitionComment' => [ + 'description' => '分区的描述信息。', + 'type' => 'string', + 'example' => 'test', + ], + 'PartitionName' => [ + 'description' => '分区的名称。', + 'type' => 'string', + 'example' => 'ds=20190909/hr=20/region=shanghai', + ], + 'GmtCreate' => [ + 'description' => '分区的创建时间。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1568032253000', + ], + 'PartitionType' => [ + 'description' => '分区的类型。', + 'type' => 'string', + 'example' => 'HIVE', + ], + 'GmtModified' => [ + 'description' => '分区的修改时间。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1568032253000', + ], + 'Location' => [ + 'description' => '分区的存储位置。', + 'type' => 'string', + 'example' => 'hdfs://emr-header-1.cluster-136574:9000/user/hive/warehouse/pt_table_090901_emr_child/ds=20190909/hr=20/region=shanghai', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"ErrorMessage\\": \\"success\\",\\n \\"RequestId\\": \\"UUID\\",\\n \\"ErrorCode\\": \\"0\\",\\n \\"Data\\": {\\n \\"TotalCount\\": 3,\\n \\"PageSize\\": 10,\\n \\"PagedData\\": [\\n {\\n \\"PartitionPath\\": \\"hdfs://emr-header-1.cluster-136574:9000/user/hive/warehouse/pt_table_090901_emr_child/ds=20190909/hr=20/region=shanghai\\",\\n \\"PartitionComment\\": \\"test\\",\\n \\"PartitionName\\": \\"ds=20190909/hr=20/region=shanghai\\",\\n \\"GmtCreate\\": 1568032253000,\\n \\"PartitionType\\": \\"HIVE\\",\\n \\"GmtModified\\": 1568032253000,\\n \\"Location\\": \\"hdfs://emr-header-1.cluster-136574:9000/user/hive/warehouse/pt_table_090901_emr_child/ds=20190909/hr=20/region=shanghai\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<errorCode>0</errorCode>\\n<errorMessage>success</errorMessage>\\n<requestId>2B31A7F4-68C8-499C-AF2B-3C906B56809F</requestId>\\n<data>\\n <pageSize>2</pageSize>\\n <totalCount>4</totalCount>\\n <pagedData>\\n <gmtCreate>1574304364000</gmtCreate>\\n <gmtModified>1574304364000</gmtModified>\\n <location>hdfs://emr-header-1.cluster-46836:9000/user/hive/warehouse/pt_table_112001_emr/ds=20190724/hr=02/region=test-2</location>\\n <partitionName>ds=20190724/hr=02/region=test-2</partitionName>\\n <partitionPath>hdfs://emr-header-1.cluster-46836:9000/user/hive/warehouse/pt_table_112001_emr/ds=20190724/hr=02/region=test-2</partitionPath>\\n <partitionType>HIVE</partitionType>\\n <partitionComment/>\\n </pagedData>\\n <pagedData>\\n <gmtCreate>1574304355000</gmtCreate>\\n <gmtModified>1574304355000</gmtModified>\\n <location>hdfs://emr-header-1.cluster-46836:9000/user/hive/warehouse/pt_table_112001_emr/ds=20190721/hr=05/region=test-5</location>\\n <partitionName>ds=20190721/hr=05/region=test-5</partitionName>\\n <partitionPath>hdfs://emr-header-1.cluster-46836:9000/user/hive/warehouse/pt_table_112001_emr/ds=20190721/hr=05/region=test-5</partitionPath>\\n <partitionType>HIVE</partitionType>\\n <partitionComment/>\\n </pagedData>\\n</data>","errorExample":""}]', + 'title' => '获取EMR HIVE表的分区列表', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'OpenDataWorksStandardService' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + [ + 'APP' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'Region', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'OrderId' => [ + 'type' => 'string', + ], + 'RequestId' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + 'errorCodes' => [], + ], + 'SendTaskMetaCallback' => [ + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '78150', + 'abilityTreeNodes' => [ + 'FEATUREdideSYOMAV', + ], + ], + 'parameters' => [ + [ + 'name' => 'TenantId', + 'in' => 'formData', + 'schema' => [ + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + 'maximum' => '9223372036854775807', + 'minimum' => '1', + 'isFileTransferUrl' => false, + ], + ], + [ + 'name' => 'Type', + 'in' => 'formData', + 'schema' => [ + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'formData', + 'schema' => [ + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + 'maximum' => '9223372036854775807', + 'minimum' => '1', + 'isFileTransferUrl' => false, + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'formData', + 'schema' => [ + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + 'maximum' => '9223372036854775807', + 'minimum' => '1', + 'isFileTransferUrl' => false, + ], + ], + [ + 'name' => 'User', + 'in' => 'formData', + 'schema' => [ + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + ], + ], + [ + 'name' => 'Code', + 'in' => 'formData', + 'schema' => [ + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + ], + ], + [ + 'name' => 'ConnectionInfo', + 'in' => 'formData', + 'schema' => [ + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + ], + ], + [ + 'name' => 'TaskEnvParam', + 'in' => 'formData', + 'schema' => [ + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + ], + ], + [ + 'name' => 'SubType', + 'in' => 'formData', + 'schema' => [ + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + ], + ], + [ + 'name' => 'Resources', + 'in' => 'formData', + 'style' => 'repeatList', + 'schema' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'string', + ], + 'required' => false, + 'maxItems' => 10, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Data' => [ + 'type' => 'string', + ], + 'RequestId' => [ + 'type' => 'string', + ], + 'ErrMsg' => [ + 'type' => 'string', + ], + 'ErrorCode' => [ + 'type' => 'integer', + 'format' => 'int64', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 500 => [ + [ + 'errorCode' => 'InternalError.Meta.Unknown', + 'errorMessage' => 'An unknown error occurred while processing your request.', + ], + ], + ], + ], + 'SetSwitchValue' => [ + 'summary' => '设置Switch的值', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'SwitchName', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + ], + ], + [ + 'name' => 'SwitchValue', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'type' => 'string', + ], + 'Data' => [ + 'type' => 'boolean', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'IdempotentParameterMismatch', + 'errorMessage' => 'The request uses the same client token as a previous, but non-identical request. Do not reuse a client token with different requests, unless the requests are identical.', + ], + ], + ], + ], + 'GetDataServiceApiContext' => [ + 'summary' => '获取数据服务ApiContext信息', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '180496', + 'abilityTreeNodes' => [ + 'FEATUREdideWDSR97', + ], + ], + 'parameters' => [ + [ + 'name' => 'ApiId', + 'in' => 'query', + 'schema' => [ + 'title' => 'api逐渐', + 'description' => 'apiId', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'minimum' => '0', + 'exclusiveMinimum' => true, + 'example' => '12345', + ], + ], + [ + 'name' => 'Verbose', + 'in' => 'query', + 'schema' => [ + 'title' => '是否详情', + 'description' => '是否详情', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'CacheKey', + 'in' => 'query', + 'schema' => [ + 'description' => 'ApiContext缓存键值', + 'type' => 'string', + 'required' => false, + 'example' => 'abc-124', + ], + ], + [ + 'name' => 'ForPrivateResGroup', + 'in' => 'query', + 'schema' => [ + 'description' => '是否绑定独享数据服务资源组', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'ApiStatus', + 'in' => 'query', + 'schema' => [ + 'description' => 'Api状态，已发布、草稿态等', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'ApiContext', + 'description' => 'ApiContext', + 'type' => 'object', + 'properties' => [ + 'Data' => [ + 'description' => 'ApiContext信息', + 'type' => 'string', + 'example' => '{"apiId":123}', + ], + 'ErrMsg' => [ + 'description' => '错误信息', + 'type' => 'string', + 'example' => 'success', + ], + 'ErrCode' => [ + 'description' => '错误码', + 'type' => 'string', + 'example' => '0', + ], + 'RequestId' => [ + 'description' => '请求Id', + 'type' => 'string', + 'example' => '1AFAE64E-D1BE-432B-A9****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 500 => [ + [ + 'errorCode' => 'InternalError.System', + 'errorMessage' => 'An internal system error occurred. Try again later.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": \\"{\\\\\\"apiId\\\\\\":123}\\",\\n \\"ErrMsg\\": \\"success\\",\\n \\"ErrCode\\": \\"0\\",\\n \\"RequestId\\": \\"1AFAE64E-D1BE-432B-A9****\\"\\n}","type":"json"}]', + 'title' => '获取数据服务ApiContext信息', + 'description' => '获取数据服务ApiContext信息', + ], + 'GetDataServiceContextUpdateEvent' => [ + 'summary' => '查询APIcontext变更事件。', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '191385', + 'abilityTreeNodes' => [ + 'FEATUREdideZZ63WZ', + ], + ], + 'parameters' => [], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID', + 'type' => 'string', + 'example' => '8754EE08-4AA2-5F77-ADD7-754DBBDA9F75', + ], + 'Data' => [ + 'title' => 'Id of the request', + 'description' => '返回内容', + 'type' => 'string', + 'example' => '{\'TotalCount\': 0, \'CalcEngines\': []}', + ], + 'ErrMsg' => [ + 'title' => 'Id of the request', + 'description' => '错误信息', + 'type' => 'string', + 'example' => 'success', + ], + 'ErrCode' => [ + 'title' => 'Id of the request', + 'description' => '错误码', + 'type' => 'string', + 'example' => '0', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 500 => [ + [ + 'errorCode' => 'InternalError.System', + 'errorMessage' => 'An internal system error occurred. Try again later.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"8754EE08-4AA2-5F77-ADD7-754DBBDA9F75\\",\\n \\"Data\\": \\"{\'TotalCount\': 0, \'CalcEngines\': []}\\",\\n \\"ErrMsg\\": \\"success\\",\\n \\"ErrCode\\": \\"0\\"\\n}","type":"json"}]', + 'title' => 'GetDataServiceContextUpdateEvent', + ], + 'GetDataServiceConnection' => [ + 'summary' => '新server独享资源组获取数据源信息。', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '259634', + 'abilityTreeNodes' => [ + 'FEATUREdideWDSR97', + ], + ], + 'parameters' => [ + [ + 'name' => 'ConnectionId', + 'in' => 'query', + 'schema' => [ + 'description' => '数据源id', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'DataSourceType', + 'in' => 'query', + 'schema' => [ + 'description' => '数据源类型', + 'type' => 'string', + 'required' => false, + 'example' => 'normal', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request', + 'type' => 'string', + 'example' => '123-abc', + ], + 'Data' => [ + 'description' => '数据源信息', + 'type' => 'string', + 'example' => '{}', + ], + 'ErrMsg' => [ + 'description' => '错误信息', + 'type' => 'string', + 'example' => 'success', + ], + 'ErrCode' => [ + 'description' => '错误码', + 'type' => 'string', + 'example' => '0', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"123-abc\\",\\n \\"Data\\": \\"{}\\",\\n \\"ErrMsg\\": \\"success\\",\\n \\"ErrCode\\": \\"0\\"\\n}","type":"json"}]', + 'title' => '查询数据源信息', + ], + 'GetDataServiceApiAuthMapContext' => [ + 'summary' => '新server独享资源组获取api context。', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '259344', + 'abilityTreeNodes' => [ + 'FEATUREdideWDSR97', + ], + ], + 'parameters' => [ + [ + 'name' => 'ApiId', + 'in' => 'query', + 'schema' => [ + 'description' => 'API ID', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'Verbose', + 'in' => 'query', + 'schema' => [ + 'description' => '是否查询详细信息', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'ProjectId', + 'in' => 'query', + 'schema' => [ + 'description' => 'DataWorks项目空间id', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'ApiPath', + 'in' => 'query', + 'schema' => [ + 'description' => 'API 路径', + 'type' => 'string', + 'required' => false, + 'example' => '/apiPath', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'Data' => [ + 'description' => 'API 信息', + 'type' => 'string', + 'example' => '{}', + ], + 'ErrMsg' => [ + 'description' => '错误信息', + 'type' => 'string', + 'example' => 'success', + ], + 'ErrCode' => [ + 'description' => '错误码', + 'type' => 'string', + 'example' => '0', + ], + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request', + 'type' => 'string', + 'example' => '123-abc', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": \\"{}\\",\\n \\"ErrMsg\\": \\"success\\",\\n \\"ErrCode\\": \\"0\\",\\n \\"RequestId\\": \\"123-abc\\"\\n}","type":"json"}]', + 'title' => '查询API内容信息', + ], + 'GetDataServiceFunction' => [ + 'summary' => '查询函数信息。', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '260794', + 'abilityTreeNodes' => [ + 'FEATUREdideSYX560', + ], + ], + 'parameters' => [ + [ + 'name' => 'FunctionId', + 'in' => 'query', + 'schema' => [ + 'description' => '函数ID', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'Data' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request', + 'type' => 'string', + 'example' => '{}', + ], + 'ErrMsg' => [ + 'description' => '错误信息', + 'type' => 'string', + 'example' => 'success', + ], + 'ErrCode' => [ + 'description' => '错误码', + 'type' => 'string', + 'example' => '0', + ], + 'RequestId' => [ + 'description' => 'RequestId', + 'type' => 'string', + 'example' => 'abc-123', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": \\"{}\\",\\n \\"ErrMsg\\": \\"success\\",\\n \\"ErrCode\\": \\"0\\",\\n \\"RequestId\\": \\"abc-123\\"\\n}","type":"json"}]', + 'title' => '查询函数信息', + ], + ], + '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', + ], + ], +]; diff --git a/data/zh_cn/dataworks-public/2020-05-18/api-docs.php b/data/zh_cn/dataworks-public/2020-05-18/api-docs.php new file mode 100644 index 0000000..c45acf8 --- /dev/null +++ b/data/zh_cn/dataworks-public/2020-05-18/api-docs.php @@ -0,0 +1,66429 @@ +<?php return [ + 'version' => '1.0', + 'info' => [ + 'style' => 'RPC', + 'product' => 'dataworks-public', + 'version' => '2020-05-18', + ], + 'directories' => [ + [ + 'id' => 120438, + 'title' => '租户', + 'type' => 'directory', + 'children' => [ + 'ListCalcEngines', + 'CreateDataSource', + 'ListDataSources', + 'UpdateDataSource', + 'DeleteDataSource', + 'ListResourceGroups', + 'GetProject', + 'AddProjectMemberToRole', + 'CreateProjectMember', + 'DeleteProjectMember', + 'ListProjectRoles', + 'RemoveProjectMemberFromRole', + 'ListProjectMembers', + 'ListProjects', + 'ListProjectIds', + 'CreateProject', + 'ChangeResourceManagerResourceGroup', + 'ListMeasureData', + ], + ], + [ + 'id' => 120453, + 'title' => '元数据', + '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' => '数据开发', + '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' => '数据集成', + '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' => '数据建模', + 'type' => 'directory', + 'children' => [ + 'QueryPublicModelEngine', + ], + ], + [ + 'id' => 120540, + 'title' => '运维中心', + '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' => '数据质量', + 'type' => 'directory', + 'children' => [ + 'UpdateQualityFollower', + 'UpdateQualityRule', + 'GetQualityRule', + 'ListQualityRules', + 'CreateQualityRule', + 'DeleteQualityFollower', + 'DeleteQualityRule', + 'GetQualityFollower', + 'CreateQualityFollower', + 'DeleteQualityEntity', + 'GetQualityEntity', + 'CreateQualityEntity', + 'CreateQualityRelativeNode', + 'DeleteQualityRelativeNode', + 'ListQualityResultsByEntity', + 'ListQualityResultsByRule', + ], + ], + [ + 'id' => 120604, + 'title' => '数据服务', + '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' => '数据保护伞', + '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' => '迁移助手', + 'type' => 'directory', + 'children' => [ + 'CreateImportMigration', + 'GetMigrationProcess', + 'StartMigration', + 'CreateExportMigration', + 'GetMigrationSummary', + 'ListMigrations', + ], + ], + [ + 'id' => 191821, + 'title' => '安全中心', + 'type' => 'directory', + 'children' => [ + 'CreatePermissionApplyOrder', + 'GetPermissionApplyOrderDetail', + 'ListPermissionApplyOrders', + 'ApprovePermissionApplyOrder', + 'RevokeTablePermission', + 'RevokeTablePermission', + ], + ], + [ + 'id' => 166724, + 'title' => '开放平台', + 'type' => 'directory', + 'children' => [ + 'ListExtensions', + 'GetExtension', + 'GetOptionValueForProject', + 'ListEnabledExtensionsForProject', + 'CallbackExtension', + 'ListCheckProcesses', + 'ListCheckProcesses', + ], + ], + [ + 'id' => 191836, + 'title' => '其他', + 'type' => 'directory', + 'children' => [ + 'UpdateTableAddColumn', + 'GetMetaTableFullInfo', + 'GetDDLJobStatus', + 'DeleteTable', + 'UpdateTable', + 'CreateTable', + 'CheckFileDeployment', + 'ListRefDISyncTasks', + 'ExportDataSources', + 'ImportDataSources', + 'UpdateClusterConfigs', + 'ListClusterConfigs', + 'ListClusters', + ], + ], + [ + 'id' => 120626, + 'title' => '废弃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' => '注册到 DataWorks 的集群的信息。', + 'type' => 'object', + 'properties' => [ + 'ClusterId' => [ + 'title' => 'Cluster ID Generated by DataWorks', + 'description' => 'DataWorks 生成的集群 ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1234', + ], + 'ClusterBizId' => [ + 'title' => 'Cluster Business Identifier', + 'description' => '集群的业务唯一标识。', + 'type' => 'string', + 'required' => true, + 'example' => 'c-d8a7523****', + ], + ], + ], + 'ClusterConfig' => [ + 'title' => 'Cluster config', + 'description' => '集群配置信息。', + 'type' => 'object', + 'properties' => [ + 'ModuleName' => [ + 'title' => 'DataWorks module name', + 'description' => '配置在哪个模块生效，支持的模块如下：'."\n" + .'- scheduler.test：运维中心 - 测试实例。'."\n" + .'- scheduler.manual：运维中心 - 手动实例。'."\n" + .'- ide：DataStudio（数据开发）。'."\n" + .'- scheduler.backfill：运维中心 - 补数据实例。'."\n" + .'- da：数据分析。'."\n" + .'- scheduler.auto：运维中心 - 周期实例。', + 'type' => 'string', + 'enumValueTitles' => [], + 'example' => 'ide', + ], + 'ConfigValue' => [ + 'title' => 'Config value', + 'description' => '配置值。', + 'type' => 'string', + 'example' => '{"spark.driver.memory":"1g"}', + ], + 'EnableOverwrite' => [ + 'title' => 'Whether to overwrite node config', + 'description' => '是否覆盖数据开发中节点的高级设置：'."\n" + .'- true（覆盖）'."\n" + .'- false（不覆盖）', + 'type' => 'boolean', + 'enumValueTitles' => [], + 'example' => 'false', + ], + ], + ], + 'Collection' => [ + 'title' => 'Definition of Collection', + 'description' => '集合定义。', + 'type' => 'object', + 'properties' => [ + 'QualifiedName' => [ + 'title' => 'Unique identifier of identity', + 'description' => '集合唯一标识。', + 'type' => 'string', + 'example' => 'album.12334', + ], + 'CollectionType' => [ + 'title' => 'Collection Type', + 'description' => '集合类型。'."\n" + .'- **ALBUM**：专辑类型。'."\n" + .'- **ALBUM_CATEGORY**：专辑中的子类目类型。', + 'type' => 'string', + 'example' => 'album', + ], + 'Name' => [ + 'title' => 'The name of the collection', + 'description' => '集合名称。', + 'type' => 'string', + 'example' => 'collectionName', + ], + 'Comment' => [ + 'title' => 'The comment of the collection', + 'description' => '备注信息。', + 'type' => 'string', + 'example' => 'comment', + ], + 'OwnerId' => [ + 'title' => 'The ownerId of the collection', + 'description' => '集合所属人ID（阿里云账号ID）。', + 'type' => 'string', + 'example' => '1234444', + ], + 'OwnerName' => [ + 'title' => 'The name of the collection owner', + 'description' => '集合所属人名称。', + 'type' => 'string', + 'example' => 'owner', + ], + 'CreateTime' => [ + 'title' => 'The create timestamp of the collection', + 'description' => '创建时间。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1668600147617', + ], + 'UpdateTime' => [ + 'title' => 'The update timestamp of the collection', + 'description' => '更新时间。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1668600148617', + ], + 'Level' => [ + 'title' => 'The level of the collection', + 'description' => '集合层级。'."\n" + .'只有ALBUM_CATEGORY类型会返回该参数，目前支持4层。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + ], + ], + 'Entity' => [ + 'title' => 'Definition of Entity', + 'description' => '实体定义。', + 'type' => 'object', + 'properties' => [ + 'QualifiedName' => [ + 'title' => 'Unique identifier of identity', + 'description' => '实体唯一标识。'."\n" + .'例如：maxcompute-table.projectA.tableB', + 'type' => 'string', + 'example' => 'maxcompute_table.563f0357118d05ef145d6bddf2966cc23e86ca8f2f013f915e565afdf09f7a23', + ], + 'TenantId' => [ + 'title' => 'Identifier of tenant', + 'description' => '租户ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '12345', + ], + 'EntityContent' => [ + 'title' => 'Attribute map', + 'description' => '实体的其他属性。包括：'."\n" + .'- **entityType**：实体类型。例如，maxcompute-table、emr-table等。'."\n" + .'- **name**：实体名称。'."\n" + .'- **projectName**：MaxCompute项目名称。', + 'type' => 'object', + ], + ], + ], + 'LineageEntityVO' => [ + 'title' => 'Definition of entity in lineage', + 'description' => '注册血缘时的实体对象', + 'type' => 'object', + 'properties' => [ + 'QualifiedName' => [ + 'title' => 'Unique identifier of entity', + 'description' => 'Unique identifier of entity', + 'type' => 'string', + 'example' => 'maxcompute-table.projectName.tablename', + ], + 'Name' => [ + 'title' => 'Name of entity', + 'description' => 'Name of entity', + 'type' => 'string', + 'example' => 'tableName', + ], + 'ParentName' => [ + 'title' => 'Parent name of entity', + 'description' => 'Parent name of entity', + 'type' => 'string', + 'example' => 'dbName', + ], + 'DetailUrl' => [ + 'title' => 'Detail url of entity', + 'description' => 'Detail url of entity', + 'type' => 'string', + 'example' => 'http://domain.test.url/entity', + ], + 'EntityType' => [ + 'title' => 'Entity type', + 'description' => 'Entity type', + 'type' => 'string', + 'example' => 'maxcompute-table', + ], + 'Owner' => [ + 'title' => 'Owner', + 'description' => 'Owner', + 'type' => 'string', + 'example' => 'owner', + ], + 'Attributes' => [ + 'title' => 'Other attributes', + 'description' => 'Other attributes', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'string', + ], + 'example' => 'attribute map', + ], + ], + ], + 'LineageRelationRegisterBulkVO' => [ + 'title' => 'A short description of struct', + 'type' => 'object', + 'properties' => [ + 'SrcEntities' => [ + 'title' => 'All source entities', + 'type' => 'array', + 'items' => [ + '$ref' => '#/components/schemas/LineageEntityVO', + ], + ], + 'DestEntities' => [ + 'title' => 'All destination entities', + 'type' => 'array', + 'items' => [ + '$ref' => '#/components/schemas/LineageEntityVO', + ], + ], + 'Relationship' => [ + 'title' => 'relationship between entities', + '$ref' => '#/components/schemas/RelationshipVO', + ], + 'CreateTimestamp' => [ + 'title' => 'The time of lineage relation generation', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1684327487964', + ], + ], + ], + 'LineageRelationRegisterTaskVO' => [ + 'title' => 'A short description of struct', + 'type' => 'object', + 'properties' => [ + 'InputEntities' => [ + 'title' => 'All input entities', + 'type' => 'array', + 'items' => [ + '$ref' => '#/components/schemas/LineageEntityVO', + ], + ], + 'OutputEntities' => [ + 'title' => 'All output entities', + 'type' => 'array', + 'items' => [ + '$ref' => '#/components/schemas/LineageEntityVO', + ], + ], + 'CreateTimestamp' => [ + 'title' => 'The time of lineage relation generation', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1684327487964', + ], + 'QualifiedName' => [ + 'title' => 'Unique identifier of entity', + 'type' => 'string', + 'example' => 'pai_dlcjob-task.12304', + ], + 'Name' => [ + 'title' => 'Task name', + 'type' => 'string', + 'example' => 'pai-task name', + ], + 'Attributes' => [ + 'title' => 'Other task attributes', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'string', + 'example' => 'owner', + ], + ], + ], + ], + 'LineageRelationRegisterVO' => [ + 'title' => 'Lineage relation register struct', + 'description' => '血缘关系注册结构体', + 'type' => 'object', + 'properties' => [ + 'SrcEntity' => [ + 'title' => 'The source entity in lineage relation', + 'description' => 'The source entity in lineage relation', + '$ref' => '#/components/schemas/LineageEntityVO', + ], + 'DestEntity' => [ + 'title' => 'The destination entity in lineage relation', + 'description' => 'The destination entity in lineage relation', + '$ref' => '#/components/schemas/LineageEntityVO', + ], + 'Relationship' => [ + 'title' => 'The relationship between entities', + 'description' => 'The relationship between entities', + '$ref' => '#/components/schemas/RelationshipVO', + ], + 'CreateTimestamp' => [ + 'title' => 'The time of lineage relation generation', + 'description' => 'The time of lineage relation generation', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1684327487964', + ], + ], + ], + 'RelationshipVO' => [ + 'title' => 'relationship info', + 'description' => '实体关系结构体', + 'type' => 'object', + 'properties' => [ + 'RelationshipType' => [ + 'title' => 'Type name of relationship', + 'description' => 'Type name of relationship', + 'type' => 'string', + 'example' => 'sql', + ], + 'RelationshipGuid' => [ + 'title' => 'Relationship uniqId', + 'description' => 'Relationship uniqId', + 'type' => 'string', + ], + 'Attributes' => [ + 'title' => 'other attribute', + 'description' => 'other attribute', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'string', + 'example' => 'key-value', + ], + ], + ], + ], + 'UserEntityTag' => [ + 'title' => '标签', + 'description' => '标签', + 'type' => 'object', + 'properties' => [ + 'TagKey' => [ + 'title' => '标签 Key', + 'description' => '标签 Key', + 'type' => 'string', + 'example' => 'priority', + ], + 'TagValue' => [ + 'title' => '标签 Value', + 'description' => '标签 Value', + 'type' => 'string', + 'example' => 'p1', + ], + ], + ], + ], + ], + 'apis' => [ + 'ListCalcEngines' => [ + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'ProjectId', + 'in' => 'query', + 'schema' => [ + 'description' => '数据源所属的DataWorks工作空间。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + 'example' => '466230'."\n", + ], + ], + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => [ + 'description' => '查询的数据源名称，精确匹配。', + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => 'test_mc', + ], + ], + [ + 'name' => 'CalcEngineType', + 'in' => 'query', + 'schema' => [ + 'description' => '查询的数据源类型。目前范围如下，不区分大小写。'."\n" + .'- **ODPS**'."\n" + .'- **EMR**'."\n" + .'- **BLINK**'."\n" + .'- **HOLO**'."\n" + .'- **MaxGraph**'."\n" + .'- **HYBRIDDB_FOR_POSTGRESQL**'."\n" + .'- **ADB_MYSQL**'."\n" + .'- **HADOOP_CDH**'."\n" + .'- **CLICKHOUSE**', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ODPS', + ], + ], + [ + 'name' => 'EnvType', + 'in' => 'query', + 'schema' => [ + 'description' => '数据源所属的环境。'."\n" + .'- **DEV**：开发环境'."\n" + .'- **PRD**：生产环境。', + 'type' => 'string', + 'required' => false, + 'example' => 'PRD', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '分页查询时每页显示的数据量，默认为10条，最大100条。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '分页查询的页码。大于等于1的正整数，默认为1。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => [ + 'description' => '请求返回码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '1AFAE64E-D1BE-432B-A9****', + ], + 'Success' => [ + 'description' => '请求是否成功，取值如下：'."\n" + .'- **true**：请求成功。'."\n" + .'- **false**：请求失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Data' => [ + 'description' => '分页查询结果。', + 'type' => 'object', + 'properties' => [ + 'PageNumber' => [ + 'description' => '页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '每页显示的条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + 'TotalCount' => [ + 'description' => '数据源的总数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'CalcEngines' => [ + 'description' => '数据源列表。', + 'type' => 'array', + 'items' => [ + 'description' => '数据源信息。', + 'type' => 'object', + 'properties' => [ + 'BindingProjectName' => [ + 'description' => '数据源关联的工作空间名称。', + 'type' => 'string', + 'example' => 'test_project', + ], + 'IsDefault' => [ + 'description' => '是否为当前类型的默认数据源。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'EngineId' => [ + 'description' => '数据源ID。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '35', + ], + 'DwRegion' => [ + 'description' => '数据源关联的DataWorks工作空间所在的地域。', + 'type' => 'string', + 'example' => 'cn-zhangjiakou', + ], + 'TaskAuthType' => [ + 'description' => '数据源的访问身份。'."\n" + .'- **USER**：当前用户。'."\n" + .'- **PROJECT**：项目执行用户。'."\n" + .'- **SUBACCOUNT**：子账号。'."\n" + .'- **STS_ROLE**：STS角色。', + 'type' => 'string', + 'example' => 'PROJECT', + ], + 'CalcEngineType' => [ + 'description' => '数据源类型。', + 'type' => 'string', + 'example' => 'ODPS', + ], + 'EngineInfo' => [ + 'description' => '数据源的详细信息。'."\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' => '{'."\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" + .'}', + ], + 'EnvType' => [ + 'description' => '数据源所在的环境。'."\n" + .'- **DEV**：开发环境。'."\n" + .'- **PRD**：生产环境。', + 'type' => 'string', + 'example' => 'PRD', + ], + 'Region' => [ + 'description' => '数据源所在的地域。', + 'type' => 'string', + 'example' => 'cn-zhangjiakou', + ], + 'GmtCreate' => [ + 'description' => '数据源的创建时间。', + 'type' => 'string', + 'example' => 'Oct 10, 2019 3:42:44 PM', + ], + 'BindingProjectId' => [ + 'description' => '数据源所在的工作空间ID。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '466230', + ], + 'Name' => [ + 'description' => '数据源的显示名称。', + 'type' => 'string', + 'example' => 'test_mc', + ], + 'TenantId' => [ + 'description' => '租户ID。', + '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' => '查看数据开发中绑定的数据源列表', + 'summary' => '该接口用于查询指定DataWorks工作空间的数据开发中绑定的数据源列表。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'CreateDataSource' => [ + 'summary' => '该接口用于创建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' => '数据源所在的DataWorks工作空间ID。您可以通过[ListProjects](~~2780068~~)接口获取工作空间ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + 'example' => '1', + ], + ], + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => [ + 'description' => '数据源的名称。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'abc', + ], + ], + [ + 'name' => 'Description', + 'in' => 'query', + 'schema' => [ + 'description' => '数据源的描述信息。', + 'type' => 'string', + 'required' => false, + 'example' => 'abc', + ], + ], + [ + 'name' => 'DataSourceType', + 'in' => 'query', + 'schema' => [ + 'description' => '数据源的类型。常用类型如下：'."\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', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'rds', + ], + ], + [ + 'name' => 'SubType', + 'in' => 'query', + 'schema' => [ + 'description' => '数据源的子类型。使用如下：'."\n" + ."\n" + .'- 当DataSourceType参数配置为RDS时，SubType参数生效。'."\n" + .'- 如果DataSourceType参数配置为RDS，SubType参数支持配置为mysql、sqlserver或postgresql。', + 'type' => 'string', + 'required' => false, + 'example' => 'mysql', + ], + ], + [ + 'name' => 'EnvType', + 'in' => 'query', + 'schema' => [ + 'description' => '数据源所属的环境，包括0（开发环境）和1（生产环境）。'."\n" + ."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'docRequired' => true, + 'example' => '1', + ], + ], + [ + 'name' => 'Content', + 'in' => 'query', + 'schema' => [ + 'description' => '数据源的详细信息。部分常用数据源样例如下：'."\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' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => [ + 'description' => '请求返回码。', + 'type' => 'string', + 'example' => '200', + ], + 'Data' => [ + 'description' => '数据源ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '123', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '0bc141151593763****', + ], + 'Success' => [ + 'description' => '请求是否成功。', + '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' => '创建数据源', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'ListDataSources' => [ + 'summary' => '该接口用于查询DataWorks的数据源列表。', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + ], + 'parameters' => [ + [ + 'name' => 'ProjectId', + 'in' => 'query', + 'schema' => [ + 'description' => '数据源所在的DataWorks工作空间ID。您可以通过[ListProjects](~~2780068~~)接口获取工作空间ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + 'example' => '1', + ], + ], + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => [ + 'description' => '查询的数据源名称。', + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => 'test', + ], + ], + [ + 'name' => 'DataSourceType', + 'in' => 'query', + 'schema' => [ + 'description' => '数据源的类型。常用的类型如下：'."\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', + 'type' => 'string', + 'required' => false, + 'example' => 'rds', + ], + ], + [ + 'name' => 'SubType', + 'in' => 'query', + 'schema' => [ + 'description' => '数据源的子类型。仅当DataSourceType参数配置为RDS时，该参数生效。'."\n" + ."\n" + .'当DataSourceType参数配置为RDS时，该参数可以配置为mysql、sqlserver或postgresql。', + 'type' => 'string', + 'required' => false, + 'example' => 'mysql', + ], + ], + [ + 'name' => 'Status', + 'in' => 'query', + 'schema' => [ + 'description' => '数据源的状态。取值如下：'."\n" + .'- ENABLED，正常。'."\n" + .'- DISABLED，禁用。', + 'type' => 'string', + 'required' => false, + 'example' => 'ENABLED', + ], + ], + [ + 'name' => 'EnvType', + 'in' => 'query', + 'schema' => [ + 'description' => '数据源所属的环境，包括0（开发环境）和1（生产环境）。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '每页显示的条数，默认为10条，最大为100条。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '分页查询的页码。取值为大于等于1的正整数。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => [ + 'description' => '请求返回码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '0bc14115159376359****', + ], + 'Success' => [ + 'description' => '请求是否成功。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Data' => [ + 'description' => '数据源的查询结果。', + 'type' => 'object', + 'properties' => [ + 'PageNumber' => [ + 'description' => '页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '每页显示的条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + 'TotalCount' => [ + 'description' => '数据源的总数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '233', + ], + 'DataSources' => [ + 'description' => '数据源列表。', + 'type' => 'array', + 'items' => [ + 'description' => '数据源详情。', + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => '数据源的状态。取值如下：'."\n" + .'- 1：表示数据源正常使用。'."\n" + .'- 2：表示数据源已禁用。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'ProjectId' => [ + 'description' => '数据源关联的工作空间ID。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '123', + ], + 'SubType' => [ + 'description' => '数据源的子类型。仅当DataSourceType参数配置为RDS时，该参数生效。', + 'type' => 'string', + 'example' => 'mysql', + ], + 'GmtModified' => [ + 'description' => '修改数据源的时间。时间格式示例为Mar 17, 2021 4:09:32 PM。', + 'type' => 'string', + 'example' => 'Mar 17, 2021 4:09:32 PM', + ], + 'EnvType' => [ + 'description' => '数据源所在的环境。取值如下：'."\n" + .'- 0：开发环境。'."\n" + .'- 1：生产环境。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'ConnectStatus' => [ + 'description' => '数据源的状态。取值如下：'."\n" + .'- 1：表示数据源正常使用。'."\n" + .'- 2：表示数据源已禁用。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Sequence' => [ + 'description' => '排序字段。数据源按此字段从大到小排序。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '300', + ], + 'Description' => [ + 'description' => '数据源的描述信息。', + 'type' => 'string', + 'example' => 'a connection', + ], + 'DataSourceType' => [ + 'description' => '数据源的类型。常用类型如下：'."\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', + 'type' => 'string', + 'example' => 'rds', + ], + 'GmtCreate' => [ + 'description' => '创建数据源的时间。时间格式示例为Mar 17, 2021 4:09:32 PM。', + 'type' => 'string', + 'example' => 'Mar 17, 2021 4:09:32 PM', + ], + 'DefaultEngine' => [ + 'description' => '数据源关联的引擎是否为同类型数据源选用的默认引擎。', + 'type' => 'boolean', + 'example' => 'false', + ], + 'Shared' => [ + 'description' => '是否为共享的数据源。', + 'type' => 'boolean', + 'example' => 'false', + ], + 'Operator' => [ + 'description' => '最近一次修改数据源的阿里云用户ID。'."\n" + ."\n", + 'type' => 'string', + 'example' => '193543050****', + ], + 'Name' => [ + 'description' => '数据源的名称。', + 'type' => 'string', + 'example' => 'abc', + ], + 'Content' => [ + 'description' => '数据连接串的相关信息。格式为JSON格式。常用的数据源对应的连接串样例如下：'."\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' => '数据源ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'BindingCalcEngineId' => [ + 'description' => '数据源关联的计算引擎ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '123', + ], + 'TenantId' => [ + 'description' => '租户ID。', + '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' => '查询数据源列表', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'UpdateDataSource' => [ + 'summary' => '该接口用于更新数据源。', + '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' => '数据源的描述信息。', + 'type' => 'string', + 'required' => false, + 'example' => 'xxx', + ], + ], + [ + 'name' => 'EnvType', + 'in' => 'query', + 'schema' => [ + 'description' => '数据源所在的环境。取值如下：'."\n" + .'- 0：开发环境。'."\n" + .'- 1：生产环境。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'docRequired' => true, + 'example' => '1', + ], + ], + [ + 'name' => 'Content', + 'in' => 'query', + 'schema' => [ + 'description' => '需要修改的目标数据源的详细信息。'."\n" + .'不支持修改数据源的类型，例如，您不可以修改odps类型的数据源为MySQL类型。'."\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":"*****","accessKey":"*****","authType":2,"endpoint":"http://service.odps.aliyun.com/api","project":"xsaxsax","tag":"public"}', + ], + ], + [ + 'name' => 'Status', + 'in' => 'query', + 'schema' => [ + 'description' => '数据源的状态。该字段已废弃，请勿使用。', + 'type' => 'string', + 'required' => false, + 'example' => 'ENABLED', + ], + ], + [ + 'name' => 'DataSourceId', + 'in' => 'query', + 'schema' => [ + 'description' => '需要更新的数据源ID，您可以调用[ListDataSources](~~2780072~~)获取数据源的ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + 'example' => '1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => [ + 'description' => '请求返回码。', + 'type' => 'string', + 'example' => '200', + ], + 'Data' => [ + 'description' => '是否成功更新数据源。'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '0bc14115159376359****', + ], + 'Success' => [ + 'description' => '请求是否成功。', + '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' => '更新数据源', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DeleteDataSource' => [ + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'DataSourceId', + 'in' => 'query', + 'schema' => [ + 'description' => '数据源ID，您可以调用[ListDataSources](~~211431~~)获取数据源的ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + 'example' => '1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => [ + 'description' => '请求返回码。', + 'type' => 'string', + 'example' => '200', + ], + 'Data' => [ + 'description' => '是否成功删除数据源。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '0bc1411515937635****', + ], + 'Success' => [ + 'description' => '请求是否成功。', + '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' => '删除数据源', + 'summary' => '该接口用于删除数据源。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'ListResourceGroups' => [ + 'summary' => '该接口用于查看指定类型的资源组列表。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'ResourceGroupType', + 'in' => 'query', + 'schema' => [ + 'description' => '需要查看的资源组类型ID。取值如下：'."\n" + .'- 0（DataWorks）'."\n" + .'- 1（调度）'."\n" + .'- 2（MaxCompute）'."\n" + .'- 3（PAI）'."\n" + .'- 4（数据集成）'."\n" + .'- 7 （下单购买独享调度资源组时，生成的购买资源ID）'."\n" + .'- 9 （dataService）'."\n" + .'- 默认取值为1（调度）。'."\n" + ."\n" + .'当取值表示引擎时，查看的资源组列表为购买该类型引擎时创建的资源组列表。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'docRequired' => true, + 'example' => '3', + ], + ], + [ + 'name' => 'Keyword', + 'in' => 'query', + 'schema' => [ + 'description' => '关键字。用于模糊查询资源组名称和资源组标识。', + 'type' => 'string', + 'required' => false, + 'example' => 'abc', + ], + ], + [ + 'name' => 'BizExtKey', + 'in' => 'query', + 'schema' => [ + 'description' => '资源组的类别。取值如下：'."\n" + .'- default：默认值，公共资源组。'."\n" + .'- single：独享资源组。', + 'type' => 'string', + 'required' => false, + 'example' => 'default', + ], + ], + [ + 'name' => 'ResourceManagerResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '资源组ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'rg-acfmzbn7pti3zfa', + ], + ], + [ + 'name' => 'Tags', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '标签列表。', + 'type' => 'array', + 'items' => [ + 'description' => '标签信息。', + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => '标签键。', + 'type' => 'string', + 'required' => false, + 'example' => 'Env', + ], + 'Value' => [ + 'description' => '标签值。', + 'type' => 'string', + 'required' => false, + 'example' => 'Test', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 20, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => [ + 'description' => '请求返回码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '0bc1411515937635973****', + ], + 'Success' => [ + 'description' => '请求是否成功。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Data' => [ + 'description' => '资源组列表。', + 'type' => 'array', + 'items' => [ + 'description' => '资源组详情。', + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => '资源组的状态。取值如下：'."\n" + .'- NORMAL(0)，表示资源组状态正常，处于运行中或服务中。'."\n" + .'- STOP(1)，表示资源组已到期，处于冻结状态。'."\n" + .'- DELETED(2)，表示资源组已被释放或销毁。'."\n" + .'- CREATING(3)，表示资源组正在创建或启动。'."\n" + .'- CREATE_FAILED(4)，表示资源组创建或启动失败。'."\n" + .'- UPDATING(5)，表示资源组正在扩容或升级。'."\n" + .'- UPDATE_FAILED(6)，表示资源组扩容或升级失败。'."\n" + .'- DELETING(7)，表示资源组正在被释放或销毁。'."\n" + .'- DELETE_FAILED(8)，表示资源组释放或销毁失败。'."\n" + .'- TIMEOUT(9)，表示对资源组执行的操作超时。所有变更操作均可能会超时，该枚举值暂时仅提供给数据服务使用。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'UpdateTime' => [ + 'description' => '最近一次更新资源组的时间。', + 'type' => 'string', + 'example' => 'Jul 9, 2018 2:43:37 PM', + ], + 'IsDefault' => [ + 'description' => '是否为默认资源组。取值如下：'."\n" + .'- true：是默认资源组。'."\n" + .'- false：非默认资源组。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Cluster' => [ + 'description' => '集群的名称。该参数仅对于MaxCompute和PAI资源组类型生效。', + 'type' => 'string', + 'example' => 'AY18G', + ], + 'EnableKp' => [ + 'description' => '是否使用Kp（关键人）访问。取值如下：'."\n" + .'- true：表示MaxCompute引擎使用阿里云账号UID作为访问账户的显示名称。'."\n" + .'- false：表示MaxCompute引擎使用阿里云账号名称作为访问账户的显示名称。'."\n" + .'其余类型无意义。该参数仅对MaxCompute引擎生效。'."\n", + 'type' => 'boolean', + 'example' => 'false', + ], + 'ResourceGroupType' => [ + 'description' => '资源组的类型。取值如下：'."\n" + .'- 0（DataWorks）'."\n" + .'- 2（MaxCompute）'."\n" + .'- 3（PAI）'."\n" + .'- 4（数据集成）'."\n" + .'- 7（调度）'."\n" + .'- 9 （dataService）', + 'type' => 'string', + 'example' => '3', + ], + 'CreateTime' => [ + 'description' => '创建集群的时间。格式示例为Jul 9, 2018 2:43:37 PM。', + 'type' => 'string', + 'example' => 'Jul 9, 2018 2:43:37 PM', + ], + 'Identifier' => [ + 'description' => '资源组的标识。', + 'type' => 'string', + 'example' => 'e1815577-2f4e-4c5e-b29****', + ], + 'Mode' => [ + 'description' => '资源组的类型。取值如下：'."\n" + .'- ISOLATE：表示预付费的独享资源组。'."\n" + .'- SHARE：表示后付费的公共资源组。'."\n" + .'- DEVELOP：表示开发者版本。', + 'type' => 'string', + 'example' => 'SHARE', + ], + 'BizExtKey' => [ + 'description' => '资源组的类别。取值如下：'."\n" + .'- default，公共资源组。'."\n" + .'- single，独享资源组。', + 'type' => 'string', + 'example' => 'default', + ], + 'Sequence' => [ + 'description' => '序列字段。用于将已创建的资源组按照创建的序号从小到大升序排序。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '300', + ], + 'Specs' => [ + 'description' => '资源组的详细信息。{}中显示的内容为资源组的详细信息。', + 'type' => 'object', + 'example' => '{}', + ], + 'Name' => [ + 'description' => '资源组的名称。', + 'type' => 'string', + 'example' => 'abc', + ], + 'Id' => [ + 'description' => '资源组的ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1234567', + ], + 'TenantId' => [ + 'description' => '租户ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1234567', + ], + 'ResourceManagerResourceGroupId' => [ + 'description' => '资源组ID。', + 'type' => 'string', + 'example' => 'rg-acfmzbn7pti3zfa', + ], + 'Tags' => [ + 'description' => '标签列表。', + 'type' => 'array', + 'items' => [ + 'description' => '标签信息。', + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => '标签键。', + 'type' => 'string', + 'example' => 'Env', + ], + 'Value' => [ + 'description' => '标签值。', + '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' => '查看资源组列表', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'GetProject' => [ + 'summary' => '该接口用于查询一个DataWorks工作空间的详细信息。', + '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' => 'DataWorks工作空间ID。'."\n" + .'您可以通过[ListProjects](~~2780068~~)接口获取工作空间ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'docRequired' => true, + 'example' => '466230', + ], + ], + [ + 'name' => 'ProjectIdentifier', + 'in' => 'query', + 'schema' => [ + 'description' => 'DataWorks工作空间的名称。您可以通过[ListProjects](~~2780068~~)接口获取工作空间的名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'test_project', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => [ + 'description' => '请求返回码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '1AFAE64E-D1BE-432B-A9****', + ], + 'Success' => [ + 'description' => '请求是否成功，取值如下：'."\n" + .'- **true**：请求成功。'."\n" + .'- **false**：请求失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Data' => [ + 'description' => '工作空间的详细信息。', + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => '工作空间的状态，取值如下：'."\n" + .'- **0**：AVAILABLE，工作空间运行正常。'."\n" + .'- **1**：DELETED，工作空间已被删除。'."\n" + .'- **2**：INITIALIZING，初始化工作空间。'."\n" + .'- **3**：INIT_FAILED，工作空间初始化失败。'."\n" + .'- **4**：FORBIDDEN，手动禁用工作空间。'."\n" + .'- **5**：DELETING，正在删除工作空间。'."\n" + .'- **6**：DEL_FAILED，工作空间删除失败。'."\n" + .'- **7**：FROZEN，工作空间欠费冻结。'."\n" + .'- **8**：UPDATING，更新工作空间（为工作空间添加并初始化计算引擎）。'."\n" + .'- **9**：UPDATE_FAILED，更新工作空间（为工作空间添加并初始化计算引擎）失败。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'MaxFlowNode' => [ + 'description' => '该参数已废弃。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'ProjectId' => [ + 'description' => '工作空间的ID。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '466230', + ], + 'IsAllowDownload' => [ + 'description' => '是否允许下载ide上查询的结果，取值如下：'."\n" + .'- **1**：允许下载。'."\n" + .'- **0**：不允许下载。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'ProjectMode' => [ + 'description' => '工作空间的模式，取值如下：'."\n" + .'- **2**：表示简单工作空间模式。'."\n" + .'- **3**：表示标准工作空间模式。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'GmtModified' => [ + 'description' => '修改工作空间的时间，示例格式为`Dec 3, 2019 9:12:20 PM`。', + 'type' => 'string', + 'example' => 'Dec 3, 2019 9:12:20 PM', + ], + 'ProdStorageQuota' => [ + 'description' => '该参数已废弃。', + 'type' => 'string', + 'example' => ' 1', + ], + 'ProjectDescription' => [ + 'description' => '工作空间的详细描述信息。', + 'type' => 'string', + 'example' => 'test_describe', + ], + 'DevelopmentType' => [ + 'description' => '该参数已废弃。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '4', + ], + 'TablePrivacyMode' => [ + 'description' => 'MaxCompute表的可见性权限，取值如下：'."\n" + .'- **0**：租户内用户不可见MaxCompute表。'."\n" + .'- **1**：租户内用户可见MaxCompute表。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'DefaultDiResourceGroupIdentifier' => [ + 'description' => '购买MaxCompute独享资源组时，默认分配的资源组的标识。', + 'type' => 'string', + 'example' => 'group_280749521****', + ], + 'SchedulerMaxRetryTimes' => [ + 'description' => '默认出错自动重跑的次数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '3', + ], + 'ProtectedMode' => [ + 'description' => '工作空间是否开启了保护模式，取值如下：'."\n" + .'- **1**：开启保护模式。'."\n" + .'- **0**：未开启保护模式。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'SchedulerRetryInterval' => [ + 'description' => '默认出错自动重跑的时间间隔，单位为ms。取值最大为30分钟，注意单位转换。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '120000', + ], + 'Appkey' => [ + 'description' => '该参数已废弃。', + 'type' => 'string', + 'example' => '0', + ], + 'DevStorageQuota' => [ + 'description' => '该参数已废弃。', + 'type' => 'string', + 'example' => '0', + ], + 'ResidentArea' => [ + 'description' => '工作空间的类型。'."\n" + .'- **private**：私有区'."\n" + .'- **swap**：交换区。', + 'type' => 'string', + 'example' => 'private', + ], + 'IsDefault' => [ + 'description' => '是否为默认工作空间，取值如下：'."\n" + .'- **1**：是。'."\n" + .'- **0**：否。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Destination' => [ + 'description' => '该参数已废弃。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'ProjectName' => [ + 'description' => '工作空间的显示名称。', + 'type' => 'string', + 'example' => 'test_project', + ], + 'ProjectIdentifier' => [ + 'description' => '工作空间的名称。', + 'type' => 'string', + 'example' => 'test_project', + ], + 'DisableDevelopment' => [ + 'description' => '是否禁用开发角色，取值如下：'."\n" + .' - **false**：默认值，开启开发角色。'."\n" + .' - **true**：禁用开发角色。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'ProjectOwnerBaseId' => [ + 'description' => '工作空间所有者的阿里云ID。', + 'type' => 'string', + 'example' => '18229311****', + ], + 'BaseProject' => [ + 'description' => '该参数已废弃。', + 'type' => 'boolean', + 'example' => 'false', + ], + 'UseProxyOdpsAccount' => [ + 'description' => '访问MaxCompute引擎是否使用代理账号。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'GmtCreate' => [ + 'description' => '创建工作空间时间，示例格式`Dec 3, 2019 9:12:20 PM`。', + 'type' => 'string', + 'example' => 'Oct 10, 2019 3:42:53 PM', + ], + 'TenantId' => [ + 'description' => '租户ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '280749521', + ], + 'EnvTypes' => [ + 'description' => '工作空间包含的环境信息。', + 'type' => 'array', + 'items' => [ + 'description' => '工作空间包含的环境：'."\n" + .'- 简单模式只有生产环境（**PROD**）。'."\n" + .'- 标准模式包含开发环境（**DEV**）和生产环境（**PROD**）。', + 'type' => 'string', + 'example' => '["PROD"]', + ], + ], + 'ResourceManagerResourceGroupId' => [ + 'description' => '资源组ID。', + 'type' => 'string', + 'example' => 'rg-acfmzbn7****', + ], + 'Tags' => [ + 'description' => '工作空间绑定的标签信息列表。', + 'type' => 'array', + 'items' => [ + 'description' => '标签信息详情。', + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => '标签键。', + 'type' => 'string', + 'example' => 'key', + ], + 'Value' => [ + 'description' => '标签值。', + 'type' => 'string', + 'example' => 'value', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + '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' => '查询工作空间详细信息', + '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' => 'DataWorks工作空间的ID。您可以通过[ListProjects](~~2780068~~)接口获取工作空间ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + 'maximum' => '10000000', + 'minimum' => '0', + 'example' => '27', + ], + ], + [ + 'name' => 'UserId', + 'in' => 'query', + 'schema' => [ + 'description' => '阿里云账号ID。您可以登录[DataWorks控制台](https://workbench.data.aliyun.com/console)，鼠标悬停至顶部菜单栏右侧的用户头像，查看账号ID。'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '1234', + ], + ], + [ + 'name' => 'RoleCode', + 'in' => 'query', + 'schema' => [ + 'description' => 'DataWorks工作空间角色的Code。您可以调用[ListProjectRoles](~~2780079~~)获取角色的Code。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'role_project_guest', + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'description' => '幂等字段，建议使用UUID。用于唯一标识此次调用操作。', + 'type' => 'string', + 'required' => false, + 'example' => '1AFAE64E-D1BE-432B-A9*****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求的ID。', + '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' => '添加工作空间用户至角色', + 'summary' => '该接口用于添加DataWorks工作空间用户至角色。使用该接口前，您需要先添加目标账号为DataWorks工作空间的成员。', + 'description' => '- 添加目标账号为DataWorks工作空间的成员，详情请参见[DataWorks工作空间添加成员](~~136941~~)。'."\n" + .'- 添加用户至DataWorks工作空间的预设角色时，会同步在该工作空间开发环境的MaxCompute项目中添加项目角色成员。详情请参见：[空间级预设角色与MaxCompute引擎权限的映射关系](~~449397~~)。', + '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' => 'DataWorks工作空间的ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + 'maximum' => '100000000', + 'minimum' => '0', + 'example' => '27', + ], + ], + [ + 'name' => 'UserId', + 'in' => 'query', + 'schema' => [ + 'description' => '待添加的用户ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '1234', + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'description' => '幂等串，建议使用UUID。', + 'type' => 'string', + 'required' => false, + 'example' => '1AFAE64E-D1BE-432B-A9****', + ], + ], + [ + 'name' => 'RoleCode', + 'in' => 'query', + 'schema' => [ + 'description' => '角色code，非必填，当不为空，则用户一并添加到此角色中。', + 'type' => 'string', + 'required' => false, + 'example' => 'role_project_guest', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + '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' => '添加一个用户至工作空间', + 'summary' => '该接口用于添加一个用户至DataWorks工作空间。', + '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' => 'DataWorks工作空间的ID。您可以登录[DataWorks控制台](https://workbench.data.aliyun.com/console)，进入工作空间配置页面获取工作空间ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + 'maximum' => '100000000', + 'minimum' => '0', + 'example' => '27', + ], + ], + [ + 'name' => 'UserId', + 'in' => 'query', + 'schema' => [ + 'description' => '用户ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '1234', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + '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' => '从DataWorks工作空间移除用户', + 'summary' => '该接口用于从DataWorks工作空间移除用户。', + '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' => 'DataWorks工作空间的ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + 'maximum' => '1000000', + 'minimum' => '0', + 'example' => '27', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '1AFAE64E-D1BE-432B-A9****', + ], + 'ProjectRoleList' => [ + 'description' => '工作空间的角色列表。', + 'type' => 'array', + 'items' => [ + 'description' => '角色详情。', + 'type' => 'object', + 'properties' => [ + 'ProjectRoleId' => [ + 'description' => '工作空间的角色ID。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'ProjectRoleType' => [ + 'description' => '工作空间的角色类型。', + 'type' => 'string', + 'example' => '0', + ], + 'ProjectRoleName' => [ + 'description' => '工作空间的角色名称。', + 'type' => 'string', + 'example' => '访客', + ], + 'ProjectRoleCode' => [ + 'description' => '工作空间的角色Code。'."\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' => '获取工作空间所有角色的列表', + 'summary' => '该接口用于获取工作空间所有角色的列表。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'RemoveProjectMemberFromRole' => [ + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'ProjectId', + 'in' => 'query', + 'schema' => [ + 'description' => 'DataWorks工作空间的ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + 'maximum' => '10000000', + 'minimum' => '0', + 'example' => '27', + ], + ], + [ + 'name' => 'UserId', + 'in' => 'query', + 'schema' => [ + 'description' => '用户的ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '1234', + ], + ], + [ + 'name' => 'RoleCode', + 'in' => 'query', + 'schema' => [ + 'description' => 'DataWorks工作空间的角色Code。可调用接口ListProjectRoles获取项目有哪些角色code列表。'."\n" + .'默认预设角色枚举如下：'."\n" + ."\n" + .'- role\\_project\\_owner 项目所有者'."\n" + .'- role\\_project\\_admin 空间管理员'."\n" + .'- role\\_project\\_dev 开发'."\n" + .'- role\\_project\\_pe 运维'."\n" + .'- role\\_project\\_deploy 部署'."\n" + .'- role\\_project\\_guest 访客'."\n" + .'- role\\_project\\_security 安全管理员'."\n" + .'- role\\_project\\_tester 体验者'."\n" + .'- role\\_project\\_erd 模型设计师', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'role_project_guest', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + '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' => '将工作空间内用户从角色中移除', + 'summary' => '该接口用于将DataWorks工作空间内的用户从DataWorks角色中移除。', + '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' => 'DataWorks工作空间的ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + 'maximum' => '10000000', + 'minimum' => '0', + 'example' => '27', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '分页的页数。默认值为1，最小值为1，最大值为30。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '10000', + 'minimum' => '1', + 'example' => '1', + 'default' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '每页显示的条数，默认为10条，最大100条。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '20', + 'minimum' => '5', + 'example' => '10', + 'default' => '10', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '1AFAE64E-D1BE-432B-A9****', + ], + 'Data' => [ + 'description' => '查询结果。', + 'type' => 'object', + 'properties' => [ + 'PageNumber' => [ + 'description' => '当前的页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '每页的大小。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'TotalCount' => [ + 'description' => '结果的总条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '3', + ], + 'ProjectMemberList' => [ + 'description' => '工作空间的成员列表。', + 'type' => 'array', + 'items' => [ + 'description' => '成员详情。', + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => '查询状态。取值如下：'."\n" + .' '."\n" + .'- 0 ，表示正常（NORMAL）。'."\n" + .'- 1，表示禁用（FORBIDDEN）。'."\n" + .'- 2，表示已删除（DELETED）。', + 'type' => 'string', + 'example' => '0', + ], + 'ProjectMemberId' => [ + 'description' => '成员的用户ID。'."\n", + 'type' => 'string', + 'example' => '121', + ], + 'Nick' => [ + 'description' => '工作空间成员的昵称。', + 'type' => 'string', + 'example' => 'zhangsan', + ], + 'ProjectMemberName' => [ + 'description' => '成员的名称。', + 'type' => 'string', + 'example' => '张三', + ], + 'ProjectMemberType' => [ + 'description' => '成员的类型，取值如下：'."\n" + ."\n" + .'- 1： 阿里云主账号（USER_ALIYUN）；'."\n" + .'- 5：RAM USER子账号（USER_UBACCOUNT）；'."\n" + .'- 6：RAM ROLE角色（USER_STS_ROLE）。', + 'type' => 'string', + 'example' => '1', + ], + 'ProjectRoleList' => [ + 'description' => '成员所拥有的角色列表。', + 'type' => 'array', + 'items' => [ + 'description' => '返回数据结构。', + 'type' => 'object', + 'properties' => [ + 'ProjectRoleId' => [ + 'description' => '角色ID。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'ProjectRoleType' => [ + 'description' => '角色的类型。取值如下：'."\n" + ."\n" + .'- SYSTEM（0）：系统角色；'."\n" + ."\n" + .'- USER_CUSTOM（2）：自定义角色。', + 'type' => 'string', + 'example' => '0', + ], + 'ProjectRoleName' => [ + 'description' => '角色的名称。'."\n" + .'DataWorks为您提供了预设角色，您也可以根据业务需求自定义角色。角色更多详情，请参见[用户、角色与权限概述](~~295463~~)。', + 'type' => 'string', + 'example' => '访客', + ], + 'ProjectRoleCode' => [ + 'description' => '角色Code。'."\n" + .'DataWorks为您提供了预设角色，您也可以根据业务需求自定义角色。角色更多详情，请参见[用户、角色与权限概述](~~295463~~)。', + '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' => '查询工作空间成员列表', + 'summary' => '该接口用于查询DataWorks工作空间中已存在成员的列表。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'ListProjects' => [ + 'summary' => '该接口用于查询用户所在租户下的DataWorks工作空间列表。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '页码数。最小值1，最大值100', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'docRequired' => true, + 'maximum' => '10000000', + 'minimum' => '1', + 'example' => '1', + 'default' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '每页显示的数据量，默认为10条，最大100条。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '10000000', + 'minimum' => '1', + 'example' => '10', + 'default' => '10', + ], + ], + [ + 'name' => 'ResourceManagerResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '资源组ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'rg-acfmzbn7pt****', + ], + ], + [ + 'name' => 'Tags', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '工作空间绑定的标签信息列表。', + 'type' => 'array', + 'items' => [ + 'description' => '标签信息。', + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => '标签键。', + 'type' => 'string', + 'required' => false, + 'example' => 'key', + ], + 'Value' => [ + 'description' => '标签值。', + 'type' => 'string', + 'required' => false, + 'example' => 'value', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 20, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '20658801****', + ], + 'PageResult' => [ + 'description' => '查询结果。', + 'type' => 'object', + 'properties' => [ + 'PageNumber' => [ + 'description' => '当前的页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '每页显示的条数，默认为10条，最大100条。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'TotalCount' => [ + 'description' => '返回结果的总条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '68', + ], + 'ProjectList' => [ + 'description' => 'DataWorks工作空间的结果列表。', + 'type' => 'array', + 'items' => [ + 'description' => '工作空间详情。', + 'type' => 'object', + 'properties' => [ + 'ProjectStatusCode' => [ + 'description' => '工作空间的状态码。'."\n" + ."\n" + .'- AVAILABLE：状态取值为0，表示正常。'."\n" + .'- DELETED：状态取值为1，表示已删除。'."\n" + .'- INITIALIZING：状态取值为2，表示初始化。'."\n" + .'- INIT_FAILED：状态取值为3，表示初始化失败。'."\n" + .'- FORBIDDEN：状态取值为4，表示手动禁用。'."\n" + .'- DELETING：状态取值为5，表示删除中。'."\n" + .'- DEL_FAILED：状态取值为6，表示删除失败。'."\n" + .'- FROZEN：状态取值为7，表示欠费冻结。'."\n" + .'- UPDATING：状态取值为8，表示项目更新（为项目添加并初始化计算引擎）中。'."\n" + .'- UPDATE_FAILED：状态取值为9，表示项目更新（为项目添加并初始化计算引擎）失败。', + 'type' => 'string', + 'example' => 'AVAILABLE', + ], + 'ProjectStatus' => [ + 'description' => '工作空间的状态。'."\n" + .'- AVAILABLE：状态取值为0，表示正常。'."\n" + .'- DELETED：状态取值为1，表示已删除。'."\n" + .'- INITIALIZING：状态取值为2，表示初始化。'."\n" + .'- INIT_FAILED：状态取值为3，表示初始化失败。'."\n" + .'- FORBIDDEN：状态取值为4，表示手动禁用。'."\n" + .'- DELETING：状态取值为5，表示删除中。'."\n" + .'- DEL_FAILED：状态取值为6，表示删除失败。'."\n" + .'- FROZEN：状态取值为7，表示欠费冻结。'."\n" + .'- UPDATING：状态取值为8，表示项目更新（为项目添加并初始化计算引擎）中。'."\n" + .'- UPDATE_FAILED：状态取值为9，表示项目更新（为项目添加并初始化计算引擎）失败。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'ProjectName' => [ + 'description' => '工作空间的显示名称。', + 'type' => 'string', + 'example' => 'test_project', + ], + 'ProjectIdentifier' => [ + 'description' => '工作空间的名称。', + 'type' => 'string', + 'example' => 'test_project', + ], + 'ProjectId' => [ + 'description' => '工作空间的ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '466230', + ], + 'ProjectDescription' => [ + 'description' => '工作空间的详细描述信息。', + 'type' => 'string', + 'example' => 'test_describe', + ], + 'ProjectOwnerBaseId' => [ + 'description' => '工作空间所有者的用户ID。', + 'type' => 'string', + 'example' => '13969939245****', + ], + 'ResourceManagerResourceGroupId' => [ + 'description' => '资源组ID。', + 'type' => 'string', + 'example' => 'rg-acfmzbn7****', + ], + 'Tags' => [ + 'description' => '工作空间绑定的标签列表。', + 'type' => 'array', + 'items' => [ + 'description' => '标签信息。', + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => '标签键。', + 'type' => 'string', + 'example' => 'key', + ], + 'Value' => [ + 'description' => '标签值。', + 'type' => 'string', + 'example' => 'value', + ], + ], + ], + ], + 'DisableDevelopment' => [ + 'description' => '是否禁用开发角色，取值如下：'."\n" + .'- **false**：开启开发角色。'."\n" + .'- **true**：禁用开发角色。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'UseProxyOdpsAccount' => [ + 'description' => '访问MaxCompute引擎是否使用代理账号。'."\n" + .'- **false**：不使用。'."\n" + .'- **true**：使用。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'TablePrivacyMode' => [ + 'description' => 'MaxCompute表的可见性权限，取值如下：'."\n" + .'- **0**：租户内用户不可见MaxCompute表。'."\n" + .'- **1**：租户内用户可见MaxCompute表。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'IsDefault' => [ + 'description' => '是否为默认工作空间，取值如下：'."\n" + .'- **1**：是。'."\n" + .'- **0**：否。', + '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' => '查询工作空间列表', + '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' => '目标阿里云账号ID。'."\n" + ."\n" + .'您可以登录[DataWorks控制台](https://workbench.data.aliyun.com/console)，鼠标悬停至顶部菜单栏右侧的用户头像，获取账号ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '139699392458****', + 'maxLength' => 10000000, + 'minLength' => 0, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '0b57ff7216278945532771749d****', + ], + 'ProjectIds' => [ + 'description' => '返回的DataWorks工作空间ID列表。'."\n" + ."\n" + .'返回结果为目标阿里云账号所拥有角色权限的DataWorks工作空间的ID列表，此处仅以一个工作空间ID示例。', + 'type' => 'array', + 'items' => [ + 'description' => '返回的DataWorks工作空间ID。', + '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 \\"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' => '查询指定账号下DataWorks工作空间ID列表', + 'summary' => '该接口用于查询指定阿里云账号（包括阿里云主账号或RAM用户）在目标地域下拥有角色权限的DataWorks工作空间的ID列表。', + 'description' => '您的阿里云账号在DataWorks工作空间中可以拥有开发、运维、空间管理员等不同的角色权限。DataWorks工作空间的角色权限介绍，详情请参见[DataWorks角色管理](~~136941~~)。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'CreateProject' => [ + 'summary' => '该接口用于创建一个DataWorks工作空间。', + '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' => '幂等参数，该参数可为空。', + 'type' => 'string', + 'required' => false, + 'example' => 'ABFUOEUOTRTRJKE', + ], + ], + [ + 'name' => 'ProjectName', + 'in' => 'query', + 'schema' => [ + 'description' => '工作空间的显示名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'test_project', + ], + ], + [ + 'name' => 'ProjectDescription', + 'in' => 'query', + 'schema' => [ + 'description' => '工作空间的详细描述信息。', + 'type' => 'string', + 'required' => false, + 'example' => 'test_describe', + ], + ], + [ + 'name' => 'DisableDevelopment', + 'in' => 'query', + 'schema' => [ + 'description' => '是否禁用开发角色，取值如下：'."\n" + .'- **false**：默认值，开启开发角色。'."\n" + .'- **true**：禁用开发角色。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + [ + 'name' => 'IsAllowDownload', + 'in' => 'query', + 'schema' => [ + 'description' => '是否允许下载ide上查询的结果，取值如下：'."\n" + .'- **1**：默认值，允许下载。'."\n" + .'- **0**：不允许下载。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'ProjectMode', + 'in' => 'query', + 'schema' => [ + 'description' => '工作空间的模式，模式区别详情参见[必读：简单模式和标准模式的区别](~~85772~~)。'."\n" + ."\n" + .'取值如下：'."\n" + .'- **2**：默认值，表示简单工作空间模式。'."\n" + .'- **3**：表示标准工作空间模式。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '3', + ], + ], + [ + 'name' => 'ProjectIdentifier', + 'in' => 'query', + 'allowEmptyValue' => false, + 'schema' => [ + 'description' => '工作空间的名称，只能包含大小写字母、数字和下划线，且首字母必须是字母或数字。', + 'type' => 'string', + 'required' => true, + 'example' => 'test_project', + ], + ], + [ + 'name' => 'ResourceManagerResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '资源组ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'rg-acfmzbn7pti3****', + ], + ], + [ + 'name' => 'Tags', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '工作空间绑定的标签列表。', + 'type' => 'array', + 'items' => [ + 'description' => '标签信息。', + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => '标签键。', + 'type' => 'string', + 'required' => true, + 'example' => 'key', + ], + 'Value' => [ + 'description' => '标签值。', + 'type' => 'string', + 'required' => true, + 'example' => 'value', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 21, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => [ + 'description' => '请求返回码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '1AFAE64E-D1BE-432B-A9****', + ], + 'Success' => [ + 'description' => '请求是否成功，取值如下：'."\n" + .'- **true**：请求成功。'."\n" + .'- **false**：请求失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Data' => [ + 'description' => '创建成功的DataWorks工作空间的ID。', + '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' => '创建DataWorks工作空间', + ], + 'ChangeResourceManagerResourceGroup' => [ + 'summary' => '该接口用于修改资源归属资源组。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'ResourceType', + 'in' => 'query', + 'schema' => [ + 'description' => '资源的类型，取值如下：'."\n" + .'- project，工作空间。如果您需要修改的是DataWorks版本所归属的资源组信息时，请选择project。'."\n" + .'- tenantresourcegroup，独享资源组。如果您需要修改的是DataWorks独享资源组所归属的资源组信息时，请选择tenantresourcegroup。', + 'type' => 'string', + 'required' => true, + 'example' => 'project', + ], + ], + [ + 'name' => 'ResourceId', + 'in' => 'query', + 'schema' => [ + 'description' => '资源类型的ID标识符，取值如下：'."\n" + .'- 当ResourceType=project时，则ResourceId可以理解为通过[ListProjects](~~2780068~~)接口获取工作空间的名称（ProjectIdentifier）。'."\n" + .'- 当ResourceType=tenantresourcegroup时，则ResourceId可以理解为通过[ListResourceGroups](~~2780075~~)接口获取独享资源组的标识（Identifier）, 仅限ResourceGroupType=7、8、9的类型。', + 'type' => 'string', + 'required' => true, + 'example' => 'test_project', + ], + ], + [ + 'name' => 'ResourceManagerResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '目标资源组ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'rg-bp67acfmxazb4p****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'Data' => [ + 'description' => '变更资源组是否成功。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'RequestId' => [ + 'description' => '请求的ID。', + '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' => '修改资源归属资源组', + ], + 'ListMeasureData' => [ + 'summary' => '该接口用于查询用户所在租户下最近30天电话告警、短信告警计量数据。', + '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' => '计量项，取值如下：'."\n" + .'- DideAlarmPhone：电话告警'."\n" + .'- DideAlarmSms：短信告警', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'DideAlarmPhone', + ], + ], + [ + 'name' => 'ComponentCode', + 'in' => 'query', + 'schema' => [ + 'title' => '计量组件,取值如下:'."\n" + .'- Count：DideAlarmPhone电话告警条数、DideAlarmSms短信告警条数。', + 'description' => '计量组件，取值如下：'."\n" + .'- Count：DideAlarmPhone电话告警条数、DideAlarmSms短信告警条数', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'Count', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'title' => '计量周期开始时间戳(毫秒),计量周期是按照天统计，EndTime - StartTime仅能查询最近30天的数据。', + 'description' => '计量周期开始时间戳（毫秒），计量周期是按照天统计，EndTime - StartTime 仅能查询最近30天的数据。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + 'example' => '1717344000000', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'title' => '计量周期截止时间戳(毫秒),计量周期是按照天统计，EndTime - StartTime仅能查询最近30天的数据。', + 'description' => '计量周期截止时间戳（毫秒），计量周期是按照天统计，EndTime - StartTime 仅能查询最近30天的数据。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + 'example' => '1717430400000', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '返回结果。', + 'description' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '请求ID。', + 'description' => '请求 ID。', + 'type' => 'string', + 'example' => '1AFAE64E-D1BE-432B-A9****', + ], + 'MeasureDatas' => [ + 'title' => '查询计量结果列表。', + 'description' => '查询计量结果。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'DomainCode' => [ + 'title' => '计量项。', + 'description' => '计量项。', + 'type' => 'string', + 'example' => 'DideAlarmPhone', + ], + 'ComponentCode' => [ + 'title' => '计量组件。', + 'description' => '计量组件。', + 'type' => 'string', + 'example' => 'Count', + ], + 'StartTime' => [ + 'title' => '计量周期开始时间戳(毫秒)。', + 'description' => '计量周期开始时间戳（毫秒）。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1717344000000', + ], + 'EndTime' => [ + 'title' => '计量周期结束时间戳(毫秒)。', + 'description' => '计量周期结束时间戳（毫秒）。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1717430400000', + ], + 'Usage' => [ + 'title' => '计量周期内使用总量。'."\n", + 'description' => '计量周期内使用总量。'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10', + ], + ], + ], + ], + 'Success' => [ + 'title' => '请求是否成功，取值如下：'."\n" + .'- true：请求成功。'."\n" + .'- false：请求失败。', + 'description' => '请求是否成功，取值如下：'."\n" + .'- true：请求成功。'."\n" + .'- false：请求失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'ErrorCode' => [ + 'title' => '请求错误码。', + 'description' => '请求错误码。', + 'type' => 'string', + 'example' => '100001001', + ], + 'ErrorMessage' => [ + 'title' => '请求报错信息。', + 'description' => '请求报错信息。', + 'type' => 'string', + 'example' => 'The user is not in tenant.', + ], + 'HttpStatusCode' => [ + 'title' => '请求返回码。', + 'description' => '请求返回码。', + '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' => '查询计量数据', + ], + 'ListTables' => [ + 'summary' => '分页获取租户下面的数据源类型粒度的表名称。', + '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' => '每页显示的条数，默认为 10 条，最大为 100 条。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'DataSourceType', + 'in' => 'query', + 'schema' => [ + 'description' => '数据源类型。支持取值为odps、'."\n" + .'emr、'."\n" + .'mysql、'."\n" + .'holo、'."\n" + .'analyticdb_for_mysql、'."\n" + .'oracle、'."\n" + .'postgresql、'."\n" + .'sqlserver、'."\n" + .'clickhouse、'."\n" + .'starrocks 。', + 'type' => 'string', + 'required' => true, + 'example' => 'odps', + ], + ], + [ + 'name' => 'NextToken', + 'in' => 'query', + 'schema' => [ + 'description' => '分页信息，指定本次读取的起始点。', + 'type' => 'string', + 'required' => false, + 'example' => '12222', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求 ID。', + 'type' => 'string', + 'example' => 'E25887B7-579C-54A5-9C4F-83A****', + ], + 'Data' => [ + 'description' => '响应数据。', + 'type' => 'object', + 'properties' => [ + 'Total' => [ + 'description' => '总数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '100', + ], + 'TableEntityList' => [ + 'description' => '实体数组。', + 'type' => 'array', + 'items' => [ + 'description' => '返回的表信息。', + 'type' => 'object', + 'properties' => [ + 'EntityQualifiedName' => [ + 'description' => '表实体唯一标识。', + 'type' => 'string', + 'example' => 'maxcompute-table.project.table', + ], + 'EntityContent' => [ + 'description' => '表实体信息。', + 'type' => 'object', + 'properties' => [ + 'TableName' => [ + 'description' => '表名称。', + 'type' => 'string', + 'example' => 'table', + ], + 'DataSourceQualifiedName' => [ + 'description' => '数据源唯一标识。', + 'type' => 'string', + 'example' => 'accountId:cn-shanghai:odps:project', + ], + 'DataSourceUniqueId' => [ + 'description' => '数据源标识唯一ID。', + 'type' => 'string', + 'example' => 'e70f92239d491057f6a2563b545bdaf8cc6b537d9dc55ec84c55f7cfefg', + ], + 'DatabaseName' => [ + 'description' => '数据库名称。', + 'type' => 'string', + 'example' => 'database', + ], + 'ProjectName' => [ + 'description' => 'odps项目名称。', + 'type' => 'string', + 'example' => 'project', + ], + 'InstanceId' => [ + 'description' => '数据源实例ID。', + 'type' => 'string', + 'example' => 'rm-uf6rn0123', + ], + ], + ], + ], + ], + ], + 'NextToken' => [ + 'description' => '分页信息，指定下次读取的起始点。', + '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' => '获取表列表', + ], + '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' => '引擎ID，格式为`引擎类型.引擎名称`。', + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => 'odps.some_engine_name', + ], + ], + [ + 'name' => 'ClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'EMR集群的clusterId。', + 'type' => 'string', + 'required' => false, + 'example' => 'abc', + ], + ], + [ + 'name' => 'DatabaseName', + 'in' => 'query', + 'schema' => [ + 'description' => 'EMR集群的数据库。', + 'type' => 'string', + 'required' => false, + 'example' => 'abc', + ], + ], + [ + 'name' => 'DataSourceType', + 'in' => 'query', + 'schema' => [ + 'description' => '数据类型，包括odps和emr。', + 'type' => 'string', + 'required' => false, + 'example' => 'emr', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '0bc1411515937****', + ], + 'Data' => [ + 'description' => '基本元数据信息。', + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'description' => '数据库类型。', + 'type' => 'string', + 'example' => 'hive', + ], + 'Comment' => [ + 'description' => '备注。', + 'type' => 'string', + 'example' => '备注', + ], + 'CreateTime' => [ + 'description' => '创建引擎的时间。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1541576644000', + ], + 'ProjectId' => [ + 'description' => '工作空间ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '22', + ], + 'ProjectName' => [ + 'description' => '工作空间的名称。', + 'type' => 'string', + 'example' => 'test', + ], + 'AppGuid' => [ + 'description' => '引擎ID，格式为`引擎类型.引擎名称`。', + 'type' => 'string', + 'example' => 'odps.engine_name', + ], + 'OwnerName' => [ + 'description' => '工作空间Owner的名称。', + 'type' => 'string', + 'example' => 'my_name', + ], + 'OwnerId' => [ + 'description' => '工作空间Owner的云账号ID。', + 'type' => 'string', + 'example' => 'userId', + ], + 'EnvType' => [ + 'description' => '环境类型：0表示非生产表，1表示生产表。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'ProjectNameCn' => [ + 'description' => '工作空间的显示名称。', + 'type' => 'string', + 'example' => '测试项目', + ], + 'Endpoint' => [ + 'description' => '服务地址Endpoint。', + 'type' => 'string', + 'example' => 'http://service.odpsstg.aliyun-inc.com/', + ], + 'ClusterBizId' => [ + 'description' => 'emr集群id。', + 'type' => 'string', + 'example' => 'abc', + ], + 'Name' => [ + 'description' => '数据库名称。', + 'type' => 'string', + 'example' => 'abc', + ], + 'Location' => [ + 'description' => 'emr数据库对应数据存储地址。', + 'type' => 'string', + 'example' => 'hdfs://', + ], + 'TenantId' => [ + 'description' => '租户ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '233', + ], + 'ModifyTime' => [ + 'description' => '修改引擎的时间。', + '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' => '获取引擎实例的基本元数据信息', + 'summary' => '该接口用于获取引擎实例的基本元数据信息。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' GetMetaDBInfo接口的使用示例Demo请参见[DataWorks OpenAPI示例](https://developer.aliyun.com/article/780879?groupCode=dataworks)。', + ], + 'GetMetaDBTableList' => [ + 'summary' => '该接口用于获取引擎实例中的表。', + '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' => '请求的数据页数，用于翻页。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '每页显示的条数，默认为10条，最大为1000条。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '1000', + 'minimum' => '1', + 'exclusiveMinimum' => false, + 'example' => '100', + ], + ], + [ + 'name' => 'AppGuid', + 'in' => 'query', + 'schema' => [ + 'description' => '项目的唯一标识，格式为`odps.{projectName}`。仅当数据类型为odps时，需要配置该参数。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'odps.testProjectName', + ], + ], + [ + 'name' => 'ClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'EMR集群的ID，仅当数据类型为emr时，需要配置该参数。', + 'type' => 'string', + 'required' => false, + 'example' => 'abc', + ], + ], + [ + 'name' => 'DatabaseName', + 'in' => 'query', + 'schema' => [ + 'description' => '数据库的名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'abc', + ], + ], + [ + 'name' => 'DataSourceType', + 'in' => 'query', + 'schema' => [ + 'description' => '数据类型，目前仅支持odps和emr。', + 'type' => 'string', + 'required' => false, + 'example' => 'odps', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '0bc1ec92159376', + ], + 'Data' => [ + 'description' => '引擎实例下的表信息。', + 'type' => 'object', + 'properties' => [ + 'PageNumber' => [ + 'description' => '请求的数据页数，用于翻页。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '每页显示的条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'TotalCount' => [ + 'description' => '计算引擎的总数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '20', + ], + 'TableEntityList' => [ + 'description' => '引擎实例下的表列表。', + 'type' => 'array', + 'items' => [ + 'description' => '返回的表信息。', + 'type' => 'object', + 'properties' => [ + 'TableName' => [ + 'description' => '表的名称。', + 'type' => 'string', + 'example' => 'tname', + ], + 'TableGuid' => [ + 'description' => '表的唯一标识。', + 'type' => 'string', + 'example' => 'odps.engine_name.tname', + ], + 'DatabaseName' => [ + 'description' => '数据库的名称。', + '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' => '获取引擎实例下的表', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' GetMetaDBTableList接口的使用示例Demo请参见[DataWorks OpenAPI示例](https://developer.aliyun.com/article/780879?groupCode=dataworks)。'."\n", + ], + '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' => '表的唯一标识。', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => 'odps.engine_name.table_name', + ], + ], + [ + 'name' => 'ClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'EMR集群的ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'abc', + ], + ], + [ + 'name' => 'DatabaseName', + 'in' => 'query', + 'schema' => [ + 'description' => 'EMR数据库的名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'abc', + ], + ], + [ + 'name' => 'TableName', + 'in' => 'query', + 'schema' => [ + 'description' => 'EMR表名。', + 'type' => 'string', + 'required' => false, + 'example' => 'abc', + ], + ], + [ + 'name' => 'DataSourceType', + 'in' => 'query', + 'schema' => [ + 'description' => '数据类型，odps或者emr。', + 'type' => 'string', + 'required' => false, + 'example' => 'emr', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'Data' => [ + 'description' => '表是否存在。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'RequestId' => [ + 'description' => '请求ID。', + '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' => '检查表是否存在', + 'summary' => '该接口用于检查表是否存在。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' CheckMetaTable接口的使用示例Demo请参见[DataWorks OpenAPI示例](https://developer.aliyun.com/article/780879?groupCode=dataworks)。', + ], + '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' => 'MaxCompute表的唯一标识。', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => 'odps.engine_name.table_name', + ], + ], + [ + 'name' => 'Partition', + 'in' => 'query', + 'schema' => [ + 'description' => 'MaxCompute表分区的名称。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ds=202005', + ], + ], + [ + 'name' => 'ClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '该参数已废弃使用。', + 'type' => 'string', + 'required' => false, + 'example' => 'abc', + ], + ], + [ + 'name' => 'DatabaseName', + 'in' => 'query', + 'schema' => [ + 'description' => '数据库的名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'abc', + ], + ], + [ + 'name' => 'TableName', + 'in' => 'query', + 'schema' => [ + 'description' => '表名。', + 'type' => 'string', + 'required' => false, + 'example' => 'abc', + ], + ], + [ + 'name' => 'DataSourceType', + 'in' => 'query', + 'schema' => [ + 'description' => '数据类型，目前仅支持odps。', + 'type' => 'string', + 'required' => false, + 'example' => 'odps', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => [ + 'description' => '请求返回码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Data' => [ + 'description' => 'MaxCompute表的分区是否存在。'."\n" + .'- true：存在。'."\n" + .'- false：不存在。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '0bc1ec92159376', + ], + 'ErrorMessage' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'The connection does not exist.', + ], + 'ErrorCode' => [ + 'description' => '错误码。', + 'type' => 'string', + 'example' => 'Invalid.Tenant.ConnectionNotExists', + ], + 'Success' => [ + 'description' => '请求是否成功。', + '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' => '检查分区是否存在', + 'summary' => '该接口用于检查分区是否存在。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => 'CheckMetaPartition接口的使用示例Demo请参见[DataWorks OpenAPI示例](https://developer.aliyun.com/article/780879?groupCode=dataworks)。', + ], + 'SearchMetaTables' => [ + 'summary' => '该接口用于根据条件搜索表。', + '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' => '分页查询页码。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '每页显示的条数，默认为10条，最大100条。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'AppGuid', + 'in' => 'query', + 'schema' => [ + 'description' => '表所在工作空间的标识。', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => 'odps.engine_name', + ], + ], + [ + 'name' => 'Keyword', + 'in' => 'query', + 'schema' => [ + 'description' => '关键字采用分词匹配算法搜索表名，如果没有匹配的字段则返回空值。默认按照下划线分词搜索。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'test', + ], + ], + [ + 'name' => 'EntityType', + 'in' => 'query', + 'schema' => [ + 'description' => '表的类型：0表示table，1表示view。如果不填，则默认搜索全部类型。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + ], + ], + [ + 'name' => 'ClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'EMR集群的ID，仅当数据类型为EMR时，需要配置该参数。'."\n" + ."\n" + .'您可以登录[EMR的控制台](https://emr.console.aliyun.com/?spm=a2c4g.11186623.0.0.965cc5c2GeiHet#/cn-hangzhou)，获取集群ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'abc', + ], + ], + [ + 'name' => 'DataSourceType', + 'in' => 'query', + 'schema' => [ + 'description' => '数据类型，包括ODPS和emr。', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => 'emr', + ], + ], + [ + 'name' => 'Schema', + 'in' => 'query', + 'schema' => [ + 'description' => '表Schema信息。在ODPS，用户启动了三层模型需要填写Schema信息', + 'type' => 'string', + 'required' => false, + 'example' => 'default', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => [ + 'description' => '请求返回码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'ErrorMessage' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'The specified parameters are invalid.', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '0bc1ec92159376****', + ], + 'Success' => [ + 'description' => '请求是否成功。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'ErrorCode' => [ + 'description' => '错误码。', + 'type' => 'string', + 'example' => '1031203110005', + ], + 'Data' => [ + 'description' => '搜索结果。', + 'type' => 'object', + 'properties' => [ + 'PageNumber' => [ + 'description' => '分页查询页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '分页查询每页的大小。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'TotalCount' => [ + 'description' => '表的总数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '100', + ], + 'DataEntityList' => [ + 'description' => '查询返回的表列表。', + 'type' => 'array', + 'items' => [ + 'description' => '表详情。', + 'type' => 'object', + 'properties' => [ + 'TableName' => [ + 'description' => '表的名称。', + 'type' => 'string', + 'example' => 'test_name', + ], + 'DatabaseName' => [ + 'description' => '数据库名称。', + 'type' => 'string', + 'example' => 'abc', + ], + 'EntityType' => [ + 'description' => '表的类型：'."\n" + ."\n" + .'- 0表示table。'."\n" + .'- 1表示view。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'ProjectName' => [ + 'description' => '工作空间的名称。', + 'type' => 'string', + 'example' => 'test', + ], + 'ProjectId' => [ + 'description' => '工作空间的ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '323', + ], + 'TableGuid' => [ + 'description' => '表的唯一标识。', + 'type' => 'string', + 'example' => 'odps.engine_name.test_name', + ], + 'OwnerId' => [ + 'description' => '工作空间Owner的云账号ID。', + 'type' => 'string', + 'example' => '123', + ], + 'ClusterId' => [ + 'description' => 'EMR集群ID。', + 'type' => 'string', + 'example' => 'abc', + ], + 'EnvType' => [ + 'description' => '环境类型：'."\n" + .'- 1表示生产环境。'."\n" + .'- 0表示开发环境。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'TenantId' => [ + 'description' => '租户ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '12345', + ], + 'Schema' => [ + 'description' => '表Schema信息。在ODPS，用户启动了三层模型需要填写Schema信息', + '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' => '根据条件搜索表', + 'description' => '仅支持搜索MaxCompute和EMR两种类型的引擎表。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' SearchMetaTables接口的使用示例Demo请参见[DataWorks OpenAPI示例](https://developer.aliyun.com/article/780879?groupCode=dataworks)。', + ], + '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' => 'MaxCompute表的唯一标识。格式为odps.projectName.tableName。'."\n" + ."\n" + .'> EMR场景下，该参数非必选。', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => 'odps.engine_name.table_name', + ], + ], + [ + 'name' => 'ClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'EMR集群的ID，当DataSourceType（数据类型）参数配置为EMR时，当前参数必配。'."\n" + ."\n" + .'您可以登录[EMR的控制台](https://emr.console.aliyun.com/?spm=a2c4g.11186623.0.0.965cc5c2GeiHet#/cn-hangzhou)，获取集群ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'abc', + ], + ], + [ + 'name' => 'DatabaseName', + 'in' => 'query', + 'schema' => [ + 'description' => '数据库的名称。仅当数据类型为EMR时，需要配置该参数。'."\n" + ."\n" + .'您可以调用[ListMetaDB](~~2780105~~)接口获取。', + 'type' => 'string', + 'required' => false, + 'example' => 'abc', + ], + ], + [ + 'name' => 'TableName', + 'in' => 'query', + 'schema' => [ + 'description' => 'EMR的表名称。仅当数据类型为EMR时，需要配置该参数。'."\n" + ."\n" + .'您可以通过调用[GetMetaDBTableList](~~2780086~~)接口，获取表名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'abc', + ], + ], + [ + 'name' => 'DataSourceType', + 'in' => 'query', + 'schema' => [ + 'description' => '数据类型，包括odps和emr。', + 'type' => 'string', + 'required' => false, + 'example' => 'emr', + ], + ], + [ + 'name' => 'Extension', + 'in' => 'query', + 'schema' => [ + 'description' => '是否包含扩展字段。'."\n" + .'扩展字段包含读取次数、收藏次数、浏览次数等。'."\n" + .'仅当数据类型为ODPS时，该参数生效。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => [ + 'description' => '请求返回码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'ErrorMessage' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'The connection does not exist.', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '0bc1411515937', + ], + 'Success' => [ + 'description' => '请求是否成功。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'ErrorCode' => [ + 'description' => '错误码。', + 'type' => 'string', + 'example' => 'Invalid.Tenant.ConnectionNotExists', + ], + 'Data' => [ + 'description' => '业务数据。', + 'type' => 'object', + 'properties' => [ + 'TableName' => [ + 'description' => '表的名称。', + 'type' => 'string', + 'example' => 'table_name', + ], + 'FavoriteCount' => [ + 'description' => '表的收藏次数。仅当Extension参数取值为true时才会返回该参数，并且该参数仅对odps数据类型生效。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '6', + ], + 'Comment' => [ + 'description' => '表的描述。', + 'type' => 'string', + 'example' => 'test table', + ], + 'ColumnCount' => [ + 'description' => '字段的个数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '3', + ], + 'CreateTime' => [ + 'description' => '创建表的时间。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1589870294000', + ], + 'ProjectId' => [ + 'description' => '工作空间的ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '232', + ], + 'OwnerId' => [ + 'description' => '表所有者的ID。', + 'type' => 'string', + 'example' => '123', + ], + 'EnvType' => [ + 'description' => '环境类型，取值如下：'."\n" + .'- 0表示开发表。'."\n" + .'- 1表示生产表。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'DatabaseName' => [ + 'description' => '数据库的名称。', + 'type' => 'string', + 'example' => 'abc', + ], + 'IsVisible' => [ + 'description' => '表的可见性：'."\n" + .'- 0表示目标表对工作空间成员可见。'."\n" + .'- 1表示目标表对租户内成员可见。'."\n" + .'- 2表示目标表对租户间成员均可见。'."\n" + .'- 3表示目标表仅对责任人可见。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'TableGuid' => [ + 'description' => '表的唯一标识。', + 'type' => 'string', + 'example' => 'odps.engine_name.table_name', + ], + 'ReadCount' => [ + 'description' => '表的读取次数。仅当Extension参数取值为true时才会返回该参数，并且该参数仅对odps数据类型生效。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '3', + ], + 'ClusterId' => [ + 'description' => 'EMR集群的ID。', + 'type' => 'string', + 'example' => 'abc', + ], + 'IsPartitionTable' => [ + 'description' => '是否为分区表，取值如下：'."\n" + .'- true：是分区表。'."\n" + .'- false：不是分区表。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'IsView' => [ + 'description' => '是否为视图，取值如下：'."\n" + .'- true：是视图。'."\n" + .'- false：不是视图。', + 'type' => 'boolean', + 'example' => 'false', + ], + 'LifeCycle' => [ + 'description' => '表的生命周期。单位为天。'."\n" + .'> MaxCompute表未设置生命周期时，返回值为0，表示永久有效', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '5', + ], + 'ProjectName' => [ + 'description' => '工作空间的名称。', + 'type' => 'string', + 'example' => 'test', + ], + 'ViewCount' => [ + 'description' => '表的浏览次数。仅当Extension参数取值为true时才会返回该参数，并且该参数仅对odps数据类型生效。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2', + ], + 'LastAccessTime' => [ + 'description' => '最近一次访问表的时间。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1589870294000', + ], + 'DataSize' => [ + 'description' => '表占用的存储空间。单位为Byte。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10', + ], + 'LastModifyTime' => [ + 'description' => '最近一次更新表的时间。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1589870294000', + ], + 'LastDdlTime' => [ + 'description' => '最近一次变更表结构的时间。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1589870294000', + ], + 'PartitionKeys' => [ + 'description' => 'Hive分区。', + 'type' => 'string', + 'example' => 'ab', + ], + 'Location' => [ + 'description' => 'Hive数据库的存储地址。', + 'type' => 'string', + 'example' => 'hdfs://', + ], + 'Caption' => [ + 'description' => '表的中文名称。', + 'type' => 'string', + 'example' => '中文名', + ], + 'TenantId' => [ + 'description' => '租户ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '12345', + ], + 'Schema' => [ + 'description' => '表Schema信息。在ODPS，用户启动了三层模型需要填写Schema信息', + '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' => '获取表的基础信息', + 'summary' => '该接口用于获取表的基础信息。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' GetMetaTableBasicInfo接口的使用示例Demo请参见[DataWorks OpenAPI示例](https://developer.aliyun.com/article/780879?groupCode=dataworks)。', + ], + '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' => '表的唯一标识。您可以通过调用[GetMetaDBTableList](~~2780086~~)，获取表的唯一标识。', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => 'odps.engine_name.table_name', + ], + ], + [ + 'name' => 'PageNum', + 'in' => 'query', + 'schema' => [ + 'description' => '请求获取的数据页码数，用于翻页。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '每页显示的条数，默认为10条，最大100条。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'ClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'EMR集群的ID，您可以登录EMR管理控制台，获取集群ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'C-010A704DA760****', + ], + ], + [ + 'name' => 'DatabaseName', + 'in' => 'query', + 'schema' => [ + 'description' => 'EMR的数据库名称。您可以通过调用[ListMetaDB](~~2780105~~)接口，获取数据库名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'abc', + ], + ], + [ + 'name' => 'TableName', + 'in' => 'query', + 'schema' => [ + 'description' => 'EMR的表名称。您可以通过调用[GetMetaDBTableList](~~2780086~~)接口，获取表名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'abc', + ], + ], + [ + 'name' => 'DataSourceType', + 'in' => 'query', + 'schema' => [ + 'description' => '数据类型，当前仅支持取值为emr。', + 'type' => 'string', + 'required' => false, + 'example' => 'emr', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回结构。', + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => [ + 'description' => 'HTTP状态码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'ErrorMessage' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'The connection does not exist.', + ], + 'RequestId' => [ + 'description' => '请求ID。用于定位日志，排查问题。', + 'type' => 'string', + 'example' => '0bc1ec92159376', + ], + 'Success' => [ + 'description' => '调用是否成功。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'ErrorCode' => [ + 'description' => '错误码。', + 'type' => 'string', + 'example' => 'Invalid.Tenant.ConnectionNotExists', + ], + 'Data' => [ + 'description' => '业务数据。', + 'type' => 'object', + 'properties' => [ + 'PageNum' => [ + 'description' => '请求获取的数据页码数，用于翻页。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '每页显示的条数，默认为10条，最大100条。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'TotalCount' => [ + 'description' => '字段的总数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '100', + ], + 'ColumnList' => [ + 'description' => '字段的信息。', + 'type' => 'array', + 'items' => [ + 'description' => '返回结构。', + 'type' => 'object', + 'properties' => [ + 'ColumnGuid' => [ + 'description' => '字段的唯一标识。', + 'type' => 'string', + 'example' => 'odps.engine_name.table_name.name', + ], + 'ColumnName' => [ + 'description' => '字段的名称。', + 'type' => 'string', + 'example' => 'name', + ], + 'IsPartitionColumn' => [ + 'description' => '字段是否为分区字段，取值如下：'."\n" + .'- true，是分区字段。'."\n" + .'- false，不是分区字段。', + 'type' => 'boolean', + 'example' => 'false', + ], + 'Comment' => [ + 'description' => '字段的备注。', + 'type' => 'string', + 'example' => 'comment ', + ], + 'ColumnType' => [ + 'description' => '字段的类型。', + 'type' => 'string', + 'example' => 'string', + ], + 'IsPrimaryKey' => [ + 'description' => '字段是否为主键，取值如下：'."\n" + .'- true，是主键。'."\n" + .'- false，不是主键。', + 'type' => 'boolean', + 'example' => 'false', + ], + 'Position' => [ + 'description' => '字段的排序。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Caption' => [ + 'description' => '字段的描述。', + 'type' => 'string', + 'example' => 'data column', + ], + 'IsForeignKey' => [ + 'description' => '字段是否为外键，取值如下：'."\n" + .'- true，是外键。'."\n" + .'- false，不是外键。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'RelationCount' => [ + 'description' => '字段热度。', + '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' => '获取表的字段信息', + 'summary' => '该接口用于获取表的字段信息。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' GetMetaTableColumn接口的使用示例Demo请参见[DataWorks OpenAPI示例](https://developer.aliyun.com/article/780879?groupCode=dataworks)。', + ], + 'GetMetaTablePartition' => [ + 'summary' => '该接口用于获取表的分区列表。', + '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' => '请求的数据页数，用于翻页。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '每页显示的条数，默认为10条，最大100条。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'TableGuid', + 'in' => 'query', + 'schema' => [ + 'description' => '表的唯一标识。', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => 'odps.engine_name.table_name', + ], + ], + [ + 'name' => 'ClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'EMR集群的ID，仅当数据类型为EMR时，需要配置该参数。'."\n" + ."\n" + .'您可以登录[EMR的控制台](https://emr.console.aliyun.com/?spm=a2c4g.11186623.0.0.965cc5c2GeiHet#/cn-hangzhou)，获取集群ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'abc', + ], + ], + [ + 'name' => 'DatabaseName', + 'in' => 'query', + 'schema' => [ + 'description' => '数据库的名称。仅当数据类型为EMR时，需要配置该参数。'."\n" + ."\n" + .'您可以调用[ListMetaDB](~~2780105~~)接口获取。', + 'type' => 'string', + 'required' => false, + 'example' => 'abc', + ], + ], + [ + 'name' => 'TableName', + 'in' => 'query', + 'schema' => [ + 'description' => 'EMR的表名称。仅当数据类型为EMR时，需要配置该参数。'."\n" + ."\n" + .'您可以通过调用[GetMetaDBTableList](~~2780086~~)接口，获取表名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'abc', + ], + ], + [ + 'name' => 'DataSourceType', + 'in' => 'query', + 'schema' => [ + 'description' => '数据类型，支持ODPS或者EMR。', + 'type' => 'string', + 'required' => false, + 'example' => 'emr', + ], + ], + [ + 'name' => 'SortCriterion', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '表分区的排序逻辑。', + 'type' => 'object', + 'properties' => [ + 'SortField' => [ + 'description' => '表分区的排序字段。您可通过name、modify_time排序。'."\n" + .'默认按照表分区的创建时间排序。', + 'type' => 'string', + 'required' => false, + 'example' => 'name', + ], + 'Order' => [ + 'description' => '表分区的排序顺序，支持使用asc、desc方式排序。默认使用desc。', + 'type' => 'string', + 'required' => false, + 'example' => 'desc', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回的数据结构。', + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => [ + 'description' => 'HTTP状态码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'ErrorMessage' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'The connection does not exist.', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '0bc1ec92159376', + ], + 'Success' => [ + 'description' => '请求是否成功。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'ErrorCode' => [ + 'description' => '错误码。', + 'type' => 'string', + 'example' => 'Invalid.Tenant.ConnectionNotExists', + ], + 'Data' => [ + 'description' => '业务数据。', + 'type' => 'object', + 'properties' => [ + 'PageNumber' => [ + 'description' => '请求的数据页数，用于翻页。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '每页显示的条数，默认为10条，最大100条。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'TotalCount' => [ + 'description' => '分区的总数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '100', + ], + 'DataEntityList' => [ + 'description' => '实例列表。', + 'type' => 'array', + 'items' => [ + 'description' => '数据的结构。', + 'type' => 'object', + 'properties' => [ + 'PartitionPath' => [ + 'description' => '分区的目录。', + 'type' => 'string', + 'example' => 'abc', + ], + 'DataSize' => [ + 'description' => '分区的大小，单位为Byte。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '19', + ], + 'PartitionName' => [ + 'description' => '分区的名称。', + 'type' => 'string', + 'example' => 'pt=20170614', + ], + 'Comment' => [ + 'description' => '备注信息。', + 'type' => 'string', + 'example' => '备注', + ], + 'ModifiedTime' => [ + 'description' => '修改分区的时间，单位为毫秒。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1590032868000', + ], + 'CreateTime' => [ + 'description' => '创建分区的时间，单位为毫秒。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1590032868000', + ], + 'RecordCount' => [ + 'description' => '分区的数据量。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '233', + ], + 'PartitionType' => [ + 'description' => '分区的类型。', + 'type' => 'string', + 'example' => 'abc', + ], + 'PartitionGuid' => [ + 'description' => '分区的唯一标识。', + 'type' => 'string', + 'example' => 'odps.engine_name.table_name.pt=20170614', + ], + 'PartitionLocation' => [ + 'description' => 'Hive分区的地址。', + 'type' => 'string', + 'example' => 'abc', + ], + 'TableGuid' => [ + 'description' => '表的唯一标识。', + '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' => '获取表的分区列表', + 'description' => '仅支持获取MaxCompute和EMR两种引擎表的分区列表。 对于EMR引擎，仅支持采用数据湖构建（Data Lake Formation）管理元数据的新版本数据湖集群和集群版本小于3.41.0或5.7.0的Hadoop集群。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' GetMetaTablePartition接口的使用示例Demo请参见[DataWorks OpenAPI示例](https://developer.aliyun.com/article/780879?groupCode=dataworks)。', + ], + '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' => '分页的页数。默认值为1，最小值为1，最大值为30。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '每页显示的条数，默认为10条，最大100条。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'TableGuid', + 'in' => 'query', + 'schema' => [ + 'description' => '表的唯一标识。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'odps.engine_name.table_name', + ], + ], + [ + 'name' => 'StartDate', + 'in' => 'query', + 'schema' => [ + 'description' => '开始日期。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '2020-06-27', + ], + ], + [ + 'name' => 'EndDate', + 'in' => 'query', + 'schema' => [ + 'description' => '结束日期。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '2020-05-27', + ], + ], + [ + 'name' => 'TaskId', + 'in' => 'query', + 'schema' => [ + 'description' => '任务标识。', + 'type' => 'string', + 'required' => false, + 'example' => '1048576', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => [ + 'description' => 'HTTP状态码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'ErrorMessage' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'The specified parameters are invalid.', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '0bc1ec92159376****', + ], + 'Success' => [ + 'description' => '请求是否成功。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'ErrorCode' => [ + 'description' => '错误码。', + 'type' => 'string', + 'example' => '1031203110005', + ], + 'Data' => [ + 'description' => '业务数据。', + 'type' => 'object', + 'properties' => [ + 'PageNumber' => [ + 'description' => '分页的页数。默认值为1，最小值为1，最大值为30。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '每页显示的条数，默认为10条，最大100条。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'TotalCount' => [ + 'description' => '表的总数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '100', + ], + 'DataEntityList' => [ + 'description' => '实例列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'EndTime' => [ + 'description' => '结束时间。', + 'type' => 'string', + 'example' => '2020-01-01 00:01:00', + ], + 'TaskInstanceId' => [ + 'description' => '实例ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '3521', + ], + 'StartTime' => [ + 'description' => '开始时间。', + 'type' => 'string', + 'example' => '2020-01-01 00:00:00', + ], + 'ProjectId' => [ + 'description' => '工作空间的ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '333', + ], + 'WaitTime' => [ + 'description' => '等待时间。', + 'type' => 'string', + 'example' => '323', + ], + 'TableGuid' => [ + 'description' => 'ODPS表的唯一标识。', + 'type' => 'string', + 'example' => 'odps.engine_name.table_name', + ], + 'TaskId' => [ + 'description' => '任务标识。', + 'type' => 'string', + 'example' => '1048576', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + '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' => '获取表的产出信息', + 'summary' => '该接口用于获取表的产出信息。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' GetMetaTableOutput接口的使用示例Demo请参见[DataWorks OpenAPI示例](https://developer.aliyun.com/article/780879?groupCode=dataworks)。', + ], + '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' => '请求的数据页数，用于翻页。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'formData', + 'schema' => [ + 'description' => '每页显示的条数，默认为10条，最大100条。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'TableGuid', + 'in' => 'formData', + 'schema' => [ + 'description' => '表的唯一标识，格式为odps.projectName.tableName。您可以通过调用[GetMetaDBTableList](~~2780086~~)，获取表的唯一标识。'."\n" + .'> 当前仅支持调用[GetMetaTableChangeLog](~~2780094~~)获取MaxCompute表的变更日志。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'odps.engine_name.table_name', + ], + ], + [ + 'name' => 'ChangeType', + 'in' => 'formData', + 'schema' => [ + 'description' => '变更类型，包括CREATE_TABLE、ALTER_TABLE、DROP_TABLE、ADD_PARTITION和DROP_PARTITION。', + 'type' => 'string', + 'required' => false, + 'example' => 'ALTER_TABLE', + ], + ], + [ + 'name' => 'ObjectType', + 'in' => 'formData', + 'schema' => [ + 'description' => '变更主体类别，包括TABLE和PARTITION。', + 'type' => 'string', + 'required' => false, + 'example' => 'TABLE', + ], + ], + [ + 'name' => 'StartDate', + 'in' => 'formData', + 'schema' => [ + 'description' => '表变更的开始日期，格式为yyyy-MM-dd HH:mm:ss。'."\n" + .'- 如果输入的日期校验失败，则系统默认获取当前时间为表变更的开始日期。'."\n" + .'- 当输入的变更开始日期和结束日期都校验失败时，则系统自动获取最近30天的表变更记录。'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '2020-06-01 00:00:00', + ], + ], + [ + 'name' => 'EndDate', + 'in' => 'formData', + 'schema' => [ + 'description' => '表变更的结束日期，格式为yyyy-MM-dd HH:mm:ss。'."\n" + .'- 如果输入的日期校验失败，则系统默认获取当前时间为表变更的结束日期。'."\n" + .'- 当输入的变更开始日期和结束日期都校验失败时，则系统自动获取最近30天的表变更记录。', + 'type' => 'string', + 'required' => false, + 'example' => '2020-06-02 00:00:00', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回对象', + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => [ + 'description' => 'HTTP状态码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'ErrorMessage' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'The connection does not exist.', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '0bc1ec92159376', + ], + 'Success' => [ + 'description' => '请求是否成功。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'ErrorCode' => [ + 'description' => '错误码。', + 'type' => 'string', + 'example' => 'Invalid.Tenant.ConnectionNotExists', + ], + 'Data' => [ + 'description' => '业务数据。', + 'type' => 'object', + 'properties' => [ + 'PageNumber' => [ + 'description' => '请求的数据页数，用于翻页。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'PageSize' => [ + 'description' => '每页显示的条数，默认为10条，最大100条。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'TotalCount' => [ + 'description' => '表的总数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10', + ], + 'DataEntityList' => [ + 'description' => '实例列表。', + 'type' => 'array', + 'items' => [ + 'description' => '返回对象', + 'type' => 'object', + 'properties' => [ + 'ObjectType' => [ + 'description' => '变更主体的类别，包括TABLE和PARTITION。', + 'type' => 'string', + 'example' => 'TABLE', + ], + 'ModifiedTime' => [ + 'description' => '修改表的时间。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1590722845000', + ], + 'CreateTime' => [ + 'description' => '创建表的时间。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1590722845000', + ], + 'ChangeContent' => [ + 'description' => '变更的内容。', + 'type' => 'string', + 'example' => '"[{\\"action\\":\\"ADD_COLUMN\\",\\"value\\":[{\\"originName\\":\\"\\",\\"originType\\":\\"\\",\\"originComment\\":\\"\\",\\"name\\":\\"id\\",\\"type\\":\\"struct<name:string>\\",\\"comment\\":\\"\\"}]}]",', + ], + 'Operator' => [ + 'description' => '操作者的名称。', + 'type' => 'string', + 'example' => 'abc', + ], + 'ChangeType' => [ + 'description' => '变更的类型。', + '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<name:string>\\",\\"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' => '获取表的变更日志', + 'summary' => '该接口用于获取表的变更日志。', + 'description' => '> 不建议使用该API，后续将有新API上线覆盖此功能。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' GetMetaTableChangeLog接口的使用示例Demo请参见[DataWorks OpenAPI示例](https://developer.aliyun.com/article/780879?groupCode=dataworks)。', + ], + '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' => '表的唯一标识。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'odps.engine_name.table_name', + ], + ], + [ + 'name' => 'WikiVersion', + 'in' => 'query', + 'schema' => [ + 'description' => '使用说明的版本。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => [ + 'description' => 'HTTP状态码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'ErrorMessage' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'The connection does not exist.', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '0bc1ec92159376', + ], + 'Success' => [ + 'description' => '请求是否成功。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'ErrorCode' => [ + 'description' => '错误码。', + 'type' => 'string', + 'example' => 'Invalid.Tenant.ConnectionNotExists', + ], + 'Data' => [ + 'description' => '业务数据。', + 'type' => 'object', + 'properties' => [ + 'ModifiedTime' => [ + 'description' => '修改表的时间。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1584444247000', + ], + 'Version' => [ + 'description' => '版本号。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'CreateTime' => [ + 'description' => '表的创建时间。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1584444247000', + ], + 'CreatorName' => [ + 'description' => '表的创建者的名称。', + 'type' => 'string', + 'example' => 'abc', + ], + 'Content' => [ + 'description' => '表的描述信息。', + 'type' => 'string', + 'example' => '# 业务需求\\n\\n<a name="xiw5n"', + ], + 'Creator' => [ + 'description' => '表的创建者。', + 'type' => 'string', + 'example' => 'abc', + ], + ], + ], + ], + ], + ], + ], + '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<a name="xiw5n"\\",\\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&lt;a name=&quot;xiw5n&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' => '获取表的使用说明', + 'summary' => '该接口用于获取表的使用说明。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' GetMetaTableIntroWiki接口的使用示例Demo请参见[DataWorks OpenAPI示例](https://developer.aliyun.com/article/780879?groupCode=dataworks)。', + ], + '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' => '类目的名称。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'category_name', + ], + ], + [ + 'name' => 'Comment', + 'in' => 'formData', + 'schema' => [ + 'description' => '类目的备注信息。', + 'type' => 'string', + 'required' => false, + 'example' => 'category 1', + ], + ], + [ + 'name' => 'ParentId', + 'in' => 'formData', + 'schema' => [ + 'description' => '父类目的ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '0', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => [ + 'description' => 'HTTP状态码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'ErrorMessage' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'The connection does not exist.', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '0bc1ec92159376', + ], + 'Success' => [ + 'description' => '请求是否成功。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'ErrorCode' => [ + 'description' => '错误码。', + 'type' => 'string', + 'example' => 'Invalid.Tenant.ConnectionNotExists', + ], + 'Data' => [ + 'description' => '类目信息。', + 'type' => 'object', + 'properties' => [ + 'CategoryId' => [ + 'description' => '类目的ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '223', + ], + ], + ], + ], + ], + ], + ], + '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' => '创建类目', + 'summary' => '该接口用于创建类目。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' CreateMetaCategory接口的使用示例Demo请参见[DataWorks OpenAPI示例](https://developer.aliyun.com/article/780879?groupCode=dataworks)。', + ], + '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' => '类目的ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + 'example' => '23', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回数据。', + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => [ + 'description' => 'HTTP状态码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Data' => [ + 'description' => '业务数据。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '0bc1ec92159376', + ], + 'ErrorMessage' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'The connection does not exist.', + ], + 'ErrorCode' => [ + 'description' => '错误码。', + 'type' => 'string', + 'example' => 'Invalid.Tenant.ConnectionNotExists', + ], + 'Success' => [ + 'description' => '请求是否成功。', + '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' => '删除类目', + 'summary' => '该接口用于删除类目。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' DeleteMetaCategory接口的使用示例Demo请参见[DataWorks OpenAPI示例](https://developer.aliyun.com/article/780879?groupCode=dataworks)。', + ], + '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' => '类目的名称。', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => 'category name ', + ], + ], + [ + 'name' => 'Comment', + 'in' => 'formData', + 'schema' => [ + 'description' => '类目的备注信息。', + 'type' => 'string', + 'required' => false, + 'example' => 'category name', + ], + ], + [ + 'name' => 'CategoryId', + 'in' => 'formData', + 'schema' => [ + 'description' => '类目的ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + 'example' => '2', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => [ + 'description' => 'HTTP状态码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Data' => [ + 'description' => '是否成功更新类目。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '0bc1ec92159376', + ], + 'ErrorMessage' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'The connection does not exist.', + ], + 'ErrorCode' => [ + 'description' => '错误码。', + 'type' => 'string', + 'example' => 'Invalid.Tenant.ConnectionNotExists', + ], + 'Success' => [ + 'description' => '请求是否成功。', + '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":"<RequestId>0bc1ec92159376</RequestId>\\n<HttpStatusCode>200</HttpStatusCode>\\n<Data>true</Data>\\n<Success>true</Success>","errorExample":""}]', + 'title' => '更新类目', + 'summary' => '该接口用于更新类目。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' UpdateMetaCategory接口的使用示例Demo请参见[DataWorks OpenAPI示例](https://developer.aliyun.com/article/780879?groupCode=dataworks)。', + ], + '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' => '类目树的ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'docRequired' => true, + 'example' => '333', + ], + ], + [ + 'name' => 'PageNum', + 'in' => 'query', + 'schema' => [ + 'description' => '请求的数据页数，用于翻页。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '每页显示的条数，默认为10条，最大100条。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回数据。', + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => [ + 'description' => 'HTTP状态码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'ErrorMessage' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'The connection does not exist.', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '0bc1ec92159376', + ], + 'Success' => [ + 'description' => '请求是否成功。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'ErrorCode' => [ + 'description' => '错误码。', + 'type' => 'string', + 'example' => 'Invalid.Tenant.ConnectionNotExists', + ], + 'Data' => [ + 'description' => '业务数据。', + 'type' => 'object', + 'properties' => [ + 'PageNum' => [ + 'description' => '请求的数据页数，用于翻页。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '每页显示的条数，默认为10条，最大100条。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'TotalCount' => [ + 'description' => '类目的总数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10', + ], + 'DataEntityList' => [ + 'description' => 'Data实例列表。', + 'type' => 'array', + 'items' => [ + 'description' => '类目详情。', + 'type' => 'object', + 'properties' => [ + 'Depth' => [ + 'description' => '类目的层数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Comment' => [ + 'description' => '类目的备注信息。', + 'type' => 'string', + 'example' => 'category 1', + ], + 'ModifiedTime' => [ + 'description' => '修改类目的时间。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1541576644000', + ], + 'CreateTime' => [ + 'description' => '创建类目的时间。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1541576644000', + ], + 'CategoryId' => [ + 'description' => '类目的ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '133', + ], + 'LastOperatorId' => [ + 'description' => '上一次操作的用户ID。', + 'type' => 'string', + 'example' => '12345', + ], + 'Name' => [ + 'description' => '类目的名称。', + 'type' => 'string', + 'example' => 'category 1', + ], + 'ParentCategoryId' => [ + 'description' => '父类目的ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '12', + ], + 'OwnerId' => [ + 'description' => '类目所有者的ID。', + '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' => '查询类目树', + 'summary' => '该接口用于查询类目树。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' GetMetaCategory接口的使用示例Demo请参见[DataWorks OpenAPI示例](https://developer.aliyun.com/article/780879?groupCode=dataworks)。', + ], + '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' => '请求的数据页数，用于翻页。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '每页显示的条数，默认为10条，最大100条。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'CategoryId', + 'in' => 'query', + 'schema' => [ + 'description' => '类目的ID，您可以调用[GetMetaCategory](~~2780099~~)获取类目的ID。类目方便您通过类别有效地组织和管理表，您可以在查找表时，通过类目来过滤目标表。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + 'minimum' => '1', + 'example' => '23', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回数据结构。', + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => [ + 'description' => 'HTTP状态码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'ErrorMessage' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'The connection does not exist.', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '0bc1ec92159376', + ], + 'Success' => [ + 'description' => '请求是否成功。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'ErrorCode' => [ + 'description' => '错误码。', + 'type' => 'string', + 'example' => 'Invalid.Tenant.ConnectionNotExists', + ], + 'Data' => [ + 'description' => '业务数据。', + 'type' => 'object', + 'properties' => [ + 'PageNumber' => [ + 'description' => '请求的数据页数，用于翻页。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '每页显示的条数，默认为10条，最大100条。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'TotalCount' => [ + 'description' => '表的总数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '20', + ], + 'TableGuidList' => [ + 'description' => '返回数据结构。', + 'type' => 'array', + 'items' => [ + 'description' => '表的列表。', + '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' => '查询指定类目下的表', + 'summary' => '该接口用于查询指定类目下的表。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' GetMetaTableListByCategory接口的使用示例Demo请参见[DataWorks OpenAPI示例](https://developer.aliyun.com/article/780879?groupCode=dataworks)。', + ], + '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' => '类目的ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + 'example' => '5', + ], + ], + [ + 'name' => 'TableGuid', + 'in' => 'query', + 'schema' => [ + 'description' => '表的唯一标识。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'odps.engine_name.table_name', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => [ + 'description' => 'HTTP状态码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Data' => [ + 'description' => '是否成功添加表至指定的类目。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '0bc1ec92159376', + ], + 'ErrorMessage' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'The connection does not exist.', + ], + '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.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' => '添加表至指定的类目', + 'summary' => '该接口用于添加表至指定的类目。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' AddToMetaCategory接口的使用示例Demo请参见[DataWorks OpenAPI示例](https://developer.aliyun.com/article/780879?groupCode=dataworks)。', + ], + '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' => '类目的ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + 'example' => '5', + ], + ], + [ + 'name' => 'TableGuid', + 'in' => 'query', + 'schema' => [ + 'description' => '表的唯一标识。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'odps.engine_name.table_name', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回数据。', + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => [ + 'description' => 'HTTP状态码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Data' => [ + 'description' => '是否成功删除表。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '0bc1ec92159376', + ], + 'ErrorMessage' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'The connection does not exist.', + ], + '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.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' => '从指定的类目中移除表', + 'summary' => '该接口用于从指定的类目中移除表。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' DeleteFromMetaCategory接口的使用示例Demo请参见[DataWorks OpenAPI示例](https://developer.aliyun.com/article/780879?groupCode=dataworks)。', + ], + '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' => 'DataWorks工作空间的ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'docRequired' => true, + 'maximum' => '9223372036854775807', + 'minimum' => '0', + 'example' => '101', + ], + ], + [ + 'name' => 'TableName', + 'in' => 'query', + 'schema' => [ + 'description' => '表的名称。', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => 'table1', + ], + ], + [ + 'name' => 'EnvType', + 'in' => 'query', + 'schema' => [ + 'description' => 'DataWorks的环境，包括0（开发环境）和1（生产环境）。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'docRequired' => true, + 'example' => '1', + ], + ], + [ + 'name' => 'TableGuid', + 'in' => 'query', + 'schema' => [ + 'description' => '表的唯一标识，格式为odps.{projectName}.{tableName}。', + 'type' => 'string', + 'required' => false, + 'example' => 'odps.test.table1', + ], + ], + [ + 'name' => 'NewOwnerId', + 'in' => 'query', + 'schema' => [ + 'description' => '新的OwnerId，为空时不更新。', + 'type' => 'string', + 'required' => false, + 'example' => '12345', + ], + ], + [ + 'name' => 'AddedLabels', + 'in' => 'formData', + 'schema' => [ + 'description' => '需要增加的标签名称，使用英文逗号（,）分隔。', + 'type' => 'string', + 'required' => false, + 'example' => 'a,b,c', + ], + ], + [ + 'name' => 'RemovedLabels', + 'in' => 'formData', + 'schema' => [ + 'description' => '需要删除的标签名称，使用英文逗号（,）分隔。', + 'type' => 'string', + 'required' => false, + 'example' => 'a,b,c', + ], + ], + [ + 'name' => 'CategoryId', + 'in' => 'query', + 'schema' => [ + 'description' => '需要关联的类目ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'maximum' => '9223372036854775807', + 'minimum' => '0', + 'example' => '101', + ], + ], + [ + 'name' => 'Visibility', + 'in' => 'query', + 'schema' => [ + 'description' => '编辑表的可见性，包括0（不可见）、1（可见）和2（工作空间可见）。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '100', + 'minimum' => '0', + 'example' => '1', + ], + ], + [ + 'name' => 'Caption', + 'in' => 'query', + 'schema' => [ + 'description' => '表的中文名称。', + 'type' => 'string', + 'required' => false, + 'example' => '中文名', + ], + ], + [ + 'name' => 'Schema', + 'in' => 'query', + 'schema' => [ + 'description' => '表Schema信息。在ODPS，用户启动了三层模型需要填写Schema信息。', + 'type' => 'string', + 'required' => false, + 'example' => 'default', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'UpdateResult' => [ + 'description' => '是否更新成功。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'RequestId' => [ + 'description' => '请求ID。', + '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":"<UpdateMetaTableResponse>\\n <UpdateResult>true</UpdateResult>\\n <RequestId>abcde</RequestId>\\n</UpdateMetaTableResponse>","errorExample":""}]', + 'title' => '更新表的Meta信息', + 'summary' => '该接口用于更新表的Meta信息。', + 'description' => '该接口仅支持MaxCompute引擎表。', + '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' => '表的唯一标识，格式为odps.{projectName}.{tableName}。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'odps.test.table1', + ], + ], + [ + 'name' => 'Content', + 'in' => 'formData', + 'schema' => [ + 'description' => '表说明的详情。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'abc', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'UpdateResult' => [ + 'description' => '表的更新结果。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'RequestId' => [ + 'description' => '本次调用的唯一ID。出现错误后，您可以根据该ID排查问题。', + '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' => '更新表的说明信息', + 'summary' => '该接口用于更新表的说明信息，当数据不存在时增加信息。', + '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' => 'DataWorks工作空间的ID。您可以调用[ListProjects](~~178393~~)，获取工作空间ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + 'example' => '123', + ], + ], + [ + 'name' => 'DataSourceType', + 'in' => 'query', + 'schema' => [ + 'description' => '数据类型，当前仅支持取值为emr。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'emr', + ], + ], + [ + 'name' => 'PageNum', + 'in' => 'query', + 'schema' => [ + 'description' => '页码数。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '10000', + 'minimum' => '1', + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '每页显示的条数，默认为10条，最大为100条。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '100', + 'minimum' => '1', + 'example' => '10', + ], + ], + [ + 'name' => 'ClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'EMR集群的ID。您可以登录[EMR的控制台](https://emr.console.aliyun.com/?spm=a2c4g.11186623.0.0.965cc5c2GeiHet#/cn-hangzhou)，获取集群ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'abc', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回数据结构。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'abc', + ], + 'DatabaseInfo' => [ + 'description' => '数据库的信息。', + 'type' => 'object', + 'properties' => [ + 'TotalCount' => [ + 'description' => '数据库的总数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10', + ], + 'DbList' => [ + 'description' => '数据库列表。', + 'type' => 'array', + 'items' => [ + 'description' => '返回数据结构。', + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'description' => '数据库的类型。', + 'type' => 'string', + 'example' => 'HIVE', + ], + 'CreateTimeStamp' => [ + 'description' => '创建数据库的时间。该结果显示为时间戳，您可以根据使用的时区将时间戳转换为相应日期。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1388776825', + ], + 'UUID' => [ + 'description' => '数据库的唯一标识。', + 'type' => 'string', + 'example' => '32342', + ], + 'ModifiedTimeStamp' => [ + 'description' => '更新数据库的时间。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1388776837', + ], + 'Name' => [ + 'description' => '数据库的名称。', + 'type' => 'string', + 'example' => 'name', + ], + 'OwnerId' => [ + 'description' => 'Owner的ID。', + 'type' => 'string', + 'example' => '1232', + ], + 'Location' => [ + 'description' => '存储数据库的地址。', + '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' => '查询数据库列表', + 'summary' => '该接口用于查询数据库列表。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ListMetaDB接口的使用示例Demo请参见[DataWorks OpenAPI示例](https://developer.aliyun.com/article/780879?groupCode=dataworks)。', + ], + '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' => '一级主题ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'docRequired' => true, + 'maximum' => '9223372036854775807', + 'minimum' => '0', + 'example' => '101', + ], + ], + [ + 'name' => 'SecondLevelThemeId', + 'in' => 'query', + 'schema' => [ + 'description' => '二级主题ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'docRequired' => true, + 'maximum' => '9223372036854775807', + 'minimum' => '0', + 'example' => '101', + ], + ], + [ + 'name' => 'LevelId', + 'in' => 'query', + 'schema' => [ + 'description' => '层级ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'docRequired' => true, + 'maximum' => '9223372036854775807', + 'minimum' => '0', + 'example' => '101', + ], + ], + [ + 'name' => 'TableGuid', + 'in' => 'query', + 'schema' => [ + 'description' => '表的唯一标识，格式为odps.{projectName}.{tableName}。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'odps.test.table1', + ], + ], + [ + 'name' => 'LevelType', + 'in' => 'query', + 'schema' => [ + 'description' => '层级类型，包括1（逻辑层级）和2（物理层级）。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '2147483647', + 'minimum' => '0', + 'example' => '1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'UpdateResult' => [ + 'description' => '表是否更新成功。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'RequestId' => [ + 'description' => '请求ID。', + '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":"<RequestId>abcde</RequestId>\\n<UpdateResult>true</UpdateResult>","errorExample":""}]', + 'title' => '修改表模型信息', + 'summary' => '修改表的主题、层级和物理分类等信息。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'CreateTableTheme' => [ + 'summary' => '调用CreateTableTheme创建主题。不建议使用该API，后续将有新API上线覆盖此功能。', + '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' => 'DataWorks工作空间的ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'docRequired' => true, + 'maximum' => '9223372036854775807', + 'minimum' => '1', + 'example' => '123', + ], + ], + [ + 'name' => 'Level', + 'in' => 'query', + 'schema' => [ + 'description' => '主题的层级，包括1（一级主题）和2（二级主题）。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'docRequired' => true, + 'maximum' => '10', + 'minimum' => '1', + 'example' => '1', + ], + ], + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => [ + 'description' => '主题的名称。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '主题名称', + ], + ], + [ + 'name' => 'ParentId', + 'in' => 'query', + 'schema' => [ + 'description' => '父类层级ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'maximum' => '9223372036854775807', + 'minimum' => '1', + 'example' => '122', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回数据。', + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => [ + 'description' => 'HTTP状态码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'ABCd', + ], + 'ErrorMessage' => [ + 'description' => '错误消息。', + 'type' => 'string', + 'example' => 'success', + ], + 'ErrorCode' => [ + 'description' => '错误码。', + 'type' => 'string', + 'example' => '0', + ], + 'Success' => [ + 'description' => '是否成功。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'ThemeId' => [ + 'description' => '生成的主题ID。', + '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' => '创建主题', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DeleteTableTheme' => [ + 'summary' => '调用DeleteTableTheme删除主题。不建议使用该API，后续将有新API上线覆盖此功能。', + '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' => '主题ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + 'maximum' => '9223372036854775807', + 'minimum' => '1', + 'example' => '123', + ], + ], + [ + 'name' => 'ProjectId', + 'in' => 'query', + 'schema' => [ + 'description' => 'DataWorks工作空间ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'maximum' => '9223372036854775807', + 'minimum' => '1', + 'example' => '123', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => [ + 'description' => 'HTTP状态码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'abcdef', + ], + 'ErrorMessage' => [ + 'description' => '错误消息。', + 'type' => 'string', + 'example' => 'The specified parameters are invalid.', + ], + 'ErrorCode' => [ + 'description' => '错误码。', + 'type' => 'string', + 'example' => '1031203110005', + ], + 'Success' => [ + 'description' => '主题是否删除成功：'."\n" + ."\n" + .'- true：是'."\n" + ."\n" + .'- false：否', + 'type' => 'boolean', + 'example' => 'true', + ], + 'DeleteResult' => [ + '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.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' => '删除主题', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'UpdateTableTheme' => [ + 'summary' => '调用UpdateTableTheme更新主题。不建议使用该API，后续将有新API上线覆盖此功能。', + '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' => '工作空间ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'docRequired' => true, + 'maximum' => '9223372036854775807', + 'minimum' => '1', + 'example' => '123', + ], + ], + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => [ + 'description' => '主题的名称。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '主题名称', + ], + ], + [ + 'name' => 'ThemeId', + 'in' => 'query', + 'schema' => [ + 'description' => '主题ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + 'maximum' => '9223372036854775807', + 'minimum' => '1', + 'example' => '123', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => [ + 'description' => 'HTTP状态码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'abcd', + ], + 'ErrorMessage' => [ + 'description' => '错误消息。', + 'type' => 'string', + 'example' => 'The specified parameters are invalid.', + ], + 'UpdateResult' => [ + 'description' => '是否成功返回更新结果：'."\n" + ."\n" + .'- true：是'."\n" + ."\n" + .'- false：否', + 'type' => 'boolean', + 'example' => 'true', + ], + 'ErrorCode' => [ + 'description' => '错误码。', + 'type' => 'string', + 'example' => '1031203110005', + ], + 'Success' => [ + 'description' => '主题是否更新成功：'."\n" + ."\n" + .'- true：是'."\n" + ."\n" + .'- false：否', + '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\\": \\"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' => '更新主题', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'ListTableTheme' => [ + 'summary' => '调用ListTableTheme查询主题列表。不建议使用该API，后续将有新API上线覆盖此功能。', + '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' => 'DataWorks工作空间的ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'docRequired' => true, + 'maximum' => '9223372036854775807', + 'minimum' => '1', + 'example' => '123', + ], + ], + [ + 'name' => 'ParentId', + 'in' => 'query', + 'schema' => [ + 'description' => '父类ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'maximum' => '9223372036854775807', + 'minimum' => '1', + 'example' => '121', + ], + ], + [ + 'name' => 'PageNum', + 'in' => 'query', + 'schema' => [ + 'description' => '分页的页数。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '2147483647', + 'minimum' => '1', + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '每页显示的条数，默认为10条，最大100条。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '100', + 'minimum' => '1', + 'example' => '10', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回数据。', + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => [ + 'description' => 'HTTP状态码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'ErrorMessage' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'The specified parameters are invalid.', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'abcde', + ], + 'Success' => [ + 'description' => '是否成功查询主题。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'ErrorCode' => [ + 'description' => '错误码。', + 'type' => 'string', + 'example' => '1031203110005', + ], + 'Data' => [ + 'description' => '层级数据。', + 'type' => 'object', + 'properties' => [ + 'TotalCount' => [ + 'description' => '内容总数量。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10', + ], + 'ThemeList' => [ + 'description' => '层级列表。', + 'type' => 'array', + 'items' => [ + 'description' => '主题列表详情。', + 'type' => 'object', + 'properties' => [ + 'CreateTimeStamp' => [ + 'description' => '创建层级的时间。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '123432343243', + ], + 'ParentId' => [ + 'description' => '父节点ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '122', + ], + 'ThemeId' => [ + 'description' => '主题ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '123', + ], + 'ProjectId' => [ + 'description' => '工作空间ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '123', + ], + 'Name' => [ + 'description' => '层级的名称。', + 'type' => 'string', + 'example' => '层级名称', + ], + 'Level' => [ + 'description' => '1（一级层级）和2（二级层级）。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Creator' => [ + 'description' => '层级的创建人。', + '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' => '查询主题列表', + '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' => '表的唯一ID，格式为odps.${projectName}.${tableName}。'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'odps.project1.name1', + ], + ], + [ + 'name' => 'DataSourceType', + 'in' => 'query', + 'schema' => [ + 'description' => '数据类型，目前只支持odps。'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'odps', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回数据。', + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => [ + 'description' => 'HTTP状态码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'ErrorMessage' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'success', + ], + 'RequestId' => [ + 'description' => '本次调用的唯一ID。出现错误后，您可以根据该ID排查问题。', + 'type' => 'string', + 'example' => '1324afdsfde', + ], + 'Success' => [ + 'description' => '调用是否成功。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'ErrorCode' => [ + 'description' => '错误码。', + 'type' => 'string', + 'example' => '0', + ], + 'Entity' => [ + 'description' => '返回数据。', + 'type' => 'object', + 'properties' => [ + 'Theme' => [ + 'description' => '返回的主题信息。', + 'type' => 'array', + 'items' => [ + 'description' => '主题信息。', + 'type' => 'object', + 'properties' => [ + 'ParentId' => [ + 'description' => '父主题ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'Name' => [ + 'description' => '主题名称。', + 'type' => 'string', + 'example' => 'theme1', + ], + 'ThemeId' => [ + 'description' => '主题ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '123', + ], + 'Level' => [ + 'description' => '主题类型，取值如下：'."\n" + .'- 1：一级主题。'."\n" + .'- 2：二级主题。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + ], + ], + ], + 'Level' => [ + 'description' => '返回的层级信息。', + 'type' => 'array', + 'items' => [ + 'description' => '层级信息。', + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'description' => '层级类型，取值如下：'."\n" + .'- 1：逻辑层级。'."\n" + .'- 2：物理层级。'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Description' => [ + 'description' => '层级的描述。', + 'type' => 'string', + 'example' => '描述', + ], + 'Name' => [ + 'description' => '层级名称。', + 'type' => 'string', + 'example' => 'level1', + ], + 'LevelId' => [ + 'description' => '层级ID。', + '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' => '获取表的主题和层级信息', + 'summary' => '获取表的主题和层级信息。', + ], + 'CreateTableLevel' => [ + 'summary' => '调用CreateTableLevel创建层级。不建议使用该API，后续将有新API上线覆盖此功能。', + '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' => 'DataWorks工作空间的ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'docRequired' => true, + 'maximum' => '9223372036854775807', + 'minimum' => '1', + 'example' => '123', + ], + ], + [ + 'name' => 'LevelType', + 'in' => 'query', + 'schema' => [ + 'description' => '层级的类型，包括1（逻辑层级）和2（物理层级）。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'docRequired' => true, + 'maximum' => '10', + 'minimum' => '1', + 'example' => '1', + ], + ], + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => [ + 'description' => '层级的名称。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '层级1', + ], + ], + [ + 'name' => 'Description', + 'in' => 'query', + 'schema' => [ + 'description' => '层级的描述。', + 'type' => 'string', + 'required' => false, + 'example' => '层级描述', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回数据。', + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => [ + 'description' => 'HTTP状态码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '请求id', + ], + 'ErrorMessage' => [ + 'description' => '错误消息。', + 'type' => 'string', + 'example' => 'The specified parameters are invalid.', + ], + 'ErrorCode' => [ + 'description' => '错误码。', + 'type' => 'string', + 'example' => '1031203110005', + ], + 'Success' => [ + 'description' => '是否成功创建层级。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'LevelId' => [ + 'description' => '层级ID。', + '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' => '创建层级', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'UpdateTableLevel' => [ + 'summary' => '调用UpdateTableLevel更新层级。不建议使用该API，后续将有新API上线覆盖此功能。', + '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' => 'DataWorks工作空间的ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + 'maximum' => '9223372036854775807', + 'minimum' => '1', + 'example' => '123', + ], + ], + [ + 'name' => 'LevelType', + 'in' => 'query', + 'schema' => [ + 'description' => '层级的类型，包括1（逻辑层级）和2（物理层级）。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'docRequired' => true, + 'maximum' => '10', + 'minimum' => '0', + 'example' => '1', + ], + ], + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => [ + 'description' => '层级的名称。', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => '层级名称', + ], + ], + [ + 'name' => 'Description', + 'in' => 'query', + 'schema' => [ + 'description' => '层级的描述。', + 'type' => 'string', + 'required' => false, + 'example' => '层级描述', + ], + ], + [ + 'name' => 'LevelId', + 'in' => 'query', + 'schema' => [ + 'description' => '需要更新的层级ID。您可以通过ListLevel获取。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + 'maximum' => '9223372036854775807', + 'minimum' => '1', + 'example' => '123', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回数据。', + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => [ + 'description' => 'HTTP状态码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'abcde', + ], + 'ErrorMessage' => [ + 'description' => '错误消息。', + 'type' => 'string', + 'example' => 'The specified parameters are invalid.', + ], + 'UpdateResult' => [ + 'description' => '是否成功返回结果。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'ErrorCode' => [ + 'description' => '错误码。', + 'type' => 'string', + 'example' => '1031203110005', + ], + '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.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' => '更新层级', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DeleteTableLevel' => [ + 'summary' => '调用DeleteTableLevel删除层级。不建议使用该API，后续将有新API上线覆盖此功能。', + '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' => '需要删除的层级ID。您可以从ListLevel接口获取。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + 'maximum' => '9223372036854775807', + 'minimum' => '1', + 'example' => '123', + ], + ], + [ + 'name' => 'ProjectId', + 'in' => 'query', + 'schema' => [ + 'description' => 'DataWorks工作空间的ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + 'maximum' => '9223372036854775807', + 'minimum' => '1', + 'example' => '123', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回数据。', + 'type' => 'object', + 'properties' => [ + 'DeleteResult' => [ + 'description' => '删除结果。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'RequestId' => [ + 'description' => '请求ID。', + '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' => '删除层级', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'ListTableLevel' => [ + 'summary' => '调用ListTableLevel查询层级列表。不建议使用该API，后续将有新API上线覆盖此功能。', + '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' => 'DataWorks工作空间的ID。您可以进入DataWorks管理控制台获取。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + 'maximum' => '9223372036854775807', + 'minimum' => '1', + 'example' => '123', + ], + ], + [ + 'name' => 'LevelType', + 'in' => 'query', + 'schema' => [ + 'description' => '层级的类型，包括1（逻辑层级）和2（物理层级）。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'docRequired' => true, + 'maximum' => '10', + 'minimum' => '0', + 'example' => '1', + ], + ], + [ + 'name' => 'PageNum', + 'in' => 'query', + 'schema' => [ + 'description' => '分页查询页码。默认为1。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '每页显示的条数，默认为10条。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回数据。', + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => [ + 'description' => 'HTTP状态码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'ErrorMessage' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'The specified parameters are invalid.', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'abc', + ], + 'Success' => [ + 'description' => '是否成功查询层级列表。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'ErrorCode' => [ + 'description' => '错误码。', + 'type' => 'string', + 'example' => '1031203110005 ', + ], + 'TableLevelInfo' => [ + 'description' => '层级的信息。', + 'type' => 'object', + 'properties' => [ + 'TotalCount' => [ + 'description' => '层级的总数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10', + ], + 'LevelList' => [ + 'description' => '层级列表。', + 'type' => 'array', + 'items' => [ + 'description' => '层级信息。', + 'type' => 'object', + 'properties' => [ + 'LevelType' => [ + 'description' => '层级的类型，包括1（逻辑层级）和2（物理层级）。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Description' => [ + 'description' => '层级的描述。', + 'type' => 'string', + 'example' => '层级描述', + ], + 'Name' => [ + 'description' => '层级的名称。', + 'type' => 'string', + 'example' => '层级1', + ], + 'ProjectId' => [ + 'description' => 'DataWorks工作空间的ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '123', + ], + 'LevelId' => [ + 'description' => '层级ID。', + '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' => '查询层级列表', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'UpdateMetaCollection' => [ + 'summary' => '该接口用于更新集合对象的名称和注释。', + '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' => '集合的唯一标识', + 'type' => 'string', + 'required' => true, + 'example' => 'album.396397', + ], + ], + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => [ + 'description' => '名称', + 'type' => 'string', + 'required' => false, + 'example' => 'myCollectionName', + ], + ], + [ + 'name' => 'Comment', + 'in' => 'query', + 'schema' => [ + 'description' => '集合备注'."\n" + .'长度限制：1-64字符', + 'type' => 'string', + 'required' => false, + 'example' => 'this is a comment', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '返回结构', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求的ID。用于定位日志，排查问题。'."\n" + ."\n", + 'type' => 'string', + 'example' => '0000-ABCD-E****', + ], + 'Status' => [ + 'description' => '更新结果：'."\n" + .'true: 成功'."\n" + .'false: 失败', + 'type' => 'boolean', + 'enumValueTitles' => [], + 'example' => 'true', + ], + 'HttpStatusCode' => [ + 'description' => 'HTTP状态码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'ErrorMessage' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'The specified product does not exist.', + ], + 'ErrorCode' => [ + 'description' => '错误码。', + 'type' => 'string', + 'example' => '9999', + ], + 'Success' => [ + 'description' => '调用是否成功。取值如下：'."\n" + .'- true：调用成功。'."\n" + .'- false：调用失败。', + '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' => '更新集合对象', + 'description' => '目前只支持更新名称(name)、注释(comment)。', + 'requestParamsDescription' => '更新的时候 Name 、Comment 二者至少要提供一个。', + ], + 'ListMetaCollections' => [ + 'summary' => '查询集合信息。 集合的概念包括数据地图页面上的专辑、专辑中的子类目等。 通过本接口可以指定集合类型查询集合信息。', + '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' => '父集合唯一标识', + 'type' => 'string', + 'required' => false, + 'example' => 'Album.1234', + ], + ], + [ + 'name' => 'NextToken', + 'in' => 'query', + 'schema' => [ + 'description' => '分页信息，指定本次读取的起始点', + 'type' => 'string', + 'required' => false, + 'example' => '12345', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '每页显示的条数，默认为10条，最大100条。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'Keyword', + 'in' => 'query', + 'schema' => [ + 'description' => '关键字。', + 'type' => 'string', + 'required' => false, + 'example' => '关键词', + ], + ], + [ + 'name' => 'OrderBy', + 'in' => 'query', + 'schema' => [ + 'description' => '排序字段名称。', + 'type' => 'string', + 'required' => false, + 'example' => '排序字段', + ], + ], + [ + 'name' => 'CollectionType', + 'in' => 'query', + 'schema' => [ + 'description' => '查询的集合类型，取值范围：'."\n" + .'- **ALBUM**：专辑集合'."\n" + .'- **ALBUM_CATEGORY**：专辑内的类目', + 'type' => 'string', + 'required' => true, + 'enumValueTitles' => [], + 'example' => 'ALBUM', + ], + ], + [ + 'name' => 'Creator', + 'in' => 'query', + 'schema' => [ + 'description' => '创建者用户ID。', + 'type' => 'string', + 'required' => false, + 'example' => '1200759642363000', + ], + ], + [ + 'name' => 'Administrator', + 'in' => 'query', + 'schema' => [ + 'description' => '集合管理员ID', + 'type' => 'string', + 'required' => false, + 'example' => '1200759642363000', + ], + ], + [ + 'name' => 'Follower', + 'in' => 'query', + 'schema' => [ + 'description' => '集合关注者ID', + 'type' => 'string', + 'required' => false, + 'example' => '1200759642363000', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '返回结构', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求的ID。用于定位日志，排查问题。'."\n" + ."\n", + 'type' => 'string', + 'example' => 'E25887B7-579C-54A5-9C4F-83A0DE367DDE', + ], + 'Data' => [ + 'description' => '返回对象', + 'type' => 'object', + 'properties' => [ + 'NextToken' => [ + 'description' => '下一页的token', + 'type' => 'string', + 'example' => '37ae2053d87d380f28ce0dc0853ca51e', + ], + 'CollectionList' => [ + 'description' => '数组对象', + 'type' => 'array', + 'items' => [ + 'description' => '返回的集合对象', + '$ref' => '#/components/schemas/Collection', + ], + ], + ], + ], + 'Success' => [ + 'description' => '调用是否成功。取值如下：'."\n" + .'- true：调用成功。'."\n" + .'- false：调用失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'ErrorCode' => [ + 'description' => '错误码。', + 'type' => 'string', + 'example' => 'Invalid.Collection.NotExists', + ], + 'ErrorMessage' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'The specified parameters are invalid.', + ], + 'HttpStatusCode' => [ + 'description' => 'HTTP状态码。', + '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' => '查询集合信息', + 'description' => '集合包括： ALBUM（专辑集合）， ALBUM_CATEGORY（专辑内的子类目）。', + 'requestParamsDescription' => 'Creator、Administrator、Follower 这三个参数，最多可以设置一个', + ], + 'ListMetaCollectionEntities' => [ + 'summary' => '该接口用于查询集合中的实体。', + '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' => '集合唯一标识。', + 'type' => 'string', + 'required' => true, + 'example' => 'album.12345', + ], + ], + [ + 'name' => 'EntityType', + 'in' => 'query', + 'schema' => [ + 'description' => '实体类型。示例：maxcompute-table表示MaxCompute表类型。', + 'type' => 'string', + 'required' => false, + 'example' => 'maxcompute-table', + ], + ], + [ + 'name' => 'Keyword', + 'in' => 'query', + 'schema' => [ + 'description' => '搜索关键词。', + 'type' => 'string', + 'required' => false, + 'example' => 'test', + ], + ], + [ + 'name' => 'NextToken', + 'in' => 'query', + 'schema' => [ + 'description' => '分页信息，指定本次读取的起始点。', + 'type' => 'string', + 'required' => false, + 'example' => '12222', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '分页大小。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'OpenApiMetaResultModel', + 'description' => 'OpenApiMetaResultModel', + 'type' => 'object', + 'properties' => [ + 'Data' => [ + 'description' => '返回结构体。', + 'type' => 'object', + 'properties' => [ + 'NextToken' => [ + 'description' => '下一页的Token。', + 'type' => 'string', + 'example' => '123344', + ], + 'EntityList' => [ + 'description' => '实体数组。', + 'type' => 'array', + 'items' => [ + 'description' => '实体信息。', + '$ref' => '#/components/schemas/Entity', + ], + ], + ], + ], + 'RequestId' => [ + 'description' => '请求的ID。用于定位日志，排查问题。'."\n" + ."\n", + 'type' => 'string', + 'example' => 'E25887B7-579C-54A5-9C4F-83A0DE367DD', + ], + 'Success' => [ + 'description' => '调用是否成功。取值如下：'."\n" + ."\n" + .'true：调用成功。'."\n" + ."\n" + .'false：调用失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'ErrorCode' => [ + 'description' => '错误码。'."\n" + ."\n", + 'type' => 'string', + 'example' => 'Invalid.Collection.NotExists', + ], + 'ErrorMessage' => [ + 'description' => '错误信息。'."\n" + ."\n", + 'type' => 'string', + 'example' => 'The specified parameters are invalid.', + ], + 'HttpStatusCode' => [ + 'description' => 'HTTP状态码。'."\n" + ."\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' => '查询集合中的实体', + ], + 'DeleteMetaCollection' => [ + 'summary' => '删除集合。', + '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' => '集合唯一标识符', + 'type' => 'string', + 'required' => true, + 'example' => 'album.12333', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '返回结构', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求的ID。用于定位日志，排查问题。'."\n" + ."\n", + 'type' => 'string', + 'example' => '0000-ABCD-E****', + ], + 'Status' => [ + 'description' => '操作结果：'."\n" + .' '."\n" + .'true: 成功'."\n" + ."\n" + .'false: 失败'."\n" + ."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'HttpStatusCode' => [ + 'description' => 'HTTP状态码。'."\n" + ."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'ErrorMessage' => [ + 'description' => '错误信息。'."\n" + ."\n", + 'type' => 'string', + 'example' => 'The specified product does not exist.', + ], + 'ErrorCode' => [ + 'description' => '错误码。'."\n" + ."\n", + 'type' => 'string', + 'example' => '999999', + ], + 'Success' => [ + 'description' => '调用是否成功。取值如下：'."\n" + ."\n" + .'true：调用成功。'."\n" + ."\n" + .'false：调用失败。', + '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' => '删除集合', + ], + 'GetMetaCollectionDetail' => [ + 'summary' => '该接口用于查询集合的详细信息。', + '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' => '集合唯一标识符。', + 'type' => 'string', + 'required' => true, + 'example' => 'album.12345', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '返回数据。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。用于定位日志，排查问题。', + 'type' => 'string', + 'example' => '0000-ABCD-E****', + ], + 'Collection' => [ + 'description' => '集合对象。', + '$ref' => '#/components/schemas/Collection', + ], + 'Success' => [ + 'description' => '调用是否成功。取值如下：'."\n" + ."\n" + .'true：调用成功。'."\n" + ."\n" + .'false：调用失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'ErrorCode' => [ + 'description' => '错误码。'."\n" + ."\n", + 'type' => 'string', + 'example' => '9999', + ], + 'ErrorMessage' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'album.xxxx does not exist.', + ], + 'HttpStatusCode' => [ + 'description' => 'HTTP状态码。'."\n" + ."\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' => '查询集合详情信息', + ], + 'DeleteMetaCollectionEntity' => [ + 'summary' => '该接口用于删除集合中的实体。', + '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' => '集合唯一识别符。', + 'type' => 'string', + 'required' => true, + 'example' => 'album.12345', + ], + ], + [ + 'name' => 'EntityQualifiedName', + 'in' => 'query', + 'schema' => [ + 'description' => '实体唯一标识符。', + 'type' => 'string', + 'required' => true, + 'example' => 'maxcompute.projectA.tableB', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '返回数据。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。用于定位日志，排查问题。', + 'type' => 'string', + 'example' => '0000-ABCD-E****', + ], + 'Status' => [ + 'description' => '操作结果：'."\n" + .'- true：成功。'."\n" + .'- false：失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'HttpStatusCode' => [ + 'description' => 'HTTP状态码。'."\n" + ."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'ErrorMessage' => [ + 'description' => '错误信息。'."\n" + ."\n", + 'type' => 'string', + 'example' => 'entity not exist', + ], + 'ErrorCode' => [ + 'description' => '错误码。'."\n" + ."\n", + 'type' => 'string', + 'example' => '999999', + ], + 'Success' => [ + 'description' => '调用是否成功。取值如下：'."\n" + .'- true：调用成功。'."\n" + .'- false：调用失败。', + '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' => '删除集合中的实体', + ], + 'AddMetaCollectionEntity' => [ + 'summary' => '该接口用于添加实体到集合中。', + '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' => '集合唯一标识符。', + 'type' => 'string', + 'required' => true, + 'example' => 'album.2222', + ], + ], + [ + 'name' => 'EntityQualifiedName', + 'in' => 'query', + 'schema' => [ + 'description' => '实体唯一标识符。', + 'type' => 'string', + 'required' => true, + 'example' => 'maxcompute-table.projectA.tableB', + ], + ], + [ + 'name' => 'Remark', + 'in' => 'query', + 'schema' => [ + 'description' => '对实体的备注信息。', + 'type' => 'string', + 'required' => false, + 'example' => 'this is a remark', + 'maxLength' => 50, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '返回结构。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求的ID。用于定位日志，排查问题。'."\n" + ."\n", + 'type' => 'string', + 'example' => '0000-ABCD-E****', + ], + 'Status' => [ + 'description' => '操作结果： '."\n" + ."\n" + .'- true: 成功 '."\n" + .'- false: 失败'."\n" + ."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'HttpStatusCode' => [ + 'description' => 'HTTP状态码。'."\n" + ."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'ErrorMessage' => [ + 'description' => '错误信息。'."\n" + ."\n", + 'type' => 'string', + 'example' => 'The specified product does not exist.', + ], + 'ErrorCode' => [ + 'description' => '错误码。'."\n" + ."\n", + 'type' => 'string', + 'example' => '9999', + ], + 'Success' => [ + 'description' => '调用是否成功。取值如下：'."\n" + .'- true：调用成功。'."\n" + .'- false：调用失败。', + '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' => '添加实体到集合中', + ], + 'CreateMetaCollection' => [ + 'summary' => '创建集合对象。', + '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' => '集合名称, '."\n" + .'长度限制:1-32字符', + 'type' => 'string', + 'required' => true, + 'example' => 'collection_name', + ], + ], + [ + 'name' => 'Comment', + 'in' => 'query', + 'schema' => [ + 'description' => '集合备注'."\n" + .'长度限制：1-64字符', + 'type' => 'string', + 'required' => false, + 'example' => 'this is a comment', + ], + ], + [ + 'name' => 'ParentQualifiedName', + 'in' => 'query', + 'schema' => [ + 'description' => '父集合唯一标识', + 'type' => 'string', + 'required' => false, + 'example' => 'album.333508', + ], + ], + [ + 'name' => 'CollectionType', + 'in' => 'query', + 'schema' => [ + 'description' => '集合类型', + 'type' => 'string', + 'required' => true, + 'example' => 'ALBUM', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request', + 'type' => 'string', + 'example' => 'E6F0DBDD-5AD****', + ], + 'QualifiedName' => [ + 'description' => '集合的唯一标识', + 'type' => 'string', + 'example' => 'album.11111', + ], + 'Success' => [ + 'description' => '调用是否成功。取值如下：'."\n" + .'- true：调用成功。'."\n" + .'- false：调用失败。', + 'type' => 'string', + 'example' => 'true', + ], + 'ErrorCode' => [ + 'description' => '错误码。', + 'type' => 'string', + 'example' => 'NoPermission', + ], + 'ErrorMessage' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'The specified parameters are invalid.', + ], + 'HttpStatusCode' => [ + 'description' => 'HTTP错误码。', + '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' => '创建集合对象', + 'description' => '集合目前有多种类型， 同一集合类型内要保证名称唯一性。', + 'requestParamsDescription' => '由于专辑下的类目是需要建立在专辑下的。 '."\n" + .'只有创建了专辑后，才能通过指定parentQualifiedName = 专辑的qualifiedName ， 创建专辑内的子类目', + ], + 'ListLineage' => [ + 'summary' => '查询实体的上下游血缘关系。', + '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' => '实体唯一标识符。', + 'type' => 'string', + 'required' => true, + 'example' => 'maxcompute-table.project.table', + ], + ], + [ + 'name' => 'NextToken', + 'in' => 'query', + 'schema' => [ + 'description' => '分页信息，指定本次读取的起始点。', + 'type' => 'string', + 'required' => false, + 'example' => 'next-token-from-previous-request', + ], + ], + [ + 'name' => 'Keyword', + 'in' => 'query', + 'schema' => [ + 'description' => '实体名称关键词。', + 'type' => 'string', + 'required' => false, + 'example' => 'name-keyword', + ], + ], + [ + 'name' => 'Direction', + 'in' => 'query', + 'schema' => [ + 'description' => '血缘上下游。取值如下： '."\n" + .'- up：上游。'."\n" + .'- down：下游。', + 'type' => 'string', + 'required' => true, + 'example' => 'up', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '分页大小，最大为100。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'OpenApiMetaResultModel'."\n" + ."\n", + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => [ + 'description' => 'HTTP状态码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'ErrorMessage' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'qualifiedName should be in format as entity-table.entity-guid', + ], + 'RequestId' => [ + 'description' => '请求的ID。用于定位日志、排查问题。', + 'type' => 'string', + 'example' => '64B-587A-8CED-969E1973887FXXX-TT', + ], + 'Success' => [ + 'description' => '调用是否成功。取值如下：'."\n" + .'- true：调用成功。'."\n" + .'- false：调用失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'ErrorCode' => [ + 'description' => '错误码。', + 'type' => 'string', + 'example' => '1010040007', + ], + 'Data' => [ + 'description' => '返回结构体。', + 'type' => 'object', + 'properties' => [ + 'NextToken' => [ + 'description' => '分页信息，指定下次读取的起始点。', + 'type' => 'string', + 'example' => 'nextTokenFromRequest-xxxsd-ff', + ], + 'DataEntityList' => [ + 'description' => '实体结构体数组。', + 'type' => 'array', + 'items' => [ + 'description' => '实体结构体。', + 'type' => 'object', + 'properties' => [ + 'Entity' => [ + 'description' => '实体信息。', + '$ref' => '#/components/schemas/Entity', + ], + 'CreateTimestamp' => [ + 'description' => '血缘创建时间。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1686215809269', + ], + 'RelationList' => [ + 'description' => '关系结构体数组。', + 'type' => 'array', + 'items' => [ + 'description' => '关系结构体。', + 'type' => 'object', + 'properties' => [ + 'Guid' => [ + 'description' => '关系唯一ID。', + 'type' => 'string', + 'example' => 'aaabbccddguid', + ], + 'Datasource' => [ + 'description' => '数据来源。', + 'type' => 'string', + 'example' => 'maxcompute,mysql', + ], + 'Type' => [ + 'description' => '任务类型：主要描述实体间关系类型。例如，通过SQL计算、通过报表字段映射、通过定义API等 。', + 'type' => 'string', + 'example' => 'sql', + ], + 'Channel' => [ + 'description' => '数据渠道：'."\n" + ."\n" + .'- **FIRST_PARTY**：DataWorks平台数据。'."\n" + .'- **THIRD_PARTY**：用户注册的数据。', + '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' => '查询实体血缘', + ], + 'DeleteLineageRelation' => [ + 'summary' => '删除实体间血缘关系。 仅限于删除用户注册的自定义血缘关系。', + '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' => '源实体唯一标识', + 'type' => 'string', + 'required' => true, + 'example' => 'maxcompute-table.project.table', + ], + ], + [ + 'name' => 'DestEntityQualifiedName', + 'in' => 'query', + 'schema' => [ + 'description' => '目标实体唯一标识', + 'type' => 'string', + 'required' => true, + 'example' => 'custom-report.report123', + ], + ], + [ + 'name' => 'RelationshipGuid', + 'in' => 'query', + 'schema' => [ + 'description' => '血缘关系唯一标识', + 'type' => 'string', + 'required' => false, + 'example' => 'dfazcdfdfccdedd', + ], + ], + [ + 'name' => 'RelationshipType', + 'in' => 'query', + 'schema' => [ + 'description' => '关系类型', + 'type' => 'string', + 'required' => false, + 'example' => 'sql', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'OpenApiMetaResultModel'."\n" + ."\n", + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => [ + 'description' => 'HTTP状态码'."\n" + ."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'ErrorMessage' => [ + 'description' => '错误信息'."\n" + ."\n", + 'type' => 'string', + 'example' => 'qualifiedName should be in format as entity-table.entity-guid', + ], + 'RequestId' => [ + 'description' => '请求的ID：用于定位日志、排查问题'."\n" + ."\n", + 'type' => 'string', + 'example' => '64B-587A-8CED-969E1973887FXXX-TT', + ], + 'Success' => [ + 'description' => '调用是否成功。取值如下：'."\n" + ."\n" + .'true：调用成功'."\n" + ."\n" + .'false：调用失败', + 'type' => 'boolean', + 'example' => 'true', + ], + 'ErrorCode' => [ + 'description' => '错误码'."\n" + ."\n", + 'type' => 'string', + 'example' => '1010040007', + ], + 'Status' => [ + 'description' => '操作结果：'."\n" + ."\n" + .'true: 成功'."\n" + ."\n" + .'false: 失败'."\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' => '删除血缘关系', + 'description' => '本接口当前处于试用阶段。需要体验的用户可以提出申请，管理员加入试用名单后即可调用。', + ], + 'RegisterLineageRelation' => [ + 'summary' => '注册实体关系，支持用户注册自定义的实体关系。', + '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' => '血缘注册结构体。', + 'required' => true, + '$ref' => '#/components/schemas/LineageRelationRegisterVO', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'OpenApiMetaResultModel', + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => [ + 'description' => 'HTTP状态码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'ErrorMessage' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'The entity of lineage not exist, xxx', + ], + 'RequestId' => [ + 'description' => '请求的ID：用于定位日志、排查问题。', + 'type' => 'string', + 'example' => 'EE50E05E-028C-182B-****', + ], + 'Success' => [ + 'description' => '调用是否成功。取值如下：'."\n" + ."\n" + .'- true：调用成功。'."\n" + ."\n" + .'- false：调用失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'ErrorCode' => [ + 'description' => '错误码。', + 'type' => 'string', + 'example' => '1010210001', + ], + 'LineageRelation' => [ + 'description' => '血缘关系对象。', + 'type' => 'object', + 'properties' => [ + 'SrcEntityQualifiedName' => [ + 'description' => '源实体唯一标识。', + 'type' => 'string', + 'example' => 'maxcompute-table.project.table', + ], + 'DestEntityQualifiedName' => [ + 'description' => '目标实体唯一标识。', + 'type' => 'string', + 'example' => 'custom-report.month_stat_user', + ], + 'RelationshipGuid' => [ + 'description' => '实体间血缘关系ID。', + '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' => '注册血缘关系', + 'description' => '本接口当前处于试用阶段。需要体验的用户可以提出申请，管理员加入试用名单后即可调用。', + 'requestParamsDescription' => '实体唯一标识格式：EntityType.EntityGuid'."\n" + ."\n" + .'```'."\n" + .'1：EntityType 标识实体类型'."\n" + .' 1.1 Dataworks上已有的实体类型'."\n" + .' (1) maxcompute表：maxcompute-table'."\n" + .' (2) mysql表：mysql-table'."\n" + .' (3) emr表：emr-table '."\n" + .' (4) holo表：holodb-table'."\n" + ."\n" + .' 1.2 用户自定义的实体类型： custom-xxx'."\n" + .' 根据用户需求，推荐使用如下类型'."\n" + .' (1) 表：custom-table'."\n" + .' (2) API：custom-api '."\n" + .' (3) 应用：custom-app'."\n" + .' (4) 报表： custom-report'."\n" + .' (5) 数据集：custom-dataset'."\n" + .' (6) 数据源：custom-datasource'."\n" + ."\n" + .'2: EntityGuid：在同一实体类型内部，唯一标识该实体的标识'."\n" + .' 用户自定义的实体可以根据需要自己定义唯一ID'."\n" + ."\n" + .'3: 实体举例：'."\n" + .' 3.1：Dataworks已有系统实体，可以在数据地图页面血缘图中看到'."\n" + .' (1) maxcompute-table.project.tableName 表示maxcompute 表的唯一ID'."\n" + .' (2) emr-table.kadfdfaccdd4ted 表示emr表的唯一ID'."\n" + .' 3.2：用自定义实体： 用户根据自己业务需求，自己定义出唯一Id，（50个字节以内）'."\n" + .' (1) custom-api.listUser 表示自定义api实体，其唯一标识为listUser '."\n" + .' (2) custom-table.db1.table2 标识自定义表实体，其唯一标识为 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' => '表的唯一标识。', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => 'odps.engine_name.table_name', + ], + ], + [ + 'name' => 'Direction', + 'in' => 'query', + 'schema' => [ + 'description' => '字段的上下游方向：up表示上游，down表示下游。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'up', + ], + ], + [ + 'name' => 'NextPrimaryKey', + 'in' => 'query', + 'schema' => [ + 'description' => '分页的逻辑。'."\n" + .'当上次返回结果中 HasNext=true 和 NextPrimaryKey 非空的时候，下次请求的时候把 NextPrimaryKey 作为参数传入', + 'type' => 'string', + 'required' => false, + 'example' => 'next_primary_key', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '每页显示的条数，默认为10条，最大100条。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'ClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'EMR集群的ID，针对EMR情况。', + 'type' => 'string', + 'required' => false, + 'example' => 'abc', + ], + ], + [ + 'name' => 'DatabaseName', + 'in' => 'query', + 'schema' => [ + 'description' => '数据库的名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'abc', + ], + ], + [ + 'name' => 'TableName', + 'in' => 'query', + 'schema' => [ + 'description' => '表名。', + 'type' => 'string', + 'required' => false, + 'example' => 'abc', + ], + ], + [ + 'name' => 'DataSourceType', + 'in' => 'query', + 'schema' => [ + 'description' => '数据类型，包括odps或emr。', + 'type' => 'string', + 'required' => false, + 'example' => 'emr', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'description' => '返回数据结构。', + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => [ + 'description' => 'HTTP状态码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'ErrorMessage' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'The connection does not exist.', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '0bc1ec92159376', + ], + 'Success' => [ + 'description' => '请求是否成功。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'ErrorCode' => [ + 'description' => '错误码。', + 'type' => 'string', + 'example' => 'Invalid.Tenant.ConnectionNotExists', + ], + 'Data' => [ + 'description' => '业务数据。', + 'type' => 'object', + 'properties' => [ + 'NextPrimaryKey' => [ + 'description' => '分页的逻辑，请根据请求返回参数HasNext=true和key填写。', + 'type' => 'string', + 'example' => 'odps.tt.2', + ], + 'HasNext' => [ + 'description' => '是否还有下一页。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'DataEntityList' => [ + 'description' => '表信息。', + 'type' => 'array', + 'items' => [ + 'description' => '返回数据结构。', + 'type' => 'object', + 'properties' => [ + 'TableName' => [ + 'description' => '表的名称。', + 'type' => 'string', + 'example' => 'name', + ], + 'TableGuid' => [ + 'description' => '表的唯一标识。', + 'type' => 'string', + 'example' => 'odps.tt.name', + ], + 'CreateTimestamp' => [ + 'description' => '创建时间', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1638720736000', + ], + 'DatabaseName' => [ + 'description' => '数据库名称', + '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' => '获取表的血缘关系', + 'summary' => '调用GetMetaTableLineage获取表的血缘关系。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => 'GetMetaTableLineage接口的使用示例Demo请参见[DataWorks OpenAPI示例](https://developer.aliyun.com/article/780879?groupCode=dataworks)。', + ], + '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' => '字段的唯一标识。', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => 'odps.engine_name.table_name.column_name', + ], + ], + [ + 'name' => 'Direction', + 'in' => 'query', + 'schema' => [ + 'description' => '字段的上下游方向：up表示上游，down表示下游。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'up', + ], + ], + [ + 'name' => 'PageNum', + 'in' => 'query', + 'schema' => [ + 'description' => '请求的数据页数，用于翻页。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '每页显示的条数，默认为10条，最大100条。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'ClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'EMR集群的ID，针对EMR情况。', + 'type' => 'string', + 'required' => false, + 'example' => 'abc', + ], + ], + [ + 'name' => 'DatabaseName', + 'in' => 'query', + 'schema' => [ + 'description' => '数据库的名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'abc', + ], + ], + [ + 'name' => 'TableName', + 'in' => 'query', + 'schema' => [ + 'description' => '表名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'abc', + ], + ], + [ + 'name' => 'ColumnName', + 'in' => 'query', + 'schema' => [ + 'description' => '字段名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'abc', + ], + ], + [ + 'name' => 'DataSourceType', + 'in' => 'query', + 'schema' => [ + 'description' => '数据类型，包括odps或emr。', + 'type' => 'string', + 'required' => false, + 'example' => 'emr', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => [ + 'description' => 'HTTP状态码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'ErrorMessage' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'The connection does not exist.', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '0bc1ec92159376', + ], + 'Success' => [ + 'description' => '请求是否成功。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'ErrorCode' => [ + 'description' => '错误码。', + 'type' => 'string', + 'example' => 'Invalid.Tenant.ConnectionNotExists', + ], + 'Data' => [ + 'description' => '业务数据。', + 'type' => 'object', + 'properties' => [ + 'PageNum' => [ + 'description' => '请求的数据页数，用于翻页。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '每页显示的条数，默认为10条，最大100条。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'TotalCount' => [ + 'description' => '字段的总数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '20', + ], + 'DataEntityList' => [ + 'description' => '实例数据列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ColumnGuid' => [ + 'description' => '字段的唯一标识。', + 'type' => 'string', + 'example' => 'odps.engine_name.table_name.1', + ], + 'ColumnName' => [ + 'description' => '字段的名称。', + 'type' => 'string', + 'example' => '1', + ], + 'TableName' => [ + 'description' => '表名', + 'type' => 'string', + 'example' => 'abc', + ], + 'DatabaseName' => [ + 'description' => '数据库名称', + 'type' => 'string', + 'example' => 'abc', + ], + 'ClusterId' => [ + 'description' => 'emr集群ID', + 'type' => 'string', + 'example' => 'abc', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + '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' => '获取字段的血缘关系', + 'summary' => '调用GetMetaColumnLineage获取字段的血缘关系。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' GetMetaColumnLineage接口的使用示例Demo请参见[DataWorks OpenAPI示例](https://developer.aliyun.com/article/780879?groupCode=dataworks)。', + ], + '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' => '文件的路径。', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => 'Business_process/First_Business_Process/MaxCompute/Folder_1/Folder_2', + ], + ], + [ + 'name' => 'ProjectId', + 'in' => 'formData', + 'schema' => [ + 'description' => 'DataWorks工作空间的ID。您可以登录[DataWorks控制台](https://workbench.data.aliyun.com/console)，进入工作空间配置页面获取工作空间ID。'."\n" + ."\n" + .'该参数与ProjectIdentifier参数，二者必须设置其一，用来确定本次API调用操作的DataWorks工作空间。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'docRequired' => true, + 'example' => '10000', + ], + ], + [ + 'name' => 'FileName', + 'in' => 'formData', + 'schema' => [ + 'description' => '文件的名称。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'File name', + ], + ], + [ + 'name' => 'FileDescription', + 'in' => 'formData', + 'schema' => [ + 'description' => '文件的描述信息。', + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => '这里是文件描述', + 'maxLength' => 200, + ], + ], + [ + 'name' => 'FileType', + 'in' => 'formData', + 'schema' => [ + 'description' => '文件的代码类型。'."\n" + .'不同文件类型其代码不同，详情请参见[DataWorks节点合集](~~600169~~)。'."\n" + ."\n" + .'您可以调用[ListFileType](~~212428~~)接口，查询文件的代码类型。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'docRequired' => true, + 'example' => '10', + ], + ], + [ + 'name' => 'Owner', + 'in' => 'formData', + 'schema' => [ + 'description' => '文件责任人的阿里云用户ID。如果该参数为空，则默认使用调用者的阿里云用户ID。', + 'type' => 'string', + 'required' => false, + 'example' => '1000000000001', + ], + ], + [ + 'name' => 'Content', + 'in' => 'formData', + 'schema' => [ + 'description' => '文件代码内容，不同代码类型（fileType）的文件，代码格式不同。您可以在运维中心找到对应类型的任务，右键单击查看代码，查看具体的代码格式。', + 'type' => 'string', + 'required' => false, + 'example' => 'SHOW TABLES;', + ], + ], + [ + 'name' => 'AutoRerunTimes', + 'in' => 'formData', + 'schema' => [ + 'description' => '出错自动重跑的次数，取值最大为10。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'docRequired' => false, + 'example' => '3', + ], + ], + [ + 'name' => 'AutoRerunIntervalMillis', + 'in' => 'formData', + 'schema' => [ + 'description' => '出错自动重跑时间间隔，单位为毫秒。最大为1800000毫秒（30分钟）。'."\n" + ."\n" + .'该参数与[DataWorks控制台](https://workbench.data.aliyun.com/console)中，数据开发任务的“调度配置>时间属性>出错自动重跑”的”重跑间隔“配置对应。'."\n" + .'控制台中“重跑间隔”的时间单位为分钟，请在调用时注意转换时间。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '120000', + ], + ], + [ + 'name' => 'RerunMode', + 'in' => 'formData', + 'schema' => [ + 'description' => '重跑属性。取值如下：'."\n" + .'- ALL_ALLOWED：运行成功或失败后皆可重跑。'."\n" + .'- FAILURE_ALLOWED：运行成功后不可重跑，运行失败后可以重跑。'."\n" + .'- ALL_DENIED：运行成功或失败皆不可重跑。'."\n" + ."\n" + .'该参数与[DataWorks控制台](https://workbench.data.aliyun.com/console)中，数据开发任务的“调度配置>时间属性>重跑属性”配置内容对应。', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [], + 'example' => 'ALL_ALLOWED', + 'default' => 'ALL_ALLOWED', + 'enum' => [ + 'ALL_ALLOWED', + 'FAILURE_ALLOWED', + 'ALL_DENIED', + ], + ], + ], + [ + 'name' => 'Stop', + 'in' => 'formData', + 'schema' => [ + 'description' => '是否暂停调度，取值如下：'."\n" + .'- true：暂停调度。'."\n" + .'- false：不暂停调度。'."\n" + ."\n" + .'该参数与[DataWorks控制台](https://workbench.data.aliyun.com/console)中，数据开发任务的“调度配置>时间属性>调度类型”配置为”暂停调度“时对应。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + 'default' => 'false', + ], + ], + [ + 'name' => 'ParaValue', + 'in' => 'formData', + 'schema' => [ + 'description' => '调度参数。多个参数之间用空格进行分割。 '."\n" + ."\n" + .'该参数与[DataWorks控制台](https://workbench.data.aliyun.com/console)中，数据开发任务的“调度配置>参数”对应。您可以参考[调度参数](~~137548~~)配置。', + 'type' => 'string', + 'required' => false, + 'example' => 'a=x b=y', + ], + ], + [ + 'name' => 'StartEffectDate', + 'in' => 'formData', + 'schema' => [ + 'description' => '开始自动调度的毫秒时间戳。'."\n" + ."\n" + .'该参数与[DataWorks控制台](https://workbench.data.aliyun.com/console)中，数据开发任务的“调度配置>时间属性>生效日期”配置的开始时间的毫秒时间戳对应。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'minimum' => '0', + 'example' => '1671608450000', + 'default' => '0', + ], + ], + [ + 'name' => 'EndEffectDate', + 'in' => 'formData', + 'schema' => [ + 'description' => '停止自动调度的时间戳，单位为毫秒。'."\n" + ."\n" + .'该参数与[DataWorks控制台](https://workbench.data.aliyun.com/console)中，数据开发任务的“调度配置>时间属性>生效日期”配置的结束时间的毫秒时间戳对应。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'minimum' => '0', + 'example' => '1671694850000', + ], + ], + [ + 'name' => 'CronExpress', + 'in' => 'formData', + 'schema' => [ + 'description' => '周期调度的cron表达式，该参数与[DataWorks控制台](https://workbench.data.aliyun.com/console)中，数据开发任务的“调度配置>时间属性>cron表达式”对应。配置完“调度周期”及“定时调度时间”后，DataWorks会自动生成相应cron表达式。'."\n" + ."\n" + .'示例如下：'."\n" + .'- 每天凌晨5点30分定时调度：`00 30 05 * * ?`'."\n" + ."\n" + .'- 每个小时的第15分钟定时调度：`00 15 00-23/1 * * ?`'."\n" + ."\n" + .'- 每隔十分钟调度一次：`00 00/10 * * * ?`'."\n" + ."\n" + .'- 每天8点到17点，每隔十分钟调度一次：`00 00-59/10 8-17 * * * ?`'."\n" + ."\n" + .'- 每月的1日0点20分自动调度：`00 20 00 1 * ?`'."\n" + ."\n" + .'- 从1月1日0点10分开始，每过3个月调度一次：`00 10 00 1 1-12/3 ?`'."\n" + ."\n" + .'- 每周二、周五的0点5分自动调度：`00 05 00 * * 2,5`'."\n" + ."\n" + .'由于DataWorks调度系统的规则，cron表达式有以下限制：'."\n" + ."\n" + .'- 最短调度间隔时间为5分钟。'."\n" + ."\n" + .'- 每天最早调度时间为0点5分。', + 'type' => 'string', + 'required' => false, + 'example' => '00 05 00 * * ?', + 'default' => 'day', + ], + ], + [ + 'name' => 'CycleType', + 'in' => 'formData', + 'schema' => [ + 'description' => '调度周期的类型，包括NOT_DAY（分钟、小时）和DAY（日、周、月）。'."\n" + ."\n" + .'该参数与[DataWorks控制台](https://workbench.data.aliyun.com/console)中，数据开发任务的“调度配置>时间属性>调度周期”对应。', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [], + 'example' => 'DAY', + 'default' => 'DAY', + 'enum' => [ + 'DAY', + 'NOT_DAY', + ], + ], + ], + [ + 'name' => 'DependentType', + 'in' => 'formData', + 'schema' => [ + 'description' => '依赖上一周期的方式。取值如下：'."\n" + .'- SELF：依赖项选择本节点。'."\n" + .'- CHILD：依赖项选择一级子节点。'."\n" + .'- USER_DEFINE：依赖项选择其他节点。'."\n" + .'- NONE：未选择依赖项，即不会依赖上一周期。 '."\n" + .'- USER\\_DEFINE\\_AND\\_SELF： 跨周期依赖本节点和其他节点的组合的情况'."\n" + .'- CHILD\\_AND\\_SELF：跨周期依赖一层子节点和本节点的组合的情况', + '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' => '依赖上一周期的节点列表。', + 'type' => 'string', + 'required' => false, + 'example' => 'abc', + ], + ], + [ + 'name' => 'InputList', + 'in' => 'formData', + 'schema' => [ + 'description' => '文件依赖的上游文件的输出名称，多个输出使用英文逗号（,）分隔。'."\n" + ."\n" + .'该参数与[DataWorks控制台](https://workbench.data.aliyun.com/console)中，数据开发任务的“调度配置>调度依赖“选择”同周期“时的”父节点输出名称”对应。', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => 'project_root,project.file1,project.001_out', + ], + ], + [ + 'name' => 'ProjectIdentifier', + 'in' => 'formData', + 'schema' => [ + 'description' => 'DataWorks工作空间的名称。您可以登录[DataWorks控制台](https://workbench.data.aliyun.com/console)，进入工作空间配置页面获取工作空间名称。'."\n" + ."\n" + .'该参数与ProjectId参数，二者必须设置其一，用来确定本次API调用操作的DataWorks工作空间。', + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => 'dw_project', + ], + ], + [ + 'name' => 'ResourceGroupIdentifier', + 'in' => 'formData', + 'schema' => [ + 'description' => '文件发布成任务后，任务执行时对应的资源组。您可以调用[ListResourceGroups](~~173913~~)通过**identifier**字段获取工作空间可用的资源组列表。'."\n" + ."\n\n" + .'> 您需确认ListResourceGroups接口返回的资源组已绑定至创建文件所使用的工作空间，绑定后才能在CreateFile中使用。', + 'type' => 'string', + 'required' => false, + 'example' => 'group_375827434852437', + ], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'formData', + 'schema' => [ + 'description' => '该字段已废弃，请勿使用。'."\n" + ."\n" + .'文件发布成任务后，任务执行时对应的资源组。对应页面上调度配置>资源属性>调度资源组的配置。与ResourceGroupIdentifier二者设置其一即可。'."\n" + ."\n" + .'您可以通过[ListResourceGroups](~~173913~~)接口获取工作空间可用的资源组列表。ResourceGroupType传1，拿到结果后取出ID字段。'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '375827434852437', + ], + ], + [ + 'name' => 'ConnectionName', + 'in' => 'formData', + 'schema' => [ + 'description' => '文件发布成任务后，任务执行时连接的数据源。'."\n" + .'您可以调用[UpdateDataSource](~~211432~~)接口获取工作空间可用的数据源列表。'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'odps_source', + ], + ], + [ + 'name' => 'AutoParsing', + 'in' => 'formData', + 'schema' => [ + 'description' => '文件是否开启自动解析功能。取值如下：'."\n" + .'- true：文件会自动解析代码。'."\n" + .'- false：文件不会自动解析代码。'."\n" + ."\n" + .'该参数与[DataWorks控制台](https://workbench.data.aliyun.com/console)中，数据开发任务的“调度配置>调度依赖”选择“同周期”时的“代码解析”对应。', + 'type' => 'boolean', + 'required' => false, + 'docRequired' => false, + 'example' => 'true', + 'default' => 'true', + ], + ], + [ + 'name' => 'SchedulerType', + 'in' => 'formData', + 'schema' => [ + 'description' => '调度的类型，取值如下：'."\n" + .'- NORMAL：正常调度任务。'."\n" + .'- MANUAL：手动任务，不会被日常调度，对应手动业务流程下的节点。'."\n" + .'- PAUSE：暂停任务。'."\n" + .'- SKIP：空跑任务，被日常调度，但启动调度时直接被置为成功。', + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'enumValueTitles' => [], + 'example' => 'NORMAL', + 'enum' => [ + 'NORMAL', + 'MANUAL', + 'PAUSE', + 'SKIP', + ], + ], + ], + [ + 'name' => 'AdvancedSettings', + 'in' => 'formData', + 'schema' => [ + 'description' => '任务的高级配置。'."\n" + ."\n" + .'该参数与[DataWorks控制台](https://workbench.data.aliyun.com/console)中，EMR Spark Streaming和EMR Streaming SQL数据开发任务，编辑页面右侧导航栏的“高级设置“对应。'."\n" + ."\n" + .'当前仅EMR Spark Streaming和EMR Streaming SQL任务支持配置该参数，并且参数为JSON格式。', + 'type' => 'string', + 'required' => false, + 'example' => '{"queue":"default","SPARK_CONF":"--conf spark.driver.memory=2g"}', + ], + ], + [ + 'name' => 'StartImmediately', + 'in' => 'formData', + 'schema' => [ + 'description' => '发布后是否立即启动。'."\n" + ."\n" + .'该参数与[DataWorks控制台](https://workbench.data.aliyun.com/console)中，EMR Spark Streaming和EMR Streaming SQL数据开发任务，编辑页面右侧导航栏的“配置>时间属性>启动方式“对应。', + 'type' => 'boolean', + 'required' => false, + 'docRequired' => false, + 'example' => 'true', + 'default' => 'false', + ], + ], + [ + 'name' => 'InputParameters', + 'in' => 'formData', + 'schema' => [ + 'description' => '节点的上下文输入参数。参数为JSON格式，包含的字段可参考[GetFile](~~173954~~)接口返回值中的InputContextParameterList参数结构。'."\n" + ."\n" + .'该参数与[DataWorks控制台](https://workbench.data.aliyun.com/console)中，数据开发任务的“调度配置>节点上下文>本节点输入参数“对应。', + 'type' => 'string', + 'required' => false, + 'example' => '[{"ValueSource": "project_001.first_node:bizdate_param","ParameterName": "bizdate_input"}]', + ], + ], + [ + 'name' => 'OutputParameters', + 'in' => 'formData', + 'schema' => [ + 'description' => '节点的上下文输出参数。参数为JSON格式，包含的字段可参考[GetFile](~~173954~~)接口返回值中的OutputContextParameterList参数结构。'."\n" + ."\n" + .'该参数与[DataWorks控制台](https://workbench.data.aliyun.com/console)中，数据开发任务的“调度配置>节点上下文>本节点输出参数“对应。', + 'type' => 'string', + 'required' => false, + 'example' => '[{"Type": 1,"Value": "${bizdate}","ParameterName": "bizdate_param"}]', + ], + ], + [ + 'name' => 'IgnoreParentSkipRunningProperty', + 'in' => 'formData', + 'schema' => [ + 'description' => '是否沿用上一周期空跑属性。取值如下：'."\n" + ."\n" + .'- true：沿用上一周期空跑属性。'."\n" + ."\n" + .'- false：不沿用上一周期空跑属性。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + [ + 'name' => 'CreateFolderIfNotExists', + 'in' => 'formData', + 'schema' => [ + 'description' => '当参数中指定的目录（FileFolderPath）在系统中不存在时，是否自动创建此目录。取值如下：'."\n" + ."\n" + .'- true：若此目录不存在，自动创建此目录'."\n" + .'- false：若此目录不存在，调用失败', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + [ + 'name' => 'ApplyScheduleImmediately', + 'in' => 'formData', + 'schema' => [ + 'description' => '是否发布后立即生效调度配置', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'Timeout', + 'in' => 'formData', + 'schema' => [ + 'description' => '调度配置超时定义', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'ImageId', + 'in' => 'formData', + 'schema' => [ + 'description' => '自定义镜像ID', + 'type' => 'string', + 'required' => false, + 'example' => 'm-bp1h4b5a8ogkbll2f3tr', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => [ + 'description' => 'HTTP状态码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Data' => [ + 'description' => '文件创建成功后的ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1000001', + ], + 'RequestId' => [ + 'description' => '本次调用的唯一ID。出现错误后，您可以根据该ID排查问题。', + 'type' => 'string', + 'example' => '0000-ABCD-EFG', + ], + 'ErrorMessage' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'The connection does not exist.', + ], + 'Success' => [ + 'description' => '调用是否成功。取值如下：'."\n" + .'- true：调用成功。'."\n" + .'- false：调用失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'ErrorCode' => [ + 'description' => '错误码。', + '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' => '在数据开发中创建一个文件', + 'summary' => '调用CreateFile，在数据开发中创建一个文件。目前不支持调用该接口创建数据集成节点任务。', + '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' => '函数文件所在的文件夹路径。', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => 'Business_process/First_Business_Process/function/string_processing', + ], + ], + [ + 'name' => 'ProjectId', + 'in' => 'formData', + 'schema' => [ + 'description' => 'DataWorks工作空间的ID，您可以单击页面右上角的小扳手图标，进入工作空间管理页面查看。'."\n" + ."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'docRequired' => false, + 'example' => '10000', + ], + ], + [ + 'name' => 'FileName', + 'in' => 'formData', + 'schema' => [ + 'description' => '函数的名称。'."\n" + ."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'StringConcat', + ], + ], + [ + 'name' => 'FunctionType', + 'in' => 'formData', + 'schema' => [ + 'description' => '函数的分类，对应创建函数表单中的函数类型一项，包括MATH（数学运算函数）、AGGREGATE（聚合函数）、STRING（字符串处理函数）、DATE（日期处理函数）、ANALYTIC（窗口函数）和OTHER（其他函数）。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'enumValueTitles' => [], + 'example' => 'STRING', + 'enum' => [ + 'MATH', + 'AGGREGATE', + 'STRING', + 'DATE', + 'ANALYTIC', + 'OTHER', + ], + ], + ], + [ + 'name' => 'ClassName', + 'in' => 'formData', + 'schema' => [ + 'description' => '函数定义所在的类名，对应创建函数表单的类名一项。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'com.alibaba.DataWorks.api.udf.StringConcat', + ], + ], + [ + 'name' => 'Resources', + 'in' => 'formData', + 'schema' => [ + 'description' => '函数引用的资源名列表，对应创建表中的资源列表。多个资源名称之间使用英文逗号（,）分隔。'."\n" + ."\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' => '函数用途的说明，对应创建函数表单中的描述。'."\n" + ."\n", + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => 'Concatenate several strings to generate a new string', + ], + ], + [ + 'name' => 'CmdDescription', + 'in' => 'formData', + 'schema' => [ + 'description' => '函数调用的命令格式，对应创建函数表单中的命令格式。'."\n" + ."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'StringConcat(String... substrs)', + ], + ], + [ + 'name' => 'ParameterDescription', + 'in' => 'formData', + 'schema' => [ + 'description' => '函数入参的说明，对应创建函数表单中的参数说明。'."\n" + ."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'List of strings to be connected', + 'default' => '', + ], + ], + [ + 'name' => 'ReturnValue', + 'in' => 'formData', + 'schema' => [ + 'description' => '函数的返回值说明，对应创建函数表单中的返回值。'."\n" + ."\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' => '函数调用示例，对应创建函数表单中的示例。'."\n" + ."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'StringConcat(\'a\', \'b\', \'c\')', + ], + ], + [ + 'name' => 'ProjectIdentifier', + 'in' => 'formData', + 'schema' => [ + 'description' => 'DataWorks工作空间的唯一标识符，即数据开发页面顶部切换工作空间处的英文标识。', + 'type' => 'string', + 'required' => false, + 'example' => 'dw_project', + ], + ], + [ + 'name' => 'CreateFolderIfNotExists', + 'in' => 'formData', + 'schema' => [ + 'description' => '当参数中指定的目录（FileFolderPath）在系统中不存在时，是否自动创建此目录。取值如下：'."\n" + ."\n" + .'- true：若此目录不存在，自动创建此目录'."\n" + ."\n" + .'- false：若此目录不存在，调用失败', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => [ + 'description' => 'HTTP状态码。'."\n" + ."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Data' => [ + 'description' => '文件创建成功后的ID。'."\n" + ."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '100000002', + ], + 'RequestId' => [ + 'description' => '本次调用的唯一ID。出现错误后，您可以根据该ID排查问题。'."\n" + ."\n", + 'type' => 'string', + 'example' => '0000-ABCD-EFG****', + ], + 'ErrorMessage' => [ + 'description' => '错误信息。'."\n" + ."\n", + 'type' => 'string', + 'example' => 'The connection does not exist.', + ], + 'Success' => [ + 'description' => '调用是否成功。'."\n" + ."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'ErrorCode' => [ + 'description' => '错误码。'."\n" + ."\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' => '在数据开发中创建函数类型文件', + 'summary' => '调用CreateUdfFile，在数据开发中创建函数类型文件。', + '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' => 'DataWorks工作空间的ID，您可以登录[DataWorks控制台](https://workbench.data.aliyun.com/console)，进入工作空间管理页面查看ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'docRequired' => false, + 'example' => '10000', + ], + ], + [ + 'name' => 'ProjectIdentifier', + 'in' => 'formData', + 'schema' => [ + 'description' => 'DataWorks工作空间的唯一标识符（即工作空间名称）。您可以登录[DataWorks控制台](https://workbench.data.aliyun.com/console)，进入工作空间配置页面查看名称。'."\n" + .'该参数与projectId参数二者必须设置其一，以确定本次API调用操作的DataWorks项目。', + 'type' => 'string', + 'required' => false, + 'example' => 'dw_project', + ], + ], + [ + 'name' => 'BusinessName', + 'in' => 'formData', + 'schema' => [ + 'description' => '业务流程名称，同一个项目空间下的业务流程名称必须唯一。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'My business process', + ], + ], + [ + 'name' => 'Description', + 'in' => 'formData', + 'schema' => [ + 'description' => '业务流程的描述信息。', + 'type' => 'string', + 'required' => false, + 'example' => 'This is a business process created through an interface.', + ], + ], + [ + 'name' => 'Owner', + 'in' => 'formData', + 'schema' => [ + 'description' => '业务流程对应责任人的阿里云账号ID。您可以登录[DataWorks控制台](https://workbench.data.aliyun.com/console)，鼠标悬停至顶部菜单栏右侧的用户头像，查看账号ID。如果该参数为空，则默认使用调用者的阿里云账号ID。', + 'type' => 'string', + 'required' => false, + 'example' => '1000000000001', + ], + ], + [ + 'name' => 'UseType', + 'in' => 'formData', + 'schema' => [ + 'description' => '业务流程所属的功能模块。取值如下：'."\n" + .'- NORMAL（数据开发）'."\n" + .'- MANUAL_BIZ（手动业务流程）', + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'enumValueTitles' => [], + 'example' => 'NORMAL', + 'default' => 'NORMAL', + 'enum' => [ + 'NORMAL', + 'MANUAL_BIZ', + ], + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => [ + 'description' => 'HTTP状态码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'RequestId' => [ + 'description' => '本次调用的唯一ID。出现错误后，您可以根据该ID排查问题。', + 'type' => 'string', + 'example' => '0000-ABCD-EFG****', + ], + 'ErrorMessage' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'The connection does not exist.', + ], + 'Success' => [ + 'description' => '调用是否成功。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'ErrorCode' => [ + 'description' => '错误码。', + 'type' => 'string', + 'example' => 'Invalid.Tenant.ConnectionNotExists', + ], + 'BusinessId' => [ + 'description' => '业务流程ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '100001', + ], + ], + ], + ], + ], + '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' => '创建业务流程', + 'summary' => '调用CreateBusiness，创建数据开发（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' => 'DataWorks工作空间的ID。您可以登录DataWorks管控台，进入工作空间配置页面获取工作空间ID。该参数与ProjectIdentifier参数，二者必须设置其一，用来确定本次API调用操作的DataWorks工作空间。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'docRequired' => false, + 'example' => '10000', + ], + ], + [ + 'name' => 'ProjectIdentifier', + 'in' => 'formData', + 'schema' => [ + 'description' => 'DataWorks工作空间名称。您可以登录DataWorks控制台，进入工作空间配置页面获取工作空间名称。该参数与ProjectId参数，二者必须设置其一，用来确定本次API调用操作的DataWorks工作空间。'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'dw_project', + ], + ], + [ + 'name' => 'BusinessId', + 'in' => 'formData', + 'schema' => [ + 'description' => '业务流程的ID，您可以调用[ListBusiness](~~173945~~)接口，根据名称查询对应业务流程的ID。'."\n" + ."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + 'example' => '1000001', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => [ + 'description' => 'HTTP状态码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'ErrorMessage' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'The connection does not exist.', + ], + 'RequestId' => [ + 'description' => '请求ID。用于出现错误后排查问题。', + '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' => '删除业务流程', + 'summary' => '调用DeleteBusiness删除业务流程。', + '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' => 'DataWorks工作空间的ID。您可以登录DataWorks管控台，进入工作空间配置页面获取工作空间ID。该参数与**ProjectIdentifier**参数，二者必须设置其一，用来确定本次API调用操作的DataWorks工作空间。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'docRequired' => false, + 'example' => '10000', + ], + ], + [ + 'name' => 'ProjectIdentifier', + 'in' => 'formData', + 'schema' => [ + 'description' => 'DataWorks工作空间名称。您可以登录DataWorks控制台，进入工作空间配置页面获取工作空间名称。该参数与**ProjectId**参数，二者必须设置其一，用来确定本次API调用操作的DataWorks工作空间。', + 'type' => 'string', + 'required' => false, + 'example' => 'dw_project', + ], + ], + [ + 'name' => 'FolderPath', + 'in' => 'formData', + 'schema' => [ + 'description' => '文件夹的路径。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'Business_process/System_Data/MaxCompute/import_layer', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => [ + 'description' => 'HTTP状态码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Data' => [ + 'description' => '新建文件夹的唯一标识符。', + 'type' => 'string', + 'example' => 'bdfd68****', + ], + 'RequestId' => [ + 'description' => '请求ID。用于出现错误后排查问题。', + 'type' => 'string', + 'example' => '0000-ABCD-EFG', + ], + 'ErrorMessage' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'The connection does not exist.', + ], + 'Success' => [ + 'description' => '调用是否成功。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'ErrorCode' => [ + 'description' => '错误码。', + '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' => '创建文件夹', + 'summary' => '调用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' => 'DataWorks工作空间的ID。您可以登录DataWorks管控台，进入工作空间配置页面获取工作空间ID。该参数与ProjectIdentifier参数，二者必须设置其一，用来确定本次API调用操作的DataWorks工作空间。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'docRequired' => false, + 'example' => '10000', + ], + ], + [ + 'name' => 'ProjectIdentifier', + 'in' => 'formData', + 'schema' => [ + 'description' => 'DataWorks工作空间名称。您可以登录DataWorks控制台，进入工作空间配置页面获取工作空间名称。该参数与ProjectId参数，二者必须设置其一，用来确定本次API调用操作的DataWorks工作空间。', + 'type' => 'string', + 'required' => false, + 'example' => 'dw_project', + ], + ], + [ + 'name' => 'BusinessName', + 'in' => 'formData', + 'schema' => [ + 'description' => '业务流程的名称。您可以调用[ListBusiness](~~173945~~)接口获取。'."\n", + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => 'MyBusiness', + ], + ], + [ + 'name' => 'Description', + 'in' => 'formData', + 'schema' => [ + 'description' => '业务流程的描述信息。'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'modified from my first business', + ], + ], + [ + 'name' => 'Owner', + 'in' => 'formData', + 'schema' => [ + 'description' => '业务流程的责任人。您可以调用[ListBusiness](~~173945~~)接口获取。', + 'type' => 'string', + 'required' => false, + 'example' => '348428****', + ], + ], + [ + 'name' => 'BusinessId', + 'in' => 'formData', + 'schema' => [ + 'description' => '业务流程的ID，您可以调用[ListBusiness](~~173945~~)接口获取。'."\n" + ."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + 'example' => '300000', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => [ + 'description' => 'HTTP状态码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'ErrorMessage' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'The connection does not exist.', + ], + 'RequestId' => [ + 'description' => '请求ID。用于出现错误后排查问题。', + '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' => '更新业务流程', + 'summary' => '调用UpdateBusiness更新业务流程。', + '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' => '文件所在的文件夹路径。', + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => 'Business_process/my_first_business_process/MaxCompute/ods_layer', + ], + ], + [ + 'name' => 'ProjectId', + 'in' => 'formData', + 'schema' => [ + 'description' => 'DataWorks工作空间的ID。您可以登录[DataWorks控制台](https://workbench.data.aliyun.com/console)，进入工作空间配置页面获取工作空间ID。'."\n" + ."\n" + .'该参数与ProjectIdentifier参数，二者必须设置其一，用来确定本次API调用操作的DataWorks工作空间。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'docRequired' => false, + 'example' => '10000', + ], + ], + [ + 'name' => 'Keyword', + 'in' => 'formData', + 'schema' => [ + 'description' => '文件名称的关键字。支持模糊匹配，即输入关键字即可查询包含该关键字的所有文件。', + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => 'ods', + ], + ], + [ + 'name' => 'ProjectIdentifier', + 'in' => 'formData', + 'schema' => [ + 'description' => 'DataWorks工作空间的名称。您可以登录[DataWorks控制台](https://workbench.data.aliyun.com/console)，进入工作空间配置页面获取工作空间名称。'."\n" + ."\n" + .'该参数与ProjectId参数，二者必须设置其一，用来确定本次API调用操作的DataWorks工作空间。', + 'type' => 'string', + 'required' => false, + 'example' => 'dw_project', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'formData', + 'schema' => [ + 'description' => '请求的数据页数，用于翻页。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'minimum' => '1', + 'example' => '1', + 'default' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'formData', + 'schema' => [ + 'description' => '每页显示的条数，默认为10条，最大为100条。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'docRequired' => false, + 'maximum' => '100', + 'minimum' => '0', + 'example' => '10', + 'default' => '10', + ], + ], + [ + 'name' => 'UseType', + 'in' => 'formData', + 'schema' => [ + 'description' => '文件所属的功能模块。取值如下：'."\n" + .'- NORMAL：数据开发。'."\n" + .'- MANUAL：手动任务。'."\n" + .'- MANUAL_BIZ：手动业务流程。'."\n" + .'- SKIP：数据开发的空跑调度。'."\n" + .'- ADHOCQUERY：临时查询。'."\n" + .'- COMPONENT：组件管理。', + 'type' => 'string', + 'required' => false, + 'example' => 'NORMAL', + ], + ], + [ + 'name' => 'FileTypes', + 'in' => 'formData', + 'schema' => [ + 'description' => '文件类型。不同文件类型其代码不同，详情请参见[DataWorks节点合集](~~600169~~)。，查询文件的代码类型。', + 'type' => 'string', + 'required' => false, + 'example' => '10,23', + ], + ], + [ + 'name' => 'Owner', + 'in' => 'formData', + 'schema' => [ + 'description' => '文件责任人。', + 'type' => 'string', + 'required' => false, + 'example' => '3726346****', + ], + ], + [ + 'name' => 'NodeId', + 'in' => 'formData', + 'schema' => [ + 'description' => '调度节点的ID。您可以调用[ListNodes](~~173979~~)接口获取节点ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '123541234', + ], + ], + [ + 'name' => 'NeedContent', + 'in' => 'formData', + 'schema' => [ + 'description' => '查询结果是否包含文件内容（对于内容较多的文件，可能存在较长的网络传输延时）。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + [ + 'name' => 'NeedAbsoluteFolderPath', + 'in' => 'formData', + 'schema' => [ + 'description' => '查询结果是否包含文件所在的文件夹的路径。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + [ + 'name' => 'ExactFileName', + 'in' => 'formData', + 'schema' => [ + 'description' => '精确匹配的文件名称，查询结果的文件名称与该参数完全一致。', + 'type' => 'string', + 'required' => false, + 'example' => 'ods_create.sql', + ], + ], + [ + 'name' => 'FileIdIn', + 'in' => 'formData', + 'schema' => [ + 'description' => 'Fileld列表，查询结果的文件ID集合只能是该列表的子集。最多支持一次指定50个FileId。', + 'type' => 'string', + 'required' => false, + 'example' => '78237,816123', + ], + ], + [ + 'name' => 'LastEditUser', + 'in' => 'formData', + 'schema' => [ + 'description' => '最近一次编辑文件的用户阿里云用户ID。', + 'type' => 'string', + 'required' => false, + 'example' => '38748246285727', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => [ + 'description' => 'HTTP状态码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'ErrorMessage' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'The connection does not exist.', + ], + 'RequestId' => [ + 'description' => '请求ID。用于出现错误后排查问题。', + 'type' => 'string', + 'example' => '0000-ABCD-****', + ], + 'ErrorCode' => [ + 'description' => '错误码。', + 'type' => 'string', + 'example' => 'Invalid.Tenant.ConnectionNotExists', + ], + 'Success' => [ + 'description' => '调用是否成功。取值如下：'."\n" + .'- true：调用成功。'."\n" + .'- false：调用失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Data' => [ + 'description' => '满足条件的文件列表。', + 'type' => 'object', + 'properties' => [ + 'PageNumber' => [ + 'description' => '请求的数据页数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '每页显示的数据条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'TotalCount' => [ + 'description' => '满足条件的数据总条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '13', + ], + 'Files' => [ + 'description' => '文件详情。', + 'type' => 'array', + 'items' => [ + 'description' => '文件信息。', + 'type' => 'object', + 'properties' => [ + 'CommitStatus' => [ + 'description' => '文件当前的提交状态，包括0（未提交最新的代码）和1（已提交最新的代码）。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'AutoParsing' => [ + 'description' => '文件是否开启自动解析功能。取值如下：'."\n" + .'- true：文件会自动解析代码。'."\n" + .'- false：文件不会自动解析代码。'."\n" + ."\n" + .'该参数与[DataWorks控制台](https://workbench.data.aliyun.com/console)中，数据开发任务的“调度配置>调度依赖”选择“同周期”时的“代码解析”对应。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Owner' => [ + 'description' => '文件责任人的阿里云用户ID。'."\n", + 'type' => 'string', + 'example' => '3872572****', + ], + 'CreateTime' => [ + 'description' => '文件创建时间的毫秒时间戳。'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1593950832000', + ], + 'FileType' => [ + 'description' => '文件类型。不同文件类型其代码不同，详情请参见[DataWorks节点合集](~~600169~~)。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'CurrentVersion' => [ + 'description' => '文件当前已经提交的最新版本号。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'BizId' => [ + 'description' => '文件所属的业务流程ID。该字段已废弃，请使用BusinessId字段。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '300000', + ], + 'LastEditUser' => [ + 'description' => '最近一次编辑文件的用户阿里云用户ID。'."\n", + 'type' => 'string', + 'example' => '38748246285727', + ], + 'FileName' => [ + 'description' => '文件的名称。'."\n", + 'type' => 'string', + 'example' => 'ods_user_info_d', + ], + 'ConnectionName' => [ + 'description' => '文件对应的任务执行时所使用的数据源名称。', + 'type' => 'string', + 'example' => 'odps_source', + ], + 'UseType' => [ + 'description' => '文件所属的功能模块。取值如下：'."\n" + .'- NORMAL：数据开发。'."\n" + .'- MANUAL：手动任务。'."\n" + .'- MANUAL_BIZ：手动业务流程。'."\n" + .'- SKIP：数据开发的空跑调度。'."\n" + .'- ADHOCQUERY：临时查询。'."\n" + .'- COMPONENT：组件管理。'."\n", + 'type' => 'string', + 'example' => 'NORMAL', + ], + 'FileFolderId' => [ + 'description' => '文件所在文件夹的ID。'."\n", + 'type' => 'string', + 'example' => '2735c2****', + ], + 'FileId' => [ + 'description' => '文件的ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10000001', + ], + 'ParentId' => [ + 'description' => '如果当前文件是组合节点文件的内部文件，该字段标识对应组合节点文件的ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '-1', + ], + 'CreateUser' => [ + 'description' => '文件创建者的阿里云用户ID。'."\n", + 'type' => 'string', + 'example' => '382762****', + ], + 'IsMaxCompute' => [ + 'description' => '如果当前文件是MaxCompute资源文件，该字段标识该资源文件是否需要上传至MaxCompute。'."\n" + ."\n" + .'仅当文件是MaxCompute资源文件时才需要配置该参数。', + 'type' => 'boolean', + 'example' => 'false', + ], + 'BusinessId' => [ + 'description' => '文件所属的业务流程ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '300000', + ], + 'FileDescription' => [ + 'description' => '文件的描述信息。'."\n", + 'type' => 'string', + 'example' => 'my test datastudio file', + ], + 'LastEditTime' => [ + 'description' => '最近一次编辑文件的毫秒时间戳。'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1593950832000', + ], + 'Content' => [ + 'description' => '该参数已废弃。您可通过[GetFile](~~173954~~)接口查询。', + 'type' => 'string', + 'example' => 'SHOW TABLES;', + ], + 'NodeId' => [ + 'description' => '提交文件后，在调度系统生成的调度任务的ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '300001', + ], + 'AbsoluteFolderPath' => [ + 'description' => '文件所在的文件夹的路径。', + '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' => '查询文件列表', + 'summary' => '调用ListFiles查询文件列表。', + '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' => 'DataWorks工作空间的ID，您可以单击页面右上角的小扳手图标，进入工作空间管理页面查看。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'docRequired' => false, + 'example' => '10000', + ], + ], + [ + 'name' => 'ProjectIdentifier', + 'in' => 'formData', + 'schema' => [ + 'description' => 'DataWorks工作空间的唯一标识符，即数据开发页面顶部切换工作空间处的英文标识。'."\n" + ."\n" + .'该参数与ProjectId参数二者必须设置其一，以确定本次API调用操作的DataWorks工作空间。', + 'type' => 'string', + 'required' => false, + 'example' => 'dw', + ], + ], + [ + 'name' => 'BusinessId', + 'in' => 'formData', + 'schema' => [ + 'description' => '业务流程的ID，您可以使用[ListBusiness](~~173945~~)获取对应业务流程的ID。'."\n" + ."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '1000001', + ], + ], + [ + 'name' => 'TableGuid', + 'in' => 'formData', + 'schema' => [ + 'description' => '表的UUID，您可以通过[SearchMetaTables](~~173919~~)获取对应表的UUID。'."\n" + ."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'odps.dw_project.tb1', + ], + ], + [ + 'name' => 'FolderId', + 'in' => 'formData', + 'schema' => [ + 'description' => '文件夹的ID，您可以使用[GetFolder](~~173952~~)或者[ListFolders](~~173955~~)获取对应文件夹的ID。'."\n" + ."\n\n", + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => '2eb6f9****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => [ + 'description' => 'HTTP状态码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'ErrorMessage' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'The connection does not exist.', + ], + 'RequestId' => [ + 'description' => '本次调用的唯一ID。出现错误后，您可以根据该ID排查问题。', + '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' => '导入表至业务流程', + 'summary' => '相当于在数据开发页面右键单击业务流程，选择导入表的操作。', + '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' => 'DataWorks工作空间的ID。您可以登录DataWorks管控台，进入工作空间配置页面获取工作空间ID。该参数与ProjectIdentifier参数，二者必须设置其一，用来确定本次API调用操作的DataWorks工作空间。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'docRequired' => false, + 'example' => '100001', + ], + ], + [ + 'name' => 'ProjectIdentifier', + 'in' => 'formData', + 'schema' => [ + 'description' => 'DataWorks工作空间名称。您可以登录DataWorks控制台，进入工作空间配置页面获取工作空间名称。该参数与ProjectId参数，二者必须设置其一，用来确定本次API调用操作的DataWorks工作空间。', + 'type' => 'string', + 'required' => false, + 'example' => 'dw_project', + ], + ], + [ + 'name' => 'FileId', + 'in' => 'formData', + 'schema' => [ + 'description' => '文件的ID，您可以通过[ListFiles](~~173942~~)查询对应文件的ID。'."\n" + ."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + 'example' => '1000000', + ], + ], + [ + 'name' => 'Comment', + 'in' => 'formData', + 'schema' => [ + 'description' => '本次提交的说明信息。', + 'type' => 'string', + 'required' => false, + 'example' => 'Submit a task for the first time', + ], + ], + [ + 'name' => 'SkipAllDeployFileExtensions', + 'in' => 'formData', + 'schema' => [ + 'description' => '文件提交成功后是否跳过发布前检查：'."\n" + .'- false：不跳过。文件提交后会自动触发发布前检查流程，检查通过后才会进入可发布状态。'."\n" + .'- true：跳过。文件提交后不会触发发布前检查流程，可直接进入发布流程。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + 'default' => 'false', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回数据。', + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => [ + 'description' => 'HTTP状态码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Data' => [ + 'description' => '发布包的ID，后续需要将该ID作为参数调用[GetDeployment](~~173950~~)接口，获取本次发布的具体情况。'."\n" + ."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '3000001', + ], + 'RequestId' => [ + 'description' => '请求ID。用于出现错误后排查问题。', + 'type' => 'string', + 'example' => '0000-ABCD-EFG****', + ], + 'ErrorMessage' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'The connection does not exist.', + ], + 'Success' => [ + 'description' => '调用是否成功。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'ErrorCode' => [ + 'description' => '错误码。', + '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' => '提交文件至调度系统开发环境', + 'summary' => '提交文件至调度系统的开发环境，生成对应的任务。', + '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' => 'DataWorks工作空间的ID。您可以登录DataWorks管控台，进入工作空间配置页面获取工作空间ID。该参数与ProjectIdentifier参数，二者必须设置其一，用来确定本次API调用操作的DataWorks工作空间。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'docRequired' => false, + 'example' => '10000', + ], + ], + [ + 'name' => 'ProjectIdentifier', + 'in' => 'formData', + 'schema' => [ + 'description' => 'DataWorks工作空间名称。您可以登录DataWorks控制台，进入工作空间配置页面获取工作空间名称。该参数与ProjectId参数，二者必须设置其一，用来确定本次API调用操作的DataWorks工作空间。', + 'type' => 'string', + 'required' => false, + 'example' => 'dw_project', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'formData', + 'schema' => [ + 'description' => '请求的数据页数，用于翻页。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'docRequired' => true, + 'minimum' => '1', + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'formData', + 'schema' => [ + 'description' => '每页显示的数据条数，默认为10条，最大为100条。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'docRequired' => true, + 'maximum' => '100', + 'minimum' => '0', + 'example' => '10', + ], + ], + [ + 'name' => 'Keyword', + 'in' => 'formData', + 'schema' => [ + 'description' => '关键字，用于模糊匹配业务流程的名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'my', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回数据。', + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => [ + 'description' => 'HTTP状态码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'ErrorMessage' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'The connection does not exist.', + ], + 'RequestId' => [ + 'description' => '请求ID。用于出现错误后排查问题。', + 'type' => 'string', + 'example' => '0000-ABCD-EFG****', + ], + 'ErrorCode' => [ + 'description' => '错误码。', + 'type' => 'string', + 'example' => 'Invalid.Tenant.ConnectionNotExists', + ], + 'Success' => [ + 'description' => '调用是否成功。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Data' => [ + 'description' => '业务流程列表的详情。', + 'type' => 'object', + 'properties' => [ + 'PageNumber' => [ + 'description' => '当前数据页的页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '当前数据页的数据条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'TotalCount' => [ + 'description' => '满足查询条件的数据总条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '13', + ], + 'Business' => [ + 'description' => '业务流程的详情。', + 'type' => 'array', + 'items' => [ + 'description' => '业务流程列表信息。', + 'type' => 'object', + 'properties' => [ + 'Owner' => [ + 'description' => '业务流程的责任人。', + 'type' => 'string', + 'example' => '34824327****', + ], + 'Description' => [ + 'description' => '业务流程的描述信息。', + 'type' => 'string', + 'example' => '我的第一个业务流程', + ], + 'ProjectId' => [ + 'description' => '业务流程所在工作空间的ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10000', + ], + 'BusinessId' => [ + 'description' => '业务流程的ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '3000001', + ], + 'BusinessName' => [ + 'description' => '业务流程的名称。', + 'type' => 'string', + 'example' => '我的第一个业务流程', + ], + 'UseType' => [ + 'description' => '业务流程所属的功能模块，包括NORMAL（数据开发）和MANUAL_BIZ（手动业务流程）。', + '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' => '查询业务流程的列表', + 'summary' => '调用ListBusiness查询业务流程的列表。', + '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' => '文件的ID，您可以通过[ListFiles](~~173942~~)查询对应文件的ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + 'example' => '1000001', + ], + ], + [ + 'name' => 'ProjectId', + 'in' => 'formData', + 'schema' => [ + 'description' => 'DataWorks工作空间的ID，您可以单击页面右上角的小扳手图标，进入工作空间管理页面查看。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'docRequired' => false, + 'example' => '1000011', + ], + ], + [ + 'name' => 'ProjectIdentifier', + 'in' => 'formData', + 'schema' => [ + 'description' => 'DataWorks工作空间的唯一标识符，即数据开发页面顶部切换工作空间处的英文标识。'."\n" + ."\n" + .'该参数与ProjectId参数二者必须设置其一，以确定本次API调用操作的DataWorks工作空间。', + 'type' => 'string', + 'required' => false, + 'example' => 'dw_project', + ], + ], + [ + 'name' => 'FileVersion', + 'in' => 'formData', + 'schema' => [ + 'description' => '需要查询的文件版本。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'docRequired' => true, + 'example' => '2', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回数据。', + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => [ + 'description' => 'HTTP状态码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'ErrorMessage' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'The connection does not exist.', + ], + 'RequestId' => [ + 'description' => '本次调用的唯一ID。出现错误后，您可以根据该ID排查问题。', + 'type' => 'string', + 'example' => '0000-ABCD-EFG****', + ], + 'ErrorCode' => [ + 'description' => '错误码。', + 'type' => 'string', + 'example' => 'Invalid.Tenant.ConnectionNotExists', + ], + 'Success' => [ + 'description' => '调用是否成功。'."\n" + .'- true：成功。'."\n" + .'- false：失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Data' => [ + 'description' => '文件的版本详情。', + 'type' => 'object', + 'properties' => [ + 'FileContent' => [ + 'description' => '生成本次文件版本的文件代码。', + 'type' => 'string', + 'example' => 'SHOW TABLES;', + ], + 'IsCurrentProd' => [ + 'description' => '本次文件版本是否为当前生产环境的最新版本。'."\n" + .'- true：是最新版本。'."\n" + .'- false：不是最新版本。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Status' => [ + 'description' => '文件版本当前的状态，取值如下：'."\n" + .'- COMMITTING（提交中）'."\n" + .'- COMMITTED或CHECK_OK（已提交）'."\n" + .'- PACKAGED（准备发布）'."\n" + .'- DEPLOYING（发布中）'."\n" + .'- DEPLOYED（已发布）'."\n" + .'- CANCELLED（取消发布）', + 'type' => 'string', + 'example' => 'COMMITTED', + ], + 'NodeContent' => [ + 'description' => '本次文件版本生成时的调度配置。', + 'type' => 'string', + 'example' => '{"cycleType":0,"cronExpress":"00 05 00 * * ?"}', + ], + 'CommitUser' => [ + 'description' => '生成本次文件版本的阿里云用户ID。', + 'type' => 'string', + 'example' => '7384234****', + ], + 'Comment' => [ + 'description' => '本次文件版本的说明。', + 'type' => 'string', + 'example' => 'Second version submission', + ], + 'FilePropertyContent' => [ + 'description' => '生成本次文件版本的文件基本信息。', + 'type' => 'string', + 'example' => '{"fileName":"ods_user_info_d","fileType":10}', + ], + 'FileName' => [ + 'description' => '生成本次文件版本的文件名。', + 'type' => 'string', + 'example' => 'ods_user_info_d', + ], + 'UseType' => [ + 'description' => '文件所属的功能模块，取值如下：'."\n" + .'- 0：NORMAL（数据开发）'."\n" + .'- 1：MANUAL（手动任务）'."\n" + .'- 2：MANUAL_BIZ（手动工作流）'."\n" + .'- 3：SKIP（数据开发的空跑调度）'."\n" + .'- 10：ADHOCQUERY（临时查询）'."\n" + .'- 30：COMPONENT（组件管理）'."\n", + 'type' => 'string', + 'example' => '0', + ], + 'ChangeType' => [ + 'description' => '本次文件版本的变更类型，包括CREATE、UPDATE和DELETE。', + 'type' => 'string', + 'example' => 'UPDATE', + ], + 'FileVersion' => [ + 'description' => '文件的版本。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'CommitTime' => [ + 'description' => '文件版本生成的毫秒时间戳。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1593881265000', + ], + 'NodeId' => [ + 'description' => '文件版本生成时对应的调度任务ID。', + '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' => '获取文件的版本详情', + 'summary' => '调用GetFileVersion获取文件的版本详情。', + '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' => 'DataWorks工作空间的ID。您可以登录DataWorks管控台，进入工作空间配置页面获取工作空间ID。该参数与ProjectIdentifier参数，二者必须设置其一，用来确定本次API调用操作的DataWorks工作空间。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'docRequired' => false, + 'example' => '10000', + ], + ], + [ + 'name' => 'ProjectIdentifier', + 'in' => 'formData', + 'schema' => [ + 'description' => 'DataWorks工作空间名称。您可以登录DataWorks控制台，进入工作空间配置页面获取工作空间名称。该参数与ProjectId参数，二者必须设置其一，用来确定本次API调用操作的DataWorks工作空间。', + 'type' => 'string', + 'required' => false, + 'example' => 'dw_project', + ], + ], + [ + 'name' => 'FolderId', + 'in' => 'formData', + 'schema' => [ + 'description' => '文件夹的ID，您可以通过[ListFolders](~~173955~~)查询对应文件夹的ID。'."\n" + ."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '2eb6f9****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => [ + 'description' => 'HTTP状态码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'ErrorMessage' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'The connection does not exist.', + ], + 'RequestId' => [ + 'description' => '请求ID。用于出现错误后排查问题。', + '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' => '删除数据开发页面的文件夹', + 'summary' => '调用DeleteFolder删除数据开发页面的文件夹。', + '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' => 'DataWorks工作空间的ID。您可以登录[DataWorks控制台](https://workbench.data.aliyun.com/console)，进入工作空间配置页面获取工作空间ID。'."\n" + ."\n" + .'该参数与ProjectIdentifier参数，二者必须设置其一，用来确定本次API调用操作的DataWorks工作空间。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'docRequired' => false, + 'example' => '10000', + ], + ], + [ + 'name' => 'ProjectIdentifier', + 'in' => 'formData', + 'schema' => [ + 'description' => 'DataWorks工作空间的名称。您可以登录[DataWorks控制台](https://workbench.data.aliyun.com/console)，进入工作空间配置页面获取工作空间名称。'."\n" + ."\n" + .'该参数与ProjectId参数，二者必须设置其一，用来确定本次API调用操作的DataWorks工作空间。', + 'type' => 'string', + 'required' => false, + 'example' => 'dw_project', + ], + ], + [ + 'name' => 'FileId', + 'in' => 'formData', + 'schema' => [ + 'description' => '文件的ID，您可以使用[ListFiles](~~173942~~)接口查询对应文件的ID。'."\n" + ."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + 'example' => '10000201', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => [ + 'description' => 'HTTP状态码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'DeploymentId' => [ + 'description' => '如果文件已经提交过，那么DeleteFile接口会同时触发一个异步在调度系统删除的流程，需要用DeleteFile接口返回的DeploymentId继续调用GetDeployment轮询被触发的异步删除流程的状态。'."\n" + ."\n" + .'如果该字段为空，则说明文件已经删除完毕，无需继续轮询。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1000000001', + ], + 'RequestId' => [ + 'description' => '请求ID。用于出现错误后排查问题。', + 'type' => 'string', + 'example' => '0000-ABCD-EFG****', + ], + 'ErrorMessage' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'The connection does not exist.', + ], + 'Success' => [ + 'description' => '调用是否成功。取值如下：'."\n" + .'- true：调用成功。'."\n" + .'- false：调用失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'ErrorCode' => [ + 'description' => '错误码。', + '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' => '删除数据开发中的文件', + 'summary' => '调用DeleteFile删除数据开发中的文件。如果文件已经提交过，那么DeleteFile API会同时触发一个异步在调度系统删除的流程，需要用DeleteFile API返回的DeploymentId继续调用GetDeployment轮询被触发的异步删除流程的状态。', + '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' => 'DataWorks工作空间的ID，您可以单击页面右上角的小扳手图标，进入工作空间管理页面查看。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'docRequired' => false, + 'example' => '10000', + ], + ], + [ + 'name' => 'ProjectIdentifier', + 'in' => 'formData', + 'schema' => [ + 'description' => 'DataWorks工作空间的唯一标识符，即数据开发页面顶部切换工作空间处的英文标识。'."\n" + ."\n" + .'该参数与ProjectId参数二者必须设置其一，以确定本次API调用操作的DataWorks工作空间。', + 'type' => 'string', + 'required' => false, + 'example' => 'dw_project', + ], + ], + [ + 'name' => 'DeploymentId', + 'in' => 'formData', + 'schema' => [ + 'description' => '发布包的ID。执行[SubmitFile](~~173944~~) 和[DeployFile](~~173956~~)时，都会生成一个对应的发布包ID。'."\n" + ."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + 'example' => '3000001', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回数据结构。', + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => [ + 'description' => 'HTTP状态码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'ErrorMessage' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'The connection does not exist.', + ], + 'RequestId' => [ + 'description' => '本次调用的唯一ID。出现错误后，您可以根据该ID排查问题。', + 'type' => 'string', + 'example' => '0000-ABCD-EFG****', + ], + 'ErrorCode' => [ + 'description' => '错误码。', + 'type' => 'string', + 'example' => 'Invalid.Tenant.ConnectionNotExists', + ], + 'Success' => [ + 'description' => '调用是否成功。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Data' => [ + 'description' => '发布包的详情。', + 'type' => 'object', + 'properties' => [ + 'Deployment' => [ + 'description' => '发布包的详情。', + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => '发布包当前的状态，包括0（就绪）、1（成功）和2（失败）。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'ErrorMessage' => [ + 'description' => '当发布包执行失败（status为2）后，该字段记录具体的错误信息。', + 'type' => 'string', + 'example' => 'Success', + ], + 'FromEnvironment' => [ + 'description' => '执行本次发布所在的环境，包括0（本地）和1（开发环境）。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'ToEnvironment' => [ + 'description' => '发布文件信息的目标环境，包括1（开发环境）和2（生产环境）。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'CheckingStatus' => [ + 'description' => '当前发布包涉及节点的检查状态，当发布包的目标环境是开发环境（toEnviroment=1）时，只有发布包的Status为1并且CheckingStatus为空时，才可以继续进行文件到生产环境的发布。'."\n" + .'- 7：检查未通过'."\n" + .'- 8：正在处于检查中的状态', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '7', + ], + 'CreateTime' => [ + 'description' => '发布包生成的毫秒时间戳。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1593877765000', + ], + 'HandlerId' => [ + 'description' => '发布包执行者的阿里云用户ID。', + 'type' => 'string', + 'example' => '2003****', + ], + 'CreatorId' => [ + 'description' => '发布包创建者的阿里云用户ID。', + 'type' => 'string', + 'example' => '20030****', + ], + 'ExecuteTime' => [ + 'description' => '发布包开始执行的毫秒时间戳。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1593877765000', + ], + 'Name' => [ + 'description' => '发布包的名称，显示在任务发布>发布包列表页面。', + 'type' => 'string', + 'example' => 'ods_user_info_d-2020-07-04_20030****', + ], + ], + ], + 'DeployedItems' => [ + 'description' => '发布项列表。', + 'type' => 'array', + 'items' => [ + 'description' => '发布项详情', + 'type' => 'object', + 'properties' => [ + 'FileId' => [ + 'description' => '文件的ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '5076****', + ], + 'FileVersion' => [ + 'description' => '文件的版本。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '7', + ], + 'Status' => [ + 'description' => '* UNPUBLISHED(0): 未发布'."\n" + .'* SUCCESS(1): 发布成功'."\n" + .'* ERROR(2): 发布失败'."\n" + .'* CLONED(3): 克隆成功'."\n" + .'* DEPLOY_ERROR(4): 发布失败'."\n" + .'* CLONING(5): 克隆中'."\n" + .'* REJECT(6): 发布驳回', + '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' => '获取发布包的详情', + 'summary' => '调用GetDeployment获取发布包的详情。', + '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' => '文件所在的路径。'."\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' => 'DataWorks工作空间的ID。您可以登录[DataWorks控制台](https://workbench.data.aliyun.com/console)，进入工作空间管理页面获取ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'docRequired' => false, + 'example' => '100001', + ], + ], + [ + 'name' => 'FileName', + 'in' => 'formData', + 'schema' => [ + 'description' => '文件的名称。您可以通过重新设置FileName的值来修改文件名称。'."\n" + .'例如，使用[ListFiles](~~173942~~)接口查询目标目录下的文件ID，通过[UpdateFile](~~173951~~)接口，输入查询的文件ID至FileId参数，并配置FileName的参数值，即可修改相应文件的名称。', + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => 'ods_user_info_d', + ], + ], + [ + 'name' => 'FileDescription', + 'in' => 'formData', + 'schema' => [ + 'description' => '文件的描述。', + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => 'Here is the file description', + 'maxLength' => 200, + ], + ], + [ + 'name' => 'Content', + 'in' => 'formData', + 'schema' => [ + 'description' => '文件代码内容，不同代码类型（fileType）的文件，代码格式不同。您可以在运维中心，右键单击对应类型的任务，选择查看代码，查看具体的代码格式。', + 'type' => 'string', + 'required' => false, + 'example' => 'SELECT "1";', + ], + ], + [ + 'name' => 'AutoRerunTimes', + 'in' => 'formData', + 'schema' => [ + 'description' => '文件出错后，自动重跑的次数。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'docRequired' => true, + 'example' => '3', + ], + ], + [ + 'name' => 'AutoRerunIntervalMillis', + 'in' => 'formData', + 'schema' => [ + 'description' => '出错自动重跑时间间隔，单位为毫秒。最大为1800000毫秒（30分钟）。'."\n" + ."\n" + .'该参数与[DataWorks控制台](https://workbench.data.aliyun.com/console)中，数据开发任务的“调度配置>时间属性>出错自动重跑”的”重跑间隔“配置对应。'."\n" + .'控制台中“重跑间隔”的时间单位为分钟，请在调用时注意转换时间。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '120000', + ], + ], + [ + 'name' => 'RerunMode', + 'in' => 'formData', + 'schema' => [ + 'description' => '重跑属性。取值如下：'."\n" + .'- ALL_ALLOWED：运行成功或失败后皆可重跑。'."\n" + .'- FAILURE_ALLOWED：运行成功后不可重跑，运行失败后可以重跑。'."\n" + .'- ALL_DENIED：运行成功或失败皆不可重跑。'."\n" + ."\n" + .'该参数与[DataWorks控制台](https://workbench.data.aliyun.com/console)中，数据开发任务的“调度配置>时间属性>重跑属性”配置内容对应。', + 'type' => 'string', + 'required' => false, + 'example' => 'ALL_ALLOWED', + 'enum' => [ + 'ALL_ALLOWD', + 'FAILURE_ALLOWED', + 'ALL_DENIED', + 'ALL_ALLOWED', + ], + ], + ], + [ + 'name' => 'Stop', + 'in' => 'formData', + 'schema' => [ + 'description' => '是否暂停调度，取值如下：'."\n" + .'- true：暂停调度。'."\n" + .'- false：不暂停调度。'."\n" + ."\n" + .'该参数与[DataWorks控制台](https://workbench.data.aliyun.com/console)中，数据开发任务的“调度配置>时间属性>调度类型”配置为”暂停调度“时对应。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + [ + 'name' => 'ParaValue', + 'in' => 'formData', + 'schema' => [ + 'description' => '调度参数。'."\n" + ."\n" + .'该参数与[DataWorks控制台](https://workbench.data.aliyun.com/console)中，数据开发任务的“调度配置>参数”对应。您可以参考[调度参数](~~137548~~)配置。', + 'type' => 'string', + 'required' => false, + 'example' => 'x=a y=b z=c', + ], + ], + [ + 'name' => 'StartEffectDate', + 'in' => 'formData', + 'schema' => [ + 'description' => '开始自动调度的毫秒时间戳。'."\n" + ."\n" + .'该参数与[DataWorks控制台](https://workbench.data.aliyun.com/console)中，数据开发任务的“调度配置>时间属性>生效日期”配置的开始时间的毫秒时间戳对应。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'minimum' => '0', + 'example' => '936923400000', + ], + ], + [ + 'name' => 'EndEffectDate', + 'in' => 'formData', + 'schema' => [ + 'description' => '停止自动调度的时间戳，单位为毫秒。'."\n" + ."\n" + .'该参数与[DataWorks控制台](https://workbench.data.aliyun.com/console)中，数据开发任务的“调度配置>时间属性>生效日期”配置的结束时间的毫秒时间戳对应。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'minimum' => '0', + 'example' => '4155787800000', + ], + ], + [ + 'name' => 'CronExpress', + 'in' => 'formData', + 'schema' => [ + 'description' => '周期调度的cron表达式，该参数与[DataWorks控制台](https://workbench.data.aliyun.com/console)中，数据开发任务的“调度配置>时间属性>cron表达式”对应。配置完“调度周期”及“定时调度时间”后，DataWorks会自动生成相应cron表达式。'."\n" + ."\n" + .'示例如下：'."\n" + ."\n" + .'- 每天凌晨5点30分定时调度：`00 30 05 * * ?`。'."\n" + ."\n" + .'- 每个小时的第15分钟定时调度：`00 15 * * * ?`。'."\n" + ."\n" + .'- 每隔十分钟调度一次：`00 00/10 * * * ?`。'."\n" + ."\n" + .'- 每天8点到17点，每个十分钟调度一次：`00 00-59/10 8-23 * * * ?`。'."\n" + ."\n" + .'- 每月的1日0点20分自动调度：`00 20 00 1 * ?`。'."\n" + ."\n" + .'- 从1月1日0点10分开始，每过3个月调度一次：`00 10 00 1 1-12/3 ?`。'."\n" + ."\n" + .'- 每周二、周五的0点5分自动调度：`00 05 00 * * 2,5`。'."\n" + ."\n\n" + .'由于DataWorks调度系统的规则，cron表达式有以下限制：'."\n" + ."\n" + .'- 最短调度间隔时间为5分钟。'."\n" + ."\n" + .'- 每天最早调度时间为0点5分。', + 'type' => 'string', + 'required' => false, + 'example' => '00 00-59/5 1-23 * * ?', + ], + ], + [ + 'name' => 'CycleType', + 'in' => 'formData', + 'schema' => [ + 'description' => '调度周期的类型，包括NOT_DAY（分钟、小时）和DAY（日、周、月）。'."\n" + ."\n" + .'该参数与[DataWorks控制台](https://workbench.data.aliyun.com/console)中，数据开发任务的“调度配置>时间属性>调度周期”对应。', + 'type' => 'string', + 'required' => false, + 'example' => 'NOT_DAY', + 'default' => 'DAY', + 'enum' => [ + 'DAY', + 'NOT_DAY', + ], + ], + ], + [ + 'name' => 'DependentType', + 'in' => 'formData', + 'schema' => [ + 'description' => '依赖上一周期的方式。取值如下：'."\n" + .'- SELF：依赖项选择本节点。'."\n" + .'- CHILD：依赖项选择一级子节点。'."\n" + .'- USER_DEFINE：依赖项选择其他节点。'."\n" + .'- NONE：未选择依赖项，即不会依赖上一周期。', + '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' => '当DependentType参数配置为USER_DEFINE时，用于设置当前文件具体依赖的节点ID。依赖多个节点时，使用英文逗号（,）分隔。'."\n" + ."\n" + .'该参数与[DataWorks控制台](https://workbench.data.aliyun.com/console)中，数据开发任务的“调度配置>调度依赖”配置为“上一周期”后，依赖项选择”其他节点“时配置的内容对应。', + 'type' => 'string', + 'required' => false, + 'example' => '5,10,15,20', + ], + ], + [ + 'name' => 'InputList', + 'in' => 'formData', + 'schema' => [ + 'description' => '文件依赖的上游文件的输出名称。依赖多个输出时，使用英文逗号（,）分隔。'."\n" + ."\n" + .'该参数与[DataWorks控制台](https://workbench.data.aliyun.com/console)中，数据开发任务的“调度配置>调度依赖“选择”同周期“时的”父节点输出名称”对应。'."\n" + ."\n" + .'> 通过CreateDISyncTask和UpdateFile方式创建离线同步任务时此参数必须配置。', + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => 'project_root,project.file1,project.001_out', + ], + ], + [ + 'name' => 'ProjectIdentifier', + 'in' => 'formData', + 'schema' => [ + 'description' => 'DataWorks工作空间的名称。您可以登录[DataWorks控制台](https://workbench.data.aliyun.com/console)，进入工作空间配置页面获取工作空间名称。'."\n" + ."\n" + .'该参数与ProjectId参数，二者必须设置其一，用来确定本次API调用操作的DataWorks工作空间。'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'dw_project', + ], + ], + [ + 'name' => 'FileId', + 'in' => 'formData', + 'schema' => [ + 'description' => '文件的ID。您可以调用[ListFiles](~~173942~~)接口获取文件ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + 'example' => '100000001', + ], + ], + [ + 'name' => 'OutputList', + 'in' => 'formData', + 'schema' => [ + 'description' => '文件的输出。'."\n" + ."\n" + .'该参数与[DataWorks控制台](https://workbench.data.aliyun.com/console)中，数据开发任务的“调度配置>调度依赖“选择”同周期“时的”本节点的输出名称”对应。', + 'type' => 'string', + 'required' => false, + 'example' => 'dw_project.ods_user_info_d', + ], + ], + [ + 'name' => 'ResourceGroupIdentifier', + 'in' => 'formData', + 'schema' => [ + 'description' => '文件发布成任务后，任务执行时对应的资源组。您可以调用[ListResourceGroups](~~173913~~)获取工作空间可用的资源组列表。', + 'type' => 'string', + 'required' => false, + 'example' => 'default_group', + ], + ], + [ + 'name' => 'ConnectionName', + 'in' => 'formData', + 'schema' => [ + 'description' => '文件对应任务执行时，任务使用的数据源标识符。您可以调用[ListDataSources](~~211431~~)获取可用的数据源列表。', + 'type' => 'string', + 'required' => false, + 'example' => 'odps_source', + ], + ], + [ + 'name' => 'Owner', + 'in' => 'formData', + 'schema' => [ + 'description' => '文件所有者的用户ID。', + 'type' => 'string', + 'required' => false, + 'example' => '18023848927592', + ], + ], + [ + 'name' => 'AutoParsing', + 'in' => 'formData', + 'schema' => [ + 'description' => '文件是否开启自动解析功能。取值如下：'."\n" + .'- true：文件会自动解析代码。'."\n" + .'- false：文件不会自动解析代码。'."\n" + ."\n" + .'该参数与[DataWorks控制台](https://workbench.data.aliyun.com/console)中，数据开发任务的“调度配置>调度依赖”选择“同周期”时的“代码解析”对应。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'SchedulerType', + 'in' => 'formData', + 'schema' => [ + 'description' => '调度的类型，取值如下：'."\n" + .'- NORMAL：正常调度任务。'."\n" + .'- MANUAL：手动任务，不会被日常调度，对应手动业务流程下的节点。'."\n" + .'- PAUSE：暂停任务。'."\n" + .'- SKIP：空跑任务，被日常调度，但启动调度时直接被置为成功。', + 'type' => 'string', + 'required' => false, + 'example' => 'NORMAL', + 'enum' => [ + 'NORMAL', + 'SKIP', + 'PAUSE', + 'MANUAL', + ], + ], + ], + [ + 'name' => 'AdvancedSettings', + 'in' => 'formData', + 'schema' => [ + 'description' => '任务的高级配置。'."\n" + ."\n" + .'该参数与[DataWorks控制台](https://workbench.data.aliyun.com/console)中，EMR Spark Streaming和EMR Streaming SQL数据开发任务，编辑页面右侧导航栏的“高级设置“对应。'."\n" + ."\n" + .'当前仅EMR Spark Streaming和EMR Streaming SQL任务支持配置该参数，并且参数为JSON格式。', + 'type' => 'string', + 'required' => false, + 'example' => '{"queue":"default","SPARK_CONF":"--conf spark.driver.memory=2g"}', + ], + ], + [ + 'name' => 'StartImmediately', + 'in' => 'formData', + 'schema' => [ + 'description' => '发布后是否立即启动。取值如下：'."\n" + .'- true：发布后立即启动。'."\n" + .'- false：发布后暂不启动。'."\n" + ."\n" + .'该参数与[DataWorks控制台](https://workbench.data.aliyun.com/console)中，EMR Spark Streaming和EMR Streaming SQL数据开发任务，编辑页面右侧导航栏的“配置>时间属性>启动方式“对应。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'InputParameters', + 'in' => 'formData', + 'schema' => [ + 'description' => '节点的上下文输入参数。参数为JSON格式，包含的字段可参考[GetFile](~~173954~~)接口返回值中的InputContextParameterList参数结构。'."\n" + ."\n" + .'该参数与[DataWorks控制台](https://workbench.data.aliyun.com/console)中，数据开发任务的“调度配置>节点上下文>本节点输入参数“对应。', + 'type' => 'string', + 'required' => false, + 'example' => '[{"ValueSource": "project_001.first_node:bizdate_param","ParameterName": "bizdate_input"}]', + ], + ], + [ + 'name' => 'OutputParameters', + 'in' => 'formData', + 'schema' => [ + 'description' => '节点的上下文输出参数。参数为JSON格式，包含的字段可参考[GetFile](~~173954~~)接口返回值中的OutputContextParameterList参数结构。'."\n" + ."\n" + .'该参数与[DataWorks控制台](https://workbench.data.aliyun.com/console)中，数据开发任务的“调度配置>节点上下文>本节点输出参数“对应。', + 'type' => 'string', + 'required' => false, + 'example' => '[{"Type": 1,"Value": "${bizdate}","ParameterName": "bizdate_param"}]', + ], + ], + [ + 'name' => 'IgnoreParentSkipRunningProperty', + 'in' => 'formData', + 'schema' => [ + 'description' => '调度配置->上一周期->是否跳过上游的空跑属性。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'ApplyScheduleImmediately', + 'in' => 'formData', + 'schema' => [ + 'description' => '是否发布后立即生效调度配置。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'Timeout', + 'in' => 'formData', + 'schema' => [ + 'description' => '调度配置超时定义。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'ImageId', + 'in' => 'formData', + 'schema' => [ + 'description' => '自定义镜像ID', + 'type' => 'string', + 'required' => false, + 'example' => 'm-uf6d7npxk1hhek8ng0cb', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => [ + 'description' => 'HTTP状态码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'ErrorMessage' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'The connection does not exist.', + ], + 'RequestId' => [ + 'description' => '本次调用的唯一ID。出现错误后，您可以根据该ID排查问题。', + 'type' => 'string', + 'example' => '0000-ABCD-EFGH-IJKLMNOPQ', + ], + 'ErrorCode' => [ + 'description' => '错误码。', + 'type' => 'string', + 'example' => 'Invalid.Tenant.ConnectionNotExists', + ], + 'Success' => [ + 'description' => '调用是否成功。取值如下：'."\n" + .'- true：调用成功。'."\n" + .'- false：调用失败。', + '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' => '更新已有的文件节点', + 'summary' => '调用UpdateFile更新已创建的文件。', + 'description' => '调试或调用该接口时，填写的参数必须与该节点原本的文件配置不同。例如，源节点的某参数值为A，则需要变更为B后再提交。如果仍填写A，会报invalid异常。', + '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' => 'DataWorks工作空间的ID。您可以登录DataWorks管控台，进入工作空间配置页面获取工作空间ID。该参数与ProjectIdentifier参数，二者必须设置其一，用来确定本次API调用操作的DataWorks工作空间。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'docRequired' => false, + 'example' => '1000011', + ], + ], + [ + 'name' => 'ProjectIdentifier', + 'in' => 'formData', + 'schema' => [ + 'description' => 'DataWorks工作空间名称。您可以登录DataWorks控制台，进入工作空间配置页面获取工作空间名称。该参数与ProjectId参数，二者必须设置其一，用来确定本次API调用操作的DataWorks工作空间。', + 'type' => 'string', + 'required' => false, + 'example' => 'dw_project', + ], + ], + [ + 'name' => 'FolderId', + 'in' => 'formData', + 'schema' => [ + 'description' => '文件夹的ID，该参数与FolderPath参数，二者必须设置其一。您可以调用[ListFolders](~~173955~~)接口获取文件夹ID。', + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => '273****', + ], + ], + [ + 'name' => 'FolderPath', + 'in' => 'formData', + 'schema' => [ + 'description' => '文件夹的路径，该参数与FolderId参数，二者必须设置其一。您可以调用[ListFolders](~~173955~~)接口获取文件夹路径。', + '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' => 'HTTP状态码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'ErrorMessage' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'The connection does not exist.', + ], + 'RequestId' => [ + 'description' => '请求ID。用于出现错误后排查问题。', + 'type' => 'string', + 'example' => '0000-ABCD-EFG****', + ], + 'ErrorCode' => [ + 'description' => '错误码。', + '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' => '文件夹的ID。'."\n" + ."\n", + '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' => '获取文件夹的详情', + 'summary' => '调用GetFolder获取文件夹的详情。', + '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' => '文件的ID，您可以通过[ListFiles](~~173942~~)查询对应文件的ID。'."\n" + ."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + 'example' => '100000001', + ], + ], + [ + 'name' => 'ProjectId', + 'in' => 'formData', + 'schema' => [ + 'description' => 'DataWorks工作空间的ID，您可以单击页面右上角的小扳手图标，进入工作空间管理页面查看。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'docRequired' => false, + 'example' => '100001', + ], + ], + [ + 'name' => 'ProjectIdentifier', + 'in' => 'formData', + 'schema' => [ + 'description' => 'DataWorks工作空间的唯一标识符，即数据开发页面顶部切换工作空间处的英文标识。'."\n" + ."\n" + .'该参数与ProjectId参数二者必须设置其一，以确定本次API调用操作的DataWorks工作空间。', + 'type' => 'string', + 'required' => false, + 'example' => 'dw_project', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'formData', + 'schema' => [ + 'description' => '请求的数据页数，用于翻页。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'minimum' => '1', + 'example' => '1', + 'default' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'formData', + 'schema' => [ + 'description' => '每页显示的条数，默认为10条，最大100条。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'docRequired' => false, + 'maximum' => '100', + 'minimum' => '0', + 'example' => '10', + 'default' => '10', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => [ + 'description' => 'HTTP状态码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'ErrorMessage' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'The connection does not exist.', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '0000-ABCD-EFG****', + ], + 'ErrorCode' => [ + 'description' => '错误码。', + 'type' => 'string', + 'example' => 'Invalid.Tenant.ConnectionNotExists', + ], + 'Success' => [ + 'description' => '调用是否成功。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Data' => [ + 'description' => '文件的版本列表。', + 'type' => 'object', + 'properties' => [ + 'PageNumber' => [ + 'description' => '当前数据页的页码。'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '当前数据页的大小。'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'TotalCount' => [ + 'description' => '满足查询条件的数据总条数。'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '13', + ], + 'FileVersions' => [ + 'description' => '文件的版本详情。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'FileContent' => [ + 'description' => '生成本次文件版本的文件代码。'."\n", + 'type' => 'string', + 'example' => 'SHOW TABLES;', + ], + 'Status' => [ + 'description' => '文件版本当前的状态，包括COMMITTING（提交中）、COMMITTED或CHECK_OK（已提交）、PACKAGED（准备发布）、DEPLOYING（发布中）、DEPLOYED（已发布）和CANCELLED（取消发布）。', + 'type' => 'string', + 'example' => 'COMMITTED', + ], + 'IsCurrentProd' => [ + 'description' => '本次文件版本是否为当前生产环境的最新版本。', + 'type' => 'boolean', + 'example' => 'false', + ], + 'CommitUser' => [ + 'description' => '生成本次文件版本的阿里云用户UID。'."\n", + 'type' => 'string', + 'example' => '73842342****', + ], + 'NodeContent' => [ + 'description' => '生成本次文件版本的调度配置。'."\n", + 'type' => 'string', + 'example' => '{"cycleType":0,"cronExpress":"00 05 00 * * ?"}', + ], + 'Comment' => [ + 'description' => '本次文件版本的说明。', + 'type' => 'string', + 'example' => 'Second version submission', + ], + 'FilePropertyContent' => [ + 'description' => '生成本次文件版本的文本基本信息。'."\n", + 'type' => 'string', + 'example' => '{"fileName":"ods_user_info_d","fileType":10}', + ], + 'FileName' => [ + 'description' => '生成本次文件版本的文件名。'."\n", + 'type' => 'string', + 'example' => 'ods_user_info_d', + ], + 'UseType' => [ + 'description' => '文件所属的功能模块，包括NORMAL（数据开发）、MANUAL（手动任务）、MANUAL_BIZ（手动工作流）、SKIP（数据开发的空跑调度）、ADHOCQUERY（临时查询）和COMPONENT（组件管理）。', + 'type' => 'string', + 'example' => 'NORMAL', + ], + 'ChangeType' => [ + 'description' => '本次文件版本的变更类型，包括CREATE、UPDATE和DELETE。', + 'type' => 'string', + 'example' => 'UPDATE', + ], + 'FileVersion' => [ + 'description' => '文件的版本。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'CommitTime' => [ + 'description' => '生成文件版本的毫秒时间戳。'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1593881265000', + ], + 'NodeId' => [ + 'description' => '生成文件版本时对应的调度任务ID。'."\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.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' => '查询文件的版本列表', + 'summary' => '调用ListFileVersions查询文件的版本列表。', + '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' => 'DataWorks工作空间的ID。您可以登录[DataWorks控制台](https://workbench.data.aliyun.com/console)，进入工作空间配置页面获取工作空间ID。'."\n" + ."\n" + .'该参数与ProjectIdentifier参数，二者必须设置其一，用来确定本次API调用操作的DataWorks工作空间。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'docRequired' => false, + 'example' => '10000', + ], + ], + [ + 'name' => 'ProjectIdentifier', + 'in' => 'formData', + 'schema' => [ + 'description' => 'DataWorks工作空间的名称。您可以登录[DataWorks控制台](https://workbench.data.aliyun.com/console)，进入工作空间配置页面获取工作空间名称。'."\n" + ."\n" + .'该参数与ProjectId参数，二者必须设置其一，用来确定本次API调用操作的DataWorks工作空间。', + 'type' => 'string', + 'required' => false, + 'example' => 'dw_project', + ], + ], + [ + 'name' => 'FileId', + 'in' => 'formData', + 'schema' => [ + 'description' => '文件的ID。您可以调用[ListFiles](~~173942~~)接口查询对应文件的ID。'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '100000001', + ], + ], + [ + 'name' => 'NodeId', + 'in' => 'formData', + 'schema' => [ + 'description' => '调度节点的ID。您可以调用[ListFiles](~~173942~~)接口获取节点ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '200000001', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => [ + 'description' => 'HTTP状态码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'ErrorMessage' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'The connection does not exist.', + ], + 'RequestId' => [ + 'description' => '请求ID。用于出现错误后排查问题。', + 'type' => 'string', + 'example' => '0000-ABCD-EFG****', + ], + 'ErrorCode' => [ + 'description' => '错误码。', + 'type' => 'string', + 'example' => 'Invalid.Tenant.ConnectionNotExists', + ], + 'Success' => [ + 'description' => '调用是否成功。取值如下：'."\n" + .'- true：调用成功。'."\n" + .'- false：调用失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Data' => [ + 'description' => '文件的详情。', + 'type' => 'object', + 'properties' => [ + 'File' => [ + 'description' => '文件的基本信息。', + 'type' => 'object', + 'properties' => [ + 'CommitStatus' => [ + 'description' => '文件当前的提交状态，包括0（未提交最新的代码）和1（已提交最新的代码）。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'AutoParsing' => [ + 'description' => '文件是否开启自动解析功能。取值如下：'."\n" + .'- true：文件会自动解析代码。'."\n" + .'- false：文件不会自动解析代码。'."\n" + ."\n" + .'该参数与[DataWorks控制台](https://workbench.data.aliyun.com/console)中，数据开发任务的“调度配置>调度依赖”选择“同周期”时的“代码解析”对应。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Owner' => [ + 'description' => '文件责任人的阿里云用户ID。', + 'type' => 'string', + 'example' => '7775674356****', + ], + 'CreateTime' => [ + 'description' => '文件创建的时间戳，单位为毫秒。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1593879116000', + ], + 'FileType' => [ + 'description' => '文件的代码类型。文件类型，不同文件类型其代码不同，详情请参见[DataWorks节点合集](~~600169~~)。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'CurrentVersion' => [ + 'description' => '文件当前已经提交的最新版本号。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '3', + ], + 'BizId' => [ + 'description' => '文件所属业务流程的ID。该字段已废弃，请使用BusinessId字段。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1000001', + ], + 'LastEditUser' => [ + 'description' => '最近一次编辑文件的阿里云用户ID。', + 'type' => 'string', + 'example' => '62465892****', + ], + 'FileName' => [ + 'description' => '文件的名称。', + 'type' => 'string', + 'example' => 'ods_user_info_d', + ], + 'ConnectionName' => [ + 'description' => '执行文件对应的任务时，所使用的数据源名称。', + 'type' => 'string', + 'example' => 'odps_source', + ], + 'UseType' => [ + 'description' => '文件所属的功能模块。取值如下：'."\n" + .'- NORMAL：数据开发。'."\n" + .'- MANUAL：手动任务。'."\n" + .'- MANUAL_BIZ：手动业务流程。'."\n" + .'- SKIP：数据开发的空跑调度。'."\n" + .'- ADHOCQUERY：临时查询。'."\n" + .'- COMPONENT：组件管理。'."\n", + 'type' => 'string', + 'example' => 'NORMAL', + ], + 'FileFolderId' => [ + 'description' => '文件所属文件夹的ID。', + 'type' => 'string', + 'example' => '2735c2****', + ], + 'ParentId' => [ + 'description' => '如果当前文件是组合节点文件的内部文件，该字段标识对应组合节点文件的ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '-1', + ], + 'CreateUser' => [ + 'description' => '文件创建人的阿里云用户ID。', + 'type' => 'string', + 'example' => '424732****', + ], + 'IsMaxCompute' => [ + 'description' => '标识该资源文件是否需要上传至MaxCompute。'."\n" + .'仅当文件是MaxCompute资源文件时才需要配置该参数。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'BusinessId' => [ + 'description' => '文件的业务流程ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1000001', + ], + 'FileDescription' => [ + 'description' => '文件的描述信息。', + 'type' => 'string', + 'example' => 'My first DataWorks file', + ], + 'DeletedStatus' => [ + 'description' => '文件的删除状态。取值如下：'."\n" + .'- NORMAL：未删除。'."\n" + .'- RECYCLE_BIN：回收站。'."\n" + .'- DELETED：被删除。', + 'type' => 'string', + 'example' => 'RECYCLE', + ], + 'LastEditTime' => [ + 'description' => '最近一次编辑文件的时间戳，单位为毫秒。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1593879116000', + ], + 'Content' => [ + 'description' => '文件的代码。', + 'type' => 'string', + 'example' => 'SHOW TABLES;', + ], + 'NodeId' => [ + 'description' => '提交文件后，在调度系统生成的调度任务ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '300001', + ], + 'AdvancedSettings' => [ + 'description' => '任务的高级配置。'."\n" + ."\n" + .'该参数与[DataWorks控制台](https://workbench.data.aliyun.com/console)中，EMR数据开发任务，编辑页面右侧导航栏的“高级设置“对应。'."\n" + ."\n" + .'> 当前EMR Shell任务不支持配置高级参数。'."\n" + ."\n" + .'各EMR任务开发的高级参数说明，请参见[EMR任务开发](~~473077~~)。', + 'type' => 'string', + 'example' => '{\\"priority\\":\\"1\\",\\"ENABLE_SPARKSQL_JDBC\\":false,\\"FLOW_SKIP_SQL_ANALYZE\\":false,\\"queue\\":\\"default\\"}', + ], + 'FileId' => [ + 'description' => '文件的ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '100000001', + ], + ], + ], + 'NodeConfiguration' => [ + 'description' => '文件的调度配置。', + 'type' => 'object', + 'properties' => [ + 'RerunMode' => [ + 'description' => '重跑属性。取值如下：'."\n" + .'- ALL_ALLOWED：运行成功或失败后皆可重跑。'."\n" + .'- FAILURE_ALLOWED：运行成功后不可重跑，运行失败后可以重跑。'."\n" + .'- ALL_DENIED：运行成功或失败皆不可重跑。'."\n" + ."\n" + .'该参数与[DataWorks控制台](https://workbench.data.aliyun.com/console)中，数据开发任务的“调度配置>时间属性>重跑属性”配置内容对应。', + 'type' => 'string', + 'example' => 'ALL_ALLOWED', + ], + 'SchedulerType' => [ + 'description' => '调度的类型，取值如下：'."\n" + .'- NORMAL：正常调度任务。'."\n" + .'- MANUAL：手动任务，不会被日常调度，对应手动业务流程下的节点。'."\n" + .'- PAUSE：暂停任务。'."\n" + .'- SKIP：空跑任务，被日常调度，但启动调度时直接被置为成功。', + 'type' => 'string', + 'example' => 'NORMAL', + ], + 'Stop' => [ + 'description' => '是否暂停调度，取值如下：'."\n" + .'- true：暂停调度。'."\n" + .'- false：不暂停调度。'."\n" + ."\n" + .'该参数与[DataWorks控制台](https://workbench.data.aliyun.com/console)中，数据开发任务的“调度配置>时间属性>调度类型”配置为”暂停调度“时对应。', + 'type' => 'boolean', + 'example' => 'false', + ], + 'ParaValue' => [ + 'description' => '调度参数。'."\n" + ."\n" + .'该参数与[DataWorks控制台](https://workbench.data.aliyun.com/console)中，数据开发任务的“调度配置>参数”对应。您可以参考[调度参数](~~137548~~)配置。', + 'type' => 'string', + 'example' => 'a=x b=y', + ], + 'StartEffectDate' => [ + 'description' => '开始自动调度的毫秒时间戳。'."\n" + ."\n" + .'该参数与[DataWorks控制台](https://workbench.data.aliyun.com/console)中，数据开发任务的“调度配置>时间属性>生效日期”配置的开始时间的毫秒时间戳对应。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '936923400000', + ], + 'EndEffectDate' => [ + 'description' => '停止自动调度的时间戳，单位为毫秒。'."\n" + ."\n" + .'该参数与[DataWorks控制台](https://workbench.data.aliyun.com/console)中，数据开发任务的“调度配置>时间属性>生效日期”配置的结束时间的毫秒时间戳对应。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '4155787800000', + ], + 'CycleType' => [ + 'description' => '调度周期的类型，包括NOT_DAY（分钟、小时）和DAY（日、周、月）。'."\n" + ."\n" + .'该参数与[DataWorks控制台](https://workbench.data.aliyun.com/console)中，数据开发任务的“调度配置>时间属性>调度周期”对应。', + 'type' => 'string', + 'example' => 'DAY', + ], + 'DependentNodeIdList' => [ + 'description' => '当DependentType参数配置为USER_DEFINE时，用于设置当前文件具体依赖的节点ID。依赖多个节点时，使用英文逗号（,）分隔。'."\n" + ."\n" + .'该参数与[DataWorks控制台](https://workbench.data.aliyun.com/console)中，数据开发任务的“调度配置>调度依赖”配置为“上一周期”后，依赖项选择”其他节点“时配置的内容对应。', + 'type' => 'string', + 'example' => '5,10,15,20', + ], + 'ResourceGroupId' => [ + 'description' => '文件发布成任务后，任务执行时对应的资源组。您可以调用[ListResourceGroups](~~173913~~)获取工作空间可用的资源组列表。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '375827434852437', + ], + 'DependentType' => [ + 'description' => '依赖上一周期的方式。取值如下：'."\n" + .'- SELF：依赖项选择本节点。'."\n" + .'- CHILD：依赖项选择一级子节点。'."\n" + .'- USER_DEFINE：依赖项选择其他节点。'."\n" + .'- NONE：未选择依赖项，即不会依赖上一周期。', + 'type' => 'string', + 'example' => 'USER_DEFINE', + ], + 'AutoRerunTimes' => [ + 'description' => '出错自动重跑的次数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '3', + ], + 'AutoRerunIntervalMillis' => [ + 'description' => '出错自动重跑时间间隔，单位为毫秒。'."\n" + ."\n" + .'该参数与[DataWorks控制台](https://workbench.data.aliyun.com/console)中，数据开发任务的“调度配置>时间属性>出错自动重跑”的”重跑间隔“配置对应。'."\n" + .'控制台中“重跑间隔”的时间单位为分钟，请在调用时注意转换时间。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '120000', + ], + 'CronExpress' => [ + 'description' => '文件定时调度的cron表达式。', + 'type' => 'string', + 'example' => '00 05 00 * * ?', + ], + 'InputList' => [ + 'description' => '文件依赖的上游文件输出。', + 'type' => 'array', + 'items' => [ + 'description' => '依赖的上游文件输出信息。', + 'type' => 'object', + 'properties' => [ + 'Input' => [ + 'description' => '文件依赖的上游文件的输出名称。'."\n" + ."\n" + .'该参数与[DataWorks控制台](https://workbench.data.aliyun.com/console)中，数据开发任务的“调度配置>调度依赖“选择”同周期“时的”父节点输出名称”对应。', + 'type' => 'string', + 'example' => 'project.001_out', + ], + 'ParseType' => [ + 'description' => '配置文件依赖的方式，取值如下：'."\n" + .'- MANUAL：手动配置。'."\n" + .'- AUTO：自动解析。', + 'type' => 'string', + 'example' => 'MANUAL', + ], + ], + ], + ], + 'OutputList' => [ + 'description' => '文件的输出。'."\n" + ."\n" + .'该参数与[DataWorks控制台](https://workbench.data.aliyun.com/console)中，数据开发任务的“调度配置>调度依赖“选择”同周期“时的”本节点的输出名称”对应。', + 'type' => 'array', + 'items' => [ + 'description' => '文件的输出信息。', + 'type' => 'object', + 'properties' => [ + 'RefTableName' => [ + 'description' => '文件的输出值。'."\n" + ."\n" + .'该参数与[DataWorks控制台](https://workbench.data.aliyun.com/console)中，数据开发任务的“调度配置>调度依赖“选择”同周期“时的“本节点的输出表”列的值对应。', + 'type' => 'string', + 'example' => 'ods_user_info_d', + ], + 'Output' => [ + 'description' => '文件的输出名称。'."\n" + ."\n" + .'该参数与[DataWorks控制台](https://workbench.data.aliyun.com/console)中，数据开发任务的“调度配置>调度依赖“选择”同周期“时的“本节点的输出名称”列值对应。', + 'type' => 'string', + 'example' => 'dw_project.002_out', + ], + ], + ], + ], + 'StartImmediately' => [ + 'description' => '发布后是否立即启动。'."\n" + ."\n" + .'该参数与[DataWorks控制台](https://workbench.data.aliyun.com/console)中，EMR Spark Streaming和EMR Streaming SQL数据开发任务，编辑页面右侧导航栏的“配置>时间属性>启动方式“对应。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'InputParameters' => [ + 'description' => '节点上下文输入参数。'."\n" + ."\n" + .'该参数与[DataWorks控制台](https://workbench.data.aliyun.com/console)中，数据开发任务的“调度配置>节点上下文>本节点输入参数“对应。', + 'type' => 'array', + 'items' => [ + 'description' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'ParameterName' => [ + 'description' => '节点上下文输入参数的参数名称。在代码中可以使用${...}方式引用该参数。'."\n" + ."\n" + .'该参数与[DataWorks控制台](https://workbench.data.aliyun.com/console)中，数据开发任务的“调度配置>节点上下文>本节点输入参数“的”参数名“对应。', + 'type' => 'string', + 'example' => 'input', + ], + 'ValueSource' => [ + 'description' => '节点上下文输入参数的取值来源。'."\n" + ."\n" + .'该参数与[DataWorks控制台](https://workbench.data.aliyun.com/console)中，数据开发任务的“调度配置>节点上下文>本节点输入参数“的”取值来源“对应。', + 'type' => 'string', + 'example' => 'project_001.parent_node:outputs', + ], + ], + ], + ], + 'OutputParameters' => [ + 'description' => '节点上下文输出参数。'."\n" + ."\n" + .'该参数与[DataWorks控制台](https://workbench.data.aliyun.com/console)中，数据开发任务的“调度配置>节点上下文>本节点输出参数“对应。', + 'type' => 'array', + 'items' => [ + 'description' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'ParameterName' => [ + 'description' => '节点上下文输出参数的参数名称。'."\n" + ."\n" + .'该参数与[DataWorks控制台](https://workbench.data.aliyun.com/console)中，数据开发任务的“调度配置>节点上下文>本节点输出参数“的”参数名“对应。', + 'type' => 'string', + 'example' => 'output', + ], + 'Value' => [ + 'description' => '节点上下文输出参数的表达式。'."\n" + ."\n" + .'该参数与[DataWorks控制台](https://workbench.data.aliyun.com/console)中，数据开发任务的“调度配置>节点上下文>本节点输出参数“的”取值“对应。', + 'type' => 'string', + 'example' => '${bizdate}', + ], + 'Type' => [ + 'description' => '节点上下文输出参数表达式的类型。取值如下：'."\n" + .'- 1：表示常量。'."\n" + .'- 2：表示变量。'."\n" + .'- 3：表示参数节点透传变量。'."\n" + ."\n" + .'该参数与[DataWorks控制台](https://workbench.data.aliyun.com/console)中，数据开发任务的“调度配置>节点上下文>本节点输出参数“的”类型“对应。', + 'type' => 'string', + 'example' => '1', + ], + 'Description' => [ + 'description' => '节点上下文输出的参数描述。', + 'type' => 'string', + 'example' => 'It\'s a context output parameter.', + ], + ], + ], + ], + 'ApplyScheduleImmediately' => [ + 'description' => '是否发布后立即生效调度配置', + 'type' => 'string', + 'example' => 'true', + ], + 'IgnoreParentSkipRunningProperty' => [ + 'description' => '调度配置->上一周期->是否跳过上游的空跑属性', + 'type' => 'string', + 'example' => 'true', + ], + 'Timeout' => [ + 'description' => '调度配置超时定义', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'ImageId' => [ + 'description' => '自定义镜像ID', + 'type' => 'string', + 'example' => 'm-bp1h4b5a8ogkbll2f3tr', + ], + ], + ], + 'ResourceDownloadLink' => [ + 'description' => '资源下载地址', + 'type' => 'object', + 'properties' => [ + 'downloadLink' => [ + 'description' => '资源下载地址链接', + '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' => '获取文件的详情', + 'summary' => '该接口用于获取文件的详情。', + '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' => 'DataWorks工作空间的ID。您可以登录DataWorks管控台，进入工作空间配置页面获取工作空间ID。该参数与ProjectIdentifier参数，二者必须设置其一，用来确定本次API调用操作的DataWorks工作空间。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'docRequired' => false, + 'example' => '10000', + ], + ], + [ + 'name' => 'ProjectIdentifier', + 'in' => 'formData', + 'schema' => [ + 'description' => 'DataWorks工作空间名称。您可以登录DataWorks控制台，进入工作空间配置页面获取工作空间名称。该参数与ProjectId参数，二者必须设置其一，用来确定本次API调用操作的DataWorks工作空间。'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'dw_project', + ], + ], + [ + 'name' => 'ParentFolderPath', + 'in' => 'formData', + 'schema' => [ + 'description' => '父文件夹的路径。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'Business_process/my_first_business_process/MaxCompute', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'formData', + 'schema' => [ + 'description' => '请求的数据页数，用于翻页。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'docRequired' => true, + 'minimum' => '1', + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'formData', + 'schema' => [ + 'description' => '每页显示的数据条数，默认为10条，最大为100条。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'docRequired' => true, + 'maximum' => '100', + 'minimum' => '0', + 'example' => '10', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => [ + 'description' => 'HTTP状态码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'ErrorMessage' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'The connection does not exist.', + ], + 'RequestId' => [ + 'description' => '请求ID。用于出现错误后排查问题。', + 'type' => 'string', + 'example' => '0000-ABCD-****', + ], + 'ErrorCode' => [ + 'description' => '错误码。', + 'type' => 'string', + 'example' => 'Invalid.Tenant.ConnectionNotExists', + ], + 'Success' => [ + 'description' => '调用是否成功。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Data' => [ + 'description' => '满足条件的文件夹的列表信息。', + 'type' => 'object', + 'properties' => [ + 'PageNumber' => [ + 'description' => '当前数据页的页码。'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '当前数据页的数据条数。'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'TotalCount' => [ + 'description' => '满足查询条件的数据总条数。'."\n", + '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' => '文件夹的ID。', + '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' => '查询文件夹的列表', + 'summary' => '调用ListFolders查询文件夹的列表。', + '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' => 'DataWorks工作空间的ID。您可以登录DataWorks管控台，进入工作空间配置页面获取工作空间ID。该参数与ProjectIdentifier参数，二者必须设置其一，用来确定本次API调用操作的DataWorks工作空间。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'docRequired' => false, + 'example' => '10000', + ], + ], + [ + 'name' => 'ProjectIdentifier', + 'in' => 'formData', + 'schema' => [ + 'description' => 'DataWorks工作空间名称。您可以登录DataWorks控制台，进入工作空间配置页面获取工作空间名称。该参数与ProjectId参数，二者必须设置其一，用来确定本次API调用操作的DataWorks工作空间。', + 'type' => 'string', + 'required' => false, + 'example' => 'dw_project', + ], + ], + [ + 'name' => 'FileId', + 'in' => 'formData', + 'schema' => [ + 'description' => '文件的ID，您可以通过[ListFiles](~~173942~~)查询对应文件的ID。'."\n" + .'该参数与NodeId参数配置一个即可。'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'docRequired' => true, + 'example' => '10000022', + ], + ], + [ + 'name' => 'Comment', + 'in' => 'formData', + 'schema' => [ + 'description' => '本次发布的说明信息。', + 'type' => 'string', + 'required' => false, + 'example' => 'First release task', + ], + ], + [ + 'name' => 'NodeId', + 'in' => 'formData', + 'schema' => [ + 'description' => '待发布文件在调度系统对应的任务ID。该参数与FileId参数配置一个即可。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '2000001', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回的数据结构。', + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => [ + 'description' => 'HTTP状态码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Data' => [ + 'description' => '发布包的ID，后续需要将该ID作为参数调用[GetDeployment](~~173950~~)接口，获取本次发布的具体情况。 '."\n" + ."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '30000001', + ], + 'RequestId' => [ + 'description' => '请求ID。用于出现错误后排查问题。', + 'type' => 'string', + 'example' => '0000-ABCD-EFG****', + ], + 'ErrorMessage' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'The connection does not exist.', + ], + 'Success' => [ + 'description' => '调用是否成功。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'ErrorCode' => [ + 'description' => '错误码。', + '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' => '部署文件', + 'summary' => '发布文件至生产环境。', + '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' => '函数文件所在文件夹的路径。'."\n", + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => 'Business_process/First_Business_Process/function/string_processing_function', + ], + ], + [ + 'name' => 'ProjectId', + 'in' => 'formData', + 'schema' => [ + 'description' => 'DataWorks工作空间的ID，您可以单击页面右上角的小扳手图标，进入工作空间管理页面查看。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'docRequired' => false, + 'example' => '10000', + ], + ], + [ + 'name' => 'FunctionType', + 'in' => 'formData', + 'schema' => [ + 'description' => '函数的分类，对应创建函数表单中的函数类型，包括MATH（数学运算函数）、AGGREGATE（聚合函数）、STRING（字符串处理函数）、DATE（日期处理函数）、ANALYTIC（窗口函数）和OTHER（其他函数）。'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'enumValueTitles' => [], + 'example' => 'STRING', + 'enum' => [ + 'MATH', + 'AGGREGATE', + 'STRING', + 'DATE', + 'ANALYTIC', + 'OTHER', + ], + ], + ], + [ + 'name' => 'ClassName', + 'in' => 'formData', + 'schema' => [ + 'description' => '函数定义所在的类名，对应创建函数表单的类名。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'com.alibaba.DataWorks.api.udf.StringConcat', + ], + ], + [ + 'name' => 'Resources', + 'in' => 'formData', + 'schema' => [ + 'description' => '函数引用的资源名列表，使用英文逗号（,）分隔，对应创建函数表单中的资源列表。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'string-concat-1.0.0.jar,commons-lang-2.6.jar', + ], + ], + [ + 'name' => 'UdfDescription', + 'in' => 'formData', + 'schema' => [ + 'description' => '函数用途的说明，对应创建函数表单中的描述。', + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => 'Concatenate several strings to generate a new string', + ], + ], + [ + 'name' => 'CmdDescription', + 'in' => 'formData', + 'schema' => [ + 'description' => '函数的调用命令格式，对应创建函数表单中的命令格式。', + 'type' => 'string', + 'required' => false, + 'example' => 'StringConcat(String... substrs)', + ], + ], + [ + 'name' => 'ParameterDescription', + 'in' => 'formData', + 'schema' => [ + 'description' => '函数入参的说明，对应创建函数表单中的参数说明。', + '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' => '函数的返回值说明，对应创建函数表单中的返回值。', + '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' => '函数的调用示例，对应创建函数表单中的示例。', + 'type' => 'string', + 'required' => false, + 'example' => 'StringConcat(\'a\', \'b\', \'c\')', + ], + ], + [ + 'name' => 'ProjectIdentifier', + 'in' => 'formData', + 'schema' => [ + 'description' => 'DataWorks工作空间的唯一标识符，即数据开发页面顶部切换工作空间处的英文标识。'."\n" + ."\n" + .'该参数与ProjectId参数二者必须设置其一，以确定本次API调用操作的DataWorks工作空间。', + 'type' => 'string', + 'required' => false, + 'example' => 'dw_project', + ], + ], + [ + 'name' => 'FileId', + 'in' => 'formData', + 'schema' => [ + 'description' => '文件的ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '1000000112', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => [ + 'description' => 'HTTP状态码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'ErrorMessage' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'The connection does not exist.', + ], + 'RequestId' => [ + 'description' => '本次调用的唯一ID。出现错误后，您可以根据该ID排查问题。', + '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<Success>true</Success>","errorExample":""}]', + 'title' => '更新函数的文件信息', + 'summary' => '调用UpdateUdfFile更新函数的文件信息。', + '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' => 'DataWorks工作空间的ID。您可以登录DataWorks管控台，进入工作空间配置页面获取工作空间ID。该参数与ProjectIdentifier参数，二者必须设置其一，用来确定本次API调用操作的DataWorks工作空间。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'docRequired' => false, + 'example' => '10000', + ], + ], + [ + 'name' => 'ProjectIdentifier', + 'in' => 'formData', + 'schema' => [ + 'description' => 'DataWorks工作空间名称。您可以登录DataWorks控制台，进入工作空间配置页面获取工作空间名称。该参数与ProjectId参数，二者必须设置其一，用来确定本次API调用操作的DataWorks工作空间。', + 'type' => 'string', + 'required' => false, + 'example' => 'dw_project', + ], + ], + [ + 'name' => 'BusinessId', + 'in' => 'formData', + 'schema' => [ + 'description' => '业务流程的ID，您可以调用[ListBusiness](~~173945~~)接口获取。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + 'example' => '1000000111', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => [ + 'description' => 'HTTP状态码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'ErrorMessage' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'The connection does not exist.', + ], + 'RequestId' => [ + 'description' => '请求ID。用于出现错误后排查问题。', + 'type' => 'string', + 'example' => '0000-ABCD-EFG****', + ], + 'ErrorCode' => [ + 'description' => '错误码。', + 'type' => 'string', + 'example' => 'Invalid.Tenant.ConnectionNotExists', + ], + 'Success' => [ + 'description' => '调用是否成功。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Data' => [ + 'description' => '业务流程的详情。', + 'type' => 'object', + 'properties' => [ + 'Owner' => [ + 'description' => '业务流程责任人的阿里云用户ID。', + 'type' => 'string', + 'example' => '20000****', + ], + 'Description' => [ + 'description' => '业务流程的描述信息。', + 'type' => 'string', + 'example' => 'This is my first business process.', + ], + 'ProjectId' => [ + 'description' => '业务流程所在DataWorks工作空间的ID。', + 'type' => 'string', + 'example' => '10000', + ], + 'BusinessId' => [ + 'description' => '业务流程的ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1000001', + ], + 'BusinessName' => [ + 'description' => '业务流程的名称。', + 'type' => 'string', + 'example' => 'The first business process', + ], + 'UseType' => [ + 'description' => '业务流程所属的功能模块，包括NORMAL（数据开发）和MANUAL_BIZ（手动业务流程）。', + '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 \\"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' => '查询业务流程的详情', + 'summary' => '调用GetBusiness查询业务流程的详情。', + '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' => 'DataWorks工作空间的ID。您可以登录DataWorks管控台，进入工作空间配置页面获取工作空间ID。该参数与ProjectIdentifier参数，二者必须设置其一，用来确定本次API调用操作的DataWorks工作空间。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'docRequired' => false, + 'example' => '10000', + ], + ], + [ + 'name' => 'ProjectIdentifier', + 'in' => 'formData', + 'schema' => [ + 'description' => 'DataWorks工作空间名称。您可以登录DataWorks控制台，进入工作空间配置页面获取工作空间名称。该参数与ProjectId参数，二者必须设置其一，用来确定本次API调用操作的DataWorks工作空间。', + 'type' => 'string', + 'required' => false, + 'example' => 'dw_project', + ], + ], + [ + 'name' => 'FolderId', + 'in' => 'formData', + 'schema' => [ + 'description' => '文件夹的ID，您可以调用[ListFolders](~~173955~~)获取文件夹的ID。'."\n" + ."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '2735c2c19d58', + ], + ], + [ + 'name' => 'FolderName', + 'in' => 'formData', + 'schema' => [ + 'description' => '文件夹的名称。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'MySecondFolder', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回数据。', + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => [ + 'description' => 'HTTP状态码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'ErrorMessage' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'The connection does not exist.', + ], + 'RequestId' => [ + 'description' => '请求ID。用于出现错误后排查问题。', + '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":"<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' => '更新文件夹的信息', + 'summary' => '调用UpdateFolder更新文件夹的信息。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'ListDeployments' => [ + 'summary' => '查询发布包列表信息。该功能与DataWorks控制台任务发布页面的发布包列表功能对应。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'abilityTreeCode' => '100712', + 'abilityTreeNodes' => [ + 'FEATUREdide8FM783', + ], + ], + 'parameters' => [ + [ + 'name' => 'ProjectIdentifier', + 'in' => 'formData', + 'schema' => [ + 'description' => 'DataWorks工作空间的名称。您可以登录[DataWorks控制台](https://workbench.data.aliyun.com/console)，进入工作空间配置页面获取工作空间名称。'."\n" + ."\n" + .'该参数与ProjectId参数，二者必须设置其一，用来确定本次API调用操作的DataWorks工作空间。', + 'type' => 'string', + 'required' => false, + 'example' => 'dw_project', + ], + ], + [ + 'name' => 'ProjectId', + 'in' => 'formData', + 'schema' => [ + 'description' => 'DataWorks工作空间的ID。您可以登录[DataWorks控制台](https://workbench.data.aliyun.com/console)，进入工作空间配置页面获取工作空间ID。'."\n" + ."\n" + .'该参数与ProjectIdentifier参数，二者必须设置其一，用来确定本次API调用操作的DataWorks工作空间。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '10000', + ], + ], + [ + 'name' => 'Creator', + 'in' => 'formData', + 'schema' => [ + 'description' => '发布包创建者的阿里云用户ID。', + 'type' => 'string', + 'required' => false, + 'example' => '20030****', + ], + ], + [ + 'name' => 'EndCreateTime', + 'in' => 'formData', + 'schema' => [ + 'description' => '生成发布包的最大毫秒时间戳。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1593877765000', + ], + ], + [ + 'name' => 'Executor', + 'in' => 'formData', + 'schema' => [ + 'description' => '发布包执行者的阿里云用户ID。', + 'type' => 'string', + 'required' => false, + 'example' => '2003****', + ], + ], + [ + 'name' => 'EndExecuteTime', + 'in' => 'formData', + 'schema' => [ + 'description' => '发布包开始执行的最大毫秒时间戳。'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1593877765000', + ], + ], + [ + 'name' => 'Status', + 'in' => 'formData', + 'schema' => [ + 'description' => '发布包当前的状态。取值如下：'."\n" + .'- 0：发布包已准备就绪。'."\n" + .'- 1：发布包发布成功。'."\n" + .'- 2：发布包发布失败。'."\n" + .'- 6：发布包被驳回。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'Keyword', + 'in' => 'formData', + 'schema' => [ + 'description' => '发布包名称的关键字。DataWorks支持模糊匹配，即输入关键字，即可查询包含该关键字的发布包。', + 'type' => 'string', + 'required' => false, + 'example' => 'hello', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'formData', + 'schema' => [ + 'description' => '请求的数据页数，用于翻页。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'formData', + 'schema' => [ + 'description' => '每页显示的条数，默认为10条，最大为100条。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '100', + 'example' => '20', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。用于出现错误后排查问题。', + 'type' => 'string', + 'example' => '0000-ABCD-EFG', + ], + 'Data' => [ + 'description' => '满足查询条件的发布包列表数据。', + 'type' => 'object', + 'properties' => [ + 'PageNumber' => [ + 'description' => '请求的数据页数，用于翻页。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '每页显示的数据条数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10', + ], + 'TotalCount' => [ + 'description' => '满足条件的数据总条数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '13', + ], + 'Deployments' => [ + 'description' => '返回的发布包列表。', + 'type' => 'array', + 'items' => [ + 'description' => '发布包的详细信息。', + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => '发布包当前的状态。取值如下：'."\n" + .'- 0：发布包已准备就绪。'."\n" + .'- 1：发布包发布成功。'."\n" + .'- 2：发布包发布失败。'."\n" + .'- 6：发布包被驳回。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'ErrorMessage' => [ + 'description' => '当发布包执行失败，该参数用于记录错误信息。', + 'type' => 'string', + 'example' => 'OK', + ], + 'CreateTime' => [ + 'description' => '发布包创建的时间戳。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1593877765000', + ], + 'Executor' => [ + 'description' => '发布包执行者的阿里云用户ID。', + 'type' => 'string', + 'example' => '2003****', + ], + 'Creator' => [ + 'description' => '发布包创建者的阿里云用户ID。', + 'type' => 'string', + 'example' => '2003****', + ], + 'ExecuteTime' => [ + 'description' => '执行发布包的时间戳。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1593877765000', + ], + 'Name' => [ + 'description' => '发布包的名称。', + 'type' => 'string', + 'example' => 'auto_created', + ], + 'Id' => [ + 'description' => '发布包的ID，您可以根据此ID调用[GetDeployment](~~173950~~)接口，获取发布包详情。', + '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' => '查询发布包列表信息', + ], + 'UpdateIDEEventResult' => [ + 'summary' => '用于在数据开发过程中触发扩展点时，通过将扩展程序对扩展点事件的检查结果返回给数据开发系统。', + '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' => 'DataWorks开放消息的消息ID。当触发扩展点事件后，您可以从接收到的事件消息中获取消息ID。'."\n" + ."\n" + .'<props="china">消息格式，可参考[消息格式](~~215367~~)。</props>'."\n" + ."\n", + 'type' => 'string', + 'required' => false, + 'example' => '8abcb91f-d266-4073-b907-2ed670378ed1', + ], + ], + [ + 'name' => 'ExtensionCode', + 'in' => 'formData', + 'schema' => [ + 'description' => '扩展程序的唯一标识。您可以登录[DataWorks控制台](https://workbench.data.aliyun.com/console)，进入开放平台的Extensions页签查看标识。', + 'type' => 'string', + 'required' => false, + 'example' => '8abcb91f-d266-4073-b907-2ed670378ed1', + ], + ], + [ + 'name' => 'CheckResult', + 'in' => 'formData', + 'schema' => [ + 'description' => '扩展程序对本次扩展点事件的检查状态。取值如下：'."\n" + .'- OK：扩展程序对本次扩展点事件检查通过。'."\n" + .'- FAIL：扩展程序对本次扩展点事件检查不通过。您需要查看并及时处理报错，以免影响后续程序的正常执行。'."\n" + .'- WARN：扩展程序对本次扩展点事件检查通过，但存在警告。', + 'type' => 'string', + 'required' => false, + 'example' => 'OK', + ], + ], + [ + 'name' => 'CheckResultTip', + 'in' => 'formData', + 'schema' => [ + 'description' => '扩展程序对本次扩展点事件进行检查的摘要信息。该信息会显示在您当前的开发页面上，当本次检查存在警告或者检查不通过时，您可以通过该摘要信息快速定位原因。', + 'type' => 'string', + 'required' => false, + 'example' => 'Succeeded', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求的唯一标识，用于后续错误排查使用。', + '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' => '更新扩展点事件的检查结果', + 'description' => "\n", + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'GetIDEEventDetail' => [ + 'summary' => '根据DataWorks开放消息的消息ID，查询触发扩展点事件时的扩展点数据快照。', + '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' => 'DataWorks开放消息的消息ID。当触发扩展点事件后，您可以从接收到的事件消息中获取消息ID。'."\n" + ."\n" + .'<props="china">消息格式，可参考[消息格式](~~215367~~)。</props>'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '8abcb91f-d266-4073-b907-2ed67****1', + ], + ], + [ + 'name' => 'ProjectId', + 'in' => 'formData', + 'schema' => [ + 'description' => 'DataWorks工作空间的ID，您可以通过解析DataWorks开放消息获取空间ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '10000', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求的唯一标识，用于后续错误排查使用。', + 'type' => 'string', + 'example' => '8abcb91f-d266-4073-b907-2ed670378ed1', + ], + 'EventDetail' => [ + 'description' => '触发扩展点事件时的数据快照。'."\n" + ."\n" + .'不同类型的消息事件，数据快照的有效字段存在差异，具体请参考各消息事件的字段说明。', + 'type' => 'object', + 'properties' => [ + 'FileExecutionCommand' => [ + 'description' => '文件代码执行时的快照，当Message类型为IDE_FILE_EXECUTE_BEFORE时有效。', + 'type' => 'object', + 'properties' => [ + 'FileId' => [ + 'description' => '文件的ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1234123', + ], + 'DataSourceName' => [ + 'description' => '文件关联的数据源唯一标识。', + 'type' => 'string', + 'example' => 'odps_source', + ], + 'Content' => [ + 'description' => '生成本次文件版本的文件代码。', + 'type' => 'string', + 'example' => 'SHOW TABLES;', + ], + 'FileType' => [ + 'description' => '文件类型。不同文件类型其代码不同，详情请参见[DataWorks节点合集](~~600169~~)。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10', + ], + ], + ], + 'DeletedFile' => [ + 'description' => '删除文件时的快照信息，当Message类型为IDE_FILE_DELETE_BEFORE时有效。', + 'type' => 'object', + 'properties' => [ + 'Owner' => [ + 'description' => '文件责任人。', + 'type' => 'string', + 'example' => '7384234****', + ], + 'FileType' => [ + 'description' => '文件类型。不同文件类型其代码不同，详情请参见[DataWorks节点合集](~~600169~~)。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10', + ], + 'CurrentVersion' => [ + 'description' => '当前文件的最新版本。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'BusinessId' => [ + 'description' => '文件所属的业务流程ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '74328', + ], + 'FileName' => [ + 'description' => '文件名称。', + 'type' => 'string', + 'example' => 'hello_dataworks.sql', + ], + 'DataSourceName' => [ + 'description' => '文件关联的数据源唯一标识。', + 'type' => 'string', + 'example' => 'odps_source', + ], + 'UseType' => [ + 'description' => '文件所属的功能模块。取值如下：'."\n" + .'- NORMAL：数据开发'."\n" + .'- MANUAL：手动任务'."\n" + .'- MANUAL_BIZ：手动业务流程'."\n" + .'- SKIP：数据开发的空跑调度'."\n" + .'- ADHOCQUERY：临时查询'."\n" + .'- COMPONENT：组件管理', + 'type' => 'string', + 'example' => 'NORMAL', + ], + 'FolderId' => [ + 'description' => '文件所属的文件夹ID，您可以调用[GetFolder](~~173952~~)接口，通过文件夹ID查询文件详情。', + 'type' => 'string', + 'example' => 'aldurie78l2falure', + ], + 'ParentFileId' => [ + 'description' => '文件所属的循环节点或遍历节点的节点ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1234122', + ], + 'Content' => [ + 'description' => '生成本次文件版本的文件代码。', + 'type' => 'string', + 'example' => 'SHOW TABLES;', + ], + 'NodeId' => [ + 'description' => '调度节点的ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '421429', + ], + 'FileId' => [ + 'description' => '文件的ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1234123', + ], + ], + ], + 'CommittedFile' => [ + 'description' => '文件提交和发布时的快照。'."\n" + ."\n" + .'仅当Message类型为IDE_FILE_SUBMIT_BEFORE或IDE_FILE_DEPLOY_BEFORE时有效。', + 'type' => 'object', + 'properties' => [ + 'FileId' => [ + 'description' => '文件的ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1234123', + ], + 'Content' => [ + 'description' => '生成本次文件版本的文件代码。', + 'type' => 'string', + 'example' => 'SHOW TABLES;', + ], + 'Committor' => [ + 'description' => '生成本次文件版本的阿里云用户ID。', + 'type' => 'string', + 'example' => '7384234****', + ], + 'FileType' => [ + 'description' => '文件类型。不同文件类型其代码不同，详情请参见[DataWorks节点合集](~~600169~~)。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10', + ], + 'ChangeType' => [ + 'description' => '本次文件版本的变更类型，包括CREATE、UPDATE和DELETE。', + 'type' => 'string', + 'example' => 'UPDATE', + ], + 'FileName' => [ + 'description' => '文件名称。', + 'type' => 'string', + 'example' => 'hello_dataworks.sql', + ], + 'NodeId' => [ + 'description' => '调度节点的ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '421429', + ], + 'Comment' => [ + 'description' => '本次文件版本的说明。', + 'type' => 'string', + 'example' => 'Second version submission', + ], + 'UseType' => [ + 'description' => '文件所属的功能模块。取值如下：'."\n" + .'- NORMAL：数据开发'."\n" + .'- MANUAL：手动任务'."\n" + .'- MANUAL_BIZ：手动业务流程'."\n" + .'- SKIP：数据开发的空跑调度'."\n" + .'- ADHOCQUERY：临时查询'."\n" + .'- COMPONENT：组件管理', + 'type' => 'string', + 'example' => 'NORMAL', + ], + 'FilePropertyContent' => [ + 'description' => '文件的更多属性。', + 'type' => 'object', + 'properties' => [ + 'DataSourceName' => [ + 'description' => '文件关联的数据源唯一标识。', + 'type' => 'string', + 'example' => 'odps_source', + ], + 'ParentFileId' => [ + 'description' => '文件所属的循环节点或遍历节点的节点ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1234122', + ], + 'BusinessId' => [ + 'description' => '文件所属的业务流程ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '74328', + ], + 'CurrentVersion' => [ + 'description' => '当前文件的最新版本。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'Owner' => [ + 'description' => '文件责任人。', + 'type' => 'string', + 'example' => '7384234****', + ], + 'FolderId' => [ + 'description' => '文件所属的文件夹ID，您可以调用[GetFolder](~~173952~~)接口，通过文件夹ID查询文件详情。', + 'type' => 'string', + 'example' => 'aldurie78l2falure', + ], + ], + ], + 'NodeConfiguration' => [ + 'description' => '文件的调度属性配置。', + 'type' => 'object', + 'properties' => [ + 'RerunMode' => [ + 'description' => '重跑属性。取值如下：'."\n" + .'- ALL_ALLOWED：运行成功或失败后皆可重跑。'."\n" + .'- FAILURE_ALLOWED：运行成功后不可重跑，运行失败后可以重跑。'."\n" + .'- ALL_DENIED：运行成功或失败皆不可重跑。'."\n" + ."\n" + .'该参数与[DataWorks控制台](https://workbench.data.aliyun.com/console)中，数据开发任务的“调度配置>时间属性>重跑属性”配置内容对应。', + 'type' => 'string', + 'example' => 'ALL_ALLOWED', + ], + 'SchedulerType' => [ + 'description' => '调度的类型，取值如下：'."\n" + .'- NORMAL：正常调度任务。'."\n" + .'- MANUAL：手动任务，不会被日常调度，对应手动业务流程下的节点。'."\n" + .'- PAUSE：暂停任务。'."\n" + .'- SKIP：空跑任务，被日常调度，但启动调度时直接被置为成功。', + 'type' => 'string', + 'example' => 'NORMAL', + ], + 'ParaValue' => [ + 'description' => '调度参数。'."\n" + ."\n" + .'该参数与[DataWorks控制台](https://workbench.data.aliyun.com/console)中，数据开发任务的“调度配置>参数”对应。您可以参考[调度参数](~~137548~~)配置。', + 'type' => 'string', + 'example' => 'a=x b=y', + ], + 'CycleType' => [ + 'description' => '调度周期的类型，包括NOT_DAY（分钟、小时）和DAY（日、周、月）。'."\n" + ."\n" + .'该参数与[DataWorks控制台](https://workbench.data.aliyun.com/console)中，数据开发任务的“调度配置>时间属性>调度周期”对应。', + 'type' => 'string', + 'example' => 'DAY', + ], + 'DependentNodeIdList' => [ + 'description' => '当DependentType参数配置为USER_DEFINE时，用于设置当前文件具体依赖的节点ID。依赖多个节点时，使用英文逗号（,）分隔。'."\n" + ."\n" + .'该参数与[DataWorks控制台](https://workbench.data.aliyun.com/console)中，数据开发任务的“调度配置>调度依赖>跨周期依赖（原上一周期）”，依赖项选择”其他节点“时配置的内容对应。', + 'type' => 'string', + 'example' => '5,10,15,20', + ], + 'ResourceGroupId' => [ + 'description' => '文件发布成任务后，任务执行时使用的资源组。您可以调用[ListResourceGroups](~~173913~~)获取工作空间可用的资源组列表。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '375827434852437', + ], + 'AutoRerunTimes' => [ + 'description' => '自动重跑次数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '3', + ], + 'AutoRerunIntervalMillis' => [ + 'description' => '自动重跑间隔毫秒数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '120000', + ], + 'CronExpress' => [ + 'description' => '调度Cron表达式。', + 'type' => 'string', + 'example' => '00 05 00 * * ?', + ], + 'InputList' => [ + 'description' => '文件依赖的上游文件输出。', + 'type' => 'array', + 'items' => [ + 'description' => '依赖的上游文件输出信息。', + 'type' => 'object', + 'properties' => [ + 'Input' => [ + 'description' => '文件依赖的上游文件的输出名称。'."\n" + ."\n" + .'该参数与[DataWorks控制台](https://workbench.data.aliyun.com/console)中，数据开发任务的“调度配置>调度依赖>依赖上游节点“的”上游节点输出名”对应。', + 'type' => 'string', + 'example' => 'dw_project_root', + ], + 'ParseType' => [ + 'description' => '配置文件依赖的方式，取值如下：'."\n" + .'- MANUAL：手动配置。'."\n" + .'- AUTO：自动解析。', + 'type' => 'string', + 'example' => 'MANUAL', + ], + ], + ], + ], + 'OutputList' => [ + 'description' => '文件的输出。'."\n" + ."\n" + .'该参数与[DataWorks控制台](https://workbench.data.aliyun.com/console)中，数据开发任务的“调度配置>调度依赖>本节点输出名称“对应。', + 'type' => 'array', + 'items' => [ + 'description' => '文件的输出信息。', + 'type' => 'object', + 'properties' => [ + 'RefTableName' => [ + 'description' => '文件的输出表名。'."\n" + ."\n" + .'该参数与[DataWorks控制台](https://workbench.data.aliyun.com/console)中，数据开发任务的“调度配置>调度依赖>本节点输出名称“的“输出表名”对应。', + 'type' => 'string', + 'example' => 'ods_user_info_d', + ], + 'Output' => [ + 'description' => '文件的输出名称。'."\n" + ."\n" + .'该参数与[DataWorks控制台](https://workbench.data.aliyun.com/console)中，数据开发任务的“调度配置>调度依赖>本节点输出名称“的“输出名”对应。', + 'type' => 'string', + 'example' => 'dw_project.002_out', + ], + ], + ], + ], + 'DependentType' => [ + 'description' => '依赖上一周期的方式。取值如下：'."\n" + .'- SELF：依赖项选择本节点。'."\n" + .'- CHILD：依赖项选择一级子节点。'."\n" + .'- USER_DEFINE：依赖项选择其他节点。'."\n" + .'- NONE：未选择依赖项，即不会依赖上一周期。'."\n", + 'type' => 'string', + 'example' => 'USER_DEFINE', + ], + ], + ], + ], + ], + 'TableModel' => [ + 'description' => '表提交和发布时的快照，当Message类型为IDE_TABLE_SUBMIT_BEFORE和IDE_TABLE_DEPLOY_BEFORE时有效。', + 'type' => 'object', + 'properties' => [ + 'Env' => [ + 'description' => '表所属环境。取值如下：'."\n" + .'- DEV：开发环境。'."\n" + .'- PROD：生产环境。', + 'type' => 'string', + 'example' => 'DEV', + ], + 'LifeCycle' => [ + 'description' => '表的生命周期。单位为天。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '7', + ], + 'TableName' => [ + 'description' => '表名称。', + 'type' => 'string', + 'example' => 'tb_hello', + ], + 'DataSourceName' => [ + 'description' => '表所属数据源的唯一标识。', + 'type' => 'string', + 'example' => 'odps_source', + ], + 'Columns' => [ + 'description' => '字段列表。', + 'type' => 'array', + 'items' => [ + 'description' => '字段信息。', + 'type' => 'object', + 'properties' => [ + 'ColumnName' => [ + 'description' => '字段名称。', + 'type' => 'string', + 'example' => 'ID', + ], + 'ColumnType' => [ + 'description' => '字段类型。', + 'type' => 'string', + 'example' => 'BIGINT', + ], + 'IsPartitionColumn' => [ + 'description' => '是否为分区字段，取值如下：'."\n" + .'- true：是分区字段。'."\n" + .'- false：非分区字段。', + 'type' => 'boolean', + 'example' => 'false', + ], + 'Comment' => [ + 'description' => '字段备注。', + 'type' => 'string', + 'example' => 'ID', + ], + ], + ], + ], + 'Comment' => [ + 'description' => '表的备注信息。', + 'type' => 'string', + 'example' => 'A new table', + ], + 'Location' => [ + 'description' => '外部表的Location信息。', + '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' => '查询触发扩展点事件时的数据快照', + 'description' => "\n", + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'CreateResourceFile' => [ + 'summary' => '调用CreateResourceFile接口，在数据开发中创建或上传一个资源文件，此API功能与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' => 'DataWorks工作空间的ID。您可以登录DataWorks控制台，进入工作空间配置页面获取工作空间ID。需要用该参数来确定本次API调用操作的DataWorks工作空间。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + 'minimum' => '0', + 'example' => '10111', + ], + ], + [ + 'name' => 'FileFolderPath', + 'in' => 'formData', + 'schema' => [ + 'description' => '文件的路径。'."\n" + ."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'Business_process/First_Business_Process/MaxCompute/Folder_1/Folder_2', + ], + ], + [ + 'name' => 'FileName', + 'in' => 'formData', + 'schema' => [ + 'description' => '文件的名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'File name', + ], + ], + [ + 'name' => 'FileType', + 'in' => 'formData', + 'schema' => [ + 'description' => '文件的代码类型。'."\n" + ."\n" + .'不同文件类型其代码不同，详情请参见[DataWorks节点合集](~~600169~~)。'."\n" + .'您也可以调用[ListFileType](~~212428~~)接口，查询文件的代码类型。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'docRequired' => true, + 'minimum' => '0', + 'example' => '10', + ], + ], + [ + 'name' => 'FileDescription', + 'in' => 'formData', + 'schema' => [ + 'description' => '文件的描述信息。', + 'type' => 'string', + 'required' => false, + 'example' => 'This is a description', + ], + ], + [ + 'name' => 'Owner', + 'in' => 'formData', + 'schema' => [ + 'description' => '文件责任人的阿里云用户ID。如果该参数为空，则默认使用调用者的阿里云用户ID。', + 'type' => 'string', + 'required' => false, + 'example' => '1000000000001', + ], + ], + [ + 'name' => 'Content', + 'in' => 'formData', + 'schema' => [ + 'description' => '文件代码内容，不同代码类型（fileType）的文件，代码格式不同。您可以在运维中心找到对应类型的任务，右键单击查看代码，查看具体的代码格式。', + 'type' => 'string', + 'required' => false, + 'example' => 'SHOW TABLES;', + ], + ], + [ + 'name' => 'ResourceFile', + 'in' => 'formData', + 'schema' => [ + 'description' => 'POP提供的文件上传OSS URL。', + 'type' => 'string', + 'required' => false, + 'example' => 'http://bucketname1.oss-cn-shanghai.aliyuncs.com/example', + 'isFileTransferUrl' => true, + ], + ], + [ + 'name' => 'OriginResourceName', + 'in' => 'formData', + 'schema' => [ + 'description' => '原始资源文件的名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'origin_file_name.sql', + ], + ], + [ + 'name' => 'UploadMode', + 'in' => 'formData', + 'schema' => [ + 'description' => '文件资源上传模式。目前仅对MaxCompute的File类型文件生效，取值如下：'."\n" + ."\n" + .'- true：可下载的资源模式。'."\n" + ."\n" + .'- false：在线编辑的文本模式。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + [ + 'name' => 'RegisterToCalcEngine', + 'in' => 'formData', + 'schema' => [ + 'description' => '是否将资源同步上传到计算引擎。', + 'type' => 'boolean', + 'required' => true, + 'example' => 'false', + ], + ], + [ + 'name' => 'StorageURL', + 'in' => 'formData', + 'schema' => [ + 'description' => '资源文件在计算引擎上的存储路径，目前只有EMR和CDH用到该字段。EMR格式为[oss|hdfs]://path/to/object，CDH默认需要填写为/user/admin/lib。', + 'type' => 'string', + 'required' => false, + 'example' => 'oss://oss-cn-shanghai.aliyuncs.com/emr-test', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '返回数据。', + 'type' => 'object', + 'properties' => [ + 'Data' => [ + 'description' => '文件创建成功后的ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1000001', + ], + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '本次调用的唯一ID。出现错误后，您可以根据该ID排查问题。', + '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' => '创建资源文件', + ], + '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' => 'DataWorks工作空间的ID。您可以登录[DataWorks控制台](https://workbench.data.aliyun.com/console)，进入工作空间配置页面获取工作空间ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + 'maximum' => '10000000000', + 'minimum' => '1', + 'example' => '10000', + ], + ], + [ + 'name' => 'TaskType', + 'in' => 'query', + 'schema' => [ + 'description' => '创建的数据集成同步任务的任务类型。'."\n" + .'目前支持使用CreateDISyncTask接口创建数据集成离线同步任务（DI_OFFLINE），实时同步任务（DI_REALTIME）和解决方案（DI_SOLUTION）。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'DI_OFFLINE', + ], + ], + [ + 'name' => 'TaskContent', + 'in' => 'formData', + 'schema' => [ + 'description' => '数据集成同步任务的脚本内容。', + '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_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' => '数据集成同步任务的配置参数。目前支持配置如下参数：'."\n" + .'- FileFolderPath：表示数据集成同步任务的存放路径。'."\n" + .'- ResourceGroup：表示数据集成同步任务所使用的数据集成资源组标识（Identifier）。您可以调用[ListResourceGroups](~~173913~~)，获取资源组标识。'."\n" + .'- Cu：表示数据集成同步任务在Serverless资源组上占用的规格，必须是0.5的倍数。', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => '{"FileFolderPath":"业务流程/XXX/数据集成","ResourceGroup":"Serverless_res_group_XXX_XXXX", "Cu":1.5}', + ], + ], + [ + 'name' => 'TaskName', + 'in' => 'query', + 'schema' => [ + 'description' => '创建的数据集成同步任务的名称。', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => 'new_di_task', + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'description' => '幂等参数，该参数可为空。', + 'type' => 'string', + 'required' => false, + 'example' => '0000-ABCD-EFG****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Success' => [ + 'description' => '请求是否成功。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'RequestId' => [ + 'description' => '请求ID。用于定位日志，排查问题。', + 'type' => 'string', + 'example' => '0bc1411515937635973****', + ], + 'Data' => [ + 'description' => '创建数据集成同步任务的返回结果。', + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => '创建数据集成同步任务的结果状态。取值如下：'."\n" + .'- success：表示创建任务成功。'."\n" + .'- fail：表示创建任务失败。', + 'type' => 'string', + 'example' => 'success', + ], + 'Message' => [ + 'description' => '创建数据集成同步任务失败的原因描述，如果成功，该字段为空，如果不成功，实例如下"不合法的目录路径：业务流程/xxxx/数据集成"，'."\n", + 'type' => 'string', + 'example' => '不合法的目录路径：业务流程/xxxx/数据集成', + ], + 'FileId' => [ + 'description' => '成功创建的数据集成同步任务的任务ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1000001', + ], + ], + ], + ], + ], + ], + ], + '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' => '创建数据集成同步任务', + 'summary' => '调用CreateDISyncTask创建数据集成同步任务。', + 'description' => 'CreateDISyncTask接口无法指定调度属性，若想配置调度属性，可使用[UpdataFile](~~2780137~~)接口。', + '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' => 'DataWorks工作空间的ID。您可以登录[DataWorks控制台](https://workbench.data.aliyun.com/console)，进入工作空间配置页面获取工作空间ID。'."\n" + ."\n" + .'该参数用于确定本次API调用操作使用的DataWorks工作空间。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + 'maximum' => '10000000000', + 'minimum' => '1', + 'example' => '10000', + ], + ], + [ + 'name' => 'TaskType', + 'in' => 'query', + 'schema' => [ + 'description' => '数据集成同步任务的类型。'."\n" + .'当前仅支持取值为DI_REALTIME，表示实时数据同步任务。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'DI_REALTIME', + ], + ], + [ + 'name' => 'FileId', + 'in' => 'query', + 'schema' => [ + 'description' => '实时数据同步任务的ID。您可以调用[ListFiles](~~173942~~)接口获取任务ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + 'maximum' => '9999999999999999', + 'minimum' => '1', + 'example' => '100', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'Success' => [ + 'description' => '请求是否成功。取值如下：'."\n" + .'- true：请求成功。'."\n" + .'- false：请求失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'RequestId' => [ + 'description' => '请求ID。用于定位日志，排查问题。', + 'type' => 'string', + 'example' => '0bc1411515937635973****', + ], + 'Data' => [ + 'description' => '删除数据集成同步任务的结果。', + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => '删除数据集成同步任务的结果状态。取值如下：'."\n" + .'- success：表示删除数据集成同步任务成功。'."\n" + .'- fail：表示删除数据集成同步任务失败。您可以查看具体的失败原因处理问题。', + 'type' => 'string', + 'example' => 'fail', + ], + 'Message' => [ + 'description' => '删除数据集成同步任务失败后的原因描述。'."\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' => '删除数据集成同步任务', + 'summary' => '调用DeleteDISyncTask接口，删除数据集成同步任务。当前仅支持使用该接口删除实时数据同步任务。', + 'description' => '如果您希望删除离线数据同步任务，请使用DeleteFile接口，具体操作流程请参考[删除同步任务](~~321443~~)。', + ], + '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' => 'DataWorks工作空间的ID。您可以登录[DataWorks控制台](https://workbench.data.aliyun.com/console)，进入工作空间配置页面获取工作空间ID。'."\n" + .'该参数用来确定本次API调用操作使用的DataWorks工作空间。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + 'maximum' => '10000000000', + 'minimum' => '1', + 'example' => '10000', + ], + ], + [ + 'name' => 'TaskType', + 'in' => 'query', + 'schema' => [ + 'description' => '修改的数据集成同步任务的任务类型。'."\n" + .'目前仅支持使用UpdateDISyncTask接口修改数据集成离线同步任务（DI_OFFLINE）。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'DI_OFFLINE', + ], + ], + [ + 'name' => 'TaskContent', + 'in' => 'query', + 'schema' => [ + 'description' => '更新已创建的数据集成同步任务通过脚本模式配置的任务内容。详情请参见[通过脚本模式配置任务](~~137717~~)。当前仅支持通过UpdateDISyncTask接口更新数据集成离线同步任务。如果您无需更新数据集成同步任务的配置内容，则可将该参数置为空。'."\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_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' => '更新数据集成同步任务的配置参数，使用JSON格式。'."\n" + ."\n" + .'- ResourceGroup：表示数据集成同步任务所使用的数据集成资源组标识（Identifier）。您可以调用[ListResourceGroups](~~173913~~)，获取资源组标识。'."\n" + .'- Cu：表示数据集成同步任务在Serverless资源组上占用的规格，必须是0.5的倍数。', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => '{"ResourceGroup":"Serverless_res_group_XXX_XXXX", "Cu":1.5}', + ], + ], + [ + 'name' => 'FileId', + 'in' => 'query', + 'schema' => [ + 'description' => '需要更新的数据集成同步任务的任务ID。您可以调用[ListFiles](~~173942~~)接口获取同步任务的ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + 'maximum' => '9223372036854775807', + 'minimum' => '1', + 'example' => '1000000', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回数据。', + 'type' => 'object', + 'properties' => [ + 'Success' => [ + 'description' => '请求是否成功。取值如下：'."\n" + .'- true：成功。'."\n" + .'- false：失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'RequestId' => [ + 'description' => '请求ID。用于定位日志，排查问题。', + 'type' => 'string', + 'example' => '0bc1411515937635973****', + ], + 'Data' => [ + 'description' => '更新数据集成同步任务的返回结果。', + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => '更新数据集成同步任务的结果状态。取值如下：'."\n" + .'- success：表示更新数据集成同步任务成功。'."\n" + .'- fail：表示更新数据集成同步任务失败。', + 'type' => 'string', + 'example' => 'success', + ], + 'Message' => [ + 'description' => '更新数据集成同步任务失败后的原因描述。如果更新数据集成同步任务成功，则该参数的返回值为空。', + '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' => '更新同步任务', + 'summary' => '更新数据集成同步任务。', + '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' => '目标数据源所在的DataWorks工作空间ID。您可以调用[ListProjects](~~178393~~)接口获取工作空间ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + 'maximum' => '10000000000', + 'minimum' => '1', + 'example' => '100001', + ], + ], + [ + 'name' => 'DatasourceName', + 'in' => 'query', + 'schema' => [ + 'description' => '目标数据源的名称。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'mysql_name', + ], + ], + [ + 'name' => 'EnvType', + 'in' => 'query', + 'schema' => [ + 'description' => '目标数据源所属的环境。取值如下：'."\n" + .'- 0：开发环境。'."\n" + .'- 1：生产环境。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '1', + ], + ], + [ + 'name' => 'ResourceGroup', + 'in' => 'query', + 'schema' => [ + 'description' => '目标数据源所使用的资源组的标识（Identifier）。您可以调用[ListResourceGroups](~~173913~~)接口获取资源组的标识（Identifier）。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'S_res_group_2XXXX4_1619100XXXXX', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Success' => [ + 'description' => '请求是否成功。取值如下：'."\n" + .'- true：成功。'."\n" + .'- false：失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'RequestId' => [ + 'description' => '本次调用的唯一ID。用于出现错误后定位日志，排查问题。', + 'type' => 'string', + 'example' => '0000-ABCD-EFG ', + ], + 'TaskList' => [ + 'description' => '测试数据源与资源组网络连通性的返回结果。', + 'type' => 'object', + 'properties' => [ + 'ConnectMessage' => [ + 'description' => '测试目标数据源与其所使用资源组的网络连通性失败后的原因描述。如果数据源与资源组网络连通性测试成功，则该参数的返回值为空。', + 'type' => 'string', + 'example' => 'Connectable', + ], + 'ConnectStatus' => [ + 'description' => '测试目标数据源与其所使用资源组网络连通性的结果状态。取值如下：'."\n" + .'- true：表示目标数据源与其所使用资源组的网络连通成功。'."\n" + .'- false：表示目标数据源与其所使用资源组的网络连通失败。您可以查看ConnectMessage参数定位失败原因。', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + ], + ], + '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' => '测试数据源网络连通性', + 'summary' => '测试目标数据源与所使用资源组的网络连通性。', + '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' => 'DataWorks工作空间的ID。您可以登录[DataWorks控制台](https://workbench.data.aliyun.com/console)，进入工作空间配置页面获取工作空间ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + 'maximum' => '10000000000', + 'minimum' => '1', + 'example' => '10000', + ], + ], + [ + 'name' => 'DatasourceName', + 'in' => 'query', + 'schema' => [ + 'description' => '目标数据源的名称。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'mysql_name', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '请求的数据页数，用于翻页。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'docRequired' => true, + 'maximum' => '100', + 'minimum' => '1', + 'example' => '1', + 'default' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '每页显示的数据条数。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'docRequired' => true, + 'maximum' => '10000', + 'minimum' => '1', + 'example' => '10', + 'default' => '10', + ], + ], + [ + 'name' => 'EnvType', + 'in' => 'query', + 'schema' => [ + 'description' => '目标数据源所属的环境。取值如下：'."\n" + .'- 0：开发环境。'."\n" + .'- 1：生产环境。', + 'type' => 'string', + 'required' => false, + 'example' => '1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回数据。', + 'type' => 'object', + 'properties' => [ + 'Success' => [ + 'description' => '请求是否成功。取值如下：'."\n" + .'- true：成功。'."\n" + .'- false：失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'RequestId' => [ + 'description' => '本次调用的唯一ID。用于出现错误后定位日志，排查问题。'."\n" + ."\n", + 'type' => 'string', + 'example' => '0000-ABCD-EFG ', + ], + 'Data' => [ + 'description' => '获取目标数据源Meta信息的返回的结果。', + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => '获取目标数据源Meta信息的结果状态。取值如下：'."\n" + .'- success：表示获取目标数据源的Meta信息成功。'."\n" + .'- fail：表示获取目标数据源的Meta信息失败。您可以查看Message参数定位失败原因。', + 'type' => 'string', + 'example' => 'success', + ], + 'Message' => [ + 'description' => '获取目标数据源Meta信息失败后的原因描述。如果获取目标数据源的Meta信息成功，则该参数的返回值为空。', + 'type' => 'string', + 'example' => 'read datasource time out', + ], + 'Meta' => [ + 'description' => '返回的目标数据源的Meta信息。返回的信息为JSON格式。'."\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" + .'参数描述如下：'."\n" + .'- dbName：数据源所在的数据库名称。'."\n" + .'- schema：数据库所属的模式。'."\n" + .'- enable：数据库是否可用，包含true（表示数据库可用），false（表示数据库不可用）取值。'."\n" + .'- tableName：数据库包含的表名称。'."\n" + .'- tableInfos：数据库中表的信息。', + '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' => '获取目标数据源的Meta信息', + 'summary' => '调用GetDataSourceMeta获取目标数据源的Meta信息。', + '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' => 'DataWorks工作空间的ID。您可以登录[DataWorks控制台](https://workbench.data.aliyun.com/console)，进入工作空间配置页面获取工作空间ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + 'maximum' => '10000000000', + 'minimum' => '1', + 'example' => '1000', + ], + ], + [ + 'name' => 'DestinationType', + 'in' => 'query', + 'schema' => [ + 'description' => '数据集成同步解决方案任务的目的端数据源。该参数不能为空。'."\n" + .'调用ListDIProjectConfig查看同步解决方案的全局配置目前仅支持配置目的端数据源为analyticdb_for_mysql、odps、elasticsearch、holo、mysql及polardb。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'elasticsearch', + ], + ], + [ + 'name' => 'SourceType', + 'in' => 'query', + 'schema' => [ + 'description' => '数据集成同步解决方案任务的源端数据源。'."\n" + .'调用ListDIProjectConfig查看同步解决方案的全局配置目前仅支持配置源端数据源为oracle、mysql、polardb、datahub、drds及analyticdb_for_mysql。'."\n" + .'如果不配置源端数据源，则默认全局配置对所有的源端数据源均生效。', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => 'mysql', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Success' => [ + 'description' => '请求是否成功。取值如下：'."\n" + .'- true：成功。'."\n" + .'- false：失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'RequestId' => [ + 'description' => '本次调用的唯一ID。用于出现错误后定位日志，排查问题。'."\n" + ."\n", + 'type' => 'string', + 'example' => '0000-ABCD-EFG ', + ], + 'Data' => [ + 'description' => '查看目标工作空间中数据集成同步解决方案任务默认全局配置的返回结果。', + 'type' => 'object', + 'properties' => [ + 'Config' => [ + 'description' => '数据集成同步解决方案任务默认的全局配置内容（即对不同DDL消息类型配置的默认处理策略）。示例如下：'."\n" + .'{"RENAMECOLUMN":"WARNING","DROPTABLE":"WARNING","CREATETABLE":"WARNING","MODIFYCOLUMN":"WARNING","TRUNCATETABLE":"WARNING","DROPCOLUMN":"WARNING","ADDCOLUMN":"WARNING","RENAMETABLE":"WARNING"}'."\n" + ."\n" + .'DDL消息类型如下：'."\n" + .'- RENAMECOLUMN：重命名列。'."\n" + .'- DROPTABLE：删除表。'."\n" + .'- CREATETABLE：新建表。'."\n" + .'- MODIFYCOLUMN：修改列类型。'."\n" + .'- TRUNCATETABLE：清空表。'."\n" + .'- DROPCOLUMN：删除列。'."\n" + .'- ADDCOLUMN：新增列。'."\n" + .'- RENAMETABLE：重命名表。'."\n" + ."\n" + .'DataWorks收到对应类型的DDL消息时，处理策略如下：'."\n" + .'- WARNING：直接丢弃该消息，同时会在实时同步日志中记录告警信息，指明该消息因执行出错被丢弃。'."\n" + .'- IGNORE：直接丢弃该消息，不再向目的端数据源发送。'."\n" + .'- CRITICAL：实时同步任务直接显示出错状态并终止运行。'."\n" + .'- NORMAL：将相应消息继续下发给目的端数据源，由目的端数据源来处理。因为不同目的端数据源对DDL消息处理策略可能会不同，因此DataWorks只执行转发操作。'."\n", + 'type' => 'string', + 'example' => '{"RENAMECOLUMN":"WARNING","DROPTABLE":"WARNING","CREATETABLE":"WARNING","MODIFYCOLUMN":"WARNING","TRUNCATETABLE":"WARNING","DROPCOLUMN":"WARNING","ADDCOLUMN":"WARNING","RENAMETABLE":"WARNING"}', + ], + ], + ], + ], + ], + ], + ], + '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' => '查看数据集成项目默认配置', + 'summary' => '查看当前工作空间中数据集成同步解决方案任务默认的全局配置。', + 'description' => '当前DataWorks仅支持为同步解决方案任务中的实时同步DDL消息处理策略设置默认的全局配置。如果您的同步解决方案任务包含实时同步任务，则配置**DDL消息处理规则**时会读取此处的全局配置为默认配置。您也可以根据实际业务需求修改目标同步任务的默认**DDL消息处理规则**为所需的配置。配置数据集成同步解决方案任务，详情请参见[配置同步解决方案任务](~~199008~~)。', + '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' => 'DataWorks工作空间的ID。您可以登录[DataWorks控制台](https://workbench.data.aliyun.com/console)，进入工作空间配置页面获取工作空间ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + 'maximum' => '10000000000', + 'minimum' => '1', + 'example' => '10000', + ], + ], + [ + 'name' => 'DestinationType', + 'in' => 'query', + 'schema' => [ + 'description' => '数据集成同步解决方案任务的目的端数据源。该参数不能为空。'."\n" + .'调用UpdateDIProjectConfig修改同步解决方案的全局配置，目前仅支持配置目的端数据源为analyticdb_for_mysql、odps、elasticsearch、holo、mysql及polardb。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'odps', + ], + ], + [ + 'name' => 'SourceType', + 'in' => 'query', + 'schema' => [ + 'description' => '数据集成同步解决方案任务的源端数据源。'."\n" + .'调用UpdateDIProjectConfig修改同步解决方案任务的全局配置，目前仅支持配置源端数据源为oracle、mysql、polardb、datahub、drds及analyticdb_for_mysql。'."\n" + .'如果不配置源端数据源，则默认全局配置对所有的源端数据源均生效。', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => 'mysql', + ], + ], + [ + 'name' => 'ProjectConfig', + 'in' => 'query', + 'schema' => [ + 'description' => '修改后的数据集成同步解决方案任务默认的全局配置内容（即对不同DDL消息类型配置的默认处理策略）。请使用JSON格式。示例如下：'."\n" + .'{"RENAMECOLUMN":"WARNING","DROPTABLE":"WARNING","CREATETABLE":"WARNING","MODIFYCOLUMN":"WARNING","TRUNCATETABLE":"WARNING","DROPCOLUMN":"WARNING","ADDCOLUMN":"WARNING","RENAMETABLE":"WARNING"}'."\n" + ."\n" + .'DDL消息类型如下：'."\n" + .'- RENAMECOLUMN：重命名列。'."\n" + .'- DROPTABLE：删除表。'."\n" + .'- CREATETABLE：新建表。'."\n" + .'- MODIFYCOLUMN：修改列类型。'."\n" + .'- TRUNCATETABLE：清空表。'."\n" + .'- DROPCOLUMN：删除列。'."\n" + .'- ADDCOLUMN：新增列。'."\n" + .'- RENAMETABLE：重命名表。'."\n" + ."\n" + .'DataWorks收到对应类型的DDL消息时，处理策略如下：'."\n" + .'- WARNING：直接丢弃该消息，同时会在实时同步日志中记录告警信息，指明该消息因执行出错被丢弃。'."\n" + .'- IGNORE：直接丢弃该消息，不再向目的端数据源发送。'."\n" + .'- CRITICAL：实时同步任务直接显示出错状态并终止运行。'."\n" + .'- NORMAL：将相应消息继续下发给目的端数据源，由目的端数据源来处理。因为不同目的端数据源对DDL消息处理策略可能会不同，因此DataWorks只执行转发操作。'."\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' => '请求是否成功。取值如下：'."\n" + .'- true：成功。'."\n" + .'- false：失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'RequestId' => [ + 'description' => '本次调用的唯一ID。用于出现错误后定位日志，排查问题。', + 'type' => 'string', + 'example' => '0000-ABCD-EFG ', + ], + 'Data' => [ + 'description' => '修改目标工作空间中数据集成同步解决方案任务默认全局配置的返回结果。', + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => '修改数据集成同步解决方案任务默认的全局配置是否成功。取值如下：'."\n" + .'- success：修改成功。'."\n" + .'- fail：修改失败。'."\n", + 'type' => 'string', + 'example' => 'success', + ], + ], + ], + ], + ], + ], + ], + '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' => '修改同步解决方案任务的全局配置', + 'summary' => '修改当前工作空间中数据集成同步解决方案任务默认的全局配置。', + 'description' => '当前DataWorks仅支持为同步解决方案任务中的实时同步DDL消息处理策略设置默认的全局配置。如果您的同步解决方案任务包含实时同步任务，则配置**DDL消息处理规则**时会读取此处的全局配置为默认配置。您也可以根据实际业务需求修改目标同步任务的默认**DDL消息处理规则**为所需的配置。配置数据集成同步解决方案任务，详情请参见[配置同步解决方案任务](~~199008~~)。', + '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' => 'DataWorks工作空间的ID。您可以登录[DataWorks控制台](https://workbench.data.aliyun.com/console)，进入工作空间管理页面获取ID。'."\n" + ."\n" + .'该参数用来确定本次API调用操作使用的DataWorks工作空间。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + 'maximum' => '10000000000', + 'minimum' => '1', + 'example' => '10000', + ], + ], + [ + 'name' => 'TaskType', + 'in' => 'query', + 'schema' => [ + 'description' => '目标数据源所关联的数据集成同步任务的任务类型。取值如下：'."\n" + ."\n" + .'- DI_REALTIME：表示数据集成实时同步任务。'."\n" + .'- DI_SOLUTION：表示数据集成同步解决方案。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'DI_REALTIME', + ], + ], + [ + 'name' => 'FileId', + 'in' => 'query', + 'schema' => [ + 'description' => '- 当TaskType为DI_REALTIME时，则FileId为实时同步任务的文件ID。'."\n" + .'- 当TaskType为DI_SOLUTION时，则FileId为同步解决方案的任务ID。'."\n" + ."\n" + .'您可以调用[ListFiles](~~173942~~)接口获取任务ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + 'maximum' => '9999999999999999', + 'minimum' => '1', + 'example' => '100', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '获取数据集成任务的返回结果。', + 'type' => 'object', + 'properties' => [ + 'Success' => [ + 'description' => '请求是否成功。取值如下：'."\n" + ."\n" + .'- True：成功。'."\n" + .'- False：失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'RequestId' => [ + 'description' => '请求ID。用于定位日志，排查问题。', + 'type' => 'string', + 'example' => '0bc1411515937635973**** ', + ], + 'Data' => [ + 'description' => '获取数据集成任务的返回结果。', + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '- 如果TaskType为DI_REALTIME，则获取实时同步任务的详情。'."\n" + .'- 如果TaskType为DI_SOLUTION，则为null。', + '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' => '获取数据集成同步任务的结果状态。取值如下：'."\n" + ."\n" + .'Success：表示获取数据集成同步任务成功。'."\n" + .'Fail：表示获取数据集成同步任务失败。', + 'type' => 'string', + 'example' => 'success', + ], + 'Message' => [ + 'description' => '获取数据集成同步任务失败后的原因描述。'."\n" + ."\n" + .'如果获取数据集成同步任务成功，则该参数的返回值为空。', + 'type' => 'string', + 'example' => 'fileId:[100] is invalid.', + ], + 'AlarmList' => [ + 'description' => '实时任务相关联的报警规则数组。', + 'type' => 'array', + 'items' => [ + 'description' => '单条实时任务相关联的报警规则。', + 'type' => 'object', + 'properties' => [ + 'Id' => [ + 'description' => '报警规则id。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '45242', + ], + 'Enabled' => [ + 'description' => '报警规则是否启动。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'RuleName' => [ + 'description' => '报警规则名称。', + 'type' => 'string', + 'example' => 'Delay alert rule name 1', + ], + 'Metric' => [ + 'description' => '报警类型：'."\n" + ."\n" + .'- taskStatus 任务状态'."\n" + .'- bizDelay 业务延迟'."\n" + .'- taskFailoverCount 监控Failover'."\n" + .'- ddlUnsupport DDL不支持'."\n" + .'- ddlReport DDL通知'."\n" + .'- totalDirtyRecordWriteInLines 脏数据', + 'type' => 'string', + 'example' => 'taskStatus', + ], + 'Description' => [ + 'description' => '报警规则描述。', + 'type' => 'string', + 'example' => 'Description', + ], + 'AlarmRuleList' => [ + 'description' => '报警通知配置数组。', + 'type' => 'array', + 'items' => [ + 'description' => '报警通知配置。', + 'type' => 'object', + 'properties' => [ + 'Level' => [ + 'description' => '- WARNING 警告告警'."\n" + .'- CRITICAL 严重告警', + 'type' => 'string', + 'example' => 'WARNING', + ], + 'Comparator' => [ + 'description' => '比较符号，指标和告警规则的比较方法：'."\n" + .'- \'=\' '."\n" + .'- \'<\''."\n" + .'- \'>\'', + 'type' => 'string', + 'example' => '=', + ], + 'Threshold' => [ + 'description' => '指标和告警规则的比较阈值。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'Duration' => [ + 'description' => '持续时间，满足该条件持续多久才会触发报警，单位分钟。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '3', + ], + 'Aggregator' => [ + 'description' => '指标的计算方法：'."\n" + .'- avg 区间取平均'."\n" + .'- max 区间取最大值', + 'type' => 'string', + 'example' => 'avg', + ], + ], + ], + ], + 'NotifyRule' => [ + 'description' => '告警通知规则数组。', + 'type' => 'object', + 'properties' => [ + 'Interval' => [ + 'description' => '告警间隔，单位分钟。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '5', + ], + 'Warning' => [ + 'description' => 'Warning级别告警通知列表。', + 'type' => 'array', + 'items' => [ + 'description' => '通道，可选的枚举值：'."\n" + ."\n" + .'- Mail（邮件）'."\n" + .'- Phone（电话）'."\n" + .'- Sms（短信）'."\n" + .'- Ding（钉钉）', + 'type' => 'string', + 'example' => 'Ding', + ], + ], + 'Critical' => [ + 'description' => 'Critical级别告警通知列表。', + 'type' => 'array', + 'items' => [ + 'description' => '通道，可选的枚举值：'."\n" + ."\n" + .'- Mail（邮件）'."\n" + .'- Phone（电话）'."\n" + .'- Sms（短信）'."\n" + .'- Ding（钉钉）', + 'type' => 'string', + 'example' => 'Ding', + ], + ], + ], + ], + ], + ], + ], + 'SolutionDetail' => [ + 'description' => '- 如果TaskType为DI_REALTIME，则为null。'."\n" + .'- 如果TaskType为DI_SOLUTION，则获取同步解决方案任务的详情。', + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => '同步解决方案的执行状态'."\n" + ."\n" + .'- 0-成功 '."\n" + .'- 1-未运行 '."\n" + .'- 2-运行中'."\n" + .'- 3-失败 '."\n" + .'- 4-提交'."\n" + .'- 5-待人工确认'."\n" + .'- 6-人工确认完成'."\n" + .'- 7-其他 '."\n" + .'- 8-等待 '."\n" + .'- 9-已删除', + 'type' => 'string', + 'example' => '0', + ], + 'Type' => [ + 'description' => '同步解决方案任务的类型。', + 'type' => 'string', + 'example' => 'holo', + ], + 'StartTime' => [ + 'description' => '同步解决方案任务的开始时间。', + 'type' => 'string', + 'example' => '2021-12-07 14:40:51', + ], + 'CreatorName' => [ + 'description' => '同步解决方案任务的创建者名称。', + 'type' => 'string', + 'example' => 'dataworks_di', + ], + 'ProjectId' => [ + 'description' => '同步解决方案任务所在的项目ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10000', + ], + 'SourceType' => [ + 'description' => '同步解决方案任务源端的类型。', + 'type' => 'string', + 'example' => 'mysql', + ], + 'ProcessContent' => [ + 'description' => '同步解决方案的配置详情。', + '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' => '同步解决方案任务的名称。', + 'type' => 'string', + 'example' => 'holo_20211206161025', + ], + 'ProcessExtra' => [ + 'description' => '同步解决方案任务的额外参数。', + 'type' => 'string', + 'example' => '{"processType":"new","tableNum":300}', + ], + 'SubmitTime' => [ + 'description' => '同步解决方案任务提交的时间。', + 'type' => 'string', + 'example' => '2021-12-07 14:40:51', + ], + 'Id' => [ + 'description' => '同步解决方案的任务ID。', + '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' => '查询数据同步任务', + 'summary' => '获取数据集成实时同步任务和同步解决方案的详情。', + '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' => 'DataWorks工作空间的ID。您可以登录[DataWorks控制台](https://workbench.data.aliyun.com/console)，进入工作空间管理页面获取ID。'."\n" + ."\n" + .'该参数用来确定本次API调用操作使用的DataWorks工作空间。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + 'maximum' => '10000000000', + 'minimum' => '1', + 'example' => '10000', + ], + ], + [ + 'name' => 'TaskType', + 'in' => 'query', + 'schema' => [ + 'description' => '目标数据源所关联的数据集成同步任务的任务类型。取值如下：'."\n" + ."\n" + .'- DI_REALTIME：表示数据集成实时同步任务。'."\n" + .'- DI_SOLUTION：表示数据集成主站同步任务。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'DI_REALTIME', + ], + ], + [ + 'name' => 'FileId', + 'in' => 'query', + 'schema' => [ + 'description' => '- 当TaskType为DI_REALTIME时，则FileId为实时同步任务的文件ID。'."\n" + .'- 当TaskType为DI_SOLUTION时，则FileId为主站同步任务的任务ID。'."\n" + ."\n" + .'您可以调用[ListFiles](~~173942~~)接口获取任务ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + 'maximum' => '9999999999999999', + 'minimum' => '1', + 'example' => '100', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '数据集成同步任务返回结果。', + 'type' => 'object', + 'properties' => [ + 'Success' => [ + 'description' => '请求是否成功。取值如下：'."\n" + ."\n" + .'- true：成功。 '."\n" + .'- false：失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'RequestId' => [ + 'description' => '请求ID。用于定位日志，排查问题。'."\n", + 'type' => 'string', + 'example' => '0bc14115159376359******', + ], + 'Data' => [ + 'description' => '发布同步任务的结果。', + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => '发布数据集成同步任务的结果状态。取值如下：'."\n" + ."\n" + .'- success：表示发布数据集成同步任务成功。'."\n" + .'- fail：表示发布数据集成同步任务失败。', + 'type' => 'string', + 'example' => 'success', + ], + 'Message' => [ + 'description' => '发布数据集成同步任务失败后的原因描述。'."\n" + ."\n" + .'如果发布数据集成同步任务成功，则该参数的返回值为空。', + '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' => '部署发布同步任务', + 'summary' => '该接口用于发布实时同步任务。', + ], + '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' => 'DataWorks工作空间的ID。您可以登录[DataWorks控制台](https://workbench.data.aliyun.com/console)，进入工作空间管理页面获取ID。'."\n" + ."\n" + .'该参数用来确定本次API调用操作使用的DataWorks工作空间。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + 'maximum' => '10000000000', + 'minimum' => '1', + 'example' => '10000', + ], + ], + [ + 'name' => 'TaskType', + 'in' => 'query', + 'schema' => [ + 'description' => '目标数据源所关联的数据集成同步任务的任务类型。取值如下：'."\n" + ."\n" + .'- DI_REALTIME：表示数据集成实时同步任务。'."\n" + .'- DI_SOLUTION：表示数据集成同步解决方案。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'DI_REALTIME', + ], + ], + [ + 'name' => 'FileId', + 'in' => 'query', + 'schema' => [ + 'description' => '- 当TaskType为DI_REALTIME时，则FileId为实时同步任务的文件ID。'."\n" + .'- 当TaskType为DI_SOLUTION时，则FileId为同步解决方案的任务ID。'."\n" + ."\n" + .'您可以调用[ListFiles](~~173942~~)接口获取任务ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + 'maximum' => '9999999999999999', + 'minimum' => '1', + 'example' => '100', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '数据集成同步任务返回的数据结构。', + 'type' => 'object', + 'properties' => [ + 'Success' => [ + 'description' => '请求是否成功。取值如下：'."\n" + ."\n" + .'- true：成功。 '."\n" + .'- false：失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'RequestId' => [ + 'description' => '请求ID。用于定位日志，排查问题。'."\n", + 'type' => 'string', + 'example' => '0bc1411515937635973****', + ], + 'Data' => [ + 'description' => '获取同步任务的运行状态。', + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => '- 如果taskType为DI_REALTIME，则status为实时任务的运行状态。包括：PAUSE、NORUN、RUN、KILLING、WAIT。 '."\n" + ."\n" + .'- 如果taskType为DI_SOLITION， 则status为同步解决方案的运行状态。包括：success、fail。'."\n", + 'type' => 'string', + 'example' => 'RUN', + ], + 'Message' => [ + 'description' => '获取同步任务运行状态失败后的原因描述。如果获取数据集成同步任务成功，则该参数的返回值为空。', + 'type' => 'string', + 'example' => 'fileId[100] is invalid', + ], + 'Name' => [ + 'description' => '- 如果taskType为DI_REALTIME，则name为实时同步任务的名称。'."\n" + .'- 如果taskType为DI_SOLITION， 则name为空。', + 'type' => 'string', + 'example' => 'streamx_name', + ], + 'SolutionInfo' => [ + 'description' => '- 如果taskType为DI_REALTIME，则SolutionInfo为空。'."\n" + .'- 如果taskType为DI_SOLITION， 则SolutionInfo为同步解决方案运行详情。', + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => '同步解决方案运行状态。', + 'type' => 'string', + 'example' => 'run', + ], + 'Id' => [ + 'description' => '同步解决方案任务ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '100', + ], + 'CreatorName' => [ + 'description' => '同步解决方案任务创建者名称。', + 'type' => 'string', + 'example' => 'dataworks_3h1', + ], + 'StepDetail' => [ + 'description' => '同步解决方案任务运行步骤详情。', + 'type' => 'array', + 'items' => [ + 'description' => '数据集成同步任务返回的数据结构。', + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => '同步解决方案运行步骤的状态。', + 'type' => 'string', + 'example' => 'success', + ], + 'StepId' => [ + 'description' => '同步解决方案运行步骤的ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'StepName' => [ + 'description' => '同步解决方案运行步骤的名称。', + 'type' => 'string', + 'example' => 'Create a base table', + ], + 'Info' => [ + 'description' => '同步解决方案运行信息', + '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' => '获取同步任务实例信息', + 'summary' => '获取实时同步任务和同步解决方案任务的运行状态。', + ], + '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' => 'DataWorks工作空间的ID。您可以登录[DataWorks控制台](https://workbench.data.aliyun.com/console)，进入工作空间管理页面获取ID。'."\n" + ."\n" + .'该参数用来确定本次API调用操作使用的DataWorks工作空间。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + 'maximum' => '10000000000', + 'minimum' => '1', + 'example' => '10000', + ], + ], + [ + 'name' => 'TaskType', + 'in' => 'query', + 'schema' => [ + 'description' => 'DI_REALTIME表示实时同步任务。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'DI_REALTIME', + ], + ], + [ + 'name' => 'FileId', + 'in' => 'query', + 'schema' => [ + 'description' => '实时同步任务的文件ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + 'maximum' => '9999999999999999', + 'minimum' => '1', + 'example' => '100', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '实时同步任务返回的数据结构。', + 'type' => 'object', + 'properties' => [ + 'Success' => [ + 'description' => '请求是否成功。取值如下：'."\n" + ."\n" + .'- true：成功。'."\n" + .'- false：失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'RequestId' => [ + 'description' => '请求ID。用于定位日志，排查问题。', + 'type' => 'string', + 'example' => '0bc1411515937635973****', + ], + 'Data' => [ + 'description' => '下线实时同步任务的状态。', + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => '下线数据集成实时同步任务的结果状态。取值如下：'."\n" + ."\n" + .'- success：表示下线数据集成实时同步任务成功。 '."\n" + .'- fail：表示下线数据集成实时同步任务失败。', + 'type' => 'string', + 'example' => 'success', + ], + 'Message' => [ + 'description' => '下线数据集成实时同步任务失败后的原因描述。如果下线数据集成实时同步任务成功，则该参数的返回值为空。', + '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' => '终止同步任务', + 'summary' => '下线数据集成实时同步任务。', + ], + 'GenerateDISyncTaskConfigForCreating' => [ + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + [ + 'APP' => [], + ], + [ + 'PrivateKey' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'ProjectId', + 'in' => 'query', + 'schema' => [ + 'description' => 'DataWorks工作空间的ID。您可以登录[DataWorks控制台](https://workbench.data.aliyun.com/console)，进入工作空间配置页面获取工作空间ID。'."\n" + ."\n" + .'该参数用来确定本次API调用操作使用的DataWorks工作空间。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + 'maximum' => '10000000000', + 'minimum' => '1', + 'example' => '10000', + ], + ], + [ + 'name' => 'TaskType', + 'in' => 'query', + 'schema' => [ + 'description' => '使用异步方式创建数据集成同步任务的任务类型。取值如下：'."\n" + .'- DI_REALTIME：表示实时同步任务。'."\n" + .'- DI_SOLUTION：表示其他同步类型的同步任务。'."\n" + ."\n" + .'仅支持使用异步方式生成数据集成实时同步任务和其他同步类型的同步任务。'."\n" + .' '."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'enumValueTitles' => [], + 'example' => 'DI_REALTIME', + 'enum' => [ + 'DI_OFFLINE', + 'DI_REALTIME', + 'DI_SOLUTION', + ], + ], + ], + [ + 'name' => 'TaskParam', + 'in' => 'query', + 'schema' => [ + 'description' => '数据集成同步任务的脚本。'."\n" + .'目前支持创建的同步任务类型如下： '."\n" + .'- 同步MySQL数据至MaxCompute。'."\n" + .'- 同步MySQL数据至Kafka。'."\n" + .'- 同步MySQL数据至Hologres。'."\n" + ."\n" + .'SelectedTables用于多库模式选择同步表，Tables用于单库模式选择同步表。'."\n" + .'- 当脚本中包含SelectedTables语句时，系统会使用SelectedTables语句中的表信息进行同步。'."\n" + .'- 当脚本中包含Tables语句时，系统会使用Tables的字段信息进行同步。'."\n" + ."\n\n" + .'同步MySQL数据至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" + ."\n" + .'同步MySQL数据至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" + ."\n" + .'同步MySQL数据至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" + .'```'."\n" + ."\n\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '{ "type": "realtime", "version": "1.0", "setting": { "resourceGroup": "S_res_group_280749521950784_1623033752022", "taskType": "oneclick_to_odps" }, "steps": [{ "stepType": "mysql", "parameter": { "connection": [ { "datasourceType": "mysql", "datasource": "mysql_pub1", "selectedTables": [ { "dbName": "mysql_db", "schema": [ { "tableInfos": [ { "table": "molin_di_test_in_pk_v4" }] } ] } ] } ] }, "name": "Reader", "category": "reader" }, { "stepType": "odps", "parameter": { "datasource": "odps_source" }, "name": "Writer", "category": "writer" } ] }', + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'description' => '幂等参数。用于避免多次调用导致操作重复。', + 'type' => 'string', + 'required' => false, + 'example' => 'ABFUOEUOTRTRJKE', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'Success' => [ + 'description' => '请求是否成功。取值如下：'."\n" + .'- true：成功。'."\n" + .'- false：失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'RequestId' => [ + 'description' => '请求ID。用于定位日志，排查问题。', + 'type' => 'string', + 'example' => '0bc1411515937635973****', + ], + 'Data' => [ + 'description' => '异步线程ID的生成结果。', + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => '生成异步线程ID的结果状态。取值如下：'."\n" + .'- success：表示成功生成异步线程ID。'."\n" + .'- fail：表示异步线程ID生成失败。您可以查看失败原因，处理相关问题。', + 'type' => 'string', + 'example' => 'true', + ], + 'ProcessId' => [ + 'description' => '异步线程ID。您需要通过该ID，调用[QueryDISyncTaskConfigProcessResult](~~383465~~)接口获取异步生成创建数据集成同步任务需要的参数，使用该参数创建数据集成同步任务。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10', + ], + 'Message' => [ + 'description' => '异步线程ID生成失败的原因描述。'."\n" + .'如果成功生成异步线程ID，则该参数的返回值为空。', + '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' => '异步生成同时任务的JSON', + 'summary' => '异步生成同时任务的JSON。', + 'description' => 'DataWorks目前仅支持直接使用[CreateDISyncTask](~~278725~~)接口创建数据集成离线同步任务，而数据集成实时同步任务和其他同步类型的任务则需要先调用[GenerateDISyncTaskConfigForCreating](~~383463~~)和[QueryDISyncTaskConfigProcessResult](~~383465~~)接口，获取异步生成创建数据集成同步任务需要的参数，再将该参数作为[CreateDISyncTask](~~278725~~)接口的入参，使用[CreateDISyncTask](~~278725~~)接口创建相应的实时同步任务和其他同步类型的同步任务。'."\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' => 'DataWorks工作空间的ID。您可以登录[DataWorks控制台](https://workbench.data.aliyun.com/console)，进入工作空间配置页面获取工作空间ID。'."\n" + ."\n" + .'该参数用来确定本次API调用操作使用的DataWorks工作空间。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + 'maximum' => '10000000000', + 'minimum' => '1', + 'example' => '10000', + ], + ], + [ + 'name' => 'TaskType', + 'in' => 'query', + 'schema' => [ + 'description' => '使用异步方式更新数据集成同步任务的任务类型。取值如下：'."\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' => '更新同步任务的脚本语句。'."\n" + .'目前仅支持通过异步方式为数据集成同步任务新增表或者删除表，并且仅支持更新如下类型的同步任务：'."\n" + .'- 同步MySQL数据至MaxCompute。'."\n" + .'- 同步MySQL数据至Kafka。'."\n" + .'- 同步MySQL数据至Hologres。'."\n" + ."\n" + .'同步任务中的SelectedTables用于多库模式选择同步表，Tables用于单库模式选择同步表。'."\n" + .'- 当脚本中包含SelectedTables语句时，系统会使用SelectedTables语句中的表信息进行同步。'."\n" + .'- 当脚本中包含Tables语句时，系统会使用Tables的字段信息进行同步。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '{"steps":[{"parameter":{"connection":[{"table":["xyx"]}]},"name":"Reader","category":"reader"}]}', + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'description' => '幂等参数。用于避免多次调用导致操作重复。', + 'type' => 'string', + 'required' => false, + 'example' => 'ABFUOEUOTRTRJKE', + ], + ], + [ + 'name' => 'TaskId', + 'in' => 'query', + 'schema' => [ + 'description' => '任务ID。'."\n" + .'- 当TaskType参数配置为实时同步任务（DI_REALTIME），则TaskId为实时同步任务的FileId。'."\n" + .'- 当TaskType参数配置为解决方案同步任务（DI_SOLUTION），则TaskId为解决方案同步任务的FileId。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + 'maximum' => '9999999999999999', + 'minimum' => '0', + 'example' => '100', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'Success' => [ + 'description' => '请求是否成功。取值如下：'."\n" + .'- true：成功。'."\n" + .'- false：失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'RequestId' => [ + 'description' => '请求ID。用于定位日志，排查问题。', + 'type' => 'string', + 'example' => '0bc1411515937635973****', + ], + 'Data' => [ + 'description' => '异步线程ID的生成结果。', + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => '生成异步线程ID的结果状态。取值如下：'."\n" + .'- success：表示成功生成异步线程ID。'."\n" + .'- fail：表示异步线程ID生成失败。您可以查看失败原因，处理相关问题。', + 'type' => 'string', + 'example' => 'true', + ], + 'ProcessId' => [ + 'description' => '异步线程ID。您需要通过该ID，调用[QueryDISyncTaskConfigProcessResult](~~383465~~)接口获取异步生成更新数据集成同步任务需要的参数，后续使用该参数更新数据集成同步任务。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10', + ], + 'Message' => [ + 'description' => '异步线程ID生成失败的原因描述。 如果成功生成异步线程ID，则该参数的返回值为空。', + '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' => '异步生成更新同步任务配置', + 'summary' => '异步生成更新同步任务的JSON。', + 'description' => 'DataWorks目前仅支持直接使用[UpdateDISyncTask](~~289109~~)接口更新数据集成离线同步任务，而数据集成实时同步任务则需要先调用GenerateDISyncTaskConfigForUpdating和[QueryDISyncTaskConfigProcessResult](~~383465~~)接口，异步生成更新数据集成同步任务需要的参数，再将该参数作为UpdateDISyncTask接口的入参，使用UpdateDISyncTask接口更新相应的实时同步任务。 仅支持使用异步方式更新数据集成实时同步任务。', + ], + 'StartDISyncInstance' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'ProjectId', + 'in' => 'query', + 'schema' => [ + 'description' => 'DataWorks工作空间的ID。您可以登录[DataWorks控制台](https://workbench.data.aliyun.com/console)，进入工作空间配置页面获取工作空间ID。'."\n" + .'该参数用来确定本次API调用操作使用的DataWorks工作空间。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + 'maximum' => '10000000000', + 'minimum' => '1', + 'example' => '10000', + ], + ], + [ + 'name' => 'TaskType', + 'in' => 'query', + 'schema' => [ + 'description' => '启动数据集成同步任务的任务类型。 目前仅支持使用DI_REALTIME和DI_SOLUTION两种类型：'."\n" + .'- DI_REALTIME代表启动实时任务。'."\n" + .'- DI_SOLUTION代表启动解决方案。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'DI_REALTIME', + ], + ], + [ + 'name' => 'FileId', + 'in' => 'query', + 'schema' => [ + 'description' => '- 当TaskType参数配置为DI_REALTIME，则FileId为实时同步任务的任务ID。'."\n" + .'- 当TaskType参数配置为DI_SOLUTION，则FileId为解决方案同步任务的任务ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + 'maximum' => '9999999999999999', + 'minimum' => '1', + 'example' => '100', + ], + ], + [ + 'name' => 'StartParam', + 'in' => 'query', + 'schema' => [ + 'description' => '- 当TaskType参数配置为DI_REALTIME，则StartParam为实时同步任务的启动参数，包括Failover的设置，脏数据条数，以及DDL的参数配置。'."\n" + .'- 当TaskType参数配置为DI_SOLUTION，则StartParam参数无意义。'."\n" + ."\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' => '返回对象。', + 'type' => 'object', + 'properties' => [ + 'Success' => [ + 'description' => '请求是否成功。取值如下：'."\n" + .'- true：成功。'."\n" + .'- false：失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'RequestId' => [ + 'description' => '请求ID。用于定位日志，排查问题。'."\n", + 'type' => 'string', + 'example' => '0bc1411515937635973****', + ], + 'Data' => [ + 'description' => '启动同步任务的结果。', + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => '启动同步任务的结果状态。取值如下：'."\n" + .'- success：同步任务启动成功。'."\n" + .'- fail：同步任务启动失败。您可以查看具体原因，处理相关问题。', + 'type' => 'string', + 'example' => 'success', + ], + 'Message' => [ + 'description' => '启动数据集成同步任务失败后的原因描述。'."\n" + ."\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' => '启动实时同步任务和解决方案同步任务', + 'summary' => '调用StartDISyncInstance接口，启动实时同步任务和解决方案同步任务。', + ], + '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' => 'DataWorks工作空间的ID。您可以登录[DataWorks控制台](https://workbench.data.aliyun.com/console)，进入工作空间配置页面获取工作空间ID。'."\n" + ."\n" + .'该参数用来确定本次API调用操作使用的DataWorks工作空间。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + 'maximum' => '10000000000', + 'minimum' => '1', + 'example' => '10000', + ], + ], + [ + 'name' => 'TaskType', + 'in' => 'query', + 'schema' => [ + 'description' => '停止数据集成同步任务的任务类型。目前仅支持使用DI_REALTIME类型。'."\n" + ."\n" + .'DI_REALTIME代表实时任务。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'DI_REALTIME', + ], + ], + [ + 'name' => 'FileId', + 'in' => 'query', + 'schema' => [ + 'description' => 'FileId为实时同步任务的ID。您可以调用[ListFiles](~~173942~~)接口获取任务ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + 'maximum' => '9999999999999999', + 'minimum' => '1', + 'example' => '100', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回对象。', + 'type' => 'object', + 'properties' => [ + 'Success' => [ + 'description' => '请求是否成功。取值如下：'."\n" + .'- true：成功。 '."\n" + .'- false：失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'RequestId' => [ + 'description' => '请求ID。用于定位日志，排查问题。'."\n", + 'type' => 'string', + 'example' => '0bc1411515937635973****', + ], + 'Data' => [ + 'description' => '停止同步任务的结果。', + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => '停止数据集成同步任务的结果状态。取值如下：'."\n" + .'- success：表示停止数据集成同步任务成功。'."\n" + .'- fail：表示停止数据集成同步任务失败。', + 'type' => 'string', + 'example' => 'success', + ], + 'Message' => [ + 'description' => '停止数据集成同步任务失败后的原因描述。'."\n" + ."\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' => '停止实时同步任务', + 'summary' => '调用StopDISyncInstance接口，停止实时同步任务。', + ], + 'QueryDISyncTaskConfigProcessResult' => [ + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + [ + 'PrivateKey' => [], + ], + [ + 'APP' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'ProjectId', + 'in' => 'query', + 'schema' => [ + 'description' => 'DataWorks工作空间的ID。您可以登录[DataWorks控制台](https://workbench.data.aliyun.com/console)，进入工作空间配置页面获取工作空间ID。'."\n" + ."\n" + .'该参数用来确定本次API调用操作使用的DataWorks工作空间。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + 'maximum' => '10000000000', + 'minimum' => '1', + 'example' => '10000', + ], + ], + [ + 'name' => 'TaskType', + 'in' => 'query', + 'schema' => [ + 'description' => '异步方式创建或更新的同步任务的任务类型。取值如下：'."\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' => '异步线程的ID。您可以调用[GenerateDISyncTaskConfigForCreating](~~383463~~)或[GenerateDISyncTaskConfigForUpdating](~~383464~~)接口获取ID。'."\n" + .'- GenerateDISyncTaskConfigForCreating：表示创建数据集成同步任务。'."\n" + .'- GenerateDISyncTaskConfigForUpdating：表示更新数据集成同步任务。'."\n" + ."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + 'maximum' => '9999999999999999', + 'minimum' => '1', + 'example' => '10', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'Success' => [ + 'description' => '请求是否成功。取值如下：'."\n" + .'- true：成功。'."\n" + .'- false：失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'RequestId' => [ + 'description' => '请求ID。用于定位日志，排查问题。', + 'type' => 'string', + 'example' => '0bc1411515937635973****', + ], + 'Data' => [ + 'description' => '获取异步生成或更新数据集成同步任务所需参数的返回结果。', + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => '获取异步生成或更新数据集成同步任务所需参数的结果状态。取值如下：'."\n" + .'- success：表示成功获取相关参数。'."\n" + .'- fail：表示获取相关参数失败。您可以查看失败原因，处理相关问题。', + 'type' => 'string', + 'example' => 'success', + ], + 'Message' => [ + 'description' => '获取异步生成或更新数据集成同步任务所需参数失败的原因描述。如果获取成功，则该参数的返回值为空。', + 'type' => 'string', + 'example' => 'fileId:[100] is invalid.', + ], + 'TaskContent' => [ + 'description' => '异步线程生成的数据集成同步任务所需参数。该参数将作为[CreateDISyncTask](~~278725~~)或[UpdateDISyncTask](~~289109~~)接口的输入参数，用于后续创建或更新数据集成同步任务。', + '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' => '查询异步任务结果', + 'summary' => '查询异步任务结果。', + 'description' => 'DataWorks目前仅支持直接使用[CreateDISyncTask](~~278725~~)接口创建或[UpdateDISyncTask](~~289109~~)接口更新数据集成离线同步任务，而数据集成实时同步任务则需要先调用[GenerateDISyncTaskConfigForCreating](~~383463~~)、[GenerateDISyncTaskConfigForUpdating](~~383464~~)和[QueryDISyncTaskConfigProcessResult](~~383465~~)接口，获取异步生成创建或更新数据集成同步任务需要的参数，再将该参数作为CreateDISyncTask或UpdateDISyncTask接口的入参，使用CreateDISyncTask创建、UpdateDISyncTask更新相应的实时同步任务。'."\n" + .' 仅支持使用异步方式创建或更新数据集成实时同步任务。', + ], + 'CreateDIJob' => [ + 'summary' => '创建数据集成新版任务，当前支持的任务类型包括：MySQL到Hologres整库实时解决方案。', + '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' => 'DataWorks工作空间ID。您可以通过[ListProjects](~~178393~~)接口获取工作空间ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '10000', + ], + ], + [ + 'name' => 'JobName', + 'in' => 'formData', + 'schema' => [ + 'description' => '任务名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'mysql_to_holo_sync_8772', + ], + ], + [ + 'name' => 'Description', + 'in' => 'formData', + 'schema' => [ + 'description' => '任务描述。', + 'type' => 'string', + 'required' => false, + 'example' => 'Synchronize mysql to hologres', + ], + ], + [ + 'name' => 'MigrationType', + 'in' => 'formData', + 'schema' => [ + 'description' => '同步类型，可选的枚举值有：'."\n" + .'- FullAndRealtimeIncremental（全量和实时增量）'."\n" + .'- RealtimeIncremental（实时增量）'."\n" + .'- Full（全量）'."\n" + .'- OfflineIncremental（离线增量）'."\n" + .'- FullAndOfflineIncremental（全量+离线增量）', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [], + 'example' => 'FullAndRealtimeIncremental', + ], + ], + [ + 'name' => 'SourceDataSourceType', + 'in' => 'formData', + 'schema' => [ + 'description' => '源端数据源类型，枚举值：MySQL。', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [], + 'example' => 'MySQL', + ], + ], + [ + 'name' => 'DestinationDataSourceType', + 'in' => 'formData', + 'schema' => [ + 'description' => '目标端数据源类型，枚举值：Hologres、Hive。', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [], + 'example' => 'Hologres', + ], + ], + [ + 'name' => 'SourceDataSourceSettings', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'description' => '源端数据源设置，目前仅支持单个数据源。', + 'type' => 'array', + 'items' => [ + 'description' => '源端数据源设置。', + 'type' => 'object', + 'properties' => [ + 'DataSourceName' => [ + 'description' => '数据源名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'mysql_datasource_1', + ], + 'DataSourceProperties' => [ + 'description' => '数据源属性。', + 'type' => 'object', + 'required' => false, + 'additionalProperties' => [ + 'type' => 'string', + 'example' => 'TimeZone', + 'description' => '源端数据源属性。MySQL数据源支持的属性名称包括：TimeZone（时区），Encoding（编码）。', + ], + ], + ], + 'required' => false, + ], + 'required' => false, + ], + ], + [ + 'name' => 'DestinationDataSourceSettings', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'description' => '目标端数据源设置，目前仅支持单个数据源。', + 'type' => 'array', + 'items' => [ + 'description' => '目标端数据源设置。', + 'type' => 'object', + 'properties' => [ + 'DataSourceName' => [ + 'description' => '数据源名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'holo_datasource_1', + ], + 'DataSourceProperties' => [ + 'description' => '数据源属性。', + 'type' => 'object', + 'required' => false, + 'additionalProperties' => [ + 'type' => 'string', + 'example' => 'TimeZone', + 'description' => '目标端数据源属性。Hologres数据源暂无属性可设置。'."\n" + ."\n", + ], + ], + ], + 'required' => false, + ], + 'required' => false, + ], + ], + [ + 'name' => 'ResourceSettings', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'description' => '资源设置。', + 'type' => 'object', + 'properties' => [ + 'OfflineResourceSettings' => [ + 'description' => '离线同步资源。', + 'type' => 'object', + 'properties' => [ + 'ResourceGroupIdentifier' => [ + 'description' => '离线同步使用的数据集成资源组标识。', + 'type' => 'string', + 'required' => false, + 'example' => 'S_res_group_111_222', + ], + ], + 'required' => false, + ], + 'RealtimeResourceSettings' => [ + 'description' => '实时同步资源。', + 'type' => 'object', + 'properties' => [ + 'ResourceGroupIdentifier' => [ + 'description' => '实时同步使用的数据集成资源组标识。', + 'type' => 'string', + 'required' => false, + 'example' => 'S_res_group_111_222', + ], + ], + 'required' => false, + ], + 'RequestedCu' => [ + 'description' => '增全量同步任务使用的资源组cu', + 'type' => 'number', + 'format' => 'float', + 'required' => false, + 'example' => '2.0', + ], + ], + 'required' => false, + ], + ], + [ + 'name' => 'TransformationRules', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'description' => '同步对象转换规则定义列表，列表中每个元素为一条转换规则定义。', + 'type' => 'array', + 'items' => [ + 'description' => '同步对象转换规则定义。', + 'type' => 'object', + 'properties' => [ + 'RuleName' => [ + 'description' => '规则名称，当动作类型和动作作用的目标类型相同时，规则名称需保证唯一性。', + 'type' => 'string', + 'required' => false, + 'example' => 'rename_rule_1', + ], + 'RuleActionType' => [ + 'description' => '动作类型，可选的枚举值：'."\n" + .'- DefinePrimaryKey（定义主键）'."\n" + .'- Rename（重命名）'."\n" + .'- AddColumn（增加列）'."\n" + .'- HandleDml（DML处理）'."\n" + .'- DefineIncrementalCondition（定义增量条件）'."\n" + .'- DefineCycleScheduleSettings（定义周期调度设置）'."\n" + .'- DefineRuntimeSettings（定义高级配置参数）'."\n" + .'- DefinePartitionKey（定义分区列）', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [], + 'example' => 'Rename', + ], + 'RuleTargetType' => [ + 'description' => '动作作用的目标类型，可选的枚举值：'."\n" + .'- Table（表）'."\n" + .'- Schema（schema）', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [], + 'example' => 'Table', + ], + 'RuleExpression' => [ + 'description' => '规则表达式，json string格式。'."\n" + ."\n\n" + .'重命名规则（Rename）示例：'."\n" + .'{"expression":"${srcDatasourceName}_${srcDatabaseName}_0922","variables":\\[{"variableName":"srcDatabaseName","variableRules":\\[{"from":"fromdb","to":"todb"}\\]}\\]}'."\n" + .'- expression：为重命名转换规则表达式，表达式内支持变量包括：${srcDatasourceName}（源端数据源名）、${srcDatabaseName}（源端库名）、${srcTableName}（源端表名）。'."\n" + .'- variables：为重命名转换规则表达式中各变量的生成规则，参数默认值为对应含义在源端的原始值，可按需定义一组字符串替换规则对原始值进行改写。variableName：变量名，不含${}。variableRules：变量生成规则组，按顺序串行执行替换，from原始字符串；to替换后字符串。'."\n" + ."\n\n" + .'在目标端增加指定列并赋值规则（AddColumn）示例：'."\n" + .'{"columns":\\[{"columnName":"my_add_column","columnValueType":"Constant","columnValue":"123"}\\]}'."\n" + .'- 如不指定，默认规则为不加列不复制。'."\n" + .'- columnName：附加的列名称。'."\n" + .'- columnValueType：附加的列取值类型，包括Constant（常量）、Variable（变量）。'."\n" + .'- columnValue：附加的列取值。当valueType=Constant时，value为自定义常量，String类型。当valueType=Variable时，value为内置变量。内置变量可选值包括：EXECUTE_TIME（执行时间，Long类型）、DB_NAME_SRC（源端数据库名称，String类型）、DATASOURCE_NAME_SRC（源端数据源名称，String类型）、TABLE_NAME_SRC（源端表名，String类型）、DB_NAME_DEST（目标端数据库名称，String类型）、DATASOURCE_NAME_DEST（目标端数据源名称，String类型）、TABLE_NAME_DEST（目标端表名，String类型）、DB_NAME_SRC_TRANSED（转换后的数据库名称，String类型）。'."\n" + ."\n" + .'指定目标端表的主键列列名（DefinePrimaryKey）示例：'."\n" + .'{"columns":\\["ukcolumn1","ukcolumn2"\\]}'."\n" + .'- 如不指定默认使用源端主键列。'."\n" + .'- 当目标端为已有表：数据集成系统不会修改目标端表结构，如果指定的主键列不在目标端的列集合中，任务启动会报错提示。'."\n" + .'- 当目标端为自动建表：数据集成系统会自动创建目标端表结构，表结构包含定义的主键列。当指定的主键列不在目标端的列集合中时，任务启动会报错提示。'."\n" + ."\n" + .'DML处理规则（HandleDml）示例：'."\n" + .'{"dmlPolicies":\\[{"dmlType":"Delete","dmlAction":"Filter","filterCondition":"id > 1"}\\]}'."\n" + .'- 如不指定，默认规则为Insert、Update、Delete均为Normal'."\n" + .'- dmlType：DML操作类型，Insert（插入）、Update（更新）、Delete（删除）'."\n" + .'- dmlAction：DML处理策略，Normal（正常处理）、Ignore（忽略）、Filter（有条件的正常处理，当dmlType=Update/Delete时使用）、LogicalDelete（逻辑删除）'."\n" + .'- filterCondition：DML过滤条件，当dmlAction=Filter时使用', + 'type' => 'string', + 'required' => false, + 'example' => '{"expression":"${srcDatasoureName}_${srcDatabaseName}"}', + ], + ], + 'required' => false, + ], + 'required' => false, + ], + ], + [ + 'name' => 'TableMappings', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'description' => '同步对象转换映射列表，列表中每个元素描述了一组源端同步对象选择规则列表和在该组同步对象上应用的同步对象转换规则列表。', + 'type' => 'array', + 'items' => [ + 'description' => '同步对象转换映射。', + 'type' => 'object', + 'properties' => [ + 'SourceObjectSelectionRules' => [ + 'description' => '源端对象选择规则，支持多条。', + 'type' => 'array', + 'items' => [ + 'description' => '每条规则可选择待同步源端对象的不同对象类型，如选择源端数据库、源端数据表。', + 'type' => 'object', + 'properties' => [ + 'ObjectType' => [ + 'description' => '对象类型，可选的枚举值：'."\n" + .'- Table（表）'."\n" + .'- Database（数据库）', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [], + 'example' => 'Table', + ], + 'Expression' => [ + 'description' => '表达式。', + 'type' => 'string', + 'required' => false, + 'example' => 'mysql_table_1', + ], + ], + 'required' => false, + ], + 'required' => false, + ], + 'TransformationRules' => [ + 'description' => '源端对象上应用的转换规则列表。', + 'type' => 'array', + 'items' => [ + 'description' => '源端对象上应用的转换规则。', + 'type' => 'object', + 'properties' => [ + 'RuleName' => [ + 'description' => '规则名称，在一种动作类型+动作作用的目标类型下规则名称唯一。', + 'type' => 'string', + 'required' => false, + 'example' => 'rename_rule_1', + ], + 'RuleActionType' => [ + 'description' => '动作类型，可选的枚举值：'."\n" + .'- DefinePrimaryKey（定义主键）'."\n" + .'- Rename（重命名）'."\n" + .'- AddColumn（增加列）'."\n" + .'- HandleDml（DML处理）'."\n" + .'- DefineIncrementalCondition（定义增量条件）'."\n" + .'- DefineCycleScheduleSettings（定义周期调度设置）'."\n" + .'- DefineRuntimeSettings（定义高级配置参数）'."\n" + .'- DefinePartitionKey（定义分区列）', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [], + 'example' => 'Rename', + ], + 'RuleTargetType' => [ + 'description' => '动作作用的目标类型，可选的枚举值：'."\n" + .'- Table（表）'."\n" + .'- Schema（schema）', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [], + 'example' => 'Table', + ], + ], + 'required' => false, + ], + 'required' => false, + ], + ], + 'required' => false, + ], + 'required' => false, + ], + ], + [ + 'name' => 'JobSettings', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'description' => '同步任务维度的设置，含DDL处理策略、源端和目标端列数据类型映射策略、任务运行时参数等。', + 'type' => 'object', + 'properties' => [ + 'DdlHandlingSettings' => [ + 'description' => 'DDL处理设置。', + 'type' => 'array', + 'items' => [ + 'description' => 'DDL处理设置。', + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'description' => 'DDL类型，可选的枚举值：'."\n" + .'- RenameColumn（重命名列）'."\n" + .'- ModifyColumn（重命名列）'."\n" + .'- CreateTable（重命名列）'."\n" + .'- TruncateTable（清空表）'."\n" + .'- DropTable（删除表）'."\n" + .'- DropColumn（删除列）'."\n" + .'- AddColumn（新增列）', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [], + 'example' => 'AddColumn', + ], + 'Action' => [ + 'description' => '处理动作，可选的枚举值：'."\n" + .' '."\n" + .'- Ignore（忽略）'."\n" + .'- Critical（报错）'."\n" + .'- Normal（正常处理）', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [], + 'example' => 'Critical', + ], + ], + 'required' => false, + ], + 'required' => false, + ], + 'ColumnDataTypeSettings' => [ + 'description' => '列类型映射，多值。', + 'type' => 'array', + 'items' => [ + 'description' => '列类型映射。', + 'type' => 'object', + 'properties' => [ + 'SourceDataType' => [ + 'description' => '源端类型。', + 'type' => 'string', + 'required' => false, + 'example' => 'bigint', + ], + 'DestinationDataType' => [ + 'description' => '目标端类型。', + 'type' => 'string', + 'required' => false, + 'example' => 'text', + ], + ], + 'required' => false, + ], + 'required' => false, + ], + 'RuntimeSettings' => [ + 'description' => '运行时设置，多值。', + 'type' => 'array', + 'items' => [ + 'description' => '运行时设置。', + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'description' => '设置名称，可选的枚举值：'."\n" + .'- runtime.offline.speed.limit.mb（离线批量任务限流大小，当runtime.offline.speed.limit.enable=true时有效）'."\n" + .'- runtime.offline.speed.limit.enable（离线批量任务是否开启限流）'."\n" + .'- dst.offline.connection.max（离线批量任务写端最大连接数）'."\n" + .'- runtime.offline.concurrent（离线批量同步任务并发度）'."\n" + .'- dst.realtime.connection.max（实时任务写端最大连接数）'."\n" + .'- runtime.enable.auto.create.schema（是否自动在目标端创建schema）'."\n" + .'- src.offline.datasource.max.connection（离线批量任务源端最大连接数）'."\n" + .'- runtime.realtime.concurrent（实时任务并发度）', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [], + 'example' => 'runtime.offline.concurrent', + ], + 'Value' => [ + 'description' => '设置取值。', + 'type' => 'string', + 'required' => false, + 'example' => '1', + ], + ], + 'required' => false, + ], + 'required' => false, + ], + 'CycleScheduleSettings' => [ + 'description' => '周期调度设置。', + 'type' => 'object', + 'properties' => [ + 'CycleMigrationType' => [ + 'description' => '需要周期调度的同步类型。取值范围：'."\n" + .'- Full：全量'."\n" + .'- OfflineIncremental：离线增量', + 'type' => 'string', + 'required' => false, + 'example' => 'Full', + ], + 'ScheduleParameters' => [ + 'description' => '调度参数。', + 'type' => 'string', + 'required' => false, + 'example' => 'bizdate=$bizdate'."\n", + ], + ], + 'required' => false, + ], + 'ChannelSettings' => [ + 'description' => '通道相关任务设置，Json String形式。', + 'type' => 'string', + 'required' => false, + 'example' => '{"structInfo":"MANAGED","storageType":"TEXTFILE","writeMode":"APPEND","partitionColumns":[{"columnName":"pt","columnType":"STRING","comment":""}],"fieldDelimiter":""}'."\n", + ], + 'ImportRuleSettings' => [ + 'description' => '同步任务导入设置。', + 'type' => 'object', + 'properties' => [ + 'Source' => [ + 'description' => '任务配置导入来源。取值范围：'."\n" + .'Datastudio：数据开发中的同步任务', + 'type' => 'string', + 'required' => false, + 'example' => 'Datastudio', + ], + 'FileId' => [ + 'description' => '待导入任务ID。', + 'type' => 'string', + 'required' => false, + 'example' => '10000', + ], + ], + 'required' => false, + ], + ], + 'required' => false, + ], + ], + [ + 'name' => 'SystemDebug', + 'in' => 'query', + 'schema' => [ + 'description' => '系统调试使用，默认false。', + 'type' => 'string', + 'required' => false, + 'example' => 'false', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '返回数据。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求的ID。用于定位日志，排查问题。', + 'type' => 'string', + 'example' => '4F6AB6B3-41FB-5EBB-AFB2-0C98D49DA2BB', + ], + 'DIJobId' => [ + 'description' => '数据集成任务ID。', + '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' => '创建数据集成新版任务', + ], + 'DeleteDIJob' => [ + 'summary' => '删除数据集成新版任务，当前支持的任务类型包括：MySQL到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' => '任务ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '11126', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '响应。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + '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' => '删除数据集成新版任务', + ], + 'GetDIJob' => [ + 'summary' => '查看数据集成新版任务，当前支持的任务类型包括：MySQL到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' => '任务ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '11588', + ], + ], + [ + 'name' => 'WithDetails', + 'in' => 'formData', + 'schema' => [ + 'description' => '是否返回详细配置信息，详细配置信息包括TransformationRules、TableMappings、JobSettings。默认返回。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '响应。', + 'type' => 'object', + 'properties' => [ + 'Data' => [ + 'description' => '任务信息。', + 'type' => 'object', + 'properties' => [ + 'ProjectId' => [ + 'description' => '工作空间的ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '22', + ], + 'DIJobId' => [ + 'description' => '任务ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '11588', + ], + 'JobName' => [ + 'description' => '任务名称。', + 'type' => 'string', + 'example' => 'mysql_to_holo_sync_445', + ], + 'Description' => [ + 'description' => '描述信息。', + 'type' => 'string', + 'example' => 'Synchronize mysql to hologres'."\n", + ], + 'MigrationType' => [ + 'description' => '同步类型，可选的枚举值有：'."\n" + .'- FullAndRealtimeIncremental（全量和实时增量）'."\n" + .'- RealtimeIncremental（实时增量）'."\n" + .'- Full（全量）'."\n" + .'- OfflineIncremental（离线增量）'."\n" + .'- FullAndOfflineIncremental（全量+离线增量）', + 'type' => 'string', + 'enumValueTitles' => [], + 'example' => 'FullAndRealtimeIncremental', + ], + 'SourceDataSourceType' => [ + 'description' => '源端数据源类型，枚举值：MySQL。', + 'type' => 'string', + 'enumValueTitles' => [], + 'example' => 'MySQL', + ], + 'DestinationDataSourceType' => [ + 'description' => '目标端数据源类型，枚举值：Hologres、Hive。', + 'type' => 'string', + 'enumValueTitles' => [], + 'example' => 'Hologres', + ], + 'SourceDataSourceSettings' => [ + 'description' => '源端数据源设置，目前仅支持单个数据源。', + 'type' => 'array', + 'items' => [ + 'description' => '源端数据源设置。', + 'type' => 'object', + 'properties' => [ + 'DataSourceName' => [ + 'description' => '数据源名称。', + 'type' => 'string', + 'example' => 'mysql_datasource_1', + ], + 'DataSourceProperties' => [ + 'description' => '数据源属性。', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'string', + 'description' => '源端数据源属性。 MySQL数据源支持的属性名称包括：TimeZone（时区），Encoding（编码）。', + 'example' => 'TimeZone', + ], + ], + ], + ], + ], + 'DestinationDataSourceSettings' => [ + 'description' => '目标端数据源设置，目前仅支持单个数据源。', + 'type' => 'array', + 'items' => [ + 'description' => '目标端数据源设置。', + 'type' => 'object', + 'properties' => [ + 'DataSourceName' => [ + 'description' => '数据源名称。', + 'type' => 'string', + 'example' => 'holo_datasource_1', + ], + 'DataSourceProperties' => [ + 'description' => '数据源属性。', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'string', + 'example' => 'TimeZone', + 'description' => '目标端数据源属性。Hologres数据源暂无属性可设置。', + ], + ], + ], + ], + ], + 'ResourceSettings' => [ + 'description' => '资源设置。', + 'type' => 'object', + 'properties' => [ + 'OfflineResourceSettings' => [ + 'description' => '离线同步资源。', + 'type' => 'object', + 'properties' => [ + 'ResourceGroupIdentifier' => [ + 'description' => '离线同步使用的数据集成资源组标识。', + 'type' => 'string', + 'example' => 'S_res_group_111_222', + ], + ], + ], + 'RealtimeResourceSettings' => [ + 'description' => '实时同步资源。', + 'type' => 'object', + 'properties' => [ + 'ResourceGroupIdentifier' => [ + 'description' => '实时同步使用的数据集成资源组标识。', + 'type' => 'string', + 'example' => 'S_res_group_111_222', + ], + ], + ], + 'RequestedCu' => [ + 'description' => '增全量同步任务使用的资源组cu。', + 'type' => 'number', + 'format' => 'float', + 'example' => '2.0', + ], + ], + ], + 'TransformationRules' => [ + 'description' => '同步对象转换规则定义列表，列表中每个元素为一条转换规则定义。', + 'type' => 'array', + 'items' => [ + 'description' => '同步对象转换规则定义。', + 'type' => 'object', + 'properties' => [ + 'RuleActionType' => [ + 'description' => '动作类型，可选的枚举值：'."\n" + .'- DefinePrimaryKey（定义主键）'."\n" + .'- Rename（重命名）'."\n" + .'- AddColumn（增加列）'."\n" + .'- HandleDml（DML处理）'."\n" + .'- DefineIncrementalCondition（定义增量条件）'."\n" + .'- DefineCycleScheduleSettings（定义周期调度设置）'."\n" + .'- DefineRuntimeSettings（定义高级配置参数）'."\n" + .'- DefinePartitionKey（定义分区列）', + 'type' => 'string', + 'enumValueTitles' => [], + 'example' => 'Rename', + ], + 'RuleExpression' => [ + 'description' => '规则表达式，json string格式。'."\n" + ."\n" + .'- 重命名规则（Rename）示例： `{"expression":"${srcDatasourceName}_${srcDatabaseName}_0922","variables":\\[{"variableName":"srcDatabaseName","variableRules":\\[{"from":"fromdb","to":"todb"}\\]}\\]}`'."\n" + ."\n" + .' - expression：为重命名转换规则表达式，表达式内支持变量包括：'."\n" + .' - ${srcDatasourceName}（源端数据源名）'."\n" + .' - ${srcDatabaseName}（源端库名）'."\n" + .' - ${srcTableName}（源端表名）'."\n" + .' - variables：为重命名转换规则表达式中各变量的生成规则，参数默认值为对应含义在源端的原始值，可按需定义一组字符串替换规则对原始值进行改写。'."\n" + .' - variableName：变量名，不含${}。'."\n" + .' - variableRules：变量生成规则组，按顺序串行执行替换，from原始字符串；to替换后字符串。'."\n" + ."\n" + .'- 在目标端增加指定列并赋值规则（AddColumn）示例：` {"columns":\\[{"columnName":"my_add_column","columnValueType":"Constant","columnValue":"123"}\\]}`'."\n" + ."\n" + .' 如不指定，默认规则为不加列不复制。'."\n" + .' - columnName：附加的列名称。'."\n" + .' - columnValueType：附加的列取值类型，包括Constant（常量）、Variable（变量）。'."\n" + .' - columnValue：附加的列取值。'."\n" + .' - 当valueType=Constant时，value为自定义常量，String类型。'."\n" + .' - 当valueType=Variable时，value为内置变量。内置变量可选值包括：EXECUTE_TIME（执行时间，Long类型）、DB_NAME_SRC（源端数据库名称，String类型）、DATASOURCE_NAME_SRC（源端数据源名称，String类型）、TABLE_NAME_SRC（源端表名，String类型）、DB_NAME_DEST（目标端数据库名称，String类型）、DATASOURCE_NAME_DEST（目标端数据源名称，String类型）、TABLE_NAME_DEST（目标端表名，String类型）、DB_NAME_SRC_TRANSED（转换后的数据库名称，String类型）。'."\n" + ."\n" + .'- 指定目标端表的主键列列名（DefinePrimaryKey）示例：` {"columns":\\["ukcolumn1","ukcolumn2"\\]}`'."\n" + ."\n" + .' 如不指定默认使用源端主键列。'."\n" + .' - 当目标端为已有表：数据集成系统不会修改目标端表结构，如果指定的主键列不在目标端的列集合中，任务启动会报错提示。'."\n" + .' - 当目标端为自动建表：数据集成系统会自动创建目标端表结构，表结构包含定义的主键列。当指定的主键列不在目标端的列集合中时，任务启动会报错提示。'."\n" + ."\n" + .'- DML处理规则（HandleDml）示例： `{"dmlPolicies":\\[{"dmlType":"Delete","dmlAction":"Filter","filterCondition":"id > 1"}\\]}`'."\n" + ."\n" + .' 如不指定，默认规则为Insert、Update、Delete均为Normal。'."\n" + .' - dmlType：DML操作类型，Insert（插入）、Update（更新）、Delete（删除）。'."\n" + .' - dmlAction：DML处理策略，Normal（正常处理）、Ignore（忽略）、Filter（有条件的正常处理，当dmlType=Update/Delete时使用）、LogicalDelete（逻辑删除）。'."\n" + .' - filterCondition：DML过滤条件，当dmlAction=Filter时使用。', + 'type' => 'string', + 'example' => '{"expression":"${srcDatasoureName}_${srcDatabaseName}"}', + ], + 'RuleName' => [ + 'description' => '规则名称，当动作类型和动作作用的目标类型相同时，规则名称需保证唯一性。', + 'type' => 'string', + 'example' => 'rename_rule_1', + ], + 'RuleTargetType' => [ + 'description' => '动作作用的目标类型，可选的数据类型有：'."\n" + .'- Table（表）'."\n" + .'- Schema（schema）', + 'type' => 'string', + 'enumValueTitles' => [], + 'example' => 'Table', + ], + ], + ], + ], + 'TableMappings' => [ + 'description' => '同步对象转换映射列表，列表中每个元素描述了一组源端同步对象选择规则列表和在该组同步对象上应用的同步对象转换规则列表。', + 'type' => 'array', + 'items' => [ + 'description' => '同步对象转换映射。', + 'type' => 'object', + 'properties' => [ + 'SourceObjectSelectionRules' => [ + 'description' => '源端对象选择规则，支持多条。', + 'type' => 'array', + 'items' => [ + 'description' => '每条规则可选择待同步源端对象的不同对象类型，如选择源端数据库、源端数据表。', + 'type' => 'object', + 'properties' => [ + 'Expression' => [ + 'description' => '表达式。', + 'type' => 'string', + 'example' => 'mysql_table_1', + ], + 'ObjectType' => [ + 'description' => '对象类型，可选的枚举值有：'."\n" + .'- Table（表）'."\n" + .'- Database（数据库）', + 'type' => 'string', + 'enumValueTitles' => [], + 'example' => 'Table', + ], + ], + ], + ], + 'TransformationRules' => [ + 'description' => '源端对象上应用的转换规则列表。', + 'type' => 'array', + 'items' => [ + 'description' => '源端对象上应用的转换规则。', + 'type' => 'object', + 'properties' => [ + 'RuleActionType' => [ + 'description' => '动作类型，可选的枚举值：'."\n" + .'- DefinePrimaryKey（定义主键）'."\n" + .'- Rename（重命名）'."\n" + .'- AddColumn（增加列）'."\n" + .'- HandleDml（DML处理）'."\n" + .'- DefineIncrementalCondition（定义增量条件）'."\n" + .'- DefineCycleScheduleSettings（定义周期调度设置）'."\n" + .'- DefineRuntimeSettings（定义高级配置参数）'."\n" + .'- DefinePartitionKey（定义分区列）', + 'type' => 'string', + 'enumValueTitles' => [], + 'example' => 'Rename', + ], + 'RuleName' => [ + 'description' => '规则名称，在一种动作类型+动作作用的目标类型下规则名称唯一。', + 'type' => 'string', + 'example' => 'rename_rule_1', + ], + 'RuleTargetType' => [ + 'description' => '动作作用的目标类型，可选的枚举值有：'."\n" + .'- Table（表）'."\n" + .'- Schema（schema）', + 'type' => 'string', + 'enumValueTitles' => [], + 'example' => 'Table', + ], + ], + ], + ], + ], + ], + ], + 'JobSettings' => [ + 'description' => '同步任务维度的设置，含DDL处理策略、源端和目标端列数据类型映射策略、任务运行时参数等。', + 'type' => 'object', + 'properties' => [ + 'ColumnDataTypeSettings' => [ + 'description' => '列类型映射，支持多值。', + 'type' => 'array', + 'items' => [ + 'description' => '列类型映射。', + 'type' => 'object', + 'properties' => [ + 'SourceDataType' => [ + 'description' => '源端类型。', + 'type' => 'string', + 'example' => 'bigint', + ], + 'DestinationDataType' => [ + 'description' => '目标端类型。', + 'type' => 'string', + 'example' => 'text', + ], + ], + ], + ], + 'DdlHandlingSettings' => [ + 'description' => 'DDL处理设置，支持多值。', + 'type' => 'array', + 'items' => [ + 'description' => 'DDL处理设置。', + 'type' => 'object', + 'properties' => [ + 'Action' => [ + 'description' => '处理动作，可选的枚举值：'."\n" + .'- Ignore（忽略）'."\n" + .'- Critical（报错）'."\n" + .'- Normal（正常处理）', + 'type' => 'string', + 'enumValueTitles' => [], + 'example' => 'Critical', + ], + 'Type' => [ + 'description' => 'DDL类型，可选的枚举值：'."\n" + .'- RenameColumn（重命名列）'."\n" + .'- ModifyColumn（更新列）'."\n" + .'- CreateTable（新建表）'."\n" + .'- TruncateTable（清空表）'."\n" + .'- DropTable（删除表）'."\n" + .'- DropColumn（删除列）'."\n" + .'- AddColumn（新增列）', + 'type' => 'string', + 'enumValueTitles' => [], + 'example' => 'AddColumn', + ], + ], + ], + ], + 'RuntimeSettings' => [ + 'description' => '运行时设置，支持多值。', + 'type' => 'array', + 'items' => [ + 'description' => '运行时设置。', + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'description' => '设置名称，可选的枚举值：'."\n" + .'- runtime.offline.speed.limit.mb（离线批量任务限流大小，当runtime.offline.speed.limit.enable=true时有效）'."\n" + .'- runtime.offline.speed.limit.enable（离线批量任务是否开启限流）'."\n" + .'- dst.offline.connection.max（离线批量任务写端最大连接数）'."\n" + .'- runtime.offline.concurrent（离线批量同步任务并发度）'."\n" + .'- dst.realtime.connection.max（实时任务写端最大连接数）'."\n" + .'- runtime.enable.auto.create.schema（是否自动在目标端创建schema）'."\n" + .'- src.offline.datasource.max.connection（离线批量任务源端最大连接数）'."\n" + .'- runtime.realtime.concurrent（实时任务并发度）', + 'type' => 'string', + 'enumValueTitles' => [], + 'example' => 'runtime.offline.concurrent', + ], + 'Value' => [ + 'description' => '设置取值。', + 'type' => 'string', + 'example' => '1', + ], + ], + ], + ], + 'CycleScheduleSettings' => [ + 'description' => '周期调度设置。', + 'type' => 'object', + 'properties' => [ + 'CycleMigrationType' => [ + 'description' => '需要周期调度的同步类型。取值范围：'."\n" + .'- Full：全量'."\n" + .'- OfflineIncremental：离线增量', + 'type' => 'string', + 'example' => 'Full', + ], + 'ScheduleParameters' => [ + 'description' => '调度参数。', + 'type' => 'string', + 'example' => 'bizdate=$bizdate', + ], + ], + ], + 'ChannelSettings' => [ + 'description' => '通道相关任务设置，Json String形式。', + 'type' => 'string', + 'example' => '{"structInfo":"MANAGED","storageType":"TEXTFILE","writeMode":"APPEND","partitionColumns":[{"columnName":"pt","columnType":"STRING","comment":""}],"fieldDelimiter":""}'."\n", + ], + ], + ], + 'CreatedTime' => [ + 'description' => '创建时间戳，单位秒。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1671516776', + ], + 'CreatedUid' => [ + 'description' => '创建者用户ID。', + 'type' => 'string', + 'example' => '100000001', + ], + 'UpdatedTime' => [ + 'description' => '最近一次更新时间戳，单位秒。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1673859985', + ], + 'UpdatedUid' => [ + 'description' => '最近一次更新者用户ID。', + 'type' => 'string', + 'example' => '100000001', + ], + 'StartedTime' => [ + 'description' => '最近一次启动时间戳，单位秒。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1673859999', + ], + 'StartedUid' => [ + 'description' => '最近一次启动者用户ID。', + 'type' => 'string', + 'example' => '100000001', + ], + 'JobStatus' => [ + 'description' => '同步状态，可选的枚举值：'."\n" + .'- Finished（运行成功已结束）'."\n" + .'- Initialized（初始化完成）'."\n" + .'- Stopped（已停止）'."\n" + .'- Failed（运行失败）'."\n" + .'- Running（运行中）'."\n" + .'- Stopping（停止中）', + 'type' => 'string', + 'enumValueTitles' => [], + 'example' => 'Finished', + ], + 'ErrorMessage' => [ + 'description' => '错误信息，当JobStatus=Failed时使用。', + 'type' => 'string', + 'example' => 'error details xxx', + ], + 'RunStats' => [ + 'description' => '运行统计信息', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'string', + 'description' => '运行统计信息详情。'."\n" + .'- StructureMigrationTotalTables：结构同步表总数'."\n" + .'- StructureMigrationSuccessTables：结构同步表成功数'."\n" + .'- StructureMigrationFailedTables：结构同步表失败数'."\n" + .'- StructureMigrationStatus：结构同步状态，Waiting、Running、Finished、Failed、Stopped'."\n" + .'- StructureMigrationErrorMessage：结构同步错误信息'."\n" + .'- FullMigrationTotalTables：全量同步表总数'."\n" + .'- FullMigrationSuccessTables：全量同步表成功数'."\n" + .'- FullMigrationFailedTables：全量同步表失败数'."\n" + .'- FullMigrationStatus：全量同步状态'."\n" + .'- FullMigrationErrorMessage：全量同步错误信息'."\n" + .'- RealtimeMigrationMaxDelay：实时同步延迟时长，单位毫秒'."\n" + .'- RealtimeMigrationStatus：实时同步状态'."\n" + .'- RealtimeMigrationErrorMessage：实时已同步错误信息', + 'example' => 'StructureMigrationTotalTables', + ], + ], + ], + ], + 'RequestId' => [ + 'description' => '请求ID。', + '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' => '查看数据集成新版任务', + ], + 'ListDIJobs' => [ + 'summary' => '查询数据集成新版任务列表，当前支持的任务类型包括：MySQL到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' => '工作空间的ID。'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1967', + ], + ], + [ + 'name' => 'JobName', + 'in' => 'formData', + 'schema' => [ + 'description' => '任务名称，不填代表不限制，填写支持模糊查询。', + 'type' => 'string', + 'required' => false, + 'example' => 'mysql_to_holo_sync_8772', + ], + ], + [ + 'name' => 'SourceDataSourceType', + 'in' => 'formData', + 'schema' => [ + 'description' => '源端数据源类型，不填代表不限制。', + 'type' => 'string', + 'required' => false, + 'example' => 'MySQL', + ], + ], + [ + 'name' => 'DestinationDataSourceType', + 'in' => 'formData', + 'schema' => [ + 'description' => '目标端数据源类型，不填代表不限制。', + 'type' => 'string', + 'required' => false, + 'example' => 'Hologres', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'formData', + 'schema' => [ + 'description' => '页码，默认为1。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'formData', + 'schema' => [ + 'description' => '分页大小，默认为10，最大支持100。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '响应。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '7263E4AC-9D2E-5B29-B8AF-7C5012E92A41', + ], + 'DIJobPaging' => [ + 'description' => '任务分页结果。', + 'type' => 'object', + 'properties' => [ + 'TotalCount' => [ + 'description' => '总记录数。'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '6', + ], + 'PageNumber' => [ + 'description' => '页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '分页大小。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'DIJobs' => [ + 'description' => '任务列表。', + 'type' => 'array', + 'items' => [ + 'description' => '任务。', + 'type' => 'object', + 'properties' => [ + 'DIJobId' => [ + 'description' => '任务ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '16626', + ], + 'ProjectId' => [ + 'description' => '工作空间的ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1967', + ], + 'JobName' => [ + 'description' => '任务名称。', + 'type' => 'string', + 'example' => 'mysql_to_holo_sync_8772', + ], + 'MigrationType' => [ + 'description' => '同步类型，可选的枚举值有：'."\n" + .'- FullAndRealtimeIncremental（全量和实时增量）'."\n" + .'- RealtimeIncremental（实时增量）'."\n" + .'- Full（全量）', + 'type' => 'string', + 'enumValueTitles' => [ + 'FullAndRealtimeIncremental' => '全量和实时增量', + 'RealtimeIncremental' => '实时增量', + 'Full' => '全量', + ], + 'example' => 'Full', + ], + 'SourceDataSourceType' => [ + 'description' => '源端数据源类型，枚举值：MySQL。', + 'type' => 'string', + 'enumValueTitles' => [ + 'MySQL' => 'MySQL', + ], + 'example' => 'MySQL', + ], + 'DestinationDataSourceType' => [ + 'description' => '目标端数据源类型，枚举值：Hologres。', + 'type' => 'string', + 'enumValueTitles' => [ + 'Hologres' => 'Hologres', + ], + 'example' => 'Hologres', + ], + 'JobStatus' => [ + 'description' => '同步状态，可选的枚举值：'."\n" + .'- Finished（运行成功已结束）'."\n" + .'- Initialized（初始化完成）'."\n" + .'- Stopped（已停止）'."\n" + .'- Failed（运行失败）'."\n" + .'- Running（运行中）'."\n" + .'- Stopping（停止中）', + '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' => '查询数据集成新版任务列表', + 'description' => '此列表接口仅返回任务基础信息，如需查看任务详细信息，请调用单任务查询接口GetDIJob。', + ], + 'StartDIJob' => [ + 'summary' => '启动数据集成新版任务，当前支持的任务类型包括：MySQL到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' => '任务ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '11743', + ], + ], + [ + 'name' => 'RealtimeStartSettings', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'description' => '实时同步启动设置。', + 'type' => 'object', + 'properties' => [ + 'StartTime' => [ + 'description' => '实时同步起始位点时间戳，单位秒。不填默认为不重置位点。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1671516776', + ], + 'FailoverSettings' => [ + 'description' => 'Failover设置。', + 'type' => 'object', + 'properties' => [ + 'Interval' => [ + 'description' => 'Failover时间区间，单位分钟。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '10', + ], + 'UpperLimit' => [ + 'description' => 'Failover次数上限。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '30', + ], + ], + 'required' => false, + ], + ], + 'required' => false, + ], + ], + [ + 'name' => 'ForceToRerun', + 'in' => 'formData', + 'schema' => [ + 'description' => '是否强制重跑全部同步步骤。不填默认为不强制重跑。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '响应。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + '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' => '启动数据集成新版任务', + ], + 'StopDIJob' => [ + 'summary' => '停止数据集成新版任务，当前支持的任务类型包括：MySQL到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' => '任务ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '11668', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '响应。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + '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' => '停止数据集成新版任务', + ], + 'UpdateDIJob' => [ + 'summary' => '更新数据集成新版任务，当前支持的任务类型包括：MySQL到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' => '任务ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '11588', + ], + ], + [ + 'name' => 'Description', + 'in' => 'formData', + 'schema' => [ + 'description' => '任务描述。', + 'type' => 'string', + 'required' => false, + 'example' => 'mysql同步到hologres', + ], + ], + [ + 'name' => 'ResourceSettings', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'description' => '资源设置。', + 'type' => 'object', + 'properties' => [ + 'OfflineResourceSettings' => [ + 'description' => '离线同步资源。', + 'type' => 'object', + 'properties' => [ + 'ResourceGroupIdentifier' => [ + 'description' => '离线同步使用的数据集成资源组标识。', + 'type' => 'string', + 'required' => false, + 'example' => 'S_res_group_111_222', + ], + ], + 'required' => false, + ], + 'RealtimeResourceSettings' => [ + 'description' => '实时同步资源。', + 'type' => 'object', + 'properties' => [ + 'ResourceGroupIdentifier' => [ + 'description' => '实时同步使用的数据集成资源组标识。', + 'type' => 'string', + 'required' => false, + 'example' => 'S_res_group_111_222', + ], + ], + 'required' => false, + ], + 'RequestedCu' => [ + 'description' => '增全量同步任务使用的资源组 cu。', + 'type' => 'number', + 'format' => 'float', + 'required' => false, + 'example' => '2.0', + ], + ], + 'required' => false, + ], + ], + [ + 'name' => 'TransformationRules', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'description' => '同步对象转换规则定义列表，列表中每个元素为一条转换规则定义。', + 'type' => 'array', + 'items' => [ + 'description' => '同步对象转换规则定义。', + 'type' => 'object', + 'properties' => [ + 'RuleName' => [ + 'description' => '规则名称，当动作类型和动作作用的目标类型相同时，规则名称需保证唯一性。', + 'type' => 'string', + 'required' => false, + 'example' => 'rename_rule_1', + ], + 'RuleActionType' => [ + 'description' => '动作类型，可选的枚举值：'."\n" + .'- DefinePrimaryKey（定义主键）'."\n" + .'- Rename（重命名）'."\n" + .'- AddColumn（增加列）'."\n" + .'- HandleDml（DML处理）'."\n" + .'- DefineIncrementalCondition（定义增量条件）'."\n" + .'- DefineCycleScheduleSettings（定义周期调度设置）'."\n" + .'- DefineRuntimeSettings（定义高级配置参数）'."\n" + .'- DefinePartitionKey（定义分区列）', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [], + 'example' => 'Rename', + ], + 'RuleTargetType' => [ + 'description' => '动作作用的目标类型，可选的枚举值：'."\n" + .'- Table（表）'."\n" + .'- Schema（schema）', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [], + 'example' => 'Table', + ], + 'RuleExpression' => [ + 'description' => '规则表达式，json string格式。'."\n" + ."\n" + .'重命名规则（Rename）示例： {"expression":"${srcDatasourceName}_${srcDatabaseName}_0922","variables":\\[{"variableName":"srcDatabaseName","variableRules":\\[{"from":"fromdb","to":"todb"}\\]}\\]}'."\n" + ."\n" + .'expression：为重命名转换规则表达式，表达式内支持变量包括：${srcDatasourceName}（源端数据源名）、${srcDatabaseName}（源端库名）、${srcTableName}（源端表名）。'."\n" + .'variables：为重命名转换规则表达式中各变量的生成规则，参数默认值为对应含义在源端的原始值，可按需定义一组字符串替换规则对原始值进行改写。variableName：变量名，不含${}。variableRules：变量生成规则组，按顺序串行执行替换，from原始字符串；to替换后字符串。'."\n" + .'在目标端增加指定列并赋值规则（AddColumn）示例： {"columns":\\[{"columnName":"my_add_column","columnValueType":"Constant","columnValue":"123"}\\]}'."\n" + ."\n" + .'如不指定，默认规则为不加列不复制。'."\n" + .'columnName：附加的列名称。'."\n" + .'columnValueType：附加的列取值类型，包括Constant（常量）、Variable（变量）。'."\n" + .'columnValue：附加的列取值。当valueType=Constant时，value为自定义常量，String类型。当valueType=Variable时，value为内置变量。内置变量可选值包括：EXECUTE_TIME（执行时间，Long类型）、DB_NAME_SRC（源端数据库名称，String类型）、DATASOURCE_NAME_SRC（源端数据源名称，String类型）、TABLE_NAME_SRC（源端表名，String类型）、DB_NAME_DEST（目标端数据库名称，String类型）、DATASOURCE_NAME_DEST（目标端数据源名称，String类型）、TABLE_NAME_DEST（目标端表名，String类型）、DB_NAME_SRC_TRANSED（转换后的数据库名称，String类型）。'."\n" + .'指定目标端表的主键列列名（DefinePrimaryKey）示例： {"columns":\\["ukcolumn1","ukcolumn2"\\]}'."\n" + ."\n" + .'如不指定默认使用源端主键列。'."\n" + .'当目标端为已有表：数据集成系统不会修改目标端表结构，如果指定的主键列不在目标端的列集合中，任务启动会报错提示。'."\n" + .'当目标端为自动建表：数据集成系统会自动创建目标端表结构，表结构包含定义的主键列。当指定的主键列不在目标端的列集合中时，任务启动会报错提示。'."\n" + .'DML处理规则（HandleDml）示例： {"dmlPolicies":\\[{"dmlType":"Delete","dmlAction":"Filter","filterCondition":"id > 1"}\\]}'."\n" + ."\n" + .'如不指定，默认规则为Insert、Update、Delete均为Normal'."\n" + .'dmlType：DML操作类型，Insert（插入）、Update（更新）、Delete（删除）'."\n" + .'dmlAction：DML处理策略，Normal（正常处理）、Ignore（忽略）、Filter（有条件的正常处理，当dmlType=Update/Delete时使用）、LogicalDelete（逻辑删除）'."\n" + .'filterCondition：DML过滤条件，当dmlAction=Filter时使用', + 'type' => 'string', + 'required' => false, + 'example' => '{"expression":"${srcDatasoureName}_${srcDatabaseName}"}', + ], + ], + 'required' => false, + ], + 'required' => false, + ], + ], + [ + 'name' => 'TableMappings', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'description' => '同步对象转换映射列表，列表中每个元素描述了一组源端同步对象选择规则列表和在该组同步对象上应用的同步对象转换规则列表。', + 'type' => 'array', + 'items' => [ + 'description' => '同步对象转换映射。', + 'type' => 'object', + 'properties' => [ + 'SourceObjectSelectionRules' => [ + 'description' => '源端对象选择规则，支持多条。', + 'type' => 'array', + 'items' => [ + 'description' => '每条规则可选择待同步源端对象的不同对象类型，如选择源端数据库、源端数据表。', + 'type' => 'object', + 'properties' => [ + 'ObjectType' => [ + 'description' => '对象类型，可选的枚举值：'."\n" + .'- Table（表）'."\n" + .'- Database（数据库）', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [], + 'example' => 'Table', + ], + 'Expression' => [ + 'description' => '表达式。', + 'type' => 'string', + 'required' => false, + 'example' => 'mysql_table_1', + ], + ], + 'required' => false, + ], + 'required' => false, + ], + 'TransformationRules' => [ + 'description' => '源端对象上应用的转换规则列表。', + 'type' => 'array', + 'items' => [ + 'description' => '源端对象上应用的转换规则。', + 'type' => 'object', + 'properties' => [ + 'RuleName' => [ + 'description' => '规则名称，在一种动作类型+动作作用的目标类型下规则名称唯一。', + 'type' => 'string', + 'required' => false, + 'example' => 'rename_rule_1', + ], + 'RuleActionType' => [ + 'description' => '动作类型，可选的枚举值：'."\n" + .'- DefinePrimaryKey（定义主键）'."\n" + .'- Rename（重命名）'."\n" + .'- AddColumn（增加列）'."\n" + .'- HandleDml（DML处理）'."\n" + .'- DefineIncrementalCondition（定义增量条件）'."\n" + .'- DefineCycleScheduleSettings（定义周期调度设置）'."\n" + .'- DefineRuntimeSettings（定义高级配置参数）'."\n" + .'- DefinePartitionKey（定义分区列）', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [], + 'example' => 'Rename', + ], + 'RuleTargetType' => [ + 'description' => '动作作用的目标类型，可选的枚举值;'."\n" + .'- Table（表）'."\n" + .'- Schema（schema）', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [], + 'example' => 'Table', + ], + ], + 'required' => false, + ], + 'required' => false, + ], + ], + 'required' => false, + ], + 'required' => false, + ], + ], + [ + 'name' => 'JobSettings', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'description' => '同步任务维度的设置，含DDL处理策略、源端和目标端列数据类型映射策略、任务运行时参数等。', + 'type' => 'object', + 'properties' => [ + 'DdlHandlingSettings' => [ + 'description' => 'DDL处理设置，支持多值。', + 'type' => 'array', + 'items' => [ + 'description' => 'DDL处理设置。', + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'description' => 'DDL类型，可选的枚举值;'."\n" + .'- RenameColumn（重命名列）'."\n" + .'- ModifyColumn（更新列）'."\n" + .'- CreateTable（新建表）'."\n" + .'- TruncateTable（清空表）'."\n" + .'- DropTable（删除表）'."\n" + .'- DropColumn（删除列）'."\n" + .'- AddColumn（新增列）', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [], + 'example' => 'AddColumn', + ], + 'Action' => [ + 'description' => '处理动作，可选的枚举值：'."\n" + .'- Ignore（忽略）'."\n" + .'- Critical（报错）'."\n" + .'- Normal（正常处理）', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [], + 'example' => 'Critical', + ], + ], + 'required' => false, + ], + 'required' => false, + ], + 'ColumnDataTypeSettings' => [ + 'description' => '列类型映射，支持多值。', + 'type' => 'array', + 'items' => [ + 'description' => '列类型映射。', + 'type' => 'object', + 'properties' => [ + 'SourceDataType' => [ + 'description' => '源端类型。', + 'type' => 'string', + 'required' => false, + 'example' => 'bigint', + ], + 'DestinationDataType' => [ + 'description' => '目标端类型。', + 'type' => 'string', + 'required' => false, + 'example' => 'text', + ], + ], + 'required' => false, + ], + 'required' => false, + ], + 'RuntimeSettings' => [ + 'description' => '运行时设置，支持多值。', + 'type' => 'array', + 'items' => [ + 'description' => '运行时设置。', + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'description' => '设置名称，可选的枚举值：'."\n" + .' '."\n" + .'- runtime.offline.speed.limit.mb（离线批量任务限流大小，当runtime.offline.speed.limit.enable=true时有效）'."\n" + .'- runtime.offline.speed.limit.enable（离线批量任务是否开启限流）'."\n" + .'- dst.offline.connection.max（离线批量任务写端最大连接数）'."\n" + .'- runtime.offline.concurrent（离线批量同步任务并发度）'."\n" + .'- dst.realtime.connection.max（实时任务写端最大连接数）'."\n" + .'- runtime.enable.auto.create.schema（是否自动在目标端创建schema）'."\n" + .'- src.offline.datasource.max.connection（离线批量任务源端最大连接数）'."\n" + .'- runtime.realtime.concurrent（实时任务并发度）', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [], + 'example' => 'runtime.offline.concurrent', + ], + 'Value' => [ + 'description' => '设置取值。', + 'type' => 'string', + 'required' => false, + 'example' => '1', + ], + ], + 'required' => false, + ], + 'required' => false, + ], + 'CycleScheduleSettings' => [ + 'description' => '周期调度设置。', + 'type' => 'object', + 'properties' => [ + 'ScheduleParameters' => [ + 'description' => '调度参数。', + 'type' => 'string', + 'required' => false, + 'example' => 'bizdate=$bizdate'."\n", + ], + ], + 'required' => false, + ], + 'ChannelSettings' => [ + 'description' => '通道相关任务设置，Json String形式。', + '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' => '响应。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + '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' => '更新数据集成新版任务', + ], + 'CreateDIAlarmRule' => [ + 'summary' => '创建数据集成新版任务告警规则，当前支持的任务类型包括：MySQL到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' => '任务ID，是告警规则关联的任务ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '11265', + ], + ], + [ + 'name' => 'Description', + 'in' => 'formData', + 'schema' => [ + 'description' => '描述。', + 'type' => 'string', + 'required' => false, + 'example' => 'mysql synchronizes to hologres heartbeat alert', + ], + ], + [ + 'name' => 'MetricType', + 'in' => 'formData', + 'schema' => [ + 'description' => '告警指标类型，可选的枚举值：'."\n" + .'- Heartbeat（任务状态报警）'."\n" + .'- FailoverCount（failover次数报警）'."\n" + .'- Delay（任务延迟报警）', + 'type' => 'string', + 'required' => true, + 'enumValueTitles' => [], + 'example' => 'Heartbeat', + ], + ], + [ + 'name' => 'TriggerConditions', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'description' => '告警触发条件列表，支持多条件。', + 'type' => 'array', + 'items' => [ + 'description' => '告警触发条件。', + 'type' => 'object', + 'properties' => [ + 'Severity' => [ + 'description' => '严重程度，可选的枚举值：'."\n" + .'- Warning'."\n" + .'- Critical', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [], + 'example' => 'Warning', + ], + 'Duration' => [ + 'description' => '告警计算时间区间，单位分钟。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '15', + ], + 'Threshold' => [ + 'description' => '告警阈值。'."\n" + .'- 任务状态报警：无需填写阈值。'."\n" + .'- failover次数报警：阈值为failover次数。'."\n" + .'- 任务延迟报警：阈值为延迟时长，单位秒。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '5', + ], + ], + 'required' => false, + ], + 'required' => true, + ], + ], + [ + 'name' => 'NotificationSettings', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'description' => '告警通知设置。', + 'type' => 'object', + 'properties' => [ + 'NotificationChannels' => [ + 'description' => '告警通知渠道，支持多值。', + 'type' => 'array', + 'items' => [ + 'description' => '告警通知渠道。', + 'type' => 'object', + 'properties' => [ + 'Severity' => [ + 'description' => '严重程度。'."\n" + .'- Warning'."\n" + .'- Critical', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [], + 'example' => 'Warning', + ], + 'Channels' => [ + 'description' => '通道列表。', + 'type' => 'array', + 'items' => [ + 'description' => '通道，可选的枚举值：'."\n" + .'- Mail（邮件）'."\n" + .'- Phone（电话）'."\n" + .'- Sms（短信）'."\n" + .'- Ding（钉钉）', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [], + 'example' => 'Ding', + ], + 'required' => false, + ], + ], + 'required' => false, + ], + 'required' => true, + ], + 'NotificationReceivers' => [ + 'description' => '告警通知接收方，支持多值。', + 'type' => 'array', + 'items' => [ + 'description' => '告警通知接收方。', + 'type' => 'object', + 'properties' => [ + 'ReceiverType' => [ + 'description' => '接收方类型。'."\n" + .'- 当告警通知渠道为邮件、电话、短信时，接收方类型选择阿里云用户ID（**AliyunUid**）。'."\n" + .'- 当告警通知渠道为钉钉时，接收方类型选择钉钉token（**DingToken**）。', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [], + 'example' => 'DingToken', + ], + 'ReceiverValues' => [ + 'description' => '接收方取值列表。', + 'type' => 'array', + 'items' => [ + 'description' => '接收方取值。'."\n" + .'- 当接收方类型为阿里云ID时，接收方取值为具体阿里云用户ID。'."\n" + .'- 当接收方类型为钉钉token时，接收方取值为具体钉钉token值。', + 'type' => 'string', + 'required' => false, + 'example' => 'token1', + ], + 'required' => false, + ], + ], + 'required' => false, + ], + 'required' => true, + ], + 'InhibitionInterval' => [ + 'description' => '告警抑制间隔时长，单位分钟，默认5分钟。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '5', + ], + ], + 'required' => true, + ], + ], + [ + 'name' => 'Enabled', + 'in' => 'formData', + 'schema' => [ + 'description' => '告警规则是否启用，默认不开启。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + 'default' => 'false', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '响应。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'C636A747-7E4E-594D-94CD-2B4F8A9A9A63', + ], + 'DIAlarmRuleId' => [ + 'description' => '告警规则ID。', + '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' => '创建数据集成新版任务告警规则', + 'description' => '当您的任务同步类型中包含实时同步时，支持设置告警规则。', + ], + 'DeleteDIAlarmRule' => [ + 'summary' => '删除数据集成新版任务告警规则，当前支持的任务类型包括：MySQL到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' => '告警规则ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '34971', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '响应。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + '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' => '删除数据集成新版任务告警规则', + 'description' => '当您的任务同步类型中包含实时同步时，支持设置告警规则。', + ], + 'GetDIAlarmRule' => [ + 'summary' => '查询数据集成新版任务告警规则，当前支持的任务类型包括：MySQL到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' => '告警规则ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '34994', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '响应。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '4A807D85-AC9F-55F7-A58F-998D5249CAD9', + ], + 'DIAlarmRule' => [ + 'description' => '告警规则。', + 'type' => 'object', + 'properties' => [ + 'DIAlarmRuleId' => [ + 'description' => '告警规则ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '34988', + ], + 'DIJobId' => [ + 'description' => '任务ID，是告警规则关联的任务ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '11170', + ], + 'Description' => [ + 'description' => '描述。', + 'type' => 'string', + 'example' => 'mysql synchronizes to hologres heartbeat alert', + ], + 'MetricType' => [ + 'description' => '告警指标类型，可选的枚举值：'."\n" + .'- Heartbeat（任务状态报警）'."\n" + .'- FailoverCount（failover次数报警）'."\n" + .'- Delay（任务延迟报警）', + 'type' => 'string', + 'enumValueTitles' => [], + 'example' => 'Heartbeat', + ], + 'Enabled' => [ + 'description' => '告警规则是否启用。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'TriggerConditions' => [ + 'description' => '告警触发条件列表，支持多条件。', + 'type' => 'array', + 'items' => [ + 'description' => '告警触发条件。', + 'type' => 'object', + 'properties' => [ + 'Severity' => [ + 'description' => '严重程度，可选的枚举值：'."\n" + .'- Warning'."\n" + .'- Critical', + 'type' => 'string', + 'enumValueTitles' => [], + 'example' => 'Warning', + ], + 'Duration' => [ + 'description' => '告警计算时间区间，单位分钟。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '15', + ], + 'Threshold' => [ + 'description' => '告警阈值。'."\n" + ."\n" + .'- 任务状态报警：无阈值。'."\n" + .'- failover次数报警：阈值为failover次数。'."\n" + .'- 任务延迟报警：阈值为延迟时长，单位秒。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '5', + ], + ], + ], + ], + 'NotificationSettings' => [ + 'description' => '告警通知设置。', + 'type' => 'object', + 'properties' => [ + 'NotificationChannels' => [ + 'description' => '告警通知渠道，支持多值。', + 'type' => 'array', + 'items' => [ + 'description' => '告警通知渠道。', + 'type' => 'object', + 'properties' => [ + 'Severity' => [ + 'description' => '严重程度，可选的枚举值：'."\n" + .'- Warning'."\n" + .'- Critical', + 'type' => 'string', + 'enumValueTitles' => [], + 'example' => 'Warning', + ], + 'Channels' => [ + 'description' => '通道列表。', + 'type' => 'array', + 'items' => [ + 'description' => '通道，可选的枚举值;'."\n" + .'- Mail（邮件）'."\n" + .'- Phone（电话）'."\n" + .'- Sms（短信）'."\n" + .'- Ding（钉钉）', + 'type' => 'string', + 'enumValueTitles' => [], + 'example' => 'Ding', + ], + ], + ], + ], + ], + 'NotificationReceivers' => [ + 'description' => '告警通知接收方，支持多值。', + 'type' => 'array', + 'items' => [ + 'description' => '告警通知接收方。', + 'type' => 'object', + 'properties' => [ + 'ReceiverType' => [ + 'description' => '接收方类型。'."\n" + ."\n" + .'- 当告警通知渠道为邮件、电话、短信时，接收方类型为阿里云用户ID（**AliyunUid**）。'."\n" + .'- 当告警通知渠道为钉钉时，接收方类型为钉钉token（**DingToken**）。', + 'type' => 'string', + 'enumValueTitles' => [], + 'example' => 'DingToken', + ], + 'ReceiverValues' => [ + 'description' => '接收方取值列表。', + 'type' => 'array', + 'items' => [ + 'description' => '接收方取值。'."\n" + ."\n" + .'- 当接收方类型为阿里云ID时，接收方取值为具体阿里云用户ID。'."\n" + .'- 当接收方类型为钉钉token时，接收方取值为具体钉钉token值。', + 'type' => 'string', + 'example' => 'token1', + ], + ], + ], + ], + ], + 'InhibitionInterval' => [ + 'description' => '告警抑制间隔时长，单位分钟。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '5', + ], + ], + ], + 'CreatedUid' => [ + 'description' => '告警规则创建者用户ID。', + 'type' => 'string', + 'example' => '10000001', + ], + 'CreatedTime' => [ + 'description' => '告警规则创建时间戳，单位秒。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1663573162', + ], + 'UpdatedUid' => [ + 'description' => '告警规则最近一次更新者用户ID。', + 'type' => 'string', + 'example' => '10000001', + ], + 'UpdatedTime' => [ + 'description' => '告警规则最近一次更新时间戳，单位秒。', + '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' => '查询数据集成新版任务告警规则', + 'description' => '当您的任务同步类型中包含实时同步时，支持设置告警规则。', + ], + 'ListDIAlarmRules' => [ + 'summary' => '查询数据集成新版任务告警规则列表，当前支持的任务类型包括：MySQL到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' => '任务ID，是告警规则关联的任务ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '11260', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'formData', + 'schema' => [ + 'description' => '页码，默认为1。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1', + 'default' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'formData', + 'schema' => [ + 'description' => '分页大小，默认为10。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '10', + 'default' => '10', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '响应。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '74C2FECD-5B3A-554A-BCF5-35****', + ], + 'DIAlarmRulePaging' => [ + 'description' => '告警规则分页结果。', + 'type' => 'object', + 'properties' => [ + 'TotalCount' => [ + 'description' => '总记录数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2', + ], + 'PageNumber' => [ + 'description' => '页码。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '分页大小。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10', + ], + 'DIJobAlarmRules' => [ + 'description' => '告警规则列表。', + 'type' => 'array', + 'items' => [ + 'description' => '告警规则。', + 'type' => 'object', + 'properties' => [ + 'DIAlarmRuleId' => [ + 'description' => '告警规则ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '41998', + ], + 'DIJobId' => [ + 'description' => '任务ID，是告警规则关联的任务ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '11260', + ], + 'Description' => [ + 'description' => '描述。', + 'type' => 'string', + 'example' => 'mysql synchronizes to hologres heartbeat alert', + ], + 'MetricType' => [ + 'description' => '告警指标类型，可选的枚举值：'."\n" + .'- Heartbeat（任务状态报警）'."\n" + .'- FailoverCount（failover次数报警）'."\n" + .'- Delay（任务延迟报警）', + 'type' => 'string', + 'enumValueTitles' => [], + 'example' => 'Heartbeat', + ], + 'Enabled' => [ + 'description' => '告警规则是否启用。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'TriggerConditions' => [ + 'description' => '告警触发条件列表，支持多条件。', + 'type' => 'array', + 'items' => [ + 'description' => '告警触发条件。', + 'type' => 'object', + 'properties' => [ + 'Severity' => [ + 'description' => '严重程度，可选的枚举值：'."\n" + .'- Warning'."\n" + .'- Critical', + 'type' => 'string', + 'enumValueTitles' => [], + 'example' => 'Warning', + ], + 'Duration' => [ + 'description' => '告警计算时间区间，单位分钟。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '15', + ], + 'Threshold' => [ + 'description' => '告警阈值。'."\n" + ."\n" + .'- 任务状态报警：无阈值。'."\n" + .'- failover次数报警：阈值为failover次数。'."\n" + .'- 任务延迟报警：阈值为延迟时长，单位秒。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '5', + ], + ], + ], + ], + 'NotificationSettings' => [ + 'description' => '告警通知设置。', + 'type' => 'object', + 'properties' => [ + 'NotificationChannels' => [ + 'description' => '告警通知渠道，支持多值。', + 'type' => 'array', + 'items' => [ + 'description' => '告警通知渠道。', + 'type' => 'object', + 'properties' => [ + 'Severity' => [ + 'description' => '严重程度，可选的枚举值：'."\n" + .'- Warning'."\n" + .'- Critical', + 'type' => 'string', + 'enumValueTitles' => [], + 'example' => 'Warning', + ], + 'Channels' => [ + 'description' => '通道列表。', + 'type' => 'array', + 'items' => [ + 'description' => '通道，可选的枚举值：'."\n" + .'- Mail（邮件）'."\n" + .'- Phone（电话）'."\n" + .'- Sms（短信）'."\n" + .'- Ding（钉钉）', + 'type' => 'string', + 'enumValueTitles' => [], + 'example' => 'Ding', + ], + ], + ], + ], + ], + 'NotificationReceivers' => [ + 'description' => '告警通知接收方，支持多值。', + 'type' => 'array', + 'items' => [ + 'description' => '告警通知接收方。', + 'type' => 'object', + 'properties' => [ + 'ReceiverType' => [ + 'description' => '接收方类型。'."\n" + ."\n" + .'- 当告警通知渠道为邮件、电话、短信时，接收方类型为阿里云用户ID（**AliyunUid**）。'."\n" + .'- 当告警通知渠道为钉钉时，接收方类型为钉钉token（**DingToken**）。', + 'type' => 'string', + 'enumValueTitles' => [], + 'example' => 'DingToken', + ], + 'ReceiverValues' => [ + 'description' => '接收方取值列表。', + 'type' => 'array', + 'items' => [ + 'description' => '接收方取值。'."\n" + ."\n" + .'- 当接收方类型为阿里云ID时，接收方取值为具体阿里云用户ID。'."\n" + .'- 当接收方类型为钉钉token时，接收方取值为具体钉钉token值。', + 'type' => 'string', + 'example' => 'token1', + ], + ], + ], + ], + ], + 'InhibitionInterval' => [ + 'description' => '告警抑制间隔时长，单位分钟。', + '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' => '查询数据集成新版任务告警规则列表', + 'description' => '当您的任务同步类型中包含实时同步时，支持设置告警规则。', + ], + 'UpdateDIAlarmRule' => [ + 'summary' => '更新数据集成新版任务告警规则，当前支持的任务类型包括：MySQL到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' => '告警规则ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '34982', + ], + ], + [ + 'name' => 'Description', + 'in' => 'formData', + 'schema' => [ + 'description' => '描述。', + 'type' => 'string', + 'required' => false, + 'example' => 'mysql synchronizes to hologres heartbeat alert', + ], + ], + [ + 'name' => 'MetricType', + 'in' => 'formData', + 'schema' => [ + 'description' => '告警指标类型，可选的枚举值：'."\n" + .'- Heartbeat（任务状态报警）'."\n" + .'- FailoverCount（failover次数报警）'."\n" + .'- Delay（任务延迟报警）', + 'type' => 'string', + 'required' => true, + 'enumValueTitles' => [], + 'example' => 'Heartbeat', + ], + ], + [ + 'name' => 'TriggerConditions', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'description' => '告警触发条件列表，支持多条件。', + 'type' => 'array', + 'items' => [ + 'description' => '告警触发条件。', + 'type' => 'object', + 'properties' => [ + 'Severity' => [ + 'description' => '严重程度，可选的枚举值;'."\n" + .'- Warning'."\n" + .'- Critical', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [], + 'example' => 'Warning', + ], + 'Duration' => [ + 'description' => '告警计算时间区间，单位分钟。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '15', + ], + 'Threshold' => [ + 'description' => '告警阈值。'."\n" + ."\n" + .'- 任务状态报警：无需填写阈值。'."\n" + .'- failover次数报警：阈值为failover次数。'."\n" + .'- 任务延迟报警：阈值为延迟时长，单位秒。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '5', + ], + ], + 'required' => false, + ], + 'required' => true, + ], + ], + [ + 'name' => 'NotificationSettings', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'description' => '告警通知设置。', + 'type' => 'object', + 'properties' => [ + 'NotificationChannels' => [ + 'description' => '告警通知渠道，支持多值。', + 'type' => 'array', + 'items' => [ + 'description' => '告警通知渠道。', + 'type' => 'object', + 'properties' => [ + 'Severity' => [ + 'description' => '严重程度，可选的枚举值：'."\n" + .'- Warning'."\n" + .'- Critical', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [], + 'example' => 'Warning', + ], + 'Channels' => [ + 'description' => '通道列表。', + 'type' => 'array', + 'items' => [ + 'description' => '通道，可选的枚举值：'."\n" + .'- Mail（邮件）'."\n" + .'- Phone（电话）'."\n" + .'- Sms（短信）'."\n" + .'- Ding（钉钉）', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [], + 'example' => 'Ding', + ], + 'required' => false, + ], + ], + 'required' => false, + ], + 'required' => true, + ], + 'NotificationReceivers' => [ + 'description' => '告警通知接收方，支持多值。', + 'type' => 'array', + 'items' => [ + 'description' => '告警通知接收方。', + 'type' => 'object', + 'properties' => [ + 'ReceiverType' => [ + 'description' => '接收方类型。'."\n" + ."\n" + .'- 当告警通知渠道为邮件、电话、短信时，接收方类型选择阿里云用户ID。'."\n" + .'- 当告警通知渠道为钉钉时，接收方类型选择钉钉token。', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [], + 'example' => 'DingToken', + ], + 'ReceiverValues' => [ + 'description' => '接收方取值列表。', + 'type' => 'array', + 'items' => [ + 'description' => '接收方取值。'."\n" + ."\n" + .'- 当接收方类型为阿里云ID时，接收方取值为具体阿里云用户ID。'."\n" + .'- 当接收方类型为钉钉token时，接收方取值为具体钉钉token值。', + 'type' => 'string', + 'required' => false, + 'example' => 'token1', + ], + 'required' => false, + ], + ], + 'required' => false, + ], + 'required' => true, + ], + 'InhibitionInterval' => [ + 'description' => '告警抑制间隔时长，单位分钟，默认5分钟。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '5', + ], + ], + 'required' => true, + ], + ], + [ + 'name' => 'Enabled', + 'in' => 'formData', + 'schema' => [ + 'description' => '告警规则是否启用，默认不开启。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '响应。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + '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' => '更新数据集成新版任务告警规则', + 'description' => '当您的任务同步类型中包含实时同步时，支持设置告警规则。'."\n" + .'告警规则更新为全字段更新，不支持部分字段更新。', + ], + 'QueryPublicModelEngine' => [ + 'summary' => '使用FML语句查询数据建模引擎的信息。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'Text', + 'in' => 'formData', + 'schema' => [ + 'description' => '输入查询引擎信息的FML语句，详情请参见[使用FML语句配置并管理数据表](~~298128~~)。'."\n" + .'当前仅支持show语句。'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'show dim tables', + ], + ], + [ + 'name' => 'ProjectId', + 'in' => 'formData', + 'schema' => [ + 'description' => 'DataWorks工作空间的ID。您可以登录[DataWorks控制台](https://workbench.data.aliyun.com/console)，进入工作空间管理页面获取ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '1234', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '是调用FML语句查询返回的结果。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用的唯一ID。出现错误后，您可以根据该ID排查问题。', + 'type' => 'string', + 'example' => '4CFB2DED-7D9B-4C42-B4AA-CFF4991DFFF4', + ], + 'ReturnValue' => [ + 'description' => '是通过FML语句查询返回的列表信息。', + 'type' => 'array', + 'items' => [ + 'description' => '返回通过FML语句查询的数据建模引擎信息的结果。', + 'type' => 'object', + 'example' => '[{ "gmtModified": 最后修改时间,"code": "表名","creatorId": "创建人ID","creatorName": "创建人名称","modifierId": "修改人ID","gmtCreate": 创建时间,"type": 表类型,"ownerId": "负责人ID","uuid": "系统ID","businessUnitUuid": "业务板块ID","detailType": "表二级类型","ownerName": "负责人名称","name": "表显示名","modifierName": "最后修改人名称","businessProcessUuid": "业务过程ID" }]', + ], + ], + ], + ], + ], + ], + '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' => '查询数据建模引擎的信息', + 'description' => '- 每次调用该接口均需使用FML语句请求获取查询信息。'."\n" + .'- 除了数仓分层、业务过程和数据域查询外，其他引擎信息查询均可使用分页查询方式。您可以在FML语句结尾增加offset'."\n" + .' num limit num语句，表示查询信息时的偏移量及每次返回的页数。目前偏移量取值仅支持为页数的倍数。'."\n" + .'- 每次调用该接口时，最多返回1000条数据。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => '## 返回结果说明'."\n" + .'### 查询数仓分层使用的FML语句如下。'."\n" + .'show layers; '."\n" + .'输出参数'."\n" + .'| 参数名 | 参数类型 | 示例值 | 描述信息 |'."\n" + .'| ---------------- | -------- | ---------- | ------------ |'."\n" + .'| code | String | dws | 数仓分层编码 |'."\n" + .'| englishName | String | dws | 数仓分层英文名 |'."\n" + .'| name | String | 汇总层 | 数仓分层中文名 |'."\n" + .'| ownerId | String | 0123456 | 负责人ID |'."\n" + .'| ownerName | String | 甲乙丙丁 | 负责人名称 |'."\n" + .'| description | String | 汇总层描述 | 备注 |'."\n" + .'| uuid | String | obj-123456 | 对象唯一标识 |'."\n" + .'| gmtCreate | TimeStamp | 1644397025000 | 创建时间 |'."\n" + .'| gmtModified | TimeStamp | 1644459965000 | 修改时间 |'."\n" + .'| creatorId | String | 0123456 | 创建人BaseId |'."\n" + .'| creatorName | String | 甲乙丙丁 | 创建人名称 |'."\n" + .'| modifierId | String | 0123456 | 修改人BaseId |'."\n" + .'| modifierName | String | 甲乙丙丁 | 修改人名称 |'."\n" + ."\n\n" + .'### 查询数据域使用的FML语句如下。'."\n" + .' show domains; '."\n" + .'输出参数'."\n" + .'| 参数名 | 参数类型 | 示例值 | 描述信息 |'."\n" + .'| ---------------- | -------- | ---------- | ------------ |'."\n" + .'| code | String | member | 数据域编码 |'."\n" + .'| englishName | String | member | 数据域英文名 |'."\n" + .'| name | String | 会员 | 数据域中文名 |'."\n" + .'| ownerId | String | 0123456 | 负责人ID |'."\n" + .'| ownerName | String | 甲乙丙丁 | 负责人名称 |'."\n" + .'| businessUnitCode | String | bu-123456 | 业务板块编码 |'."\n" + .'| description | String | 会员域备注 | 备注 |'."\n" + .'| uuid | String | obj-123456 | 对象唯一标识 |'."\n" + .'| gmtCreate | TimeStamp | 1644397025000 | 创建时间 |'."\n" + .'| gmtModified | TimeStamp | 1644459965000 | 修改时间 |'."\n" + .'| creatorId | String | 0123456 | 创建人BaseIdID |'."\n" + .'| creatorName | String | 甲乙丙丁 | 创建人名称 |'."\n" + .'| modifierId | String | 0123456 | 修改人BaseIdID |'."\n" + .'| modifierName | String | 甲乙丙丁 | 修改人名称 |'."\n" + .' '."\n" + ."\n" + .'### 查询业务过程使用的FML语句如下。'."\n" + ."\n" + .'- 无条件列表查询：show business_processes;'."\n" + .'- 根据code查询业务过程：show business_processes where code=\'bp-code\'; '."\n" + .'- 根据数据域查询业务过程：show business_processes where data_domain=\'dm-code\'; '."\n" + .' '."\n" + .'输出参数'."\n" + ."\n" + .'| 参数名 | 参数类型 | 示例值 | 描述信息 |'."\n" + .'| -------------- | -------- | -------------- | ------------------------------- |'."\n" + .'| code | String | bp-123456 | 业务过程编码 |'."\n" + .'| englishName | String | pay | 业务过程英文名 |'."\n" + .'| name | String | 付款 | 业务过程中文名 |'."\n" + .'| dataDomainCode | String | trade | 所属数据域编码 |'."\n" + .'| dataDomainName | String | 交易 | 所属数据域中文名 |'."\n" + .'| dataDomainUuid | String | dm-123456 | 所属数据域UUID |'."\n" + .'| ownerId | String | 0123456 | 负责人BaseId |'."\n" + .'| ownerName | String | 甲乙丙丁 | 负责人名称 |'."\n" + .'| description | String | 付款 | 备注 |'."\n" + .'| source | Integer | 2 | 创建来源。可取值如下：<br>1：系统创建<br>2：用户创建|'."\n" + .'| uuid | String | obj-123456 | 对象唯一标识 |'."\n" + .'| gmtCreate | TimeStamp | 1644397025000 | 创建时间 |'."\n" + .'| gmtModified | TimeStamp | 1644459965000 | 修改时间 |'."\n" + .'| creatorId | String | creatorId | 创建人BaseId |'."\n" + .'| creatorName | String | 甲乙丙丁 | 创建人名称 |'."\n" + .'| modifierId | String | 0123456 | 修改人BaseId |'."\n" + .'| modifierName | String | 甲乙丙丁 | 修改人名称 |'."\n" + ."\n" + .'### 查询业务分类使用的FML语句如下。'."\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" + .'输出参数'."\n" + .'| 参数名 | 参数类型 | 示例值 | 描述信息 |'."\n" + .'| ----------------- | ------------------ | -------------------- | -------------------- |'."\n" + .'| categoryDetail | DirectoryDetailDTO | {"uuid": "cate_uuid", "code": "trd", "name": "交易"} | 业务分类详细信息 |'."\n" + .'| name | String | 电商 | 目录名称 |'."\n" + .'| detailType | String | DICT | 目录子类型 |'."\n" + .'| parentUuid | String | dy-123456 | 父级目录UUID |'."\n" + .'| description | String | 描述信息 | 目录描述 |'."\n" + .'| code | String | ind | 业务分类code |'."\n" + .'| dataDomains | List | [{"uuid": "domain1", "code": "trd", "name": "交易域"}] | 业务分类下挂靠数据域 |'."\n" + .'| ownerId | String | 0123456 | 负责人BaseId |'."\n" + .'| ownerName | String | 甲乙丙丁 | 负责人名称 |'."\n" + .'| businessUnitCode | String | bu-123456 | 业务板块编码 |'."\n" + .'| description | String | 描述信息 | 目录描述 |'."\n" + .'| categoryPath | String | tm.ind | 业务分类path |'."\n" + ."\n" + .'### 查询数据集市使用的FML语句如下。'."\n" + .' show markets;'."\n" + .'输出参数'."\n" + .'| 参数名 | 参数类型 | 示例值 | 描述信息 |'."\n" + .'| ----------------- | ------------------ | -------------------- | -------------------- |'."\n" + .'| categoryDetail | DirectoryDetailDTO | {"uuid": "cate_uuid", "code": "trd", "name": "交易"} | 数据集市详细信息 |'."\n" + .'| name | String | 电商 | 目录名称 |'."\n" + .'| detailType | String | DICT | 目录子类型 |'."\n" + .'| parentUuid | String | dy-123456 | 父级目录UUID |'."\n" + .'| description | String | 描述信息 | 目录描述 |'."\n" + .'| code | String | ind | 业务分类code |'."\n" + .'| subDetailType | String | common | 目录子类型细分类型 |'."\n" + .'| auditDTOList | List | [{"baseId":"123","showName":"test"}] | 审核人员列表 |'."\n" + .'| code | String | member | 数据域编码 |'."\n" + .'| englishName | String | member | 数据域英文名 |'."\n" + .'| name | String | 会员 | 数据域中文名 |'."\n" + .'| ownerId | String | 0123456 | 负责人BaseId |'."\n" + .'| ownerName | String | 甲乙丙丁 | 负责人名称 |'."\n" + .'| businessUnitCode | String | bu-123456 | 业务板块编码 |'."\n" + .'| description | String | 会员域备注 | 备注 |'."\n" + .'| auditDTOList | List | [{"baseId":"123","showName":"test"}] | 审核人员列表 |'."\n" + .'| categoryPath | String | tm.ind | 业务分类path |'."\n" + ."\n" + .'### 查询主题域使用的FML语句如下。'."\n" + .' show subjects;'."\n" + .'输出参数'."\n" + .'| 参数名 | 参数类型 | 示例值 | 描述信息 |'."\n" + .'| ----------------- | ------------------ | -------------------- | -------------------- |'."\n" + .'| categoryDetail | DirectoryDetailDTO | {"uuid": "cate_uuid", "code": "trd", "name": "交易"} |主题详细信息 |'."\n" + .'| name | String | 电商 | 目录名称 |'."\n" + .'| detailType | String | DICT | 目录子类型 |'."\n" + .'| parentUuid | String | dy-123456 | 父级目录UUID |'."\n" + .'| description | String | 描述信息 | 目录描述 |'."\n" + .'| code | String | ind | 业务分类code |'."\n" + .'| subDetailType | String | common | 目录子类型细分类型 |'."\n" + .'| auditDTOList | List | [{"baseId":"123","showName":"test"}] | 审核人员列表 |'."\n" + .'| code | String | member | 数据域编码 |'."\n" + .'| englishName | String | member | 数据域英文名 |'."\n" + .'| name | String | 会员 | 数据域中文名 |'."\n" + .'| ownerId | String | 0123456 | 负责人BaseId |'."\n" + .'| ownerName | String | 甲乙丙丁 | 负责人名称 |'."\n" + .'| businessUnitCode | String | bu-123456 | 业务板块编码 |'."\n" + .'| description | String | 会员域备注 | 备注 |'."\n" + .'| auditDTOList | List | [{"baseId":"123","showName":"test"}] | 审核人员列表 |'."\n" + .'| categoryPath | String | tm.ind | 业务分类path |'."\n" + ."\n" + .'### 查询数据标准集使用的FML语句如下。'."\n" + .' show dict groups;'."\n" + .'输出参数'."\n" + .'| 参数名 | 参数类型 | 示例值 | 描述信息 |'."\n" + .'| ------------ | -------- | ---------- | ------------ |'."\n" + .'| name | String | 电商 | 目录名称 |'."\n" + .'| detailType | String | DICT | 目录子类型 |'."\n" + .'| parentUuid | String | dy-123456 | 父级目录UUID |'."\n" + .'| description | String | 描述信息 | 目录描述 |'."\n" + .'| code | String | ind | 业务分类code |'."\n" + .'| uuid | List | obj-123456 | 对象唯一标识 |'."\n" + .'| gmtCreate | TimeStamp | 1644397025000 | 创建时间 |'."\n" + .'| gmtModified | TimeStamp | 1644459965000 | 修改时间 |'."\n" + .'| creatorId | String | 0123456 | 创建人BaseId|'."\n" + .'| creatorName | String | 甲乙丙丁 | 创建人名称 |'."\n" + .'| modifierId | String | 0123456 | 修改人BaseId |'."\n" + .'| modifierName | String | 甲乙丙丁 | 修改人名称 |'."\n" + ."\n" + .'### 查询数据标准使用的FML语句如下。'."\n" + .' show dicts;'."\n" + .'输出参数'."\n" + .'| 参数名 | 参数类型 | 示例值 | 描述信息 |'."\n" + .'| ------------------ | -------- | ------------ | ------------ |'."\n" + .'| code | String | shop_type | 英文缩写 |'."\n" + .'| englishName | String | shop type | 英文名称 |'."\n" + .'| name | String | 店铺类型 | 中文名称 |'."\n" + .'| no | String | SN00001| 标准编号 |'."\n" + .'| dataType | String | STRING| 数据类型 |'."\n" + .'| length | Integer | 10 | 列长度 |'."\n" + .'| numericalPrecision | Integer | 2 | 列精度 |'."\n" + .'| notNull | Boolean | false | 是否不为空 |'."\n" + .'| defaultValue | String | 旗舰店 | 默认值 |'."\n" + .'| parentNo | String | SN0001 | 父级标准编号 |'."\n" + .'| parentName | String | 店铺 | 父级标准名称 |'."\n" + .'| codeTableNo | String | shop_type | 引用码表编号 |'."\n" + .'| codeTableName | String | 店铺类型码表 | 引用码表名称 |'."\n" + .'| codeTableUuid | String | tb-0001 | 引用码表UUID |'."\n" + .'| directoryUuid | String | 所属目录UUID | 所属目录UUID |'."\n" + .'| directoryName | String | 店铺目录 | 所属目录名称 |'."\n" + .'| description | String | remark | 备注 |'."\n" + .'| uuid | String | obj-123456 | 对象唯一标识 |'."\n" + .'| gmtCreate | TimeStamp | 1644397025000 | 创建时间 |'."\n" + .'| gmtModified | TimeStamp | 1644459965000 | 修改时间 |'."\n" + .'| creatorId | String | 0123456 | 创建人BaseId |'."\n" + .'| creatorName | String | 甲乙丙丁 | 创建人名称 |'."\n" + .'| modifierId | String | 0123456 | 修改人BaseId |'."\n" + .'| modifierName | String | 甲乙丙丁 | 修改人名称 |'."\n" + ."\n" + .'### 查询标准代码使用的FML语句如下。'."\n" + .' show code tables;'."\n" + .'输出参数'."\n" + .'| 参数名 | 参数类型 | 示例值 | 描述信息 |'."\n" + .'| ------------ | -------- | ---------- | ------------ |'."\n" + .'| code | String | shop_type |代码编码 |'."\n" + .'| name | String | 店铺类型 | 代码名称 |'."\n" + .'| extendName | String | shop type | 英文名称 |'."\n" + .'| description | String | remark | 描述 |'."\n" + .'| uuid | String | obj-123456 | 对象唯一标识 |'."\n" + .'| gmtCreate | TimeStamp | 1644397025000 | 创建时间 |'."\n" + .'| gmtModified | TimeStamp | 1644459965000 | 修改时间 |'."\n" + .'| creatorId | String | 0123456 | 创建人BaseId |'."\n" + .'| creatorName | String | 甲乙丙丁 | 创建人名称 |'."\n" + .'| modifierId | String | 0123456 | 修改人BaseId|'."\n" + .'| modifierName | String | 甲乙丙丁 | 修改人名称 |'."\n" + ."\n" + .'### 查询度量单位组使用的FML语句如下。'."\n" + .' show measure_unit groups;'."\n" + .'输出参数'."\n" + .'| 参数名 | 参数类型 | 示例值 | 描述信息 |'."\n" + .'| ------------ | -------- | ---------- | ------------ |'."\n" + .'| name | String | 电商 | 目录名称|'."\n" + .'| detailType | String | DICT | 目录子类型 |'."\n" + .'| parentUuid | String | dy-123456 | 父级目录UUID |'."\n" + .'| description | String |描述信息 | 目录描述 |'."\n" + .'| code | String | ind | 分类code |'."\n" + .'| uuid | String | obj-123456 | 对象唯一标识 |'."\n" + .'| gmtCreate | TimeStamp | 1644397025000 | 创建时间 |'."\n" + .'| gmtModified | TimeStamp | 1644459965000 | 修改时间 |'."\n" + .'| creatorId | String | 0123456 | 创建人BaseId |'."\n" + .'| creatorName | String | 甲乙丙丁 | 创建人名称 |'."\n" + .'| modifierId | String | 0123456 | 修改人BaseId |'."\n" + .'| modifierName | String | 甲乙丙丁 | 修改人名称 |'."\n" + ."\n" + .'### 查询度量单位使用的FML语句如下。'."\n" + .' show measure_units;'."\n" + .'输出参数'."\n" + .'| 参数名 | 参数类型 | 示例值 | 描述信息 |'."\n" + .'| ------------- | -------- | ------------ | ------------ |'."\n" + .'| code | String | yuan | 英文缩写 |'."\n" + .'| englishName | String | RMB | 英文名称 |'."\n" + .'| name | String | 元 | 列中文名称 |'."\n" + .'| directoryUuid | String | di-0001 | 单位分组UUID |'."\n" + .'| directoryName | String | 货币 | 单位分组名称 |'."\n" + .'| description | String | remark | 备注 |'."\n" + .'| uuid | String | obj-123456 | 对象唯一标识 |'."\n" + .'| gmtCreate | TimeStamp | 1644397025000 | 创建时间 |'."\n" + .'| gmtModified | TimeStamp | 1644459965000 | 修改时间 |'."\n" + .'| creatorId | String | 0123456 | 创建人BaseId |'."\n" + .'| creatorName | String | 甲乙丙丁 | 创建人名称 |'."\n" + .'| modifierId | String | 0123456 | 修改人BaseId |'."\n" + .'| modifierName | String | 甲乙丙丁 | 修改人名称 |'."\n" + ."\n" + .'### 查询标准代码内容使用的FML语句如下。'."\n" + .' show codes from code_table;'."\n" + .'输出参数'."\n" + .'| 参数名 | 参数类型 | 示例值 | 描述信息 |'."\n" + .'| ----------------- | -------- | ---------------- | ---------------- |'."\n" + .'| codeContent | String | 0 | code内容值 |'."\n" + .'| extendNameContent | String | female | 扩展标准代码名称 |'."\n" + .'| nameContent | String | 女性 | 标准代码名称 |'."\n" + .'| description | String | remark | 标准代码描述 |'."\n" + .'| uuid | String | obj-123456 | 对象唯一标识 |'."\n" + .'| gmtCreate | TimeStamp | 1644397025000 | 创建时间 |'."\n" + .'| gmtModified | TimeStamp | 1644459965000 | 修改时间 |'."\n" + .'| creatorId | String | 0123456 | 创建人BaseId |'."\n" + .'| creatorName | String | 甲乙丙丁 | 创建人名称 |'."\n" + .'| modifierId | String | 0123456 | 修改人BaseId |'."\n" + .'| modifierName | String | 甲乙丙丁 | 修改人名称 |'."\n" + ."\n" + .'### 查询命名词典使用的FML语句如下。'."\n" + .'show naming dicts;'."\n" + .'输出参数'."\n" + .'| 参数名 | 参数类型 | 示例值 | 描述信息 |'."\n" + .'| ------------ | -------- | ---------- | ------------ |'."\n" + .'| code | String | shop | 英文缩写 |'."\n" + .'| creatorId | String | 0123456 | 创建人BaseId |'."\n" + .'| creatorName | String | 甲乙丙丁 | 创建人名称 |'."\n" + .'| extendName | String | shop | 英文名称 |'."\n" + .'| gmtCreate | TimeStamp | 1644397025000 | 创建时间 |'."\n" + .'| gmtModified | TimeStamp | 1644459965000 | 修改时间 |'."\n" + .'| modifierId | String | 0123456 | 修改人BaseId |'."\n" + .'| modifierName | String | 甲乙丙丁 | 修改人名称 |'."\n" + .'| name | String | 店铺 | 中文名称 |'."\n" + .'| ownerId | String | 0123456 | 负责人BaseId |'."\n" + .'| ownerName | String | 甲乙丙丁 | 负责人名称 |'."\n" + .'| uuid | String | obj-123456 | 对象唯一标识 |'."\n" + ."\n" + .'### 查询表信息使用的FML语句如下。'."\n" + .' show tables;'."\n" + .'输出参数'."\n" + .'| 参数名 | 参数类型 | 示例值 | 描述信息 |'."\n" + .'| ---------------------- | -------- | ---------- | ------------------------------------------ |'."\n" + .'| code | String | dim_shop | 表编码 |'."\n" + .'| name | String | 店铺维度表 | 表中文名 |'."\n" + .'| type | Integer | 1 | 表类型。取值如下：<br>0：事实表<br>1：维度表<br>3：汇总表<br>4：应用表<br>5：贴源表<br>6：维度 |'."\n" + .'| detailType | String | normal | 表具体类型。可取值如下：<br>普通维度<br>枚举维度<br>事务事实 |'."\n" + .'| businessProcessUuid | String | bp-123456 | 业务过程UUID |'."\n" + .'| businessUnitUuid | String | bu-123456 | 业务板块UUID |'."\n" + .'| dataWarehouseLayerUuid | String | ly-123456 | 数仓层UUID |'."\n" + .'| businessCategoryUuid | String | bc-123456 | 业务分类UUID |'."\n" + .'| ownerId | String | 0123456 | 负责人BaseId |'."\n" + .'| ownerName | String | 甲乙丙丁 | 负责人名称 |'."\n" + .'| description | String | 店铺表备注 | 备注 |'."\n" + .'| config | String | json字符串 | 拓展属性配置 |'."\n" + .'| lifeCycle | Integer | 365 | 表生命周期 |'."\n" + .'| uuid | String | obj-123456 | 对象唯一标识 |'."\n" + .'| gmtCreate | TimeStamp | 1644397025000 | 创建时间 |'."\n" + .'| gmtModified | TimeStamp | 1644459965000 | 修改时间 |'."\n" + .'| creatorId | String | 0123456 | 创建人BaseId |'."\n" + .'| creatorName | String | 甲乙丙丁 | 创建人名称 |'."\n" + .'| modifierId | String | 0123456 | 修改人BaseId |'."\n" + .'| modifierName | String | 甲乙丙丁 | 修改人名称 |'."\n" + ."\n" + .'### 查询维度表使用的FML语句如下。'."\n" + .' show dim tables; '."\n" + .'输出参数'."\n" + .'| 参数名 | 参数类型 | 示例值 | 描述信息 |'."\n" + .'| ---------------------- | -------- | ---------- | ---------------------------------------- |'."\n" + .'| code | String | dim_shop | 表编码 |'."\n" + .'| name | String | 店铺维度表 | 表中文名 |'."\n" + .'| type | Integer | 1 | 表类型。可取值如下：<br>0：事实表<br>1：维度表 |'."\n" + .'| detailType | String | normal | 表具体类型。可取值如下：<br>普通维度<br>枚举维度<br>事务事实 |'."\n" + .'| businessProcessUuid | String | bp-123456 | 业务过程UUID |'."\n" + .'| businessUnitUuid | String | bu-123456 | 业务板块UUID |'."\n" + .'| dataWarehouseLayerUuid | String | ly-123456 | 数仓层UUID |'."\n" + .'| businessCategoryUuid | String | bc-123456 | 业务分类UUID |'."\n" + .'| ownerId | String | 0123456 | 负责人BaseId |'."\n" + .'| ownerName | String | 甲乙丙丁 | 负责人名称 |'."\n" + .'| description | String | 店铺表备注 | 备注 |'."\n" + .'| config | String | json字符串 | 拓展属性配置 |'."\n" + .'| lifeCycle | Integer | 365 | 表生命周期 |'."\n" + .'| uuid | String | obj-123456 | 对象唯一标识 |'."\n" + .'| gmtCreate | TimeStamp | 1644397025000 | 创建时间 |'."\n" + .'| gmtModified | TimeStamp | 1644459965000 | 修改时间 |'."\n" + .'| creatorId | String | 0123456 | 创建人BaseId |'."\n" + .'| creatorName | String | 甲乙丙丁 | 创建人名称 |'."\n" + .'| modifierId | String | 0123456 | 修改人BaseId |'."\n" + .'| modifierName | String | 甲乙丙丁 | 修改人名称 |'."\n" + ."\n" + .'### 查询事实表信息使用的FML语句如下。'."\n" + .' show fact tables;'."\n" + .'输出参数'."\n" + .'| 参数名 | 参数类型 | 示例值 | 描述信息 |'."\n" + .'| ---------------------- | -------- | ---------- | ---------------------------------------- |'."\n" + .'| code | String | dim_shop | 表编码 |'."\n" + .'| name | String | 店铺维度表 | 表中文名 |'."\n" + .'| type | Integer | 1 | 表类型。可取值如下：<br>0：事实表<br>1：维度表 |'."\n" + .'| detailType | String | normal | 表具体类型。可取值如下：<br>普通维度<br>枚举维度<br>事务事实 |'."\n" + .'| businessProcessUuid | String | bp-123456 | 业务过程UUID |'."\n" + .'| businessUnitUuid | String | bu-123456 | 业务板块UUID |'."\n" + .'| dataWarehouseLayerUuid | String | ly-123456 | 数仓层UUID |'."\n" + .'| businessCategoryUuid | String | bc-123456 | 业务分类UUID |'."\n" + .'| ownerId | String | 0123456 | 负责人BaseId |'."\n" + .'| ownerName | String | 甲乙丙丁 | 负责人名称 |'."\n" + .'| description | String | 店铺表备注 | 备注 |'."\n" + .'| config | String | json字符串 | 拓展属性配置 |'."\n" + .'| lifeCycle | Integer | 365 | 表生命周期 |'."\n" + .'| uuid | String | obj-123456 | 对象唯一标识 |'."\n" + .'| gmtCreate | TimeStamp | 1644397025000 | 创建时间 |'."\n" + .'| gmtModified | TimeStamp | 1644459965000 | 修改时间 |'."\n" + .'| creatorId | String | 0123456 | 创建人BaseId |'."\n" + .'| creatorName | String | 甲乙丙丁 | 创建人名称 |'."\n" + .'| modifierId | String | 0123456 | 修改人BaseId |'."\n" + .'| modifierName | String | 甲乙丙丁 | 修改人名称 |'."\n" + ."\n" + .'### 查询汇总表使用的FML语句如下。'."\n" + .' show dws tables;'."\n" + .'输出参数'."\n" + .'| 参数名 | 参数类型 | 示例值 | 描述信息 |'."\n" + .'| ---------------------- | -------- | ------------ | ------------------------------------------ |'."\n" + .'| dataDomainUuid | String | dm-12345 | 数据域UUID |'."\n" + .'| dataDomainCode | String | member | 数据域Code |'."\n" + .'| dataDomainName | String | 会员 | 数据域名字 |'."\n" + .'| timePeriods | List | [{"uuid": "uuid", "code": "code", "name": "中文名称"}] | 时间周期列表 |'."\n" + .'| uuid | String | obj-123456 | 对象唯一标识 |'."\n" + .'| code | String | dws_001 | 表名 |'."\n" + .'| name | String | 支付汇总表 | 表中文名称 |'."\n" + .'| adjuncts | List | [{"uuid": "uuid", "code": "code", "name": "中文名称"}] | 修饰词列表 |'."\n" + .'| dimensions | List | [{"uuid": "uuid", "code": "code", "name": "中文名称"}] | 粒度 |'."\n" + .'| bizEntityUuid | String | dim-123456 | 业务对象UUID |'."\n" + .'| bizEntityCode | String | dim_shop | 业务对象英文缩写 |'."\n" + .'| bizEntityName | String | 店铺表 | 业务对象中文名称 |'."\n" + .'| relUuid | String | dim_a-123456 | 关联维度UUID |'."\n" + .'| type | Integer | 3 | 表类型。取值为：3（汇总表） |'."\n" + .'| detailType | String | dws_normal | 表具体类型。可取值如下：<br>dws_normal：普通汇总表<br>dws_advanced：轻度汇总表 |'."\n" + .'| businessProcessUuid | String | bp-123456 | 业务过程UUID |'."\n" + .'| businessUnitUuid | String | bu-123456 | 业务板块UUID |'."\n" + .'| dataWarehouseLayerUuid | String | ly-123456 | 数仓层UUID |'."\n" + .'| businessCategoryUuid | String | bc-123456 | 业务分类UUID |'."\n" + .'| ownerId | String | 0123456 | 负责人BaseId |'."\n" + .'| ownerName | String | 甲乙丙丁 | 负责人名称 |'."\n" + .'| description | String | 店铺表备注 | 备注 |'."\n" + .'| config | String | json字符串 | 拓展属性配置 |'."\n" + .'| lifeCycle | Integer | 365 | 表生命周期 |'."\n" + .'| gmtCreate | TimeStamp | 1644397025000 | 创建时间 |'."\n" + .'| gmtModified | TimeStamp | 1644459965000 | 修改时间 |'."\n" + .'| creatorId | String | 0123456 | 创建人BaseId |'."\n" + .'| creatorName | String | 甲乙丙丁 | 创建人名称 |'."\n" + .'| modifierId | String | 0123456 | 修改人BaseId |'."\n" + .'| modifierName | String | 甲乙丙丁 | 修改人名称 |'."\n" + ."\n" + .'### 查询应用表使用的FML语句如下。'."\n" + .' show ads tables;'."\n" + .'输出参数'."\n" + .'| 参数名 | 参数类型 | 示例值 | 描述信息 |'."\n" + .'| ---------------------- | -------- | ------------ | ------------------------------------------ |'."\n" + .'| dataDomainUuid | String | dm-12345 | 数据域UUID |'."\n" + .'| dataDomainCode | String | member | 数据域Code |'."\n" + .'| dataDomainName | String | 会员 | 数据域名称 |'."\n" + .'| timePeriods | List | [{"uuid": "uuid", "code": "code", "name": "中文名称"}] | 时间周期列表 |'."\n" + .'| uuid | String | obj-123456 | 对象唯一标识 |'."\n" + .'| code | String | dws_001 |表名 |'."\n" + .'| name | String | 支付汇总表 | 表中文名称 |'."\n" + .'| adjuncts | List | [{"uuid": "uuid", "code": "code", "name": "中文名称"}] | 修饰词列表 |'."\n" + .'| dimensions | List | [{"uuid": "uuid", "code": "code", "name": "中文名称"}] |粒度 |'."\n" + .'| bizEntityUuid | String | dim-123456 | 业务对象UUID |'."\n" + .'| bizEntityCode | String | dim_shop | 业务对象英文缩写 |'."\n" + .'| bizEntityName | String | 店铺表 | 业务对象中文名称 |'."\n" + .'| relUuid | String | dim_a-123456 | 关联维度UUID |'."\n" + .'| type | Integer | 1 | 表类型。可取值如下：<br>0：事实表<br>1：维度表 |'."\n" + .'| detailType | String | normal | 表具体类型。可取值如下：<br>普通维度<br>枚举维度<br>事务事实 |'."\n" + .'| businessProcessUuid | String | bp-123456 | 业务过程UUID |'."\n" + .'| businessUnitUuid | String | bu-123456 | 业务板块UUID |'."\n" + .'| dataWarehouseLayerUuid | String | ly-123456 | 数仓层UUID |'."\n" + .'| businessCategoryUuid | String | bc-123456 | 业务分类UUID |'."\n" + .'| ownerId | String | 0123456 | 负责人BaseId |'."\n" + .'| ownerName | String | 甲乙丙丁 | 负责人名称 |'."\n" + .'| description | String | 店铺表备注 | 备注 |'."\n" + .'| config | String | json字符串 | 拓展属性配置 |'."\n" + .'| lifeCycle | Integer | 365 | 表生命周期 |'."\n" + .'| gmtCreate | TimeStamp | 1644397025000 | 创建时间 |'."\n" + .'| gmtModified | TimeStamp | 1644459965000 | 修改时间 |'."\n" + .'| creatorId | String | 0123456 | 创建人BaseId |'."\n" + .'| creatorName | String | 甲乙丙丁 | 创建人名称 |'."\n" + .'| modifierId | String | 0123456 | 修改人BaseId |'."\n" + .'| modifierName | String | 甲乙丙丁 | 修改人名称 |'."\n" + ."\n" + .'### 查询表信息同时返回字段信息使用的FML语句如下。'."\n" + .' show full tables;'."\n" + .'输出参数'."\n" + .'| 参数名 | 参数类型 | 示例值 | 描述信息 |'."\n" + .'| -------------- | -------- | ---------- | ---------- |'."\n" + .'| tableUuid | String | tb-123456 | 表UUID |'."\n" + .'| tableCode | String | dim_shop | 表编码 |'."\n" + .'| tableName | String | 店铺表 | 表名称 |'."\n" + .'| columnCode | String | shop_id | 列编码 |'."\n" + .'| columnName | String | 店铺Id | 列名称 |'."\n" + .'| columnUuid | String | col-123456 | 列UUID |'."\n" + .'| columnType | String | STRING | 列数据类型 |'."\n" + .'| columnCategory | String | ATTRIBUTE | 列类别 |'."\n" + ."\n" + .'### 查询列信息使用的FML语句如下。'."\n" + .' show columns from table_code;'."\n" + .'输出参数'."\n" + .'| 参数名 | 参数类型 | 示例值 | 描述信息 |'."\n" + .'| ------------------- | -------- | ------------ | ------------ |'."\n" + .'| code | String | seller_id | 列编码 |'."\n" + .'| name | String | 卖家Id | 列中文名 |'."\n" + .'| dataType | String | STRING | 数据类型 |'."\n" + .'| type | String | ATTRIBUTE | 字段类型 |'."\n" + .'| isPrimaryKey | Boolean | false | 是否主键 |'."\n" + .'| isPartitionKey | Boolean | false | 是否分区键 |'."\n" + .'| partitionOrder | Integer | 1 | 分区键顺序 |'."\n" + .'| notNull | Boolean | true | 是否非空 |'."\n" + .'| dataDictionaryUuid | String | member_id | 数据字典编码 |'."\n" + .'| dataDictionaryCode | String | 会员Id | 数据字典名称 |'."\n" + .'| codeTableUuid | String | cd-123456 | 关联码表UUID |'."\n" + .'| codeTableCode | String | sex | 关联码表编码 |'."\n" + .'| codeTableName | String | 性别 | 关联码表名称 |'."\n" + .'| measureUnitCode | String | percent | 关联单位编码 |'."\n" + .'| measureUnitName | String | 分 | 关联单位名称 |'."\n" + .'| sourceProjectName | String | autotest | 来源项目名称 |'."\n" + .'| sourceTableCode | String | dict | 来源表编码 |'."\n" + .'| sourceColumnCode | String | age | 来源字段编码 |'."\n" + .'| sourceRelationTag | String | label | 冗余关系标签 |'."\n" + .'| description | String | 字段备注 | 备注 |'."\n" + .'| orderId | String | 1 | 字段顺序 |'."\n" + .'| columnGroupName | Integer | col_group_1 | 所属字段组 |'."\n" + .'| config | String | json字符串 | 拓展属性配置 |'."\n" + .'| uuid | String | obj-123456 | 对象唯一标识 |'."\n" + .'| gmtCreate | TimeStamp | 1644397025000 | 创建时间 |'."\n" + .'| gmtModified | TimeStamp | 1644459965000 | 修改时间 |'."\n" + .'| creatorId | String | 0123456 | 创建人BaseId |'."\n" + .'| creatorName | String | 甲乙丙丁 | 创建人名称 |'."\n" + .'| modifierId | String | 0123456 | 修改人BaseId |'."\n" + .'| modifierName | String | 甲乙丙丁 | 修改人名称 |'."\n" + ."\n" + .'### 查询修饰词使用的FML语句如下。'."\n" + .' show adjuncts;'."\n" + .'输出参数'."\n" + .'| 参数名 | 参数类型 | 示例值 | 描述信息 |'."\n" + .'| ----------------- | ------------------ | ---------------------------------------------- | ---------------------------------------------- |'."\n" + .'| businessUnitUuid | String | bu-123456 | 业务板块UUID |'."\n" + .'| businessUnitCode | String | test_bu | 业务板块CODE |'."\n" + .'| businessUnitName | String | 测试板块 | 业务板块NAME |'."\n" + .'| dataDomainUuid | String | dt-123456 | 数据域UUID |'."\n" + .'| dataDomainCode | String | member | 数据域CODE |'."\n" + .'| dataDomainName | String | 会员域 | 数据域NAME |'."\n" + .'| categoryUuid | String | cy-123456 | 业务分类UUID |'."\n" + .'| categoryCode | String | trade | 业务分类CODE |'."\n" + .'| categoryName | String | 电商 | 业务分类NAME |'."\n" + .'| type | AdjunctTypeEnum | DIM_VAL | 修饰词类型 |'."\n" + .'| code | String | beauty | 英文缩写 |'."\n" + .'| name | String | 美妆 | 中文名称 |'."\n" + .'| extendName | String | beauty | 英文名称 |'."\n" + .'| description | String | 美妆描述 | 描述 |'."\n" + .'| bizExpression | String | 用于报表统计口径 | 业务口径 |'."\n" + .'| expression | String | beauty = 1 | 修饰词语义表达式 |'."\n" + .'| bizEntityUuid | String | dim-123456 | 业务对象UUID |'."\n" + .'| bizEntityCode | String | dim_shop | 业务对象英文缩写 |'."\n" + .'| bizEntityName | String | 店铺表 | 业务对象中文名称 |'."\n" + .'| relUuid | String | dim_a-123456 | 关联维度UUID |'."\n" + .'| ownerId | String | 0123456 | 负责人BaseId |'."\n" + .'| ownerName | String | 甲乙丙丁 | 负责人名称 |'."\n" + .'| isDeleted | DeleteTagEnum | NO | 是否被删除 |'."\n" + .'| uuid | String | obj-123456 | 对象唯一标识 |'."\n" + .'| gmtCreate | TimeStamp | 1644397025000 | 创建时间 |'."\n" + .'| gmtModified | TimeStamp | 1644459965000 | 修改时间 |'."\n" + .'| creatorId | String | 0123456 | 创建人BaseId |'."\n" + .'| creatorName | String | 甲乙丙丁 | 创建人名称 |'."\n" + .'| modifierId | String | 0123456 | 修改人BaseId |'."\n" + .'| modifierName | String | 甲乙丙丁 | 修改人名称 |'."\n" + ."\n" + .'### 查询时间周期使用的FML语句如下。'."\n" + .' show time_periods;'."\n" + .'输出参数'."\n" + .'| 参数名 | 参数类型 | 示例值 | 描述信息 |'."\n" + .'| ----------------- | ------------------ | ---------------------------------------------- | ---------------------------------------------- |'."\n" + .'| businessUnitUuid | String | bu-123456 | 所属的业务板块 |'."\n" + .'| businessUnitCode | String | test_bu | 业务板块CODE |'."\n" + .'| type | TimePeriodTypeEnum | DAY | 时间周期类型 |'."\n" + .'| typeName | String | 天 | 时间周期类型名称 |'."\n" + .'| code | String | 1d | 英文缩写 |'."\n" + .'| name | String | 1天 | 中文名称|'."\n" + .'| extendName | String | 1d | 英文名称|'."\n" + .'| description | String | 时间周期描述 | 描述 |'."\n" + .'| isDeleted | DeleteTagEnum | NO | 是否被删除 |'."\n" + .'| timeBegin | String | start_expression | 开始时间表达式|'."\n" + .'| timeEnd | String | end_expression | 结束时间表达式|'."\n" + .'| gmtCreate | TimeStamp | 1633885261000 | 创建时间|'."\n" + .'| gmtModified | TimeStamp | 1633885261000 | 修改时间 |'."\n" + .'| modifierId | String | 0123456 | 修改人BaseId |'."\n" + .'| modifierName | String | 甲乙丙丁 | 修改人名称 |'."\n" + .'| ownerId | String | 0123456 | 负责人BaseId |'."\n" + .'| ownerName | String | 甲乙丙丁 | 负责人名称 |'."\n" + .'| beginOffset | Integer | 1 | 开始周期偏移量 |'."\n" + .'| endOffset | Integer | 1 | 结束周期偏移量|'."\n" + .'| firstDay | Integer | 1 |周期第一天（必填场景：type in[WEEK, MONTH, QUARTER, YEAR]）,"+ "取值范围:"+ "WEEK（初始星期，周日：1, 周一：2, 周二：3, 周三：4, 周四：5, 周五：6, 周六：7）, "+ "MONTH（初始号，月初：1, 月末：99, 2号到27号：[2~27]）, "+ "QUARTER（初始月，1月到12月：[0~11]）, "+ "YEAR（初始月，1月到12月：[0~11]）|'."\n" + .'| uuid | String | obj-123456 | 对象唯一标识 |'."\n" + .'| creatorId | String | 0123456 | 创建人BaseId |'."\n" + .'| creatorName | String | 甲乙丙丁 | 创建人名称|'."\n" + ."\n" + .'### 查询原子指标使用的FML语句如下。'."\n" + .' show atomic indicators;'."\n" + .'输出参数 '."\n" + .'| 参数名 | 参数类型 | 示例值 | 描述信息 |'."\n" + .'| ------------------- | ------------------- | ------------ | ---------------- |'."\n" + .'| dataDistinct | YesOrNoEnum | YES | 数据是否需要去重。可取值如下：<br>YES<br>NO |'."\n" + .'| aggFunctionType | AggFunctionEnum | SUM | 指标聚合函数类型。可取值如下：<br>SUM<br>COUNT<br>AVG<br>MAX<br>MIN<br>RATE<br>RANK<br>UNDEFINED|'."\n" + .'| calExpression | String | price | 计算口径(code) |'."\n" + .'| dataType | DataTypeNameEnum | TINYINT | 数据类型。可取值为：TINYINT、SMALLINT、INT、BIGINT、BINARY、FLOAT、DOUBLE、DECIMAL、VARCHAR、CHAR、STRING、DATE、DATETIME、TIMESTAMP、BOOLEAN、ARRAY、MAP、STRUCT、JSON |'."\n" + .'| dataRound | String | N | 数据精度。可取值如下：<br>N<br>M |'."\n" + .'| dataUnitUuid | String | du-123456 | 指标单位UUID |'."\n" + .'| dataUnitCode | String | percent | 指标单位CODE |'."\n" + .'| dataUnitName | String | 分 | 指标单位名称 |'."\n" + .'| bizExpression | String | 支付金额汇总 | 业务口径 |'."\n" + .'| dataRollUpType | String | AGG_FUNCTION | 数据上卷方式。可取值如下：<br>AGG_FUNCTION<br>SUM_THEN_RATE<br>RATE_THEN_AVG<br>NOT_SUPPORT |'."\n" + .'| businessUnitUuid | String | bu-0001 | 业务板块UUID |'."\n" + .'| businessUnitCode | String | project_code| 业务板块Code |'."\n" + .'| businessProcessUuid | String | di-0002| 业务过程UUID |'."\n" + .'| businessProcessCode | String | pay| 业务过程Code|'."\n" + .'| businessProcessName | String | 支付 | 业务过程Name |'."\n" + .'| dataDomainUuid | String | di-0003 | 数据域UUID |'."\n" + .'| dataDomainCode | String | trd| 数据域Code |'."\n" + .'| dataDomainName | String | 交易 | 数据域Name |'."\n" + .'| categoryUuid | String | di-0001 | 业务分类UUID |'."\n" + .'| categoryCode | String | tb | 业务分类Code |'."\n" + .'| categoryName | String | 淘宝| 业务分类Name |'."\n" + .'| type |String | ATOMIC | 指标类型。可取值如下：<br> ATOMIC<br> DERIVATIVE<br> DERIVATIVE_COMPOSITE |'."\n" + .'| code | String | pay_amt | 英文缩写 |'."\n" + .'| name | String |支付金额 | 中文名称 |'."\n" + .'| extendName | String | pay amount | 英文名称 |'."\n" + .'| description | String | remark | 描述 |'."\n" + .'| status | String | NORMAL | 指标状态。可取值如下：<br>DRAFT<br>DEV<br>NORMAL |'."\n" + .'| ownerId | String | 0001 | 负责人BaseId |'."\n" + .'| ownerName | String | 负责人姓名 | 负责人名称 |'."\n" + .'| isDeleted | DeleteTagEnum | NO | 是否被删除。可取值如下：<br>YES <br>NO|'."\n" + .'| uuid | String | obj-123456 | 对象唯一标识 |'."\n" + .'| gmtCreate | TimeStamp | 1644397025000 | 创建时间 |'."\n" + .'| gmtModified | TimeStamp | 1644459965000 | 修改时间 |'."\n" + .'| creatorId | String | 0123456 | 创建人BaseId |'."\n" + .'| creatorName | String | 甲乙丙丁 | 创建人名称 |'."\n" + .'| modifierId | String | 0123456 | 修改人BaseId |'."\n" + .'| modifierName | String | 甲乙丙丁 | 修改人名称 |'."\n" + ."\n" + .'### 查询派生指标使用的FML语句如下。'."\n" + .' show derivative indicators;'."\n" + .'输出参数'."\n" + .'| 参数名 | 参数类型 | 示例值 | 描述信息 |'."\n" + .'| ---------------------- | ------------------- | ------------------ | ------------------ |'."\n" + .'| timePeriodUuid | String | tp-0001 | 时间周期UUID |'."\n" + .'| timePeriodCode | String | 1d | 时间周期英文缩写 |'."\n" + .'| timePeriodName | String | 近1天 | 时间周期中文名称 |'."\n" + .'| adjunctUuids | List | ["adj-001"]| 修饰词UUID列表 |'."\n" + .'| adjunctCodes | List |["male"]| 修饰词英缩写列表 |'."\n" + .'| adjunctNames | List | 男性 | 修饰词中文名称列表 |'."\n" + .'| atomicIndicatorUuid | String | ind-a-0001 | 原子指标UUID |'."\n" + .'| atomicIndicatorCode | String | pay_amt | 原子指标英文缩写 |'."\n" + .'| atomicIndicatorName | String | 支付金额 | 原子指标中文名称 |'."\n" + .'| dataType | DataTypeNameEnum | BIGINT | 数据类型。可取值为：TINYINT、SMALLINT、INT、BIGINT、BINARY、FLOAT、DOUBLE、DECIMAL、VARCHAR、CHAR、STRING、DATE、DATETIME、TIMESTAMP、BOOLEAN、ARRAY、MAP、STRUCT、JSON |'."\n" + .'| bizEntityUuid | String | dim-123456 | 业务对象UUID |'."\n" + .'| bizEntityCode | String | dim_shop | 业务对象英文缩写 |'."\n" + .'| bizEntityName | String | 店铺表 | 业务对象中文名称 |'."\n" + .'| relUuid | String | dim_a-123456 | 关联维度UUID |'."\n" + .'| indHash | String | hash-0001 | 指标hash |'."\n" + .'| suggestCode | String | pay_amt_1d | 推荐编码 |'."\n" + .'| businessUnitUuid | String | bu-0001 | 业务板块UUID |'."\n" + .'| businessUnitCode | String | project_code | 业务板块Code |'."\n" + .'| businessProcessUuid | String | di-0002 | 业务过程UUID |'."\n" + .'| businessProcessCode | String | pay | 业务过程Code |'."\n" + .'| businessProcessName | String | 支付 | 业务过程Name |'."\n" + .'| dataDomainUuid | String | di-0003 | 数据域UUID |'."\n" + .'| dataDomainCode | String | trd | 数据域Code |'."\n" + .'| dataDomainName | String | 交易 | 数据域Name |'."\n" + .'| categoryUuid | String | di-0001 | 业务分类UUID |'."\n" + .'| categoryCode | String | tb | 业务分类Code |'."\n" + .'| categoryName | String | 淘宝 | 业务分类Name |'."\n" + .'| type | IndicatorTypeEnum | ATOMIC | 指标类型。可取值如下：<br> ATOMIC<br> DERIVATIVE<br> DERIVATIVE_COMPOSITE |'."\n" + .'| code | String | pay_amt | 英文缩写 |'."\n" + .'| name | String | 支付金额 | 中文名称 |'."\n" + .'| extendName | String | pay amount | 英文名称 |'."\n" + .'| description | String | remark | 描述 |'."\n" + .'| status | IndicatorStatusEnum | NORMAL | 指标状态。可取值如下：<br>DRAFT<br>DEV<br>NORMAL |'."\n" + .'| ownerId | String | 0001 | 负责人BaseId |'."\n" + .'| ownerName | String | 负责人姓名 | 负责人名称 |'."\n" + .'| isDeleted | DeleteTagEnum | NO | 是否被删除。可取值如下：<br>YES <br>NO |'."\n" + .'| uuid | String | obj-123456 | 对象唯一标识 |'."\n" + .'| gmtCreate | TimeStamp | 1644397025000 | 创建时间 |'."\n" + .'| gmtModified | TimeStamp | 1644459965000 | 修改时间 |'."\n" + .'| creatorId | String | 0123456 | 创建人BaseId |'."\n" + .'| creatorName | String | 甲乙丙丁 | 创建人名称 |'."\n" + .'| modifierId | String | 0123456 | 修改人BaseId |'."\n" + .'| modifierName | String | 甲乙丙丁 | 修改人名称 |'."\n" + ."\n" + .'### 查询复合指标使用的FML语句如下。'."\n" + .'show derivative composite indicators;'."\n" + .'输出参数'."\n" + .'| 参数名 | 参数类型 | 示例值 | 描述信息 |'."\n" + .'| ---------------------- | ------------------- | ------------------ | ------------------ |'."\n" + .'| businessUnitCode | String | project_code | 工作空间名称 |'."\n" + .'| businessProcessUuid | String | di-0002 | 业务过程UUID |'."\n" + .'| businessProcessCode | String | pay | 业务过程Code |'."\n" + .'| businessProcessName | String | 支付 | 业务过程名称 |'."\n" + .'| dataDomainUuid | String | di-0003 | 数据域UUID |'."\n" + .'| dataDomainCode | String | trd | 数据域Code |'."\n" + .'| dataDomainName | String | 交易 | 数据域名称 |'."\n" + .'| categoryUuid | String | di-0001 | 业务分类UUID |'."\n" + .'| categoryCode | String | tb | 业务分类Code |'."\n" + .'| categoryName | String | 淘宝 | 业务分类名称 |'."\n" + .'| type | String | DERIVATIVE_COMPOSITE | 计算模式。可取值DERIVATIVE_COMPOSITE （计算表达式）、DERIVATIVE_COMPARISON（同环比） |'."\n" + .'| code | String | pay_amt | 指标英文缩写 |'."\n" + .'| name | String | 支付金额 | 指标中文名称 |'."\n" + .'| extendName | String | pay amount | 指标英文名称 |'."\n" + .'| description | String | remark | 指标描述信息 |'."\n" + .'| calculateExpression | String | {@pay_amt_1d[近1天_支付金额]}/{@pay_amt_1m[近30天_支付金额]} | 计算表达式 |'."\n" + .'| comparisonPeriodType | String | DAY_MOM | 同环比对比类型。取值如下： DAY_MOM（日环比）、 WEEK_MOM（周环比）、WEEK_YOY（周同比）、MONTH_MOM（月环比）、MONTH_YOY（月同比）、QUARTER_MOM（季度环比）、YEAR_MOM（年环比）、YEAR_YOY（年同比） |'."\n" + .'| comparisonIndicatorUuid | String | obj-123456 | 同环比对比指标的UUID |'."\n" + .'| comparisonIndicatorCode | String | pay_amt_1d | 同环比对比指标的英文缩写 |'."\n" + .'| comparisonIndicatorName | String | 近1天_支付金额 | 同环比对比指标的中文名称 |'."\n" + .'| ownerId | String | 0001 | 指标负责人的BaseId |'."\n" + .'| ownerName | String | 张三 | 指标负责人的姓名 |'."\n" + .'| isDeleted | DeleteTagEnum | NO | 是否被删除，可取值YES或NO。 |'."\n" + .'| uuid | String | obj-123456 | 对象唯一标识 |'."\n" + .'| gmtCreate | TimeStamp | 1644397025000 | 指标创建时间 |'."\n" + .'| gmtModified | TimeStamp | 1644459965000 | 指标修改时间 |'."\n" + .'| creatorId | String | 0123456 | 指标创建人BaseId |'."\n" + .'| creatorName | String | 甲乙丙丁 | 指标创建人名称 |'."\n" + .'| modifierId | String | 0123456 | 指标修改人BaseId |'."\n" + .'| modifierName | String | 甲乙丙丁 | 指标修改人名称 |'."\n" + ."\n" + .'### 查询单个指标所依赖模型的相关信息，使用的FML语句如下。'."\n" + .'show statistic indicator table_code;'."\n" + .'输出参数'."\n" + .'| 参数名 | 参数类型 | 示例值 | 描述信息 |'."\n" + .'| ---------------------- | ------------------- | ------------------ | ------------------ |'."\n" + .'| uuid | String | obj-123456 | 指标唯一标识 |'."\n" + .'| code | String | pay_amt | 指标英文缩写 |'."\n" + .'| name | String | 支付金额 | 指标中文名称 |'."\n" + .'|extendName | String | pay amount | 指标英文名称 |'."\n" + .'| relations | List<EntityInfo> | 示例请参见下文 | 依赖指标的模型信息列表，EntityInfo的结构参见下文|'."\n" + ."\n" + .'EntityInfo的结构示例及参数描述如下。'."\n" + ."\n" + .'```'."\n" + .'['."\n" + .' {'."\n" + .' "uuid": "uuid",'."\n" + .' "code": "code",'."\n" + .' "name": "中文名称",'."\n" + .' "extendName": "full name in English",'."\n" + .' "entityType": "EntityTypeEnum.BASE_DERIVATIVE_INDICATOR",'."\n" + .' "entityTypeName": "实体类型名称",'."\n" + .' "entitySubType": "DERIVATIVE_INDICATOR",'."\n" + .' "entitySubTypeName": "实体子类型名称",'."\n" + .' "ownerId": "0001",'."\n" + .' "ownerName": "负责人姓名"'."\n" + .' }'."\n" + .']'."\n" + .'```'."\n" + ."\n" + .'| 参数名 | 参数类型 | 示例值 | 描述信息 |'."\n" + .'| ---------------------- | ------------------- | ------------------ | ------------------ |'."\n" + .'| uuid | String | obj-123456 | 模型唯一标识 |'."\n" + .'| code | String | dws_001| 模型英文缩写 |'."\n" + .'| name | String | 支付汇总表 | 模型中文名称 |'."\n" + .'| extendName | String | dws_001| 模型英文名称 |'."\n" + .'| entityType | EntityTypeEnum | Table | 依赖指标的实体类型。取值包括但不限于`TABLE、BASE_ATOMIC_INDICATOR、BASE_DERIVATIVE_INDICATOR` |'."\n" + .'| entityTypeName | String | 表 | 实体类型名称 |'."\n" + .'| entitySubType | String | DWS_TABLE | 实体子类型。取值包括但不限于`DWS_TABLE、ATOMIC_INDICATOR、DERIVATIVE_INDICATOR` |'."\n" + .'| entitySubTypeName | String | 汇总表 | 实体子类型名称 |'."\n" + .'| ownerId | String | 0001 | 负责人BaseId |'."\n" + .'| ownerName | String | 张三 | 负责人名称 |', + 'extraInfo' => ' ', + ], + 'GetAlertMessage' => [ + 'summary' => '调用GetAlertMessage接口，通过获取的AlertId查询报警信息。', + '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' => '报警ID，可调用[ListAlertMessages](~~173961~~)获取。', + 'type' => 'string', + 'required' => true, + 'example' => '1421', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求的ID。用于定位日志，排查问题。'."\n" + ."\n", + 'type' => 'string', + 'example' => '0000-ABCD-EFG****', + ], + 'HttpStatusCode' => [ + 'description' => 'HTTP状态码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'ErrorMessage' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'The specified parameters are invalid.', + ], + 'ErrorCode' => [ + 'description' => '错误码。', + 'type' => 'string', + 'example' => 'Invalid.Tenant.ConnectionNotExists', + ], + 'Success' => [ + 'description' => '调用是否成功。取值如下：'."\n" + .'- true：调用成功。'."\n" + .'- false：调用失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Data' => [ + 'description' => '返回数据详情。', + 'type' => 'object', + 'properties' => [ + 'RemindId' => [ + 'description' => '当Source（报警来源）为REMIND_ALERT（自定义报警）时，返回触发的自定义监控规则ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1234', + ], + 'AlertMessageStatus' => [ + 'description' => '报警信息的发送状态。取值如下：'."\n" + .'- READY_TO_SEND（准备发送）'."\n" + .'- SEND_FAIL（发送失败）'."\n" + .'- SEND_SUCCESS（发送成功）'."\n" + .'- SEND_OVERLIMIT（报警超限）', + 'type' => 'string', + 'example' => 'READY_TO_SEND', + ], + 'AlertUser' => [ + 'description' => '报警信息接收人的阿里云UID。', + 'type' => 'string', + 'example' => '9527952795****', + ], + 'AlertTime' => [ + 'description' => '报警时间。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1553524393000', + ], + 'AlertMethod' => [ + 'description' => '报警方式。取值如下：'."\n" + .'- MAIL（邮件）'."\n" + .'- SMS（短信）'."\n" + .'- PHONE（电话，仅DataWorks专业版及以上版本支持）', + 'type' => 'string', + 'example' => 'SMS', + ], + 'Source' => [ + 'description' => '报警来源。取值如下：'."\n" + .'- REMIND_ALERT（自定义报警）'."\n" + .'- TOPIC_ALERT（事件报警）'."\n" + .'- SLA_ALERT（基线预警）'."\n" + .'- NODE_CYCLE_ALERT（节点成环报警）'."\n" + .'- NODE_LONELY_ALERT（节点孤立报警）', + 'type' => 'string', + 'example' => 'REMIND_ALERT', + ], + 'Content' => [ + 'description' => '报警内容。', + 'type' => 'string', + 'example' => 'Node error', + ], + 'RemindName' => [ + 'description' => '当Source（报警来源）为REMIND_ALERT（自定义提醒）时，返回触发的自定义监控规则名称。', + 'type' => 'string', + 'example' => 'Custom monitoring rule name', + ], + 'AlertId' => [ + 'description' => '报警ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '123', + ], + 'Instances' => [ + 'description' => '当Source（报警来源）为REMIND_ALERT（自定义提醒）时，返回触发自定义监控规则的实例列表。其它类型的报警来源返回为空。', + 'type' => 'array', + 'items' => [ + 'description' => '实例信息。', + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => '实例状态。取值如下：'."\n" + .'- NOT_RUN（未运行）'."\n" + .'- WAIT_TIME（等待时间）'."\n" + .'- WAIT_RESOURCE（等待资源）'."\n" + .'- RUNNING（运行中）'."\n" + .'- CHECKING（校检中）'."\n" + .'- CHECKING_CONDITION（条件检测中）'."\n" + .'- FAILURE（运行失败）'."\n" + .'- SUCCESS（运行成功）', + 'type' => 'string', + 'example' => 'NOT_RUN', + ], + 'InstanceId' => [ + 'description' => '实例的ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '12312****', + ], + 'NodeName' => [ + 'description' => '节点的名称。', + 'type' => 'string', + 'example' => 'Node name', + ], + 'NodeId' => [ + 'description' => '节点的ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1234', + ], + 'ProjectId' => [ + 'description' => '节点所在工作空间的ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1234', + ], + ], + ], + ], + 'Topics' => [ + 'description' => '当Source（报警来源）为TOPIC_ALERT（全局事件告警）时，返回触发报警的事件列表。当报警来源为其它类型时，返回结果为空。', + 'type' => 'array', + 'items' => [ + 'description' => '事件信息。', + 'type' => 'object', + 'properties' => [ + 'TopicName' => [ + 'description' => '事件的名称。', + 'type' => 'string', + 'example' => 'error', + ], + 'InstanceId' => [ + 'description' => '事件关联的实例ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '12345', + ], + 'TopicId' => [ + 'description' => '事件的ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '412431', + ], + 'TopicOwner' => [ + 'description' => '事件责任人的阿里云UID。', + 'type' => 'string', + 'example' => '9527952795****', + ], + 'NodeId' => [ + 'description' => '事件关联的任务节点ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1234', + ], + 'TopicStatus' => [ + 'description' => '事件的状态。取值如下：'."\n" + .'- IGNORE（已忽略）'."\n" + .'- NEW（新发现）'."\n" + .'- FIXING（处理中）'."\n" + .'- RECOVER（已恢复）', + 'type' => 'string', + 'example' => 'FIXING', + ], + ], + ], + ], + 'Nodes' => [ + 'description' => '不同的报警来源返回不同的节点列表：'."\n" + .'当Source（报警来源）为NODE_ CYCLE_ALERT（节点成环报警）时，返回成环的节点类型。'."\n" + .'当Source（报警来源）为NODELONELYALERT（节点孤立报警）时，返回孤立的节点类型。', + 'type' => 'array', + 'items' => [ + 'description' => '节点信息。', + 'type' => 'object', + 'properties' => [ + 'Owner' => [ + 'description' => '节点责任人的阿里云UID。', + 'type' => 'string', + 'example' => '95279527952****', + ], + 'NodeName' => [ + 'description' => '节点的名称。', + 'type' => 'string', + 'example' => 'Node name', + ], + 'NodeId' => [ + 'description' => '节点的ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1234', + ], + 'ProjectId' => [ + 'description' => '节点所在工作空间的ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1234', + ], + ], + ], + ], + 'SlaAlert' => [ + 'description' => '当Source（报警来源）为SLA_ALERT（基线报警）时，返回触发基线预警的基本实例信息。当报警来源为其它类型时，返回为空。', + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => '基线状态。取值如下：'."\n" + .'- ERROR（异常）'."\n" + .'- SAFE（安全）'."\n" + .'- DANGEROUS（预警）'."\n" + .'- OVER（破线）', + 'type' => 'string', + 'example' => 'SAFE', + ], + 'BaselineOwner' => [ + 'description' => '基线责任人的阿里云UID，多个UID之间使用英文逗号（,）分隔。', + 'type' => 'string', + 'example' => '952795279****', + ], + 'BaselineId' => [ + 'description' => '基线的ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '15142123', + ], + 'BaselineName' => [ + 'description' => '基线的名称。', + 'type' => 'string', + 'example' => 'Baseline name', + ], + 'Bizdate' => [ + 'description' => '基线实例的业务日期时间戳。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1553443200000', + ], + 'ProjectId' => [ + 'description' => '基线所在工作空间的ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1234', + ], + 'InGroupId' => [ + 'description' => '基线实例的周期号：天基线为1，小时基线范围为\\[1,24]。', + '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' => '查询报警信息', + ], + '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' => '分页的页数。默认值为1、最小值为1、最大值为30。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'docRequired' => true, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'formData', + 'schema' => [ + 'description' => '每页显示的条数，默认为10，最大100条。'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'docRequired' => true, + 'example' => '10', + ], + ], + [ + 'name' => 'BeginTime', + 'in' => 'formData', + 'schema' => [ + 'description' => '起始报警时间，需要使用yyyy-MM-dd\'T\'HH:mm:ssZ的UTC格式。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '2020-04-02T00:00:00+0800', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'formData', + 'schema' => [ + 'description' => '截止报警时间，需要使用yyyy-MM-dd\'T\'HH:mm:ssZ的UTC格式。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '2020-04-04T00:00:00+0800', + ], + ], + [ + 'name' => 'RemindId', + 'in' => 'formData', + 'schema' => [ + 'description' => '自定义规则的ID，当AlertRuleTypes参数配置为USER_DEFINE自定义规则时生效。'."\n" + .'该参数与BaselineId参数配置一个即可。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'docRequired' => false, + 'example' => '9527', + ], + ], + [ + 'name' => 'AlertMethods', + 'in' => 'formData', + 'schema' => [ + 'description' => '报警方式，取值如下：'."\n" + .'- MAIL：邮件。'."\n" + .'- SMS：短信。'."\n" + .'<props="intl">可使用短信告警的地域为：新加坡、马来西亚（吉隆坡）、德国（法兰克福）。</props>'."\n" + .'<props="china">- PHONE：电话。仅DataWorks专业版及以上版本支持。</props>'."\n" + ."\n" + .'多个报警方式之间使用英文逗号（,）分隔。'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'SMS,MAIL,PHONE', + ], + ], + [ + 'name' => 'AlertUser', + 'in' => 'formData', + 'schema' => [ + 'description' => '报警接收人的阿里云UID。', + 'type' => 'string', + 'required' => false, + 'example' => '12345', + ], + ], + [ + 'name' => 'AlertRuleTypes', + 'in' => 'formData', + 'schema' => [ + 'description' => '规则类型，包括GLOBAL（全局规则）、USER_DEFINE（自定义规则）和OTHER（其它）。多个规则类型之间使用英文逗号（,）分隔。', + 'type' => 'string', + 'required' => false, + 'example' => 'GLOBAL,USER_DEFINE,OTHER', + ], + ], + [ + 'name' => 'BaselineId', + 'in' => 'formData', + 'schema' => [ + 'title' => '基线ID，当 alertRuleTypes 包含 GLOBAL 时生效，与 RemindId 互斥', + 'description' => '基线ID。当AlertRuleTypes参数配置为GLOBAL时生效。'."\n" + .'该参数与RemindId参数配置一个即可。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1234', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => [ + 'description' => 'HTTP返回码。'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'RequestId' => [ + 'description' => '本次调用的唯一ID。出现错误后，您可以根据该ID排查问题。', + 'type' => 'string', + 'example' => '0000-ABCD-EFG****', + ], + 'ErrorMessage' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'The specified parameters are invalid.', + ], + 'ErrorCode' => [ + 'description' => '错误码。', + 'type' => 'string', + 'example' => 'Invalid.Tenant.ConnectionNotExists', + ], + 'Success' => [ + 'description' => '调用是否成功。'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'Data' => [ + 'description' => '返回的报警信息列表。', + 'type' => 'object', + 'properties' => [ + 'PageNumber' => [ + 'description' => '当前的页数。', + 'type' => 'string', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '每页的大小。'."\n", + 'type' => 'string', + 'example' => '10', + ], + 'TotalCount' => [ + 'description' => '报警信息的总数。'."\n", + 'type' => 'string', + 'example' => '100', + ], + 'AlertMessages' => [ + 'description' => '报警信息列表。', + 'type' => 'array', + 'items' => [ + 'description' => '返回数据。', + 'type' => 'object', + 'properties' => [ + 'RemindId' => [ + 'description' => '当Source（报警来源）为REMIND_ALERT（自定义报警）时，返回触发的自定义监控规则ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1234', + ], + 'AlertMessageStatus' => [ + 'description' => '发送状态，包括READY_TO_SEND（准备发送）、SEND_FAIL（发送失败）、SEND_SUCCESS（发送成功）和SEND_OVERLIMIT（报警超限）。', + 'type' => 'string', + 'example' => 'READY_TO_SEND', + ], + 'AlertUser' => [ + 'description' => '接收人的阿里云UID。', + 'type' => 'string', + 'example' => '9527952795****', + ], + 'AlertTime' => [ + 'description' => '报警的时间戳。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1553531401000', + ], + 'AlertMethod' => [ + 'description' => '报警方式，包括MAIL（邮件）、SMS（短信）和 PHONE（电话，仅DataWorks专业版及以上版本支持）。', + 'type' => 'string', + 'example' => 'SMS', + ], + 'Source' => [ + 'description' => '报警来源，包括REMIND_ALERT（自定义报警）、TOPIC_ALERT（事件告警）、SLA_ALERT（基线预警）、NODE_CYCLE_ALERT（节点成环报警）和NODE_LONELY_ALERT（节点孤立报警）。', + 'type' => 'string', + 'example' => 'REMIND_ALERT', + ], + 'Content' => [ + 'description' => '报警的内容。', + 'type' => 'string', + 'example' => 'Node error', + ], + 'RemindName' => [ + 'description' => '当Source（报警来源）为REMIND_ALERT（自定义提醒）时，返回触发的自定义监控规则名称。', + 'type' => 'string', + 'example' => 'Custom monitoring rule name', + ], + 'AlertId' => [ + 'description' => '报警ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1234', + ], + 'Instances' => [ + 'description' => '当Source（报警来源）为REMIND_ALERT（自定义提醒）时，返回触发自定义监控规则的实例列表。其它类型的报警来源返回为空。', + 'type' => 'array', + 'items' => [ + 'description' => '实例信息。', + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => '实例状态，包括NOT_RUN （未运行）、WAIT_TIME（等待时间）、WAIT_RESOURCE（等待资源）、RUNNING（运行中）、CHECKING（校检中）、CHECKING_CONDITION（条件检测中）、FAILURE（运行失败）和SUCCESS（运行成功）。'."\n", + 'type' => 'string', + 'example' => 'NOT_RUN', + ], + 'InstanceId' => [ + 'description' => '实例的ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '12345', + ], + 'NodeName' => [ + 'description' => '节点的名称。', + 'type' => 'string', + 'example' => 'Node name', + ], + 'NodeId' => [ + 'description' => '节点的ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1234', + ], + 'ProjectId' => [ + 'description' => '节点所在工作空间的ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1234', + ], + ], + ], + ], + 'Topics' => [ + 'description' => '当Source（报警来源）为TOPIC_ALERT（全局事件告警）时，返回触发报警的事件列表。当报警来源为其它类型时，返回结果为空。', + 'type' => 'array', + 'items' => [ + 'description' => '事件信息。', + 'type' => 'object', + 'properties' => [ + 'TopicName' => [ + 'description' => '事件的名称。', + 'type' => 'string', + 'example' => '9527 error', + ], + 'InstanceId' => [ + 'description' => '事件关联的实例ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '12345', + ], + 'TopicId' => [ + 'description' => '事件的ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1234', + ], + 'TopicOwner' => [ + 'description' => '事件责任人的阿里云UID。', + 'type' => 'string', + 'example' => '9527952795****', + ], + 'NodeId' => [ + 'description' => '事件关联的节点ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1234', + ], + 'TopicStatus' => [ + 'description' => '事件状态，包括IGNORE（已忽略），NEW（新发现）、 FIXING（处理中）和RECOVER（已恢复）。', + 'type' => 'string', + 'example' => 'FIXING', + ], + ], + ], + ], + 'Nodes' => [ + 'description' => '不同的报警来源返回不同的节点列表：'."\n" + ."\n" + .'- 当Source（报警来源）为NODE_ CYCLE_ALERT（节点成环报警）时，返回成环的节点类型。'."\n" + ."\n" + .'- 当Source（报警来源）为NODE_LONELY_ALERT（节点孤立报警）时，返回孤立的节点类型。'."\n" + ."\n\n", + 'type' => 'array', + 'items' => [ + 'description' => '节点信息。', + 'type' => 'object', + 'properties' => [ + 'Owner' => [ + 'description' => '节点责任人的阿里云UID。', + 'type' => 'string', + 'example' => '95279527952****', + ], + 'NodeName' => [ + 'description' => '节点的名称。', + 'type' => 'string', + 'example' => 'Node name', + ], + 'NodeId' => [ + 'description' => '节点的ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1234', + ], + 'ProjectId' => [ + 'description' => '节点所在工作空间的ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1234', + ], + ], + ], + ], + 'SlaAlert' => [ + 'description' => '当Source（报警来源）为SLA_ALERT（基线报警）时，返回触发基线预警的基本实例信息。当报警来源为其它类型时，返回为空。', + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => '基线状态，包括ERROR（异常）、SAFE（安全）、DANGROUS（预警）和OVER（破线）。', + 'type' => 'string', + 'example' => 'SAFE', + ], + 'BaselineOwner' => [ + 'description' => '基线责任人的阿里云UID，多个UID之间使用英文逗号（,）分隔。', + 'type' => 'string', + 'example' => '952795279****', + ], + 'BaselineId' => [ + 'description' => '基线的ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1234', + ], + 'BaselineName' => [ + 'description' => '基线的名称。', + 'type' => 'string', + 'example' => 'Baseline name', + ], + 'Bizdate' => [ + 'description' => '基线实例的业务日期时间戳。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1553443200000', + ], + 'ProjectId' => [ + 'description' => '基线所在工作空间的ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1234', + ], + 'InGroupId' => [ + 'description' => '基线实例的周期号：天基线为1，小时基线范围为\\[1,24\\]。', + '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' => '获取报警信息的列表', + 'summary' => '调用ListAlertMessages获取报警信息的列表。', + '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' => '基线的ID。您可以通过调用[GetNode](~~173977~~)接口获取基线ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + 'example' => '1234', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => [ + 'description' => 'HTTP返回码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '401', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'ecb967ec-c137-48a5-860****', + ], + 'ErrorMessage' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'The specified parameters are invalid.', + ], + 'ErrorCode' => [ + 'description' => '错误码。', + 'type' => 'string', + 'example' => '1031203110005', + ], + 'Success' => [ + 'description' => '请求是否成功。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Data' => [ + 'description' => '基线的详情。', + 'type' => 'object', + 'properties' => [ + 'HourSlaDetail' => [ + 'description' => '小时基线的承诺时间配置（JSON格式），key为周期号，value为hh:mm格式。hh的取值范围为\\[0,47\\]，mm的取值范围为\\[0,59\\]。', + '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' => '是否为工作空间的默认基线，包括true（是）和false（否）。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Owner' => [ + 'description' => '基线责任人的阿里云UID。有多个责任人时，使用英文逗号（,）分隔。', + 'type' => 'string', + 'example' => '9527952****', + ], + 'ProjectId' => [ + 'description' => '工作空间的ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '123456', + ], + 'Priority' => [ + 'description' => '基线的优先级，取值集合为{1,3,5,7,8}。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'SlaMinu' => [ + 'description' => '天基线的承诺分钟，取值范围为\\[0, 59\\]。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '30', + ], + 'SlaHour' => [ + 'description' => '天基线的承诺小时，取值范围为\\[0, 47\\]。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '9', + ], + 'BaselineId' => [ + 'description' => '基线的ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1234', + ], + 'BaselineName' => [ + 'description' => '基线的名称。', + 'type' => 'string', + 'example' => 'Baseline name'."\n", + ], + 'HourExpDetail' => [ + 'description' => '小时基线的预警时间配置（JSON格式），key为周期号，value为hh:mm格式。hh的取值范围为\\[0,47\\]，mm的取值范围为\\[0,59\\]。', + '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' => '基线是否开启，包括true（开启）和false（未开启）。 ', + 'type' => 'boolean', + 'example' => 'true', + ], + 'ExpHour' => [ + 'description' => '天基线的预警小时，取值范围为\\[0, 47\\]。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '7', + ], + 'BaselineType' => [ + 'description' => '基线类型，包括DAILY（天基线）和HOURLY（小时基线）。', + 'type' => 'string', + 'example' => 'DAILY', + ], + 'ExpMinu' => [ + 'description' => '天基线的预警分钟，取值范围为\\[0, 59\\]。', + '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' => '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' => '获取配置详情', + 'summary' => '调用GetBaselineConfig获取配置详情。', + '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' => '基线的ID。您可以通过调用[ListBaselineConfigs](~~173964~~)接口获取基线ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + 'example' => '1234', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => [ + 'description' => 'HTTP状态码。'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'RequestId' => [ + 'description' => '请求ID。用于出现错误后排查问题。'."\n", + 'type' => 'string', + 'example' => '0000-ABCD-E****', + ], + 'ErrorMessage' => [ + 'description' => '错误信息。'."\n", + 'type' => 'string', + 'example' => 'The specified parameters are invalid.', + ], + 'ErrorCode' => [ + 'description' => '错误码。'."\n", + 'type' => 'string', + 'example' => '1031203110005', + ], + 'Success' => [ + 'description' => '调用是否成功。'."\n", + 'type' => 'string', + 'example' => 'true', + ], + 'Data' => [ + 'description' => '基线中的节点列表。'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Owner' => [ + 'description' => '节点责任人的阿里云UID。'."\n", + 'type' => 'string', + 'example' => '9527952****', + ], + 'NodeName' => [ + 'description' => '节点的名称。'."\n", + 'type' => 'string', + 'example' => 'Node name', + ], + 'NodeId' => [ + 'description' => '节点的ID。'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '12345', + ], + 'ProjectId' => [ + 'description' => '节点所在工作空间的ID。'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '12345', + ], + ], + ], + ], + ], + ], + ], + ], + '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' => '获取基线中的节点', + 'summary' => '获取基线中的节点（不包含这些节点的上游节点）。', + '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' => '分页的页数。默认值为1，最小值为1，最大值为30。'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'docRequired' => true, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'formData', + 'schema' => [ + 'description' => '每页返回的数据行数。默认值为10，最小值为1，最大值为100。'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'docRequired' => true, + 'example' => '10', + ], + ], + [ + 'name' => 'Owner', + 'in' => 'formData', + 'schema' => [ + 'description' => '基线责任人的阿里云UID。', + 'type' => 'string', + 'required' => false, + 'example' => '95279527****', + ], + ], + [ + 'name' => 'ProjectId', + 'in' => 'formData', + 'schema' => [ + 'description' => '工作空间的ID。您可以通过ListProjects接口获取工作空间ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + 'example' => '1234', + ], + ], + [ + 'name' => 'Priority', + 'in' => 'formData', + 'schema' => [ + 'description' => '基线的优先级，取值范围为{1,3,5,7,8} 。多个优先级之间使用英文逗号（,）分隔。', + 'type' => 'string', + 'required' => false, + 'example' => '1,3,5,7,8', + ], + ], + [ + 'name' => 'Useflag', + 'in' => 'formData', + 'schema' => [ + 'description' => '是否开启，包括true（开启）和false（未开启）。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'BaselineTypes', + 'in' => 'formData', + 'schema' => [ + 'description' => '基线类型，包括DAILY（天基线）和HOURLY（小时基线）。多个类型之间使用英文逗号（,）分隔。'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'DAILY,HOURLY', + ], + ], + [ + 'name' => 'SearchText', + 'in' => 'formData', + 'schema' => [ + 'description' => '基线名称的搜索关键字。', + 'type' => 'string', + 'required' => false, + 'example' => 'Baseline name search keywords', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'description' => '返回数据结构。', + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => [ + 'description' => 'HTTP返回码。'."\n" + ."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'RequestId' => [ + 'description' => '本次调用的唯一ID。出现错误后，您可以根据该ID排查问题。'."\n", + 'type' => 'string', + 'example' => '0000-ABCD-EFG****', + ], + 'ErrorMessage' => [ + 'description' => '错误信息。'."\n", + 'type' => 'string', + 'example' => 'The specified parameters are invalid.', + ], + 'ErrorCode' => [ + 'description' => '错误码。', + 'type' => 'string', + 'example' => '1031203110005', + ], + 'Success' => [ + 'description' => '调用是否成功。'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'Data' => [ + 'description' => '返回的基线列表。', + 'type' => 'object', + 'properties' => [ + 'PageNumber' => [ + 'description' => '当前的页数。'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '每页的大小。'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'TotalCount' => [ + 'description' => '基线的总数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '100', + ], + 'Baselines' => [ + 'description' => '基线列表。', + 'type' => 'array', + 'items' => [ + 'description' => '返回数据结构。', + 'type' => 'object', + 'properties' => [ + 'HourSlaDetail' => [ + 'description' => '小时基线的承诺时间配置（JSON格式），key为周期号，value为hh:mm格式。hh的取值范围为\\[0,47\\]，mm的取值范围为\\[0,59\\]。', + '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' => '是否为工作空间的默认基线，包括true（是）和false（否）。'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'Owner' => [ + 'description' => '基线责任人的阿里云UID。有多个责任人时，使用英文逗号（,）分隔。'."\n", + 'type' => 'string', + 'example' => '952795****', + ], + 'ProjectId' => [ + 'description' => '基线所在工作空间的ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '100001', + ], + 'Priority' => [ + 'description' => '基线的优先级，取值集合为{1,3,5,7,8}。'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'SlaMinu' => [ + 'description' => '天基线的预警分钟，取值范围为\\[0, 59\\]。'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '30', + ], + 'SlaHour' => [ + 'description' => '天基线的承诺小时，取值范围为\\[0, 47\\]。'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '9', + ], + 'BaselineId' => [ + 'description' => '基线的ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1234', + ], + 'BaselineName' => [ + 'description' => '基线的名称。', + 'type' => 'string', + 'example' => 'Baseline name', + ], + 'HourExpDetail' => [ + 'description' => '小时基线的预警时间配置（JSON格式），key为周期号，value为hh:mm格式。hh的取值范围为\\[0,47\\]，mm的取值范围为\\[0,59\\]。', + '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' => '基线是否开启，包括true（开启）和false（未开启）。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'ExpHour' => [ + 'description' => '天基线的预警小时，取值范围为\\[0, 47\\]。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '7', + ], + 'BaselineType' => [ + 'description' => '基线类型，包括DAILY（天基线）和HOURLY（小时基线）。 '."\n", + 'type' => 'string', + 'example' => 'DAILY', + ], + 'ExpMinu' => [ + 'description' => '天基线的预警分钟，取值范围为\\[0, 59\\]。', + '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' => '获取基线列表', + 'summary' => '调用ListBaselineConfigs获取基线列表。', + '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' => '基线的ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + 'example' => '1234', + ], + ], + [ + 'name' => 'Bizdate', + 'in' => 'formData', + 'schema' => [ + 'description' => '业务日期，需要使用yyyy-MM-dd\'T\'HH:mm:ssZ的UTC格式。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '2020-07-07T00:00:00+0800', + ], + ], + [ + 'name' => 'InGroupId', + 'in' => 'formData', + 'schema' => [ + 'description' => '基线实例周期号。天基线为1，小时基线的取值范围为\\[1,24\\]。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'docRequired' => true, + 'example' => '1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => [ + 'description' => 'HTTP返回码。'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'RequestId' => [ + 'description' => '本次调用的唯一ID。出现错误后，您可以根据该ID排查问题。', + 'type' => 'string', + 'example' => '0000-ABCD-EFG****', + ], + 'ErrorMessage' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'The specified parameters are invalid.', + ], + 'ErrorCode' => [ + 'description' => '错误码。'."\n", + 'type' => 'string', + 'example' => '1031203110005', + ], + 'Success' => [ + 'description' => '调用是否成功。'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'Data' => [ + 'description' => '关键路径信息。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Owner' => [ + 'description' => '节点责任人的阿里云UID。', + 'type' => 'string', + 'example' => '9527952****', + ], + 'NodeName' => [ + 'description' => '节点的名称。', + 'type' => 'string', + 'example' => 'Node name', + ], + 'Bizdate' => [ + 'description' => '实例的业务日期时间戳。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1553443200000', + ], + 'ProjectId' => [ + 'description' => '节点所在工作空间的ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1234', + ], + 'InstanceId' => [ + 'description' => '实例的ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '123456', + ], + 'PrgType' => [ + 'description' => '节点类型，常用的节点类型包括数据集成（23）、MaxCompute SQL（10）、Shell（6）和虚节点（99）。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'NodeId' => [ + 'description' => '节点的ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1234', + ], + 'InGroupId' => [ + 'description' => '实例周期号，取值范围为\\[1,288\\]。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Runs' => [ + 'description' => '实例的运行记录。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => '实例的状态，包括NOT_RUN（未运行）、WAIT_TIME（等待时间）、WAIT_RESOURCE（等待资源）、RUNNING（运行中）、CHECKING（校检中）、CHECKING_CONDITION（条件检测中）、FAILURE（运行失败）和SUCCESS（运行成功）。', + 'type' => 'string', + 'example' => 'SUCCESS', + ], + 'AbsTime' => [ + 'description' => '实例的预计开始运行时间+历史平均运行时长得到的时间戳。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1553531402000', + ], + 'BeginRunningTime' => [ + 'description' => '实例实际开始运行的时间戳。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1553531401000', + ], + 'FinishTime' => [ + 'description' => '实例的实际运行结束时间戳。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1553531401000', + ], + 'BeginCast' => [ + 'description' => '实例预计开始运行的时间戳。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1553531686000', + ], + 'EndCast' => [ + 'description' => '实例的预计运行结束时间戳。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1553531687000', + ], + 'BeginWaitResTime' => [ + 'description' => '实例开始进入等待资源状态的时间戳。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1553531401000', + ], + 'BeginWaitTimeTime' => [ + 'description' => '实例开始进入等待时间状态的时间戳。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1553531400000', + ], + ], + ], + ], + 'Topics' => [ + 'description' => '实例关联的事件信息。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'TopicName' => [ + 'description' => '事件的名称。', + 'type' => 'string', + 'example' => '1234', + ], + 'InstanceId' => [ + 'description' => '实例的ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1234', + ], + 'TopicId' => [ + 'description' => '事件的ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1234', + ], + 'AddTime' => [ + 'description' => '事件发现时间戳。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1553531401000', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + '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' => '获取基线实例的关键路径', + 'summary' => '调用GetBaselineKeyPath获取基线实例的关键路径。', + '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' => '基线的ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + 'example' => '1234', + ], + ], + [ + 'name' => 'Bizdate', + 'in' => 'formData', + 'schema' => [ + 'description' => '业务日期，需要使用UTC格式（yyyy-MM-dd\'T\'HH:mm:ssZ）。'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '2020-07-07T00:00:00+0800', + ], + ], + [ + 'name' => 'InGroupId', + 'in' => 'formData', + 'schema' => [ + 'description' => '基线实例的周期号。天基线为1，小时基线的取值范围为\\[1,24\\]。'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'docRequired' => true, + 'example' => '1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => [ + 'description' => 'HTTP返回码。'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'RequestId' => [ + 'description' => '本次调用的唯一ID。出现错误后，您可以根据该ID排查问题。'."\n", + 'type' => 'string', + 'example' => '0000-ABCD-EFG****', + ], + 'ErrorMessage' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'The specified parameters are invalid.', + ], + 'ErrorCode' => [ + 'description' => '错误码。', + 'type' => 'string', + 'example' => '1031203110005', + ], + 'Success' => [ + 'description' => '调用是否成功。'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'Data' => [ + 'description' => '基线实例的详情。', + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => '基线的状态，包括ERROR（异常）、SAFE（安全）、DANGROUS（预警）和OVER（破线）。', + 'type' => 'string', + 'example' => 'SAFE', + ], + 'Owner' => [ + 'description' => '基线责任人的阿里云UID。多个责任人之间使用英文逗号（,）分隔。', + 'type' => 'string', + 'example' => '9527952795****', + ], + 'FinishTime' => [ + 'description' => '当FinishStatus（基线实例完成状态）为FINISH（已完成）时，返回基线实例的完成时间戳。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1553443200000', + ], + 'ProjectId' => [ + 'description' => '基线所在工作空间的ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1234', + ], + 'Priority' => [ + 'description' => '基线的优先级，取值范围为{1,2,5,7,8}。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'EndCast' => [ + 'description' => '基线实例的预计产出时间戳。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1553443200000', + ], + 'InGroupId' => [ + 'description' => '基线实例的周期号。天基线为1，小时基线的取值范围为\\[1,24\\]。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'BaselineName' => [ + 'description' => '基线的名称。', + 'type' => 'string', + 'example' => '基线名称', + ], + 'BaselineId' => [ + 'description' => '基线的ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1234', + ], + 'FinishStatus' => [ + 'description' => '基线实例是否完成，包括UNFINISH（未完成）和FINISH（已完成）。'."\n", + 'type' => 'string', + 'example' => 'UNFINISH', + ], + 'Bizdate' => [ + 'description' => '业务日期时间戳。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1553443200000', + ], + 'Buffer' => [ + 'description' => '基线实例的余量，单位为秒。', + 'type' => 'number', + 'format' => 'float', + 'example' => '1200', + ], + 'SlaTime' => [ + 'description' => '基线实例的承诺时间戳。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1553443200000', + ], + 'ExpTime' => [ + 'description' => '基线实例的预警时间戳。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1553443200000', + ], + 'LastInstance' => [ + 'description' => '最晚实例信息。', + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => '实例的状态，包括NOT_RUN（未运行）、WAIT_TIME（等待时间）、WAIT_RESOURCE（等待资源）、RUNNING（运行中）、CHECKING（校检中）、CHECKING_CONDITION（条件检测中）、FAILURE（运行失败）和SUCCESS（运行成功）。', + 'type' => 'string', + 'example' => 'SUCCESS', + ], + 'Owner' => [ + 'description' => '节点责任人的阿里云UID。', + 'type' => 'string', + 'example' => '9527952795****', + ], + 'FinishTime' => [ + 'description' => '实例的实际完成时间戳。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1553443200000', + ], + 'NodeName' => [ + 'description' => '节点的名称。', + 'type' => 'string', + 'example' => '节点名称', + ], + 'ProjectId' => [ + 'description' => '节点所在工作空间的ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1234', + ], + 'InstanceId' => [ + 'description' => '实例的ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '12345', + ], + 'EndCast' => [ + 'description' => '实例的预计完成时间戳。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1553443200000', + ], + 'NodeId' => [ + 'description' => '节点的ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1234', + ], + ], + ], + 'BlockInstance' => [ + 'description' => '关键实例信息。', + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => '实例的状态，包括NOT_RUN（未运行）、WAIT_TIME（等待时间）、WAIT_RESOURCE（等待资源）、RUNNING（运行中）、CHECKING（校检中）、CHECKING_CONDITION（条件检测中）、FAILURE（运行失败）和SUCCESS（运行成功）。', + 'type' => 'string', + 'example' => 'SUCCESS', + ], + 'Owner' => [ + 'description' => '节点责任人的阿里云UID。', + 'type' => 'string', + 'example' => '9527952795****', + ], + 'FinishTime' => [ + 'description' => '实例的实际完成时间戳。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1553443200000', + ], + 'NodeName' => [ + 'description' => '节点的名称。', + 'type' => 'string', + 'example' => '节点名称', + ], + 'ProjectId' => [ + 'description' => '节点所在工作空间的ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1234', + ], + 'InstanceId' => [ + 'description' => '实例的ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '12345', + ], + 'EndCast' => [ + 'description' => '实例的预计完成时间戳。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1553443200000', + ], + 'NodeId' => [ + 'description' => '节点的ID。', + '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' => '获取基线实例的详情', + 'summary' => '调用GetBaselineStatus获取基线实例的详情。', + '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' => '分页的页数。默认值为1，最小值为1，最大值为30。'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'docRequired' => true, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'formData', + 'schema' => [ + 'description' => '每页显示的条数，默认值为10，最大值为100。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'docRequired' => true, + 'example' => '10', + ], + ], + [ + 'name' => 'Bizdate', + 'in' => 'formData', + 'schema' => [ + 'description' => '业务日期，需要使用UTC格式（yyyy-MM-dd\'T\'HH:mm:ssZ）。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '2020-07-07T00:00:00+0800', + ], + ], + [ + 'name' => 'Priority', + 'in' => 'formData', + 'schema' => [ + 'description' => '基线的优先级，取值范围为{1,3,5,7,8}。多个优先级之间使用英文逗号（,）分隔。', + 'type' => 'string', + 'required' => false, + 'example' => '1,3,5,7,8', + ], + ], + [ + 'name' => 'SearchText', + 'in' => 'formData', + 'schema' => [ + 'description' => '搜索关键字，支持基线名称和基线ID，如果输入小时基线ID，则会返回该小时基线所有实例。', + 'type' => 'string', + 'required' => false, + 'example' => '关键词', + ], + ], + [ + 'name' => 'Owner', + 'in' => 'formData', + 'schema' => [ + 'description' => '基线责任人的阿里云UID。', + 'type' => 'string', + 'required' => false, + 'example' => '9527952795****', + ], + ], + [ + 'name' => 'TopicId', + 'in' => 'formData', + 'schema' => [ + 'description' => '相关事件的ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1234', + ], + ], + [ + 'name' => 'FinishStatus', + 'in' => 'formData', + 'schema' => [ + 'description' => '基线实例是否完成，包括UNFINISH（未完成）、FINISH（已完成）。多个状态之间使用英文逗号（,）分隔。', + 'type' => 'string', + 'required' => false, + 'example' => 'FINISH,UNFINISH', + ], + ], + [ + 'name' => 'Status', + 'in' => 'formData', + 'schema' => [ + 'description' => '基线的状态，包括ERROR（异常）、SAFE（安全）、DANGROUS（预警）和OVER（破线）。多个状态之间使用英文逗号（,）分隔。 ', + 'type' => 'string', + 'required' => false, + 'example' => 'SAFE,DANGROUS,OVER', + ], + ], + [ + 'name' => 'BaselineTypes', + 'in' => 'formData', + 'schema' => [ + 'description' => '基线的类型，包括DAILY（天基线）和HOURLY（小时基线）。多个类型之间使用英文逗号（,）分隔。', + 'type' => 'string', + 'required' => false, + 'example' => 'DAILY,HOURLY', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回数据。', + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => [ + 'description' => 'HTTP返回码。'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'RequestId' => [ + 'description' => '本次调用的唯一ID。出现错误后，您可以根据该ID排查问题。'."\n", + 'type' => 'string', + 'example' => '0000-ABCD-EFG****', + ], + 'ErrorMessage' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'The specified parameters are invalid.', + ], + 'ErrorCode' => [ + 'description' => '错误码。', + 'type' => 'string', + 'example' => 'Invalid.Tenant.ConnectionNotExists', + ], + 'Success' => [ + 'description' => '调用是否成功。'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'Data' => [ + 'description' => '返回的基线实例列表。', + 'type' => 'object', + 'properties' => [ + 'PageNumber' => [ + 'description' => '当前的页数。'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '每页的大小。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'TotalCount' => [ + 'description' => '基线实例的总数。'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '100', + ], + 'BaselineStatuses' => [ + 'description' => '基线实例列表。', + 'type' => 'array', + 'items' => [ + 'description' => '基线实例列表信息。', + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => '基线的状态，包括ERROR（异常）、SAFE（安全）、DANGEROUS（预警）和OVER（破线）。', + 'type' => 'string', + 'example' => 'SAFE', + ], + 'Owner' => [ + 'description' => '基线责任人的阿里云UID。多个责任人之间使用英文逗号（,）分隔。', + 'type' => 'string', + 'example' => '9527952795****', + ], + 'FinishTime' => [ + 'description' => '当FinishStatus（基线实例完成状态）为FINISH（已完成）时，返回基线实例的完成时间戳。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1553531400000', + ], + 'ProjectId' => [ + 'description' => '基线所在工作空间的ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1234', + ], + 'Priority' => [ + 'description' => '基线的优先级，取值范围为{1,3,5,7,8}。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'EndCast' => [ + 'description' => '基线实例的预计完成时间。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1553531400000', + ], + 'InGroupId' => [ + 'description' => '基线实例的周期号。天基线为1，小时基线的取值范围为\\[1,24]。'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'BaselineName' => [ + 'description' => '基线的名称。', + 'type' => 'string', + 'example' => '基线名称', + ], + 'BaselineId' => [ + 'description' => '基线的ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1234', + ], + 'FinishStatus' => [ + 'description' => '基线实例是否完成，包括UNFINISH（未完成）和FINISH（已完成）。', + 'type' => 'string', + 'example' => 'UNFINISH', + ], + 'Bizdate' => [ + 'description' => '业务日期时间戳。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1553443200000', + ], + 'Buffer' => [ + 'description' => '基线实例的余量，单位为秒。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1800', + ], + 'SlaTime' => [ + 'description' => '基线实例的实际完成时间。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1553531400000', + ], + 'ExpTime' => [ + 'description' => '基线实例的预警时间。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1553531400000', + ], + 'BaselineType' => [ + 'description' => '基线的类型，包括DAILY（天基线）和HOURLY（小时基线）。', + 'type' => 'string', + 'example' => '基线类型', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + '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' => '获取基线实例列表', + 'summary' => '调用ListBaselineStatuses获取基线实例列表。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DeleteRemind' => [ + 'summary' => '调用DeleteRemind删除自定义监控报警规则。', + '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' => '自定义监控报警规则的ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + 'example' => '1234', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => [ + 'description' => 'HTTP返回码。'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Data' => [ + 'description' => '是否删除成功，包括true（删除成功）和false（删除失败）。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'ErrorMessage' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'The specified parameters are invalid.', + ], + 'RequestId' => [ + 'description' => '本次调用的唯一ID。出现错误后，您可以根据该ID排查问题。', + 'type' => 'string', + 'example' => '0000-ABCD-EFG****', + ], + 'Success' => [ + 'description' => '调用是否成功。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'ErrorCode' => [ + 'description' => '错误码。'."\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' => '删除自定义监控报警规则', + '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' => '自定义规则的ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + 'example' => '1234', + ], + ], + [ + 'name' => 'RemindName', + 'in' => 'formData', + 'schema' => [ + 'description' => '自定义规则的名称，不能超过128个字符。', + 'type' => 'string', + 'required' => false, + 'example' => 'update_remindname', + ], + ], + [ + 'name' => 'DndEnd', + 'in' => 'formData', + 'schema' => [ + 'description' => '免打扰的截止时间，即在设置的时间之前不会发送报警。格式为hh:mm。hh的取值范围为\\[0,23\\] ，mm的取值范围为\\[0,59\\]。', + 'type' => 'string', + 'required' => false, + 'example' => '08:00', + ], + ], + [ + 'name' => 'RemindUnit', + 'in' => 'formData', + 'schema' => [ + 'description' => '监控对象的类型。取值如下：'."\n" + .'- NODE（节点）'."\n" + .'- BASELINE（基线）'."\n" + .'- PROJECT（工作空间）'."\n" + .'- BIZPROCESS（业务流程）', + 'type' => 'string', + 'required' => false, + 'example' => 'NODE', + 'enum' => [ + 'NODE', + 'BASELINE', + 'PROJECT', + 'BIZPROCESS', + ], + ], + ], + [ + 'name' => 'NodeIds', + 'in' => 'formData', + 'schema' => [ + 'description' => '监控对象为节点时的节点ID。一个规则最多监控50个节点，多个节点ID之间使用英文逗号（,）分隔。'."\n" + .'当RemindUnit参数取值为NODE（节点）时，当前参数生效。', + 'type' => 'string', + 'required' => false, + 'example' => '1,2,3', + ], + ], + [ + 'name' => 'BaselineIds', + 'in' => 'formData', + 'schema' => [ + 'description' => '监控对象为基线时的基线ID。一个规则最多监控5条基线，多个基线ID之间使用英文逗号（,）分隔。'."\n" + .'当RemindUnit参数取值为BASELINE（基线）时，当前参数生效。', + 'type' => 'string', + 'required' => false, + 'example' => '1,2,3', + ], + ], + [ + 'name' => 'ProjectId', + 'in' => 'formData', + 'schema' => [ + 'description' => '监控对象为工作空间时的工作空间ID。一个规则只能监控一个工作空间。'."\n" + .'当RemindUnit参数取值为PROJECT（工作空间）时，当前参数生效。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1234', + ], + ], + [ + 'name' => 'BizProcessIds', + 'in' => 'formData', + 'schema' => [ + 'description' => '监控对象为业务流程时的业务流程ID。一个规则最多监控5个业务流程，多个业务流程ID之间使用英文逗号（,）分隔。'."\n" + .'当RemindUnit参数取值为BIZPROCESS（业务流程）时，当前参数生效。', + 'type' => 'string', + 'required' => false, + 'example' => '1,2,3', + ], + ], + [ + 'name' => 'RemindType', + 'in' => 'formData', + 'schema' => [ + 'description' => '触发报警规则的条件。取值如下：'."\n" + .'- FINISHED（完成）：表示从实例运行的起始时间点开始监控，在任务运行成功时系统发送报警。'."\n" + .'- UNFINISHED（未完成）：表示从实例运行的起始时间点开始监控，到指定的目标时间点任务仍未结束运行，则系统发送报警。'."\n" + .'- ERROR（出错）：表示从实例运行的起始时间点开始监控，当任务运行出错时，系统发送报警。'."\n" + .'- CYCLE_UNFINISHED（周期未完成）：表示在指定的周期内，实例仍未结束运行，则系统发送报警。通常用于监控以小时为周期单位的实例任务。'."\n" + .'- TIMEOUT（运行超时）：表示从实例运行的起始时间点开始监控，到指定的运行时长后，该任务仍未结束运行，则系统发送报警。通常用于监控实例任务的运行时间。'."\n" + ."\n" + .'更多触发报警规则的内容，详情请参见[自定义规则](~~138172~~)。', + 'type' => 'string', + 'required' => false, + 'example' => 'FINISHED', + 'enum' => [ + 'FINISHED', + 'UNFINISHED', + 'ERROR', + 'CYCLE_UNFINISHED', + 'TIMEOUT', + 'EXHAUSTED_ERROR', + ], + ], + ], + [ + 'name' => 'MaxAlertTimes', + 'in' => 'formData', + 'schema' => [ + 'description' => '最大报警次数。取值范围为\\[1,10\\]，默认值为3。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '10', + 'minimum' => '1', + 'example' => '3', + 'default' => '3', + ], + ], + [ + 'name' => 'AlertInterval', + 'in' => 'formData', + 'schema' => [ + 'description' => '报警间隔，单位为秒。最小值为1200，默认值为1800。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'docRequired' => false, + 'maximum' => '1800', + 'minimum' => '1200', + 'example' => '1800', + 'default' => '1800', + ], + ], + [ + 'name' => 'Detail', + 'in' => 'formData', + 'schema' => [ + 'description' => '不同触发条件的参数配置详情，具体如下：'."\n" + .'- 当RemindType（触发条件）取值为FINISHED（完成）时，当前参数配置为空。'."\n" + .'- 当RemindType（触发条件）取值为UNFINISHED（未完成）时，当前参数的配置格式示例为{"hour":23,"minu":59}。hour的取值范围为\\[0,47\\]，minu的取值范围为\\[0,59\\]。'."\n" + .'- 当RemindType（触发条件）取值为ERROR（出错）时，当前参数配置为空。'."\n" + .'- 当RemindType（触发条件）取值为CYCLE_UNFINISHED（周期未完成）时，当前参数的配置格式示例为{"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"}。'."\n" + .'JSON字符串的key为周期号，取值范围为\\[1,288\\]；value为该周期对应的未完成时间，格式为hh:mm。hh的取值范围为\\[0,47\\]，mm的取值范围为\\[0,59\\]。'."\n" + .'- 当RemindType（触发条件）取值为TIMEOUT（运行超时）时，当前参数的配置格式示例为1800，单位为秒。即从实例开始运行起，运行超过30分钟触发报警。', + 'type' => 'string', + 'required' => false, + 'example' => '{"hour":23,"minu":59}', + ], + ], + [ + 'name' => 'AlertUnit', + 'in' => 'formData', + 'schema' => [ + 'description' => '报警的接收对象，包括OWNER（任务责任人）和OTHER（指定的用户）。', + 'type' => 'string', + 'required' => false, + 'example' => 'OWNER', + 'default' => '', + 'enum' => [ + 'OTHER', + 'OWNER', + ], + ], + ], + [ + 'name' => 'AlertMethods', + 'in' => 'formData', + 'schema' => [ + 'description' => '报警的方式，取值如下：'."\n" + .'- MAIL（邮件）'."\n" + .'- SMS（短信）'."\n" + .'- PHONE（电话），仅DataWorks专业版及以上版本支持使用电话方式接收报警。'."\n" + .'- DINGROBOTS（钉钉机器人），仅当配置RobotUrls参数后，该报警方式才会生效。'."\n" + .'- Webhooks（企业微信或飞书机器人），仅当配置 Webhooks 参数后，该报警方式才会生效。'."\n" + ."\n" + .'多个报警方式之间使用英文逗号（,）分隔。', + 'type' => 'string', + 'required' => false, + 'example' => 'SMS,MAIL', + 'default' => '', + 'enum' => [], + ], + ], + [ + 'name' => 'AlertTargets', + 'in' => 'formData', + 'schema' => [ + 'description' => '不同报警接收人的配置详情：'."\n" + .'- 当AlertUnit（报警接收人）取值为OWNER（节点任务责任人）时，当前参数配置为空。'."\n" + .'- 当AlertUnit（报警接收人）取值为OTHER（指定的用户）时，当前参数配置为指定用户的阿里云UID。多个阿里云UID之间使用英文逗号（,）分隔，最多支持指定10个用户接收报警。'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '9527952795279527', + ], + ], + [ + 'name' => 'UseFlag', + 'in' => 'formData', + 'schema' => [ + 'description' => '是否启用报警规则，取值如下：'."\n" + .'- true（开启）'."\n" + .'- false（关闭）', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'RobotUrls', + 'in' => 'formData', + 'schema' => [ + 'description' => '钉钉群机器人的WebHook地址，多个WebHook地址之间使用英文逗号（,）分隔。'."\n" + .'当该参数配置为undefined时，系统会清空钉钉机器人的WebHook地址。', + 'type' => 'string', + 'required' => false, + 'example' => 'https://oapi.dingtalk.com/robot/send?access_token=******************************', + ], + ], + [ + 'name' => 'Webhooks', + 'in' => 'formData', + 'schema' => [ + 'description' => '企业微信或飞书机器人的webhook地址，多个webhook地址之间使用英文逗号（,）分隔。alertMethods 中需要包含 WEBHOOKS 告警方式。当该参数配置为undefined时，系统会清空WebHook地址。'."\n" + ."\n" + .'仅DataWorks企业版支持。'."\n" + .'可用地域：华东2（上海）、西南1（成都）、华北3（张家口）、华北2（北京）、华东1（杭州）、华南1（深圳）、中国（香港）、欧洲中部 1（法兰克福）、亚太东南1（新加坡）。', + 'type' => 'string', + 'required' => false, + 'example' => 'https://open.feishu.cn/open-apis/bot/v2/hook/*******'."\n", + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => [ + 'description' => 'HTTP状态码。'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Data' => [ + 'description' => '更新自定义监控规则的返回结果。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'ErrorMessage' => [ + 'description' => '错误信息。'."\n", + 'type' => 'string', + 'example' => 'The specified parameters are invalid.', + ], + 'RequestId' => [ + 'description' => '本次调用的唯一ID。出现错误后，您可以根据该ID排查问题。', + 'type' => 'string', + 'example' => '0000-ABCD-EFG****', + ], + 'Success' => [ + 'description' => '调用是否成功。取值如下：'."\n" + .'- true（成功）'."\n" + .'- false（失败）'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'ErrorCode' => [ + 'description' => '错误码。', + 'type' => 'string', + 'example' => '1031203110005', + ], + ], + ], + ], + ], + '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' => '更新自定义报警规则', + 'summary' => '调用UpdateRemind更新自定义监控规则。', + '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' => '自定义规则的名称，不能超过128个字符。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'test_error_remind', + ], + ], + [ + 'name' => 'DndEnd', + 'in' => 'formData', + 'schema' => [ + 'description' => '免打扰截止时间，格式为hh:mm。hh的取值范围为\\[0,23\\]，mm的取值范围为\\[0,59\\]。 ', + 'type' => 'string', + 'required' => false, + 'example' => '08:00', + ], + ], + [ + 'name' => 'RemindUnit', + 'in' => 'formData', + 'schema' => [ + 'description' => '对象的类型，包括NODE（任务节点）、BASELINE（基线） 、PROJECT（工作空间）和BIZPROCESS（业务流程）。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'NODE', + 'enum' => [ + 'NODE', + 'BASELINE', + 'PROJECT', + 'BIZPROCESS', + ], + ], + ], + [ + 'name' => 'NodeIds', + 'in' => 'formData', + 'schema' => [ + 'description' => 'RemindUnit（对象类型）为NODE（任务节点）时，监控的任务节点ID。多个ID之间使用英文逗号（,）分隔，一个规则最多监控50个节点。', + 'type' => 'string', + 'required' => false, + 'example' => '1,2,3', + ], + ], + [ + 'name' => 'BaselineIds', + 'in' => 'formData', + 'schema' => [ + 'description' => '当RemindUnit（对象类型）为BASELINE（基线）时，监控的基线ID。多个ID之间使用英文逗号（,）分隔，一个规则最多监控5条基线。', + 'type' => 'string', + 'required' => false, + 'example' => '1,2,3', + ], + ], + [ + 'name' => 'ProjectId', + 'in' => 'formData', + 'schema' => [ + 'description' => '当RemindUnit（对象类型）为PROJECT（工作空间）时，监控的工作空间ID。一个规则只能监控一个工作空间。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '9527', + ], + ], + [ + 'name' => 'BizProcessIds', + 'in' => 'formData', + 'schema' => [ + 'description' => '当RemindUnit（对象类型）为BIZPROCESS（业务流程）时，监控的业务流程ID。多个业务流程ID之间使用英文逗号（,）分隔，一个规则最多监控5个业务流程。', + 'type' => 'string', + 'required' => false, + 'example' => '1,2,3', + ], + ], + [ + 'name' => 'RemindType', + 'in' => 'formData', + 'schema' => [ + 'description' => '触发条件，包括FINISHED（完成）、UNFINISHED（未完成）、ERROR（出错）、 CYCLE_UNFINISHED（周期未完成）和TIMEOUT（运行超时）。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'FINISHED', + 'enum' => [ + 'FINISHED', + 'UNFINISHED', + 'ERROR', + 'CYCLE_UNFINISHED', + 'TIMEOUT', + 'EXHAUSTED_ERROR', + ], + ], + ], + [ + 'name' => 'MaxAlertTimes', + 'in' => 'formData', + 'schema' => [ + 'description' => '最大报警次数。最小值为1，最大值为10，默认值为3。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '10', + 'minimum' => '1', + 'example' => '2', + 'default' => '3', + ], + ], + [ + 'name' => 'AlertInterval', + 'in' => 'formData', + 'schema' => [ + 'description' => '最小报警间隔，单位为秒。最小值为1200，默认值为1800。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'minimum' => '1200', + 'example' => '1800', + 'default' => '1800', + ], + ], + [ + 'name' => 'Detail', + 'in' => 'formData', + 'schema' => [ + 'description' => '不同触发条件的说明如下：'."\n" + ."\n" + .'- 当RemindType（触发条件）为FINISHED（完成）时，传空。'."\n" + ."\n" + .'- 当RemindType（触发条件）为UNFINISHED（未完成）时，传参格式为{"hour":23,"minu":59}。hour的取值范围为\\[0,47\\]，minu的取值范围为\\[0,59\\]。'."\n" + ."\n" + .'- 当RemindType（触发条件）为ERROR（出错）时，传空。'."\n" + ."\n" + .'- 当RemindType（触发条件）为CYCLE_UNFINISHED（周期未完成）时，传参格式为{"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"}。JSON字符串key为周期号，取值范围为\\[1,288\\]。value为该周期对应的未完成时间，格式为hh:mm。hh的取值范围为\\[0,47\\]，mm的取值范围为\\[0,59\\]。'."\n" + ."\n" + .'- 当RemindType（触发条件）为TIMEOUT（运行超时）时，传参格式为1800，单位为秒。即从开始运行起，运行超过30分钟触发报警。', + 'type' => 'string', + 'required' => false, + 'example' => '{"hour":"23","minu":"59"}', + ], + ], + [ + 'name' => 'AlertUnit', + 'in' => 'formData', + 'schema' => [ + 'description' => '报警接收对象的粒度，包括OWNER（任务责任人）和OTHER（指定的人）。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'OWNER', + 'default' => '', + 'enum' => [ + 'OTHER', + 'OWNER', + ], + ], + ], + [ + 'name' => 'AlertMethods', + 'in' => 'formData', + 'schema' => [ + 'description' => '报警方式，取值如下：'."\n" + .'- MAIL：邮件。'."\n" + .'- SMS：短信。'."\n" + .'<props="intl">可使用短信告警的地域为：新加坡、马来西亚（吉隆坡）、德国（法兰克福）。</props>'."\n" + .'<props="china">- PHONE：电话。仅DataWorks专业版及以上版本支持。</props>'."\n" + .'- Webhooks（企业微信或飞书机器人），仅当配置 Webhooks 参数后，该报警方式才会生效。'."\n" + .'- DINGROBOTS：钉钉群机器人。'."\n" + ."\n" + .'多个报警方式之间使用英文逗号（,）分隔。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'SMS,MAIL', + ], + ], + [ + 'name' => 'AlertTargets', + 'in' => 'formData', + 'schema' => [ + 'description' => '- 当AlertUnit（报警接收人）为OWNER（节点任务责任人）时，传空。'."\n" + ."\n" + .'- 当AlertUnit（报警接收人）为OTHER（指定的人）时，传入指定用户的阿里云UID。多个阿里云UID之间使用英文逗号（,）分隔，最多支持10个。', + 'type' => 'string', + 'required' => false, + 'example' => '9527952795279527', + ], + ], + [ + 'name' => 'RobotUrls', + 'in' => 'formData', + 'schema' => [ + 'description' => '钉钉群机器人的webhook地址，多个webhook地址之间使用英文逗号（,）分隔。', + 'type' => 'string', + 'required' => false, + 'example' => 'https://oapi.dingtalk.com/robot/send?access_token=******************************', + ], + ], + [ + 'name' => 'Webhooks', + 'in' => 'formData', + 'schema' => [ + 'description' => '企业微信或飞书机器人的webhook地址，多个webhook地址之间使用英文逗号（,）分隔。alertMethods 中需要包含 WEBHOOKS 告警方式。'."\n" + ."\n" + .'仅DataWorks企业版支持。'."\n" + .'可用地域：华东2（上海）、西南1（成都）、华北3（张家口）、华北2（北京）、华东1（杭州）、华南1（深圳）、中国（香港）、欧洲中部 1（法兰克福）、亚太东南1（新加坡）。', + 'type' => 'string', + 'required' => false, + 'example' => 'https://open.feishu.cn/open-apis/bot/v2/hook/*******', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '请求返回结果', + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => [ + 'description' => 'HTTP返回码。'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Data' => [ + 'description' => '创建自定义监控规则成功后，返回的自定义规则ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1234', + ], + 'ErrorMessage' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'The specified parameters are invalid.', + ], + 'RequestId' => [ + 'description' => '本次调用的唯一ID。出现错误后，您可以根据该ID排查问题。', + 'type' => 'string', + 'example' => '0000-ABCD-EFG****', + ], + 'Success' => [ + 'description' => '调用是否成功。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'ErrorCode' => [ + 'description' => '错误码。', + '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' => '创建自定义报警规则', + 'summary' => '调用CreateRemind创建自定义报警规则。', + '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' => '自定义监控规则的ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + 'example' => '1234', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回的数据类型。', + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => [ + 'description' => 'HTTP返回码。'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'RequestId' => [ + 'description' => '本次调用的唯一ID。出现错误后，您可以根据该ID排查问题。', + 'type' => 'string', + 'example' => '0000-ABCD-EFGH-IJK****', + ], + 'ErrorMessage' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'The specified parameters are invalid.', + ], + 'ErrorCode' => [ + 'description' => '错误码。', + 'type' => 'string', + 'example' => '1031203110005', + ], + 'Success' => [ + 'description' => '调用是否成功。'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'Data' => [ + 'description' => '自定义监控规则的详情。', + 'type' => 'object', + 'properties' => [ + 'MaxAlertTimes' => [ + 'description' => '最大报警次数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '3', + ], + 'RemindUnit' => [ + 'description' => '对象的类型，包括NODE（任务节点）、BASELINE（基线）、PROJECT（工作空间）和BIZPROCESS（业务流程）。', + 'type' => 'string', + 'example' => 'NODE', + ], + 'AlertInterval' => [ + 'description' => '最小报警间隔，单位为秒。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1800', + ], + 'Useflag' => [ + 'description' => '自定义监控规则是否开启，包括true（开启）和false（关闭）。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Founder' => [ + 'description' => '自定义监控规则创建人的阿里云UID。', + 'type' => 'string', + 'example' => '9527951795****', + ], + 'RemindId' => [ + 'description' => '自定义监控规则的ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1234', + ], + 'DndEnd' => [ + 'description' => '免打扰截止时间，格式为hh:mm。hh的取值范围为\\[0,23\\]，mm的取值范围为\\[0,59\\]。', + 'type' => 'string', + 'example' => '08:00', + ], + 'RemindType' => [ + 'description' => '触发条件，包括FINISHED（完成）、UNFINISHED（未完成）、ERROR（出错）、CYCLE_UNFINISHED（周期未完成）和TIMEOUT（运行超时）。', + 'type' => 'string', + 'example' => 'FINISHED', + ], + 'AlertUnit' => [ + 'description' => '报警接收对象类型，多类型告警接收人参考出参Receivers。'."\n" + .'- OWNER（任务责任人）'."\n" + .'- OTHER（指定的人）'."\n" + .'- SHIFT_SCHEDULE（值班表） ', + 'type' => 'string', + 'example' => 'OWNER', + ], + 'DndStart' => [ + 'description' => '免打扰起始时间，格式为hh:mm。hh的取值范围为\\[0,23\\]，mm的取值范围为\\[0,59\\]。', + 'type' => 'string', + 'example' => '00:00', + ], + 'RemindName' => [ + 'description' => '规则的名称。', + 'type' => 'string', + 'example' => 'Rule name', + ], + 'Detail' => [ + 'description' => '- 当RemindType（触发条件）为FINISHED（完成）时，返回空。'."\n" + ."\n" + .'- 当RemindType（触发条件）为UNFINISHED（未完成）时，返回格式为{"hour":23,"minu":59}。hour的取值范围为\\[0,47\\]，minu的取值范围为\\[0,59\\]。'."\n" + ."\n" + .'- 当RemindType（触发条件）为ERROR（出错）时，返回空。'."\n" + ."\n" + .'- 当RemindType（触发条件）为CYCLE_UNFINISHED（周期未完成）时，返回格式为{"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"}。JSON字符串key为周期号，取值范围为\\[1,288\\]。value为该周期对应的未完成时间，格式为hh:mm。hh的取值范围为\\[0,47\\]，mm的取值范围为\\[0,59\\]。'."\n" + ."\n" + .'- 当RemindType（触发条件）为TIMEOUT（运行超时）时，返回格式为1800，单位为秒。即从开始运行起，运行超过30分钟触发报警。', + 'type' => 'string', + 'example' => '{"hour":23,"minu":59}', + ], + 'Robots' => [ + 'description' => '钉钉群机器人的webhook地址列表。', + 'type' => 'array', + 'items' => [ + 'description' => '返回的数据类型。', + 'type' => 'object', + 'properties' => [ + 'WebUrl' => [ + 'description' => '钉钉群机器人的webhook地址。', + 'type' => 'string', + 'example' => 'https://oapi.dingtalk.com/robot/send?access_token=******************************', + ], + 'AtAll' => [ + 'description' => '是否@所有人，包括true（是）和false（否）。', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + 'Nodes' => [ + 'description' => '当RemindUnit（对象类型）为NODE（任务节点）时，该规则监控的节点列表。', + 'type' => 'array', + 'items' => [ + 'description' => '返回的数据类型。', + 'type' => 'object', + 'properties' => [ + 'Owner' => [ + 'description' => '节点责任人的阿里云UID。', + 'type' => 'string', + 'example' => '9527951795****', + ], + 'NodeName' => [ + 'description' => '节点的名称。', + 'type' => 'string', + 'example' => 'Node name', + ], + 'NodeId' => [ + 'description' => '节点的ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1234', + ], + 'ProjectId' => [ + 'description' => '节点所在工作空间的ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1234', + ], + ], + ], + ], + 'Baselines' => [ + 'description' => '当RemindUnit（对象类型）为BASELINE（基线）时，该规则监控的基线列表。', + 'type' => 'array', + 'items' => [ + 'description' => '返回的数据类型。', + 'type' => 'object', + 'properties' => [ + 'BaselineName' => [ + 'description' => '基线的名称。', + 'type' => 'string', + 'example' => 'Baseline name', + ], + 'BaselineId' => [ + 'description' => '基线的ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1234', + ], + ], + ], + ], + 'Projects' => [ + 'description' => '当RemindUnit（对象类型）为PROJECT（工作空间）时，该规则监控的工作空间列表。', + 'type' => 'array', + 'items' => [ + 'description' => '返回的数据类型。', + 'type' => 'object', + 'properties' => [ + 'ProjectId' => [ + 'description' => '工作空间的ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1234', + ], + ], + ], + ], + 'BizProcesses' => [ + 'description' => '当RemindUnit（对象类型）为BIZPROCESS（业务流程）时，该规则监控的业务流程列表。', + 'type' => 'array', + 'items' => [ + 'description' => '返回的数据类型。', + 'type' => 'object', + 'properties' => [ + 'BizProcessName' => [ + 'description' => '业务流程名称。', + 'type' => 'string', + 'example' => 'Business process name', + ], + 'BizId' => [ + 'description' => '业务流程ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '9527', + ], + ], + ], + ], + 'AlertTargets' => [ + 'description' => '报警接收人说明。多类型告警接收人参考出参Receivers。', + 'type' => 'array', + 'items' => [ + 'description' => '- 当AlertUnit（报警接收人）为OWNER（节点任务责任人）时，返回空。'."\n" + .'- 当AlertUnit（报警接收人）为OTHER（指定的人）时，返回指定用户的阿里云UID。'."\n" + .'- 当AlertUnit（报警接收人）为SHIFT_SCHEDULE（值班表）时，返回值班表ID。', + 'type' => 'string', + 'example' => '9527952795279527', + ], + ], + 'AlertMethods' => [ + 'description' => '报警方式。', + 'type' => 'array', + 'items' => [ + 'description' => '报警的方式，取值如下：'."\n" + .'- MAIL（邮件）'."\n" + .'- SMS（短信）'."\n" + .'- <props="intl">可使用短信告警的地域为：新加坡、马来西亚（吉隆坡）、德国（法兰克福）。</props><props="china">PHONE（电话，仅DataWorks专业版及以上版本支持）。</props>', + 'type' => 'string', + 'example' => 'SMS,MAIL', + ], + ], + 'Webhooks' => [ + 'description' => 'WebHook URL', + 'type' => 'array', + 'items' => [ + 'description' => '企业微信或飞书机器人的WebHook地址。AlertMethods中需要包含WebHook告警方式。'."\n" + .'自定义Webhook仅DataWorks企业版支持。', + 'type' => 'string', + 'example' => 'https://open.feishu.cn/open-apis/bot/v2/hook/*******', + ], + ], + 'Receivers' => [ + 'description' => '告警接收人信息。', + 'type' => 'array', + 'items' => [ + 'description' => '报警接收对象类型。', + 'type' => 'object', + 'properties' => [ + 'AlertUnit' => [ + 'description' => '报警接收对象类型，多类型告警接收人参考出参Receivers。'."\n" + .'- OWNER（任务责任人）'."\n" + .'- OTHER（指定的人）'."\n" + .'- SHIFT_SCHEDULE（值班表） ', + 'type' => 'string', + 'example' => 'OWNER', + ], + 'AlertTargets' => [ + 'description' => '告警接受对象。', + 'type' => 'array', + 'items' => [ + 'description' => '- 当AlertUnit（报警接收人）为OWNER（节点任务责任人）时，返回空。'."\n" + .'- 当AlertUnit（报警接收人）为OTHER（指定的人）时，返回指定用户的阿里云UID。'."\n" + .'- 当AlertUnit（报警接收人）为SHIFT_SCHEDULE（值班表）时，返回值班表ID。', + 'type' => 'string', + 'example' => '9527952795279527', + ], + ], + ], + ], + ], + 'AllowNodes' => [ + 'description' => '告警白名单。', + 'type' => 'array', + 'items' => [ + 'description' => '白名单中的任务ID，在监控时会被忽略。', + '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' => '获取自定义监控报警规则详情', + 'summary' => '调用GetRemind接口，获取自定义监控报警规则的详情。', + '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' => '分页的页数。默认值为1，最小值为1，最大值为30。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'docRequired' => true, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'formData', + 'schema' => [ + 'description' => '每页显示的条数，默认为10条，最大100条。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'docRequired' => true, + 'example' => '10', + ], + ], + [ + 'name' => 'Founder', + 'in' => 'formData', + 'schema' => [ + 'description' => '创建人的阿里云UID。', + 'type' => 'string', + 'required' => false, + 'example' => '9527952795****', + ], + ], + [ + 'name' => 'NodeId', + 'in' => 'formData', + 'schema' => [ + 'description' => '规则的对象，任务节点ID。您可以根据任务节点ID搜索覆盖该任务节点的自定义监控规则。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1234', + ], + ], + [ + 'name' => 'RemindTypes', + 'in' => 'formData', + 'schema' => [ + 'description' => '触发条件，包括FINISHED（完成）、UNFINISHED（未完成）、ERROR（出错）、CYCLE_UNFINISHED（周期未完成）和TIMEOUT（运行超时）。多个触发条件之间使用英文逗号（,）分隔。', + 'type' => 'string', + 'required' => false, + 'example' => 'FINISHED,ERROR', + ], + ], + [ + 'name' => 'AlertTarget', + 'in' => 'formData', + 'schema' => [ + 'description' => '报警接收人的阿里云UID。', + 'type' => 'string', + 'required' => false, + 'example' => '9527952795****', + ], + ], + [ + 'name' => 'SearchText', + 'in' => 'formData', + 'schema' => [ + 'description' => '搜索规则名称。', + 'type' => 'string', + 'required' => false, + 'example' => '模糊搜索规则名称', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => [ + 'description' => 'HTTP返回码。'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'RequestId' => [ + 'description' => '本次调用的唯一ID。出现错误后，您可以根据该ID排查问题。'."\n", + 'type' => 'string', + 'example' => '0000-ABCD-EFG****', + ], + 'ErrorMessage' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'The specified parameters are invalid.', + ], + 'ErrorCode' => [ + 'description' => '错误码。', + 'type' => 'string', + 'example' => '1031203110005', + ], + 'Success' => [ + 'description' => '调用是否成功。'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'Data' => [ + 'description' => '返回的自定义监控规则列表。', + 'type' => 'object', + 'properties' => [ + 'PageNumber' => [ + 'description' => '当前的页数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '每页的大小。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'TotalCount' => [ + 'description' => '自定义监控规则的总数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '100', + ], + 'Reminds' => [ + 'description' => '自定义监控规则列表。', + 'type' => 'array', + 'items' => [ + 'description' => '自定义监控规则列表。', + 'type' => 'object', + 'properties' => [ + 'Founder' => [ + 'description' => '规则创建人的阿里云UID。', + 'type' => 'string', + 'example' => '952795****', + ], + 'RemindId' => [ + 'description' => '自定义监控规则的ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1234', + ], + 'AlertUnit' => [ + 'description' => '报警接收对象的粒度，包括OWNER（任务责任人）和OTHER（指定的人）。', + 'type' => 'string', + 'example' => 'OWNER', + ], + 'RemindType' => [ + 'description' => '触发条件，包括FINISHED（完成）、UNFINISHED（未完成）、ERROR（出错）、CYCLE_UNFINISHED（周期未完成）和TIMEOUT（运行超时）。', + 'type' => 'string', + 'example' => 'FINISHED', + ], + 'DndEnd' => [ + 'description' => '免打扰截止时间，格式为hh:mm。hh的取值范围为\\[0,23\\]，mm的取值范围为\\[0,59\\]。', + 'type' => 'string', + 'example' => '08:00', + ], + 'DndStart' => [ + 'description' => '免打扰起始时间，格式为hh:mm。hh的取值范围为\\[0,23\\]，mm的取值范围为\\[0,59\\]。', + 'type' => 'string', + 'example' => '00:00', + ], + 'RemindUnit' => [ + 'description' => '对象的类型，包括NODE（任务节点）、BASELINE（基线）、PROJECT（工作空间）和BIZPROCESS（业务流程）。', + 'type' => 'string', + 'example' => 'NODE', + ], + 'Useflag' => [ + 'description' => '规则是否开启，包括true（开启）和false（关闭）。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'RemindName' => [ + 'description' => '自定义监控规则的名称。', + 'type' => 'string', + 'example' => '规则名称', + ], + 'AlertTargets' => [ + 'description' => '报警接收人的阿里云UID列表。', + 'type' => 'array', + 'items' => [ + 'description' => '报警接收人的阿里云UID列表。', + 'type' => 'string', + 'example' => '952795****', + ], + ], + 'NodeIds' => [ + 'description' => '当RemindUnit（对象类型）为NODE（任务节点）时，监控的节点ID列表。', + 'type' => 'array', + 'items' => [ + 'description' => '当RemindUnit（对象类型）为NODE（任务节点）时，监控的节点ID列表。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1234', + ], + ], + 'BizProcessIds' => [ + 'description' => '当RemindUnit（对象类型）为BIZPROCESS（业务流程）时，监控的基线ID列表。', + 'type' => 'array', + 'items' => [ + 'description' => '当RemindUnit（对象类型）为BIZPROCESS（业务流程）时，监控的基线ID列表。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '9527', + ], + ], + 'ProjectIds' => [ + 'description' => '当RemindUnit（对象类型）为PROJECT（工作空间）时，监控的节点ID列表。', + 'type' => 'array', + 'items' => [ + 'description' => '当RemindUnit（对象类型）为PROJECT（工作空间）时，监控的节点ID列表。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1234', + ], + ], + 'BaselineIds' => [ + 'description' => '当RemindUnit（对象类型）为BASELINE（基线）时，监控的基线ID列表。', + 'type' => 'array', + 'items' => [ + 'description' => '当RemindUnit（对象类型）为BASELINE（基线）时，监控的基线ID列表。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '9527', + ], + ], + 'AlertMethods' => [ + 'description' => '报警的方式，包括MAIL（邮件）、SMS（短信）和PHONE（电话，仅DataWorks专业版及以上版本支持）。', + 'type' => 'array', + 'items' => [ + 'description' => '报警的方式，包括MAIL（邮件）、SMS（短信）和PHONE（电话，仅DataWorks专业版及以上版本支持）。', + 'type' => 'string', + 'example' => 'SMS', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + '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' => '获取自定义监控规则列表', + 'summary' => '获取或搜索自定义监控规则列表。', + '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' => '起始发现时间，需要使用UTC格式（yyyy-MM-dd\'T\'HH:mm:ssZ）。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '2019-03-24T00:00:00+0800', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'formData', + 'schema' => [ + 'description' => '截止发现时间，需要使用UTC格式（yyyy-MM-dd\'T\'HH:mm:ssZ）。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '2019-03-25T23:00:00+0800', + ], + ], + [ + 'name' => 'TopicTypes', + 'in' => 'formData', + 'schema' => [ + 'description' => '事件的类型，包括SLOW（变慢）和ERROR（出错）。多个事件类型之间使用英文逗号（,）分隔。', + 'type' => 'string', + 'required' => false, + 'example' => 'ERROR,SLOW', + ], + ], + [ + 'name' => 'TopicStatuses', + 'in' => 'formData', + 'schema' => [ + 'description' => '事件的状态，包括IGNORE（已忽略）、NEW（新发现）、FIXING（处理中）和RECOVER（已恢复）。多个事件状态之间使用英文逗号（,）分隔。', + 'type' => 'string', + 'required' => false, + 'example' => 'IGNORE,NEW,FIXING,RECOVER', + ], + ], + [ + 'name' => 'NodeId', + 'in' => 'formData', + 'schema' => [ + 'description' => '事件关联的任务节点ID，与参数InstanceId互斥。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1234', + ], + ], + [ + 'name' => 'InstanceId', + 'in' => 'formData', + 'schema' => [ + 'description' => '事件关联的实例ID，与参数NodeId互斥。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '12345', + ], + ], + [ + 'name' => 'Owner', + 'in' => 'formData', + 'schema' => [ + 'description' => '事件责任人的阿里云UID。', + 'type' => 'string', + 'required' => false, + 'example' => '952795****', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'formData', + 'schema' => [ + 'description' => '分页的页数。默认值为1，最小值为1，最大值为30。'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'docRequired' => true, + 'maximum' => '30', + 'minimum' => '1', + 'example' => '1', + 'default' => '', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'formData', + 'schema' => [ + 'description' => '每页显示的条数，默认为10条，最大100条。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'docRequired' => true, + 'maximum' => '100', + 'minimum' => '1', + 'example' => '10', + 'default' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => [ + 'description' => 'HTTP返回码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'RequestId' => [ + 'description' => '本次调用的唯一ID。出现错误后，您可以根据该ID排查问题。'."\n", + 'type' => 'string', + 'example' => '0000-ABCD-EFG****', + ], + 'ErrorMessage' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'The specified parameters are invalid.', + ], + 'ErrorCode' => [ + 'description' => '错误码。', + 'type' => 'string', + 'example' => '1031203110005', + ], + 'Success' => [ + 'description' => '调用是否成功。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Data' => [ + 'description' => '返回的事件列表。', + 'type' => 'object', + 'properties' => [ + 'PageNumber' => [ + 'description' => '当前的页数。'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '每页的大小。'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'TotalCount' => [ + 'description' => '事件的总数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '100', + ], + 'Topics' => [ + 'description' => '事件列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'TopicName' => [ + 'description' => '事件的名称。', + 'type' => 'string', + 'example' => '1234出错', + ], + 'ProjectId' => [ + 'description' => '任务节点所在工作空间的ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1234', + ], + 'NodeOwner' => [ + 'description' => '任务节点责任人的阿里云UID', + 'type' => 'string', + 'example' => '952795****', + ], + 'InstanceId' => [ + 'description' => '事件关联的实例ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '12345', + ], + 'FixTime' => [ + 'description' => '事件恢复的时间戳。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1553508465000', + ], + 'TopicType' => [ + 'description' => '事件的类型，包括SLOW（变慢）和ERROR（出错）。', + 'type' => 'string', + 'example' => 'ERROR', + ], + 'TopicStatus' => [ + 'description' => '事件的状态，包括IGNORE（已忽略）、NEW（新发现）、FIXING（处理中）和RECOVER（已恢复）。', + 'type' => 'string', + 'example' => 'NEW', + ], + 'HappenTime' => [ + 'description' => '事件发生的时间戳，事件发生和被发现存在一定的时间差。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1553508465000', + ], + 'NodeName' => [ + 'description' => '任务节点的名称。', + 'type' => 'string', + 'example' => '节点名称', + ], + 'TopicId' => [ + 'description' => '事件的ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1234', + ], + 'AddTime' => [ + 'description' => '事件发现的时间戳。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1553524393000', + ], + 'NodeId' => [ + 'description' => '事件关联的任务节点ID。', + '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' => '获取或搜索事件列表', + 'summary' => '调用ListTopics获取或搜索事件列表。', + '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' => '事件的ID。您可以调用[listTopics](~~173973~~)获取。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + 'example' => '1234', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => [ + 'description' => 'HTTP返回码。'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'RequestId' => [ + 'description' => '本次调用的唯一ID。出现错误后，您可以根据该ID排查问题。'."\n", + 'type' => 'string', + 'example' => '0000-ABCD-EFGH-IJKLMNOPQ', + ], + 'ErrorMessage' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'The specified parameters are invalid.', + ], + 'ErrorCode' => [ + 'description' => '错误码。', + 'type' => 'string', + 'example' => '1031203110005', + ], + 'Success' => [ + 'description' => '调用是否成功。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Data' => [ + 'description' => '事件的详情。', + 'type' => 'object', + 'properties' => [ + 'Owner' => [ + 'description' => '事件责任人的阿里云UID。', + 'type' => 'string', + 'example' => '952795****', + ], + 'TopicName' => [ + 'description' => '事件的名称。', + 'type' => 'string', + 'example' => '1234 error', + ], + 'BaselineStatus' => [ + 'description' => '基线的状态，包括ERROR（异常）、SAFE（安全）、DANGROUS（预警）和OVER（破线）。', + 'type' => 'string', + 'example' => 'SAFE', + ], + 'ProjectId' => [ + 'description' => '事件关联任务节点所在工作空间的ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '123456', + ], + 'NextAlertTime' => [ + 'description' => '下次报警时间戳。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1553524393000', + ], + 'InstanceId' => [ + 'description' => '事件关联的实例ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '12345', + ], + 'FixTime' => [ + 'description' => '事件恢复时间戳。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1553524393000', + ], + 'BaselineInGroupId' => [ + 'description' => '最差基线实例的周期号。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'BaselineBuffer' => [ + 'description' => '最差基线实例余量，单位为秒。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '3600', + ], + 'TopicType' => [ + 'description' => '事件的类型，包括SLOW（变慢）和ERROR（出错）。', + 'type' => 'string', + 'example' => 'ERROR', + ], + 'TopicStatus' => [ + 'description' => '事件的状态，包括IGNORE（已忽略）、NEW（新发现）、FIXING（处理中）和RECOVER（已恢复）。', + 'type' => 'string', + 'example' => 'FIXING', + ], + 'HappenTime' => [ + 'description' => '事件发生的时间戳。事件发生和被发现可能存在时间差。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1553524393000', + ], + 'DealTime' => [ + 'description' => '最后处理时间戳。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1553524393000', + ], + 'DealUser' => [ + 'description' => '最后处理人的阿里云UID。', + 'type' => 'string', + 'example' => '952795****', + ], + 'BaselineName' => [ + 'description' => '最差基线实例的基线名称。', + 'type' => 'string', + 'example' => 'Baseline name', + ], + 'BaselineId' => [ + 'description' => '最差基线实例的基线ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1234', + ], + 'NodeName' => [ + 'description' => '事件关联的任务节点名称。', + 'type' => 'string', + 'example' => 'Node name', + ], + 'AlertTime' => [ + 'description' => '首次报警时间戳。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1553524393000', + ], + 'Buffer' => [ + 'description' => '事件的余量，单位为秒。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1200', + ], + 'Assigner' => [ + 'description' => '指派人的阿里云UID。', + 'type' => 'string', + 'example' => '952795****', + ], + 'TopicId' => [ + 'description' => '事件的ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1234', + ], + 'AddTime' => [ + 'description' => '事件发现时间戳。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1553524393000', + ], + 'NodeId' => [ + 'description' => '事件关联的任务节点ID。', + '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.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' => '获取事件的详情', + 'summary' => '调用GetTopic获取事件的详情。', + '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' => '事件的ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + 'example' => '1234', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => [ + 'description' => 'HTTP返回码。'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'RequestId' => [ + 'description' => '本次调用的唯一ID。出现错误后，您可以根据该ID排查问题。'."\n", + 'type' => 'string', + 'example' => '0000-ABCD-EFG****', + ], + 'ErrorMessage' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'The specified parameters are invalid.', + ], + 'ErrorCode' => [ + 'description' => '错误码。', + 'type' => 'string', + 'example' => '1031203110005', + ], + 'Success' => [ + 'description' => '调用是否成功。'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'Data' => [ + 'description' => '事件影响的基线实例列表。', + 'type' => 'object', + 'properties' => [ + 'TopicId' => [ + 'description' => '事件的ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1234', + ], + 'Influences' => [ + 'description' => '影响的基线实例列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => '基线的状态，包括ERROR（异常）、SAFE（安全）、DANGROUS（预警）和OVER（破线）。', + 'type' => 'string', + 'example' => 'SAFE', + ], + 'Owner' => [ + 'description' => '基线责任人的阿里云UID。多个责任人之间使用英文逗号（,）分隔。', + 'type' => 'string', + 'example' => '952795****', + ], + 'BaselineName' => [ + 'description' => '基线的名称。', + 'type' => 'string', + 'example' => 'Baseline name', + ], + 'BaselineId' => [ + 'description' => '基线的ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '12345', + ], + 'Bizdate' => [ + 'description' => '基线实例的业务日期时间戳。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1553356800000', + ], + 'Buffer' => [ + 'description' => '基线实例的余量，单位为秒。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '360', + ], + 'ProjectId' => [ + 'description' => '基线所在工作空间的ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1234', + ], + 'Priority' => [ + 'description' => '基线的优先级，取值范围为{1,2,5,7,8}。'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'InGroupId' => [ + 'description' => '基线实例的周期号。天基线为1，小时基线的取值范围为\\[1,24\\]。'."\n" + ."\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.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' => '获取事件影响的基线实例列表', + 'summary' => '调用GetTopicInfluence获取事件影响的基线实例列表。', + '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' => '节点的ID。您可以调用[ListNodes](~~173979~~)接口查看NodeId的相关信息。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + 'minimum' => '2', + 'example' => '1234', + 'isFileTransferUrl' => false, + ], + ], + [ + 'name' => 'ProjectEnv', + 'in' => 'formData', + 'schema' => [ + 'description' => '工作空间的环境，包括PROD和DEV。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'enumValueTitles' => [], + 'example' => 'PROD', + 'isFileTransferUrl' => false, + 'enum' => [ + 'PROD', + 'DEV', + ], + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回实体。', + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => [ + 'description' => 'HTTP状态码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'RequestId' => [ + 'description' => '请求的ID，用于定位日志，排查问题。', + 'type' => 'string', + 'example' => 'E6F0DBDD-5AD****', + ], + 'ErrorMessage' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'The connection does not exist.', + ], + 'ErrorCode' => [ + 'description' => '错误码。', + 'type' => 'string', + 'example' => 'Invalid.Tenant.ConnectionNotExists', + ], + 'Success' => [ + 'description' => '调用是否成功。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Data' => [ + 'description' => '节点的详情。', + 'type' => 'object', + 'properties' => [ + 'SchedulerType' => [ + 'description' => '调度的类型，取值如下：'."\n" + .'- NORMAL：正常调度任务。'."\n" + .'- MANUAL：手动任务，不会被日常调度。'."\n" + .'- PAUSE：暂停任务。'."\n" + .'- SKIP：空跑任务，被日常调度，但启动调度时直接被置为成功。', + 'type' => 'string', + 'example' => 'NORMAL', + ], + 'RepeatInterval' => [ + 'description' => '出错后重新调度频率。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '60', + ], + 'Repeatability' => [ + 'description' => '是否可以重复运行。', + 'type' => 'string', + 'example' => 'true', + ], + 'RepeatMode' => [ + 'description' => '重跑的模式，0表示只有失败的情况下可以重跑，1表示所有情况均可重跑，2表示所有情况下均不可重跑。'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'ProjectId' => [ + 'description' => '工作空间的ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1234', + ], + 'ProgramType' => [ + 'description' => '节点的类型。', + 'type' => 'string', + 'example' => 'ODPS_SQL', + ], + 'Priority' => [ + 'description' => '任务优先级，1/3/5/7/8。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'OwnerId' => [ + 'description' => '负责人的ID。', + 'type' => 'string', + 'example' => '17366294****', + ], + 'Connection' => [ + 'description' => '连接串。', + 'type' => 'string', + 'example' => 'odps_source_dev', + ], + 'ParamValues' => [ + 'description' => '额外的参数。', + 'type' => 'string', + 'example' => 'a=b', + ], + 'RelatedFlowId' => [ + 'description' => '关联业务流程ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '123', + ], + 'DqcType' => [ + 'description' => ' DQC类型，0表示没有关联dqc，1表示有关联dqc。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'BaselineId' => [ + 'description' => '基线ID。返回作为叶子节点所设置的基线ID，若未设置，则返回一个空间默认值。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '123456', + ], + 'Description' => [ + 'description' => '节点的描述信息。', + 'type' => 'string', + 'example' => 'test', + ], + 'NodeName' => [ + 'description' => '节点的名称。', + 'type' => 'string', + 'example' => 'sql节点', + ], + 'ResGroupName' => [ + 'description' => '资源组的名称。', + 'type' => 'string', + 'example' => '默认资源组', + ], + 'BusinessId' => [ + 'description' => '业务流程ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '123', + ], + 'DqcDescription' => [ + 'description' => 'DQC分区规则串。', + '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' => 'cron表达式。', + 'type' => 'string', + 'example' => '00 00 00 * * ?', + ], + 'NodeId' => [ + 'description' => '节点的ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1234', + ], + 'ResGroupIdentifier' => [ + 'description' => '资源组唯一标示。', + 'type' => 'string', + 'example' => 'group_123', + ], + 'FileType' => [ + 'description' => '文件类型。不同文件类型其代码不同，详情请参见[DataWorks节点合集](~~600169~~)。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'FileId' => [ + 'description' => '文件ID。<warning>字段已弃用</warning>', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '123', + ], + 'FileVersion' => [ + 'description' => '文件版本。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'DeployDate' => [ + 'description' => '部署日期。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1727280000000', + ], + 'CreateTime' => [ + 'description' => '创建时间。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1727280000000', + ], + 'ModifyTime' => [ + 'description' => '修改时间。', + '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' => '获取节点详情', + 'summary' => '获取节点的详情。', + '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' => '节点的ID。您可以调用[ListNodes](~~173979~~)接口查看NodeId的相关信息。'."\n" + ."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + 'minimum' => '2', + 'example' => '12314567', + 'isFileTransferUrl' => false, + ], + ], + [ + 'name' => 'ProjectEnv', + 'in' => 'formData', + 'schema' => [ + 'description' => '运行的环境，包括DEV（开发环境）和PROD（生产环境）。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'PROD', + 'isFileTransferUrl' => false, + 'enum' => [ + 'PROD', + 'DEV', + ], + ], + ], + [ + 'name' => 'IoType', + 'in' => 'formData', + 'schema' => [ + 'description' => '用于指定查询节点为上游节点还是下游节点。取值如下：'."\n" + .'- input，上游节点。'."\n" + .'- output，下游节点。'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'output', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => [ + 'description' => 'HTTP状态码。'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'RequestId' => [ + 'description' => '请求的ID，用于定位日志，排查问题。'."\n", + 'type' => 'string', + 'example' => 'E6F0DBDD-5AD****', + ], + 'ErrorMessage' => [ + 'description' => '错误信息。'."\n", + 'type' => 'string', + 'example' => 'The project does not exist.', + ], + 'ErrorCode' => [ + 'description' => '错误码。'."\n", + 'type' => 'string', + 'example' => 'Invalid.Tenant.ProjectNotExists', + ], + 'Success' => [ + 'description' => '调用是否成功。'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'Data' => [ + 'description' => '输入输出列表。', + 'type' => 'array', + 'items' => [ + 'description' => '输入输出信息。', + 'type' => 'object', + 'properties' => [ + 'TableName' => [ + 'description' => '该参数暂不生效，目前无法获取。', + 'type' => 'string', + 'example' => 'dwd_xxx_table', + ], + 'Data' => [ + 'description' => '输入输出节点名称。', + 'type' => 'string', + 'example' => 'xxxx.123141254_out', + ], + 'NodeId' => [ + 'description' => '节点ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '12314567', + ], + ], + ], + ], + ], + ], + ], + ], + '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' => '查询节点输入输出信息', + 'summary' => '查询当前节点的输入输出信息。', + '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' => '负责人的ID。', + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => '193379****', + ], + ], + [ + 'name' => 'BizName', + 'in' => 'formData', + 'schema' => [ + 'description' => '业务流程的名称。', + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => 'test_bizName', + ], + ], + [ + 'name' => 'ProgramType', + 'in' => 'formData', + 'schema' => [ + 'description' => '节点的类型。您可以调用[ListFileType](~~212428~~)查看节点类型。', + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => 'ODPS_SQL', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'formData', + 'schema' => [ + 'description' => '页码数。最小值1，最大值100', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'minimum' => '1', + 'example' => '1', + 'default' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'formData', + 'schema' => [ + 'description' => '每页显示的条数，默认为10条，最大100条。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '100', + 'minimum' => '1', + 'example' => '10', + 'default' => '10', + ], + ], + [ + 'name' => 'ProjectId', + 'in' => 'formData', + 'schema' => [ + 'description' => '工作空间的ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + 'example' => '1234', + ], + ], + [ + 'name' => 'ProjectEnv', + 'in' => 'formData', + 'schema' => [ + 'description' => '运行的环境，包括DEV和PROD。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'PROD', + 'enum' => [ + 'PROD', + 'DEV', + ], + ], + ], + [ + 'name' => 'NodeName', + 'in' => 'formData', + 'schema' => [ + 'description' => '节点的名称。', + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => 'liux_test_n****', + ], + ], + [ + 'name' => 'SchedulerType', + 'in' => 'formData', + 'schema' => [ + 'description' => '调度的类型，取值如下：'."\n" + .'- NORMAL：正常调度任务。'."\n" + .'- PAUSE：暂停任务。'."\n" + .'- SKIP：空跑任务，被日常调度，但启动调度时直接被置为成功。', + 'type' => 'string', + 'required' => false, + 'example' => 'NORMAL', + 'enum' => [ + 'NORMAL', + 'MANUAL', + 'PAUSE', + 'SKIP', + ], + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回实体。', + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => [ + 'description' => 'HTTP状态码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'RequestId' => [ + 'description' => '请求的ID。用于定位日志，排查问题。', + 'type' => 'string', + 'example' => 'E6F0DBDD-5AD****', + ], + 'ErrorMessage' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'The connection does not exist.', + ], + 'ErrorCode' => [ + 'description' => '错误码。', + 'type' => 'string', + 'example' => 'Invalid.Tenant.ConnectionNotExists', + ], + 'Success' => [ + 'description' => '调用是否成功。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Data' => [ + 'description' => '节点的列表。', + 'type' => 'object', + 'properties' => [ + 'PageNumber' => [ + 'description' => '页码数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '每页显示的条数，默认为10条，最大100条。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'TotalCount' => [ + 'description' => '符合条件的节点总数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '66', + ], + 'Nodes' => [ + 'description' => '节点的信息。', + 'type' => 'array', + 'items' => [ + 'description' => '返回实体。', + 'type' => 'object', + 'properties' => [ + 'SchedulerType' => [ + 'description' => '调度的类型，取值如下：'."\n" + .'- NORMAL：正常调度任务。'."\n" + .'- PAUSE：暂停任务。'."\n" + .'- SKIP：空跑任务，被日常调度，但启动调度时直接被置为成功。', + 'type' => 'string', + 'example' => 'NORMAL', + ], + 'RepeatInterval' => [ + 'description' => '出错后重新调度频率。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '60', + ], + 'Repeatability' => [ + 'description' => '是否可以重复运行。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'RepeatMode' => [ + 'description' => '重跑的模式，0 表示只有失败的情况下可以重跑，1 表示所有情况均可重跑，2 表示所有情况下均不可重跑。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'ProjectId' => [ + 'description' => '工作空间的ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '33671', + ], + 'ProgramType' => [ + 'description' => '节点的类型。', + 'type' => 'string', + 'example' => 'ODPS_SQL', + ], + 'Priority' => [ + 'description' => '优先级，1/3/5/7/8', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'OwnerId' => [ + 'description' => '负责人的ID。', + 'type' => 'string', + 'example' => '19337906836551', + ], + 'Connection' => [ + 'description' => '连接串。', + 'type' => 'string', + 'example' => 'odps_source', + ], + 'ParamValues' => [ + 'description' => '额外的参数。', + 'type' => 'string', + 'example' => 'a=b', + ], + 'RelatedFlowId' => [ + 'description' => '关联业务流程ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1231123', + ], + 'DqcType' => [ + 'description' => 'DQC类型，0表示没有关联dqc，1表示有关联dqc。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'BaselineId' => [ + 'description' => '基线ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '123456', + ], + 'Description' => [ + 'description' => '节点的描述信息。', + 'type' => 'string', + 'example' => 'test', + ], + 'NodeName' => [ + 'description' => '节点的名称。', + 'type' => 'string', + 'example' => 'liux_test_n****', + ], + 'ResGroupName' => [ + 'description' => '资源组的名称。', + 'type' => 'string', + 'example' => '默认资源组', + ], + 'BusinessId' => [ + 'description' => '业务流程ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '123', + ], + 'DqcDescription' => [ + 'description' => 'DQC分区规则串。', + 'type' => 'string', + 'example' => '[{"projectName":"ztjy_dim","tableName":"dim_user_agent_manage_area_a","partition":"ds\\u003d$[yyyy-mm-dd-1]"}]', + ], + 'CronExpress' => [ + 'description' => 'cron表达式。', + 'type' => 'string', + 'example' => '00 00 00 * * ?', + ], + 'NodeId' => [ + 'description' => '节点的ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1234', + ], + 'ResGroupIdentifier' => [ + 'description' => '资源组标识。', + 'type' => 'string', + 'example' => 'group_123', + ], + 'FileType' => [ + 'description' => '不同文件类型其代码不同，详情请参见[DataWorks节点合集](~~600169~~)。'."\n" + .'您也可以调用[ListFileType](~~212428~~)接口，查询文件的代码类型。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'FileId' => [ + 'description' => '文件的ID。您可以调用ListFiles接口查询对应文件的ID。<warning>字段已弃用</warning>', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '20', + ], + 'FileVersion' => [ + 'description' => '文件的版本。为当前已经提交的最新版本号。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '3', + ], + 'DeployDate' => [ + 'description' => '提交发布日期的时间戳，单位为毫秒。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1734537600000', + ], + 'CreateTime' => [ + 'description' => '节点创建的时间戳，单位为毫秒。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1593879116000', + ], + 'ModifyTime' => [ + 'description' => '节点修改的时间戳，单位为毫秒。', + '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' => '获取节点的列表', + 'summary' => '调用ListNodes获取节点的列表。', + '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' => '节点的ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + 'minimum' => '2', + 'example' => '1234', + 'isFileTransferUrl' => false, + ], + ], + [ + 'name' => 'ProjectEnv', + 'in' => 'formData', + 'schema' => [ + 'description' => '工作空间的环境，包括PROD和DEV。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'PROD', + 'isFileTransferUrl' => false, + 'enum' => [ + 'PROD', + 'DEV', + ], + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回数据。', + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => [ + 'description' => 'HTTP状态码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Data' => [ + 'description' => '节点的代码。', + 'type' => 'string', + 'example' => 'select a;', + ], + 'ErrorMessage' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'The connection does not exist.', + ], + 'RequestId' => [ + 'description' => '请求的ID。用于定位日志，排查问题。', + 'type' => 'string', + 'example' => 'E6F0DBDD-5AD****', + ], + 'Success' => [ + 'description' => '调用是否成功。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'ErrorCode' => [ + 'description' => '错误码。', + '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' => '获取节点的代码', + 'summary' => '调用GetNodeCode获取节点的代码。', + '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' => '实例的ID。您可以调用[ListInstances](~~173982~~)获取。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + 'example' => '1234', + ], + ], + [ + 'name' => 'ProjectEnv', + 'in' => 'formData', + 'schema' => [ + 'description' => '工作空间的环境，包括PROD（生产环境）和DEV（开发环境）。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'PROD', + 'enum' => [ + 'PROD', + 'DEV', + ], + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回实体。', + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => [ + 'description' => 'HTTP状态码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'RequestId' => [ + 'description' => '请求的ID。用于定位日志，排查问题。', + 'type' => 'string', + 'example' => 'E6F0DBDD-5AD****', + ], + 'ErrorMessage' => [ + 'description' => '调度实例失败时的异常信息。', + 'type' => 'string', + 'example' => 'test', + ], + 'Success' => [ + 'description' => '调用是否成功。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'ErrorCode' => [ + 'description' => '错误码。', + 'type' => 'string', + 'example' => '0', + ], + 'Data' => [ + 'description' => '实例的详细信息。', + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => '任务的状态，取值如下：'."\n" + ."\n" + .'- NOT_RUN(1)：未运行'."\n" + .'- WAIT_TIME(2)： 等待时间。等待定时时间到来'."\n" + .'- WAIT_RESOURCE(3)：等待资源。已经下发到执行引擎，在等待资源排队调度执行'."\n" + .'- RUNNING(4)：运行中'."\n" + .'- CHECKING(7)：校验中。执行完毕，下发给数据质量进行数据校检'."\n" + .'- CHECKING_CONDITION(8)： 条件检测中。执行完毕，正在做分支条件校验'."\n" + .'- WAIT_TRIGGER(9)：等待触发。触发式节点会在等待时间后变成等待触发'."\n" + .'- FAILURE(5)：运行失败'."\n" + .'- SUCCESS(6)：运行成功', + 'type' => 'string', + 'example' => 'NOT_RUN', + ], + 'CycTime' => [ + 'description' => '实例的定时时间。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1590422400000', + ], + 'BeginRunningTime' => [ + 'description' => '实例开始运行的时间。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1590416703313', + ], + 'FinishTime' => [ + 'description' => '实例运行的结束时间。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1590416703313', + ], + 'CreateTime' => [ + 'description' => '实例的创建时间。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1590416703313', + ], + 'DagId' => [ + 'description' => '工作流的ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '338450167', + ], + 'Priority' => [ + 'description' => '实例运行优先级，取值分为1、3、5、7和8。取值越大，优先级越高。默认优先级为1。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'TaskType' => [ + 'description' => '实例的调度类型，取值如下：'."\n" + .'- NORMAL(0)：正常调度任务。该任务被日常调度。'."\n" + .'- MANUAL(1)：手动任务。该任务不会被日常调度。'."\n" + .'- PAUSE(2)：冻结任务。该任务被日常调度，但启动调度时直接被置为失败状态。'."\n" + .'- SKIP(3)：空跑任务。该任务被日常调度，但启动调度时直接被置为成功状态。'."\n" + .'- SKIP_UNCHOOSE(4)：临时工作流中未选择的任务，仅存在于临时工作流中，启动调度时直接被置为成功状态。'."\n" + .'- SKIP_CYCLE(5)：未到运行周期的周或月任务。该任务被日常调度，但启动调度时直接被置为成功状态。'."\n" + .'- CONDITION_UNCHOOSE(6)：上游实例中有分支（IF）节点，但是该下游节点未被分支节点选中，直接置为空跑任务。'."\n" + .'- REALTIME_DEPRECATED(7)：实时生成的已经过期的周期实例，该类型的任务直接被置为成功状态。', + 'type' => 'string', + 'example' => 'NORMAL(0)', + ], + 'ParamValues' => [ + 'description' => '参数信息。', + 'type' => 'string', + 'example' => 'bizdate=$bizdate tbods=$tbods tbdw=$tbdw tbpmic=$tbpmic tbpidx=$tbpidx tbptcif=$tbptcif', + ], + 'Connection' => [ + 'description' => '连接串。', + 'type' => 'string', + 'example' => 'odps_source', + ], + 'BaselineId' => [ + 'description' => '基线ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '123123', + ], + 'DqcType' => [ + 'description' => '数据质量DQC类型，取值如下：'."\n" + .'- 0表示有关联dqc。'."\n" + .'- 1表示没有关联dqc。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'DagType' => [ + 'description' => '工作流的类型，取值如下：'."\n" + ."\n" + .'- DAILY(0)：日常调度工作流'."\n" + .'- MANUAL(1)：手动任务工作流'."\n" + .'- SMOKE_TEST(2)：冒烟测试工作流'."\n" + .'- SUPPLY_DATA(3)：补数据工作流'."\n" + .'- MANUAL_FLOW(4)：手动运行的dataflow pai 业务流程等（如IDE上点击运行业务流程）'."\n" + .'- BUSINESS_PROCESS_DAG(5)：手动业务流程工作流', + 'type' => 'string', + 'example' => 'DAILY', + ], + 'BusinessId' => [ + 'description' => '业务流程ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '123', + ], + 'TaskRerunTime' => [ + 'description' => '实例还可以运行的次数。取值可以为空、以及大于等于0的整数。'."\n" + .'- 取值为空，表示该实例对应的节点没有设置自动重跑次数。'."\n" + .'- 取值为0，表示该实例不能再重跑。'."\n" + .'- 取值为大于0的整数（假设为n），表示该实例可重跑次数为n。例如，该参数取值为1，则剩余重跑次数为1，取值为2，则剩余重跑次数为2，以此类推。初始值为对应节点定义的自动重跑次数+1。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'PeriodNumber' => [ + 'description' => '周期序号。表示任务实例处于当天的第几轮周期。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'ModifyTime' => [ + 'description' => '实例的最新修改时间。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1590416703313', + ], + 'Repeatability' => [ + 'description' => '实例是否可以重复执行。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'RepeatInterval' => [ + 'description' => '调度任务运行出错后，重新调整调度频率，单位为毫秒（ms）。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '60000', + ], + 'InstanceId' => [ + 'description' => '实例的ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '11713307578', + ], + 'BeginWaitResTime' => [ + 'description' => '实例开始等待资源的时间。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1590416703313', + ], + 'RelatedFlowId' => [ + 'description' => '关联的业务流程ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '123123', + ], + 'Bizdate' => [ + 'description' => '业务日期。通常为该任务运行时间的前一天。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1590336000000', + ], + 'NodeName' => [ + 'description' => '节点的名称。', + 'type' => 'string', + 'example' => 'kzh', + ], + 'BeginWaitTimeTime' => [ + 'description' => '实例开始等待调度的时间。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1590416703313', + ], + 'DqcDescription' => [ + 'description' => 'DQC分区规则串。', + 'type' => 'string', + 'example' => '[{"projectName":"ztjy_dim","tableName":"dim_user_agent_manage_area_a","partition":"ds\\u003d$[yyyy-mm-dd-1]"}]', + ], + 'NodeId' => [ + 'description' => '节点的ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '33115', + ], + 'CreateUser' => [ + 'description' => '实例创建人。', + 'type' => 'string', + 'example' => '111', + ], + 'Owner' => [ + 'description' => '实例责任人。', + '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' => '获取实例的详情', + 'summary' => '调用GetInstance接口，获取实例的详细信息。', + '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' => '运行的环境，包括PROD（生产环境）和DEV（开发环境）。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'enumValueTitles' => [], + 'example' => 'PROD', + 'enum' => [ + 'PROD', + 'DEV', + ], + ], + ], + [ + 'name' => 'NodeId', + 'in' => 'formData', + 'schema' => [ + 'description' => '节点的ID。您可以调用[ListNodes](~~173979~~)查看节点ID信息。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'docRequired' => false, + 'example' => '100000000000', + ], + ], + [ + 'name' => 'NodeName', + 'in' => 'formData', + 'schema' => [ + 'description' => '节点的名称。您可以调用[ListNodes](~~173979~~)查看节点名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'openmr_8****', + ], + ], + [ + 'name' => 'Owner', + 'in' => 'formData', + 'schema' => [ + 'description' => '负责人的ID，即工作空间管理员的账号UID。您可登录阿里云控制台后，在账号管理的安全管理中查看账号UID。', + 'type' => 'string', + 'required' => false, + 'example' => '193379****', + ], + ], + [ + 'name' => 'ProjectId', + 'in' => 'formData', + 'schema' => [ + 'description' => '工作空间的ID。您可以调用[ListProjects](~~178393~~)查看空间ID信息。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + 'example' => '12345', + ], + ], + [ + 'name' => 'BizName', + 'in' => 'formData', + 'schema' => [ + 'description' => '业务流程的名称。您可以调用[ListBusiness](~~173945~~)查看业务流程信息。', + 'type' => 'string', + 'required' => false, + 'example' => 'test_bizName', + ], + ], + [ + 'name' => 'ProgramType', + 'in' => 'formData', + 'schema' => [ + 'description' => '节点的类型。您可以调用[ListNodes](~~173979~~)查看节点类型。', + 'type' => 'string', + 'required' => false, + 'example' => 'ODPS_SQL', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'formData', + 'schema' => [ + 'description' => '页码数，用于翻页。最小值为1，最大值为100。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'minimum' => '1', + 'example' => '1', + 'default' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'formData', + 'schema' => [ + 'description' => '每页显示的条数，默认为10条，最大100条。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '100', + 'minimum' => '1', + 'example' => '10', + 'default' => '10', + ], + ], + [ + 'name' => 'DagId', + 'in' => 'formData', + 'schema' => [ + 'description' => 'DagId可以是执行补数据[RunCycleDagNodes](~~212961~~)，冒烟测试[RunSmokeTest](~~212949~~)，手动业务流程[RunManualDagNodes](~~212830~~)等接口返回的DagId。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '11111', + ], + ], + [ + 'name' => 'Bizdate', + 'in' => 'formData', + 'schema' => [ + 'description' => '获取实例列表的日期，格式为yyyy-MM-dd HH:mm:ss。', + 'type' => 'string', + 'required' => false, + 'example' => '2020-02-02 00:00:00', + ], + ], + [ + 'name' => 'BeginBizdate', + 'in' => 'formData', + 'schema' => [ + 'description' => '获取实例列表的开始日期，格式为yyyy-MM-dd HH:mm:ss。', + 'type' => 'string', + 'required' => false, + 'example' => '2020-02-02 00:00:00', + ], + ], + [ + 'name' => 'EndBizdate', + 'in' => 'formData', + 'schema' => [ + 'description' => '获取实例列表的结束日期，格式为yyyy-MM-dd HH:mm:ss。', + 'type' => 'string', + 'required' => false, + 'example' => '2020-02-03 00:00:00', + ], + ], + [ + 'name' => 'Status', + 'in' => 'formData', + 'schema' => [ + 'description' => '任务的状态，取值如下：'."\n" + ."\n" + .'- NOT_RUN（未运行）'."\n" + ."\n" + .'- WAIT_TIME（等待定时间DueTime或CycTime到来）'."\n" + ."\n" + .'- WAIT_RESOURCE（等待资源）'."\n" + ."\n" + .'- RUNNING（运行中）'."\n" + .'- CHECKING（下发给数据质量进行数据校验）'."\n" + .'- CHECKING_CONDITION（正在进行分支条件校验）'."\n" + .'- FAILURE（执行失败）'."\n" + .'- SUCCESS（执行成功）', + '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' => '返回值的排序规则。取值如下：'."\n" + .'- CREATE_TIME_DESC：按照创建时间降序返回'."\n" + .'- INSTANCE_ID_DESC：默认值，按照实例ID降序返回。 ', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [], + 'example' => 'INSTANCE_ID_DESC', + 'enum' => [ + 'INSTANCE_ID_DESC', + 'CREATE_TIME_DESC', + ], + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => [ + 'description' => 'HTTP状态码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'RequestId' => [ + 'description' => '请求的ID。用于定位日志，排查问题。', + 'type' => 'string', + 'example' => 'E6F0DBDD-5AD****', + ], + 'ErrorMessage' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'The project does not exist.', + ], + 'ErrorCode' => [ + 'description' => '错误码。', + 'type' => 'string', + 'example' => 'Invalid.Tenant.ProjectNotExists', + ], + 'Success' => [ + 'description' => '调用是否成功。取值如下：'."\n" + .'- true：调用成功。'."\n" + .'- false：调用失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Data' => [ + 'description' => '实例的列表。', + 'type' => 'object', + 'properties' => [ + 'PageNumber' => [ + 'description' => '页码数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '每页显示的条数，默认为10条，最大为100条。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'TotalCount' => [ + 'description' => '实例的总数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '66', + ], + 'Instances' => [ + 'description' => '实例的信息。', + 'type' => 'array', + 'items' => [ + 'description' => '返回数据。', + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => '任务的状态，取值如下：'."\n" + ."\n" + .'- NOT_RUN(1)：未运行'."\n" + .'- WAIT_TIME(2)： 等待时间。等待定时时间到来'."\n" + .'- WAIT_RESOURCE(3)：等待资源。已经下发到执行引擎，在等待资源排队调度执行'."\n" + .'- RUNNING(4)：运行中'."\n" + .'- CHECKING(7)：校验中。执行完毕，下发给数据质量进行数据校检'."\n" + .'- CHECKING_CONDITION(8)： 条件检测中。执行完毕，正在做分支条件校验'."\n" + .'- WAIT_TRIGGER(9)：等待触发。触发式节点会在等待时间后变成等待触发'."\n" + .'- FAILURE(5)：运行失败'."\n" + .'- SUCCESS(6)：运行成功', + 'type' => 'string', + 'example' => 'NOT_RUN', + ], + 'CycTime' => [ + 'description' => '调度任务的运行时间。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1590422400000', + ], + 'BeginRunningTime' => [ + 'description' => '实例开始运行的时间。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1590416703313', + ], + 'FinishTime' => [ + 'description' => '调度任务的结束时间。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1590416703313', + ], + 'ErrorMessage' => [ + 'description' => '实例运行的报错信息。'."\n" + ."\n" + .'该字段已废弃，您可以调用[GetInstanceLog](~~173983~~)接口获取执行任务的相关报错信息。', + 'type' => 'string', + 'example' => 'error message', + ], + 'CreateTime' => [ + 'description' => '实例的创建时间。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1590416703313', + ], + 'DagId' => [ + 'description' => '工作流的ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '33845', + ], + 'Priority' => [ + 'description' => '实例运行优先级，取值分为1、3、5、7和8。'."\n" + ."\n" + .'取值越大，优先级越高。默认优先级为1。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'TaskType' => [ + 'description' => '任务实例的调度类型，取值如下：'."\n" + .'- NORMAL(0)：正常调度任务。该任务被日常调度。'."\n" + .'- MANUAL(1)：手动任务。该任务不会被日常调度。'."\n" + .'- PAUSE(2)：冻结任务。该任务被日常调度，但启动调度时直接被置为失败状态。'."\n" + .'- SKIP(3)：空跑任务。该任务被日常调度，但启动调度时直接被置为成功状态。'."\n" + .'- SKIP_UNCHOOSE(4)：临时工作流中未选择的任务，仅存在于临时工作流中，启动调度时直接被置为成功状态。'."\n" + .'- SKIP_CYCLE(5)：未到运行周期的周或月任务。该任务被日常调度，但启动调度时直接被置为成功状态。'."\n" + .'- CONDITION_UNCHOOSE(6)：上游实例中有分支（IF）节点，但是该下游节点未被分支节点选中，直接置为空跑任务。'."\n" + .' REALTIME_DEPRECATED(7)：实时生成的已经过期的周期实例，该类型的任务直接被置为成功状态。', + 'type' => 'string', + 'example' => 'NORMAL(0)', + ], + 'ParamValues' => [ + 'description' => '参数的信息。', + 'type' => 'string', + 'example' => 'bizdate=$bizdate tbods=$tbods', + ], + 'Connection' => [ + 'description' => '连接串。', + 'type' => 'string', + 'example' => 'odps_source', + ], + 'BaselineId' => [ + 'description' => '基线ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '123123', + ], + 'DqcType' => [ + 'description' => 'DQC类型，取值如下：'."\n" + .'- 0表示有关联dqc。'."\n" + .'- 1表示没有关联dqc。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'DagType' => [ + 'description' => '工作流的类型，取值如下：'."\n" + ."\n" + .'- DAILY(0)：日常调度工作流'."\n" + .'- MANUAL(1)：手动任务工作流'."\n" + .'- SMOKE_TEST(2)：冒烟测试工作流'."\n" + .'- SUPPLY_DATA(3)：补数据工作流'."\n" + .'- MANUAL_FLOW(4)：手动运行的dataflow pai 业务流程等（如IDE上点击运行业务流程）'."\n" + .'- BUSINESS_PROCESS_DAG(5)：手动业务流程工作流', + 'type' => 'string', + 'example' => 'DAILY', + ], + 'BusinessId' => [ + 'description' => '业务流程ID', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '123', + ], + 'TaskRerunTime' => [ + 'description' => '实例还可以运行的次数。取值可以为空、以及大于等于0的整数。'."\n" + .'- 取值为空，表示该实例对应的节点没有设置自动重跑次数。'."\n" + .'- 取值为0，表示该实例不能再重跑。'."\n" + .'- 取值为大于0的整数（假设为n），表示该实例可重跑次数为n。例如，该参数取值为1，则剩余重跑次数为1，取值为2，则剩余重跑次数为2，以此类推。初始值为对应节点定义的自动重跑次数+1。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'ModifyTime' => [ + 'description' => '调度任务的最新修改时间。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1590416703313', + ], + 'Repeatability' => [ + 'description' => '实例任务是否可以重复执行。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'RepeatInterval' => [ + 'description' => '调度任务运行出错后，重新调整调度频率，单位为毫秒（ms）。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '60000', + ], + 'InstanceId' => [ + 'description' => '实例的ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1234', + ], + 'BeginWaitResTime' => [ + 'description' => '实例任务开始等待资源的时间。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1590416703313', + ], + 'RelatedFlowId' => [ + 'description' => '关联的业务流程ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '123456', + ], + 'Bizdate' => [ + 'description' => '执行调度任务的日期。通常为该任务运行时间的前一天。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1590336000000', + ], + 'NodeName' => [ + 'description' => '节点的名称。', + 'type' => 'string', + 'example' => 'kzh', + ], + 'BeginWaitTimeTime' => [ + 'description' => '实例任务开始等待调度的时间。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1590416703313', + ], + 'DqcDescription' => [ + 'description' => 'DQC分区规则串。', + 'type' => 'string', + 'example' => '[{"projectName":"ztjy_dim","tableName":"dim_user_agent_manage_area_a","partition":"ds\\u003d$[yyyy-mm-dd-1]"}]', + ], + 'NodeId' => [ + 'description' => '节点的ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '33115', + ], + 'CreateUser' => [ + 'description' => '触发实例运行的用户。例如，用户Test触发补数据实例运行，则CreateUser为Test。', + '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' => '获取实例的列表', + 'summary' => '调用ListInstances获取实例的列表。', + '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' => '实例的ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + 'example' => '1234', + ], + ], + [ + 'name' => 'ProjectEnv', + 'in' => 'formData', + 'schema' => [ + 'description' => '工作空间的环境，包括PROD和DEV。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'PROD', + 'enum' => [ + 'PROD', + 'DEV', + ], + ], + ], + [ + 'name' => 'InstanceHistoryId', + 'in' => 'formData', + 'schema' => [ + 'description' => '可以从ListInstanceHistory获取InstanceHistoryId', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => [ + 'description' => 'HTTP状态码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Data' => [ + 'description' => '日志的内容。', + 'type' => 'string', + 'example' => 'log_content', + ], + 'ErrorMessage' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'The connection does not exist.', + ], + 'RequestId' => [ + 'description' => '请求的ID。用于定位日志，排查问题。', + '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\\": \\"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' => '获取实例的日志', + 'summary' => '调用GetInstanceLog获取实例的日志。', + 'description' => '超过7天的实例可能查不到日志数据。', + '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' => '实例的ID。您可以调用[ListInstances](~~173982~~)获取。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + 'example' => '1234', + ], + ], + [ + 'name' => 'ProjectEnv', + 'in' => 'formData', + 'schema' => [ + 'description' => '工作空间的环境，包括PROD和DEV。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'PROD', + 'enum' => [ + 'PROD', + 'DEV', + ], + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => [ + 'description' => 'HTTP状态码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Data' => [ + 'description' => '调用停止实例接口后，返回的结果详情。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'ErrorMessage' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'The connection does not exist.', + ], + 'RequestId' => [ + 'description' => '请求的ID。用于定位日志，排查问题。', + '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\\": 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' => '终止实例', + 'summary' => '调用StopInstance终止实例。', + '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' => '实例的ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + 'example' => '1234', + ], + ], + [ + 'name' => 'ProjectEnv', + 'in' => 'formData', + 'schema' => [ + 'description' => '工作空间的环境，包括PROD和DEV。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'PROD', + 'enum' => [ + 'PROD', + 'DEV', + ], + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => [ + 'description' => 'HTTP状态码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Data' => [ + 'description' => '调用重启实例接口后，返回的结果详情。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'ErrorMessage' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'The connection does not exist.', + ], + 'RequestId' => [ + 'description' => '请求的ID。用于定位日志，排查问题。', + 'type' => 'string', + 'example' => 'q32ety****', + ], + 'ErrorCode' => [ + 'description' => '错误码。', + 'type' => 'string', + 'example' => 'Invalid.Tenant.ConnectionNotExists', + ], + 'Success' => [ + 'description' => '调用是否成功。', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + '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' => '重启实例', + 'summary' => '调用RestartInstance重启实例。', + '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' => '实例的ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + 'example' => '1234', + ], + ], + [ + 'name' => 'ProjectEnv', + 'in' => 'formData', + 'schema' => [ + 'description' => '工作空间的环境，包括PROD和DEV。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'PROD', + 'enum' => [ + 'PROD', + 'DEV', + ], + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回数据。', + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => [ + 'description' => 'HTTP状态码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Data' => [ + 'description' => '调用SetSuccessInstance接口后，是否返回结果详情。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'ErrorMessage' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'The connection does not exist.', + ], + 'RequestId' => [ + 'description' => '请求ID。', + '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\\": 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' => '重置失败状态的实例为成功', + 'summary' => '调用SetSuccessInstance，重置失败状态的实例为成功。', + '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' => '实例的ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + 'example' => '1234', + ], + ], + [ + 'name' => 'ProjectEnv', + 'in' => 'formData', + 'schema' => [ + 'description' => '工作空间的环境，包括PROD和DEV。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'PROD', + 'enum' => [ + 'PROD', + 'DEV', + ], + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => [ + 'description' => 'HTTP状态码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Data' => [ + 'description' => '调用SuspendInstance接口后，返回的结果详情。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'ErrorMessage' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'The connection does not exist.', + ], + 'RequestId' => [ + 'description' => '请求的ID。用于定位日志，排查问题。', + 'type' => 'string', + 'example' => '0baf87f0159376****', + ], + 'ErrorCode' => [ + 'description' => '错误码。', + 'type' => 'string', + 'example' => 'Invalid.Tenant.ProjectNotExists', + ], + 'Success' => [ + 'description' => '调用是否成功。', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + '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' => '暂停实例', + 'summary' => '调用SuspendInstance暂停实例。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'ResumeInstance' => [ + 'summary' => '调用ResumeInstance恢复暂停状态的实例。', + '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' => '实例的ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + 'example' => '1234', + ], + ], + [ + 'name' => 'ProjectEnv', + 'in' => 'formData', + 'schema' => [ + 'description' => '工作空间的环境，包括PROD和DEV。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'PROD', + 'enum' => [ + 'PROD', + 'DEV', + ], + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回数据。', + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => [ + 'description' => 'HTTP状态码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Data' => [ + 'description' => '调用ResumeInstance接口后，返回的结果详情。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'ErrorMessage' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'The connection does not exist.', + ], + 'RequestId' => [ + 'description' => '请求的ID。用于定位日志，排查问题。', + '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\\": 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' => '恢复暂停状态的实例', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'RunCycleDagNodes' => [ + 'summary' => '调用RunCycleDagNodes创建补数据工作流。', + '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' => '工作空间的环境，PROD表示生产环境，DEV表示开发环境。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'PROD', + 'enum' => [ + 'PROD', + 'DEV', + ], + ], + ], + [ + 'name' => 'StartBizDate', + 'in' => 'formData', + 'schema' => [ + 'description' => '补数据的起始业务日期。格式为yyyy-MM-dd 00:00:00。'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '2020-05-20 00:00:00', + ], + ], + [ + 'name' => 'Name', + 'in' => 'formData', + 'schema' => [ + 'description' => '工作流的名称。'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'xm_test', + 'maxLength' => 128, + ], + ], + [ + 'name' => 'RootNodeId', + 'in' => 'formData', + 'schema' => [ + 'description' => '补数据的起始节点ID。您可以通过调用[ListNodes](~~173979~~)接口获取节点ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + 'example' => '1234', + ], + ], + [ + 'name' => 'ExcludeNodeIds', + 'in' => 'formData', + 'schema' => [ + 'description' => '无需补数据的节点ID列表，在这个列表中的节点会生成空跑实例，空跑实例被调度后会直接运行成功，不会执行脚本内容。', + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => '1234,123465', + ], + ], + [ + 'name' => 'BizBeginTime', + 'in' => 'formData', + 'schema' => [ + 'description' => '任务的开始时间。仅小时调度任务需要设置该参数，格式为HH:mm:ss，取值范围为 00:00:00~23:59:59。'."\n", + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => '00:00:00', + ], + ], + [ + 'name' => 'BizEndTime', + 'in' => 'formData', + 'schema' => [ + 'description' => '任务的结束时间。仅小时调度任务需要设置该参数，格式为HH:mm:ss，取值范围为 00:00:00~23:59:59。', + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => '01:00:00', + ], + ], + [ + 'name' => 'Parallelism', + 'in' => 'formData', + 'schema' => [ + 'description' => '多个业务日期的任务是否可以并行运行。', + 'type' => 'boolean', + 'required' => true, + 'docRequired' => true, + 'example' => 'false', + ], + ], + [ + 'name' => 'EndBizDate', + 'in' => 'formData', + 'schema' => [ + 'description' => '补数据的结束业务日期。格式为yyyy-MM-dd 00:00:00。'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '2020-05-21 00:00:00', + ], + ], + [ + 'name' => 'NodeParams', + 'in' => 'formData', + 'schema' => [ + 'description' => '配置为一个JSON字符串，Key为节点ID，Value为参数的实际取值。'."\n", + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => '{"74324":"a=123 b=456"}', + ], + ], + [ + 'name' => 'IncludeNodeIds', + 'in' => 'formData', + 'schema' => [ + 'description' => '补数据的节点ID。对多个节点补数据时，多个节点ID使用逗号（,）分隔。您可以通过调用[ListNodes](~~173979~~)接口获取节点ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '74324,74325', + ], + ], + [ + 'name' => 'StartFutureInstanceImmediately', + 'in' => 'formData', + 'schema' => [ + 'description' => '是否立刻运行未来调度时间的实例，如果设置为true，则大于当前时间的实例会立刻运行，否则会等待调度时间', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + 'default' => 'false', + ], + ], + [ + 'name' => 'ConcurrentRuns', + 'in' => 'formData', + 'schema' => [ + 'description' => '任务并行数。取值范围2~10。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '10', + 'minimum' => '2', + 'example' => '5', + ], + ], + [ + 'name' => 'AlertType', + 'in' => 'formData', + 'schema' => [ + 'description' => '告警类型。取值范围：'."\n" + .'- SUCCESS：成功告警。'."\n" + .'- FAILURE：失败告警。'."\n" + .'- SUCCESS_FAILURE：成功或失败皆告警。', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [], + 'example' => 'FAILURE', + 'enum' => [ + 'SUCCESS', + 'FAILURE', + 'SUCCESS_FAILURE', + ], + ], + ], + [ + 'name' => 'AlertNoticeType', + 'in' => 'formData', + 'schema' => [ + 'description' => '告警通知方式。取值范围：'."\n" + .'- SMS：短信。'."\n" + .'- MAIL：邮件。'."\n" + .'- SMS_MAIL：短信与邮件。', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [], + 'example' => 'SMS', + 'enum' => [ + 'SMS', + 'MAIL', + 'SMS_MAIL', + ], + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回实体。', + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => [ + 'description' => 'HTTP状态码。'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'RequestId' => [ + 'description' => '请求的ID。用于定位日志，排查问题。'."\n", + 'type' => 'string', + 'example' => '>E6F0DBDD-5AD****', + ], + 'ErrorMessage' => [ + 'description' => '错误信息。'."\n", + 'type' => 'string', + 'example' => 'The connection does not exist.', + ], + 'Success' => [ + 'description' => '调用是否成功。'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'ErrorCode' => [ + 'description' => '错误码。'."\n", + 'type' => 'string', + 'example' => 'Invalid.Tenant.ConnectionNotExists', + ], + 'Data' => [ + 'description' => '周期任务补数据返回的DagId，可以通过该DagId查到对应的实例。', + 'type' => 'array', + 'items' => [ + 'description' => '工作流ID的列表。'."\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>>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' => '创建补数据工作流', + 'description' => '补数据相关内容，详情请参见[补数据](~~137937~~)。', + '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' => '工作空间的环境，包括PROD（生产环境）和DEV（开发环境）。'."\n" + .'简单模式的工作空间无开发环境，详情请参见[简单模式和标准模式的工作空间](~~85772~~)。'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'PROD', + 'enum' => [ + 'PROD', + 'DEV', + ], + ], + ], + [ + 'name' => 'Bizdate', + 'in' => 'formData', + 'schema' => [ + 'description' => '业务日期。'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '2020-05-26 00:00:00', + ], + ], + [ + 'name' => 'Name', + 'in' => 'formData', + 'schema' => [ + 'description' => '工作流的名称。'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'xm_create_test', + 'maxLength' => 128, + ], + ], + [ + 'name' => 'NodeId', + 'in' => 'formData', + 'schema' => [ + 'description' => '节点的ID。您可以调用[ListNodes](~~173979~~)接口获取节点ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + 'example' => '1234', + ], + ], + [ + 'name' => 'NodeParams', + 'in' => 'formData', + 'schema' => [ + 'description' => '节点的参数。配置为一个JSON字符串，Key为节点 ID，Value为参数实际取值。'."\n", + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => 'bizdate=$bizdate tbods=$tbods', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回数据。', + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => [ + 'description' => 'HTTP状态码。'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Data' => [ + 'description' => '工作流的ID。'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '3333333', + ], + 'ErrorMessage' => [ + 'description' => '错误信息。'."\n", + 'type' => 'string', + 'example' => 'The connection does not exist.', + ], + 'RequestId' => [ + 'description' => '请求的ID。用于定位日志，排查问题。'."\n", + 'type' => 'string', + 'example' => 'E6F0DBDD-5AD****', + ], + 'ErrorCode' => [ + 'description' => '错误码。'."\n", + 'type' => 'string', + 'example' => 'Invalid.Tenant.ConnectionNotExists', + ], + 'Success' => [ + 'description' => '调用是否成功。'."\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' => '运行冒烟测试', + 'summary' => '创建冒烟测试工作流。', + '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' => 'DataWorks工作空间的ID。您可以登录DataWorks管控台，进入工作空间配置页面获取工作空间ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + 'maximum' => '99999999999', + 'minimum' => '2', + 'example' => '9527', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回数据结构', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。用于出现错误后排查问题。', + 'type' => 'string', + 'example' => '952795279527ab****', + ], + 'InstanceStatusTrend' => [ + 'description' => '在业务日期的不同时刻，运行成功的实例数量统计趋势数据。'."\n", + 'type' => 'object', + 'properties' => [ + 'TodayTrend' => [ + 'description' => '业务日期当天的趋势。'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '返回数据结构', + 'type' => 'object', + 'properties' => [ + 'TimePoint' => [ + 'description' => '时间点。取值范围为00:00～23:00中的整点小时时间，例如00:00、01:00、02:00等等。', + 'type' => 'string', + 'example' => '01:00', + ], + 'Count' => [ + 'description' => '运行成功的实例数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + ], + ], + ], + 'YesterdayTrend' => [ + 'description' => '业务日期前一天的趋势。'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '返回数据结构。', + 'type' => 'object', + 'properties' => [ + 'TimePoint' => [ + 'description' => '时间点。取值范围为00:00～23:00中的整点小时时间，例如00:00、01:00、02:00等等。', + 'type' => 'string', + 'example' => '01:00', + ], + 'Count' => [ + 'description' => '运行成功的实例数量。'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + ], + ], + ], + 'AvgTrend' => [ + 'description' => '历史平均趋势。'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '返回数据结构。', + 'type' => 'object', + 'properties' => [ + 'TimePoint' => [ + 'description' => '时间点。取值范围为00:00～23:00中的整点小时时间，例如00:00、01:00、02:00等等。', + 'type' => 'string', + 'example' => '01:00', + ], + 'Count' => [ + 'description' => '运行成功的实例数量。'."\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' => '获取运行成功的实例数量', + 'summary' => '获取业务日期当天生成的周期实例任务，在业务日期的不同整点时刻，运行成功的实例数量统计趋势。', + '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' => 'DataWorks工作空间的ID。您可以登录DataWorks管控台，进入工作空间配置页面获取工作空间ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + 'maximum' => '99999999999', + 'minimum' => '2', + 'example' => '10000', + ], + ], + [ + 'name' => 'BeginDate', + 'in' => 'formData', + 'schema' => [ + 'description' => '开始业务日期，精确到天。该参数需要配置为yyyy-MM-dd\'T\'HH:mm:ssZ的UTC格式。'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '2021-06-13T00:00:00+0800', + ], + ], + [ + 'name' => 'EndDate', + 'in' => 'formData', + 'schema' => [ + 'description' => '结束业务日期，精确到天。该参数需要配置为yyyy-MM-dd\'T\'HH:mm:ssZ的UTC格式。'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '2021-06-16T00:00:00+0800', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回数据结构。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。用于出现错误后排查问题。', + 'type' => 'string', + 'example' => '95279527adhfj****', + ], + 'InstanceCounts' => [ + 'description' => '周期实例数量在指定时间段的趋势数据。', + 'type' => 'array', + 'items' => [ + 'description' => '返回数据结构。', + 'type' => 'object', + 'properties' => [ + 'Date' => [ + 'description' => '获取周期实例数量的业务日期，此处显示业务日期对应的时间戳。'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1623772800000', + ], + 'Count' => [ + 'description' => '周期实例的数量。'."\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' => '获取指定时间段周期实例数量趋势', + 'summary' => '获取指定时间段周期实例数量的趋势。', + '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' => 'DataWorks工作空间的ID。您可以登录DataWorks管控台，进入工作空间配置页面获取工作空间ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + 'maximum' => '99999999999', + 'minimum' => '2', + 'example' => '1000001', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '请求返回结果', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。用于出现错误后排查问题。'."\n", + 'type' => 'string', + 'example' => '6347364dadsfadf****', + ], + 'InstanceConsumeTimeRank' => [ + 'description' => '实例运行时长的排行记录。'."\n", + 'type' => 'object', + 'properties' => [ + 'UpdateTime' => [ + 'description' => '实例运行时长排行更新时间戳。'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1600963200000', + ], + 'ConsumeTimeRank' => [ + 'description' => '实例运行时长的排行数据。'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '请求返回结果', + 'type' => 'object', + 'properties' => [ + 'Owner' => [ + 'description' => '节点责任人的阿里云UID。'."\n", + 'type' => 'string', + 'example' => '952795279527', + ], + 'NodeName' => [ + 'description' => '节点的名称。'."\n", + 'type' => 'string', + 'example' => 'Node name', + ], + 'BusinessDate' => [ + 'description' => '实例运行的业务日期。'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1600963200000', + ], + 'ProgramType' => [ + 'description' => '任务的类型。'."\n" + .'常见的类型如下：'."\n" + .'6（Shell）、10（ODPS SQL）、11（ODPS MR）、23（数据集成）、24（ODPS Script）、99（虚拟节点）、221（PyODPS 2）、225（ODPS Spark）、227（EMR Hive）、228（EMR Spark）、229（EMR Spark SQL）、230（EMR MR）、239（OSS对象检查）、257（EMR Shell）、258（EMR Spark Shell）、259（EMR Presto）、260（EMR Impala）、900（实时同步）、1089（跨租户节点）、1091（Hologres开发）、1093（Hologres SQL）、1100（赋值节点）、1221（PyODPS 3）。'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'InstanceId' => [ + 'description' => '实例ID。'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '95279527', + ], + 'NodeId' => [ + 'description' => '任务节点的ID。'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '9527', + ], + 'Consumed' => [ + 'description' => '实例运行时长，单位为s。'."\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' => '获取昨天耗时最长的任务排行', + 'summary' => '获取实例运行时长排行。', + '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' => 'DataWorks工作空间的ID。您可以登录DataWorks管控台，进入工作空间配置页面获取工作空间ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + 'maximum' => '99999999999', + 'minimum' => '2', + 'example' => '10000001', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回数据结构', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。用于出现错误后排查问题。'."\n", + 'type' => 'string', + 'example' => '952795279527****', + ], + 'InstanceErrorRank' => [ + 'description' => '节点出错的排行数据。'."\n", + 'type' => 'object', + 'properties' => [ + 'UpdateTime' => [ + 'description' => '出错排行更新的时间戳。'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1600963200000', + ], + 'ErrorRank' => [ + 'description' => '节点近一个月出错排行数据。'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '返回数据结构', + 'type' => 'object', + 'properties' => [ + 'Owner' => [ + 'description' => '节点责任人的阿里云UID。'."\n", + 'type' => 'string', + 'example' => '952795279527', + ], + 'NodeName' => [ + 'description' => '节点的名称。'."\n", + 'type' => 'string', + 'example' => 'Node name', + ], + 'ProjectId' => [ + 'description' => 'DataWorks工作空间的ID。'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '9527', + ], + 'ProgramType' => [ + 'description' => '节点任务的类型。'."\n" + .'常用的类型如下：'."\n" + .'6（Shell）、10（ODPS SQL）、11（ODPS MR）、23（数据集成）、24（ODPS Script）、99（虚拟节点）、221（PyODPS 2）、225（ODPS Spark）、227（EMR Hive）、228（EMR Spark）、229（EMR Spark SQL）、230（EMR MR）、239（OSS对象检查）、257（EMR Shell）、258（EMR Spark Shell）、259（EMR Presto）、260（EMR Impala）、900（实时同步）、1089（跨租户节点）、1091（Hologres开发）、1093（Hologres SQL）、1100（赋值节点）、1221（PyODPS 3）。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'NodeId' => [ + 'description' => '节点的ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '9527', + ], + 'Count' => [ + 'description' => '节点出错的次数。', + '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' => '获取近一个月节点的出错排行', + 'summary' => '获取近一个月节点的出错排行。', + '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' => 'DataWorks工作空间的ID。您可以登录DataWorks管控台，进入工作空间配置页面获取工作空间ID。'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + 'maximum' => '9223372036854775807', + 'minimum' => '1', + 'example' => '123465', + 'isFileTransferUrl' => false, + ], + ], + [ + 'name' => 'ProjectEnv', + 'in' => 'formData', + 'schema' => [ + 'description' => '工作空间的环境，包括DEV（开发环境）和PROD（生产环境）。'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'PROD', + 'isFileTransferUrl' => false, + 'enum' => [ + 'PROD', + 'DEV', + ], + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求的ID，用于定位日志，排查问题。', + 'type' => 'string', + 'example' => 'SDFSDFSDF-SDFSDF-SDFDSF-SDFSDF', + ], + 'ProgramTypeAndCounts' => [ + 'description' => '节点的类型和数量。'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Count' => [ + 'description' => '节点的数量。'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'ProgramType' => [ + 'description' => '节点的类型。'."\n" + .'常用的类型如下：'."\n" + .'6（Shell）、10（ODPS SQL）、11（ODPS MR）、23（数据集成）、24（ODPS Script）、99（虚拟节点）、221（PyODPS 2）、225（ODPS Spark）、227（EMR Hive）、228（EMR Spark）、229（EMR Spark SQL）、230（EMR MR）、239（OSS对象检查）、257（EMR Shell）、258（EMR Spark Shell）、259（EMR Presto）、260（EMR Impala）、900（实时同步）、1089（跨租户节点）、1091（Hologres开发）、1093（Hologres SQL）、1100（赋值节点）、1221（PyODPS 3）。'."\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' => '获取节点任务类型分布情况', + 'summary' => '获取节点任务类型的分布情况。', + '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' => 'DataWorks工作空间的ID。您可以登录DataWorks管控台，进入工作空间配置页面获取工作空间ID。'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + 'maximum' => '9223372036854775807', + 'minimum' => '1', + 'example' => '1234', + 'isFileTransferUrl' => false, + ], + ], + [ + 'name' => 'ProjectEnv', + 'in' => 'formData', + 'schema' => [ + 'description' => '运行的环境，包括PROD（生产环境）和DEV（开发环境）。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'enumValueTitles' => [], + 'example' => 'PROD', + 'isFileTransferUrl' => false, + 'enum' => [ + 'PROD', + 'DEV', + ], + ], + ], + [ + 'name' => 'BizDate', + 'in' => 'formData', + 'schema' => [ + 'description' => '获取不同实例状态数量的业务日期。格式为yyyy-MM-dd。'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '2020-01-01', + 'maxLength' => 10, + 'minLength' => 10, + 'isFileTransferUrl' => false, + ], + ], + [ + 'name' => 'SchedulerType', + 'in' => 'formData', + 'schema' => [ + 'description' => '调度的类型，取值如下：'."\n" + .'- NORMAL：周期调度'."\n" + .'- MANUAL：手动调度'."\n" + .'- PAUSE：暂停调度'."\n" + .'- SKIP：空跑', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [], + 'example' => 'NORMAL', + 'enum' => [ + 'NORMAL', + 'MANUAL', + 'PAUSE', + 'SKIP', + ], + ], + ], + [ + 'name' => 'DagType', + 'in' => 'formData', + 'schema' => [ + 'description' => 'Dag Type的类型：'."\n" + .'- MANUAL：手动任务工作流'."\n" + .'- SMOKE_TEST：冒烟测试工作流'."\n" + .'- SUPPLY_DATA：补数据'."\n" + .'- BUSINESS_PROCESS_DAG：一次性业务流程工作流', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [], + 'example' => 'MANUAL', + 'enum' => [ + 'DAILY', + 'MANUAL', + 'SMOKE_TEST', + 'SUPPLY_DATA', + 'BUSINESS_PROCESS_DAG', + ], + ], + ], + [ + 'name' => 'SchedulerPeriod', + 'in' => 'formData', + 'schema' => [ + 'description' => '调度周期。'."\n" + .'- MINUTE：分钟。'."\n" + .'- HOUR：小时。'."\n" + .'- DAY：天。'."\n" + .'- WEEK：周。'."\n" + .'- MONTH：月。', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [], + 'example' => 'DAY', + 'enum' => [ + 'MINUTE', + 'HOUR', + 'DAY', + 'WEEK', + 'MONTH', + ], + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回实体。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID，用于定位日志，排查问题。'."\n", + 'type' => 'string', + 'example' => '0000-ABCD-EFG****', + ], + 'StatusCount' => [ + 'description' => '实例状态的数量统计。'."\n", + 'type' => 'object', + 'properties' => [ + 'FailureCount' => [ + 'description' => '运行失败的实例数量。'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'WaitTimeCount' => [ + 'description' => '等待运行的实例数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'RunningCount' => [ + 'description' => '运行中的实例数量。'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'SuccessCount' => [ + 'description' => '运行成功的实例数量。'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'TotalCount' => [ + 'description' => '实例的总数。'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'NotRunCount' => [ + 'description' => '未运行的实例数量。'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'WaitResCount' => [ + 'description' => '等待资源的实例数量。'."\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' => '获取实例运行状态统计数据', + 'summary' => '用GetInstanceStatusCount获取实例任务不同运行状态的数量统计。', + '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' => 'DataWorks工作空间的ID。您可以登录DataWorks管控台，进入工作空间配置页面获取工作空间ID。该参数与ProjectIdentifier参数，二者必须设置其一，用来确定本次API调用操作的DataWorks工作空间。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '10000', + ], + ], + [ + 'name' => 'ProjectIdentifier', + 'in' => 'formData', + 'schema' => [ + 'description' => 'DataWorks工作空间名称。您可以登录DataWorks控制台，进入工作空间配置页面获取工作空间名称。'."\n" + .'该参数与ProjectId参数，二者必须设置其一，用来确定本次API调用操作的DataWorks工作空间。', + 'type' => 'string', + 'required' => false, + 'example' => 'dw_project', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'formData', + 'schema' => [ + 'description' => '请求数据的页码数。'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'docRequired' => true, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'formData', + 'schema' => [ + 'description' => '每页显示的数据条数，最大值为100。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'docRequired' => true, + 'example' => '50', + ], + ], + [ + 'name' => 'Keyword', + 'in' => 'formData', + 'schema' => [ + 'description' => '节点类型的名称。您可以登录DataWorks控制台，进入数据开发界面，在左侧导航栏查看某类型节点的名称。配置说明如下：'."\n" + .'- 支持查看中英文名称，但该参数查看的名称语言需要与Locale参数的语言类型一致。'."\n" + .'- 支持模糊搜索。'."\n" + .'- 如果不配置该参数，则会返回所有节点类型的名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'ODPS SQL', + ], + ], + [ + 'name' => 'Locale', + 'in' => 'formData', + 'schema' => [ + 'description' => '选择查询的语言，支持查询zh-CN和en-US语言的节点类型信息。'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh-CN', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。用于出现错误后排查问题。', + 'type' => 'string', + 'example' => '0000-ABCD-EFG****', + ], + 'NodeTypeInfoList' => [ + 'description' => '返回的节点类型信息列表。'."\n", + 'type' => 'object', + 'properties' => [ + 'PageNumber' => [ + 'description' => '当前数据页的页码。'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '当前数据页显示的数据条数。'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '50', + ], + 'TotalCount' => [ + 'description' => '满足查询条件的数据总条数。'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '127', + ], + 'NodeTypeInfo' => [ + 'description' => '单个节点类型的信息。'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'NodeTypeName' => [ + 'description' => '节点类型的名称。'."\n" + .'常用的代码及名称类型对应关系如下：'."\n" + .'6（Shell）、10（ODPS SQL）、11（ODPS MR）、23（数据集成）、24（ODPS Script）、99（虚拟节点）、221（PyODPS 2）、225（ODPS Spark）、227（EMR Hive）、228（EMR Spark）、229（EMR Spark SQL）、230（EMR MR）、239（OSS对象检查）、257（EMR Shell）、258（EMR Spark Shell）、259（EMR Presto）、260（EMR Impala）、900（实时同步）、1089（跨租户节点）、1091（Hologres开发）、1093（Hologres SQL）、1100（赋值节点）、1221（PyODPS 3）。', + 'type' => 'string', + 'example' => 'ODPS SQL', + ], + 'NodeType' => [ + 'description' => '节点类型的Code信息。'."\n" + .'常用的代码及名称类型对应关系如下：'."\n" + .'6（Shell）、10（ODPS SQL）、11（ODPS MR）、23（数据集成）、24（ODPS Script）、99（虚拟节点）、221（PyODPS 2）、225（ODPS Spark）、227（EMR Hive）、228（EMR Spark）、229（EMR Spark SQL）、230（EMR MR）、239（OSS对象检查）、257（EMR Shell）、258（EMR Spark Shell）、259（EMR Presto）、260（EMR Impala）、900（实时同步）、1089（跨租户节点）、1091（Hologres开发）、1093（Hologres SQL）、1100（赋值节点）、1221（PyODPS 3）。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + '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' => '查询任务节点类型', + 'summary' => '查询任务节点的类型信息，包括类型Code和类型名称。', + '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' => '调度运维中心的环境标识。PROD表示生产环境，DEV表示开发环境。'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'enumValueTitles' => [], + 'example' => 'PROD or DEV', + 'enum' => [ + 'PROD', + 'DEV', + ], + ], + ], + [ + 'name' => 'ProjectName', + 'in' => 'formData', + 'schema' => [ + 'description' => '手动业务流程所属的工作空间英文名称。'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'test_workspace', + 'pattern' => '^([^\\x00-\\xff]|[\\w.,;/@\\n-])+$', + ], + ], + [ + 'name' => 'FlowName', + 'in' => 'formData', + 'schema' => [ + 'description' => '手动业务流程的名称。'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'test_workflow', + 'pattern' => '^([^\\x00-\\xff]|[\\w.,;/@\\n-])+$', + ], + ], + [ + 'name' => 'BizDate', + 'in' => 'formData', + 'schema' => [ + 'description' => '业务日期的值为小于等于当前日期-1天。例如，今天是2020年11月11日，则业务日期需要是2020年11月10日的00:00:00或者该日期之前的日期。业务日期的时分秒信息均填写00。'."\n" + .'StartBizDate与EndBizDate参数配合使用，当前参数与StartBizDate和EndBizDate参数只能配置一个。', + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => '2020-11-11 00:00:00', + ], + ], + [ + 'name' => 'NodeParameters', + 'in' => 'formData', + 'schema' => [ + 'description' => '传递手动业务流程执行时的节点参数信息，对应手动业务流程里的节点**属性**配置的**调度参数**。'."\n" + ."\n" + .'一个JSON格式： { "<手动业务流程内部的某个节点ID>": "节点的调度参数信息，和数据开发调度配置里面的参数格式保持一致", "<手动业务流程内部的某个节点ID>": "节点的调度参数信息，和数据开发调度配置里面的参数格式保持一致" }', + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => '{"20000123121": "key1=val2 key2=val2", "20000123124": "kkkk=vvvvv aaaa=bbbb"}', + ], + ], + [ + 'name' => 'DagParameters', + 'in' => 'formData', + 'schema' => [ + 'description' => '该参数会同步至本次Dag的所有实例中。如果内部节点（[支持的节点类型](~~147245~~)）的调度参数引用了DagParameters中的业务流程参数，则节点的对应参数值会被替换为DagParameter中的业务流程参数。', + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => '{"kaaaa": "vaaaaa", "kbbbb": "vbbbbb"}', + ], + ], + [ + 'name' => 'IncludeNodeIds', + 'in' => 'formData', + 'schema' => [ + 'description' => '如果需要运行手动业务流程里的部分节点，可输入相应节点ID。多个节点ID使用逗号（,）分隔。', + 'type' => 'string', + 'required' => false, + 'example' => '74324,74325', + ], + ], + [ + 'name' => 'ExcludeNodeIds', + 'in' => 'formData', + 'schema' => [ + 'description' => '如果不需要运行业务流程里的部分节点，可输入相应节点ID。此处输入的节点运行时会生成空跑实例，空跑实例被调度后会直接运行成功，不会执行脚本内容。多个节点ID使用逗号（,）分隔。'."\n" + .'ExcludeNodeIds参数需要与IncludeNodeIds参数同时使用，ExcludeNodeIds参数的配置才会生效。', + 'type' => 'string', + 'required' => false, + 'example' => '123,456', + ], + ], + [ + 'name' => 'ProjectId', + 'in' => 'formData', + 'schema' => [ + 'description' => '项目ID', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '123', + ], + ], + [ + 'name' => 'StartBizDate', + 'in' => 'formData', + 'schema' => [ + 'description' => '获取业务开始日期，格式为yyyy-MM-dd HH:mm:ss。'."\n" + .'StartBizDate与EndBizDate参数配合使用，并且当前参数与BizDate参数只能配置一个。', + 'type' => 'string', + 'required' => false, + 'example' => '2020-02-02 00:00:00', + ], + ], + [ + 'name' => 'EndBizDate', + 'in' => 'formData', + 'schema' => [ + 'description' => '获取业务结束日期，格式为yyyy-MM-dd HH:mm:ss。'."\n" + .'StartBizDate与EndBizDate参数配合使用，并且当前参数与BizDate参数只能配置一个。', + 'type' => 'string', + 'required' => false, + 'example' => '2020-02-03 00:00:00', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'DagId' => [ + 'description' => '手动业务流程运行Dag的实例ID。您可以通过接口和该DagId查询此次手动业务流程运行的内部节点实例的详细信息和状态。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '700000123123141', + ], + 'RequestId' => [ + 'description' => '请求唯一标识。'."\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' => '执行手动业务流程', + 'summary' => '手动业务流程必须已在环境界面提交发布，之后运维中心才会显示对应手动业务流程，您才可以使用该接口，触发手动业务流程运行。', + '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' => '运维中心的调度环境标识，包括PROD（生产环境）和DEV（开发环境）。'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'RPOD', + 'enum' => [ + 'PROD', + 'DEV', + ], + ], + ], + [ + 'name' => 'ProjectName', + 'in' => 'formData', + 'schema' => [ + 'description' => '手动业务流程所属的工作空间名称。您可以进入[DataWorks控制台](https://workbench.data.aliyun.com/console)，在工作空间配置页面获取。'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'test_workspace', + ], + ], + [ + 'name' => 'DagId', + 'in' => 'formData', + 'schema' => [ + 'description' => '触发手动业务流程运行的Dag实例ID。您可以调用[RunManualDagNodes](~~212830~~)接口获取。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '7000001231241', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID，用于定位日志，排查问题。'."\n", + 'type' => 'string', + 'example' => 'SDFSDFSDF-SDFSDF-SDFDSF-SDFSDF', + ], + 'Instances' => [ + 'description' => '手动业务流程的内部实例列表。'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '返回数据。', + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => '实例任务的状态，取值如下：'."\n" + ."\n" + .'- NOT_RUN（未运行）'."\n" + .'- WAIT_TIME（等待定时时间DueTime或CycleTime到来）'."\n" + .'- WAIT_RESOURCE（等待资源）'."\n" + .'- RUNNING（运行中）'."\n" + .'- CHECKING（下发给数据质量进行数据校检）'."\n" + .'- CHECKING_CONDITION（正在进行分支条件校检）'."\n" + .'- FAILURE（执行失败）'."\n" + .'- SUCCESS（执行成功）', + 'type' => 'string', + 'example' => 'SUCCESS', + ], + 'BeginRunningTime' => [ + 'description' => ' 实例任务开始运行的时间。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1605178414676', + ], + 'BizDate' => [ + 'description' => '业务日期。通常为该任务运行时间的前一天。'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1605178414676', + ], + 'CycTime' => [ + 'description' => '实例任务的定时时间。'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1605178414676', + ], + 'FinishTime' => [ + 'description' => '实例任务运行的结束时间。'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1605178414676', + ], + 'CreateTime' => [ + 'description' => '实例任务的创建时间。'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1605178414676', + ], + 'DagId' => [ + 'description' => '手动业务流程实例的DagId。'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '350850491', + ], + 'InstanceId' => [ + 'description' => '内部实例ID。'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '11726873619', + ], + 'BeginWaitResTime' => [ + 'description' => '实例任务开始等待资源的时间。'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1605178414676', + ], + 'TaskType' => [ + 'description' => '实例任务的调度类型，取值如下：'."\n" + ."\n" + .'- NORMAL(0)：正常调度任务。该任务被日常调度。'."\n" + .'- MANUAL(1)：手动任务。该任务不会被日常调度。'."\n" + .'- PAUSE(2)：冻结任务。该任务被日常调度，但启动调度时直接被置为失败状态。'."\n" + .'- SKIP(3)：空跑任务。该任务被日常调度，但启动调度时直接被置为成功状态。'."\n" + .'- SKIP_UNCHOOSE(4)：临时工作流中未选择的任务，仅存在于临时工作流中，启动调度时直接被置为成功状态。'."\n" + .'- SKIP_CYCLE(5)：未到运行周期的周或月任务。该任务被日常调度，但启动调度时直接被置为成功状态。'."\n" + .'- CONDITION_UNCHOOSE(6)：上游实例中有分支（IF）节点，但是该下游节点未被分支节点选中，直接置为空跑任务。'."\n" + .'- REALTIME_DEPRECATED(7)：实时生成的已经过期的周期实例，该类型的任务直接被置为成功状态。', + 'type' => 'string', + 'example' => 'MANUAL', + ], + 'ParamValues' => [ + 'description' => '实例的参数信息。'."\n", + 'type' => 'string', + 'example' => 'xxx=yyy', + ], + 'DagType' => [ + 'description' => '手动业务流程的标识。'."\n", + 'type' => 'string', + 'example' => '5', + ], + 'NodeName' => [ + 'description' => '节点的名称。'."\n", + 'type' => 'string', + 'example' => 'test2', + ], + 'BeginWaitTimeTime' => [ + 'description' => '实例任务开始等待调度的时间。'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1605178414676', + ], + 'NodeId' => [ + 'description' => '业务流程的内部节点ID。'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '37851', + ], + 'ModifyTime' => [ + 'description' => '最近一次修改实例任务的时间。'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1605178414676', + ], + 'CreateUser' => [ + 'description' => '触发实例运行的用户。例如，用户Test触发运行手动执行的业务流程实例，则CreateUser为Test。', + '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' => '获取手动执行的业务流程实例的信息', + 'summary' => '获取手动执行的业务流程实例的信息。', + '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' => '根据DagId获取Dag详情。可通过如下方式获取DagId：'."\n" + .'- 调用[RunCycleDagNodes](~~2780209~~)接口，获取返回值**Data**。'."\n" + .'- 调用[RunSmokeTest](~~2780210~~)接口，获取返回值**Data**。'."\n" + .'- 调用[RunManualDagNodes](~~2780218~~)接口，获取返回值**DagId**。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + 'minimum' => '2', + 'example' => '123141452344525', + ], + ], + [ + 'name' => 'ProjectEnv', + 'in' => 'formData', + 'schema' => [ + 'description' => '调度运维环境的标识：PROD表示生产环境，DEV表示开发环境。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'PROD', + 'enum' => [ + 'PROD', + 'DEV', + ], + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回实体。', + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => [ + 'description' => 'HTTP状态码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'RequestId' => [ + 'description' => '请求的ID。用于定位日志，排查问题。', + 'type' => 'string', + 'example' => '7782a299-b291-4fee-8424-cf8058efa8e8', + ], + 'ErrorMessage' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'The connection does not exist.', + ], + 'ErrorCode' => [ + 'description' => '错误码。', + 'type' => 'string', + 'example' => 'Invalid.Tenant.ConnectionNotExists', + ], + 'Success' => [ + 'description' => '调用是否成功。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Data' => [ + 'description' => 'Dag的详情信息。', + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'description' => 'DAG的类型，包括MANUAL（手动任务工作流）、SMOKE_TEST（冒烟测试工作流）、SUPPLY_DATA（补数据）和BUSINESS_PROCESS_DAG（一次性业务流程工作流）。', + 'type' => 'string', + 'example' => 'MANUAL_FLOW', + ], + 'Status' => [ + 'description' => 'DAG的状态，包括CREATED（已创建）、RUNNING（运行中）、FAILURE（运行失败）和SUCCESS（运行成功）。'."\n" + .' ', + 'type' => 'string', + 'example' => 'FAILURE', + ], + 'FinishTime' => [ + 'description' => '结束时间。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1605052800000', + ], + 'CreateTime' => [ + 'description' => '创建时间。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1605052800000', + ], + 'ProjectId' => [ + 'description' => '工作空间的ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '112345', + ], + 'DagId' => [ + 'description' => 'DagId。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '351249682', + ], + 'Gmtdate' => [ + 'description' => 'Gmtdate。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1605052800000', + ], + 'StartTime' => [ + 'description' => '开始时间。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1605052800000', + ], + 'CreateUser' => [ + 'description' => '创建人。', + 'type' => 'string', + 'example' => '1736629400048545', + ], + 'Bizdate' => [ + 'description' => '业务日期。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1605052800000', + ], + 'Name' => [ + 'description' => 'Dag的名称。', + 'type' => 'string', + 'example' => 'test_dag', + ], + 'ModifyTime' => [ + 'description' => '修改时间。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1605052800000', + ], + 'OpSeq' => [ + 'description' => '操作的标识码。', + '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' => '根据DagId获取Dag详情', + 'summary' => '支持查询手动业务流程、手动任务、补数据的Dag详情信息，不支持查询日常调度Dag详情。', + 'description' => 'Dag Type的类型：'."\n" + ."\n" + .'- MANUAL：手动任务工作流'."\n" + .' '."\n" + .'- SMOKE_TEST：冒烟测试工作流'."\n" + ."\n" + .'- SUPPLY_DATA：补数据'."\n" + ."\n" + .'- BUSINESS_PROCESS_DAG：一次性业务流程工作流'."\n" + ."\n" + .'Dag Status的类型：'."\n" + ."\n" + .'- CREATED：已创建'."\n" + .'- RUNNING：运行中'."\n" + .'- FAILURE：运行失败'."\n" + .'- SUCCESS：运行成功', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'ListDags' => [ + 'summary' => '根据OpSeq（补数据唯一标识）获取单次补数据的所有Dag详情。', + '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' => '补数据唯一标识。您可通过调用[GetDag](~~189753~~)接口获取。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'minimum' => '2', + 'example' => '123', + ], + ], + [ + 'name' => 'ProjectEnv', + 'in' => 'formData', + 'schema' => [ + 'description' => '调度运维环境的标识：PROD表示生产环境，DEV表示开发环境。', + 'type' => 'string', + 'required' => true, + 'example' => 'PROD', + 'enum' => [ + 'PROD', + 'DEV', + ], + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回实体。', + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => [ + 'description' => 'HTTP状态码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'RequestId' => [ + 'description' => '请求的ID。用于定位日志，排查问题。', + 'type' => 'string', + 'example' => '7782a299-b291-4fee-8424-cf8058efa8e8', + ], + 'ErrorMessage' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'The connection does not exist.', + ], + 'ErrorCode' => [ + 'description' => '错误码。', + 'type' => 'string', + 'example' => 'Invalid.Tenant.ConnectionNotExists', + ], + 'Success' => [ + 'description' => '调用是否成功。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Data' => [ + 'description' => 'Dag的详情信息。', + 'type' => 'object', + 'properties' => [ + 'Dags' => [ + 'description' => '返回的实体。', + 'type' => 'array', + 'items' => [ + 'description' => '返回实体。', + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'description' => 'DAG的类型。取值如下：'."\n" + .'- MANUAL（手动任务工作流）'."\n" + .'- SMOKE_TEST（冒烟测试工作流）'."\n" + .'- SUPPLY_DATA（补数据）'."\n" + .'- BUSINESS_PROCESS_DAG（一次性业务流程工作流）', + 'type' => 'string', + 'example' => 'MANUAL_FLOW', + ], + 'Status' => [ + 'description' => 'DAG的状态。取值如下：'."\n" + .'- CREATED（已创建）'."\n" + .'- RUNNING（运行中）'."\n" + .'- FAILURE（运行失败）'."\n" + .'- SUCCESS（运行成功）', + 'type' => 'string', + 'example' => 'FAILURE', + ], + 'FinishTime' => [ + 'description' => '结束时间。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1605052800000', + ], + 'CreateTime' => [ + 'description' => '创建时间。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1605052800000', + ], + 'ProjectId' => [ + 'description' => '工作空间的ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '112345', + ], + 'DagId' => [ + 'description' => 'DagId。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '351249682', + ], + 'Gmtdate' => [ + 'description' => 'Gmtdate。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1605052800000', + ], + 'StartTime' => [ + 'description' => '开始时间。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1605052800000', + ], + 'CreateUser' => [ + 'description' => '创建人。', + 'type' => 'string', + 'example' => '1736629400048545', + ], + 'Bizdate' => [ + 'description' => '业务日期。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1605052800000', + ], + 'Name' => [ + 'description' => 'Dag的名称。', + 'type' => 'string', + 'example' => 'test_dag', + ], + 'ModifyTime' => [ + 'description' => '修改时间。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1605052800000', + ], + 'OpSeq' => [ + 'description' => '操作的标识码。', + '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' => '获取单次补数据的所有Dag详情', + 'description' => 'Dag Type的类型：'."\n" + ."\n" + .'- MANUAL：手动任务工作流'."\n" + .'- SMOKE_TEST：冒烟测试工作流'."\n" + .'- SUPPLY_DATA：补数据'."\n" + .'- BUSINESS_PROCESS_DAG：一次性业务流程工作流'."\n" + ."\n" + .'Dag Status的类型：'."\n" + ."\n" + .'- CREATED：已创建'."\n" + .'- RUNNING：运行中'."\n" + .'- FAILURE：运行失败'."\n" + .'- SUCCESS：运行成功', + ], + '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' => '调度运维中心的环境标识，PROD表示生产环境，DEV表示开发环境。'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'enumValueTitles' => [], + 'example' => 'PROD', + 'enum' => [ + 'PROD', + 'DEV', + ], + ], + ], + [ + 'name' => 'Outputs', + 'in' => 'formData', + 'schema' => [ + 'description' => '节点的输出名称。支持配置多个输出名称，配置多个名称时请使用英文逗号（,）分隔。'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'aaaaa.1231412_out,bbbb.12313123_out', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => [ + 'description' => 'HTTP状态码。'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'RequestId' => [ + 'description' => '请求的ID。用于定位日志，排查问题。'."\n", + 'type' => 'string', + 'example' => 'SDFSDFSDF-asdfDFSDF-SDFSDf-SDfSFD', + ], + 'ErrorMessage' => [ + 'description' => '错误信息。'."\n", + 'type' => 'string', + 'example' => 'The connection does not exist.', + ], + 'ErrorCode' => [ + 'description' => '错误码。'."\n", + 'type' => 'string', + 'example' => 'Invalid.Tenant.ConnectionNotExists', + ], + 'Success' => [ + 'description' => '调用是否成功。'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'Data' => [ + 'description' => '返回的目标节点信息列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Output' => [ + 'description' => '当前节点的输出名称。', + 'type' => 'string', + 'example' => 'test_0709_1.630003556_out', + ], + 'NodeList' => [ + 'description' => 'input和output对应的节点信息列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'SchedulerType' => [ + 'description' => '节点任务的调度类型，取值如下：'."\n" + .'- NORMAL：正常调度任务。该任务被日常调度。'."\n" + .'- MANUAL：手动任务。该任务不会被日常调度。'."\n" + .'- PAUSE：冻结任务。该任务被日常调度，但启动调度时直接被置为失败状态。'."\n" + .'- SKIP：空跑任务。该任务被日常调度，但启动调度时直接被置为成功状态。', + 'type' => 'string', + 'example' => 'NORMAL', + ], + 'RepeatInterval' => [ + 'description' => '节点运行出错后重新调度的频率。'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '60', + ], + 'Repeatability' => [ + 'description' => '是否可以重复运行。'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'FileType' => [ + 'description' => '文件类型。不同文件类型其代码不同，详情请参见[DataWorks节点合集](~~600169~~)。', + 'type' => 'string', + 'example' => 'ODPS_SQL', + ], + 'ProjectId' => [ + 'description' => '工作空间的ID。'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '33671', + ], + 'ProgramType' => [ + 'description' => '节点的类型。该参数已废弃，节点类型请参考FileType。'."\n", + 'type' => 'string', + 'example' => 'ODPS_SQL', + ], + 'Priority' => [ + 'description' => '节点运行的优先级，取值分为1、3、5、7和8。取值越大，优先级越高。默认优先级为1。'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'OwnerId' => [ + 'description' => '负责人的ID。'."\n", + 'type' => 'string', + 'example' => '19337906836551', + ], + 'Connection' => [ + 'description' => '数据源名称。', + 'type' => 'string', + 'example' => 'odps_source', + ], + 'ParamValues' => [ + 'description' => '节点的调度参数。'."\n", + 'type' => 'string', + 'example' => 'a=b', + ], + 'RelatedFlowId' => [ + 'description' => '关联的业务流程ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1235655464', + ], + 'DqcType' => [ + 'description' => 'DQC类型，0表示有关联dqc，1表示没有关联dqc。'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'BaselineId' => [ + 'description' => '基线ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1235667', + ], + 'Description' => [ + 'description' => '节点的描述信息。'."\n", + 'type' => 'string', + 'example' => 'test', + ], + 'NodeName' => [ + 'description' => '节点的名称。'."\n", + 'type' => 'string', + 'example' => 'liux_test_n****', + ], + 'ResGroupName' => [ + 'description' => '资源组的名称。'."\n", + 'type' => 'string', + 'example' => 'Default Resource Group', + ], + 'DqcDescription' => [ + 'description' => 'DQC分区规则串。', + 'type' => 'string', + 'example' => '[{"projectName":"ztjy_dim","tableName":"dim_user_agent_manage_area_a","partition":"ds\\u003d$[yyyy-mm-dd-1]"}]', + ], + 'CronExpress' => [ + 'description' => 'cron表达式。'."\n", + 'type' => 'string', + 'example' => '00 00 00 * * ?', + ], + 'NodeId' => [ + 'description' => '节点的ID。'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '125677', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + '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' => '根据节点的输出结果精确查询目标节点', + 'summary' => '根据节点的输出结果精确查询目标节点。', + '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' => '触发式节点的节点ID。您可参见[ListNodes](~~173979~~)获取节点ID信息。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + 'maximum' => '9223372036854775807', + 'minimum' => '-9223372036854775808', + 'example' => '10000011', + ], + ], + [ + 'name' => 'CycleTime', + 'in' => 'formData', + 'schema' => [ + 'description' => '触发式节点对应节点任务的13位的毫秒级定时时间戳。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + 'maximum' => '9223372036854775807', + 'minimum' => '-9223372036854775808', + 'example' => '1606200230105', + ], + ], + [ + 'name' => 'BizDate', + 'in' => 'formData', + 'schema' => [ + 'description' => '触发式节点实例所在的业务日期时间戳。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + 'maximum' => '9223372036854775807', + 'minimum' => '-9223372036854775808', + 'example' => '1606200230105', + ], + ], + [ + 'name' => 'AppId', + 'in' => 'formData', + 'schema' => [ + 'description' => '触发式节点所属的DataWorks工作空间ID。工作空间ID可参见[ListProjects](~~178393~~)查询。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + 'maximum' => '9223372036854775807', + 'minimum' => '-9223372036854775808', + 'example' => '10001', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Success' => [ + 'description' => '调用是否成功。'."\n" + ."\n" + .'- true：调用成功'."\n" + ."\n" + .'- false：调用失败', + 'type' => 'boolean', + 'example' => 'true', + ], + 'RequestId' => [ + 'description' => '一次请求的唯一标识。', + 'type' => 'string', + 'example' => '9BA675F1-F848-4752-A6E3-92ABA0616005', + ], + ], + ], + ], + ], + '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' => '运行一个触发式节点', + 'summary' => '调用RunTriggerNode运行一个触发式节点。', + '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' => '调度运维中心的环境标识。PROD表示生产环境，DEV表示开发环境。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'PROD', + 'enum' => [ + 'PROD', + 'DEV', + ], + ], + ], + [ + 'name' => 'NodeId', + 'in' => 'formData', + 'schema' => [ + 'description' => '节点ID。您可以进入管控台的运维中心界面，查看节点ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + 'example' => '12345456211234', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回实体。', + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => [ + 'description' => 'HTTP返回码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'RequestId' => [ + 'description' => '本次调用的唯一ID。出现错误后，您可以根据该ID排查问题。', + 'type' => 'string', + 'example' => 'asfsdfas-adfasdf-asfas-dfasdf-asdf', + ], + 'ErrorMessage' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'err', + ], + 'ErrorCode' => [ + 'description' => '错误码。', + 'type' => 'string', + 'example' => '1060010000000', + ], + 'Success' => [ + 'description' => '调用是否成功。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Data' => [ + 'description' => '返回的节点信息列表。'."\n", + 'type' => 'object', + 'properties' => [ + 'Nodes' => [ + 'description' => '节点列表。'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '返回实体。', + 'type' => 'object', + 'properties' => [ + 'SchedulerType' => [ + 'description' => '调度类型。取值如下：'."\n" + .'- NORMAL，正常调度任务。'."\n" + .'- MANUAL，手动任务，不会被日常调度。'."\n" + .'- PAUSE，暂停任务，被日常调度，但启动调度时直接被置为失败。'."\n" + .'- SKIP，空跑任务，被日常调度，但启动调度时直接被置为成功。', + 'type' => 'string', + 'example' => 'NORMAL', + ], + 'BaselineId' => [ + 'description' => '基线ID。'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1244564565', + ], + 'Repeatability' => [ + 'description' => '节点任务运行失败是否可重跑。'."\n" + .'- true，重跑。'."\n" + .'- false，不重跑。'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'NodeName' => [ + 'description' => '节点名称。'."\n", + 'type' => 'string', + 'example' => 'test_Node', + ], + 'ProjectId' => [ + 'description' => '节点所在项目空间的ID。'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '12315412412', + ], + 'ProgramType' => [ + 'description' => '节点类型。', + 'type' => 'string', + 'example' => 'ODPS_SQL', + ], + 'Priority' => [ + 'description' => '优先级。取值为1~8，数值越大，优先级越高。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '3', + ], + 'OwnerId' => [ + 'description' => '节点Owner的DataWorks UID。'."\n", + 'type' => 'string', + 'example' => '123124561341251321', + ], + 'CronExpress' => [ + 'description' => '定时表达式。用于定时调度执行节点任务。'."\n", + 'type' => 'string', + 'example' => '00 00 * * * *', + ], + 'NodeId' => [ + 'description' => '节点ID。'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1244564565', + ], + 'StepType' => [ + 'description' => '调度依赖类型。'."\n" + .'- **0**：同周期依赖'."\n" + .'- **3**：跨周期依赖', + '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' => '获取节点上游列表', + 'summary' => '调用GetNodeParents获取节点上游列表。', + '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' => '调度运维中心的环境标识。PROD表示生产环境，DEV表示开发环境。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'enumValueTitles' => [], + 'example' => 'PROD', + 'enum' => [ + 'PROD', + 'DEV', + ], + ], + ], + [ + 'name' => 'NodeId', + 'in' => 'formData', + 'schema' => [ + 'description' => '节点ID。您可以进入管控台的运维中心界面，查看节点ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + 'example' => '123456878', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回实体。', + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => [ + 'description' => 'HTTP返回码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'RequestId' => [ + 'description' => '本次调用的唯一ID。出现错误后，您可以根据该ID排查问题。', + 'type' => 'string', + 'example' => 'adsfasdf-adf-asdf-asdf-asdfadfasdd', + ], + 'ErrorMessage' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'err', + ], + 'ErrorCode' => [ + 'description' => '错误码。', + 'type' => 'string', + 'example' => '1060010000000', + ], + 'Success' => [ + 'description' => '调用是否成功。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Data' => [ + 'description' => '返回的节点信息列表。', + 'type' => 'object', + 'properties' => [ + 'Nodes' => [ + 'description' => '节点列表。', + 'type' => 'array', + 'items' => [ + 'description' => '返回实体。', + 'type' => 'object', + 'properties' => [ + 'SchedulerType' => [ + 'description' => '调度类型。取值如下：'."\n" + .'- NORMAL，正常调度任务。'."\n" + .'- MANUAL，手动任务，不会被日常调度。'."\n" + .'- PAUSE，暂停任务，被日常调度，但启动调度时直接被置为失败。'."\n" + .'- SKIP，空跑任务，被日常调度，但启动调度时直接被置为成功。', + 'type' => 'string', + 'example' => 'NORMAL', + ], + 'BaselineId' => [ + 'description' => '基线ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '12345656', + ], + 'Repeatability' => [ + 'description' => '节点任务运行失败是否可重跑。'."\n" + .'- true，重跑。'."\n" + .'- false，不重跑。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'NodeName' => [ + 'description' => '节点名称。', + 'type' => 'string', + 'example' => 'test_Node', + ], + 'ProjectId' => [ + 'description' => '节点所在项目空间的ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '12315412412', + ], + 'ProgramType' => [ + 'description' => '节点类型。', + 'type' => 'string', + 'example' => 'ODPS_SQL', + ], + 'Priority' => [ + 'description' => '优先级。取值为1~8，数值越大，优先级越高。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '3', + ], + 'OwnerId' => [ + 'description' => '节点Owner的DataWorks UID。', + 'type' => 'string', + 'example' => '123124561341251321', + ], + 'CronExpress' => [ + 'description' => '定时表达式。用于定时调度执行节点任务。', + 'type' => 'string', + 'example' => '00 00 * * * * ', + ], + 'NodeId' => [ + 'description' => '节点ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1244564565', + ], + 'StepType' => [ + 'description' => '调度依赖类型。'."\n" + .'- **0**：同周期依赖'."\n" + .'- **3**：跨周期依赖', + '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' => '获取节点下游列表', + 'summary' => '调用GetNodeChildren获取节点下游列表。', + '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' => '运行的环境，包括开发环境（DEV）和生产环境（PRD）。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'PROD', + 'enum' => [ + 'PROD', + 'DEV', + ], + ], + ], + [ + 'name' => 'NodeId', + 'in' => 'formData', + 'schema' => [ + 'description' => '节点的ID，您可以调用[ListNodes](~~173979~~)接口获取节点ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + 'example' => '1234', + ], + ], + [ + 'name' => 'SchedulerType', + 'in' => 'formData', + 'schema' => [ + 'description' => '需要对目标节点执行的操作。取值如下：'."\n" + .'- 0：表示解冻目标节点。'."\n" + .'- 2：表示冻结目标节点。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'docRequired' => true, + 'example' => '0', + 'enum' => [ + '0', + '2', + ], + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回数据。', + 'type' => 'object', + 'properties' => [ + 'Success' => [ + 'description' => '返回值。取值如下：'."\n" + .'- true：表示调用成功。'."\n" + .'- false：表示调用失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'RequestId' => [ + 'description' => '请求的ID。用于定位日志，排查问题。', + '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' => '冻结或解冻目标节点', + 'summary' => '调用UpdateNodeRunMode冻结或解冻目标节点。', + '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' => '运行的环境，包括开发环境（DEV）和生产环境（PRD）。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'PROD', + 'enum' => [ + 'PROD', + 'DEV', + ], + ], + ], + [ + 'name' => 'NodeId', + 'in' => 'formData', + 'schema' => [ + 'description' => '节点的ID，您可以调用[ListNodes](~~173979~~)接口获取节点ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + 'example' => '1234', + ], + ], + [ + 'name' => 'UserId', + 'in' => 'formData', + 'schema' => [ + 'description' => '节点负责人的阿里云账号ID。您可以登录DataWorks控制台，鼠标悬停至顶部菜单栏右侧的用户头像，查看账号ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '19337906836551', + 'maxLength' => 64, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回数据。', + 'type' => 'object', + 'properties' => [ + 'Success' => [ + 'description' => '返回值。取值如下：'."\n" + .'- true：表示调用成功。'."\n" + .'- false：表示调用失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'RequestId' => [ + 'description' => '请求的ID。用于定位日志，排查问题。', + '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' => '修改目标节点负责人', + 'summary' => '修改目标节点的负责人。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'UpdateWorkbenchEventResult' => [ + 'summary' => '所属扩展程序的运维中心回调API，当运维中心的流程被扩展程序卡住后,调用UpdateWorkbenchEventResult返回扩展程序的处理结果。', + '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' => '订阅OpenEvent后接收到扩展事件的messageId', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '03400b03-b721-4c34-8727-2****1', + ], + ], + [ + 'name' => 'ExtensionCode', + 'in' => 'query', + 'schema' => [ + 'description' => '扩展程序的编码', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '58e95e2acd6f408e8707f1bf2591f9e9', + ], + ], + [ + 'name' => 'CheckResult', + 'in' => 'query', + 'schema' => [ + 'description' => '回调结果，OK代表检查成功，FAIL代表检查失败', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'FAIL', + 'enum' => [ + 'OK', + 'FAIL', + 'WARN', + ], + ], + ], + [ + 'name' => 'CheckResultTip', + 'in' => 'query', + 'schema' => [ + 'description' => '检查失败的原因', + 'type' => 'string', + 'required' => false, + 'example' => 'SQL is too long', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request', + 'type' => 'string', + 'example' => '0bc1ec92159376****', + ], + 'Success' => [ + 'title' => '成功标识', + 'description' => '成功标识', + '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' => '更新扩展程序的处理结果', + ], + 'ListShiftPersonnels' => [ + 'summary' => '获取值班表的值班人员列表。', + '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' => '值班表唯一标识。', + 'type' => 'string', + 'required' => true, + 'example' => '2ab6456ada634b2f938ee******9b45b', + ], + ], + [ + 'name' => 'UserType', + 'in' => 'formData', + 'schema' => [ + 'description' => '值班人查询条件：ALL（全部值班人）、PRIMARY（主值班人）、BACKUP（备值班人）、DESIGNATED_USER（指定人）', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [], + 'example' => 'ALL', + 'default' => 'ALL', + 'enum' => [ + 'ALL', + 'PRIMARY', + 'BACKUP', + 'DESIGNATED_USER', + ], + ], + ], + [ + 'name' => 'ShiftPersonUID', + 'in' => 'formData', + 'schema' => [ + 'description' => '阿里云账号ID。您可以登录DataWorks控制台，鼠标悬停至顶部菜单栏右侧的用户头像，查看账号ID。', + 'type' => 'string', + 'required' => false, + 'example' => '1933790****551', + ], + ], + [ + 'name' => 'BeginTime', + 'in' => 'formData', + 'schema' => [ + 'description' => '值班人开始时间，时间戳', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + 'example' => '1593950832000', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'formData', + 'schema' => [ + 'description' => '值班人结束时间，时间戳', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + 'example' => '1593950832000', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'API返回结果', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。用于出现错误后排查问题。', + 'type' => 'string', + 'example' => '0000-ABCD-EFG', + ], + 'Paging' => [ + 'description' => '分页结果', + 'type' => 'object', + 'properties' => [ + 'PageNumber' => [ + 'description' => '页码数，用于翻页。最小值为1，最大值为100，默认为1。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '每页显示的条数，默认为10条，最大100条。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'TotalCount' => [ + 'description' => '满足条件的数据总条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '100', + ], + 'ShiftPersons' => [ + 'description' => '值班人列表', + 'type' => 'array', + 'items' => [ + 'description' => '值班人', + 'type' => 'object', + 'properties' => [ + 'ShiftPersonUID' => [ + 'description' => '值班人UID', + 'type' => 'string', + 'example' => '3726346****', + ], + 'ShiftPersonName' => [ + 'description' => '值班人名称', + 'type' => 'string', + 'example' => 'Zhang San', + ], + 'BeginTime' => [ + 'description' => '值班周期开始时间', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1593950832000', + ], + 'EndTime' => [ + 'description' => '值班周期结束时间', + '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' => '获取值班表的值班人员列表', + ], + 'ListShiftSchedules' => [ + 'summary' => '获取运维中心值班表列表。', + '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' => '根据关键字模糊查询', + 'type' => 'string', + 'required' => false, + 'example' => 'Duty table name keyword', + ], + ], + [ + 'name' => 'Owner', + 'in' => 'formData', + 'schema' => [ + 'description' => '阿里云账号ID。您可以登录DataWorks控制台，鼠标悬停至顶部菜单栏右侧的用户头像，查看账号ID。', + 'type' => 'string', + 'required' => false, + 'example' => '1933790683*****', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'formData', + 'schema' => [ + 'description' => '每页显示的条数，默认为10条，最大100条。'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '100', + 'minimum' => '10', + 'example' => '10', + 'default' => '10', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'formData', + 'schema' => [ + 'description' => '页码数，用于翻页。最小值为1，最大值为100，默认为1。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '100', + 'minimum' => '1', + 'example' => '1', + 'default' => '1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'API返回结果。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求的ID。用于定位日志，排查问题。', + 'type' => 'string', + 'example' => 'E6F0DBDD-5AD****', + ], + 'Paging' => [ + 'description' => '分页详情。', + 'type' => 'object', + 'properties' => [ + 'PageNumber' => [ + 'description' => '页码数，用于翻页。最小值为1，最大值为100。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '每页显示的条数', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'TotalCount' => [ + 'description' => '数据量总数', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '100', + ], + 'ShiftSchedules' => [ + 'description' => '值班表列表数据', + 'type' => 'array', + 'items' => [ + 'description' => '值班表', + 'type' => 'object', + 'properties' => [ + 'ShiftScheduleIdentifier' => [ + 'description' => '值班表唯一标识，可用来查询值班表值班人员列表', + 'type' => 'string', + 'example' => '2ab6456ada634b2f938ee******9b45b', + ], + 'ShiftScheduleName' => [ + 'description' => '值班表的名称。', + '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' => '获取运维中心值班表列表', + ], + 'ListInstanceHistory' => [ + 'summary' => '调用ListInstanceHistory，获取所有实例历史记录，任务重跑一次就会生成一条历史记录。', + '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' => '实例的ID。您可以调用ListInstances获取。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + 'example' => '1234', + ], + ], + [ + 'name' => 'ProjectEnv', + 'in' => 'formData', + 'schema' => [ + 'description' => '工作空间的环境，包括PROD（生产环境）和DEV（开发环境），默认获取PROD（生产环境）的实例数据。', + 'type' => 'string', + 'required' => false, + 'example' => 'PROD', + 'default' => 'PROD', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '返回结果', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求的ID。用于定位日志，排查问题。', + 'type' => 'string', + 'example' => 'E6F0DBDD-5AD****', + ], + 'Success' => [ + 'description' => '调用是否成功。取值如下：'."\n" + .'- true：调用成功。'."\n" + .'- false：调用失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Instances' => [ + 'description' => '实例列表', + 'type' => 'array', + 'items' => [ + 'description' => '实例详情', + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => '任务的状态，取值如下：'."\n" + ."\n" + .'- NOT_RUN（未运行）'."\n" + .'- WAIT_TIME（等待定时时间DueTime或CycTime到来）'."\n" + .'- WAIT_RESOURCE（等待资源）'."\n" + .'- RUNNING（运行中）'."\n" + .'- CHECKING（下发给数据质量进行数据校检）'."\n" + .'- CHECKING_CONDITION（正在进行分支条件校检）'."\n" + .'- FAILURE（执行失败）'."\n" + .'- SUCCESS（执行成功）', + 'type' => 'string', + 'example' => 'NOT_RUN', + ], + 'CycTime' => [ + 'description' => '调度任务的运行时间，返回时间戳格式。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1590422400000', + ], + 'BeginRunningTime' => [ + 'description' => '实例开始运行的时间，返回时间戳格式。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1590416703313', + ], + 'FinishTime' => [ + 'description' => '调度任务的结束时间，返回时间戳格式。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1590416703313', + ], + 'ErrorMessage' => [ + 'description' => '实例运行的报错信息。该字段已废弃，您可以调用GetInstanceLog接口获取执行任务的相关报错信息。', + 'type' => 'string', + 'example' => 'error message', + ], + 'CreateTime' => [ + 'description' => '实例的创建时间。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1590416703313', + ], + 'DagId' => [ + 'description' => '工作流的ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '33845', + ], + 'TaskType' => [ + 'description' => '任务实例的调度类型，取值如下：'."\n" + ."\n" + .'- NORMAL(0)：正常调度任务。该任务被日常调度。'."\n" + .'- MANUAL(1)：手动任务。该任务不会被日常调度。'."\n" + .'- PAUSE(2)：冻结任务。该任务被日常调度，但启动调度时直接被置为失败状态。'."\n" + .'- SKIP(3)：空跑任务。该任务被日常调度，但启动调度时直接被置为成功状态。'."\n" + .'- SKIP_UNCHOOSE(4)：临时工作流中未选择的任务，仅存在于临时工作流中，启动调度时直接被置为成功状态。'."\n" + .'- SKIP_CYCLE(5)：未到运行周期的周或月任务。该任务被日常调度，但启动调度时直接被置为成功状态。'."\n" + .'- CONDITION_UNCHOOSE(6)：上游实例中有分支（IF）节点，但是该下游节点未被分支节点选中，直接置为空跑任务。'."\n" + .'- REALTIME_DEPRECATED(7)：实时生成的已经过期的周期实例，该类型的任务直接被置为成功状态。', + 'type' => 'string', + 'example' => 'NORMAL(0)', + ], + 'DagType' => [ + 'description' => 'DQC类型，取值如下：'."\n" + ."\n" + .'- 0表示有关联dqc。'."\n" + .'- 1表示没有关联dqc。', + 'type' => 'string', + 'example' => '1', + ], + 'ModifyTime' => [ + 'description' => '调度任务的最新修改时间。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1590416703313', + ], + 'InstanceId' => [ + 'description' => '实例的ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1234', + ], + 'BeginWaitResTime' => [ + 'description' => '实例任务开始等待资源的时间。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1590416703313', + ], + 'Bizdate' => [ + 'description' => '执行调度任务的日期。通常为该任务运行时间的前一天。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1590336000000', + ], + 'NodeName' => [ + 'description' => '节点的名称。', + 'type' => 'string', + 'example' => 'kzh', + ], + 'BeginWaitTimeTime' => [ + 'description' => '实例任务开始等待调度的时间。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1590416703313', + ], + 'NodeId' => [ + 'description' => '节点的ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '33115', + ], + 'InstanceHistoryId' => [ + 'description' => '实例的历史档案编号。', + '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' => '获取所有实例历史记录', + ], + 'ListInnerNodes' => [ + 'summary' => '调用ListInnerNodes获取内部节点详情，例如查询组合节点、循环节点等节点类型的内部节点，不支持PAI节点的内部节点查询。', + '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' => '文件的代码类型。'."\n" + ."\n" + .'常用的代码及其对应的文件类型包括6（Shell）、10（ODPS SQL）、11（ODPS MR）、23（数据集成）、24（ODPS Script）、97（PAI）、98（组合节点）、99（虚拟节点）、221（PyODPS 2）、225（ODPS Spark）、227（EMR Hive）、228（EMR Spark）、229（EMR Spark SQL）、230（EMR MR）、239（OSS对象检查）、257（EMR Shell）、258（EMR Spark Shell）、259（EMR Presto）、260（EMR Impala）、900（实时同步）、1002（PAI内部节点）、1089（跨租户节点）、1091（Hologres开发）、1093（Hologres SQL）、1100（赋值节点）、1106（遍历节点（foreach））、1221（PyODPS 3），您可以调用ListNodes查看节点类型。', + 'type' => 'string', + 'required' => false, + 'example' => 'ODPS_SQL', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'formData', + 'schema' => [ + 'description' => '页码数。最小值1，最大值100', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '100', + 'minimum' => '1', + 'example' => '1', + 'default' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'formData', + 'schema' => [ + 'description' => '每页显示的条数，默认为10条，最大100条。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '100', + 'minimum' => '10', + 'example' => '10', + 'default' => '10', + ], + ], + [ + 'name' => 'ProjectId', + 'in' => 'formData', + 'schema' => [ + 'description' => '工作空间的ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + 'example' => '1234', + ], + ], + [ + 'name' => 'ProjectEnv', + 'in' => 'formData', + 'schema' => [ + 'description' => '运行的环境，包括DEV和PROD，默认PROD。', + 'type' => 'string', + 'required' => false, + 'example' => 'PROD', + 'default' => 'PROD', + ], + ], + [ + 'name' => 'NodeName', + 'in' => 'formData', + 'schema' => [ + 'description' => '节点名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'liux_test_n****', + ], + ], + [ + 'name' => 'OuterNodeId', + 'in' => 'formData', + 'schema' => [ + 'description' => '内部节点所属的组合节点ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + 'example' => '12345', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '返回结果', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求的ID。用于定位日志，排查问题。', + 'type' => 'string', + 'example' => 'E6F0DBDD-5AD****', + ], + 'Success' => [ + 'description' => '调用是否成功。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Paging' => [ + 'description' => '分页信息', + 'type' => 'object', + 'properties' => [ + 'PageNumber' => [ + 'description' => '页码数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '每页显示的条数，默认为10条，最大100条。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'TotalCount' => [ + 'description' => '符合条件的节点总数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '100', + ], + 'Nodes' => [ + 'description' => '内部节点列表。', + 'type' => 'array', + 'items' => [ + 'description' => '节点详情。', + 'type' => 'object', + 'properties' => [ + 'SchedulerType' => [ + 'description' => '调度的类型，取值如下：'."\n" + ."\n" + .'- NORMAL：正常调度任务。'."\n" + .'- MANUAL：手动任务，不会被日常调度。'."\n" + .'- PAUSE：暂停任务。'."\n" + .'- SKIP：空跑任务，被日常调度，但启动调度时直接被置为成功。', + 'type' => 'string', + 'example' => 'NORMAL', + ], + 'RepeatInterval' => [ + 'description' => '出错后重新调度频率。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '60', + ], + 'Repeatability' => [ + 'description' => '是否可以重复运行。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'ProjectId' => [ + 'description' => '工作空间的ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '123', + ], + 'ProgramType' => [ + 'description' => '节点的类型。', + 'type' => 'string', + 'example' => 'ODPS_SQL', + ], + 'Priority' => [ + 'description' => '优先级，1/3/5/7/8', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'OwnerId' => [ + 'description' => '负责人的ID。', + 'type' => 'string', + 'example' => '1933****36551', + ], + 'Connection' => [ + 'description' => '连接串。', + 'type' => 'string', + 'example' => 'odps_source', + ], + 'ParamValues' => [ + 'description' => '额外的参数。', + 'type' => 'string', + 'example' => 'a=b', + ], + 'DqcType' => [ + 'description' => 'DQC类型，0表示有关联dqc，1表示没有关联dqc。', + 'type' => 'string', + 'example' => '1', + ], + 'BaselineId' => [ + 'description' => '基线ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1234', + ], + 'Description' => [ + 'description' => '节点的描述信息。', + 'type' => 'string', + 'example' => 'test', + ], + 'NodeName' => [ + 'description' => '节点的名称。', + 'type' => 'string', + 'example' => 'liux_test_n****', + ], + 'ResGroupName' => [ + 'description' => '资源组的名称。', + 'type' => 'string', + 'example' => 'Default Resource Group', + ], + 'BusinessId' => [ + 'description' => '业务流程ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '123', + ], + 'DqcDescription' => [ + 'description' => 'DQC分区规则串。', + 'type' => 'string', + 'example' => '[{"projectName":"ztjy_dim","tableName":"dim_user_agent_manage_area_a","partition":"ds\\u003d$[yyyy-mm-dd-1]"}]', + ], + 'CronExpress' => [ + 'description' => 'cron表达式。', + 'type' => 'string', + 'example' => '00 00 00 * * ?', + ], + 'NodeId' => [ + 'description' => '节点的ID。', + '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' => '获取内部节点列表', + ], + 'OfflineNode' => [ + 'summary' => '调用OfflineNode下线节点。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'NodeId', + 'in' => 'formData', + 'schema' => [ + 'description' => '节点的ID。您可以调用[ListNodes](~~173979~~)接口查看NodeId的相关信息。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + 'minimum' => '2', + 'example' => '1234', + ], + ], + [ + 'name' => 'ProjectId', + 'in' => 'formData', + 'schema' => [ + 'description' => 'DataWorks工作空间ID。您可以通过[ListProjects](~~178393~~)接口获取工作空间ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + 'minimum' => '1', + 'example' => '9527', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '返回结果', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求的ID。用于定位日志，排查问题。', + 'type' => 'string', + 'example' => 'E6F0DBDD-5AD****', + ], + 'Success' => [ + 'description' => '调用是否成功。', + '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' => '下线节点', + ], + 'GetBaseline' => [ + 'summary' => '根据基线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' => '基线的ID，可以通过 [ListBaselines](~~2261507~~) 获取。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '123456', + ], + ], + [ + 'name' => 'ProjectId', + 'in' => 'formData', + 'schema' => [ + 'description' => '基线所监控的项目空间ID，可从 [ListBaselines](~~2261507~~) 获取。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '10000', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'OpenApiResultModel<PopBaselineConfigDto>', + 'description' => 'OpenApiResultModel<PopBaselineConfigDto>', + 'type' => 'object', + 'properties' => [ + 'Success' => [ + 'description' => '请求是否成功，true - 成功，false - 失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'ErrorCode' => [ + 'description' => '错误码。', + 'type' => 'string', + 'example' => '1031203110005', + ], + 'ErrorMessage' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'The specified parameters are invalid', + ], + 'HttpStatusCode' => [ + 'description' => 'HTTP返回码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Data' => [ + 'description' => '返回值。', + 'type' => 'object', + 'properties' => [ + 'BaselineId' => [ + 'title' => '基线id', + 'description' => '基线的id。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1001', + ], + 'BaselineName' => [ + 'title' => '基线名', + 'description' => '基线名。', + 'type' => 'string', + 'example' => 'Test baseline', + ], + 'ProjectId' => [ + 'title' => '项目id', + 'description' => '项目id。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10000', + ], + 'Owner' => [ + 'title' => '责任人', + 'description' => '责任人。', + 'type' => 'string', + 'example' => '9527952****', + ], + 'Priority' => [ + 'title' => '优先级', + 'description' => '基线的优先级，取值集合为{1,3,5,7,8}。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'BaselineType' => [ + 'title' => '基线类型 (DAILY, HOURLY)', + 'description' => '基线类型。'."\n" + ."\n" + .'- DAILY - 日基线'."\n" + .'- HOURLY - 小时基线', + 'type' => 'string', + 'example' => 'DAILY', + ], + 'OverTimeSettings' => [ + 'title' => '基线承诺时间设置', + 'description' => '基线承诺时间设置。', + 'type' => 'array', + 'items' => [ + 'description' => '监控周期。', + 'type' => 'object', + 'properties' => [ + 'Cycle' => [ + 'title' => '周期，取值范围 [1,24]', + 'description' => '承诺时间对应的周期，天基线是1，小时基线可以配置最多24个周期。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Time' => [ + 'title' => '承诺时间，hh:mm格式，hh的取值范围为[0,47]，mm的取值范围为[0,59]', + 'description' => '承诺时间，hh:mm格式，hh的取值范围为[0,47]，mm的取值范围为[0,59]。', + 'type' => 'string', + 'example' => '00:00', + ], + ], + ], + ], + 'Enabled' => [ + 'title' => '是否开启基线', + 'description' => '是否开启基线。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'NodeIds' => [ + 'title' => '基线节点列表', + 'description' => '基线上游节点列表。', + 'type' => 'array', + 'items' => [ + 'description' => '节点ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '700003****', + ], + ], + 'AlertEnabled' => [ + 'title' => '是否开启告警', + 'description' => '是否开启告警。'."\n" + ."\n" + .'- true - 是'."\n" + .'- false - 否', + 'type' => 'boolean', + 'example' => 'true', + ], + 'AlertMarginThreshold' => [ + 'title' => '预警余量，单位为分钟', + 'description' => '预警余量，单位为分钟。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '60', + ], + 'AlertSettings' => [ + 'title' => '告警设置', + 'description' => '告警设置。', + 'type' => 'array', + 'items' => [ + 'description' => '基线的告警配置。', + 'type' => 'object', + 'properties' => [ + 'AlertType' => [ + 'title' => '告警类型，BASELINE / TOPIC', + 'description' => '告警类型'."\n" + .'- BASELINE - 基线'."\n" + .'- TOPIC - 事件'."\n", + 'type' => 'string', + 'example' => 'BASELINE', + ], + 'AlertMethods' => [ + 'title' => '告警方式', + 'description' => '告警方式列表', + 'type' => 'array', + 'items' => [ + 'description' => '告警方式。取值如下：'."\n" + .'- MAIL - 邮件'."\n" + .'- SMS - 短信'."\n" + .'- PHONE - 语音 '."\n" + .'- DINGROBOTS - 钉钉机器人'."\n" + .'- WEBHOOKS - Webhook', + 'type' => 'string', + 'example' => 'MAIL', + ], + ], + 'SilenceStartTime' => [ + 'title' => '静默开始时间', + 'description' => '静默开始时间，格式为 HH:mm:ss 。', + 'type' => 'string', + 'example' => '00:00:00', + ], + 'SilenceEndTime' => [ + 'title' => '静默结束时间', + 'description' => '静默结束时间，格式为 HH:mm:ss 。', + 'type' => 'string', + 'example' => '00:00:00', + ], + 'AlertInterval' => [ + 'title' => '事件告警间隔', + 'description' => '事件告警间隔，单位为秒。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '900', + ], + 'AlertMaximum' => [ + 'title' => '事件告警最大次数', + 'description' => '事件告警最大次数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'DingRobots' => [ + 'title' => '钉钉机器人列表', + 'description' => '钉钉机器人列表。', + 'type' => 'array', + 'items' => [ + 'description' => '钉钉机器人配置。', + 'type' => 'object', + 'properties' => [ + 'WebUrl' => [ + 'description' => '钉钉机器人地址。', + 'type' => 'string', + 'example' => 'https://oapi.dingtalk.com/robot/send?access_token=xxx', + ], + 'AtAll' => [ + 'description' => '是否 @所有人。', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + 'Webhooks' => [ + 'title' => 'webhook 列表', + 'description' => 'webhook 列表。', + 'type' => 'array', + 'items' => [ + 'description' => '企业微信或飞书机器人的webhook地址，多个webhook地址之间使用英文逗号（,）分隔。alertMethods 中需要包含 WEBHOOKS 告警方式。仅DataWorks企业版支持。'."\n" + ."\n" + .'可用地域：华东2（上海）、西南1（成都）、华北3（张家口）、华北2（北京）、华东1（杭州）、华南1（深圳）、中国（香港）、欧洲中部 1（法兰克福）、亚太东南1（新加坡）。', + 'type' => 'string', + 'example' => 'https://open.feishu.cn/open-apis/bot/v2/hook/xxx', + ], + ], + 'TopicTypes' => [ + 'title' => '事件告警类型，事件特有配置', + 'description' => '事件告警类型列表，事件特有配置。', + 'type' => 'array', + 'items' => [ + 'description' => '事件告警类型。'."\n" + ."\n" + .'- SLOW - 变慢'."\n" + .'- ERROR - 出错', + 'type' => 'string', + 'example' => 'SLOW', + ], + ], + 'BaselineAlertEnabled' => [ + 'title' => '基线告警开关，基线特有配置', + 'description' => '基线告警开关，基线特有配置。'."\n" + ."\n" + .'- true - 开启'."\n" + .'- false - 关闭', + 'type' => 'boolean', + 'example' => 'false', + ], + 'AlertRecipientType' => [ + 'title' => '告警接收人类型', + 'description' => '告警接收人类型。'."\n" + ."\n" + .'- OWNER - 任务责任人'."\n" + .'- OTHER - 指定的人'."\n" + .'- SHIFT_SCHEDULE - 值班表 ', + 'type' => 'string', + 'example' => 'OWNER', + ], + 'AlertRecipient' => [ + 'title' => '告警接收人详情', + 'description' => '告警接收人详情。'."\n" + ."\n" + .'- AlertRecipientType 为 OWNER：空'."\n" + .'- AlertRecipientType 为 SHIFT_SCHEDULE：值班表uid'."\n" + .'- AlertRecipientType 为 OTHER: uid列表，多个uid使用英文 , 分割', + 'type' => 'string', + 'example' => '123123', + ], + ], + ], + ], + ], + ], + 'RequestId' => [ + 'description' => '请求ID。', + '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' => '获取基线配置', + ], + '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' => '基线的ID，可以通过 [ListBaselines](~~2261507~~) 获取。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1234', + ], + ], + [ + 'name' => 'ProjectId', + 'in' => 'formData', + 'schema' => [ + 'title' => '项目空间ID', + 'description' => '基线所监控的项目空间ID，可从 ListBaselines 获取。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '10000', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'OpenApiResultModel<Boolean>', + 'description' => 'OpenApiResultModel<Boolean>', + 'type' => 'object', + 'properties' => [ + 'Success' => [ + 'description' => '调用是否成功。'."\n" + ."\n" + .'- true：调用成功'."\n" + ."\n" + .'- false：调用失败', + 'type' => 'boolean', + 'example' => 'true', + ], + 'ErrorCode' => [ + 'description' => '错误码。', + 'type' => 'string', + 'example' => '1031203110000', + ], + 'ErrorMessage' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'Baseline deletion failed with nodes dependent on baseline', + ], + 'HttpStatusCode' => [ + 'description' => 'HTTP状态码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Data' => [ + 'description' => '是否成功删除。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'RequestId' => [ + 'description' => '请求的ID。用于定位日志，排查问题。', + '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' => '删除基线配置', + 'summary' => '根据基线ID删除基线配置，只有基线上游没有任何节点的情况下才允许删除。可通过调用UpdateBaseline接口修改基线上游节点。', + ], + 'ListBaselines' => [ + 'summary' => '该接口用于获取基线列表。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'abilityTreeCode' => '158237', + 'abilityTreeNodes' => [ + 'FEATUREdideSFSFU4', + ], + ], + 'parameters' => [ + [ + 'name' => 'Owner', + 'in' => 'formData', + 'schema' => [ + 'title' => '责任人', + 'description' => '责任人', + 'type' => 'string', + 'required' => false, + 'example' => '3726346****', + ], + ], + [ + 'name' => 'ProjectId', + 'in' => 'formData', + 'schema' => [ + 'title' => '项目空间id', + 'description' => 'DataWorks工作空间的ID。您可以登录[DataWorks控制台](https://workbench.data.aliyun.com/console)，进入工作空间配置页面获取工作空间ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '123456', + ], + ], + [ + 'name' => 'Priority', + 'in' => 'formData', + 'schema' => [ + 'description' => '基线的优先级，取值范围为{1,3,5,7,8}。', + 'type' => 'string', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'Enable', + 'in' => 'formData', + 'schema' => [ + 'title' => '是否开启基线', + 'description' => '是否开启基线，包括true（可用）和false（不可用）。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'BaselineTypes', + 'in' => 'formData', + 'schema' => [ + 'title' => '基线类型', + 'description' => '基线的类型，包括DAILY（天基线）和HOURLY（小时基线）。多个类型之间使用英文逗号（,）分隔。', + 'type' => 'string', + 'required' => false, + 'example' => 'DAILY', + ], + ], + [ + 'name' => 'SearchText', + 'in' => 'formData', + 'schema' => [ + 'title' => '基线名模糊查询', + 'description' => '基线名称的搜索关键字。', + 'type' => 'string', + 'required' => false, + 'example' => 'baselineName', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'formData', + 'schema' => [ + 'description' => '分页查询页码。大于等于1的正整数，默认为1，最大为30。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'formData', + 'schema' => [ + 'description' => '每页显示的条数，默认为10条，最大100条。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '100', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'OpenApiResultModel<PopBaselineConfigDto>', + 'description' => 'OpenApiResultModel<PopBaselineConfigDto>', + 'type' => 'object', + 'properties' => [ + 'Success' => [ + 'description' => '调用是否成功。取值如下：'."\n" + .'- true：调用成功。'."\n" + .'- false：调用失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'ErrorCode' => [ + 'description' => '错误码。', + 'type' => 'string', + 'example' => '103630001', + ], + 'ErrorMessage' => [ + 'description' => '调用失败时，返回的错误信息。', + 'type' => 'string', + 'example' => 'The user does not exist. 276571706358178756', + ], + 'HttpStatusCode' => [ + 'description' => 'HTTP返回码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Data' => [ + 'description' => '返回的基线列表。', + 'type' => 'object', + 'properties' => [ + 'PageNumber' => [ + 'description' => '当前的页数。', + 'type' => 'string', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '每页的大小。', + 'type' => 'string', + 'example' => '10', + ], + 'TotalCount' => [ + 'description' => '基线的总数。', + 'type' => 'string', + 'example' => '100', + ], + 'Baselines' => [ + 'description' => '基线列表。', + 'type' => 'array', + 'items' => [ + 'description' => '基线配置。', + 'type' => 'object', + 'properties' => [ + 'BaselineId' => [ + 'description' => '基线的ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1234', + ], + 'ProjectId' => [ + 'description' => '基线所在工作空间的ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '9527', + ], + 'BaselineType' => [ + 'description' => '基线类型，包括DAILY（天基线）和HOURLY（小时基线）。 '."\n", + 'type' => 'string', + 'example' => 'DAILY', + ], + 'Priority' => [ + 'description' => '基线的优先级，取值范围为{1,2,5,7,8}。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Owner' => [ + 'description' => '基线责任人的阿里云UID。有多个责任人时，使用英文逗号（,）分隔。'."\n", + 'type' => 'string', + 'example' => '952795****', + ], + 'BaselineName' => [ + 'description' => '基线的名称。', + 'type' => 'string', + 'example' => 'BaselineName', + ], + 'Enabled' => [ + 'description' => '基线是否开启，包括true（可用）和false（不可用）。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'AlertEnabled' => [ + 'description' => '是否开启告警，包括true（开启）和false（关闭）。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'AlertMarginThreshold' => [ + 'description' => '基线实例的预警阈值，单位为分钟。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '30', + ], + 'OverTimeSettings' => [ + 'description' => '基线承诺时间设置。', + 'type' => 'array', + 'items' => [ + 'description' => '周期配置。', + 'type' => 'object', + 'properties' => [ + 'Cycle' => [ + 'description' => '承诺时间对应的周期，天基线为1，小时基线可以配置最多24个周期。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Time' => [ + 'description' => '承诺时间，hh:mm格式，hh的取值范围为\\[0,47\\]，mm的取值范围为\\[0,59\\]。', + 'type' => 'string', + 'example' => '00:00', + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'RequestId' => [ + 'description' => '本次调用的唯一id。出现错误后，您可以根据该ID排查问题。', + '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' => '获取基线列表', + ], + 'CreateBaseline' => [ + 'summary' => '该接口用于创建基线。', + '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' => '基线名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'BaselineName', + ], + ], + [ + 'name' => 'ProjectId', + 'in' => 'formData', + 'schema' => [ + 'title' => '项目id', + 'description' => 'DataWorks工作空间的ID，您可以登录[DataWorks控制台](https://workbench.data.aliyun.com/console)，进入工作空间管理页面查看ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '10000', + ], + ], + [ + 'name' => 'Owner', + 'in' => 'formData', + 'schema' => [ + 'title' => '责任人', + 'description' => '基线责任人的阿里云uid。', + 'type' => 'string', + 'required' => true, + 'example' => '1000000000001', + ], + ], + [ + 'name' => 'Priority', + 'in' => 'formData', + 'schema' => [ + 'title' => '基线优先级', + 'description' => '基线的优先级，取值范围为{1,3,5,7,8}。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '1,3,5,7,8', + ], + ], + [ + 'name' => 'NodeIds', + 'in' => 'formData', + 'schema' => [ + 'description' => '基线上游节点列表。', + 'type' => 'string', + 'required' => false, + 'example' => '210001233239,210001236482', + ], + ], + [ + 'name' => 'OvertimeSettings', + 'in' => 'formData', + 'style' => 'repeatList', + 'schema' => [ + 'title' => '基线承诺时间', + 'description' => '基线承诺时间配置。', + 'type' => 'array', + 'items' => [ + 'description' => '周期。', + 'type' => 'object', + 'properties' => [ + 'Cycle' => [ + 'title' => '周期，取值范围 [1,24]', + 'description' => '承诺时间对应的周期，天基线需要配置为1，小时基线可以配置最多24个周期。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + 'Time' => [ + 'title' => '承诺时间，hh:mm格式，hh的取值范围为[0,47]，mm的取值范围为[0,59]', + 'description' => '承诺时间，hh:mm格式，hh的取值范围为\\[0,47\\]，mm的取值范围为\\[0,59\\]。', + 'type' => 'string', + 'required' => false, + 'example' => '00:00', + ], + ], + 'required' => false, + ], + 'required' => true, + 'maxItems' => 144, + 'minItems' => 1, + ], + ], + [ + 'name' => 'AlertMarginThreshold', + 'in' => 'formData', + 'schema' => [ + 'title' => '基线预警余量', + 'description' => '基线预警余量，单位为分钟。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '30', + ], + ], + [ + 'name' => 'BaselineType', + 'in' => 'formData', + 'schema' => [ + 'title' => '基线类型 (DAILY, HOURLY)', + 'description' => '基线类型，包括DAILY（天基线）和HOURLY（小时基线）。', + 'type' => 'string', + 'required' => true, + 'example' => 'DAILY', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'OpenApiResultModel<Long>', + 'description' => 'OpenApiResultModel<Long>', + 'type' => 'object', + 'properties' => [ + 'Success' => [ + 'description' => '调用是否成功。取值如下：'."\n" + .'- true：调用成功。'."\n" + .'- false：调用失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'ErrorCode' => [ + 'description' => '错误码。', + 'type' => 'string', + 'example' => '401', + ], + 'ErrorMessage' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'The specified parameters are invalid.', + ], + 'HttpStatusCode' => [ + 'description' => 'HTTP返回码。'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Data' => [ + 'description' => '基线的id。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '100003', + ], + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + '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' => '创建基线', + ], + 'UpdateBaseline' => [ + 'summary' => '该接口用于更新基线。', + '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' => '基线的ID, 可通过 [ListBaselines](~~2261507~~) 获取。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1000010800007', + ], + ], + [ + 'name' => 'ProjectId', + 'in' => 'formData', + 'schema' => [ + 'description' => '项目ID, 可通过 [ListBaselines](~~2261507~~) 获取。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '2043', + ], + ], + [ + 'name' => 'BaselineName', + 'in' => 'formData', + 'schema' => [ + 'title' => '基线名', + 'description' => '基线名。', + 'type' => 'string', + 'required' => false, + 'example' => 'BaselineName', + ], + ], + [ + 'name' => 'Owner', + 'in' => 'formData', + 'schema' => [ + 'title' => '责任人', + 'description' => '基线责任人的阿里云uid。', + 'type' => 'string', + 'required' => false, + 'example' => '3726346****', + ], + ], + [ + 'name' => 'Priority', + 'in' => 'formData', + 'schema' => [ + 'title' => '基线优先级', + 'description' => '基线的优先级，取值范围为{1,3,5,7,8}。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '7', + ], + ], + [ + 'name' => 'NodeIds', + 'in' => 'formData', + 'schema' => [ + 'description' => '基线上游节点列表，使用逗号分割，节点较多的情况下，建议在其下游增加虚节点，便于管理。', + 'type' => 'string', + 'required' => false, + 'example' => '1,2,3', + ], + ], + [ + 'name' => 'OvertimeSettings', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'title' => '基线承诺时间', + 'description' => '基线承诺时间配置。', + 'type' => 'array', + 'items' => [ + 'description' => '周期。', + 'type' => 'object', + 'properties' => [ + 'Cycle' => [ + 'title' => '周期，取值范围 [1,24]', + 'description' => '承诺时间对应的周期，天基线是1，小时基线可以配置最多24个周期。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + 'Time' => [ + 'title' => '承诺时间，hh:mm格式，hh的取值范围为[0,47]，mm的取值范围为[0,59]', + 'description' => '承诺时间，hh:mm格式，hh的取值范围为[0,47]，mm的取值范围为[0,59]。', + 'type' => 'string', + 'required' => false, + 'example' => '00:00', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 144, + ], + ], + [ + 'name' => 'AlertMarginThreshold', + 'in' => 'formData', + 'schema' => [ + 'title' => '基线预警余量', + 'description' => '基线预警余量，单位为分钟。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '30', + ], + ], + [ + 'name' => 'BaselineType', + 'in' => 'formData', + 'schema' => [ + 'title' => '基线类型 (DAILY, HOURLY)', + 'description' => '基线类型，包括DAILY（天基线）和HOURLY（小时基线）。', + 'type' => 'string', + 'required' => false, + 'example' => 'DAILY', + ], + ], + [ + 'name' => 'Enabled', + 'in' => 'formData', + 'schema' => [ + 'title' => '是否开启基线', + 'description' => '基线是否开启，包括true（可用）和false（不可用）。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'AlertEnabled', + 'in' => 'formData', + 'schema' => [ + 'title' => '是否开启告警', + 'description' => '是否开启告警，包括true（开启）和false（关闭）。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'AlertSettings', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'title' => '告警配置', + 'description' => '基线告警配置。', + 'type' => 'array', + 'items' => [ + 'description' => '告警配置。', + 'type' => 'object', + 'properties' => [ + 'AlertType' => [ + 'title' => '告警类型，BASELINE / TOPIC', + 'description' => '告警类型，BASELINE - 基线 / TOPIC - 事件。', + 'type' => 'string', + 'required' => false, + 'example' => 'BASELINE', + ], + 'AlertMethods' => [ + 'title' => '告警方式', + 'description' => 'MAIL（邮件）'."\n" + .'SMS（短信）'."\n" + .'PHONE（电话），仅DataWorks专业版及以上版本支持使用电话方式接收报警。'."\n" + .'DINGROBOTS（钉钉机器人），仅当配置RobotUrls参数后，该报警方式才会生效。'."\n" + .'Webhooks（企业微信或飞书机器人），仅当配置 Webhooks 参数后，该报警方式才会生效。', + 'type' => 'array', + 'items' => [ + 'description' => '报警的方式', + 'type' => 'string', + 'required' => false, + 'example' => 'SMS', + ], + 'required' => false, + ], + 'SilenceStartTime' => [ + 'title' => '静默开始时间', + 'description' => '静默开始时间。', + 'type' => 'string', + 'required' => false, + 'example' => '00:00:00', + ], + 'SilenceEndTime' => [ + 'title' => '静默结束时间', + 'description' => '静默结束时间。', + 'type' => 'string', + 'required' => false, + 'example' => '00:00:00', + ], + 'AlertInterval' => [ + 'title' => '事件告警间隔', + 'description' => '事件告警间隔，单位为分钟，最小为5，最大值为 1440', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '1440', + 'minimum' => '5', + 'example' => '1800', + ], + 'AlertMaximum' => [ + 'title' => '事件告警最大次数', + 'description' => '事件告警最大次数，最大为24。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '288', + 'minimum' => '1', + 'example' => '1', + ], + 'DingRobots' => [ + 'title' => '钉钉机器人列表', + 'description' => '钉钉机器人列表', + 'type' => 'array', + 'items' => [ + 'description' => '钉钉机器人配置。', + 'type' => 'object', + 'properties' => [ + 'WebUrl' => [ + 'description' => '钉钉群机器人的webhook地址。', + 'type' => 'string', + 'required' => false, + 'example' => 'https://oapi.dingtalk.com/robot/send?access_token=xxx ', + ], + 'AtAll' => [ + 'description' => '是否@所有人，包括true（是）和false（否）。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 10, + ], + 'Webhooks' => [ + 'title' => 'webhook 列表', + 'description' => 'webhook 列表。', + 'type' => 'array', + 'items' => [ + 'description' => '企业微信或飞书机器人的webhook地址，多个webhook地址之间使用英文逗号（,）分隔。alertMethods 中需要包含 WEBHOOKS 告警方式。当该参数配置为undefined时，系统会清空WebHook地址。'."\n" + ."\n" + .'仅DataWorks企业版支持。'."\n" + .'可用地域：华东2（上海）、西南1（成都）、华北3（张家口）、华北2（北京）、华东1（杭州）、华南1（深圳）、中国（香港）、欧洲中部 1（法兰克福）、亚太东南1（新加坡）。', + 'type' => 'string', + 'required' => false, + 'example' => 'https://open.feishu.cn/open-apis/bot/v2/hook/xxx ', + ], + 'required' => false, + 'maxItems' => 10, + ], + 'TopicTypes' => [ + 'title' => '事件告警类型，事件特有配置', + 'description' => '事件告警类型，事件特有配置。', + 'type' => 'array', + 'items' => [ + 'description' => '事件的类型，包括SLOW（变慢）和ERROR（出错）。多个事件类型之间使用英文逗号（,）分隔。', + 'type' => 'string', + 'required' => false, + 'example' => 'SLOW', + ], + 'required' => false, + 'maxItems' => 10, + ], + 'BaselineAlertEnabled' => [ + 'title' => '基线告警开关，基线特有配置', + 'description' => '基线告警开关，基线特有配置，包括true（是）和false（否）。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + 'AlertRecipientType' => [ + 'title' => '告警接收人类型', + 'description' => '告警接收人类型，OWNER（任务责任人）/ OTHER（指定的人）/ SHIFT_SCHEDULE（值班表）。', + 'type' => 'string', + 'required' => false, + 'example' => 'OWNER', + ], + 'AlertRecipient' => [ + 'title' => '告警接收人详情', + 'description' => '告警接收人详情，指定人：工号列表，值班表：值班表名，责任人：空。', + 'type' => 'string', + 'required' => false, + 'example' => '123123', + ], + ], + 'required' => false, + ], + 'required' => false, + ], + ], + [ + 'name' => 'RemoveNodeIds', + 'in' => 'formData', + 'schema' => [ + 'description' => '需要从基线上提出的节点ID，多个ID间使用,分隔', + 'type' => 'string', + 'required' => false, + 'example' => '123,456', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'OpenApiResultModel<Boolean>', + 'description' => 'OpenApiResultModel<Boolean>', + 'type' => 'object', + 'properties' => [ + 'Success' => [ + 'description' => '请求是否成功。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'ErrorCode' => [ + 'description' => '错误码。', + 'type' => 'string', + 'example' => '401', + ], + 'ErrorMessage' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'The specified parameters are invalid.', + ], + 'HttpStatusCode' => [ + 'description' => 'HTTP状态码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Data' => [ + 'description' => '基线是否更新成功。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + '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' => '修改基线配置', + ], + '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' => '引擎或者数据源的名称。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'autotest', + ], + ], + [ + 'name' => 'FollowerId', + 'in' => 'formData', + 'schema' => [ + 'description' => '订阅关系的ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + 'example' => '1234', + ], + ], + [ + 'name' => 'Follower', + 'in' => 'formData', + 'schema' => [ + 'description' => '订阅人。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '1912232****', + ], + ], + [ + 'name' => 'AlarmMode', + 'in' => 'formData', + 'schema' => [ + 'description' => '订阅的方式，包括1（邮件）、2（邮件和短信）、4（钉钉群机器人）、5（钉钉群机器人@ALL）、6（飞书）、7（企业微信）、8（WEBHOOK）和9（电话告警）。', + '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' => ' '."\n" + .'DataWorks工作空间的ID。您可以进入DataWorks管理控制台获取。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'docRequired' => true, + 'example' => '123', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回数据结构。', + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => [ + 'description' => 'HTTP返回码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Data' => [ + 'description' => '是否更新成功。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'ErrorMessage' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'You have no permission', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '576b9457-2cf5-4****', + ], + 'ErrorCode' => [ + 'description' => '错误码。', + 'type' => 'string', + 'example' => '401', + ], + 'Success' => [ + 'description' => '调用是否成功。', + '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' => '更新订阅关系', + 'summary' => '调用UpdateQualityFollower更新订阅关系。', + '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' => '校验规则的强弱。强弱表示规则的重要程度。取值如下：'."\n" + .'- 1，表示强规则。'."\n" + .'- 0，表示弱规则。'."\n" + .'您可以根据实际需求设置重要的规则为强规则。如果使用强规则并触发了红色告警，则会阻塞调度任务。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '1', + 'minimum' => '0', + 'enumValueTitles' => [], + 'example' => '0', + 'enum' => [ + '0', + '1', + ], + ], + ], + [ + 'name' => 'EntityId', + 'in' => 'formData', + 'schema' => [ + 'description' => '分区表达式的ID。您可以调用[ListQualityRules](~~173995~~)接口获分区表达式ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '123', + ], + ], + [ + 'name' => 'Comment', + 'in' => 'formData', + 'schema' => [ + 'description' => '校验规则的描述信息。', + 'type' => 'string', + 'required' => false, + 'example' => 'Verify the number of table rows', + 'maxLength' => 512, + ], + ], + [ + 'name' => 'Checker', + 'in' => 'formData', + 'schema' => [ + 'description' => '校验器ID。'."\n" + .'2，表示 7 天平均值波动。'."\n" + .'3，表示 30 天平均值波动。'."\n" + .'4，表示 1 天周期比较。'."\n" + .'5，表示 7 天周期比较。'."\n" + .'6，表示 30 天周期比较。'."\n" + .'7，表示 7 天方差波动。'."\n" + .'8，表示 30 天方差波动。'."\n" + .'9，表示与固定值比较。'."\n" + .'10，表示 1、7、30 天波动检测。'."\n" + .'11，表示上一周期比较。'."\n" + .'您可以调用[ListQualityRules](~~173995~~)接口获取校验器ID。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'docRequired' => false, + 'example' => '9', + ], + ], + [ + 'name' => 'ExpectValue', + 'in' => 'formData', + 'schema' => [ + 'description' => '校验结果的期望值。', + 'type' => 'string', + 'required' => false, + 'example' => '300', + 'maxLength' => 128, + ], + ], + [ + 'name' => 'Id', + 'in' => 'formData', + 'schema' => [ + 'description' => '校验规则的ID。您可以调用[ListQualityRules](~~173995~~)接口获取规则ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + 'example' => '1234', + ], + ], + [ + 'name' => 'Trend', + 'in' => 'formData', + 'schema' => [ + 'description' => '校验结果的趋势。取值如下：'."\n" + .'- up，表示上升趋势。'."\n" + .'- down，表示下降趋势。'."\n" + .'- abs，表示绝对值。', + 'type' => 'string', + 'required' => false, + 'example' => 'up', + ], + ], + [ + 'name' => 'MethodName', + 'in' => 'formData', + 'schema' => [ + 'description' => '采集样本数据方法的名称。包括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、table_count-count_distinct等。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'table_count', + ], + ], + [ + 'name' => 'Operator', + 'in' => 'formData', + 'schema' => [ + 'description' => '比较符。包括>、>=、=、≠、<和<=等。'."\n" + ."\n" + .'> 当Checker=9时，Operator为必选参数。', + 'type' => 'string', + 'required' => false, + 'example' => '>', + 'maxLength' => 128, + ], + ], + [ + 'name' => 'ProjectName', + 'in' => 'formData', + 'schema' => [ + 'description' => '引擎或者数据源的名称。您可以登录[DataWorks控制台](https://workbench.data.aliyun.com/console)，进入工作空间管理页面获取名称。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'autotest', + ], + ], + [ + 'name' => 'Property', + 'in' => 'formData', + 'schema' => [ + 'description' => '字段的名称。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'id', + 'maxLength' => 128, + 'minLength' => 1, + ], + ], + [ + 'name' => 'PropertyType', + 'in' => 'formData', + 'schema' => [ + 'description' => '字段的类型。', + 'type' => 'string', + 'required' => false, + 'example' => 'bigint', + 'maxLength' => 128, + ], + ], + [ + 'name' => 'RuleType', + 'in' => 'formData', + 'schema' => [ + 'description' => '规则的类型：'."\n" + .'- 0：系统模板规则'."\n" + .'- 1：自定义SQL规则'."\n" + .'- 4：自定义模板规则', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '99', + 'minimum' => '0', + 'example' => '0', + ], + ], + [ + 'name' => 'WhereCondition', + 'in' => 'formData', + 'schema' => [ + 'description' => '校验任务使用的过滤条件或自定义SQL语句。', + 'type' => 'string', + 'required' => false, + 'example' => 'dt=$[yyyymmdd]', + ], + ], + [ + 'name' => 'CriticalThreshold', + 'in' => 'formData', + 'schema' => [ + 'description' => '红色告警阈值。表示与样本预期的偏离程度。您可以根据业务需求自定义该阈值。使用强规则并触发红色阈值，会阻塞调度任务。', + 'type' => 'string', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'WarningThreshold', + 'in' => 'formData', + 'schema' => [ + 'description' => '橙色告警阈值。表示与样本预期的偏离程度，您可以根据业务需求自定义该阈值。', + 'type' => 'string', + 'required' => false, + 'example' => '5', + ], + ], + [ + 'name' => 'TemplateId', + 'in' => 'formData', + 'schema' => [ + 'description' => '使用的校验模板的ID。您可以调用[ListQualityRules](~~173995~~)接口获取校验模板的ID。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '7', + ], + ], + [ + 'name' => 'RuleName', + 'in' => 'formData', + 'schema' => [ + 'description' => '校验规则的名称。', + 'type' => 'string', + 'required' => false, + 'example' => '123', + 'maxLength' => 255, + 'minLength' => 1, + ], + ], + [ + 'name' => 'PredictType', + 'in' => 'formData', + 'schema' => [ + 'description' => '是否为动态阈值。取值如下：'."\n" + .'- 0，表示非动态阈值。'."\n" + .'- 2，表示动态阈值。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '99', + 'minimum' => '0', + 'example' => '0', + ], + ], + [ + 'name' => 'OpenSwitch', + 'in' => 'formData', + 'schema' => [ + 'description' => '规则的启用或停用状态，用于控制质量规则是否在生产环境中运行。'."\n" + ."\n" + .'- true：在数据质量规则关联产出表数据的调度任务执行时，便会触发质量规则校验。'."\n" + ."\n" + .'- false：在数据质量规则关联产出表数据的调度任务执行时，不会触发质量规则校验。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + 'default' => 'true', + ], + ], + [ + 'name' => 'ProjectId', + 'in' => 'formData', + 'schema' => [ + 'description' => 'DataWorks项目空间ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + 'example' => '26', + ], + ], + [ + 'name' => 'TaskSetting', + 'in' => 'formData', + 'schema' => [ + 'description' => '在自定义规则之前插入的变量设置，格式如：x=a,y=b', + 'type' => 'string', + 'required' => false, + 'example' => 'x=a,y=b', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回数据结构。', + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => [ + 'description' => 'HTTP返回码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Data' => [ + 'description' => '校验规则是否更新成功。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'ErrorMessage' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'You have no permission.', + ], + 'RequestId' => [ + 'description' => '请求ID。用于出现错误后排查问题。', + 'type' => 'string', + 'example' => '576b9457-2cf5-4****', + ], + 'ErrorCode' => [ + 'description' => '错误码。', + 'type' => 'string', + 'example' => '0', + ], + 'Success' => [ + 'description' => '调用是否成功。', + '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' => '更新规则', + 'summary' => '调用UpdateQualityRule更新校验规则的信息。', + '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' => '校验规则的ID。您可以调用[ListQualityRules](~~173995~~)接口查看RuleId的相关信息。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + 'maximum' => '2147483647', + 'minimum' => '1', + 'example' => '1234', + ], + ], + [ + 'name' => 'ProjectName', + 'in' => 'formData', + 'schema' => [ + 'description' => '引擎或者数据源的名称。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'autotest', + ], + ], + [ + 'name' => 'ProjectId', + 'in' => 'formData', + 'schema' => [ + 'description' => 'DataWorks项目空间ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'docRequired' => true, + 'example' => '12345', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回数据结构。', + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => [ + 'description' => 'HTTP状态码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '576b9457-2cf5-4****', + ], + 'ErrorMessage' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'You have no permission.', + ], + 'ErrorCode' => [ + 'description' => '错误码。', + 'type' => 'string', + 'example' => '401', + ], + 'Success' => [ + 'description' => '调用是否成功。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Data' => [ + 'description' => '获取的规则信息。', + 'type' => 'object', + 'properties' => [ + 'BlockType' => [ + 'description' => '校验规则的强弱。强弱表示规则的重要程度。取值如下：'."\n" + .'- 1，表示强规则。'."\n" + .'- 0，表示弱规则。'."\n" + .'您可以根据实际需求设置重要的规则为强规则。如果使用强规则并触发了红色告警，则会阻塞调度任务。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'OnDutyAccountName' => [ + 'description' => '配置校验规则的阿里云账号名称。', + 'type' => 'string', + 'example' => 'test', + ], + 'WarningThreshold' => [ + 'description' => '橙色告警阈值。表示与样本预期的偏离程度，您可以根据业务需求自定义该阈值。', + 'type' => 'string', + 'example' => '10', + ], + 'Property' => [ + 'description' => '规则属性的字段，即被校验数据源表的column名称。', + 'type' => 'string', + 'example' => 'id', + ], + 'RuleType' => [ + 'description' => '规则的类型：'."\n" + .'- 0：系统模板规则'."\n" + .'- 1：自定义SQL规则'."\n" + .'- 4：自定义模板规则', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'Comment' => [ + 'description' => '校验规则的描述信息。', + 'type' => 'string', + 'example' => 'Verify that the primary key is unique', + ], + 'OnDuty' => [ + 'description' => '配置校验规则的账号ID。', + 'type' => 'string', + 'example' => '1822931****', + ], + 'Checker' => [ + 'description' => '校验器ID。该字段对应前端的ID标识，需要由pkId转换。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '9', + ], + 'FixCheck' => [ + 'description' => '固定值校验。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'MethodId' => [ + 'description' => '采集样本数据方法的ID。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '8', + ], + 'CriticalThreshold' => [ + 'description' => '红色告警阈值。表示与样本预期的偏离程度。您可以根据业务需求自定义该阈值。使用强规则并触发红色阈值，会阻塞调度任务。', + 'type' => 'string', + 'example' => '20', + ], + 'PredictType' => [ + 'description' => '是否为动态阈值：'."\n" + .'- 0表示非动态阈值。'."\n" + .'- 1表示动态阈值规则。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'TemplateName' => [ + 'description' => '使用的校验模板的名称。', + 'type' => 'string', + 'example' => 'SQL task table rows, 1,7, 30 days fluctuation test', + ], + 'CheckerName' => [ + 'description' => '校验器的名称。', + 'type' => 'string', + 'example' => 'compared with a fixed value', + ], + 'RuleName' => [ + 'description' => '规则的名称。', + 'type' => 'string', + 'example' => 'View table fluctuations', + ], + 'MethodName' => [ + 'description' => '采集样本数据方法的名称。包括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、table_count-count_distinct等。', + 'type' => 'string', + 'example' => 'table_count', + ], + 'EntityId' => [ + 'description' => '分区表达式的ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '165523', + ], + 'WhereCondition' => [ + 'description' => '校验任务使用的过滤条件或自定义SQL语句。', + 'type' => 'string', + 'example' => 'id>10', + ], + 'Operator' => [ + 'description' => '操作符。', + 'type' => 'string', + 'example' => '>=', + ], + 'ExpectValue' => [ + 'description' => '期望值。', + 'type' => 'string', + 'example' => '30', + ], + 'Trend' => [ + 'description' => '校验结果的趋势。', + 'type' => 'string', + 'example' => 'abs', + ], + 'TemplateId' => [ + 'description' => '使用的校验模板的ID。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '7', + ], + 'Id' => [ + 'description' => '规则的ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '123232', + ], + 'OpenSwitch' => [ + 'description' => '规则是否开启', + 'type' => 'boolean', + 'example' => 'true', + ], + 'TaskSetting' => [ + 'description' => '在自定义规则之前插入的变量设置，格式如：x=a,y=b', + '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>10</WhereCondition>\\n <Operator>>=</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' => '获取规则的信息', + 'summary' => '调用GetQualityRule获取校验规则的信息。', + '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' => '引擎或者数据源的名称。您可以从数据源配置中获取名称。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'autotest', + ], + ], + [ + 'name' => 'EntityId', + 'in' => 'formData', + 'schema' => [ + 'description' => '分区表达式的ID。您可以调用[GetQualityEntity](~~174003~~)获取分区表达式ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + 'example' => '12345', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'formData', + 'schema' => [ + 'description' => '页码数。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'docRequired' => true, + 'minimum' => '1', + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'formData', + 'schema' => [ + 'description' => '每页显示的条数，默认为10条，最大为20条。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'docRequired' => true, + 'maximum' => '20', + 'minimum' => '1', + 'example' => '20', + ], + ], + [ + 'name' => 'ProjectId', + 'in' => 'formData', + 'schema' => [ + 'description' => 'DataWorks项目空间ID', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + 'example' => '12345', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回数据结构。', + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => [ + 'description' => 'HTTP返回码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'RequestId' => [ + 'description' => '请求ID，用于后续错误排查使用。', + 'type' => 'string', + 'example' => '38cbdef0-f6cf-49****', + ], + 'ErrorMessage' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'You have no permission.', + ], + 'Success' => [ + 'description' => '调用是否成功，取值如下：'."\n" + .'- true：调用成功。'."\n" + .'- false：调用失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'ErrorCode' => [ + 'description' => '错误码。', + 'type' => 'string', + 'example' => 'Invalid.Tenant.ConnectionNotExists', + ], + 'Data' => [ + 'description' => '获取的规则列表。', + 'type' => 'object', + 'properties' => [ + 'PageNumber' => [ + 'description' => '页码数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '每页显示的条数，默认为10条，最大为100条。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + 'TotalCount' => [ + 'description' => '返回数据总量。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '400', + ], + 'Rules' => [ + 'description' => '校验规则的详情。', + 'type' => 'array', + 'items' => [ + 'description' => '返回数据结构。', + 'type' => 'object', + 'properties' => [ + 'BlockType' => [ + 'description' => '校验规则的强弱。强弱表示规则的重要程度。取值如下：'."\n" + .'- 1，表示强规则。'."\n" + .'- 0，表示弱规则。'."\n" + .'您可以根据实际需求设置重要的规则为强规则。如果使用强规则并触发了红色告警，则会阻塞调度任务。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'OnDutyAccountName' => [ + 'description' => '配置校验规则的阿里云账号名称。', + 'type' => 'string', + 'example' => 'test', + ], + 'Property' => [ + 'description' => '字段的名称。', + 'type' => 'string', + 'example' => 'id', + ], + 'WarningThreshold' => [ + 'description' => '橙色告警阈值。表示与样本预期的偏离程度，您可以根据业务需求自定义该阈值。', + 'type' => 'string', + 'example' => '10', + ], + 'TableName' => [ + 'description' => '表的名称。', + 'type' => 'string', + 'example' => 'dual', + ], + 'OnDuty' => [ + 'description' => '配置校验规则的账号ID。', + 'type' => 'string', + 'example' => '1912****', + ], + 'Comment' => [ + 'description' => '规则的描述信息。', + 'type' => 'string', + 'example' => 'Verify table rules', + ], + 'RuleCheckerRelationId' => [ + 'description' => '规则详情的内部关联ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '132323', + ], + 'FixCheck' => [ + 'description' => '固定值校验。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'MethodId' => [ + 'description' => '采集样本数据方法的ID。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '21', + ], + 'TemplateName' => [ + 'description' => '使用的校验模板的名称。', + 'type' => 'string', + 'example' => 'Number of SQL task table rows, 1, 7, and 30 days wave detection', + ], + 'Trend' => [ + 'description' => '校验结果的趋势。', + 'type' => 'string', + 'example' => 'abs', + ], + 'HistoryWarningThreshold' => [ + 'description' => '历史橙色告警阈值。', + 'type' => 'string', + 'example' => 'history max:40%,history min:10%', + ], + 'RuleType' => [ + 'description' => '规则的类型：'."\n" + .'- 0：系统模板规则'."\n" + .'- 1：自定义SQL规则'."\n" + .'- 4：自定义模板规则', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'MatchExpression' => [ + 'description' => '分区表达式。', + 'type' => 'string', + 'example' => 'dt=$[yyyymmdd]', + ], + 'ProjectName' => [ + 'description' => '引擎或者数据源的名称。', + 'type' => 'string', + 'example' => 'autotest', + ], + 'PropertyKey' => [ + 'description' => '用于数据质量前端规则联动，可以忽略。', + 'type' => 'string', + 'example' => 'table_count', + ], + 'CriticalThreshold' => [ + 'description' => '红色告警阈值。表示与样本预期的偏离程度。您可以根据业务需求自定义该阈值。使用强规则并触发红色阈值，会阻塞调度任务。', + 'type' => 'string', + 'example' => '40', + ], + 'HistoryCriticalThreshold' => [ + 'description' => '历史红色告警阈值。', + 'type' => 'string', + 'example' => 'history max:80%,history min:50%', + ], + 'MethodName' => [ + 'description' => '采集样本数据方法的名称。包括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、table_count-count_distinct等。', + 'type' => 'string', + 'example' => 'count/table_count', + ], + 'CheckerId' => [ + 'description' => '校验器ID。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '7', + ], + 'EntityId' => [ + 'description' => '分区表达式的ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1234', + ], + 'ExpectValue' => [ + 'description' => '期望值。', + 'type' => 'string', + 'example' => '1000', + ], + 'TemplateId' => [ + 'description' => '使用的校验模板的ID。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '7', + ], + 'Id' => [ + 'description' => '规则的ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1234', + ], + 'RuleName' => [ + 'title' => '规则名称', + 'description' => '规则名称。', + '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' => '根据分区表达式获取规则列表', + 'summary' => '调用ListQualityRules根据分区表达式获取校验规则列表。', + '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' => '规则的强弱：'."\n" + ."\n" + .'- 0表示弱规则'."\n" + .'- 1表示强规则。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'docRequired' => true, + 'maximum' => '1', + 'minimum' => '0', + 'example' => '0', + ], + ], + [ + 'name' => 'EntityId', + 'in' => 'formData', + 'schema' => [ + 'description' => '分区表达式的ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + 'maximum' => '2147483647', + 'minimum' => '1', + 'example' => '15224', + ], + ], + [ + 'name' => 'Comment', + 'in' => 'formData', + 'schema' => [ + 'description' => '规则的描述信息。', + 'type' => 'string', + 'required' => false, + 'example' => 'Verification', + 'maxLength' => 128, + 'minLength' => 1, + ], + ], + [ + 'name' => 'Checker', + 'in' => 'formData', + 'schema' => [ + 'description' => '校验器的ID，取值如下：'."\n" + ."\n" + .'- 2，表示7天平均值波动。'."\n" + .'- 3，表示30天平均值波动。'."\n" + .'- 4，表示1天周期比较。'."\n" + .'- 5，表示7天周期比较。'."\n" + .'- 6，表示30天周期比较。'."\n" + .'- 7，表示7天方差波动。'."\n" + .'- 8，表示30天方差波动。'."\n" + .'- 9，表示与固定值比较。'."\n" + .'- 10，表示1、7、30天波动检测。'."\n" + .'- 11，表示上一周期比较。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'docRequired' => true, + 'minimum' => '1', + 'example' => '9', + ], + ], + [ + 'name' => 'ExpectValue', + 'in' => 'formData', + 'schema' => [ + 'description' => '期望值。', + 'type' => 'string', + 'required' => false, + 'example' => '0', + ], + ], + [ + 'name' => 'Trend', + 'in' => 'formData', + 'schema' => [ + 'description' => '校验结果的趋势。取值如下：'."\n" + .'- up，表示上升趋势。'."\n" + .'- down，表示下降趋势。'."\n" + .'- abs，表示绝对值。', + 'type' => 'string', + 'required' => false, + 'example' => 'abs', + ], + ], + [ + 'name' => 'MethodName', + 'in' => 'formData', + 'schema' => [ + 'description' => '采样方。如果是自定义SQL，该参数的值为user_defined。', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => 'count/table_count', + ], + ], + [ + 'name' => 'Operator', + 'in' => 'formData', + 'schema' => [ + 'description' => '比较符。包括>、>=、=、≠、<和<=等。'."\n" + ."\n" + .'> 当Checker=9时，Operator为必选参数。', + 'type' => 'string', + 'required' => false, + 'example' => '>', + ], + ], + [ + 'name' => 'ProjectName', + 'in' => 'formData', + 'schema' => [ + 'description' => '引擎或者数据源的名称。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'autotest', + ], + ], + [ + 'name' => 'Property', + 'in' => 'formData', + 'schema' => [ + 'description' => '规则的字段。如果是表级别校验，行数为table_count、大小为table_size字段。', + 'type' => 'string', + 'required' => false, + 'example' => 'table_id', + 'maxLength' => 128, + ], + ], + [ + 'name' => 'PropertyType', + 'in' => 'formData', + 'schema' => [ + 'description' => '字段的类型，表级table，字段级填写bigint等。', + 'type' => 'string', + 'required' => false, + 'example' => 'bigint', + ], + ], + [ + 'name' => 'RuleType', + 'in' => 'formData', + 'schema' => [ + 'description' => '规则的类型：'."\n" + .'- 0：系统模板规则'."\n" + .'- 1：自定义SQL规则'."\n" + .'- 4：自定义模板规则', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'docRequired' => true, + 'maximum' => '99', + 'minimum' => '0', + 'example' => '0', + ], + ], + [ + 'name' => 'WhereCondition', + 'in' => 'formData', + 'schema' => [ + 'description' => '过滤条件或自定义SQL。', + 'type' => 'string', + 'required' => false, + 'example' => 'table_id>1', + ], + ], + [ + 'name' => 'CriticalThreshold', + 'in' => 'formData', + 'schema' => [ + 'description' => '红色告警阈值。表示与样本预期的偏离程度。您可以根据业务需求自定义该阈值。使用强规则并触发红色阈值，会阻塞调度任务。', + 'type' => 'string', + 'required' => false, + 'example' => '20', + ], + ], + [ + 'name' => 'WarningThreshold', + 'in' => 'formData', + 'schema' => [ + 'description' => '橙色告警阈值。表示与样本预期的偏离程度，您可以根据业务需求自定义该阈值。', + 'type' => 'string', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'TemplateId', + 'in' => 'formData', + 'schema' => [ + 'description' => '模板的ID。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'minimum' => '1', + 'example' => '7', + ], + ], + [ + 'name' => 'RuleName', + 'in' => 'formData', + 'schema' => [ + 'description' => '规则的名称。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '1234', + 'maxLength' => 128, + ], + ], + [ + 'name' => 'PredictType', + 'in' => 'formData', + 'schema' => [ + 'description' => '是否为动态阈值：0表示非动态阈值、2表示动态阈值规则。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'docRequired' => true, + 'maximum' => '99', + 'minimum' => '0', + 'example' => '0', + ], + ], + [ + 'name' => 'ProjectId', + 'in' => 'formData', + 'schema' => [ + 'description' => 'DataWorks工作空间的ID。您可以登录[DataWorks控制台](https://workbench.data.aliyun.com/console)，进入工作空间配置页面获取工作空间ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + 'example' => '10000', + ], + ], + [ + 'name' => 'TaskSetting', + 'in' => 'formData', + 'schema' => [ + 'description' => '在自定义规则之前插入的变量设置，格式如：x=a,y=b。', + 'type' => 'string', + 'required' => false, + 'example' => 'x=a,y=b', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回参数。', + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => [ + 'description' => 'HTTP返回码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Data' => [ + 'description' => '新建的规则ID。', + 'type' => 'string', + 'example' => '12345', + ], + 'ErrorMessage' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'You have no permission.', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'ecb967ec-c137-48****', + ], + 'ErrorCode' => [ + 'description' => '错误码。', + 'type' => 'string', + 'example' => '401', + ], + 'Success' => [ + 'description' => '调用是否成功。', + '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' => '创建质量监控规则', + 'summary' => '调用CreateQualityRule创建质量监控规则。', + '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' => '分区表达式所在的引擎或者数据源的名称。您可以登录[DataWorks控制台](https://workbench.data.aliyun.com/console)，进入数据质量的规则配置页面获取名称。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'autotest', + ], + ], + [ + 'name' => 'FollowerId', + 'in' => 'formData', + 'schema' => [ + 'description' => '分区表达式的订阅关系ID。您可以调用[GetQualityFollower](~~174000~~)接口获取订阅关系ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + 'example' => '1234', + ], + ], + [ + 'name' => 'ProjectId', + 'in' => 'formData', + 'schema' => [ + 'description' => 'DataWorks工作空间的ID。您可以登录DataWorks控制台，进入工作空间配置页面获取工作空间ID。'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '10000', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => [ + 'description' => 'HTTP状态码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Data' => [ + 'description' => '是否成功删除分区表达式的订阅用户，取值如下：'."\n" + .'- true，删除成功。'."\n" + .'- false，删除失败，您可以通过报错信息查询原因，处理问题。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'ErrorMessage' => [ + 'description' => '删除分区表达式订阅用户失败后的报错信息。', + 'type' => 'string', + 'example' => 'You have no permission.', + ], + 'RequestId' => [ + 'description' => '请求ID，用于后续错误排查使用。', + 'type' => 'string', + 'example' => '6d739ef6-098a-47****', + ], + 'ErrorCode' => [ + 'description' => '错误码。', + 'type' => 'string', + 'example' => '401', + ], + 'Success' => [ + 'description' => '调用是否成功。取值如下：'."\n" + .'- true：调用成功。'."\n" + .'- false：调用失败。', + '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' => '删除分区表达式的订阅人', + 'summary' => '调用DeleteQualityFollower删除分区表达式的订阅人。', + 'description' => '数据质量是通过分区表达式来确定需要配置的监控规则。通过该规则帮助您第一时间感知源端数据的变更与ETL（Extract Transformation Load）中产生的脏数据，自动拦截问题任务，有效阻断脏数据向下游蔓延。避免任务产出不符合预期的问题数据，影响正常使用和业务决策。您可以通过订阅管理，为分区表达式添加订阅用户，添加后，当该分区表达式的监控规则被触发，则相应用户会收到消息通知，方便您及时发现并处理问题。详情请参见[配置监控规则](~~73690~~)。', + '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' => '引擎或者数据源的名称。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'autotest', + ], + ], + [ + 'name' => 'RuleId', + 'in' => 'formData', + 'schema' => [ + 'description' => '规则ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + 'example' => '1234', + ], + ], + [ + 'name' => 'ProjectId', + 'in' => 'formData', + 'schema' => [ + 'description' => 'DataWorks工作空间的ID。您可以登录DataWorks控制台，进入工作空间配置页面获取工作空间ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + 'example' => '10000', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回数据结构。', + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => [ + 'description' => 'HTTP返回码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Data' => [ + 'description' => '删除是否成功。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'ErrorMessage' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'You have no permission.', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '6d739ef6-098a-47****', + ], + 'ErrorCode' => [ + 'description' => '错误码。', + 'type' => 'string', + 'example' => '401', + ], + 'Success' => [ + 'description' => '调用是否成功。', + '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' => '删除规则', + 'summary' => '调用DeleteQualityRule删除规则。', + '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' => '引擎或者数据源的名称。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'autotest', + ], + ], + [ + 'name' => 'EntityId', + 'in' => 'formData', + 'schema' => [ + 'description' => '分区表达式的ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + 'example' => '12345', + ], + ], + [ + 'name' => 'ProjectId', + 'in' => 'formData', + 'schema' => [ + 'description' => 'DataWorks工作空间的ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + 'example' => '27', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回数据结构。', + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => [ + 'description' => 'HTTP返回码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '38cbdef0-f6cf-49', + ], + 'ErrorMessage' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'You have no permission.', + ], + 'Success' => [ + 'description' => '调用是否成功。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'ErrorCode' => [ + 'description' => '错误码。', + 'type' => 'string', + 'example' => 'Invalid.Tenant.ConnectionNotExists', + ], + 'Data' => [ + 'description' => '订阅关系的信息。', + 'type' => 'array', + 'items' => [ + 'description' => '返回数据结构。', + 'type' => 'object', + 'properties' => [ + 'FollowerAccountName' => [ + 'description' => '订阅人的阿里云账号名称。', + 'type' => 'string', + 'example' => 'test', + ], + 'TableName' => [ + 'description' => '分区表的名称。', + 'type' => 'string', + 'example' => 'dual', + ], + 'AlarmMode' => [ + 'description' => '告警的模式，取值如下：'."\n" + .'- 1（邮件）'."\n" + .'- 2（邮件和短信）'."\n" + .'- 4（钉钉群机器人或hook）'."\n" + .'- 5（钉钉群机器人@ALL）', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'EntityId' => [ + 'description' => '分区表达式的ID。', + 'type' => 'string', + 'example' => '1234', + ], + 'ProjectName' => [ + 'description' => '引擎或者数据源的名称。', + 'type' => 'string', + 'example' => 'autotest', + ], + 'Id' => [ + 'description' => '订阅关系的ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '123', + ], + 'Follower' => [ + 'description' => '订阅人，用于接收告警信息。', + 'type' => 'string', + 'example' => '1234', + ], + 'CreateTime' => [ + 'description' => '数据质量规则订阅配置的创建时间。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1541576644000', + ], + 'ModifyTime' => [ + 'description' => '数据质量规则订阅配置的更新时间。', + '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' => '获取分区表达式的订阅人', + 'summary' => '调用GetQualityFollower获取分区表达式的订阅人。', + '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' => '引擎或者数据源的名称。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'autotest', + ], + ], + [ + 'name' => 'Follower', + 'in' => 'formData', + 'schema' => [ + 'description' => '订阅人的账号ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '123', + ], + ], + [ + 'name' => 'AlarmMode', + 'in' => 'formData', + 'schema' => [ + 'description' => '订阅的方式，包括1（邮件）、2（邮件和短信）、4（钉钉群机器人）、5（钉钉群机器人@ALL）、6（飞书）、7（企业微信）、8（WEBHOOK）和9（电话告警）。', + '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' => '分区表达式的ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + 'example' => '12345', + ], + ], + [ + 'name' => 'ProjectId', + 'in' => 'formData', + 'schema' => [ + 'description' => 'DataWorks工作空间的ID。您可以进入DataWorks管理控制台获取。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + 'example' => '123', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回数据结构。', + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => [ + 'description' => 'HTTP错误码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Data' => [ + 'description' => '新创建的订阅关系ID。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '12345', + ], + 'ErrorMessage' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'You have no permission.', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'ecb967ec-c137-48****', + ], + 'ErrorCode' => [ + 'description' => '错误码。', + 'type' => 'string', + 'example' => '401', + ], + 'Success' => [ + 'description' => '调用是否成功。', + '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' => '创建分区表达式的订阅人', + 'summary' => '调用CreateQualityFollower创建分区表达式的订阅人。', + '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' => '分区表达式的ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + 'maximum' => '2147483647', + 'minimum' => '1', + 'example' => '1234', + ], + ], + [ + 'name' => 'ProjectName', + 'in' => 'formData', + 'schema' => [ + 'description' => '引擎或者数据源的名称。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'autotest', + ], + ], + [ + 'name' => 'EnvType', + 'in' => 'formData', + 'schema' => [ + 'description' => '引擎或者数据源的类型。支持EMR、Hologres、AnalyticDB for PostgreSQL、CDH、MaxCompute、Kafka和DataHub数据源。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'odps', + 'enum' => [ + 'odps', + 'emr', + 'hadoop', + 'cdh', + 'hybriddb_for_postgresql', + 'holodb', + ], + ], + ], + [ + 'name' => 'ProjectId', + 'in' => 'formData', + 'schema' => [ + 'description' => 'DataWorks项目空间ID', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + 'example' => '12345', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回数据结构。', + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => [ + 'description' => 'HTTP错误码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Data' => [ + 'description' => '调用DeleteQualityEntity接口后，返回的结果详情。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'ErrorMessage' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'You have no permission.', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'ecb967ec-c137-48****', + ], + 'Success' => [ + 'description' => '调用是否成功。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'ErrorCode' => [ + 'description' => '错误码。', + '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' => '删除分区表达式', + 'summary' => '调用DeleteQualityEntity删除分区表达式。', + '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' => '引擎或数据源的名称。您可以从数据源配置中获取名称。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'autotest', + 'maxLength' => 1024, + 'minLength' => 1, + ], + ], + [ + 'name' => 'TableName', + 'in' => 'formData', + 'schema' => [ + 'description' => '分区表名称。您可以调用[GetMetaTablePartition](~~173923~~)查看分区表名称。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'dual', + 'maxLength' => 128, + 'minLength' => 1, + ], + ], + [ + 'name' => 'EnvType', + 'in' => 'formData', + 'schema' => [ + 'description' => '引擎或数据源的类型。'."\n" + .'取值范围：'."\n" + .'- cdh'."\n" + .'- analyticdb_for_mysql'."\n" + .'- odps'."\n" + .'- emr'."\n" + .'- hadoop'."\n" + .'- holodb'."\n" + .'- hybriddb_for_postgresql', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'enumValueTitles' => [], + 'example' => 'odps', + 'maxLength' => 64, + 'minLength' => 1, + ], + ], + [ + 'name' => 'MatchExpression', + 'in' => 'formData', + 'schema' => [ + 'description' => '分区表达式。', + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => 'dt=$[yyyymmdd]', + 'maxLength' => 128, + 'minLength' => 1, + ], + ], + [ + 'name' => 'ProjectId', + 'in' => 'formData', + 'schema' => [ + 'description' => 'DataWorks工作空间的ID。您可以登录[DataWorks控制台](https://workbench.data.aliyun.com/console)，进入工作空间配置页面获取工作空间ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + 'example' => '123456', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => [ + 'description' => 'HTTP状态码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '6d739ef6-098a-47****', + ], + 'ErrorMessage' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'You have no permission.', + ], + 'ErrorCode' => [ + 'description' => '错误码。', + 'type' => 'string', + 'example' => '401', + ], + 'Success' => [ + 'description' => '调用是否成功。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Data' => [ + 'description' => '返回信息。', + 'type' => 'array', + 'items' => [ + 'description' => '返回数据详情。', + 'type' => 'object', + 'properties' => [ + 'RelativeNode' => [ + 'description' => '分区表达式关联的调度节点信息，包括：'."\n" + .'- ProjectName：调度节点所在的项目名称。'."\n" + .'- NodeID：调度节点的节点ID。'."\n", + 'type' => 'string', + 'example' => '[{"projectName":"xc_DP****","nodeId":7000026****}]', + ], + 'OnDutyAccountName' => [ + 'description' => '责任人的阿里云账号名称。', + 'type' => 'string', + 'example' => 'test', + ], + 'Task' => [ + 'description' => '任务节点。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'TableName' => [ + 'description' => '分区表名称。', + 'type' => 'string', + 'example' => 'test_dqc_de****', + ], + 'Followers' => [ + 'description' => '订阅人，接收告警信息的阿里云账号ID。', + 'type' => 'string', + 'example' => '1822931****', + ], + 'OnDuty' => [ + 'description' => '责任人，指配置分区表达式的账号ID。', + 'type' => 'string', + 'example' => '1822931****', + ], + 'MatchExpression' => [ + 'description' => '分区表达式。', + 'type' => 'string', + 'example' => 'dt=$[yyyymmdd-1]', + ], + 'CreateTime' => [ + 'description' => '创建分区表达式的时间。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1593964800000', + ], + 'ProjectName' => [ + 'description' => '引擎或数据源的名称。', + 'type' => 'string', + 'example' => 'autotest', + ], + 'HasRelativeNode' => [ + 'description' => '是否关联调度，取值如下：'."\n" + .'- true：已关联调度。'."\n" + .'- false：未关联调度。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'EnvType' => [ + 'description' => '引擎或者数据源的类型。', + 'type' => 'string', + 'example' => 'odps', + ], + 'EntityLevel' => [ + 'description' => '分区表达式的级别，取值如下：'."\n" + .'- 0（SQL级别）：指每段SQL语句执行完毕后都会触发DQC执行校验。'."\n" + .'- 1（任务级别）：指所有SQL语句均执行完毕后，统一进行校验。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'ModifyUser' => [ + 'description' => '更新人，指更新分区表达式的账号ID。', + 'type' => 'string', + 'example' => '1822931****', + ], + 'Sql' => [ + 'description' => 'SQL级别的分区表达式。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'Id' => [ + 'description' => '分区表达式ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '4003918', + ], + 'ModifyTime' => [ + 'description' => '更新分区表达式的时间。', + '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' => '获取分区表达式', + 'summary' => '调用GetQualityEntity获取分区表达式。', + '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' => '引擎的项目名称或者数据源的名称。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'autotest', + ], + ], + [ + 'name' => 'TableName', + 'in' => 'formData', + 'schema' => [ + 'description' => '表的名称。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'dual', + 'maxLength' => 128, + 'minLength' => 1, + ], + ], + [ + 'name' => 'EnvType', + 'in' => 'formData', + 'schema' => [ + 'description' => '引擎或者数据源的类型。', + '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' => '分区表达式。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'dt=$[yyyymmdd]', + 'maxLength' => 128, + 'minLength' => 1, + ], + ], + [ + 'name' => 'EntityLevel', + 'in' => 'formData', + 'schema' => [ + 'description' => '已废弃。'."\n" + ."\n" + .'包括0（SQL完成时校检）。', + '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' => 'DataWorks工作空间的ID。您可以进入DataWorks管理控制台获取。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + 'example' => '123', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '分区表达式返回数据结构。', + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => [ + 'description' => 'HTTP请求错误码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Data' => [ + 'description' => '新创建的分区表达式ID。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '12345', + ], + 'ErrorMessage' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'Your project is not relative with your account.', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '011e1231u3****', + ], + 'Success' => [ + 'description' => '调用是否成功。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'ErrorCode' => [ + 'description' => '错误码。', + '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' => '创建数据质量的分区表达式', + 'summary' => '调用CreateQualityEntity创建数据质量的分区表达式。', + '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' => '引擎或者数据源的类型。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ODPS', + 'maxLength' => 40, + 'minLength' => 1, + ], + ], + [ + 'name' => 'MatchExpression', + 'in' => 'formData', + 'schema' => [ + 'description' => '分区表达式。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'dt=$[yyyymmdd]', + 'maxLength' => 80, + 'minLength' => 1, + ], + ], + [ + 'name' => 'NodeId', + 'in' => 'formData', + 'schema' => [ + 'description' => '调度节点ID，您可以调用[ListNodes](~~173979~~)接口获取节点ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + 'example' => '12321', + ], + ], + [ + 'name' => 'ProjectId', + 'in' => 'formData', + 'schema' => [ + 'description' => '工作空间的ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + 'example' => '123', + ], + ], + [ + 'name' => 'TargetNodeProjectName', + 'in' => 'formData', + 'schema' => [ + 'description' => '关联调度的节点项目。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'autotest', + 'maxLength' => 128, + 'minLength' => 1, + ], + ], + [ + 'name' => 'ProjectName', + 'in' => 'formData', + 'schema' => [ + 'description' => '引擎或者数据源的名称。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'autotest', + 'maxLength' => 128, + 'minLength' => 1, + ], + ], + [ + 'name' => 'TableName', + 'in' => 'formData', + 'schema' => [ + 'description' => '表的名称。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'dual', + 'maxLength' => 128, + 'minLength' => 1, + ], + ], + [ + 'name' => 'TargetNodeProjectId', + 'in' => 'formData', + 'schema' => [ + 'description' => '节点所在的项目空间ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + 'example' => '1234', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'XXX返回数据结构。', + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => [ + 'description' => 'HTTP错误码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Data' => [ + 'description' => '是否关联成功。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'ErrorMessage' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'You have no permission.', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'ecb967ec-c137-48****', + ], + 'Success' => [ + 'description' => '调用是否成功。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'ErrorCode' => [ + 'description' => '错误码。', + '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' => '创建分区表达式关联', + 'summary' => '调用CreateQualityRelativeNode创建分区表达式关联。', + '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' => '引擎或者数据源的类型。'."\n" + .'枚举值：'."\n" + .'- cdh'."\n" + .'- analyticdb_for_mysql'."\n" + .'- odps'."\n" + .'- emr'."\n" + .'- hadoop'."\n" + .'- holodb'."\n" + .'- hybriddb_for_postgresql', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ODPS', + 'maxLength' => 40, + 'minLength' => 1, + ], + ], + [ + 'name' => 'MatchExpression', + 'in' => 'formData', + 'schema' => [ + 'description' => '分区表达式。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'dt=$[yyyymmdd]', + 'maxLength' => 80, + 'minLength' => 1, + ], + ], + [ + 'name' => 'NodeId', + 'in' => 'formData', + 'schema' => [ + 'description' => '节点ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + 'example' => '156234', + ], + ], + [ + 'name' => 'ProjectId', + 'in' => 'formData', + 'schema' => [ + 'description' => '工作空间的ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + 'example' => '12345', + ], + ], + [ + 'name' => 'TargetNodeProjectName', + 'in' => 'formData', + 'schema' => [ + 'description' => '关联调度节点的项目。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'autotest', + 'maxLength' => 512, + 'minLength' => 1, + ], + ], + [ + 'name' => 'ProjectName', + 'in' => 'formData', + 'schema' => [ + 'description' => '引擎或者数据源的名称。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'autotest', + ], + ], + [ + 'name' => 'TableName', + 'in' => 'formData', + 'schema' => [ + 'description' => '表的名称。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'dual', + 'maxLength' => 128, + 'minLength' => 1, + ], + ], + [ + 'name' => 'TargetNodeProjectId', + 'in' => 'formData', + 'schema' => [ + 'description' => '关联调度节点的项目ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + 'example' => '12345', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '关联调度返回数据结构。', + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => [ + 'description' => 'HTTP错误码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Data' => [ + 'description' => '删除是否成功。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'ErrorMessage' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'You have no permission.', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '6d739ef6-098a-47****', + ], + 'Success' => [ + 'description' => '调用是否成功。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'ErrorCode' => [ + 'description' => '错误码。', + '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' => '删除调度关联', + 'summary' => '调用DeleteQualityRelativeNode删除调度关联。', + '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' => '分区表达式ID。您可以调用[GetQualityEntity](~~174003~~)获取分区表达式ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + 'maximum' => '2147483647', + 'minimum' => '1', + 'example' => '15232', + ], + ], + [ + 'name' => 'StartDate', + 'in' => 'formData', + 'schema' => [ + 'description' => '业务日期起始时间，格式为yyyy-MM-dd HH:mm:ss。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '2020-09-20 00:00:00', + ], + ], + [ + 'name' => 'EndDate', + 'in' => 'formData', + 'schema' => [ + 'description' => '业务日期截止时间，格式为yyyy-MM-dd HH:mm:ss。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '2020-09-21 00:00:00', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'formData', + 'schema' => [ + 'description' => '每页显示的条数，默认为10条，最大20条。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'docRequired' => true, + 'maximum' => '20', + 'minimum' => '1', + 'example' => '10', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'formData', + 'schema' => [ + 'description' => '页码数。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'docRequired' => true, + 'maximum' => '2147483647', + 'minimum' => '1', + 'example' => '1', + ], + ], + [ + 'name' => 'ProjectName', + 'in' => 'formData', + 'schema' => [ + 'description' => '引擎或者数据源的名称。您可以从数据源配置中获取名称。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'autotest', + ], + ], + [ + 'name' => 'ProjectId', + 'in' => 'formData', + 'schema' => [ + 'description' => 'DataWorks项目空间ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + 'example' => '12345', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '校验结果', + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => [ + 'description' => 'HTTP状态码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'ErrorMessage' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'You have no permission.', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'CBA58543-00D4-41****', + ], + 'Success' => [ + 'description' => '请求是否成功。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'ErrorCode' => [ + 'description' => '错误码。', + 'type' => 'string', + 'example' => '401', + ], + 'Data' => [ + 'description' => '校验结果的顶层结构体。', + 'type' => 'object', + 'properties' => [ + 'PageNumber' => [ + 'description' => '页码数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '每页显示的条数，默认为10条，最大100条。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'TotalCount' => [ + 'description' => '数据的总记录数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '50', + ], + 'RuleChecks' => [ + 'description' => '校验结果的列表。', + 'type' => 'array', + 'items' => [ + 'description' => '校验结果', + 'type' => 'object', + 'properties' => [ + 'BlockType' => [ + 'description' => '校验规则的强弱。强弱表示规则的重要程度。取值如下：'."\n" + .'- 1，表示强规则。'."\n" + .'- 0，表示弱规则。'."\n" + .'您可以根据实际需求设置重要的规则为强规则。如果使用强规则并触发了红色告警，则会阻塞调度任务。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'WarningThreshold' => [ + 'description' => '橙色阈值。表示与样本预期的偏离程度，您可以根据业务需求自定义该阈值。', + 'type' => 'number', + 'format' => 'float', + 'example' => '0.1', + ], + 'Property' => [ + 'description' => '规则属性的字段，即被校验数据源表的column名称。', + 'type' => 'string', + 'example' => 'type', + ], + 'TableName' => [ + 'description' => '进行校验的表名称。', + 'type' => 'string', + 'example' => 'dual', + ], + 'Comment' => [ + 'description' => '校验规则的描述。', + 'type' => 'string', + 'example' => 'The description of the rule.', + ], + 'CheckResultStatus' => [ + 'description' => '校验结果状态参数与产品界面中的状态信息一致，取值有以下几种：'."\n" + .'- 0：正常'."\n" + .'- 1：橙色告警'."\n" + .'- 2：红色告警', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'TemplateName' => [ + 'description' => '使用的校验模板的名称。', + 'type' => 'string', + 'example' => 'Expected value verification', + ], + 'CheckerName' => [ + 'description' => '校验器的名称。', + 'type' => 'string', + 'example' => 'fulx', + ], + 'RuleId' => [ + 'description' => '规则ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '123123232', + ], + 'FixedCheck' => [ + 'description' => '是否为固定值校验。取值如下：'."\n" + .'- true：是固定值校验。'."\n" + .'- false：非固定值校验。', + 'type' => 'boolean', + 'example' => 'false', + ], + 'Op' => [ + 'description' => '比较符。', + 'type' => 'string', + 'example' => '>', + ], + 'UpperValue' => [ + 'description' => '预测上限。设置阈值后自动生成。', + 'type' => 'number', + 'format' => 'float', + 'example' => '25555', + ], + 'ActualExpression' => [ + 'description' => '被校验的数据源表的实际分区。', + 'type' => 'string', + 'example' => 'ds=20200912', + ], + 'ExternalId' => [ + 'description' => '调度任务的节点ID。', + 'type' => 'string', + 'example' => '1112323123', + ], + 'TimeCost' => [ + 'description' => '执行校验任务花费的时间，单位为秒。', + 'type' => 'string', + 'example' => '202', + ], + 'Trend' => [ + 'description' => '校验结果的趋势。', + 'type' => 'string', + 'example' => 'abs', + ], + 'ExternalType' => [ + 'description' => '调度系统的类型。目前仅支持CWF。', + 'type' => 'string', + 'example' => 'CWF2', + ], + 'BizDate' => [ + 'description' => '业务日期。如果被校验的业务主体为离线数据，则业务日期通常为执行校验操作的前一天。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1600704000000', + ], + 'CheckResult' => [ + 'description' => '校验结果参数的结果通常与CheckResultStatus一致，取值有以下几种：'."\n" + .'- 0：正常'."\n" + .'- 1：橙色告警'."\n" + .'- 2：红色告警', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'ResultString' => [ + 'description' => '校验结果的字符串形式。', + 'type' => 'string', + 'example' => 'test', + ], + 'MatchExpression' => [ + 'description' => '分区表达式。', + 'type' => 'string', + 'example' => 'ds=$[yyyymmdd]', + ], + 'CheckerType' => [ + 'description' => '校验类型。取值如下：'."\n" + .'- 0，固定值'."\n" + .'- 1，波动校验'."\n" + .'- 2，动态阈值', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'ProjectName' => [ + 'description' => '需要进行数据质量校验的引擎或者数据源名称。', + 'type' => 'string', + 'example' => 'autotest', + ], + 'BeginTime' => [ + 'description' => '执行校验操作的开始时间。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1600704000000', + ], + 'DateType' => [ + 'description' => '调度周期的类型。通常为YMD，即年任务、月任务、天任务。', + 'type' => 'string', + 'example' => 'YMD', + ], + 'CriticalThreshold' => [ + 'description' => '红色阈值。表示与样本预期的偏离程度。您可以根据业务需求自定义该阈值。使用强规则并触发红色阈值，会阻塞调度任务。', + 'type' => 'number', + 'format' => 'float', + 'example' => '0.5', + ], + 'IsPrediction' => [ + 'description' => '是否为预测的结果。取值如下：'."\n" + .'- true：是预测的结果。'."\n" + .'- false：不是预测的结果。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'RuleName' => [ + 'description' => '规则的名称。', + 'type' => 'string', + 'example' => 'The name of the rule.', + ], + 'CheckerId' => [ + 'description' => '校验器的ID。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '7', + ], + 'DiscreteCheck' => [ + 'description' => '是否为离散校验。取值如下：'."\n" + .'- true：是离散校验。'."\n" + .'- false：非离散校验。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'EndTime' => [ + 'description' => '查询校验结果的截止时间。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1600704000000', + ], + 'MethodName' => [ + 'description' => '采集样本数据的方法。包括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、table_count-count_distinct等。', + 'type' => 'string', + 'example' => 'count_distinct', + ], + 'LowerValue' => [ + 'description' => '预测结果的下限。根据您设置的阈值自动生成。', + 'type' => 'number', + 'format' => 'float', + 'example' => '2344', + ], + 'EntityId' => [ + 'description' => '分区表达式ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '15432322', + ], + 'WhereCondition' => [ + 'description' => '校验任务使用的规则过滤条件。', + 'type' => 'string', + 'example' => 'id>0', + ], + 'ExpectValue' => [ + 'description' => '期望值。', + 'type' => 'number', + 'format' => 'float', + 'example' => '200', + ], + 'TemplateId' => [ + 'description' => '使用的校验模板的ID。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '5', + ], + 'TaskId' => [ + 'description' => '校验任务的ID。', + 'type' => 'string', + 'example' => '16008552981681a0d6****', + ], + 'Id' => [ + 'description' => '主键ID。'."\n" + ."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '121212121', + ], + 'ReferenceValue' => [ + 'description' => '历史样本值。', + 'type' => 'array', + 'items' => [ + 'description' => '校验结果', + 'type' => 'object', + 'properties' => [ + 'DiscreteProperty' => [ + 'description' => '通过group by分组后的样本字段取值。例如group by性别字段，则DiscreteProperty为男生、女生和null。', + 'type' => 'string', + 'example' => '0', + ], + 'Value' => [ + 'description' => '校验值。', + 'type' => 'number', + 'format' => 'float', + 'example' => '19', + ], + 'BizDate' => [ + 'description' => '业务日期。如果被校验的业务主体为离线数据，则业务日期通常为执行校验操作的前一天。', + 'type' => 'string', + 'example' => '2020-12-03', + ], + 'SingleCheckResult' => [ + 'description' => '校验结果。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'Threshold' => [ + 'description' => '阈值。', + 'type' => 'number', + 'format' => 'float', + 'example' => '0.5', + ], + ], + ], + ], + 'SampleValue' => [ + 'description' => '当前使用的样本。', + 'type' => 'array', + 'items' => [ + 'description' => '校验结果', + 'type' => 'object', + 'properties' => [ + 'DiscreteProperty' => [ + 'description' => '通过group by分组后的样本字段取值。例如group by性别字段，则DiscreteProperty为男生、女生和null。', + 'type' => 'string', + 'example' => '0', + ], + 'BizDate' => [ + 'description' => '业务日期。如果被校验的业务主体为离线数据，则业务日期通常为执行校验操作的前一天。', + 'type' => 'string', + 'example' => '2020-12-03', + ], + 'Value' => [ + 'description' => '当前样本值。', + '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>></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>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' => '根据分区表达式查询校验历史结果', + 'summary' => '调用ListQualityResultsByEntity，根据分区表达式查询历史校验结果。', + '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' => '使用的校验规则ID。您可以使用该规则ID与分区表达式等信息进行联合查询。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + 'maximum' => '2147483647', + 'minimum' => '1', + 'example' => '152322134', + ], + ], + [ + 'name' => 'StartDate', + 'in' => 'formData', + 'schema' => [ + 'description' => '业务日期起始时间，格式为yyyy-MM-dd HH:mm:ss。'."\n" + ."\n" + .'该参数与EndDate配合使用，二者所取的时间区间不能大于7天。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '2020-09-20 00:00:00', + ], + ], + [ + 'name' => 'EndDate', + 'in' => 'formData', + 'schema' => [ + 'description' => '业务日期截止时间，格式为yyyy-MM-dd HH:mm:ss。'."\n" + ."\n" + .'该参数与StartDate配合使用，二者所取的时间区间不能大于7天。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '2020-09-22 00:00:00', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'formData', + 'schema' => [ + 'description' => '每页显示的条数，默认为10条，最大20条。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'docRequired' => true, + 'maximum' => '20', + 'minimum' => '1', + 'example' => '10', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'formData', + 'schema' => [ + 'description' => '页码数。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'docRequired' => true, + 'maximum' => '2147483647', + 'minimum' => '1', + 'example' => '1', + ], + ], + [ + 'name' => 'ProjectName', + 'in' => 'formData', + 'schema' => [ + 'description' => '需要进行数据质量校验的引擎或者数据源名称。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'autotest', + ], + ], + [ + 'name' => 'ProjectId', + 'in' => 'formData', + 'schema' => [ + 'description' => 'DataWorks项目空间ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + 'example' => '123456', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '校验结果', + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => [ + 'description' => 'HTTP状态码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'ErrorMessage' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'You have no permission.', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'CBA58543-00D4-41****', + ], + 'ErrorCode' => [ + 'description' => '错误码。', + 'type' => 'string', + 'example' => '401', + ], + 'Success' => [ + 'description' => '请求是否成功。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Data' => [ + 'description' => '校验结果的顶层结构体。', + 'type' => 'object', + 'properties' => [ + 'PageNumber' => [ + 'description' => '页码数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '每页显示的条数，默认为10条，最大100条。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'TotalCount' => [ + 'description' => '数据的总记录数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '200', + ], + 'RuleChecks' => [ + 'description' => '校验结果的列表。', + 'type' => 'array', + 'items' => [ + 'description' => '校验结果', + 'type' => 'object', + 'properties' => [ + 'BlockType' => [ + 'description' => '校验规则的强弱。强弱表示规则的重要程度。取值如下：'."\n" + .'- 1，表示强规则。'."\n" + .'- 0，表示弱规则。'."\n" + .'您可以根据实际需求设置重要的规则为强规则。如果使用强规则并触发了红色告警，则会阻塞调度任务。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'WarningThreshold' => [ + 'description' => '橙色阈值。表示与样本预期的偏离程度，您可以根据业务需求自定义该阈值。', + 'type' => 'number', + 'format' => 'float', + 'example' => '0.1', + ], + 'Property' => [ + 'description' => '规则属性的字段，即被校验数据源表的column名称。', + 'type' => 'string', + 'example' => 'type', + ], + 'TableName' => [ + 'description' => '进行校验的表名称。', + 'type' => 'string', + 'example' => 'dual', + ], + 'Comment' => [ + 'description' => '校验规则的描述。', + 'type' => 'string', + 'example' => 'The description of the rule.', + ], + 'CheckResultStatus' => [ + 'description' => '校验结果状态。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'TemplateName' => [ + 'description' => '使用的校验模板的名称。', + 'type' => 'string', + 'example' => 'Expected value verification', + ], + 'CheckerName' => [ + 'description' => '校验器的名称。', + 'type' => 'string', + 'example' => 'fulx', + ], + 'RuleId' => [ + 'description' => '规则ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '123421', + ], + 'FixedCheck' => [ + 'description' => '是否为固定值校验。取值如下：'."\n" + .'- true：是固定值校验。'."\n" + .'- false：非固定值校验。', + 'type' => 'boolean', + 'example' => 'false', + ], + 'Op' => [ + 'description' => '比较符。', + 'type' => 'string', + 'example' => '>', + ], + 'UpperValue' => [ + 'description' => '预测上限。设置阈值后自动生成。', + 'type' => 'number', + 'format' => 'float', + 'example' => '22200', + ], + 'ActualExpression' => [ + 'description' => '被校验的数据源表的实际分区。', + 'type' => 'string', + 'example' => 'ds=20200925', + ], + 'ExternalId' => [ + 'description' => '调度任务的节点ID。', + 'type' => 'string', + 'example' => '123112232', + ], + 'TimeCost' => [ + 'description' => '执行校验任务花费的时间。', + 'type' => 'string', + 'example' => '10', + ], + 'Trend' => [ + 'description' => '校验结果的趋势。', + 'type' => 'string', + 'example' => 'up', + ], + 'ExternalType' => [ + 'description' => '调度系统的类型。目前仅支持CWF。', + 'type' => 'string', + 'example' => 'CWF2', + ], + 'BizDate' => [ + 'description' => '业务日期。如果被校验的业务主体为离线数据，则业务日期通常为执行校验操作的前一天。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1600704000000', + ], + 'CheckResult' => [ + 'description' => '校验结果。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'ResultString' => [ + 'description' => '校验结果的字符串形式。', + 'type' => 'string', + 'example' => 'ResultString', + ], + 'MatchExpression' => [ + 'description' => '分区表达式。', + 'type' => 'string', + 'example' => 'ds=$[yyyymmdd]', + ], + 'CheckerType' => [ + 'description' => '校验器的类型。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'ProjectName' => [ + 'description' => '需要进行数据质量校验的引擎或者数据源名称。', + 'type' => 'string', + 'example' => 'autotest', + ], + 'BeginTime' => [ + 'description' => '执行校验操作的开始时间。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1600704000000', + ], + 'DateType' => [ + 'description' => '调度周期的类型。通常为YMD，即年任务、月任务、天任务。', + 'type' => 'string', + 'example' => 'YMD', + ], + 'CriticalThreshold' => [ + 'description' => '红色阈值。表示与样本预期的偏离程度。您可以根据业务需求自定义该阈值。使用强规则并触发红色阈值，会阻塞调度任务。', + 'type' => 'number', + 'format' => 'float', + 'example' => '0.6', + ], + 'IsPrediction' => [ + 'description' => '是否为预测的结果。取值如下：'."\n" + .'- true：是预测的结果。'."\n" + .'- false：不是预测的结果。', + 'type' => 'boolean', + 'example' => 'false', + ], + 'RuleName' => [ + 'description' => '规则的名称。', + 'type' => 'string', + 'example' => 'The name of the rule.', + ], + 'CheckerId' => [ + 'description' => '校验器的ID。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '7', + ], + 'DiscreteCheck' => [ + 'description' => '是否为离散校验。取值如下：'."\n" + .'- true：是离散校验。'."\n" + .'- false：非离散校验。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'EndTime' => [ + 'description' => '查询校验结果的截止时间。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1600704000000', + ], + 'MethodName' => [ + 'description' => '采集样本数据的方法。包括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、table_count-count_distinct等。', + 'type' => 'string', + 'example' => 'max', + ], + 'LowerValue' => [ + 'description' => '预测下限。根据您设置的阈值自动生成。', + 'type' => 'number', + 'format' => 'float', + 'example' => '2344', + ], + 'EntityId' => [ + 'description' => '分区表达式ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '14534343', + ], + 'WhereCondition' => [ + 'description' => '校验任务使用的过滤条件。', + 'type' => 'string', + 'example' => 'type!=\'type2\'', + ], + 'ExpectValue' => [ + 'description' => '期望值。', + 'type' => 'number', + 'format' => 'float', + 'example' => '90', + ], + 'TemplateId' => [ + 'description' => '使用的校验模板的ID。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '5', + ], + 'TaskId' => [ + 'description' => '校验任务的ID。', + 'type' => 'string', + 'example' => '16008552981681a0d6****', + ], + 'Id' => [ + 'description' => '主键ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2231123', + ], + 'ReferenceValue' => [ + 'description' => '历史样本值。', + 'type' => 'array', + 'items' => [ + 'description' => '校验结果', + 'type' => 'object', + 'properties' => [ + 'DiscreteProperty' => [ + 'description' => '通过group by分组后的样本字段取值。例如group by性别字段，则DiscreteProperty为男生、女生和null。', + 'type' => 'string', + 'example' => 'type1', + ], + 'Value' => [ + 'description' => '样本值。', + 'type' => 'number', + 'format' => 'float', + 'example' => '20', + ], + 'BizDate' => [ + 'description' => '业务日期。如果被校验的业务主体为离线数据，则业务日期通常为执行校验操作的前一天。', + 'type' => 'string', + 'example' => '1600704000000', + ], + 'SingleCheckResult' => [ + 'description' => '校验结果的字符串。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'Threshold' => [ + 'description' => '阈值。', + 'type' => 'number', + 'format' => 'float', + 'example' => '0.2', + ], + ], + ], + ], + 'SampleValue' => [ + 'description' => '当前使用的样本。', + 'type' => 'array', + 'items' => [ + 'description' => '校验结果', + 'type' => 'object', + 'properties' => [ + 'DiscreteProperty' => [ + 'description' => '通过group by分组后的样本字段取值。例如group by性别字段，则DiscreteProperty为男生、女生和null。', + 'type' => 'string', + 'example' => 'type2', + ], + 'BizDate' => [ + 'description' => '业务日期。如果被校验的业务主体为离线数据，则业务日期通常为执行校验操作的前一天。', + 'type' => 'string', + 'example' => '1600704000000', + ], + 'Value' => [ + 'description' => '样本值。', + 'type' => 'number', + 'format' => 'float', + 'example' => '23', + ], + ], + ], + ], + 'Open' => [ + 'description' => '规则是否开启。', + '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>&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' => '校验数据源质量', + 'summary' => '根据校验规则校验数据源的质量，并查询校验结果。', + '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' => '租户ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'docRequired' => false, + 'example' => '10001', + ], + ], + [ + 'name' => 'ProjectId', + 'in' => 'formData', + 'schema' => [ + 'description' => '工作空间的ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + 'example' => '10000', + ], + ], + [ + 'name' => 'ApiName', + 'in' => 'formData', + 'schema' => [ + 'description' => 'API的名称，支持汉字、英文、数字和下划线（_），且只能以英文和汉字开头，4~50个字符。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'Test API name'."\n", + ], + ], + [ + 'name' => 'GroupId', + 'in' => 'formData', + 'schema' => [ + 'description' => '业务流程的ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'Business process ID', + ], + ], + [ + 'name' => 'ApiMode', + 'in' => 'formData', + 'schema' => [ + 'description' => 'API的类型，可选枚举值包括0（向导API）、1（脚本API）和2（注册API）。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'docRequired' => true, + 'example' => '0', + ], + ], + [ + 'name' => 'RequestMethod', + 'in' => 'formData', + 'schema' => [ + 'description' => 'API的请求方式，可选枚举值包括0（GET）、1（POST）、2（PUT）和3（DELETE）。向导和脚本API支持GET和POST。注册API支持GET、POST、PUT和DELETE。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'docRequired' => true, + 'example' => '0', + ], + ], + [ + 'name' => 'ResponseContentType', + 'in' => 'formData', + 'schema' => [ + 'description' => 'API的返回数据类型，可选枚举值包括0（JSON）和1（XML）。向导和脚本API支持JSON，注册API支持JSON和XML。'."\n" + ."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'docRequired' => true, + 'example' => '0', + ], + ], + [ + 'name' => 'Timeout', + 'in' => 'formData', + 'schema' => [ + 'description' => '超时时间，单位为毫秒（ms），取值范围为(0, 30000]。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'docRequired' => true, + 'example' => '10000', + ], + ], + [ + 'name' => 'VisibleRange', + 'in' => 'formData', + 'schema' => [ + 'description' => '可见范围，可选枚举值包括0（工作空间）和1（私有）。'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'docRequired' => true, + 'example' => '0', + ], + ], + [ + 'name' => 'Protocols', + 'in' => 'formData', + 'schema' => [ + 'description' => 'API的协议，可选枚举值包括0（HTTP）和1（HTTPS）。支持多个值，多个值之间使用英文逗号（,）分隔。'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '0,1', + ], + ], + [ + 'name' => 'WizardDetails', + 'in' => 'formData', + 'schema' => [ + 'description' => '向导API的详情，请参见[GetDataServiceApi](~~174013~~)接口wizardDetails字段的JSON String。'."\n" + ."\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' => '脚本API的详情，请参见[GetDataServiceApi](~~174013~~)接口scriptDetails字段的JSON String。', + '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' => '注册API的详情，请参见[GetDataServiceApi](~~174013~~)接口registrationDetails字段的JSON String。', + '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' => 'API的路径，支持英文、数字、下划线（_）和连字符（-），且只能以斜线（/）开头，不能超过200个字符。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '/test/1', + ], + ], + [ + 'name' => 'ApiDescription', + 'in' => 'formData', + 'schema' => [ + 'description' => 'API的描述信息。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'Test API description', + ], + ], + [ + 'name' => 'FolderId', + 'in' => 'formData', + 'schema' => [ + 'description' => '创建API的目标文件夹ID，业务流程下根文件夹ID等于0，用户自建文件夹ID大于0。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'maximum' => '9223372036854775807', + 'minimum' => '0', + 'example' => '0', + ], + ], + [ + 'name' => 'SqlMode', + 'in' => 'formData', + 'schema' => [ + 'description' => '- 0-基础模式。'."\n" + ."\n" + .'- 1-mybatis'."\n" + ."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '0', + ], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'formData', + 'schema' => [ + 'description' => '独享资源组ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '3242432423', + ], + ], + [ + 'name' => 'RequestContentType', + 'in' => 'formData', + 'schema' => [ + 'description' => '请求数据类型。'."\n" + ."\n" + .'- 0：xml'."\n" + ."\n" + .'- 1：json'."\n" + ."\n" + .'- 2：form', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'enumValueTitles' => [], + 'example' => '0', + 'enum' => [ + '0', + '1', + '2', + ], + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => [ + 'description' => 'HTTP状态码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Data' => [ + 'description' => '创建的API ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '100003', + ], + 'ErrorMessage' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'The connection does not exist.', + ], + 'RequestId' => [ + 'description' => '请求ID，一次请求的唯一标识。'."\n", + '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 \\"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' => '创建数据服务API', + 'summary' => '调用CreateDataServiceApi创建数据服务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' => '租户ID。您可登录[DataWorks控制台](https://workbench.data.aliyun.com/console)，进入数据开发（DataStudio）页面，单击右上方当前登录用户名称，选择菜单 > 用户信息，获取租户ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'docRequired' => false, + 'example' => '10002', + ], + ], + [ + 'name' => 'ProjectId', + 'in' => 'formData', + 'schema' => [ + 'description' => '工作空间的ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + 'example' => '10001', + ], + ], + [ + 'name' => 'ApiId', + 'in' => 'formData', + 'schema' => [ + 'description' => 'API的ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + 'example' => '10000', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => [ + 'description' => 'HTTP状态码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Data' => [ + 'description' => '发布是否成功。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'ErrorMessage' => [ + 'description' => '错误信息。'."\n", + 'type' => 'string', + 'example' => 'The connection does not exist.', + ], + 'RequestId' => [ + 'description' => '请求ID，一次请求的唯一标识。'."\n", + 'type' => 'string', + 'example' => '0000-ABCD-EFG****', + ], + 'ErrorCode' => [ + 'description' => '错误码。', + 'type' => 'string', + 'example' => 'Invalid.Tenant.ConnectionNotExists', + ], + 'Success' => [ + 'description' => '调用是否成功。'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + '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' => '发布数据服务API', + 'summary' => '调用PublishDataServiceApi发布数据服务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' => '租户ID。您可登录[DataWorks控制台](https://workbench.data.aliyun.com/console)，进入数据开发（DataStudio）页面，单击右上方当前登录用户名称，选择菜单 > 用户信息，获取租户ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'docRequired' => false, + 'example' => '10002', + ], + ], + [ + 'name' => 'ProjectId', + 'in' => 'formData', + 'schema' => [ + 'description' => '工作空间的ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + 'example' => '10001', + ], + ], + [ + 'name' => 'ApiId', + 'in' => 'formData', + 'schema' => [ + 'description' => '数据服务API的ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + 'example' => '10000', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => [ + 'description' => 'HTTP状态码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Data' => [ + 'description' => '删除是否成功。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'ErrorMessage' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'The connection does not exist.', + ], + 'RequestId' => [ + 'description' => '请求ID，一次请求的唯一标识。'."\n", + 'type' => 'string', + 'example' => '0000-ABCD-EFG****', + ], + 'ErrorCode' => [ + 'description' => '错误码。', + 'type' => 'string', + 'example' => 'Invalid.Tenant.ConnectionNotExists', + ], + 'Success' => [ + 'description' => '调用是否成功。'."\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 \\"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' => '删除数据服务API', + 'summary' => '调用DeleteDataServiceApi删除数据服务API。', + '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' => '页码，从1开始，默认值为1。'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'docRequired' => true, + 'minimum' => '1', + 'example' => '1', + 'default' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'formData', + 'schema' => [ + 'description' => '每页显示的条数，默认为10条，最大50条。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'docRequired' => true, + 'maximum' => '50', + 'minimum' => '1', + 'example' => '10', + 'default' => '10', + ], + ], + [ + 'name' => 'ProjectId', + 'in' => 'formData', + 'schema' => [ + 'description' => '工作空间的ID。'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + 'example' => '10000', + ], + ], + [ + 'name' => 'TenantId', + 'in' => 'formData', + 'schema' => [ + 'description' => '租户ID。您可登录[DataWorks控制台](https://workbench.data.aliyun.com/console)，进入数据开发（DataStudio）页面，单击右上方当前登录用户名称，选择菜单 > 用户信息，获取租户ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'docRequired' => false, + 'example' => '10001', + ], + ], + [ + 'name' => 'ApiNameKeyword', + 'in' => 'formData', + 'schema' => [ + 'description' => 'API名称的关键词，过滤得到API名称包含该关键词的API。'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'My API name', + ], + ], + [ + 'name' => 'ApiPathKeyword', + 'in' => 'formData', + 'schema' => [ + 'description' => 'API路径的关键词，过滤得到API路径包含该关键词的API。'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '/test/', + ], + ], + [ + 'name' => 'CreatorId', + 'in' => 'formData', + 'schema' => [ + 'description' => 'API创建者的阿里云ID，过滤得到该用户创建的API。', + 'type' => 'string', + 'required' => false, + 'example' => '123456', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回对象', + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => [ + 'description' => 'HTTP状态码。'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'RequestId' => [ + 'description' => '请求ID，一次请求的唯一标识。'."\n", + 'type' => 'string', + 'example' => '0000-ABCD-EFG****', + ], + 'ErrorMessage' => [ + 'description' => '错误信息。'."\n", + 'type' => 'string', + 'example' => 'The connection does not exist.', + ], + 'Success' => [ + 'description' => '调用是否成功。'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'ErrorCode' => [ + 'description' => '错误码。'."\n", + 'type' => 'string', + 'example' => 'Invalid.Tenant.ConnectionNotExists', + ], + 'Data' => [ + 'description' => '返回开发中API的信息。', + 'type' => 'object', + 'properties' => [ + 'PageNumber' => [ + 'description' => '页码，和请求中的PageNumber一致。'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '每页显示的条数，默认为10条，最大100条。'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'TotalCount' => [ + 'description' => '总记录数。'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '100', + ], + 'Apis' => [ + 'description' => 'API开发态信息列表。', + 'type' => 'array', + 'items' => [ + 'description' => '返回对象', + 'type' => 'object', + 'properties' => [ + 'Timeout' => [ + 'description' => '超时时间，单位为毫秒（ms）。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10000', + ], + 'Status' => [ + 'description' => 'API的状态，可选枚举值包括0（未发布）和1（已发布）。'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'ApiId' => [ + 'description' => 'API的ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10002', + ], + 'ApiMode' => [ + 'description' => 'API的类型，可选枚举值包括0（向导API）、1（脚本API）和2（注册API）。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'ProjectId' => [ + 'description' => '工作空间的ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10000', + ], + 'ResponseContentType' => [ + 'description' => 'API的返回数据类型，可选枚举值包括0（JSON）和1（XML）。向导和脚本API支持JSON，注册API支持JSON和XML。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'CreatorId' => [ + 'description' => '创建人的阿里云ID。', + 'type' => 'string', + 'example' => '1234567', + ], + 'VisibleRange' => [ + 'description' => '可见范围，可选枚举值包括0（工作空间）和1（私有）。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'ModifiedTime' => [ + 'description' => '最新修改时间。'."\n", + 'type' => 'string', + 'example' => '2020-06-23T00:21:01+0800', + ], + 'OperatorId' => [ + 'description' => '最新编辑人的阿里云ID。', + 'type' => 'string', + 'example' => '2345678', + ], + 'GroupId' => [ + 'description' => '分组ID。', + 'type' => 'string', + 'example' => 'abcde123456789', + ], + 'Description' => [ + 'description' => 'API的描述信息。', + 'type' => 'string', + 'example' => 'Test API description', + ], + 'FolderId' => [ + 'description' => '文件夹ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'RequestMethod' => [ + 'description' => 'API的请求方式，可选枚举值包括0（GET）、1（POST）、2（PUT）和3（DELTE）。向导和脚本API支持GET和POST。注册API支持GET、POST、PUT和DELETE。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'CreatedTime' => [ + 'description' => '创建时间。'."\n", + 'type' => 'string', + 'example' => '2020-06-23T00:21:01+0800', + ], + 'ApiName' => [ + 'description' => 'API的名称。'."\n", + 'type' => 'string', + 'example' => 'My API name', + ], + 'TenantId' => [ + 'description' => '租户ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10000', + ], + 'ApiPath' => [ + 'description' => 'API的路径。'."\n", + 'type' => 'string', + 'example' => '/test/1', + ], + 'Protocols' => [ + 'description' => '字段列表', + 'type' => 'array', + 'items' => [ + 'description' => 'API的协议，多值列表，可选枚举值包括0（HTTP）和1（HTTPS）。'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + ], + 'RegistrationDetails' => [ + 'description' => '注册API的详情，只有注册API返回。'."\n", + 'type' => 'object', + 'properties' => [ + 'ServiceHost' => [ + 'description' => '后端服务地址。'."\n", + 'type' => 'string', + 'example' => 'http://example.aliyundoc.com', + ], + 'ServiceContentType' => [ + 'description' => 'API的返回数据类型，可选枚举值包括0（JSON）和1（XML）。向导和脚本API支持JSON，注册API支持JSON和XML。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'ServicePath' => [ + 'description' => '后端服务路径。'."\n", + 'type' => 'string', + 'example' => '/index', + ], + 'SuccessfulResultSample' => [ + 'description' => '正常返回示例。'."\n", + 'type' => 'string', + 'example' => '{"success": true}', + ], + 'FailedResultSample' => [ + 'description' => '错误返回示例。'."\n", + 'type' => 'string', + 'example' => '{"success": false}', + ], + 'ServiceRequestBodyDescription' => [ + 'description' => '后端请求body内容的描述信息。'."\n", + 'type' => 'string', + 'example' => '{"abc":1}', + ], + 'RegistrationErrorCodes' => [ + 'description' => '注册API的错误码列表。'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '返回对象', + 'type' => 'object', + 'properties' => [ + 'ErrorMessage' => [ + 'description' => '错误信息。'."\n", + 'type' => 'string', + 'example' => 'fail to call', + ], + 'ErrorCode' => [ + 'description' => '错误码。'."\n", + 'type' => 'string', + 'example' => '1001', + ], + 'ErrorSolution' => [ + 'description' => '错误解决方案。'."\n", + 'type' => 'string', + 'example' => 'retry', + ], + ], + ], + ], + 'RegistrationRequestParameters' => [ + 'description' => '注册API的请求参数列表。'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '返回对象', + 'type' => 'object', + 'properties' => [ + 'ColumnName' => [ + 'description' => '绑定的表字段名称，仅向导模式支持。'."\n", + 'type' => 'string', + 'example' => 'column1', + ], + 'ParameterName' => [ + 'description' => '参数的名称。'."\n", + 'type' => 'string', + 'example' => 'name1', + ], + 'ParameterPosition' => [ + 'description' => '参数的位置，可选枚举值包括0（Path）、1（Query）、2（Head）和3（Body）。向导和脚本API仅支持Query。注册API中的GET、DELETE方法支持Query、Head，PUT、POST方法支持Query、Head和Body。'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'ParameterDescription' => [ + 'description' => '描述的信息。', + 'type' => 'string', + 'example' => 'description1', + ], + 'DefaultValue' => [ + 'description' => '默认值。'."\n", + 'type' => 'string', + 'example' => 'default1', + ], + 'ParameterOperator' => [ + 'description' => '运算符，可选枚举值包括0（Equal）、1（Like）、2（Const）和3（In）。向导模式API支持Equal、Like和In，脚本模式API支持Equal，注册API支持Equal和Const。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'ParameterDataType' => [ + 'description' => "\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', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'ExampleValue' => [ + 'description' => '示例值。', + 'type' => 'string', + 'example' => 'example1', + ], + 'IsRequiredParameter' => [ + 'description' => '是否必填。'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + ], + 'ScriptDetails' => [ + 'description' => '脚本API的详情，只有脚本API返回。'."\n", + 'type' => 'object', + 'properties' => [ + 'Script' => [ + 'description' => 'SQL脚本。'."\n", + 'type' => 'string', + 'example' => 'select a from t', + ], + 'IsPagedResponse' => [ + 'description' => '返回是否分页。'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'ScriptRequestParameters' => [ + 'description' => '脚本API的请求参数列表。'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '返回对象', + 'type' => 'object', + 'properties' => [ + 'ColumnName' => [ + 'description' => '绑定的表字段名称，仅向导模式支持。'."\n", + 'type' => 'string', + 'example' => 'column1', + ], + 'ParameterName' => [ + 'description' => '参数名称', + 'type' => 'string', + 'example' => 'param1', + ], + 'ParameterPosition' => [ + 'description' => '参数位置，可选枚举值有：'."\n" + ."\n" + .'- 0：Path'."\n" + .'- 1：Query'."\n" + .'- 2：Head'."\n" + .'- 3：Body'."\n" + ."\n" + .'向导和脚本API，只支持Query；注册API，GET、DELETE方法支持Query、Head，PUT、POST方法支持Query、Head、Body。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'ParameterDescription' => [ + 'description' => '描述', + 'type' => 'string', + 'example' => 'description1', + ], + 'DefaultValue' => [ + 'description' => '默认值', + 'type' => 'string', + 'example' => 'default1', + ], + 'ParameterOperator' => [ + 'description' => '运算符，可选枚举值有：'."\n" + ."\n" + .'- 0：Equal'."\n" + .'- 1：Like'."\n" + .'- 2：Const'."\n" + .'- 3：In'."\n" + ."\n" + .'向导API支持Equal、Like、In；脚本API支持Equal；注册API支持Equal、Const。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'ParameterDataType' => [ + 'description' => '数据类型，可选枚举值：'."\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', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'ExampleValue' => [ + 'description' => '示例值'."\n", + 'type' => 'string', + 'example' => 'example1', + ], + 'IsRequiredParameter' => [ + 'description' => '是否必填'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + 'ScriptResponseParameters' => [ + 'description' => '脚本API的返回参数列表。'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '返回对象', + 'type' => 'object', + 'properties' => [ + 'ParameterDescription' => [ + 'description' => '描述', + 'type' => 'string', + 'example' => 'description2', + ], + 'ColumnName' => [ + 'description' => '绑定的表字段名称，仅向导模式有'."\n", + 'type' => 'string', + 'example' => 'column2', + ], + 'ParameterName' => [ + 'description' => '参数名称', + 'type' => 'string', + 'example' => 'param2', + ], + 'ParameterDataType' => [ + 'description' => '数据类型，可选枚举值：'."\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', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'ExampleValue' => [ + 'description' => '示例值'."\n", + 'type' => 'string', + 'example' => 'example2', + ], + ], + ], + ], + 'ScriptConnection' => [ + 'description' => '脚本API的数据源信息。'."\n", + 'type' => 'object', + 'properties' => [ + 'TableName' => [ + 'description' => '数据源表的名称。'."\n", + 'type' => 'string', + 'example' => 't', + ], + 'ConnectionId' => [ + 'description' => '数据源ID。'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '123', + ], + ], + ], + ], + ], + 'WizardDetails' => [ + 'description' => '向导API的详情，只有向导API返回。'."\n", + 'type' => 'object', + 'properties' => [ + 'IsPagedResponse' => [ + 'description' => '返回是否分页。'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'WizardRequestParameters' => [ + 'description' => '向导API的请求参数列表。'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '返回对象', + 'type' => 'object', + 'properties' => [ + 'ColumnName' => [ + 'description' => '绑定的表字段名称，仅向导模式支持。'."\n", + 'type' => 'string', + 'example' => 'column1', + ], + 'ParameterName' => [ + 'description' => '参数名称。'."\n", + 'type' => 'string', + 'example' => 'param1', + ], + 'ParameterPosition' => [ + 'description' => '参数的位置，可选枚举值包括0（Path）、1（Query）、2（Head）和3（Body）。向导和脚本API仅支持Query。注册API中的GET、DELETE方法支持Query、Head，PUT、POST方法支持Query、Head和Body。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'ParameterDescription' => [ + 'description' => '描述信息。'."\n", + 'type' => 'string', + 'example' => 'description1', + ], + 'DefaultValue' => [ + 'description' => '默认值。'."\n", + 'type' => 'string', + 'example' => 'default1', + ], + 'ParameterOperator' => [ + 'description' => '运算符，可选枚举值包括0（Equal）、1（Like）、2（Const）和3（In）。向导API支持Equal、Like和In，脚本API支持Equal，注册API支持Equal和Const。'."\n" + ."\n\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'ParameterDataType' => [ + 'description' => '数据类型，可选枚举值：'."\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', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'ExampleValue' => [ + 'description' => '示例值。'."\n", + 'type' => 'string', + 'example' => 'example1', + ], + 'IsRequiredParameter' => [ + 'description' => '是否必填。'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + 'WizardResponseParameters' => [ + 'description' => '向导模式的返回参数列表。'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '返回对象', + 'type' => 'object', + 'properties' => [ + 'ParameterDescription' => [ + 'description' => '描述信息。', + 'type' => 'string', + 'example' => 'description2', + ], + 'ColumnName' => [ + 'description' => '绑定的表字段名称，仅向导模式支持。'."\n", + 'type' => 'string', + 'example' => 'column2', + ], + 'ParameterName' => [ + 'description' => '参数的名称。', + 'type' => 'string', + 'example' => 'param2', + ], + 'ParameterDataType' => [ + 'description' => '数据类型，可选枚举值：'."\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', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'ExampleValue' => [ + 'description' => '示例值。'."\n", + 'type' => 'string', + 'example' => 'example2', + ], + ], + ], + ], + 'WizardConnection' => [ + 'description' => '向导API的数据源信息。'."\n", + 'type' => 'object', + 'properties' => [ + 'TableName' => [ + 'description' => '数据源表的名称。'."\n", + 'type' => 'string', + 'example' => 't', + ], + 'ConnectionId' => [ + 'description' => '数据源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' => '获取数据服务API开发中的信息列表', + 'summary' => '调用ListDataServiceApis获取数据服务API开发中的信息列表。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' 不同类型API的详情信息通过不同字段返回。向导API使用WizardDetails字段，脚本API使用ScriptDetails字段，注册API使用RegistrationDetails字段。'."\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' => '租户ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'docRequired' => false, + 'example' => '10002', + ], + ], + [ + 'name' => 'ProjectId', + 'in' => 'formData', + 'schema' => [ + 'description' => '工作空间的ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + 'example' => '10001', + ], + ], + [ + 'name' => 'ApiId', + 'in' => 'formData', + 'schema' => [ + 'description' => '数据服务API的ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + 'example' => '10000', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回对象', + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => [ + 'description' => 'HTTP状态码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'RequestId' => [ + 'description' => '请求ID，一次请求的唯一标识。'."\n", + 'type' => 'string', + 'example' => '0000-ABCD-EFG****', + ], + 'ErrorMessage' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'The specified parameters are invalid.', + ], + 'Success' => [ + 'description' => '调用是否成功。'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'ErrorCode' => [ + 'description' => '错误码。', + 'type' => 'string', + 'example' => '1031203110005', + ], + 'Data' => [ + 'description' => '返回数据。', + 'type' => 'object', + 'properties' => [ + 'Timeout' => [ + 'description' => '超时时间，单位为毫秒（ms）。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10000', + ], + 'Status' => [ + 'description' => 'API的状态，可选枚举值包括0（未发布）和1（已发布）。'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'ApiId' => [ + 'description' => '数据服务API的ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10000', + ], + 'ApiMode' => [ + 'description' => 'API的类型，可选枚举值包括0（向导API）、1（脚本API）和2（注册API）。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'ProjectId' => [ + 'description' => '工作空间的ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10001', + ], + 'ResponseContentType' => [ + 'description' => 'API的返回数据类型，可选枚举值包括0（JSON）和1（XML）。向导和脚本API支持JSON，注册API支持JSON和XML。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'CreatorId' => [ + 'description' => '创建人的阿里云ID。', + 'type' => 'string', + 'example' => '1234567', + ], + 'VisibleRange' => [ + 'description' => '可见范围，可选枚举值包括0（工作空间）和1（私有）。'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'ModifiedTime' => [ + 'description' => '最新修改时间。', + 'type' => 'string', + 'example' => '2020-06-23T00:21:01+0800', + ], + 'OperatorId' => [ + 'description' => '最新编辑人的阿里云ID。', + 'type' => 'string', + 'example' => '2345678', + ], + 'GroupId' => [ + 'description' => '分组ID。', + 'type' => 'string', + 'example' => 'ab123****', + ], + 'Description' => [ + 'description' => '描述信息。', + 'type' => 'string', + 'example' => '测试API描述', + ], + 'FolderId' => [ + 'description' => '文件夹ID', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'RequestMethod' => [ + 'description' => 'API的请求方式，可选枚举值包括0（GET）、1（POST）、2（PUT）和3（DELETE）。向导和脚本API支持GET和POST。注册API支持GET、POST、PUT和DELETE。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'CreatedTime' => [ + 'description' => '创建时间。', + 'type' => 'string', + 'example' => '2020-06-23T00:21:01+0800', + ], + 'ApiName' => [ + 'description' => 'API的名称。', + 'type' => 'string', + 'example' => '测试API名称', + ], + 'TenantId' => [ + 'description' => '租户ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10002', + ], + 'ApiPath' => [ + 'description' => 'API的路径。', + 'type' => 'string', + 'example' => '/test/1', + ], + 'Protocols' => [ + 'description' => '字段列表', + 'type' => 'array', + 'items' => [ + 'description' => 'API协议，多值列表，可选枚举值包括0（HTTP）和1（HTTPS）。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + ], + 'RegistrationDetails' => [ + 'description' => '注册API的详情，只有注册API返回。', + 'type' => 'object', + 'properties' => [ + 'ServiceHost' => [ + 'description' => '后端服务地址', + 'type' => 'string', + 'example' => 'http://example.aliyundoc.com', + ], + 'ServiceContentType' => [ + 'description' => 'API返回数据类型，可选枚举值：'."\n" + ."\n" + .'- 0：JSON'."\n" + .'- 1：XML'."\n" + ."\n" + .'向导和脚本API只支持JSON；注册API支持JSON和XML。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'ServicePath' => [ + 'description' => '后端服务路径', + 'type' => 'string', + 'example' => '/index', + ], + 'SuccessfulResultSample' => [ + 'description' => '正常返回示例', + 'type' => 'string', + 'example' => '{"success": true}', + ], + 'FailedResultSample' => [ + 'description' => '错误返回示例。', + 'type' => 'string', + 'example' => '{"success": false}', + ], + 'ServiceRequestBodyDescription' => [ + 'description' => '后端请求body内容描述', + 'type' => 'string', + 'example' => '{"abc":1}', + ], + 'RegistrationErrorCodes' => [ + 'description' => '注册API的错误码列表。', + 'type' => 'array', + 'items' => [ + 'description' => '返回对象', + 'type' => 'object', + 'properties' => [ + 'ErrorMessage' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'fail to call', + ], + 'ErrorCode' => [ + 'description' => '错误码。', + 'type' => 'string', + 'example' => '1001', + ], + 'ErrorSolution' => [ + 'description' => '错误解决方案。', + 'type' => 'string', + 'example' => 'retry', + ], + ], + ], + ], + 'RegistrationRequestParameters' => [ + 'description' => '注册API的请求参数列表。', + 'type' => 'array', + 'items' => [ + 'description' => '返回对象', + 'type' => 'object', + 'properties' => [ + 'ColumnName' => [ + 'description' => '绑定的表字段名称，仅向导模式支持。', + 'type' => 'string', + 'example' => 'column1', + ], + 'ParameterName' => [ + 'description' => '参数的名称。', + 'type' => 'string', + 'example' => 'name1', + ], + 'ParameterPosition' => [ + 'description' => '参数位置，可选枚举值有：'."\n" + ."\n" + .'- 0：Path'."\n" + .'- 1：Query'."\n" + .'- 2：Head'."\n" + .'- 3：Body'."\n" + ."\n" + .'向导和脚本API，只支持Query；注册API，GET、DELETE方法支持Query、Head，PUT、POST方法支持Query、Head、Body。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'ParameterDescription' => [ + 'description' => '描述信息。', + 'type' => 'string', + 'example' => 'description1', + ], + 'DefaultValue' => [ + 'description' => '默认值。', + 'type' => 'string', + 'example' => 'default1', + ], + 'ParameterOperator' => [ + 'description' => '运算符，可选枚举值有：'."\n" + ."\n" + .'- 0：Equal'."\n" + .'- 1：Like'."\n" + .'- 2：Const'."\n" + .'- 3：In'."\n" + ."\n" + .'向导API支持Equal、Like、In；脚本API支持Equal；注册API支持Equal、Const。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'ParameterDataType' => [ + 'description' => '数据类型，可选枚举值：'."\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', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'ExampleValue' => [ + 'description' => '示例值。', + 'type' => 'string', + 'example' => 'example1', + ], + 'IsRequiredParameter' => [ + 'description' => '是否必填。', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + ], + 'ScriptDetails' => [ + 'description' => '脚本API的详情，只有脚本API返回。', + 'type' => 'object', + 'properties' => [ + 'Script' => [ + 'description' => 'SQL脚本。', + 'type' => 'string', + 'example' => 'select a from t', + ], + 'IsPagedResponse' => [ + 'description' => '返回是否分页。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'ScriptRequestParameters' => [ + 'description' => '脚本API的请求参数列表。', + 'type' => 'array', + 'items' => [ + 'description' => '返回对象', + 'type' => 'object', + 'properties' => [ + 'ColumnName' => [ + 'description' => '绑定的表字段名称，仅向导模式支持。', + 'type' => 'string', + 'example' => 'column1', + ], + 'ParameterName' => [ + 'description' => '参数的名称。', + 'type' => 'string', + 'example' => 'param1', + ], + 'ParameterPosition' => [ + 'description' => '参数的位置，可选枚举值包括0（Path）、1（Query）、2（Head）和3（Body）。向导和脚本API仅支持Query。注册API中的GET、DELETE方法支持Query、Head，PUT、POST方法支持Query、Head和Body。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'ParameterDescription' => [ + 'description' => '描述信息。', + 'type' => 'string', + 'example' => 'description1', + ], + 'DefaultValue' => [ + 'description' => '默认值。', + 'type' => 'string', + 'example' => 'default1', + ], + 'ParameterOperator' => [ + 'description' => '运算符，可选枚举值包括0（Equal）、1（Like）、2（Const）和3（In）。向导模式API支持Equal、Like和In，脚本模式API支持Equal，注册API支持Equal和Const。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'ParameterDataType' => [ + 'description' => '数据类型，可选枚举值：'."\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', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'ExampleValue' => [ + 'description' => '示例值。', + 'type' => 'string', + 'example' => 'example1', + ], + 'IsRequiredParameter' => [ + 'description' => '是否必填。', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + 'ScriptResponseParameters' => [ + 'description' => '脚本API的返回参数列表。', + 'type' => 'array', + 'items' => [ + 'description' => '返回对象', + 'type' => 'object', + 'properties' => [ + 'ParameterDescription' => [ + 'description' => '描述信息。', + 'type' => 'string', + 'example' => 'description2', + ], + 'ColumnName' => [ + 'description' => '绑定的表字段名称，仅向导模式支持。', + 'type' => 'string', + 'example' => 'column2', + ], + 'ParameterName' => [ + 'description' => '参数的名称。', + 'type' => 'string', + 'example' => 'param2', + ], + 'ParameterDataType' => [ + 'description' => '数据类型，可选枚举值：'."\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', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'ExampleValue' => [ + 'description' => '示例值。', + 'type' => 'string', + 'example' => 'example2', + ], + ], + ], + ], + 'ScriptConnection' => [ + 'description' => '脚本API的数据源信息。', + 'type' => 'object', + 'properties' => [ + 'TableName' => [ + 'description' => '数据源表的名称。', + 'type' => 'string', + 'example' => 't', + ], + 'ConnectionId' => [ + 'description' => '数据源ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '123', + ], + ], + ], + ], + ], + 'WizardDetails' => [ + 'description' => '向导API详情，只有向导API返回。', + 'type' => 'object', + 'properties' => [ + 'IsPagedResponse' => [ + 'description' => '返回是否分页。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'WizardRequestParameters' => [ + 'description' => '向导API的请求参数列表。', + 'type' => 'array', + 'items' => [ + 'description' => '返回对象', + 'type' => 'object', + 'properties' => [ + 'ColumnName' => [ + 'description' => '绑定的表字段名称，仅向导模式支持。', + 'type' => 'string', + 'example' => 'column1', + ], + 'ParameterName' => [ + 'description' => '参数的名称。', + 'type' => 'string', + 'example' => 'param1', + ], + 'ParameterPosition' => [ + 'description' => '参数的位置，可选枚举值包括0（Path）、1（Query）、2（Head）和3（Body）。向导和脚本API仅支持Query。注册API中的GET、DELETE方法支持Query、Head，PUT、POST方法支持Query、Head和Body。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'ParameterDescription' => [ + 'description' => '描述信息。', + 'type' => 'string', + 'example' => 'description1', + ], + 'DefaultValue' => [ + 'description' => '默认值。', + 'type' => 'string', + 'example' => 'default1', + ], + 'ParameterOperator' => [ + 'description' => '运算符，可选枚举值包括0（Equal）、1（Like）、2（Const）和3（In）。向导模式API支持Equal、Like和In，脚本模式API支持Equal，注册API支持Equal和Const。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'ParameterDataType' => [ + 'description' => '数据类型，可选枚举值：'."\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', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'ExampleValue' => [ + 'description' => '示例值。', + 'type' => 'string', + 'example' => 'example1', + ], + 'IsRequiredParameter' => [ + 'description' => '是否必填。', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + 'WizardResponseParameters' => [ + 'description' => '向导模式的返回参数列表。', + 'type' => 'array', + 'items' => [ + 'description' => '返回对象', + 'type' => 'object', + 'properties' => [ + 'ParameterDescription' => [ + 'description' => '描述信息。', + 'type' => 'string', + 'example' => 'description2', + ], + 'ColumnName' => [ + 'description' => '绑定的表字段名称，仅向导模式支持。', + 'type' => 'string', + 'example' => 'column2', + ], + 'ParameterName' => [ + 'description' => '参数的名称。', + 'type' => 'string', + 'example' => 'param2', + ], + 'ParameterDataType' => [ + 'description' => '数据类型，可选枚举值：'."\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', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'ExampleValue' => [ + 'description' => '示例值。', + 'type' => 'string', + 'example' => 'example2', + ], + ], + ], + ], + 'WizardConnection' => [ + 'description' => '向导API的数据源信息。', + 'type' => 'object', + 'properties' => [ + 'TableName' => [ + 'description' => '数据源的表名称。', + 'type' => 'string', + 'example' => 't', + ], + 'ConnectionId' => [ + 'description' => '数据源ID。', + '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' => '查询数据服务API开发态的详情', + 'summary' => '调用GetDataServiceApi查询数据服务API开发态的详情。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' 不同类型API的详情信息通过不同字段返回。向导API使用WizardDetails字段，脚本API使用ScriptDetails字段，注册API使用RegistrationDetails字段。', + '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' => '租户ID。您可登录[DataWorks控制台](https://workbench.data.aliyun.com/console)，进入数据开发（DataStudio）页面，单击右上方当前登录用户名称，选择菜单 > 用户信息，获取租户ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'docRequired' => false, + 'example' => '10001', + ], + ], + [ + 'name' => 'ProjectId', + 'in' => 'formData', + 'schema' => [ + 'description' => '工作空间的ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + 'example' => '10001', + ], + ], + [ + 'name' => 'ApiId', + 'in' => 'formData', + 'schema' => [ + 'description' => 'API的ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + 'example' => '10000', + ], + ], + [ + 'name' => 'RequestMethod', + 'in' => 'formData', + 'schema' => [ + 'description' => 'API的请求方式，可选枚举值包括0（GET）、1（POST）、2（PUT）和3（DELTE）。向导和脚本API支持GET和POST。注册API支持GET、POST、PUT和DELETE。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'docRequired' => true, + 'example' => '0', + ], + ], + [ + 'name' => 'ResponseContentType', + 'in' => 'formData', + 'schema' => [ + 'description' => 'API的返回数据类型，可选枚举值包括0（JSON）和1（XML）。向导和脚本API支持JSON，注册API支持JSON和XML。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'docRequired' => true, + 'example' => '0', + ], + ], + [ + 'name' => 'Timeout', + 'in' => 'formData', + 'schema' => [ + 'description' => '超时时间，单位为毫秒（ms），取值范围为(0, 30000]。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'docRequired' => true, + 'example' => '10000', + ], + ], + [ + 'name' => 'VisibleRange', + 'in' => 'formData', + 'schema' => [ + 'description' => '可见范围，可选枚举值包括0（工作空间）和1（私有）。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'docRequired' => true, + 'example' => '0', + ], + ], + [ + 'name' => 'Protocols', + 'in' => 'formData', + 'schema' => [ + 'description' => 'API协议，可选枚举值包括0（HTTP）和1（HTTPS）。支持多值，多个值之间使用英文逗号（,）分隔。'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '0,1', + ], + ], + [ + 'name' => 'WizardDetails', + 'in' => 'formData', + 'schema' => [ + 'description' => '向导API的详情，请参见[GetDataServiceApi](~~174013~~)接口wizardDetails字段的JSON String。'."\n" + ."\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' => '脚本API的详情，请参见[GetDataServiceApi](~~174013~~)接口scriptDetails字段的JSON String。'."\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' => '注册API的详情，请参见[GetDataServiceApi](~~174013~~)接口registrationDetails字段的JSON String。', + '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' => 'API的路径。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '/test/2', + ], + ], + [ + 'name' => 'ApiDescription', + 'in' => 'formData', + 'schema' => [ + 'description' => 'API的描述信息。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '测试API描述', + ], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'formData', + 'schema' => [ + 'description' => '独享资源组ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '3242432423', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => [ + 'description' => 'HTTP状态码。'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Data' => [ + 'description' => '更新API是否成功。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'ErrorMessage' => [ + 'description' => '错误信息。'."\n", + 'type' => 'string', + 'example' => 'The connection does not exist.', + ], + 'RequestId' => [ + 'description' => '请求ID，一次请求的唯一标识。'."\n", + 'type' => 'string', + 'example' => '0000-ABCD-EFG****', + ], + 'ErrorCode' => [ + 'description' => '错误码。', + 'type' => 'string', + 'example' => 'Invalid.Tenant.ConnectionNotExists', + ], + 'Success' => [ + 'description' => '调用是否成功。'."\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 \\"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' => '更新数据服务API开发态的信息', + 'summary' => '调用UpdateDataServiceApi更新数据服务API开发态的信息。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'GetDataServicePublishedApi' => [ + 'summary' => '调用GetDataServicePublishedApi查询数据服务API的发布态信息。', + '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' => '工作空间的ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + 'example' => '10002', + ], + ], + [ + 'name' => 'TenantId', + 'in' => 'formData', + 'schema' => [ + 'description' => '租户ID。您可登录[DataWorks控制台](https://workbench.data.aliyun.com/console)，进入数据开发（DataStudio）页面，单击右上方当前登录用户名称，选择菜单 > 用户信息，获取租户ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'docRequired' => false, + 'example' => '10003', + ], + ], + [ + 'name' => 'ApiId', + 'in' => 'formData', + 'schema' => [ + 'description' => 'API的ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + 'example' => '10001', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => [ + 'description' => 'HTTP状态码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'RequestId' => [ + 'description' => '请求ID，一次请求的唯一标识。'."\n", + 'type' => 'string', + 'example' => '0000-ABCD-EFG****', + ], + 'ErrorMessage' => [ + 'description' => '错误信息。'."\n", + 'type' => 'string', + 'example' => 'The connection does not exist.', + ], + 'Success' => [ + 'description' => '调用是否成功。'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'ErrorCode' => [ + 'description' => '错误码。'."\n", + 'type' => 'string', + 'example' => 'Invalid.Tenant.ConnectionNotExists', + ], + 'Data' => [ + 'description' => 'API的最新发布态信息。', + 'type' => 'object', + 'properties' => [ + 'Timeout' => [ + 'description' => '超时时间，单位为毫秒（ms）。'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10000', + ], + 'Status' => [ + 'description' => ' '."\n" + .'API的状态，可选枚举值包括0（未发布）和1（已发布）。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'ApiId' => [ + 'description' => '数据服务API的ID。'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10000', + ], + 'ApiMode' => [ + 'description' => 'API的类型，可选枚举值包括0（向导API）、1（脚本API）和2（注册API）。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'ProjectId' => [ + 'description' => '工作空间的ID。'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10001', + ], + 'ResponseContentType' => [ + 'description' => 'API的返回数据类型，可选枚举值包括0（JSON）和1（XML）。向导和脚本API支持JSON，注册API支持JSON和XML。'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'CreatorId' => [ + 'description' => '创建人的阿里云ID。'."\n", + 'type' => 'string', + 'example' => '1234567', + ], + 'VisibleRange' => [ + 'description' => '可见范围，可选枚举值包括0（工作空间）和1（私有）。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'ModifiedTime' => [ + 'description' => '最新修改时间。'."\n", + 'type' => 'string', + 'example' => '2020-06-23T00:21:01+0800', + ], + 'OperatorId' => [ + 'description' => '最新编辑人的阿里云ID。'."\n", + 'type' => 'string', + 'example' => '2345678', + ], + 'GroupId' => [ + 'description' => '分组ID。'."\n", + 'type' => 'string', + 'example' => 'ab12**', + ], + 'Description' => [ + 'description' => '描述信息。', + 'type' => 'string', + 'example' => '测试API描述', + ], + 'RequestMethod' => [ + 'description' => 'API的请求方式，可选枚举值包括0（GET）、1（POST）、2（PUT）和3（DELTE）。向导和脚本API支持GET和POST。注册API支持GET、POST、PUT和DELETE。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'CreatedTime' => [ + 'description' => '创建时间。'."\n", + 'type' => 'string', + 'example' => '2020-06-23T00:21:01+0800', + ], + 'ApiName' => [ + 'description' => 'API的名称。'."\n", + 'type' => 'string', + 'example' => '测试API名称', + ], + 'TenantId' => [ + 'description' => '租户ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10001', + ], + 'ApiPath' => [ + 'description' => 'API的路径。'."\n", + 'type' => 'string', + 'example' => '/test/1', + ], + 'Protocols' => [ + 'description' => 'API协议，多值列表，可选枚举值包括0（HTTP）和1（HTTPS）。', + 'type' => 'array', + 'items' => [ + 'description' => 'API协议，多值列表，可选枚举值包括0（HTTP）和1（HTTPS）。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + ], + 'RegistrationDetails' => [ + 'description' => '注册API详情，只有注册API返回。'."\n", + 'type' => 'object', + 'properties' => [ + 'ServiceHost' => [ + 'description' => '后端服务地址。', + 'type' => 'string', + 'example' => 'http://www.abc.com', + ], + 'ServiceContentType' => [ + 'description' => 'API的返回数据类型，可选枚举值包括0（JSON）和1（XML）。向导和脚本API支持JSON，注册API支持JSON和XML。'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'ServicePath' => [ + 'description' => '后端服务路径。'."\n", + 'type' => 'string', + 'example' => '/index', + ], + 'SuccessfulResultSample' => [ + 'description' => '正常返回示例。'."\n", + 'type' => 'string', + 'example' => '{"success": true}', + ], + 'FailedResultSample' => [ + 'description' => '错误返回示例。'."\n", + 'type' => 'string', + 'example' => '{"success": false}', + ], + 'ServiceRequestBodyDescription' => [ + 'description' => '后端请求body内容的描述。'."\n", + 'type' => 'string', + 'example' => '{"abc":1}', + ], + 'RegistrationErrorCodes' => [ + 'title' => '', + 'description' => '注册API的错误码列表。'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ErrorMessage' => [ + 'title' => '', + 'description' => '错误信息。'."\n", + 'type' => 'string', + 'example' => 'The connection does not exist.', + ], + 'ErrorCode' => [ + 'title' => '', + 'description' => '错误码。'."\n", + 'type' => 'string', + 'example' => 'Invalid.Tenant.ConnectionNotExists', + ], + 'ErrorSolution' => [ + 'title' => '', + 'description' => '错误解决方案。'."\n", + 'type' => 'string', + 'example' => 'retry', + ], + ], + ], + ], + 'RegistrationRequestParameters' => [ + 'title' => '', + 'description' => '注册API的请求参数列表。'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ParameterName' => [ + 'description' => '参数的名称。'."\n", + 'type' => 'string', + 'example' => 'name1', + ], + 'ParameterPosition' => [ + 'description' => '参数的位置，可选枚举值包括0（Path）、1（Query）、2（Head）和3（Body）。向导和脚本API仅支持Query。注册API中的GET、DELETE方法支持Query、Head，PUT、POST方法支持Query、Head和Body。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'ParameterDescription' => [ + 'description' => '描述信息。', + 'type' => 'string', + 'example' => 'description1', + ], + 'DefaultValue' => [ + 'description' => '默认值。', + 'type' => 'string', + 'example' => 'default1', + ], + 'ParameterOperator' => [ + 'description' => '运算符，可选枚举值包括0（Equal）、1（Like）、2（Const）和3（In）。向导模式API支持Equal、Like和In，脚本模式API支持Equal，注册API支持Equal和Const。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'ExampleValue' => [ + 'description' => '示例值。'."\n", + 'type' => 'string', + 'example' => 'example1', + ], + 'ParameterDataType' => [ + 'description' => '数据类型，可选枚举值：'."\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', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'IsRequiredParameter' => [ + 'description' => '是否必填。', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + ], + 'ScriptDetails' => [ + 'description' => '脚本API详情，只有脚本API返回。'."\n", + 'type' => 'object', + 'properties' => [ + 'IsPagedResponse' => [ + 'description' => '返回是否分页。'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'SuccessfulResultSample' => [ + 'description' => '正常返回示例。', + 'type' => 'string', + 'example' => '{"success": true}', + ], + 'FailedResultSample' => [ + 'description' => '错误返回示例。'."\n", + 'type' => 'string', + 'example' => '{"success": false}', + ], + 'Script' => [ + 'description' => 'SQL脚本。'."\n", + 'type' => 'string', + 'example' => 'select a from t', + ], + 'ScriptErrorCodes' => [ + 'description' => '脚本API的错误码列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ErrorMessage' => [ + 'description' => '错误信息', + 'type' => 'string', + 'example' => 'fail to call', + ], + 'ErrorCode' => [ + 'description' => '错误码', + 'type' => 'string', + 'example' => '1001', + ], + 'ErrorSolution' => [ + 'description' => '错误解决方案', + 'type' => 'string', + 'example' => 'retry', + ], + ], + ], + ], + 'ScriptRequestParameters' => [ + 'description' => '脚本API的请求参数列表。'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ParameterName' => [ + 'description' => '参数名称'."\n", + 'type' => 'string', + 'example' => 'param1', + ], + 'ParameterPosition' => [ + 'description' => '参数位置，可选枚举值有：'."\n" + ."\n" + .'- 0：Path'."\n" + .'- 1：Query'."\n" + .'- 2：Head'."\n" + .'- 3：Body'."\n" + ."\n" + .'向导和脚本API，只支持Query；注册API，GET、DELETE方法支持Query、Head，PUT、POST方法支持Query、Head、Body。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'ParameterDescription' => [ + 'description' => '描述'."\n", + 'type' => 'string', + 'example' => 'description1', + ], + 'DefaultValue' => [ + 'description' => '默认值'."\n", + 'type' => 'string', + 'example' => 'default1', + ], + 'ParameterOperator' => [ + 'description' => '运算符，可选枚举值有：'."\n" + ."\n" + .'- 0：Equal'."\n" + .'- 1：Like'."\n" + .'- 2：Const'."\n" + .'- 3：In'."\n" + ."\n" + .'向导API支持Equal、Like、In；脚本API支持Equal；注册API支持Equal、Const。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'ExampleValue' => [ + 'description' => '示例值'."\n", + 'type' => 'string', + 'example' => 'example1', + ], + 'ParameterDataType' => [ + 'description' => '数据类型，可选枚举值：'."\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', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'IsRequiredParameter' => [ + 'description' => '是否必填'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + 'ScriptResponseParameters' => [ + 'description' => '脚本API的返回参数列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ParameterDescription' => [ + 'description' => '描述信息。'."\n", + 'type' => 'string', + 'example' => 'description2', + ], + 'ParameterName' => [ + 'description' => '参数的名称。', + 'type' => 'string', + 'example' => 'param2', + ], + 'ExampleValue' => [ + 'description' => '示例值。', + 'type' => 'string', + 'example' => 'example2', + ], + 'ParameterDataType' => [ + 'description' => '数据类型，可选枚举值：'."\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', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + ], + ], + ], + 'ScriptConnection' => [ + 'description' => '脚本API的数据源信息。'."\n", + 'type' => 'object', + 'properties' => [ + 'TableName' => [ + 'description' => '数据源的表名称。'."\n", + 'type' => 'string', + 'example' => 't', + ], + 'ConnectionId' => [ + 'description' => '数据源的ID。'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '123', + ], + ], + ], + ], + ], + 'WizardDetails' => [ + 'description' => '向导API详情，只有向导API返回。', + 'type' => 'object', + 'properties' => [ + 'IsPagedResponse' => [ + 'description' => '返回是否分页。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'SuccessfulResultSample' => [ + 'description' => '正常返回示例。', + 'type' => 'string', + 'example' => '{"success": true}', + ], + 'FailedResultSample' => [ + 'description' => '错误返回示例。', + 'type' => 'string', + 'example' => '{"success": false}', + ], + 'WizardErrorCodes' => [ + 'description' => '向导API的错误码列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ErrorMessage' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'fail to call', + ], + 'ErrorCode' => [ + 'description' => '错误码。', + 'type' => 'string', + 'example' => '1001', + ], + 'ErrorSolution' => [ + 'description' => '错误解决方案。', + 'type' => 'string', + 'example' => 'retry', + ], + ], + ], + ], + 'WizardRequestParameters' => [ + 'description' => '向导API的请求参数列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ParameterName' => [ + 'description' => '参数的名称。', + 'type' => 'string', + 'example' => 'param1', + ], + 'ParameterPosition' => [ + 'description' => '参数的位置，可选枚举值包括0（Path）、1（Query）、2（Head）和3（Body）。向导和脚本API仅支持Query。注册API中的GET、DELETE方法支持Query、Head，PUT、POST方法支持Query、Head和Body。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'ParameterDescription' => [ + 'description' => '描述信息。', + 'type' => 'string', + 'example' => 'description1', + ], + 'DefaultValue' => [ + 'description' => '默认值。'."\n", + 'type' => 'string', + 'example' => 'default1', + ], + 'ParameterOperator' => [ + 'description' => '运算符，可选枚举值包括0（Equal）、1（Like）、2（Const）和3（In）。向导模式API支持Equal、Like和In，脚本模式API支持Equal，注册API支持Equal和Const。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'ExampleValue' => [ + 'description' => '示例值。'."\n", + 'type' => 'string', + 'example' => 'example1', + ], + 'ParameterDataType' => [ + 'description' => '数据类型，可选枚举值：'."\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', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'IsRequiredParameter' => [ + 'description' => '是否必填。'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + 'WizardResponseParameters' => [ + 'description' => '向导API的返回参数列表。', + 'type' => 'array', + 'items' => [ + 'description' => '向导模式的返回参数列表。', + 'type' => 'object', + 'properties' => [ + 'ParameterDescription' => [ + 'description' => '描述信息。', + 'type' => 'string', + 'example' => 'description2', + ], + 'ParameterName' => [ + 'description' => '参数的名称。', + 'type' => 'string', + 'example' => 'param2', + ], + 'ExampleValue' => [ + 'description' => '示例值。', + 'type' => 'string', + 'example' => 'example2', + ], + 'ParameterDataType' => [ + 'description' => '数据类型，可选枚举值：'."\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', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + ], + ], + ], + 'WizardConnection' => [ + 'description' => '向导API的数据源信息。'."\n", + 'type' => 'object', + 'properties' => [ + 'TableName' => [ + 'description' => '数据源的表名称。', + 'type' => 'string', + 'example' => 't', + ], + 'ConnectionId' => [ + 'description' => '数据源的ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '123', + ], + ], + ], + ], + ], + 'SqlMode' => [ + 'title' => 'SQL模式，0：基础SQL；1：高级SQL', + 'description' => 'SQL模式，0：基础SQL；1：高级SQL', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + ], + ], + ], + ], + ], + ], + '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' => '查询数据服务API的发布态信息', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' 不同类型API的详情信息通过不同字段返回。向导API使用WizardDetails字段，脚本API使用ScriptDetails字段，注册API使用RegistrationDetails字段。'."\n", + 'extraInfo' => ' ', + ], + 'ListDataServicePublishedApis' => [ + 'summary' => '调用ListDataServicePublishedApis获取数据服务API的发布态信息列表。', + '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' => '页码，从1开始，默认值为1。'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'docRequired' => true, + 'minimum' => '1', + 'example' => '1', + 'default' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'formData', + 'schema' => [ + 'description' => '每页显示的条数，默认为10条，最大50条。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'docRequired' => true, + 'maximum' => '50', + 'minimum' => '1', + 'example' => '10', + 'default' => '10', + ], + ], + [ + 'name' => 'ProjectId', + 'in' => 'formData', + 'schema' => [ + 'description' => '工作空间的ID。'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + 'example' => '10000', + ], + ], + [ + 'name' => 'TenantId', + 'in' => 'formData', + 'schema' => [ + 'description' => '租户ID。您可登录[DataWorks控制台](https://workbench.data.aliyun.com/console)，进入数据开发（DataStudio）页面，单击右上方当前登录用户名称，选择菜单 > 用户信息，获取租户ID。'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'docRequired' => false, + 'example' => '10001', + ], + ], + [ + 'name' => 'ApiNameKeyword', + 'in' => 'formData', + 'schema' => [ + 'description' => 'API名称的关键词，过滤得到API名称包含该关键词的API。'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'My API name', + ], + ], + [ + 'name' => 'ApiPathKeyword', + 'in' => 'formData', + 'schema' => [ + 'description' => 'API路径的关键词，过滤得到API路径包含该关键词的API。'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '/test/', + ], + ], + [ + 'name' => 'CreatorId', + 'in' => 'formData', + 'schema' => [ + 'description' => 'API创建者的阿里云ID，过滤得到该用户创建的API。'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '12345', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => [ + 'description' => 'HTTP状态码。'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'RequestId' => [ + 'description' => '请求ID，一次请求的唯一标识。'."\n", + 'type' => 'string', + 'example' => '0000-ABCD-EFG****', + ], + 'ErrorMessage' => [ + 'description' => '错误信息。'."\n", + 'type' => 'string', + 'example' => 'The connection does not exist.', + ], + 'Success' => [ + 'description' => '调用是否成功。'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'ErrorCode' => [ + 'description' => '错误码。'."\n", + 'type' => 'string', + 'example' => 'Invalid.Tenant.ConnectionNotExists', + ], + 'Data' => [ + 'description' => 'API发布态信息返回。', + 'type' => 'object', + 'properties' => [ + 'PageNumber' => [ + 'description' => '页码，和请求中的PageNumber一致。'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '每页显示的条数，默认为10条，最大100条。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'TotalCount' => [ + 'description' => '总记录数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '100', + ], + 'Apis' => [ + 'description' => 'API发布态信息列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Timeout' => [ + 'description' => '超时时间，单位毫秒ms'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10000', + ], + 'Status' => [ + 'description' => 'API的状态，可选枚举值包括0（未发布）和1（已发布）。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'ApiId' => [ + 'description' => 'API的ID。'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10002', + ], + 'ApiMode' => [ + 'description' => 'API的类型，可选枚举值包括0（向导API）、1（脚本API）和2（注册API）。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'ProjectId' => [ + 'description' => '工作空间的ID。'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10000', + ], + 'ResponseContentType' => [ + 'description' => ' '."\n" + .'API的返回数据类型，可选枚举值包括0（JSON）和1（XML）。向导和脚本API支持JSON，注册API支持JSON和XML。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'CreatorId' => [ + 'description' => '创建人的阿里云ID。'."\n", + 'type' => 'string', + 'example' => '1234567', + ], + 'VisibleRange' => [ + 'description' => '可见范围，可选枚举值包括0（工作空间）和1（私有）。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'ModifiedTime' => [ + 'description' => '最新修改时间。'."\n", + 'type' => 'string', + 'example' => '2020-06-23T00:21:01+0800', + ], + 'OperatorId' => [ + 'description' => '最新编辑人阿里云ID'."\n", + 'type' => 'string', + 'example' => '2345678', + ], + 'GroupId' => [ + 'description' => '分组ID。'."\n", + 'type' => 'string', + 'example' => 'ab123', + ], + 'Description' => [ + 'description' => '描述信息。', + 'type' => 'string', + 'example' => 'Test API description', + ], + 'RequestMethod' => [ + 'description' => 'API的请求方式，可选枚举值包括0（GET）、1（POST）、2（PUT）和3（DELTE）。向导和脚本API支持GET和POST。注册API支持GET、POST、PUT和DELETE。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'CreatedTime' => [ + 'description' => '创建时间。'."\n", + 'type' => 'string', + 'example' => '2020-06-23T00:21:01+0800', + ], + 'ApiName' => [ + 'description' => 'API的名称。'."\n", + 'type' => 'string', + 'example' => 'My API name', + ], + 'TenantId' => [ + 'description' => '租户ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10001', + ], + 'ApiPath' => [ + 'description' => 'API的路径。'."\n", + 'type' => 'string', + 'example' => '/test/1', + ], + 'Protocols' => [ + 'description' => 'API协议，可选枚举值包括0（HTTP）和1（HTTPS）。', + 'type' => 'array', + 'items' => [ + 'description' => 'API协议，可选枚举值包括0（HTTP）和1（HTTPS）。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + ], + 'RegistrationDetails' => [ + 'description' => '注册API详情，只有注册API返回。', + 'type' => 'object', + 'properties' => [ + 'ServiceHost' => [ + 'description' => '后端服务地址。'."\n", + 'type' => 'string', + 'example' => 'http://www.abc.com', + ], + 'ServiceContentType' => [ + 'description' => 'API的返回数据类型，可选枚举值包括0（JSON）和1（XML）。向导和脚本API支持JSON，注册API支持JSON和XML。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'ServicePath' => [ + 'description' => '后端服务路径。'."\n", + 'type' => 'string', + 'example' => '/index', + ], + 'SuccessfulResultSample' => [ + 'description' => '正常返回示例。'."\n", + 'type' => 'string', + 'example' => '{"success": true}', + ], + 'FailedResultSample' => [ + 'description' => '错误返回示例。'."\n", + 'type' => 'string', + 'example' => '{"success": false}', + ], + 'ServiceRequestBodyDescription' => [ + 'description' => '后端请求body内容的描述。'."\n", + 'type' => 'string', + 'example' => '{"abc":1}', + ], + 'RegistrationErrorCodes' => [ + 'description' => '注册API的错误码列表。'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '注册API的错误码列表。'."\n", + 'type' => 'object', + 'properties' => [ + 'ErrorMessage' => [ + 'description' => '错误信息'."\n", + 'type' => 'string', + 'example' => 'fail to call', + ], + 'ErrorCode' => [ + 'description' => '错误码'."\n", + 'type' => 'string', + 'example' => '1001', + ], + 'ErrorSolution' => [ + 'description' => '错误解决方案'."\n", + 'type' => 'string', + 'example' => 'retry', + ], + ], + ], + ], + 'RegistrationRequestParameters' => [ + 'description' => '注册API的请求参数列表。'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ParameterName' => [ + 'description' => '参数名称'."\n", + 'type' => 'string', + 'example' => 'name1', + ], + 'ParameterPosition' => [ + 'description' => '参数位置，可选枚举值有：'."\n" + ."\n" + .'- 0：Path'."\n" + .'- 1：Query'."\n" + .'- 2：Head'."\n" + .'- 3：Body'."\n" + ."\n" + .'向导和脚本API，只支持Query；注册API，GET、DELETE方法支持Query、Head，PUT、POST方法支持Query、Head、Body。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'ParameterDescription' => [ + 'description' => '描述', + 'type' => 'string', + 'example' => 'description1', + ], + 'DefaultValue' => [ + 'description' => '默认值'."\n", + 'type' => 'string', + 'example' => 'default1', + ], + 'ParameterOperator' => [ + 'description' => '运算符，可选枚举值有：'."\n" + ."\n" + .'- 0：Equal'."\n" + .'- 1：Like'."\n" + .'- 2：Const'."\n" + .'- 3：In'."\n" + ."\n" + .'向导API支持Equal、Like、In；脚本API支持Equal；注册API支持Equal、Const。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'ExampleValue' => [ + 'description' => '示例值'."\n", + 'type' => 'string', + 'example' => 'example1', + ], + 'ParameterDataType' => [ + 'description' => '数据类型，可选枚举值：'."\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', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'IsRequiredParameter' => [ + 'description' => '是否必填'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + ], + 'ScriptDetails' => [ + 'description' => '脚本API详情，只有脚本API返回。'."\n", + 'type' => 'object', + 'properties' => [ + 'IsPagedResponse' => [ + 'description' => '返回是否分页'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'SuccessfulResultSample' => [ + 'description' => '正常返回示例'."\n", + 'type' => 'string', + 'example' => '{"success": true}', + ], + 'FailedResultSample' => [ + 'description' => '错误返回示例'."\n", + 'type' => 'string', + 'example' => '{"success": false}', + ], + 'Script' => [ + 'description' => 'SQL脚本'."\n", + 'type' => 'string', + 'example' => 'select a from t', + ], + 'ScriptErrorCodes' => [ + 'description' => '脚本API错误码列表'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ErrorMessage' => [ + 'description' => '错误信息'."\n", + 'type' => 'string', + 'example' => 'fail to call', + ], + 'ErrorCode' => [ + 'description' => '错误码'."\n", + 'type' => 'string', + 'example' => '1001', + ], + 'ErrorSolution' => [ + 'description' => '错误解决方案'."\n", + 'type' => 'string', + 'example' => 'retry', + ], + ], + ], + ], + 'ScriptRequestParameters' => [ + 'description' => '脚本API请求参数列表'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ParameterName' => [ + 'description' => '参数名称'."\n", + 'type' => 'string', + 'example' => 'param1', + ], + 'ParameterPosition' => [ + 'description' => '参数位置，可选枚举值有：'."\n" + ."\n" + .'- 0：Path'."\n" + .'- 1：Query'."\n" + .'- 2：Head'."\n" + .'- 3：Body'."\n" + ."\n" + .'向导和脚本API，只支持Query；注册API，GET、DELETE方法支持Query、Head，PUT、POST方法支持Query、Head、Body。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'ParameterDescription' => [ + 'description' => '描述'."\n", + 'type' => 'string', + 'example' => 'description1', + ], + 'DefaultValue' => [ + 'description' => '默认值'."\n", + 'type' => 'string', + 'example' => 'default1', + ], + 'ParameterOperator' => [ + 'description' => '运算符，可选枚举值有：'."\n" + ."\n" + .'- 0：Equal'."\n" + .'- 1：Like'."\n" + .'- 2：Const'."\n" + .'- 3：In'."\n" + ."\n" + .'向导API支持Equal、Like、In；脚本API支持Equal；注册API支持Equal、Const。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'ExampleValue' => [ + 'description' => '示例值'."\n", + 'type' => 'string', + 'example' => 'example1', + ], + 'ParameterDataType' => [ + 'description' => '数据类型，可选枚举值：'."\n" + ."\n" + .'- 0：String'."\n" + .'- 1：Int'."\n" + .'- 2：Long'."\n" + .'- 3：Float'."\n" + .'- 4：Double'."\n" + .'- 5：Boolean'."\n" + ."\n" + .'高级脚本还有以下数据类型：'."\n" + ."\n" + .'- 6：StringList'."\n" + .'- 7：IntList'."\n" + .'- 8：LongList'."\n" + .'- 9：FloatList'."\n" + .'- 10：DoubleList'."\n" + .'- 11：BooleanList', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'IsRequiredParameter' => [ + 'description' => '是否必填'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + 'ScriptResponseParameters' => [ + 'description' => '脚本API返回参数列表'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ParameterDescription' => [ + 'description' => '描述'."\n", + 'type' => 'string', + 'example' => 'description2', + ], + 'ParameterName' => [ + 'description' => '参数名称'."\n", + 'type' => 'string', + 'example' => 'param2', + ], + 'ExampleValue' => [ + 'description' => '示例值'."\n", + 'type' => 'string', + 'example' => 'example2', + ], + 'ParameterDataType' => [ + 'description' => '数据类型，可选枚举值：'."\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', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + ], + ], + ], + 'ScriptConnection' => [ + 'description' => '脚本API数据源信息'."\n", + 'type' => 'object', + 'properties' => [ + 'TableName' => [ + 'description' => '数据源表名'."\n", + 'type' => 'string', + 'example' => 't', + ], + 'ConnectionId' => [ + 'description' => '数据源ID'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '123', + ], + ], + ], + ], + ], + 'WizardDetails' => [ + 'description' => '向导API详情，只有向导API返回。'."\n", + 'type' => 'object', + 'properties' => [ + 'IsPagedResponse' => [ + 'description' => '返回是否分页。'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'SuccessfulResultSample' => [ + 'description' => '正常返回示例。'."\n", + 'type' => 'string', + 'example' => '{"success": true}', + ], + 'FailedResultSample' => [ + 'description' => '错误返回示例。'."\n", + 'type' => 'string', + 'example' => '{"success": false}', + ], + 'WizardErrorCodes' => [ + 'description' => '向导API的错误码列表。'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ErrorMessage' => [ + 'description' => '错误信息。'."\n", + 'type' => 'string', + 'example' => 'fail to call', + ], + 'ErrorCode' => [ + 'description' => '错误码。'."\n", + 'type' => 'string', + 'example' => '1001', + ], + 'ErrorSolution' => [ + 'description' => '错误解决方案。'."\n", + 'type' => 'string', + 'example' => 'retry', + ], + ], + ], + ], + 'WizardRequestParameters' => [ + 'description' => '向导API的请求参数列表。'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ParameterName' => [ + 'description' => '参数的名称。'."\n", + 'type' => 'string', + 'example' => 'param1', + ], + 'ParameterPosition' => [ + 'description' => '参数的位置，可选枚举值包括0（Path）、1（Query）、2（Head）和3（Body）。向导和脚本API仅支持Query。注册API中的GET、DELETE方法支持Query、Head，PUT、POST方法支持Query、Head和Body。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'ParameterDescription' => [ + 'description' => '描述信息。', + 'type' => 'string', + 'example' => 'description1', + ], + 'DefaultValue' => [ + 'description' => '默认值。'."\n", + 'type' => 'string', + 'example' => 'default1', + ], + 'ParameterOperator' => [ + 'description' => '运算符，可选枚举值包括0（Equal）、1（Like）、2（Const）和3（In）。向导模式API支持Equal、Like和In，脚本模式API支持Equal，注册API支持Equal和Const。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'ExampleValue' => [ + 'description' => '示例值。'."\n", + 'type' => 'string', + 'example' => 'example1', + ], + 'ParameterDataType' => [ + 'description' => '数据类型，可选枚举值：'."\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', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'IsRequiredParameter' => [ + 'description' => '是否必填。'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + 'WizardResponseParameters' => [ + 'description' => '向导API的返回参数列表。'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ParameterDescription' => [ + 'description' => '描述信息。', + 'type' => 'string', + 'example' => 'description2', + ], + 'ParameterName' => [ + 'description' => '参数的名称。'."\n", + 'type' => 'string', + 'example' => 'param2', + ], + 'ExampleValue' => [ + 'description' => '示例值。'."\n", + 'type' => 'string', + 'example' => 'example2', + ], + 'ParameterDataType' => [ + 'description' => '数据类型，可选枚举值：'."\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', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + ], + ], + ], + 'WizardConnection' => [ + 'description' => '向导API的数据源信息。'."\n", + 'type' => 'object', + 'properties' => [ + 'TableName' => [ + 'description' => '数据源的表名称。'."\n", + 'type' => 'string', + 'example' => 't', + ], + 'ConnectionId' => [ + 'description' => '数据源ID。'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '12354', + ], + ], + ], + ], + ], + 'SqlMode' => [ + 'title' => 'SQL模式，0：基础SQL；1：高级SQL', + 'description' => 'SQL模式，0：基础SQL；1：高级SQL', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + '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' => '获取数据服务API的发布态信息列表', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' 不同类型API的详情信息通过不同字段返回。向导API使用WizardDetails字段，脚本API使用ScriptDetails字段，注册API使用RegistrationDetails字段。'."\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' => '工作空间的ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + 'example' => '10000', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '页码，从1开始，默认值为1。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'docRequired' => true, + 'minimum' => '1', + 'example' => '1', + 'default' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '每页显示的条数，默认为10条，最大50条。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'docRequired' => true, + 'maximum' => '50', + 'minimum' => '1', + 'example' => '10', + 'default' => '10', + ], + ], + [ + 'name' => 'TenantId', + 'in' => 'formData', + 'schema' => [ + 'description' => ' 该字段已废弃。租户ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'docRequired' => false, + 'example' => '10001', + ], + ], + [ + 'name' => 'ApiNameKeyword', + 'in' => 'formData', + 'schema' => [ + 'description' => 'API名称的关键词，通过过滤获取API名称包含该关键词的API。', + 'type' => 'string', + 'required' => false, + 'example' => '我的API名称', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回数据结构。', + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => [ + 'description' => 'HTTP状态码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'RequestId' => [ + 'description' => '请求ID，一次请求的唯一标识。', + 'type' => 'string', + 'example' => '0000-ABCD-EFG****', + ], + 'ErrorMessage' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => '正常', + ], + 'Success' => [ + 'description' => '调用是否成功。', + 'type' => 'boolean', + 'example' => 'Boolean', + ], + 'ErrorCode' => [ + 'description' => '错误码。', + 'type' => 'string', + 'example' => '0', + ], + 'Data' => [ + 'description' => '授权给他人的API列表。', + 'type' => 'object', + 'properties' => [ + 'PageNumber' => [ + 'description' => '页码，和请求中的PageNumber一致。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '每页显示的条数，默认为10条，最大100条。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'TotalCount' => [ + 'description' => '总记录数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '100', + ], + 'ApiAuthorizationList' => [ + 'description' => '返回数据结构。', + 'type' => 'array', + 'items' => [ + 'description' => '返回数据结构。', + 'type' => 'object', + 'properties' => [ + 'ApiStatus' => [ + 'description' => 'API的状态，可选枚举值包括0（未发布）和1（已发布）。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'ApiId' => [ + 'description' => 'API的ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10002', + ], + 'ModifiedTime' => [ + 'description' => 'API的最近更新时间。', + 'type' => 'string', + 'example' => '2020-06-23T00:21:01+0800', + ], + 'GroupId' => [ + 'description' => '分组ID。', + 'type' => 'string', + 'example' => 'ab123', + ], + 'ProjectId' => [ + 'description' => '工作空间的ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10000', + ], + 'CreatorId' => [ + 'description' => 'API负责人的阿里云ID。', + 'type' => 'string', + 'example' => '12345', + ], + 'CreatedTime' => [ + 'description' => 'API的创建时间。', + 'type' => 'string', + 'example' => '2020-06-23T00:21:01+0800', + ], + 'ApiName' => [ + 'description' => 'API的名称。', + 'type' => 'string', + 'example' => '我的API名称', + ], + 'TenantId' => [ + 'description' => '租户ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10001', + ], + 'ApiPath' => [ + 'description' => 'API的路径。', + 'type' => 'string', + 'example' => '/test/1', + ], + 'AuthorizationRecords' => [ + 'description' => '授权给他人的授权详情列表。', + 'type' => 'array', + 'items' => [ + 'description' => '返回数据结构。', + 'type' => 'object', + 'properties' => [ + 'EndTime' => [ + 'description' => '授权有效期的截止时间。', + 'type' => 'string', + 'example' => '2020-06-24T00:21:01+0800', + ], + 'CreatorId' => [ + 'description' => 'API负责人的阿里云ID。', + 'type' => 'string', + 'example' => '12345', + ], + 'CreatedTime' => [ + 'description' => '授权时间。', + 'type' => 'string', + 'example' => '2020-06-23T00:21:01+0800', + ], + 'ProjectId' => [ + 'description' => '获得授权的工作空间ID。', + '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' => '获取授权给他人的API列表', + 'summary' => '调用ListDataServiceApiAuthorities获取授权给他人的API列表。', + ], + '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' => '工作空间的ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + 'example' => '10000', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '页码，从1开始，默认值为1。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'docRequired' => true, + 'minimum' => '1', + 'example' => 'PageNumber', + 'default' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '每页显示的条数，默认为10条，最大50条。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'docRequired' => true, + 'maximum' => '50', + 'minimum' => '1', + 'example' => '10', + 'default' => '10', + ], + ], + [ + 'name' => 'TenantId', + 'in' => 'formData', + 'schema' => [ + 'description' => '该字段已废弃。租户ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'docRequired' => false, + 'example' => '10001', + ], + ], + [ + 'name' => 'ApiNameKeyword', + 'in' => 'formData', + 'schema' => [ + 'description' => 'API名称的关键词，通过过滤获取API名称包含该关键词的API。', + 'type' => 'string', + 'required' => false, + 'example' => '我的API名称', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => [ + 'description' => 'HTTP状态码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'RequestId' => [ + 'description' => '请求ID，一次请求的唯一标识。', + 'type' => 'string', + 'example' => '0000-ABCD-EFG****', + ], + 'ErrorMessage' => [ + 'description' => '错误信息', + 'type' => 'string', + 'example' => 'The specified parameters are invalid.', + ], + 'Success' => [ + 'description' => '调用是否成功。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'ErrorCode' => [ + 'description' => '错误码。', + 'type' => 'string', + 'example' => '1031203110005', + ], + 'Data' => [ + 'description' => '获得授权的API信息。', + 'type' => 'object', + 'properties' => [ + 'PageNumber' => [ + 'description' => '页码，和请求中的PageNumber一致。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '每页显示的条数，默认为10条，最大100条。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'TotalCount' => [ + 'description' => '总记录数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '100', + ], + 'ApiAuthorizedList' => [ + 'description' => '获得授权的API列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ApiId' => [ + 'description' => 'API的ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10002', + ], + 'ApiStatus' => [ + 'description' => 'API的状态，可选枚举值包括0（未发布）和1（已发布）。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'GrantOperatorId' => [ + 'description' => '授权者的阿里云ID。', + 'type' => 'string', + 'example' => '23456', + ], + 'ProjectId' => [ + 'description' => '工作空间的ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10000', + ], + 'CreatorId' => [ + 'description' => 'API负责人阿里云ID', + 'type' => 'string', + 'example' => '12345', + ], + 'GrantEndTime' => [ + 'description' => 'API的授权到期时间。', + 'type' => 'string', + 'example' => '2020-06-24T00:21:01+0800', + ], + 'ModifiedTime' => [ + 'description' => 'API的最近更新时间。', + 'type' => 'string', + 'example' => '2020-06-23T00:21:01+0800', + ], + 'GroupId' => [ + 'description' => '分组ID。', + 'type' => 'string', + 'example' => 'abcde123456789', + ], + 'GrantCreatedTime' => [ + 'description' => 'API的授权时间。', + 'type' => 'string', + 'example' => '2020-06-23T00:21:01+0800', + ], + 'CreatedTime' => [ + 'description' => 'API的创建时间。', + 'type' => 'string', + 'example' => '2020-06-23T00:21:01+0800', + ], + 'ApiName' => [ + 'description' => 'API的名称。', + 'type' => 'string', + 'example' => '我的API名称', + ], + 'TenantId' => [ + 'description' => '租户ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10001', + ], + 'ApiPath' => [ + 'description' => 'API的路径。', + 'type' => 'string', + 'example' => '/test/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 \\"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' => '获取获得授权的API信息列表', + 'summary' => '调用ListDataServiceAuthorizedApis获取获得授权的API信息列表。', + ], + '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' => '租户ID。您可登录[DataWorks控制台](https://workbench.data.aliyun.com/console)，进入数据开发（DataStudio）页面，单击右上方当前登录用户名称，选择菜单 > 用户信息，获取租户ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'docRequired' => false, + 'example' => '10002', + ], + ], + [ + 'name' => 'ProjectId', + 'in' => 'formData', + 'schema' => [ + 'description' => '工作空间的ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + 'example' => '10001', + ], + ], + [ + 'name' => 'ApiId', + 'in' => 'formData', + 'schema' => [ + 'description' => '数据服务API的ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + 'example' => '10000', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => [ + 'description' => 'HTTP状态码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Data' => [ + 'description' => '数据服务API是否下线成功。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'ErrorMessage' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'The connection does not exist.', + ], + 'RequestId' => [ + 'description' => '请求ID，一次请求的唯一标识。', + 'type' => 'string', + 'example' => '0000-ABCD-EFG****', + ], + 'ErrorCode' => [ + 'description' => '错误码。', + 'type' => 'string', + 'example' => 'Invalid.Tenant.ConnectionNotExists', + ], + 'Success' => [ + 'description' => '调用是否成功。', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + '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' => '下线数据服务API', + 'summary' => '调用AbolishDataServiceApi下线数据服务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' => '租户ID。您可登录[DataWorks控制台](https://workbench.data.aliyun.com/console)，进入数据开发（DataStudio）页面，单击右上方当前登录用户名称，选择菜单 > 用户信息，获取租户ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'docRequired' => false, + 'example' => '10002', + ], + ], + [ + 'name' => 'ProjectId', + 'in' => 'formData', + 'schema' => [ + 'description' => '工作空间的ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + 'example' => '10001', + ], + ], + [ + 'name' => 'ApplicationId', + 'in' => 'formData', + 'schema' => [ + 'description' => 'App的ID，可在API网关控制台上查看应用信息。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + 'example' => '10000', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => [ + 'description' => 'HTTP状态码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'RequestId' => [ + 'description' => '请求ID，一次请求的唯一标识。'."\n", + 'type' => 'string', + 'example' => '0000-ABCD-EFG****', + ], + 'ErrorMessage' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => '正常', + ], + 'Success' => [ + 'description' => '调用是否成功。'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'ErrorCode' => [ + 'description' => '错误码。', + 'type' => 'string', + 'example' => '0', + ], + 'Data' => [ + 'description' => 'App详情。', + 'type' => 'object', + 'properties' => [ + 'ApplicationCode' => [ + 'description' => 'API调用认证方式一，简单身份认证中的AppCode。'."\n", + 'type' => 'string', + 'example' => 'CODE123', + ], + 'ApplicationKey' => [ + 'description' => 'API调用认证方式二，加密签名身份认证中的AppKey。', + 'type' => 'string', + 'example' => 'KEY123', + ], + 'ApplicationSecret' => [ + 'description' => 'API调用认证方式二，加密签名身份认证中的AppSecret。', + 'type' => 'string', + 'example' => 'SECRET123', + ], + 'ProjectId' => [ + 'description' => '关联工作空间的ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10001', + ], + 'ApplicationName' => [ + 'description' => '应用名称。', + 'type' => 'string', + 'example' => '测试应用', + ], + 'ApplicationId' => [ + 'description' => 'App的ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10000', + ], + ], + ], + ], + ], + ], + ], + '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' => '查询数据服务App的详情', + 'summary' => '调用GetDataServiceApplication查询数据服务App的详情。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => 'ApplicationCode或ApplicationSecre参数的泄露会威胁您数据服务API资源的安全，本OpenAPI会对ApplicationCode和ApplicationSecre参数进行脱敏后再返回。', + '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' => '页码，从1开始，默认值为1。'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'docRequired' => true, + 'minimum' => '1', + 'example' => '1', + 'default' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'formData', + 'schema' => [ + 'description' => '每页显示的条数，默认为10条，最大50条。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'docRequired' => true, + 'maximum' => '50', + 'minimum' => '1', + 'example' => '10', + 'default' => '10', + ], + ], + [ + 'name' => 'ProjectIdList', + 'in' => 'formData', + 'schema' => [ + 'description' => '指定工作空间ID查询应用。支持多值，多值之间使用英文逗号（,）分隔。最少指定1个工作空间ID，最多指定50个工作空间ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '10000,100001', + ], + ], + [ + 'name' => 'TenantId', + 'in' => 'formData', + 'schema' => [ + 'description' => '租户ID。您可登录[DataWorks控制台](https://workbench.data.aliyun.com/console)，进入数据开发（DataStudio）页面，单击右上方当前登录用户名称，选择菜单 > 用户信息，获取租户ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'docRequired' => false, + 'example' => '100002', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => [ + 'description' => 'HTTP状态码。'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'RequestId' => [ + 'description' => '请求ID，一次请求的唯一标识。'."\n", + 'type' => 'string', + 'example' => '0000-ABCD-EFG***', + ], + 'ErrorMessage' => [ + 'description' => '错误信息。'."\n", + 'type' => 'string', + 'example' => '正常', + ], + 'Success' => [ + 'description' => '调用是否成功。'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'ErrorCode' => [ + 'description' => '错误码。'."\n", + 'type' => 'string', + 'example' => '0', + ], + 'Data' => [ + 'description' => '查询得到的应用基础信息。', + 'type' => 'object', + 'properties' => [ + 'PageNumber' => [ + 'description' => '页码，和请求中的PageNumber一致。'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '每页显示的条数，默认为10条，最大100条。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'TotalCount' => [ + 'description' => '总记录数。'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '100', + ], + 'Applications' => [ + 'description' => '应用的基础信息列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ApplicationName' => [ + 'description' => '应用的名称。', + 'type' => 'string', + 'example' => '我的应用', + ], + 'ApplicationId' => [ + 'description' => '应用ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '20000', + ], + 'ProjectId' => [ + 'description' => '工作空间的ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10000', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + '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' => '获取数据服务应用的基础信息列表', + 'summary' => '调用ListDataServiceApplications获取数据服务应用的基础信息列表。', + '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' => '租户ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'docRequired' => false, + 'maximum' => '9223372036854775807', + 'minimum' => '1', + 'example' => '10002', + ], + ], + [ + 'name' => 'ProjectId', + 'in' => 'formData', + 'schema' => [ + 'description' => '工作空间的ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + 'maximum' => '9223372036854775807', + 'minimum' => '1', + 'example' => '10001', + ], + ], + [ + 'name' => 'FolderName', + 'in' => 'formData', + 'schema' => [ + 'description' => '文件夹的名称。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '测试文件夹', + ], + ], + [ + 'name' => 'ParentId', + 'in' => 'formData', + 'schema' => [ + 'description' => '文件夹的目标父文件夹ID。业务流程根文件夹ID等于0，用户创建的文件夹ID大于0。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + 'maximum' => '9223372036854775807', + 'minimum' => '0', + 'example' => '0', + ], + ], + [ + 'name' => 'GroupId', + 'in' => 'formData', + 'schema' => [ + 'description' => '文件夹的目标业务流程ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '1000abcd', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'FolderId' => [ + 'description' => '创建的文件夹ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '123', + ], + 'RequestId' => [ + 'description' => '请求ID，一次请求的唯一标识。'."\n", + 'type' => 'string', + 'example' => '0000-ABCD-E****', + ], + ], + ], + ], + ], + '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' => '创建数据服务文件夹', + 'summary' => '调用CreateDataServiceFolder创建数据服务文件夹。', + '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' => '该字段已废弃。租户ID。您可登录[DataWorks控制台](https://workbench.data.aliyun.com/console)，进入数据开发（DataStudio）页面，单击右上方当前登录用户名称，选择菜单 > 用户信息，获取租户ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'docRequired' => false, + 'maximum' => '9223372036854775807', + 'minimum' => '1', + 'example' => '10003', + ], + ], + [ + 'name' => 'ProjectId', + 'in' => 'formData', + 'schema' => [ + 'description' => '工作空间的ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + 'maximum' => '9223372036854775807', + 'minimum' => '1', + 'example' => '10002', + ], + ], + [ + 'name' => 'FolderId', + 'in' => 'formData', + 'schema' => [ + 'description' => '文件夹的ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + 'maximum' => '9223372036854775807', + 'minimum' => '1', + 'example' => '10001', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回数据。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID，一次请求的唯一标识。'."\n", + 'type' => 'string', + 'example' => '0000-ABCD-EF****', + ], + 'Folder' => [ + 'description' => '文件夹详情。', + 'type' => 'object', + 'properties' => [ + 'ParentId' => [ + 'description' => '父文件夹ID。业务流程下根文件夹ID等于0，用户创建文件夹ID大于0。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'ModifiedTime' => [ + 'description' => '文件夹的编辑时间。', + 'type' => 'string', + 'example' => '2020-09-24T18:37:51+0800', + ], + 'GroupId' => [ + 'description' => '文件夹所属业务流程的ID。', + 'type' => 'string', + 'example' => 'ds_1234', + ], + 'FolderId' => [ + 'description' => '文件夹的ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '11', + ], + 'ProjectId' => [ + 'description' => '工作空间的ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10001', + ], + 'FolderName' => [ + 'description' => '文件夹的名称。', + 'type' => 'string', + 'example' => 'test1', + ], + 'CreatedTime' => [ + 'description' => '文件夹的创建时间。', + 'type' => 'string', + 'example' => '2020-09-24T18:37:51+0800', + ], + 'TenantId' => [ + 'description' => '租户ID。', + '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' => '查询数据服务文件夹', + 'summary' => '调用GetDataServiceFolder查询数据服务文件夹。', + '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' => '页码，从1开始。默认值为1。'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'docRequired' => true, + 'maximum' => '2147483647', + 'minimum' => '1', + 'example' => '1', + 'default' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'formData', + 'schema' => [ + 'description' => '每页显示的条数，默认为10条，最大50条。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'docRequired' => true, + 'maximum' => '50', + 'minimum' => '1', + 'example' => '10', + 'default' => '10', + ], + ], + [ + 'name' => 'ProjectId', + 'in' => 'formData', + 'schema' => [ + 'description' => '工作空间的ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + 'maximum' => '9223372036854775807', + 'minimum' => '1', + 'example' => '10001', + ], + ], + [ + 'name' => 'TenantId', + 'in' => 'formData', + 'schema' => [ + 'description' => '租户ID。您可登录[DataWorks控制台](https://workbench.data.aliyun.com/console)，进入数据开发（DataStudio）页面，单击右上方当前登录用户名称，选择菜单 > 用户信息，获取租户ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'docRequired' => false, + 'maximum' => '9223372036854775807', + 'minimum' => '1', + 'example' => '10002', + ], + ], + [ + 'name' => 'GroupId', + 'in' => 'formData', + 'schema' => [ + 'description' => '指定文件夹所属业务流程的ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'ds_123abc', + ], + ], + [ + 'name' => 'FolderNameKeyword', + 'in' => 'formData', + 'schema' => [ + 'description' => '文件夹名称关键词，可以进行子串匹配。', + 'type' => 'string', + 'required' => false, + 'example' => '文件夹名称关键词', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID，一次请求的唯一标识。'."\n", + 'type' => 'string', + 'example' => '0000-ABCD-EF****', + ], + 'FolderPagingResult' => [ + 'description' => '文件夹列表的分页结果。', + 'type' => 'object', + 'properties' => [ + 'PageNumber' => [ + 'description' => '页码，和请求中的PageNumber一致。'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '每页显示的条数，默认为10条，最大100条。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'TotalCount' => [ + 'description' => '总记录数。'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '100', + ], + 'Folders' => [ + 'description' => '文件夹列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ParentId' => [ + 'description' => '父文件夹的ID。业务流程下根文件夹ID等于0，用户创建文件夹ID大于0。'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'ModifiedTime' => [ + 'description' => '文件夹的编辑时间。'."\n", + 'type' => 'string', + 'example' => '2020-09-24T18:37:51+0800', + ], + 'GroupId' => [ + 'description' => '文件夹所属业务流程的ID。'."\n", + 'type' => 'string', + 'example' => 'ds_1234', + ], + 'FolderId' => [ + 'description' => '文件夹的ID。'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '11', + ], + 'FolderName' => [ + 'description' => '文件夹的名称。'."\n", + 'type' => 'string', + 'example' => 'test1', + ], + 'ProjectId' => [ + 'description' => '工作空间ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10001', + ], + 'CreatedTime' => [ + 'description' => '文件夹的创建时间。'."\n", + 'type' => 'string', + 'example' => '2020-09-24T18:37:51+0800', + ], + 'TenantId' => [ + 'description' => '租户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 \\"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' => '查询数据服务文件夹列表', + 'summary' => '调用ListDataServiceFolders查询数据服务文件夹列表。', + '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' => '该字段已废弃。租户ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'docRequired' => false, + 'maximum' => '9223372036854775807', + 'minimum' => '1', + 'example' => '10002', + ], + ], + [ + 'name' => 'ProjectId', + 'in' => 'formData', + 'schema' => [ + 'description' => '工作空间的ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + 'maximum' => '9223372036854775807', + 'minimum' => '1', + 'example' => '10001', + ], + ], + [ + 'name' => 'ApiGatewayGroupId', + 'in' => 'formData', + 'schema' => [ + 'description' => '业务流程绑定的API网关分组ID，您可以进入API网关控制台分组详情页面进行查看。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '1000abcd', + ], + ], + [ + 'name' => 'GroupName', + 'in' => 'formData', + 'schema' => [ + 'description' => '业务流程的名称。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '业务流程名称', + ], + ], + [ + 'name' => 'Description', + 'in' => 'formData', + 'schema' => [ + 'description' => '业务流程的描述。', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => '测试业务流程', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'GroupId' => [ + 'description' => '创建的业务流程ID。', + 'type' => 'string', + 'example' => 'ds_12345', + ], + 'RequestId' => [ + 'description' => '请求ID，一次请求的唯一标识。'."\n", + 'type' => 'string', + 'example' => '0000-ABCD-EF****', + ], + ], + ], + ], + ], + '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' => '创建数据服务业务流程', + 'summary' => '调用CreateDataServiceGroup创建数据服务业务流程。', + ], + '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' => '该字段已废弃。租户ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'docRequired' => false, + 'maximum' => '9223372036854775807', + 'minimum' => '1', + 'example' => '10001', + ], + ], + [ + 'name' => 'ProjectId', + 'in' => 'formData', + 'schema' => [ + 'description' => '工作空间的ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + 'maximum' => '9223372036854775807', + 'minimum' => '1', + 'example' => '10002', + ], + ], + [ + 'name' => 'GroupId', + 'in' => 'formData', + 'schema' => [ + 'description' => '业务流程的ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ds_123abc', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID，一次请求的唯一标识。', + 'type' => 'string', + 'example' => '0000-ABCD-EF****', + ], + 'Group' => [ + 'description' => '业务流程详情。', + 'type' => 'object', + 'properties' => [ + 'ModifiedTime' => [ + 'description' => '编辑时间。', + 'type' => 'string', + 'example' => '2020-09-24T18:37:51+0800', + ], + 'Description' => [ + 'description' => '业务流程的描述。', + 'type' => 'string', + 'example' => '业务流程描述', + ], + 'GroupName' => [ + 'description' => '业务流程名称。', + 'type' => 'string', + 'example' => '业务流程名称', + ], + 'GroupId' => [ + 'description' => '业务流程ID。', + 'type' => 'string', + 'example' => 'ds_123abc', + ], + 'ProjectId' => [ + 'description' => '工作空间ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10002', + ], + 'ApiGatewayGroupId' => [ + 'description' => '业务流程绑定的API网关分组ID。', + 'type' => 'string', + 'example' => '100abc', + ], + 'CreatorId' => [ + 'description' => ' '."\n" + .'创建人UID，部分历史业务流程创建人的UID可能为空。', + 'type' => 'string', + 'example' => '10001', + ], + 'CreatedTime' => [ + 'description' => '业务流程的创建时间。', + 'type' => 'string', + 'example' => '2020-09-24T18:37:51+0800', + ], + 'TenantId' => [ + 'description' => '租户ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10003', + ], + ], + ], + ], + ], + ], + ], + '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' => '查询数据服务业务流程', + 'summary' => '调用GetDataServiceGroup查询数据服务业务流程。', + ], + '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' => '页码，从1开始，默认值为1。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'docRequired' => true, + 'maximum' => '2147483647', + 'minimum' => '1', + 'example' => '1', + 'default' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'formData', + 'schema' => [ + 'description' => '每页显示的条数，默认为10条，最大50条。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'docRequired' => true, + 'maximum' => '50', + 'minimum' => '1', + 'example' => '10', + 'default' => '10', + ], + ], + [ + 'name' => 'ProjectId', + 'in' => 'formData', + 'schema' => [ + 'description' => '工作空间的ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + 'maximum' => '9223372036854775807', + 'minimum' => '1', + 'example' => '10000', + ], + ], + [ + 'name' => 'TenantId', + 'in' => 'formData', + 'schema' => [ + 'description' => '该字段已废弃。租户ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'docRequired' => false, + 'maximum' => '9223372036854775807', + 'minimum' => '1', + 'example' => '10001', + ], + ], + [ + 'name' => 'GroupNameKeyword', + 'in' => 'formData', + 'schema' => [ + 'description' => '业务流程名称关键词，可以进行子串匹配。', + 'type' => 'string', + 'required' => false, + 'example' => '测试业务流程', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID，一次请求的唯一标识。'."\n" + ."\n", + 'type' => 'string', + 'example' => '0000-ABCD-EF****', + ], + 'GroupPagingResult' => [ + 'description' => '业务流程的分页结果。', + 'type' => 'object', + 'properties' => [ + 'PageNumber' => [ + 'description' => '页码，和请求中的PageNumber一致。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '每页显示的条数，默认为10条，最大100条。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'TotalCount' => [ + 'description' => '总记录数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '100', + ], + 'Groups' => [ + 'description' => '业务流程列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ModifiedTime' => [ + 'description' => '业务流程的编辑时间。', + 'type' => 'string', + 'example' => '2020-09-24T18:37:51+0800', + ], + 'Description' => [ + 'description' => '业务流程的描述。', + 'type' => 'string', + 'example' => '业务流程描述', + ], + 'GroupName' => [ + 'description' => '业务流程名称。', + 'type' => 'string', + 'example' => '业务流程名称', + ], + 'GroupId' => [ + 'description' => '业务流程的ID。', + 'type' => 'string', + 'example' => 'ds_123abc', + ], + 'ProjectId' => [ + 'description' => '工作空间的ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10002', + ], + 'ApiGatewayGroupId' => [ + 'description' => '业务流程绑定的API网关分组ID。', + 'type' => 'string', + 'example' => '100abc', + ], + 'CreatorId' => [ + 'description' => '创建人UID，部分历史业务流程的创建人UID可能为空。', + 'type' => 'string', + 'example' => '10001', + ], + 'CreatedTime' => [ + 'description' => '业务流程的创建时间。', + 'type' => 'string', + 'example' => '2020-09-24T18:37:51+0800', + ], + 'TenantId' => [ + 'description' => '租户ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10003', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + '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' => '查询数据服务业务流程列表', + 'summary' => '调用ListDataServiceGroups查询数据服务业务流程列表。', + ], + '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' => '租户ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'docRequired' => false, + 'maximum' => '9223372036854775807', + 'minimum' => '1', + 'example' => '1004', + ], + ], + [ + 'name' => 'ProjectId', + 'in' => 'formData', + 'schema' => [ + 'description' => '工作空间的ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + 'maximum' => '9223372036854775807', + 'minimum' => '1', + 'example' => '10003', + ], + ], + [ + 'name' => 'ApiId', + 'in' => 'formData', + 'schema' => [ + 'description' => 'API的ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + 'maximum' => '9223372036854775807', + 'minimum' => '1', + 'example' => '10001', + ], + ], + [ + 'name' => 'AuthorizedProjectId', + 'in' => 'formData', + 'schema' => [ + 'description' => '被授权的工作空间ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + 'maximum' => '9223372036854775807', + 'minimum' => '1', + 'example' => '10002', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'formData', + 'schema' => [ + 'description' => '授权有限期结束时间，Unix时间戳，单位为s。例如1600531564，代表北京时间2020-09-20 00:06:04。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + 'maximum' => '9223372036854775807', + 'minimum' => '1', + 'example' => '1600531564', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Success' => [ + 'description' => '授权是否成功。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'RequestId' => [ + 'description' => '请求ID，一次请求的唯一标识。'."\n", + 'type' => 'string', + 'example' => '0000-ABCD-EF****', + ], + ], + ], + ], + ], + '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' => '新增数据服务API授权', + 'summary' => '调用CreateDataServiceApiAuthority新增数据服务API授权。', + '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' => ' 该字段已废弃。租户的ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'docRequired' => false, + 'maximum' => '9223372036854775807', + 'minimum' => '1', + 'example' => '10001', + ], + ], + [ + 'name' => 'ProjectId', + 'in' => 'formData', + 'schema' => [ + 'description' => '工作空间的ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + 'maximum' => '9223372036854775807', + 'minimum' => '1', + 'example' => '10002', + ], + ], + [ + 'name' => 'ApiId', + 'in' => 'formData', + 'schema' => [ + 'description' => 'API的ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + 'maximum' => '9223372036854775807', + 'minimum' => '1', + 'example' => '10003', + ], + ], + [ + 'name' => 'AuthorizedProjectId', + 'in' => 'formData', + 'schema' => [ + 'description' => '被取消授权的工作空间ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + 'maximum' => '9223372036854775807', + 'minimum' => '1', + 'example' => '10004', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Success' => [ + 'description' => '取消授权是否成功。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'RequestId' => [ + 'description' => '请求ID，一次请求的唯一标识。', + 'type' => 'string', + 'example' => '0000-ABCD-EF****', + ], + ], + ], + ], + ], + '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' => '取消数据服务API授权', + 'summary' => '调用DeleteDataServiceApiAuthority取消数据服务API授权。', + ], + 'ListDataServiceApiTest' => [ + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'ApiId', + 'in' => 'query', + 'schema' => [ + 'description' => '测试API Id', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + 'example' => '12345', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '分页大小，最大100', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'description' => '返回消息', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求Id', + 'type' => 'string', + 'example' => 'ESDAFWEA', + ], + 'Data' => [ + 'description' => '数据列表', + 'type' => 'array', + 'items' => [ + 'description' => '数据对象', + 'type' => 'object', + 'properties' => [ + 'TestId' => [ + 'description' => '测试Id', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '123', + ], + 'ApiId' => [ + 'description' => '测试API Id', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2343', + ], + 'ParamMap' => [ + 'description' => '测试API请求参数', + 'type' => 'string', + 'example' => '{"name":"test"}', + ], + 'RetCode' => [ + 'description' => '测试API返回code，如果未完成，该数据为空', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'RetResult' => [ + 'description' => '返回数据', + 'type' => 'string', + 'example' => '{"id":2}', + ], + 'CostTime' => [ + 'description' => 'API请求花费的时间', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'Status' => [ + 'description' => '任务是否已经完成，包含：RUNNING，FINISHED', + 'type' => 'string', + 'example' => 'FINISHED', + ], + 'CreateTime' => [ + 'description' => '任务创建时间', + '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' => '列出数据服务API测试记录', + 'summary' => '列出数据服务API测试记录，只能查询最近一个月数据。', + ], + 'TestDataServiceApi' => [ + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'ApiId', + 'in' => 'query', + 'schema' => [ + 'description' => 'API Id', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + 'example' => '12343', + ], + ], + [ + 'name' => 'QueryParam', + 'in' => 'formData', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '放在Query里面的请求参数', + 'type' => 'array', + 'items' => [ + 'description' => '请求对象', + 'type' => 'object', + 'properties' => [ + 'ParamKey' => [ + 'description' => '参数名称', + 'type' => 'string', + 'required' => false, + 'example' => 'name', + ], + 'ParamValue' => [ + 'description' => '参数值', + 'type' => 'string', + 'required' => false, + 'example' => 'test', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 500, + ], + ], + [ + 'name' => 'BodyParams', + 'in' => 'formData', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '放在请求Body的参数信息', + 'type' => 'array', + 'items' => [ + 'description' => '请求对象', + 'type' => 'object', + 'properties' => [ + 'ParamKey' => [ + 'description' => '参数名称', + 'type' => 'string', + 'required' => false, + 'example' => 'name', + ], + 'ParamValue' => [ + 'description' => '参数值', + 'type' => 'string', + 'required' => false, + 'example' => 'test', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 500, + ], + ], + [ + 'name' => 'PathParams', + 'in' => 'formData', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '放在Path里面的请求参数', + 'type' => 'array', + 'items' => [ + 'description' => '请求对象', + 'type' => 'object', + 'properties' => [ + 'ParamKey' => [ + 'description' => '参数名称', + 'type' => 'string', + 'required' => false, + 'example' => 'path1', + ], + 'ParamValue' => [ + 'description' => '参数值', + 'type' => 'string', + 'required' => false, + 'example' => 'api', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 500, + ], + ], + [ + 'name' => 'HeadParams', + 'in' => 'formData', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '放在Header里面的请求参数', + 'type' => 'array', + 'items' => [ + 'description' => '请求对象', + 'type' => 'object', + 'properties' => [ + 'ParamKey' => [ + 'description' => '参数名称', + 'type' => 'string', + 'required' => false, + 'example' => 'requestId', + ], + 'ParamValue' => [ + 'description' => '参数值', + 'type' => 'string', + 'required' => false, + 'example' => 'abcd', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 500, + ], + ], + [ + 'name' => 'BodyContent', + 'in' => 'formData', + 'schema' => [ + 'description' => '请求body数据', + 'type' => 'string', + 'required' => false, + 'example' => '{"name":"test"}', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回对象', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求id', + 'type' => 'string', + 'example' => 'abdsfewe', + ], + 'Data' => [ + 'description' => '返回对象', + 'type' => 'object', + 'properties' => [ + 'TestId' => [ + 'description' => '测试Id', + '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' => '测试数据服务API', + 'summary' => '测试API，异步测试，需要GetDataServiceApiTest接口获取测试结果。', + ], + 'GetDataServiceApiTest' => [ + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'TestId', + 'in' => 'query', + 'schema' => [ + 'description' => '测试Id。TestDataServiceApi接口调用以后异步执行，同时返回测试Id。也可以通过ListDataServiceApiTest获取最近的测试Id。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + 'example' => '123434', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'description' => '返回对象', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求Id', + 'type' => 'string', + 'example' => 'adssd****', + ], + 'Data' => [ + 'description' => '返回对象', + 'type' => 'object', + 'properties' => [ + 'ApiId' => [ + 'description' => '测试API Id'."\n" + ."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '12343', + ], + 'ParamMap' => [ + 'description' => '测试API请求参数'."\n" + ."\n", + 'type' => 'string', + 'example' => '{"name":"test"}', + ], + 'RetCode' => [ + 'description' => ' '."\n" + .'测试API返回code，如果未完成，该数据为空', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'RetResult' => [ + 'description' => '返回数据'."\n" + ."\n", + 'type' => 'string', + 'example' => '{"id":2}', + ], + 'DebugInfo' => [ + 'description' => 'Debug信息', + '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' => '耗时', + 'type' => 'string', + 'example' => '10', + ], + 'NodesDebugInfo' => [ + 'description' => '节点Debug信息', + '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' => '任务是否已经完成，包含：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>[<span style=\\\\\\"color: #92D581;\\\\\\">INFO</span>] [16:15:13.240] resource group is 498774069027041[<span style=\\\\\\"color: #92D581;\\\\\\">INFO</span>]</DebugInfo>\\n <CostTime>10</CostTime>\\n <NodesDebugInfo>[<span style=\\\\\\"color: #92D581;\\\\\\">INFO</span>] [16:15:13.240] resource group is 498774069027041[<span style=\\\\\\"color: #92D581;\\\\\\">INFO</span>]</NodesDebugInfo>\\n <Status>FINISHED</Status>\\n </Data>\\n</GetDataServiceApiTestResponse>","errorExample":""}]', + 'title' => '获取API测试结果', + 'summary' => '获取API测试结果。', + ], + 'SubmitDataServiceApi' => [ + 'summary' => 'SubmitDataServiceApi用于提交数据服务API。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '157978', + 'abilityTreeNodes' => [ + 'FEATUREdideZZ63WZ', + ], + ], + 'parameters' => [ + [ + 'name' => 'TenantId', + 'in' => 'formData', + 'schema' => [ + 'description' => '租户ID。您可以登录[数据服务](https://ds-cn-shanghai.data.aliyun.com/)，点击账号名称，查看用户信息，获取租户ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '10001', + ], + ], + [ + 'name' => 'ProjectId', + 'in' => 'formData', + 'schema' => [ + 'description' => 'DataWorks工作空间的ID。您可以登录[DataWorks管控台](https://workbench.data.aliyun.com/console)，进入工作空间配置页面获取工作空间ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '10000', + ], + ], + [ + 'name' => 'ApiId', + 'in' => 'formData', + 'schema' => [ + 'description' => 'API的ID。您可以通过调用[ListDataServiceApis](~~2780261~~)接口获取。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '12345', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID，一次请求的唯一标识。'."\n", + 'type' => 'string', + 'example' => '0000-ABCD-EFG****', + ], + 'HttpStatusCode' => [ + 'description' => 'HTTP状态码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Data' => [ + 'description' => '提交是否成功。取值如下：'."\n" + .'- true：成功。'."\n" + .'- false：失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'ErrorCode' => [ + 'description' => '错误码。', + 'type' => 'string', + 'example' => 'Invalid.Tenant.ConnectionNotExists', + ], + 'Success' => [ + 'description' => '调用是否成功。', + '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' => '提交数据服务API', + ], + 'SaveDataServiceApiTestResult' => [ + 'summary' => '该接口用于保存API测试的结果。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '169364', + 'abilityTreeNodes' => [ + 'FEATUREdideNC84FD', + ], + ], + 'parameters' => [ + [ + 'name' => 'ApiId', + 'in' => 'formData', + 'schema' => [ + 'description' => 'API的ID。您可以通过调用[ListDataServiceApis](~~174012~~)接口获取。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '417381955954827', + ], + ], + [ + 'name' => 'ProjectId', + 'in' => 'formData', + 'schema' => [ + 'description' => 'DataWorks工作空间的ID。您可以登录[DataWorks控制台](https://workbench.data.aliyun.com/console)，进入工作空间配置页面获取工作空间ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '10001', + ], + ], + [ + 'name' => 'ResultSample', + 'in' => 'formData', + 'schema' => [ + 'description' => '非必填参数，API测试成功的结果示例。', + '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' => '非必填参数，API测试失败的结果示例。', + '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' => '是否使用系统自动生成结果，如果不传resultSample/failResultSample参数，则使用系统默认生成的。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID，一次请求的唯一标识。', + 'type' => 'string', + 'example' => '0000-ABCD-EF***** ', + ], + 'Data' => [ + 'description' => '是否成功保存测试结果。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Success' => [ + 'description' => '调用是否成功。'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'HttpStatusCode' => [ + 'description' => 'HTTP状态码。', + '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' => '保存API测试结果', + ], + 'GetOpSensitiveData' => [ + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => [ + 'description' => ' 获取访问记录的条件设置。可选的参数如下：'."\n" + .'- dbType：数据类型。'."\n" + .'- instanceName：实例名称。'."\n" + .'- databaseName：数据库名称。'."\n" + .'- projectName：项目名称。'."\n" + .'- clusterName：集群名称。'."\n" + ."\n" + .'示例获取Hologres中ABC实例的abc数据库的敏感数据访问记录：'."\n" + .'[ {"dbType":"hologres","instanceName":"ABC","databaseName":"abc"} ]'."\n" + ."\n" + .'实际使用时，您需要根据业务使用的引擎进行配置。'."\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' => '每页展示的数据量，最小值为1，最大值为1000。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'docRequired' => true, + 'maximum' => '1000', + 'minimum' => '1', + 'example' => '1', + ], + ], + [ + 'name' => 'PageNo', + 'in' => 'query', + 'schema' => [ + 'description' => '页码数。最小值为1，最大值为1000。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'docRequired' => true, + 'maximum' => '1000', + 'minimum' => '1', + 'example' => '10', + ], + ], + [ + 'name' => 'Date', + 'in' => 'query', + 'schema' => [ + 'description' => '获取访问记录的日期。格式为：yyyyMMdd。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '20210116', + ], + ], + [ + 'name' => 'OpType', + 'in' => 'query', + 'schema' => [ + 'description' => '用户对数据的操作类型。取值如下：'."\n" + .'- SQL_SELECT，访问行为。例如，使用SELECT查询数据。'."\n" + .'- TUNNEL_DOWNLOAD，导出行为。例如，下载数据。', + 'type' => 'string', + 'required' => false, + 'example' => 'SQL_SELECT', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回对象', + 'type' => 'object', + 'properties' => [ + 'OpSensitiveData' => [ + 'description' => '返回的敏感数据记录信息。包括totalCount（敏感数据总条数）和opRiskDatas（风险数据列表）。'."\n" + .'其中opRiskDatas（风险数据列表）包括：'."\n" + .'- sensType：敏感类型。'."\n" + .'- sensLevel：敏感级别（数字越大表示敏感程度越高）。'."\n" + .'- opType：操作类型。'."\n" + .'- sql：操作执行的sql语句。'."\n" + .'- opAccount：执行操作的账号。'."\n" + .'- opTime：执行操作的时间。', + '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 = '1331111****';" } ], "totalCount": 6', + ], + 'RequestId' => [ + 'description' => '请求ID，一次请求的唯一标识。', + '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 = '1331111****';\\\\\\" } ], \\\\\\"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 = &#39;1331111****&#39;;\\" } ], \\"totalCount\\": 6</OpSensitiveData>\\n <RequestId>0000-ABCD-EFG****</RequestId>\\n</GetOpSensitiveDataResponse>","errorExample":""}]', + 'title' => '获取敏感数据访问记录', + 'summary' => '获取租户下所有DataWorks工作空间指定日期的敏感数据访问记录。', + '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' => '输入的待脱敏数据。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '15365291784', + ], + ], + [ + 'name' => 'SceneCode', + 'in' => 'formData', + 'schema' => [ + 'description' => '脱敏场景码。您可以进入DataWorks管控台的数据保护伞，在数据脱敏管理页面查看。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '_default_scene_code', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'DesensitizeData' => [ + 'description' => '脱敏后的结果数据。', + 'type' => 'string', + 'example' => '{ "desensData": "**198807120510**" }', + ], + 'RequestId' => [ + 'description' => '请求ID，一次请求的唯一标识。', + 'type' => 'string', + 'example' => 'BCA321BA-46C5-40E9-8A08-6******', + ], + ], + ], + ], + ], + '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' => '数据脱敏', + 'summary' => '输入待脱敏数据，返回脱敏后的结果数据。', + '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' => '每页返回的数据量，最大值为1000。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'docRequired' => true, + 'maximum' => '1000', + 'minimum' => '1', + 'example' => '10', + ], + ], + [ + 'name' => 'PageNo', + 'in' => 'query', + 'schema' => [ + 'description' => '页码数，最小值为1。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'docRequired' => true, + 'maximum' => '1000', + 'minimum' => '1', + 'example' => '1', + ], + ], + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => [ + 'description' => '获取访问记录的条件设置。可选的参数如下：'."\n" + .'- dbType：数据类型。'."\n" + .'- instanceName：实例名称。'."\n" + .'- databaseName：数据库名称。'."\n" + .'- projectName：项目名称。'."\n" + .'- clusterName：集群名称。'."\n" + ."\n" + .'示例获取Hologres中ABC实例的abc数据库的敏感数据访问记录：'."\n" + .'[ {"dbType":"hologres","instanceName":"ABC","databaseName":"abc"} ]'."\n" + ."\n" + .'实际使用时，您需要根据业务使用的引擎进行配置。', + 'type' => 'string', + 'required' => false, + 'example' => '[ {"dbType":"hologres","instanceName":"ABC","databaseName":"abc"}, {"dbType":"ODPS.ODPS","projectName":"adbc"} ]', + ], + ], + [ + 'name' => 'Date', + 'in' => 'query', + 'schema' => [ + 'description' => '获取访问记录的日期。格式为：yyyyMMdd。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '20210221', + ], + ], + [ + 'name' => 'RiskType', + 'in' => 'query', + 'schema' => [ + 'description' => '指通过什么方式识别风险类型。取值如下：'."\n" + .'- 手工识别。'."\n" + .'- 风险规则名称，您可以进入DataWorks的数据保护伞，在风险识别管理页面获取。', + 'type' => 'string', + 'required' => false, + 'example' => 'Manual identification', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回参数', + 'type' => 'object', + 'properties' => [ + 'RiskData' => [ + 'description' => '返回的有风险的敏感数据信息。包括totalCount（敏感数据总条数）和opRiskDatas（风险数据列表）。'."\n" + .'其中opRiskDatas（风险数据列表）包括：'."\n" + .'- sensType：敏感类型。'."\n" + .'- sensLevel：敏感级别。'."\n" + .'- opType：操作类型。'."\n" + .'- sql：操作执行的sql语句。'."\n" + .'- opAccount：执行操作的账号。'."\n" + .'- opTime：执行操作的时间。', + 'type' => 'string', + 'example' => '{ "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 }', + ], + 'RequestId' => [ + 'description' => '请求ID，一次请求的唯一标识。', + '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' => '获取有风险的敏感数据访问记录', + 'summary' => '获取租户下所有DataWorks工作空间指定日期中有风险的敏感数据访问记录。', + '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' => '每页返回的数据量，最大值为1000。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'docRequired' => true, + 'maximum' => '1000', + 'minimum' => '1', + 'example' => '1000', + ], + ], + [ + 'name' => 'PageNo', + 'in' => 'query', + 'schema' => [ + 'description' => '页码数，最小值为1。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'docRequired' => true, + 'maximum' => '1000', + 'minimum' => '1', + 'example' => '1', + ], + ], + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => [ + 'description' => '获取访问记录的条件设置。可选的参数如下：'."\n" + .'- dbType：数据类型。'."\n" + .'- instanceName：实例名称。'."\n" + .'- databaseName：数据库名称。'."\n" + .'- projectName：项目名称。'."\n" + .'- clusterName：集群名称。'."\n" + ."\n" + .'示例获取Hologres中ABC实例的abc数据库的敏感数据访问记录。实际使用时，您需要根据业务使用的引擎进行配置。'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '[ {"dbType":"hologres","instanceName":"ABC","databaseName":"abc"}, {"dbType":"ODPS.ODPS","projectName":"adbc"} ]', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回参数', + 'type' => 'object', + 'properties' => [ + 'SensitiveData' => [ + 'description' => '返回的敏感数据信息。包括totalCount（敏感数据总条数）和sensDatas（敏感数据列表）。'."\n" + .'其中sensDatas（敏感数据列表）包括：'."\n" + .'- guid：租户元数据的唯一id，例如ODPS.ODPS类型数据的guid由project.table.column组成。'."\n" + .'- sensType：敏感类型。'."\n" + .'- sensLevel：敏感级别。', + 'type' => 'object', + 'example' => '{ "sensDatas": [ { "sensLevel": "L1", "guid": "dsg_demo.animal.dog", "sensType": "姓名" } ], "totalCount": 2171 }', + ], + 'RequestId' => [ + 'description' => '请求ID，一次请求的唯一标识。', + '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' => '获取敏感数据', + 'summary' => '调用GetSensitiveData，获取租户下所有DataWorks工作空间的最新敏感数据识别结果。', + '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' => '待识别的数据。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '13900001234', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回对象', + 'type' => 'object', + 'properties' => [ + 'Sensitives' => [ + 'description' => '识别出的敏感数据信息。'."\n" + .'sensDatas表示识别出的敏感数据规则列表，包括：'."\n" + .'- hitCount：命中率，该数据命中规则的次数。'."\n" + .'- ruleName：规则名称。', + 'type' => 'object', + 'example' => '{ "sensDatas": [ { "hitCount": 1, "ruleName": "手机号" } ] }', + ], + 'RequestId' => [ + 'description' => '请求ID，一次请求的唯一标识。', + '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' => '扫描敏感数据', + 'summary' => '调用ScanSensitiveData识别输入数据中是否存在敏感数据。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DsgQuerySensResult' => [ + 'summary' => '该接口用于获取数据保护伞的敏感数据识别结果。', + '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' => '租户ID。您可登录[DataWorks控制台](https://workbench.data.aliyun.com/console)，进入数据开发（DataStudio）页面，单击右上方当前登录用户名称，选择菜单 > 用户信息，获取租户ID。', + 'type' => 'string', + 'required' => true, + 'example' => '10241024', + ], + ], + [ + 'name' => 'DbType', + 'in' => 'formData', + 'schema' => [ + 'description' => '数据库类型，取值为：'."\n" + .'- **ODPS.ODPS**'."\n" + .'- **HOLO.POSTGRES**'."\n" + .'- **EMR**', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [], + 'example' => 'ODPS.ODPS', + ], + ], + [ + 'name' => 'ProjectName', + 'in' => 'formData', + 'schema' => [ + 'description' => 'DataWorks工作空间的名称。您可以登录[DataWorks控制台](https://workbench.data.aliyun.com/console)，进入工作空间配置页面获取工作空间名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'project', + ], + ], + [ + 'name' => 'SchemaName', + 'in' => 'formData', + 'schema' => [ + 'description' => 'Schema名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'schema', + ], + ], + [ + 'name' => 'Table', + 'in' => 'formData', + 'schema' => [ + 'description' => '表名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'table', + ], + ], + [ + 'name' => 'Col', + 'in' => 'formData', + 'schema' => [ + 'description' => '字段名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'col', + ], + ], + [ + 'name' => 'NodeName', + 'in' => 'formData', + 'schema' => [ + 'description' => '分类节点名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'Personal information', + ], + ], + [ + 'name' => 'Level', + 'in' => 'formData', + 'schema' => [ + 'description' => '敏感字段等级。', + 'type' => 'string', + 'required' => false, + 'example' => '3', + ], + ], + [ + 'name' => 'SensStatus', + 'in' => 'formData', + 'schema' => [ + 'description' => '字段敏感状态：'."\n" + ."\n" + .'- 1：敏感'."\n" + .'- -1：非敏感', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [], + 'example' => '1', + ], + ], + [ + 'name' => 'SensitiveId', + 'in' => 'formData', + 'schema' => [ + 'description' => '敏感字段ID。', + 'type' => 'string', + 'required' => false, + 'example' => '10241024', + ], + ], + [ + 'name' => 'SensitiveName', + 'in' => 'formData', + 'schema' => [ + 'description' => '敏感字段名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'name', + ], + ], + [ + 'name' => 'Order', + 'in' => 'formData', + 'schema' => [ + 'description' => '排序方式：'."\n" + .'- DESC：降序。'."\n" + .'- ASC：升序。', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [], + 'example' => 'DESC', + ], + ], + [ + 'name' => 'OrderField', + 'in' => 'formData', + 'schema' => [ + 'description' => '用于排序的字段：'."\n" + .'- gmt_create'."\n" + .'- gmt_modified', + 'type' => 'string', + 'required' => false, + 'example' => 'gmt_create', + ], + ], + [ + 'name' => 'PageNo', + 'in' => 'formData', + 'schema' => [ + 'description' => '页码数，最小值为1。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'formData', + 'schema' => [ + 'description' => '每页显示的条数，默认为10条，最大为20条。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'OpenApiResultModel', + 'description' => '返回数据。', + 'type' => 'object', + 'properties' => [ + 'Success' => [ + 'description' => '调用是否成功。'."\n" + .'- true：成功。'."\n" + .'- false：失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'ErrorCode' => [ + 'description' => '错误码。'."\n" + ."\n", + 'type' => 'string', + 'example' => '400', + ], + 'ErrorMessage' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'Missing parameter', + ], + 'HttpStatusCode' => [ + 'description' => 'HTTP返回码。'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '400', + ], + 'Data' => [ + 'description' => '返回数据。', + 'type' => 'any', + 'example' => '1234', + ], + 'RequestId' => [ + 'description' => '请求ID，一次请求的唯一标识。'."\n", + 'type' => 'string', + 'example' => '900000001', + ], + 'DynamicErrorCode' => [ + 'description' => '错误码。取值同ErrorCode。', + 'type' => 'string', + 'example' => '400', + ], + 'DynamicErrorMessage' => [ + 'description' => '错误信息。取值同ErrorMessage。', + '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' => '获取敏感数据识别结果', + 'description' => '该API功能对应数据保护伞控制台界面的查询功能，通过与租户ID关联，获取指定租户的敏感数据识别结果。'."\n" + .'- 支持根据数据源类型、项目空间等维度进行筛选。'."\n" + .'- 支持对某个字段进行升降序排序。'."\n" + .'- 支持分页查询。', + ], + 'QueryDefaultTemplate' => [ + 'summary' => '调用QueryDefaultTemplate接口查询数据保护伞定义的默认分类分级模板。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '212265', + 'abilityTreeNodes' => [ + 'FEATUREdideBVSRMP', + ], + ], + 'parameters' => [ + [ + 'name' => 'TenantId', + 'in' => 'formData', + 'schema' => [ + 'description' => '租户ID。您可登录[DataWorks控制台](https://workbench.data.aliyun.com/console)，进入数据开发（DataStudio）页面，单击右上方当前登录用户名称，选择菜单 > 用户信息，获取租户ID。', + 'type' => 'string', + 'required' => true, + 'example' => '1024102', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'OpenApiResultModel', + 'description' => '返回数据。', + 'type' => 'object', + 'properties' => [ + 'Success' => [ + 'description' => '调用是否成功。取值如下：'."\n" + .'- true：调用成功。'."\n" + .'- false：调用失败。', + 'type' => 'boolean', + 'required' => true, + 'example' => 'true', + ], + 'ErrorCode' => [ + 'description' => '错误码。', + 'type' => 'string', + 'required' => true, + 'example' => '9990030003', + 'default' => 'null', + ], + 'ErrorMessage' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'required' => true, + 'example' => 'Parameter error', + 'default' => 'null', + ], + 'HttpStatusCode' => [ + 'description' => 'HTTP状态码。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '400', + ], + 'Data' => [ + 'description' => '返回的默认分类分级模板数据。JSON格式。', + 'type' => 'any', + 'required' => true, + 'example' => '[{"gmtModified":1709022365000,"fileName":"default file","isDelete":false,"isDefaultTemplate":true}]', + ], + 'RequestId' => [ + 'description' => '请求的ID。用于定位日志，排查问题。', + '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' => '查询默认分类分级模板', + ], + 'DsgStopSensIdentify' => [ + 'summary' => '调用DsgStopSensIdentify接口，停止数据保护伞定义的分类分级敏感数据识别任务。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'abilityTreeCode' => '213660', + 'abilityTreeNodes' => [ + 'FEATUREdide1B7LSC', + ], + ], + 'parameters' => [ + [ + 'name' => 'TenantId', + 'in' => 'formData', + 'schema' => [ + 'description' => '租户ID。您可登录[DataWorks控制台](https://workbench.data.aliyun.com/console)，进入数据开发（DataStudio）页面，单击右上方当前登录用户名称，选择菜单 > 用户信息，获取租户ID。', + 'type' => 'string', + 'required' => true, + 'example' => '10241024', + ], + ], + [ + 'name' => 'JobId', + 'in' => 'formData', + 'schema' => [ + 'description' => '数据保护伞的识别任务ID。可通过调用[DsgRunSensIdentify](~~2744039~~)接口获取。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1000001', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'OpenApiResultModel', + 'description' => '返回数据。', + 'type' => 'object', + 'properties' => [ + 'Success' => [ + 'description' => '调用是否成功。'."\n" + .'- true：成功。'."\n" + .'- false：失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'ErrorCode' => [ + 'description' => '错误码。', + 'type' => 'string', + 'example' => '9990030003', + ], + 'ErrorMessage' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'Missing parameter', + ], + 'HttpStatusCode' => [ + 'description' => 'HTTP状态码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Data' => [ + 'description' => '返回数据，布尔型。', + 'type' => 'any', + 'example' => 'true', + ], + 'RequestId' => [ + 'description' => '请求ID，一次请求的唯一标识。', + 'type' => 'string', + 'example' => '10000111', + ], + ], + ], + ], + ], + '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' => '停止分类分级敏感数据识别任务', + ], + 'QuerySensClassification' => [ + 'summary' => '调用QuerySensClassification接口，查询数据保护伞分类分级中的分类节点。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '212270', + 'abilityTreeNodes' => [ + 'FEATUREdideBVSRMP', + ], + ], + 'parameters' => [ + [ + 'name' => 'TemplateId', + 'in' => 'formData', + 'schema' => [ + 'description' => '数据保护伞定义的模板ID。可通过调用[QueryDefaultTemplate](~~2743948~~)接口获取。', + 'type' => 'string', + 'required' => true, + 'example' => 'e1970541-6cf5-4d23-b101-d5b66****', + ], + ], + [ + 'name' => 'TenantId', + 'in' => 'formData', + 'schema' => [ + 'description' => '租户ID。您可登录[DataWorks控制台](https://workbench.data.aliyun.com/console)，进入数据开发（DataStudio）页面，单击右上方当前登录用户名称，选择菜单 > 用户信息，获取租户ID。', + 'type' => 'string', + 'required' => true, + 'example' => '10241024', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'OpenApiResultModel', + 'description' => '返回数据。', + 'type' => 'object', + 'properties' => [ + 'Success' => [ + 'description' => '调用是否成功。'."\n" + .'- true：成功。'."\n" + .'- false：失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'ErrorCode' => [ + 'description' => '错误码。', + 'type' => 'string', + 'example' => '9990030003', + ], + 'ErrorMessage' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'Missing parameter', + ], + 'HttpStatusCode' => [ + 'description' => 'HTTP状态码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '400', + ], + 'Data' => [ + 'description' => '返回的数据保护伞分类分级中的分类节点信息。JSON格式。', + 'type' => 'any', + 'example' => '[{ "nodeName": "teset1", "sensitiveNotNull": true, "nodeId": "1aac2e35-b437-486b-95c7-a5ae48371024", "nodeOldId": "1aac2e35-b437-486b-95c7-a5ae48371024", "parentId": "0" }]', + ], + 'RequestId' => [ + 'description' => '请求ID，一次请求的唯一标识。', + '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' => '查询分类分级中的分类节点', + ], + 'QuerySensLevel' => [ + 'summary' => '调用QuerySensLevel接口，查询在数据保护伞定义的敏感数据等级。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '212269', + 'abilityTreeNodes' => [ + 'FEATUREdidePQ4SAC', + ], + ], + 'parameters' => [ + [ + 'name' => 'TemplateId', + 'in' => 'formData', + 'schema' => [ + 'description' => '数据保护伞定义的模板ID。可通过调用[QueryDefaultTemplate](~~2743948~~)接口获取。', + 'type' => 'string', + 'required' => true, + 'example' => 'e1970541-6cf5-4d23-b101-d5b6****', + ], + ], + [ + 'name' => 'tenantId', + 'in' => 'formData', + 'schema' => [ + 'description' => '租户ID。您可登录[DataWorks控制台](https://workbench.data.aliyun.com/console)，进入数据开发（DataStudio）页面，单击右上方当前登录用户名称，选择菜单 > 用户信息，获取租户ID。', + 'type' => 'string', + 'required' => true, + 'example' => '10241024', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'OpenApiResultModel', + 'description' => '返回数据。', + 'type' => 'object', + 'properties' => [ + 'Success' => [ + 'description' => '调用是否成功。'."\n" + .'- true：成功。'."\n" + .'- false：失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'ErrorCode' => [ + 'description' => '错误码。', + 'type' => 'string', + 'example' => '9990030003', + ], + 'ErrorMessage' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'Missing parameter', + ], + 'HttpStatusCode' => [ + 'description' => 'HTTP状态码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Data' => [ + 'description' => '返回的数据保护伞定义的敏感数据等级。JSON数组格式。', + 'type' => 'any', + 'example' => '[{"level":1,"isSensitive":false,"levelName":"1level"},{"level":2,"isSensitive":false,"levelName":"2level"}]', + ], + 'RequestId' => [ + 'description' => '请求ID，一次请求的唯一标识。', + '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' => '查询敏感数据等级', + ], + 'QueryRecognizeRulesType' => [ + 'summary' => '调用QueryRecognizeRulesType接口，查询数据保护伞定义的敏感字段内置识别规则类型。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '212274', + 'abilityTreeNodes' => [ + 'FEATUREdideDCM5VK', + ], + ], + 'parameters' => [], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'OpenApiResultModel', + 'description' => '返回数据。', + 'type' => 'object', + 'properties' => [ + 'Success' => [ + 'description' => '调用是否成功。'."\n" + .'- true：成功。'."\n" + .'- false：失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'ErrorCode' => [ + 'description' => '错误码。', + 'type' => 'string', + 'example' => '9990030002', + ], + 'ErrorMessage' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'Missing parameter', + ], + 'HttpStatusCode' => [ + 'description' => 'HTTP状态码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Data' => [ + 'description' => '返回的敏感字段内置识别规则类型，JSON格式。', + 'type' => 'any', + 'example' => '{ "HttpStatusCode": 200, "Data": [ { "Regular Expression": "1" }, { "Recognize Rule": "2" }, { "Sample Library": "3" }, { "Model": "4" } ], "Success": true }', + ], + 'RequestId' => [ + 'description' => '请求ID，一次请求的唯一标识。', + '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' => '查询敏感字段内置识别规则类型', + ], + 'DsgRunSensIdentify' => [ + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'abilityTreeCode' => '212734', + 'abilityTreeNodes' => [ + 'FEATUREdide1B7LSC', + ], + ], + 'parameters' => [ + [ + 'name' => 'TenantId', + 'in' => 'formData', + 'schema' => [ + 'description' => '租户ID。您可登录[DataWorks控制台](https://workbench.data.aliyun.com/console)，进入数据开发（DataStudio）页面，单击右上方当前登录用户名称，选择菜单 > 用户信息，获取租户ID。', + 'type' => 'string', + 'required' => true, + 'example' => '10241024', + ], + ], + [ + 'name' => 'EsMetaParams', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'description' => '指定元数据扫描的参数对象列表。', + 'type' => 'array', + 'items' => [ + 'description' => '指定元数据扫描的参数对象。', + 'type' => 'object', + 'properties' => [ + 'DbType' => [ + 'description' => '数据源类型，取值如下：'."\n" + .'- ODPS.ODPS'."\n" + .'- EMR'."\n" + .'- HOLO.POSTGRES', + 'type' => 'string', + 'required' => false, + 'example' => 'ODPS.ODPS', + ], + 'ClusterId' => [ + 'description' => '集群ID。根据您自己的数据源集群获取。', + 'type' => 'string', + 'required' => false, + 'example' => '101010', + ], + 'ProjectName' => [ + 'description' => 'DataWorks工作空间的名称。您可以登录[DataWorks控制台](https://workbench.data.aliyun.com/console)，进入工作空间配置页面获取工作空间名称。', + 'type' => 'string', + 'required' => false, + 'example' => '16666767566****', + ], + 'SchemaName' => [ + 'description' => 'Schema名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'default', + ], + 'TableName' => [ + 'description' => '表名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'table1', + ], + 'TableNameList' => [ + 'description' => '表名称列表。', + 'type' => 'array', + 'items' => [ + 'description' => '表名称列表内容。', + 'type' => 'string', + 'required' => false, + 'example' => 'table1,table2', + ], + 'required' => false, + ], + 'User' => [ + 'description' => '操作者的用户名。建议填写您的阿里云账号名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'xxx-uat', + ], + 'InstanceId' => [ + 'description' => '实例ID。根据您的数据源获取。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => 'hgprecn-cn-9lb37k****', + ], + ], + 'required' => false, + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'DataWorksResult', + 'description' => '返回数据。', + 'type' => 'object', + 'properties' => [ + 'ErrorCode' => [ + 'description' => '错误码。', + 'type' => 'string', + 'example' => '9990030003', + ], + 'ErrorMessage' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'Missing parameter', + ], + 'Success' => [ + 'description' => '调用是否成功。取值如下：'."\n" + .'- true：调用成功。'."\n" + .'- false：调用失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Data' => [ + 'description' => '生成的敏感数据识别任务的任务ID。INT 64类型。', + 'type' => 'any', + 'example' => '1000001', + ], + 'HttpStatusCode' => [ + 'description' => 'HTTP状态码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '400', + ], + 'RequestId' => [ + 'description' => '请求的ID。用于定位日志，排查问题。', + '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' => ' 启动敏感数据识别任务', + 'summary' => '调用DsgRunSensIdentify接口启动一个数据保护伞的敏感数据识别任务。', + ], + 'DeleteRecognizeRule' => [ + 'summary' => '调用DeleteRecognizeRule接口，删除在数据保护伞定义的分类分级规则。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'abilityTreeCode' => '212271', + 'abilityTreeNodes' => [ + 'FEATUREdideDCM5VK', + ], + ], + 'parameters' => [ + [ + 'name' => 'SensitiveId', + 'in' => 'formData', + 'schema' => [ + 'description' => '敏感字段ID。可通过调用[QuerySensNodeInfo](~~2747189~~)接口获取。', + 'type' => 'string', + 'required' => true, + 'example' => '27f5f5e2-ec60-4567-b1e4-77****4', + ], + ], + [ + 'name' => 'TenantId', + 'in' => 'formData', + 'schema' => [ + 'description' => '租户ID。您可登录[DataWorks控制台](https://workbench.data.aliyun.com/console)，进入数据开发（DataStudio）页面，单击右上方当前登录用户名称，选择菜单 > 用户信息，获取租户ID。', + 'type' => 'string', + 'required' => true, + 'example' => '10241023', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'OpenApiResultModel', + 'description' => '返回数据。', + 'type' => 'object', + 'properties' => [ + 'Success' => [ + 'description' => '调用是否成功。'."\n" + .'- true：成功。'."\n" + .'- false：失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'ErrorCode' => [ + 'description' => '错误码。', + 'type' => 'string', + 'example' => '9990030003', + ], + 'ErrorMessage' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'Missing parameter', + ], + 'HttpStatusCode' => [ + 'description' => 'HTTP状态码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Data' => [ + 'description' => '返回数据：是否删除成功。', + 'type' => 'any', + 'example' => '{ "HttpStatusCode": 200, "Success": true }', + ], + 'RequestId' => [ + 'description' => '请求ID，一次请求的唯一标识。', + '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' => '删除分类分级规则', + ], + 'QuerySensNodeInfo' => [ + 'summary' => '调用QuerySensNodeInfo接口查询数据保护伞的分类分级识别规则。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'abilityTreeCode' => '217792', + 'abilityTreeNodes' => [ + 'FEATUREdideDCM5VK', + ], + ], + 'parameters' => [ + [ + 'name' => 'TemplateId', + 'in' => 'formData', + 'schema' => [ + 'description' => '分类分级模板ID。可通过调用[QueryDefaultTemplate](~~2743948~~)接口获取。', + 'type' => 'string', + 'required' => true, + 'example' => 'e1970541-6cf5-4d23-b101-d5b****', + ], + ], + [ + 'name' => 'TenantId', + 'in' => 'formData', + 'schema' => [ + 'description' => '租户ID。您可登录[DataWorks控制台](https://workbench.data.aliyun.com/console)，进入数据开发（DataStudio）页面，单击右上方当前登录用户名称，选择菜单 > 用户信息，获取租户ID。', + 'type' => 'string', + 'required' => true, + 'example' => '10241024', + ], + ], + [ + 'name' => 'NodeId', + 'in' => 'formData', + 'schema' => [ + 'description' => '分类分级节点ID。可通过调用[QuerySensClassification](~~2746850~~)接口获取，或登录[DataWorks控制台](https://workbench.data.aliyun.com/console)，进入数据保护伞界面直接获取。', + 'type' => 'string', + 'required' => false, + 'example' => '0ce67949-0810-400f-a24a-cc5ffafe1024', + ], + ], + [ + 'name' => 'SensitiveName', + 'in' => 'formData', + 'schema' => [ + 'description' => '敏感字段名称。您可登录[DataWorks控制台](https://workbench.data.aliyun.com/console)，进入数据保护伞界面直接获取。', + 'type' => 'string', + 'required' => false, + 'example' => 'ID card', + ], + ], + [ + 'name' => 'PageNo', + 'in' => 'formData', + 'schema' => [ + 'description' => '分页查询页码数。取值：从1开始。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'formData', + 'schema' => [ + 'description' => '分页查询每页显示的条数。取值：10~1000，建议大小为10~100。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'status', + 'in' => 'formData', + 'schema' => [ + 'description' => '敏感字段的状态。取值如下：'."\n" + .'- 0：草稿态。'."\n" + .'- 1：发布态。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'OpenApiResultModel', + 'description' => '返回数据。', + 'type' => 'object', + 'properties' => [ + 'Success' => [ + 'description' => '调用是否成功。'."\n" + .'- true：成功。'."\n" + .'- false：失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'ErrorCode' => [ + 'description' => '错误码。', + 'type' => 'string', + 'example' => '9990030003', + ], + 'ErrorMessage' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'Missing parameter', + ], + 'HttpStatusCode' => [ + 'description' => 'HTTP状态码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Data' => [ + 'description' => '返回的JSON格式业务数据。', + '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' => '请求ID，一次请求的唯一标识。', + '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' => ' 查询分类分级识别规则', + ], + 'AddRecognizeRule' => [ + 'summary' => '调用AddRecognizeRule接口新增数据保护伞分类分级定义的敏感字段。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'abilityTreeCode' => '212268', + 'abilityTreeNodes' => [ + 'FEATUREdideBVSRMP', + ], + ], + 'parameters' => [ + [ + 'name' => 'TenantId', + 'in' => 'formData', + 'schema' => [ + 'description' => '租户ID。您可登录[DataWorks控制台](https://workbench.data.aliyun.com/console)，进入数据开发（DataStudio）页面，单击右上方当前登录用户名称，选择菜单 > 用户信息，获取租户ID。', + 'type' => 'string', + 'required' => true, + 'example' => '10241024', + ], + ], + [ + 'name' => 'AccountName', + 'in' => 'formData', + 'schema' => [ + 'description' => '创建敏感数据识别规则的阿里云用户。此处填写用户名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'dsg-uat', + ], + ], + [ + 'name' => 'SensitiveName', + 'in' => 'formData', + 'schema' => [ + 'description' => '自定义的敏感字段名称。输入长度小于128的字符串。', + 'type' => 'string', + 'required' => true, + 'example' => 'name', + ], + ], + [ + 'name' => 'TemplateId', + 'in' => 'formData', + 'schema' => [ + 'description' => '模板ID。调用[QueryDefaultTemplate](~~2743948~~)接口获取当前默认的模板ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'e1970541-6cf5-4d23-b101-****', + ], + ], + [ + 'name' => 'NodeId', + 'in' => 'formData', + 'schema' => [ + 'description' => '分类结点ID。可调用[QuerySensClassification](~~2746850~~)接口获取所有结点ID，选择一个结点新建敏感字段。此处输入所选的结点ID。', + 'type' => 'string', + 'required' => true, + 'example' => '0ce67949-0810-400f-a24a-****', + ], + ], + [ + 'name' => 'NodeParent', + 'in' => 'formData', + 'schema' => [ + 'description' => '分类结点的父结点信息。可调用[QuerySensClassification](~~2746850~~)接口获取。', + 'type' => 'string', + 'required' => true, + 'example' => 'Customer/personal/personal_Natural _Information/personal basic_profile_information', + ], + ], + [ + 'name' => 'Level', + 'in' => 'formData', + 'schema' => [ + 'description' => '敏感字段分级。根据模板定义的分级信息，选择其中一级作为新增敏感字段的等级。例如1~10级。', + 'type' => 'string', + 'required' => true, + 'example' => '1', + ], + ], + [ + 'name' => 'LevelName', + 'in' => 'formData', + 'schema' => [ + 'description' => '分级名称。可调用[QueryDefaultTemplate](~~2743948~~)接口，获取所选分级在模板中对应的分级名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'Confidential', + ], + ], + [ + 'name' => 'SensitiveDescription', + 'in' => 'formData', + 'schema' => [ + 'description' => '敏感字段描述。长度小于128的字符串。', + 'type' => 'string', + 'required' => false, + 'example' => 'This is a sensitive field that identifies the name.', + ], + ], + [ + 'name' => 'OperationType', + 'in' => 'formData', + 'schema' => [ + 'description' => '运算类型。取值如下：'."\n" + .'- 0：或'."\n" + .'- 1：与', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '0', + ], + ], + [ + 'name' => 'RecognizeRulesType', + 'in' => 'formData', + 'schema' => [ + 'description' => '敏感数据识别规则类型：'."\n" + .'- 1：正则表达式。'."\n" + .'- 2：内置规则。'."\n" + .'- 3：样本库。'."\n" + .'- 4：自生成模型。', + 'type' => 'string', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'RecognizeRules', + 'in' => 'formData', + 'schema' => [ + 'description' => '敏感数据识别规则内容。可调用[QuerySensNodeInfo](~~2747189~~)接口，参考内置规则同字段的配置。', + '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' => '内容识别。可通过调用[QuerySensNodeInfo](~~2747189~~)接口，参考内置规则的同字段配置。', + 'type' => 'string', + 'required' => false, + 'example' => '{"_clazz":"com.alipay.dsgclient.sdk.dsg.fastscan.engine.cond.NationalityCond"}', + ], + ], + [ + 'name' => 'HitThreshold', + 'in' => 'formData', + 'schema' => [ + 'description' => '命中阈值。若抽样数据中，超过阈值百分比（例如，60%）的数据命中NER模型，则认为命中该敏感字段。取值：0~100之间的整数。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '50', + ], + ], + [ + 'name' => 'ColScan', + 'in' => 'formData', + 'schema' => [ + 'description' => '字段扫描，仅识别赋值的字段。'."\n" + .'- 取值格式：${项目空间}.${表名}.${字段名}或${项目空间}.${SCHEMA}.${表名}.${字段名}。'."\n" + .'- 支持*通配符，如default.table.column1*可以匹配default.table.column10等*后面的任意内容。', + 'type' => 'string', + 'required' => false, + 'example' => 'default.qujian.*', + ], + ], + [ + 'name' => 'ColExclude', + 'in' => 'formData', + 'schema' => [ + 'description' => '字段排除，即不识别赋值的字段。'."\n" + .'- 取值格式：${项目空间}.${表名}.${字段名}或${项目空间}.${SCHEMA}.${表名}.${字段名}。'."\n" + .'- 支持*通配符，如default.table.column1*可以匹配default.table.column10等*后面的任意内容。', + 'type' => 'string', + 'required' => false, + 'example' => 'default.qujian.*6', + ], + ], + [ + 'name' => 'CommentScan', + 'in' => 'formData', + 'schema' => [ + 'description' => '内容扫描。取值为您的数据资产中每个字段注释信息的文本，支持模糊匹配。', + 'type' => 'string', + 'required' => false, + 'example' => 'test', + ], + ], + [ + 'name' => 'Status', + 'in' => 'formData', + 'schema' => [ + 'description' => '敏感字段的生效状态。取值如下：'."\n" + .'- 0：草稿。'."\n" + .'- 1：生效。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'OpenApiResultModel', + 'description' => '返回数据。', + 'type' => 'object', + 'properties' => [ + 'Success' => [ + 'description' => '调用是否成功。'."\n" + .'- true：成功。'."\n" + .'- false：失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'ErrorCode' => [ + 'description' => '错误码。', + 'type' => 'string', + 'example' => '9990030003', + ], + 'ErrorMessage' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'Missing parameter', + ], + 'HttpStatusCode' => [ + 'description' => 'HTTP状态码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Data' => [ + 'description' => '返回结果，JSON格式数据。', + 'type' => 'any', + 'example' => '{ "HttpStatusCode": 200, "Success": true }', + ], + 'RequestId' => [ + 'description' => '请求ID，一次请求的唯一标识。', + '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' => '新增分类分级定义的敏感字段', + ], + 'EditRecognizeRule' => [ + 'summary' => '调用EditRecognizeRule接口编辑数据保护伞分类分级定义的敏感字段。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '212267', + 'abilityTreeNodes' => [ + 'FEATUREdideDCM5VK', + ], + ], + 'parameters' => [ + [ + 'name' => 'TenantId', + 'in' => 'formData', + 'schema' => [ + 'description' => '租户ID。您可登录[DataWorks控制台](https://workbench.data.aliyun.com/console)，进入数据开发（DataStudio）页面，单击右上方当前登录用户名称，选择菜单 > 用户信息，获取租户ID。', + 'type' => 'string', + 'required' => true, + 'example' => '102410000', + ], + ], + [ + 'name' => 'AccountName', + 'in' => 'formData', + 'schema' => [ + 'description' => '新建敏感数据识别规则的阿里云用户。此处填写用户名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'dsg-uat', + ], + ], + [ + 'name' => 'SensitiveId', + 'in' => 'formData', + 'schema' => [ + 'description' => '敏感字段ID。可调用[QuerySensNodeInfo](~~2747189~~)接口获取全量敏感字段ID，或调用[QueryRecognizeRuleDetail](~~2766023~~)接口查询特定敏感字段ID。', + 'type' => 'string', + 'required' => true, + 'example' => '1a928de7-3962-4e07-93ac-e1973baa1024', + ], + ], + [ + 'name' => 'SensitiveName', + 'in' => 'formData', + 'schema' => [ + 'description' => '自定义的敏感字段名称。输入长度小于128的字符串。', + 'type' => 'string', + 'required' => true, + 'example' => 'name', + ], + ], + [ + 'name' => 'NodeId', + 'in' => 'formData', + 'schema' => [ + 'description' => '分类结点ID。可调用[QuerySensClassification](~~2746850~~)接口获取所有结点ID，选择一个结点新建敏感字段。此处输入所选的结点ID。', + 'type' => 'string', + 'required' => true, + 'example' => '0ce67949-0810-400f-a24a-cc5ffafe1024', + ], + ], + [ + 'name' => 'NodeParent', + 'in' => 'formData', + 'schema' => [ + 'description' => '分类结点的父结点信息。可调用[QuerySensClassification](~~2746850~~)接口获取。', + 'type' => 'string', + 'required' => true, + 'example' => 'Customer/personal/personal_Natural_Information/personal_basic_profile_information', + ], + ], + [ + 'name' => 'TemplateId', + 'in' => 'formData', + 'schema' => [ + 'description' => '模板ID。调用[QueryDefaultTemplate](~~2743948~~)接口获取当前默认的模板ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'e1970541-6cf5-4d23-b101-d5b66f6e1024', + ], + ], + [ + 'name' => 'level', + 'in' => 'formData', + 'schema' => [ + 'description' => '敏感字段分级。根据模板定义的分级信息，选择其中一级作为新增敏感字段的等级。例如1~10级。', + 'type' => 'string', + 'required' => true, + 'example' => '1', + ], + ], + [ + 'name' => 'LevelName', + 'in' => 'formData', + 'schema' => [ + 'description' => '分级名称。可调用[QueryDefaultTemplate](~~2743948~~)接口，获取所选分级在模板中对应的分级名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'Confidential', + ], + ], + [ + 'name' => 'SensitiveDescription', + 'in' => 'formData', + 'schema' => [ + 'description' => '敏感字段描述。长度小于128的字符串。', + 'type' => 'string', + 'required' => false, + 'example' => 'This is a sensitive field that identifies the name.', + ], + ], + [ + 'name' => 'Status', + 'in' => 'formData', + 'schema' => [ + 'description' => '敏感字段的生效状态。取值如下：'."\n" + .'- 0：草稿。'."\n" + .'- 1：生效。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + ], + ], + [ + 'name' => 'OperationType', + 'in' => 'formData', + 'schema' => [ + 'description' => '运算类型。取值如下：'."\n" + .'- 0：或'."\n" + .'- 1：与', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '0', + ], + ], + [ + 'name' => 'RecognizeRulesType', + 'in' => 'formData', + 'schema' => [ + 'description' => '敏感数据识别规则类型：'."\n" + .'- 1：正则表达式。'."\n" + .'- 2：内置规则。'."\n" + .'- 3：样本库。'."\n" + .'- 4：自生成模型。', + 'type' => 'string', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'RecognizeRules', + 'in' => 'formData', + 'schema' => [ + 'description' => '敏感数据识别规则内容。可调用[QuerySensNodeInfo](~~2747189~~)接口，参考内置规则同字段的配置。', + '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' => '内容识别。可通过调用[QuerySensNodeInfo](~~2747189~~)接口，参考内置规则的同字段配置。', + 'type' => 'string', + 'required' => false, + 'example' => '{"_clazz":"com.alipay.dsgclient.sdk.dsg.fastscan.engine.cond.NationalityCond"}', + ], + ], + [ + 'name' => 'ColScan', + 'in' => 'formData', + 'schema' => [ + 'description' => '字段扫描，仅识别赋值的字段。'."\n" + .'- 取值格式：${项目空间}.${表名}.${字段名}或${项目空间}.${SCHEMA}.${表名}.${字段名}。'."\n" + .'- 支持*通配符，如default.table.column1*可以匹配default.table.column10等*后面的任意内容。', + 'type' => 'string', + 'required' => false, + 'example' => 'default.qujian.*', + ], + ], + [ + 'name' => 'ColExclude', + 'in' => 'formData', + 'schema' => [ + 'description' => '字段排除，即不识别赋值的字段。'."\n" + .'- 取值格式：${项目空间}.${表名}.${字段名}或${项目空间}.${SCHEMA}.${表名}.${字段名}。'."\n" + .'- 支持*通配符，如default.table.column1*可以匹配default.table.column10等*后面的任意内容。', + 'type' => 'string', + 'required' => false, + 'example' => 'default.qujian.*6', + ], + ], + [ + 'name' => 'CommentScan', + 'in' => 'formData', + 'schema' => [ + 'description' => '内容扫描。取值为您的数据资产中每个字段注释信息的文本，支持模糊匹配。', + 'type' => 'string', + 'required' => false, + 'example' => 'test', + ], + ], + [ + 'name' => 'HitThreshold', + 'in' => 'formData', + 'schema' => [ + 'description' => '命中阈值。若抽样数据中，超过阈值百分比（例如，60%）的数据命中NER模型，则认为命中该敏感字段。取值：0~100之间的整数。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '50', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'OpenApiResultModel', + 'description' => '返回数据。', + 'type' => 'object', + 'properties' => [ + 'Success' => [ + 'description' => '调用是否成功。'."\n" + .'- true：成功。'."\n" + .'- false：失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'ErrorCode' => [ + 'description' => '错误码。', + 'type' => 'string', + 'example' => '9990030003', + ], + 'ErrorMessage' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'Missing parameter', + ], + 'HttpStatusCode' => [ + 'description' => 'HTTP状态码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Data' => [ + 'description' => '返回结果，JSON格式数据。', + 'type' => 'any', + 'example' => '{ "HttpStatusCode": 200, "Success": true }', + ], + 'RequestId' => [ + 'description' => '请求ID，一次请求的唯一标识。', + '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' => '编辑分类分级定义的敏感字段', + ], + 'QueryRecognizeDataByRuleType' => [ + 'summary' => '调用QueryRecognizeDataByRuleType接口获取数据保护伞的敏感字段识别方式列表。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '212273', + 'abilityTreeNodes' => [ + 'FEATUREdideDCM5VK', + ], + ], + 'parameters' => [ + [ + 'name' => 'RecognizeRulesType', + 'in' => 'formData', + 'schema' => [ + 'description' => '识别规则类型。可调用[QueryRecognizeRulesType](~~2746905~~)接口获取规则的类型。'."\n" + .'- 1：正则表达式'."\n" + .'- 2：内置模型'."\n" + .'- 3：样本库'."\n" + .'- 4：自生成模型', + 'type' => 'string', + 'required' => true, + 'example' => '2', + ], + ], + [ + 'name' => 'TenantId', + 'in' => 'formData', + 'schema' => [ + 'description' => '租户ID。您可登录[DataWorks控制台](https://workbench.data.aliyun.com/console)，进入数据开发（DataStudio）页面，单击右上方当前登录用户名称，选择菜单 > 用户信息，获取租户ID。', + 'type' => 'string', + 'required' => true, + 'example' => '10241024', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'DataWorksResult', + 'description' => '返回数据。', + 'type' => 'object', + 'properties' => [ + 'ErrorCode' => [ + 'description' => '错误码。', + 'type' => 'string', + 'example' => '9990030003', + ], + 'ErrorMessage' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'Missing parameter', + ], + 'Success' => [ + 'description' => '调用是否成功。'."\n" + .'- true：成功。'."\n" + .'- false：失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Data' => [ + 'description' => '返回数据：JSON格式。', + 'type' => 'any', + 'example' => '[{"custom": false, "name": "EducationDegree", "localeName": "EducationDegree", "templateJsonStr": "{"_clazz":"com.alipay.dsgclient.sdk.dsg.fastscan.engine.cond.EducationDegreeCond"}", "desc": ""}]', + ], + 'HttpStatusCode' => [ + 'description' => 'HTTP状态码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'RequestId' => [ + 'description' => '请求的ID。用于定位日志，排查问题。', + 'type' => 'string', + 'example' => '100000012', + ], + ], + ], + ], + ], + '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\\\\\\": \\\\\\"{"_clazz":"com.alipay.dsgclient.sdk.dsg.fastscan.engine.cond.EducationDegreeCond"}\\\\\\", \\\\\\"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\\": \\"{&quot;_clazz&quot;:&quot;com.alipay.dsgclient.sdk.dsg.fastscan.engine.cond.EducationDegreeCond&quot;}\\", \\"desc\\": \\"\\"}]</Data>\\n <HttpStatusCode>200</HttpStatusCode>\\n <RequestId>10000001</RequestId>\\n</QueryRecognizeDataByRuleTypeResponse>","errorExample":""}]', + 'title' => '获取敏感字段识别方式列表', + ], + 'QueryRecognizeRuleDetail' => [ + 'summary' => '调用QueryRecognizeRuleDetail接口查询数据保护伞的指定敏感字段详情。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '212990', + 'abilityTreeNodes' => [ + 'FEATUREdideDCM5VK', + ], + ], + 'parameters' => [ + [ + 'name' => 'SensitiveName', + 'in' => 'formData', + 'schema' => [ + 'description' => '敏感字段名称。可调用[QuerySensNodeInfo](~~2747189~~)接口，或进入[DataWorks控制台](https://workbench.data.aliyun.com/console)，在数据保护伞的分类分级界面获取敏感字段名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'Name', + ], + ], + [ + 'name' => 'TenantId', + 'in' => 'formData', + 'schema' => [ + 'description' => '租户ID。您可登录[DataWorks控制台](https://workbench.data.aliyun.com/console)，进入数据开发（DataStudio）页面，单击右上方当前登录用户名称，选择菜单 > 用户信息，获取租户ID。', + 'type' => 'string', + 'required' => true, + 'example' => '10241024', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'OpenApiResultModel', + 'description' => '返回数据。', + 'type' => 'object', + 'properties' => [ + 'Success' => [ + 'description' => '调用是否成功。'."\n" + .'- true：成功。'."\n" + .'- false：失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'ErrorCode' => [ + 'description' => '错误码。', + 'type' => 'string', + 'example' => '9990030003', + ], + 'ErrorMessage' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'Missing parameter', + ], + 'HttpStatusCode' => [ + 'description' => 'HTTP状态码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Data' => [ + 'description' => '返回的敏感字段详情，JSON格式。', + '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' => '请求的ID。用于定位日志，排查问题。', + 'type' => 'string', + 'example' => '100000012', + ], + ], + ], + ], + ], + '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' => '查询指定敏感字段详情', + ], + 'DsgUserGroupGetOdpsRoleGroups' => [ + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '220985', + 'abilityTreeNodes' => [ + 'FEATUREdideRZM9W6', + ], + ], + 'parameters' => [ + [ + 'name' => 'ProjectName', + 'in' => 'query', + 'schema' => [ + 'description' => 'MaxCompute项目名称。您可通过调用[DsgPlatformQueryProjectsAndSchemaFromMeta](~~2786303~~)接口获取MaxCompute项目列表。', + 'type' => 'string', + 'required' => true, + 'example' => 'test_project', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'OpenApiResultModel<List<String>>', + 'description' => '返回数据。', + 'type' => 'object', + 'properties' => [ + 'Success' => [ + 'description' => '调用是否成功。取值如下：'."\n" + .'- true：调用成功。'."\n" + .'- false：调用失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'ErrorCode' => [ + 'description' => '错误码。', + 'type' => 'string', + 'example' => '1029030003', + ], + 'ErrorMessage' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'param error', + ], + 'HttpStatusCode' => [ + 'description' => 'HTTP状态码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '400', + ], + 'Data' => [ + 'description' => '返回结果数据。', + 'type' => 'array', + 'items' => [ + 'description' => 'MaxCompute角色名称。', + 'type' => 'string', + 'example' => 'test_role', + ], + ], + 'RequestId' => [ + 'description' => '请求的ID。用于定位日志，排查问题。', + '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' => '查询可选择的MaxCompute角色列表', + 'summary' => '调用DsgUserGroupGetOdpsRoleGroups接口，查询该租户在数据保护伞创建或修改用户组时，用户组成员可选择的MaxCompute角色列表。 ', + ], + 'DsgDesensPlanAddOrUpdate' => [ + 'summary' => '调用DsgDesensPlanAddOrUpdate接口新建或编辑数据脱敏规则。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'abilityTreeCode' => '219759', + 'abilityTreeNodes' => [ + 'FEATUREdideRZM9W6', + ], + ], + 'parameters' => [ + [ + 'name' => 'DesensRules', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '需要新增或编辑的脱敏规则集合。', + 'type' => 'array', + 'items' => [ + 'description' => '脱敏规则信息。', + 'type' => 'object', + 'properties' => [ + 'Id' => [ + 'description' => '脱敏规则ID。您可调用[DsgDesensPlanQueryList](~~2786578~~)接口查询。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '123', + ], + 'DataType' => [ + 'description' => '敏感字段类型。', + 'type' => 'string', + 'required' => true, + 'example' => 'phone', + ], + 'RuleName' => [ + 'description' => '脱敏规则名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'phone_hash', + ], + 'Status' => [ + 'description' => '脱敏规则的生效状态。取值如下：'."\n" + .'- 0：失效。'."\n" + .'- 1：生效。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + 'SceneIds' => [ + 'description' => '二级脱敏场景。', + 'type' => 'array', + 'items' => [ + 'description' => '二级脱敏场景ID。此处输入的二级脱敏场景需要未配置DataType参数指定的敏感字段类型脱敏规则。您可调用[DsgSceneQuerySceneListByName](~~2786322~~)查询脱敏场景ID。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '123', + ], + 'required' => true, + ], + 'Owner' => [ + 'description' => '脱敏规则的负责人。', + 'type' => 'string', + 'required' => true, + 'example' => 'test_user', + ], + 'CheckWatermark' => [ + 'description' => '是否添加水印。取值如下：'."\n" + .'- true：是'."\n" + .'- false：否', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + 'DesensPlan' => [ + 'description' => '脱敏规则。', + 'type' => 'object', + 'properties' => [ + 'DesensPlanType' => [ + 'description' => '脱敏规则中配置的脱敏方式。取值如下：'."\n" + .'- 哈希：hash'."\n" + .'- 假名：mapping'."\n" + .'- 掩盖：mask'."\n" + .'- 字符替换：charreplacement'."\n" + .'- 区间变换：intervalselect'."\n" + .'- 取整：decimalpoint'."\n" + .'- 置空：emptydesens', + 'type' => 'string', + 'required' => true, + 'example' => 'hash', + ], + 'ExtParam' => [ + 'description' => '脱敏规则参数。', + 'type' => 'object', + 'required' => false, + 'additionalProperties' => [ + 'type' => 'any', + 'description' => '脱敏规则参数配置，根据您要配置的脱敏规则添加不同参数，具体内容请参见下文示例。', + 'example' => '{ "algo": "MD5", "salt":6 }', + ], + ], + ], + 'required' => true, + ], + ], + 'required' => false, + ], + 'required' => true, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'OpenApiResultModel<Boolean>', + 'description' => 'OpenApiResultModel<Boolean>', + 'type' => 'object', + 'properties' => [ + 'Success' => [ + 'description' => '调用是否成功。取值如下：'."\n" + .'true：调用成功。'."\n" + .'false：调用失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'ErrorCode' => [ + 'description' => '错误码。', + 'type' => 'string', + 'example' => '1029030003', + ], + 'ErrorMessage' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'param error', + ], + 'HttpStatusCode' => [ + 'description' => 'HTTP状态码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '400', + ], + 'Data' => [ + 'description' => '新增或编辑的执行结果。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'RequestId' => [ + 'description' => '请求的ID。用于定位日志，排查问题。', + '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' => '新建或编辑数据脱敏规则', + 'requestParamsDescription' => 'ExtParam为动态参数，对于不同脱敏规则配置不同，参考示例如下：'."\n" + ."\n" + .'```'."\n" + .'哈希：'."\n" + .'{'."\n" + .' "algo": "MD5",'."\n" + .' "salt": 6'."\n" + .'}'."\n" + .'假名：'."\n" + .'{'."\n" + .' "charset": "Aa",'."\n" + .' "salt": 6'."\n" + .'}'."\n" + .'掩盖：'."\n" + .'{'."\n" + .' "before": 3,'."\n" + .' "after": 4'."\n" + .'}'."\n" + .'自定义掩盖：'."\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" + .'样本值字符替换：'."\n" + .'{'."\n" + .' "library": "test_library",'."\n" + .' "position": 3'."\n" + .'}'."\n" + .'固定值字符替换：'."\n" + .'{'."\n" + .' "replace": "repData",'."\n" + .' "position": 3'."\n" + .'}'."\n" + .'随机字符替换：'."\n" + .'{'."\n" + .' "replace": "repData"'."\n" + .'}'."\n" + .'自定义字符替换：'."\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" + .'区间变换：'."\n" + .'{'."\n" + .' "intervalselects": ['."\n" + .' {'."\n" + .' "desens": "1",'."\n" + .' "interval": ['."\n" + .' "1",'."\n" + .' "100"'."\n" + .' ]'."\n" + .' }'."\n" + .' ]'."\n" + .'}'."\n" + .'取整：'."\n" + .'{'."\n" + .'"point":3'."\n" + .'}'."\n" + .'置空：'."\n" + .'{}'."\n" + .'```'."\n" + ."\n" + .'具体支持的脱敏方式及相关规则，可参考[DsgQueryDefaultTemplates](~~2786306~~)接口查询。', + ], + 'DsgPlatformQueryProjectsAndSchemaFromMeta' => [ + 'summary' => '调用DsgPlatformQueryProjectsAndSchemaFromMeta接口，查询当前租户下不同类型的引擎实例列表。', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'abilityTreeCode' => '219458', + 'abilityTreeNodes' => [ + 'FEATUREdideRZM9W6', + ], + ], + 'parameters' => [ + [ + 'name' => 'EngineName', + 'in' => 'query', + 'schema' => [ + 'title' => '引擎名称', + 'description' => '引擎类型。取值如下：'."\n" + .'- ODPS.ODPS'."\n" + .'- EMR'."\n" + .'- HOLO.POSTGRES', + 'type' => 'string', + 'required' => true, + 'example' => 'EMR', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'OpenApiResultModel<List<QueryProjectsAndSchemaFromMetaVO>>', + 'description' => 'OpenApiResultModel<List<QueryProjectsAndSchemaFromMetaVO>>', + 'type' => 'object', + 'properties' => [ + 'Success' => [ + 'description' => '调用是否成功。取值如下：'."\n" + .'- true：调用成功。'."\n" + .'- false：调用失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'ErrorCode' => [ + 'description' => '错误码。', + 'type' => 'string', + 'example' => '1029030003', + ], + 'ErrorMessage' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'param error', + ], + 'HttpStatusCode' => [ + 'description' => 'HTTP状态码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '400', + ], + 'Data' => [ + 'description' => '返回数据。', + 'type' => 'array', + 'items' => [ + 'description' => '返回数据。', + 'type' => 'object', + 'properties' => [ + 'Project' => [ + 'description' => '引擎名称。', + 'type' => 'string', + 'example' => 'emr_test_project', + ], + 'ClusterId' => [ + 'description' => 'EMR集群ID。仅当请求参数EngineName（引擎类型）取值为EMR时，返回数据才会生成该参数。', + 'type' => 'string', + 'example' => 'c-12345', + ], + ], + ], + ], + 'RequestId' => [ + 'description' => '请求的ID。用于定位日志，排查问题。', + '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' => '查询当前租户下的引擎实例列表', + ], + 'DsgUserGroupDelete' => [ + 'summary' => '调用DsgUserGroupDelete接口，删除数据保护伞配置的用户组。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'abilityTreeCode' => '219457', + 'abilityTreeNodes' => [ + 'FEATUREdideRZM9W6', + ], + ], + 'parameters' => [ + [ + 'name' => 'Ids', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '用户组信息。', + 'type' => 'array', + 'items' => [ + 'description' => '用户组ID。您可调用[DsgUserGroupQueryList](~~2786441~~)接口查询。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '123', + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'OpenApiResultModel<Boolean>', + 'description' => 'OpenApiResultModel<Boolean>', + 'type' => 'object', + 'properties' => [ + 'Success' => [ + 'description' => '调用是否成功。取值如下：'."\n" + .'- true：调用成功。'."\n" + .'- false：调用失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'ErrorCode' => [ + 'description' => '错误码。', + 'type' => 'string', + 'example' => '1029030003', + ], + 'ErrorMessage' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'param error', + ], + 'HttpStatusCode' => [ + 'description' => 'HTTP状态码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '400', + ], + 'Data' => [ + 'description' => '操作结果。取值如下：'."\n" + .'- true：删除用户组成功。'."\n" + .'- false：删除用户组失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'RequestId' => [ + 'description' => '请求的ID。用于定位日志，排查问题。', + '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' => '删除数据保护伞配置的用户组', + ], + 'DsgWhiteListDeleteList' => [ + 'summary' => '调用DsgWhiteListDeleteList接口，删除数据保护伞中配置的脱敏白名单。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'abilityTreeCode' => '219462', + 'abilityTreeNodes' => [ + 'FEATUREdideRZM9W6', + ], + ], + 'parameters' => [ + [ + 'name' => 'Ids', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '白名单ID。', + 'type' => 'array', + 'items' => [ + 'description' => '白名单ID。您可调用[DsgWhiteListQueryList](~~2786508~~)接口获取。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '123', + ], + 'required' => true, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'OpenApiResultModel<Boolean>', + 'description' => 'OpenApiResultModel<Boolean>', + 'type' => 'object', + 'properties' => [ + 'Success' => [ + 'description' => '调用是否成功。取值如下：'."\n" + .'- true：调用成功。'."\n" + .'- false：调用失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'ErrorCode' => [ + 'description' => '错误码。', + 'type' => 'string', + 'example' => '1029030003', + ], + 'ErrorMessage' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'param error', + ], + 'HttpStatusCode' => [ + 'description' => 'HTTP状态码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '400', + ], + 'Data' => [ + 'description' => '操作结果。取值如下：'."\n" + .'- true：操作成功。'."\n" + .'- false：操作失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'RequestId' => [ + 'description' => '请求的ID。用于定位日志，排查问题。', + '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' => '删除脱敏白名单', + ], + 'DsgScenedDeleteScene' => [ + 'summary' => '调用DsgScenedDeleteScene接口，删除数据保护伞中已创建的二级脱敏场景。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'abilityTreeCode' => '219460', + 'abilityTreeNodes' => [ + 'FEATUREdideRZM9W6', + ], + ], + 'parameters' => [ + [ + 'name' => 'Ids', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '二级脱敏场景的ID列表。', + 'type' => 'array', + 'items' => [ + 'description' => '二级脱敏场景的ID列表。您可调用[DsgSceneQuerySceneListByName](~~2786322~~)接口获取。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '123', + ], + 'required' => true, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'OpenApiResultModel<Boolean>', + 'description' => 'OpenApiResultModel<Boolean>', + 'type' => 'object', + 'properties' => [ + 'Success' => [ + 'description' => '调用是否成功。取值如下：'."\n" + .'- true：调用成功。'."\n" + .'- false：调用失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'ErrorCode' => [ + 'description' => '错误码。', + 'type' => 'string', + 'example' => '1029030003', + ], + 'ErrorMessage' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'param error', + ], + 'HttpStatusCode' => [ + 'description' => 'HTTP状态码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '400', + ], + 'Data' => [ + 'description' => '操作结果。取值如下：'."\n" + .'- true：操作成功。'."\n" + .'- false：操作失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'RequestId' => [ + 'description' => '请求的ID。用于定位日志，排查问题。', + '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' => '删除二级脱敏场景', + ], + 'DsgDesensPlanDelete' => [ + 'summary' => '调用DsgDesensPlanDelete接口，删除数据保护伞中已创建的脱敏规则。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'abilityTreeCode' => '219620', + 'abilityTreeNodes' => [ + 'FEATUREdideRZM9W6', + ], + ], + 'parameters' => [ + [ + 'name' => 'Ids', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '脱敏规则的ID集合。', + 'type' => 'array', + 'items' => [ + 'description' => '脱敏规则ID。您可调用[DsgDesensPlanQueryList](~~2786578~~)接口获取。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '123', + ], + 'required' => true, + ], + ], + [ + 'name' => 'SceneCode', + 'in' => 'query', + 'schema' => [ + 'description' => '脱敏规则所属的一级脱敏场景Code。取值如下：'."\n" + .'- 数据开发/数据地图展示脱敏：dataworks_display_desense_code'."\n" + .'- MaxCompute引擎层脱敏：maxcompute_desense_code'."\n" + .'- MaxCompute引擎层脱敏（新）：maxcompute_new_desense_code'."\n" + .'- Hologres引擎层脱敏：hologres_display_desense_code'."\n" + .'- 数据集成静态脱敏：dataworks_data_integration_desense_code'."\n" + .'- 数据分析展示脱敏：dataworks_analysis_desense_code', + 'type' => 'string', + 'required' => true, + 'example' => 'dataworks_display_desense_code', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'OpenApiResultModel<Boolean>', + 'description' => 'OpenApiResultModel<Boolean>', + 'type' => 'object', + 'properties' => [ + 'Success' => [ + 'description' => '调用是否成功。取值如下：'."\n" + .'- true：调用成功。'."\n" + .'- false：调用失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'ErrorCode' => [ + 'description' => '错误码。', + 'type' => 'string', + 'example' => '1029030003', + ], + 'ErrorMessage' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'param error', + ], + 'HttpStatusCode' => [ + 'description' => 'HTTP状态码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '400', + ], + 'Data' => [ + 'description' => '操作结果。取值如下：'."\n" + .'- true：操作成功。'."\n" + .'- false：操作失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'RequestId' => [ + 'description' => '请求的ID。用于定位日志，排查问题。', + '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' => '删除脱敏规则', + ], + 'DsgDesensPlanUpdateStatus' => [ + 'summary' => '调用DsgDesensPlanUpdateStatus接口，修改脱敏规则的生效状态。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '219619', + 'abilityTreeNodes' => [ + 'FEATUREdideRZM9W6', + ], + ], + 'parameters' => [ + [ + 'name' => 'Ids', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '需要修改状态的脱敏规则ID集合。', + 'type' => 'array', + 'items' => [ + 'description' => '脱敏规则ID。您可调用[DsgDesensPlanQueryList](~~2786578~~)接口获取。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '123', + ], + 'required' => true, + ], + ], + [ + 'name' => 'SceneCode', + 'in' => 'query', + 'schema' => [ + 'description' => '脱敏规则所属的一级脱敏场景Code。取值如下：'."\n" + .'- 数据开发/数据地图展示脱敏：dataworks_display_desense_code'."\n" + .'- MaxCompute引擎层脱敏：maxcompute_desense_code'."\n" + .'- MaxCompute引擎层脱敏（新）：maxcompute_new_desense_code'."\n" + .'- Hologres引擎层脱敏：hologres_display_desense_code'."\n" + .'- 数据集成静态脱敏：dataworks_data_integration_desense_code'."\n" + .'- 数据分析展示脱敏：dataworks_analysis_desense_code', + 'type' => 'string', + 'required' => true, + 'example' => 'dataworks_display_desense_code', + ], + ], + [ + 'name' => 'Status', + 'in' => 'query', + 'schema' => [ + 'description' => '脱敏规则的生效状态。取值如下：'."\n" + .'- 0：失效。'."\n" + .'- 1：生效。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'OpenApiResultModel<Boolean>', + 'description' => 'OpenApiResultModel<Boolean>', + 'type' => 'object', + 'properties' => [ + 'Success' => [ + 'description' => '调用是否成功。取值如下：'."\n" + .'- true：调用成功。'."\n" + .'- false：调用失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'ErrorCode' => [ + 'description' => '错误码。', + 'type' => 'string', + 'example' => '1029030003', + ], + 'ErrorMessage' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'param error', + ], + 'HttpStatusCode' => [ + 'description' => 'HTTP状态码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '400', + ], + 'Data' => [ + 'description' => '操作结果。取值如下：'."\n" + .'- true：操作成功。'."\n" + .'- false：操作失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'RequestId' => [ + 'description' => '请求的ID。用于定位日志，排查问题。', + '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' => '修改脱敏规则的生效状态', + ], + 'DsgWhiteListQueryList' => [ + 'summary' => '调用DsgWhiteListQueryList接口，查询数据保护伞中配置的脱敏白名单。', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'abilityTreeCode' => '219250', + 'abilityTreeNodes' => [ + 'FEATUREdideRZM9W6', + ], + ], + 'parameters' => [ + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'title' => '页码', + 'description' => '分页的页数。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'title' => '页大小', + 'description' => '每页显示的条数，最大100条。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '10', + ], + ], + [ + 'name' => 'SceneId', + 'in' => 'query', + 'schema' => [ + 'title' => '二级场景Id', + 'description' => '二级脱敏场景ID。您可调用[DsgSceneQuerySceneListByName](~~2786322~~)接口获取。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '123', + ], + ], + [ + 'name' => 'DataType', + 'in' => 'query', + 'schema' => [ + 'title' => '敏感类型关键字', + 'description' => '敏感字段类型的关键字。', + 'type' => 'string', + 'required' => false, + 'example' => 'phone', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'OpenApiResultModel<PagingResultModel<WhiteListQueryListVO>>', + 'description' => 'OpenApiResultModel<PagingResultModel<WhiteListQueryListVO>>', + 'type' => 'object', + 'properties' => [ + 'Success' => [ + 'description' => '调用是否成功。取值如下：'."\n" + .'- true：调用成功。'."\n" + .'- false：调用失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'ErrorCode' => [ + 'description' => '错误码。', + 'type' => 'string', + 'example' => '1029030003', + ], + 'ErrorMessage' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'param error', + ], + 'HttpStatusCode' => [ + 'description' => 'HTTP状态码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '400', + ], + 'PageData' => [ + 'description' => '分页数据。', + 'type' => 'object', + 'properties' => [ + 'PageNumber' => [ + 'description' => '分页的页数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '每页显示的条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'TotalCount' => [ + 'description' => '返回的脱敏白名单总条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '100', + ], + 'Data' => [ + 'description' => '白名单集合。', + 'type' => 'array', + 'items' => [ + 'description' => '返回数据。', + 'type' => 'object', + 'properties' => [ + 'Id' => [ + 'description' => '脱敏白名单ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '123', + ], + 'Type' => [ + 'description' => '敏感字段类型。', + 'type' => 'string', + 'example' => 'phone', + ], + 'UserGroups' => [ + 'description' => '用户组名称集合。', + 'type' => 'array', + 'items' => [ + 'description' => '用户组名称。', + 'type' => 'string', + 'example' => 'test_group', + ], + ], + 'GmtCreate' => [ + 'description' => '脱敏白名单的创建时间。', + 'type' => 'string', + 'example' => '2024-05-09 15:46:20', + ], + 'GmtModified' => [ + 'description' => '脱敏白名单的修改时间。', + 'type' => 'string', + 'example' => '2024-05-09 15:46:20', + ], + 'RuleId' => [ + 'description' => '脱敏规则ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '123', + ], + 'SceneId' => [ + 'description' => '二级脱敏场景ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '123', + ], + 'StartTime' => [ + 'description' => '脱敏白名单的生效时间，不能早于当前时间。单位为天。', + 'type' => 'string', + 'example' => '2024-05-09 15:46:20', + ], + 'EndTime' => [ + 'description' => '脱敏白名单的失效时间，不能早于生效时间。单位为天。', + 'type' => 'string', + 'example' => '2024-05-10 15:46:20', + ], + ], + ], + ], + ], + ], + 'RequestId' => [ + 'description' => '请求的ID。用于定位日志，排查问题。', + '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' => '查询脱敏白名单', + ], + 'DsgSceneAddOrUpdateScene' => [ + 'summary' => '调用DsgSceneAddOrUpdateScene接口，新增或编辑二级脱敏场景。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'abilityTreeCode' => '219459', + 'abilityTreeNodes' => [ + 'FEATUREdideRZM9W6', + ], + ], + 'parameters' => [ + [ + 'name' => 'scenes', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '二级脱敏场景信息。', + 'type' => 'array', + 'items' => [ + 'description' => '二级脱敏场景信息。', + 'type' => 'object', + 'properties' => [ + 'id' => [ + 'description' => '二级脱敏场景ID。'."\n" + .'- 不配置该参数：表示当前操作为新增二级脱敏场景。'."\n" + .'- 配置该参数：表示编辑指定二级脱敏场景信息。您可调用[DsgSceneQuerySceneListByName](~~2786322~~)接口查询二级脱敏场景ID。', + 'type' => 'string', + 'required' => false, + 'example' => '10000', + ], + 'sceneName' => [ + 'description' => '二级脱敏场景名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'dev_scene', + ], + 'sceneCode' => [ + 'description' => '二级脱敏场景所属的一级脱敏场景Code。取值如下：'."\n" + .'- 数据开发/数据地图展示脱敏：dataworks_display_desense_code'."\n" + .'- MaxCompute引擎层脱敏：maxcompute_desense_code'."\n" + .'- MaxCompute引擎层脱敏（新）：maxcompute_new_desense_code'."\n" + .'- 数据分析展示脱敏：dataworks_analysis_desense_code', + 'type' => 'string', + 'required' => true, + 'example' => 'dataworks_display_desense_code', + ], + 'projects' => [ + 'description' => '脱敏场景生效的引擎信息。', + 'type' => 'array', + 'items' => [ + 'description' => '脱敏场景生效的引擎信息。', + 'type' => 'object', + 'properties' => [ + 'clusterId' => [ + 'description' => '若脱敏场景生效的数据范围为EMR引擎，此处需输入EMR集群ID。仅当使用EMR引擎时需配置该参数。', + 'type' => 'string', + 'required' => false, + 'example' => 'c-1234', + ], + 'projectName' => [ + 'description' => '脱敏场景生效的引擎实例名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'dev_project', + ], + 'dbType' => [ + 'description' => '脱敏场景生效的引擎类型。取值如下：'."\n" + .'- ODPS：ODPS.ODPS'."\n" + .'- HOLO：HOLO.POSTGRES'."\n" + .'- EMR：EMR', + 'type' => 'string', + 'required' => false, + 'example' => 'ODPS.ODPS', + ], + ], + 'required' => false, + ], + 'required' => false, + ], + 'desc' => [ + 'description' => '描述。', + 'type' => 'string', + 'required' => false, + 'example' => 'Test scenarios', + ], + 'userGroupIds' => [ + 'description' => '脱敏场景生效的用户组信息。', + 'type' => 'array', + 'items' => [ + 'description' => '脱敏场景生效的用户组ID。您可调用[DsgUserGroupQueryList](~~2786441~~)接口获取。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '123', + ], + 'required' => false, + ], + ], + 'required' => false, + ], + 'required' => true, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'OpenApiResultModel<Boolean>', + 'description' => 'OpenApiResultModel<Boolean>', + 'type' => 'object', + 'properties' => [ + 'Success' => [ + 'description' => '调用是否成功。取值如下：'."\n" + .'- true：调用成功。'."\n" + .'- false：调用失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'ErrorCode' => [ + 'description' => '错误码。', + 'type' => 'string', + 'example' => '1029030003', + ], + 'ErrorMessage' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'param error', + ], + 'HttpStatusCode' => [ + 'description' => 'HTTP状态码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '400', + ], + 'Data' => [ + 'description' => '操作结果。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'RequestId' => [ + 'description' => '请求的ID。用于定位日志，排查问题。', + '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' => '新增或编辑二级脱敏场景', + ], + 'DsgSceneQuerySceneListByName' => [ + 'summary' => '调用DsgSceneQuerySceneListByName接口，获取脱敏场景列表。', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'abilityTreeCode' => '219224', + 'abilityTreeNodes' => [ + 'FEATUREdideRZM9W6', + ], + ], + 'parameters' => [ + [ + 'name' => 'SceneName', + 'in' => 'query', + 'schema' => [ + 'title' => '场景名称关键字', + 'description' => '脱敏场景名称的模糊查询关键字，平台会根据该关键字获取相关脱敏场景信息。', + 'type' => 'string', + 'required' => false, + 'example' => 'dev_', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'OpenApiResultModel<List<DsgSceneVO>>', + 'description' => 'OpenApiResultModel<List<DsgSceneVO>>', + 'type' => 'object', + 'properties' => [ + 'Success' => [ + 'description' => '调用是否成功。取值如下：'."\n" + .'- true：调用成功。'."\n" + .'- false：调用失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'ErrorCode' => [ + 'description' => '错误码。', + 'type' => 'string', + 'example' => '1029030003', + ], + 'ErrorMessage' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'param error', + ], + 'HttpStatusCode' => [ + 'description' => 'HTTP状态码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '400', + ], + 'Data' => [ + 'description' => '返回数据。', + 'type' => 'array', + 'items' => [ + 'description' => '返回数据。', + 'type' => 'object', + 'properties' => [ + 'Id' => [ + 'description' => '脱敏场景ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '123', + ], + 'SceneCode' => [ + 'description' => '一级脱敏场景Code。取值如下：'."\n" + .'- 数据开发/数据地图展示脱敏：dataworks_display_desense_code'."\n" + .'- MaxCompute引擎层脱敏：maxcompute_desense_code'."\n" + .'- MaxCompute引擎层脱敏（新）：maxcompute_new_desense_code'."\n" + .'- Hologres引擎层脱敏：hologres_display_desense_code'."\n" + .'- 数据集成静态脱敏：dataworks_data_integration_desense_code'."\n" + .'- 数据分析展示脱敏：dataworks_analysis_desense_code', + 'type' => 'string', + 'example' => 'dataworks_display_desense_code', + ], + 'Desc' => [ + 'description' => '脱敏场景描述信息。', + 'type' => 'string', + 'example' => 'Test scenarios', + ], + 'SceneName' => [ + 'description' => '脱敏场景名称。', + 'type' => 'string', + 'example' => 'test_scene', + ], + 'UserGroups' => [ + 'description' => '脱敏场景的用户组名称列表。使用英文逗号（,）隔开。', + 'type' => 'string', + 'example' => 'user1,user2', + ], + 'SceneLevel' => [ + 'description' => '脱敏场景级别。取值如下：'."\n" + .'- 0：一级场景'."\n" + .'- 1：二级场景', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Projects' => [ + 'description' => '脱敏场景生效的引擎信息。', + 'type' => 'array', + 'items' => [ + 'description' => '脱敏场景生效的引擎信息。', + 'type' => 'object', + 'properties' => [ + 'DbType' => [ + 'description' => '引擎类型。取值如下：'."\n" + .'- ODPS：ODPS.ODPS'."\n" + .'- HOLO：HOLO.POSTGRES'."\n" + .'- EMR：EMR', + 'type' => 'string', + 'example' => 'ODPS.ODPS', + ], + 'ProjectName' => [ + 'description' => '引擎实例名称。', + 'type' => 'string', + 'example' => 'dev_project', + ], + 'ClusterId' => [ + 'description' => 'EMR集群ID。仅当脱敏场景生效的数据范围为EMR引擎时，会返回该参数。', + 'type' => 'string', + 'example' => 'c-123456', + ], + ], + ], + ], + 'Children' => [ + 'description' => '多级脱敏场景参数信息。', + 'type' => 'array', + 'items' => [ + 'description' => '若存在多级脱敏场景（即脱敏场景存在父子节点嵌套），则此处为嵌套的脱敏场景信息。参数与外层参数相同。', + 'type' => 'any', + 'example' => '$ref', + ], + ], + ], + ], + ], + 'RequestId' => [ + 'description' => '请求的ID。用于定位日志，排查问题。', + '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' => '获取脱敏场景列表', + ], + 'DsgUserGroupAddOrUpdate' => [ + 'summary' => '调用DsgUserGroupAddOrUpdate接口，新增或编辑数据保护伞中的用户组。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'abilityTreeCode' => '219456', + 'abilityTreeNodes' => [ + 'FEATUREdideRZM9W6', + ], + ], + 'parameters' => [ + [ + 'name' => 'UserGroups', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '用户组信息。', + 'type' => 'array', + 'items' => [ + 'description' => '用户组信息。', + 'type' => 'object', + 'properties' => [ + 'Id' => [ + 'description' => '用户组ID。'."\n" + .'- 不配置该参数：表示当前操作为新增用户组。'."\n" + .'- 配置该参数：表示编辑指定用户组信息。您可调用[DsgUserGroupQueryList](~~2786441~~)接口查询用户组ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '123', + ], + 'Name' => [ + 'description' => '用户组名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'yun_group', + ], + 'Owner' => [ + 'description' => '用户组的负责人。', + 'type' => 'string', + 'required' => true, + 'example' => 'user1', + ], + 'Accounts' => [ + 'description' => '用户组中的用户列表。'."\n" + .'- 基于阿里云账号及RAM角色创建的用户组：可调用[DsgUserGroupQueryUserList](~~2786445~~)接口查询用户列表。'."\n" + .'- 基于MaxCompute角色创建的用户组：可调用[DsgUserGroupGetOdpsRoleGroups](~~2785695~~)接口查询用户列表。', + 'type' => 'array', + 'items' => [ + 'description' => '输入用户名或MaxCompute角色。该参数需基于UserGroupType参数的取值配置。', + 'type' => 'string', + 'required' => false, + 'example' => 'user1', + ], + 'required' => true, + ], + 'ProjectName' => [ + 'description' => 'MaxCompute项目名称。创建MaxCompute用户组时必须配置该参数。', + 'type' => 'string', + 'required' => false, + 'example' => 'dev_project', + ], + 'UserGroupType' => [ + 'description' => '用户组类型。取值如下：'."\n" + .'- 1：阿里云用户'."\n" + .'- 2：RAM角色'."\n" + .'- 3：MaxCompute角色', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '1', + ], + ], + 'required' => true, + ], + 'required' => true, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'OpenApiResultModel<Boolean>', + 'description' => 'OpenApiResultModel<Boolean>', + 'type' => 'object', + 'properties' => [ + 'Success' => [ + 'description' => '调用是否成功。取值如下：'."\n" + .'- true：调用成功。'."\n" + .'- false：调用失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'ErrorCode' => [ + 'description' => '错误码。', + 'type' => 'string', + 'example' => '1029030003', + ], + 'ErrorMessage' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'param error', + ], + 'HttpStatusCode' => [ + 'description' => 'HTTP状态码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '400', + ], + 'Data' => [ + 'description' => '操作结果。取值如下：'."\n" + .'- true：操作成功。'."\n" + .'- false：操作失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'RequestId' => [ + 'description' => '请求的ID。用于定位日志，排查问题。', + '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' => '新增或编辑数据保护伞中的用户组', + ], + 'DsgUserGroupQueryList' => [ + 'summary' => '调用DsgUserGroupQueryList接口，查询数据保护伞的用户组列表。', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'abilityTreeCode' => '219454', + 'abilityTreeNodes' => [ + 'FEATUREdideRZM9W6', + ], + ], + 'parameters' => [ + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'title' => '页码', + 'description' => '分页的页码数。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'title' => '页大小', + 'description' => '每页显示的条数，最大为100。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '10', + ], + ], + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => [ + 'title' => '用户组名称', + 'description' => '用户组名称关键字。平台会根据该关键字模糊匹配，查询相关用户组信息。', + 'type' => 'string', + 'required' => false, + 'example' => 'yun_group', + ], + ], + [ + 'name' => 'Owner', + 'in' => 'query', + 'schema' => [ + 'title' => '负责人', + 'description' => '用户组的负责人。', + 'type' => 'string', + 'required' => false, + 'example' => 'user1', + ], + ], + [ + 'name' => 'ProjectName', + 'in' => 'query', + 'schema' => [ + 'description' => '引擎名称。如需查询MaxCompute用户组信息，可配置该参数。', + 'type' => 'string', + 'required' => false, + 'example' => 'dev_project', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'OpenApiResultModel<PagingResultModel<UserGroupQueryListVO>>', + 'description' => 'OpenApiResultModel<PagingResultModel<UserGroupQueryListVO>>', + 'type' => 'object', + 'properties' => [ + 'Success' => [ + 'description' => '调用是否成功。取值如下：'."\n" + .'- true：调用成功。'."\n" + .'- false：调用失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'ErrorCode' => [ + 'description' => '错误码。', + 'type' => 'string', + 'example' => '1029030003', + ], + 'ErrorMessage' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'param error', + ], + 'HttpStatusCode' => [ + 'description' => 'HTTP状态码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '400', + ], + 'PageData' => [ + 'description' => '分页数据查询结果。', + 'type' => 'object', + 'properties' => [ + 'PageNumber' => [ + 'description' => '分页的页码数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '每页显示的条数，最大为100。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'TotalCount' => [ + 'description' => '返回的用户组总条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '100', + ], + 'Data' => [ + 'description' => '用户组列表。', + 'type' => 'array', + 'items' => [ + 'description' => '用户组信息。', + 'type' => 'object', + 'properties' => [ + 'Accounts' => [ + 'description' => '用户组中的用户名集合。', + 'type' => 'array', + 'items' => [ + 'description' => '用户名。', + 'type' => 'string', + 'example' => 'user1', + ], + ], + 'Id' => [ + 'description' => '用户组ID。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '123', + ], + 'GmtCreate' => [ + 'description' => '用户组的创建时间。', + 'type' => 'string', + 'example' => '2024-05-10 17:14:44', + ], + 'GmtModified' => [ + 'description' => '用户组的修改时间。', + 'type' => 'string', + 'example' => '2024-05-10 17:14:44', + ], + 'Name' => [ + 'description' => '用户组名称。', + 'type' => 'string', + 'example' => 'test_group', + ], + 'Owner' => [ + 'description' => '用户组负责人。', + 'type' => 'string', + 'example' => 'user1', + ], + ], + ], + 'example' => '{ "accounts": [ "role_project_scheduler" ], "gmtCreate": "2024-05-10 15:22:18", "gmtModified": "2024-05-10 15:22:18", "id": 1955, "name": "dsg_fin_test-复制", "owner": "UAT" }', + ], + ], + ], + 'RequestId' => [ + 'description' => '请求的ID。用于定位日志，排查问题。', + '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' => '查询数据保护伞的用户组列表', + ], + 'DsgUserGroupQueryUserList' => [ + 'summary' => '调用DsgUserGroupQueryUserList接口，查询当前租户下的用户或角色列表。', + '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' => 'OpenApiResultModel<List<UserGroupQueryUserListVO>>', + 'type' => 'object', + 'properties' => [ + 'Success' => [ + 'description' => '调用是否成功。取值如下：'."\n" + .'- true：调用成功。'."\n" + .'- false：调用失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'ErrorCode' => [ + 'description' => '错误码。', + 'type' => 'string', + 'example' => '1029030003', + ], + 'ErrorMessage' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'param error', + ], + 'HttpStatusCode' => [ + 'description' => 'HTTP状态码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '400', + ], + 'Data' => [ + 'description' => '返回数据。', + 'type' => 'array', + 'items' => [ + 'description' => '返回的用户信息。', + 'type' => 'object', + 'properties' => [ + 'AccountName' => [ + 'description' => '用户名称。', + 'type' => 'string', + 'example' => 'user1', + ], + 'YunAccount' => [ + 'description' => '阿里云用户名称或RAM角色名称。基于阿里云账号或RAM角色创建用户组时需使用该参数的返回值。', + 'type' => 'string', + 'example' => 'user:user1', + ], + 'AccountType' => [ + 'description' => '用户类型。取值如下：'."\n" + .'- 1~5：表示阿里云用户。'."\n" + .'- 6：表示RAM角色。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'BaseId' => [ + 'description' => '用户ID或角色ID。', + 'type' => 'string', + 'example' => '234', + ], + 'ParentAccountId' => [ + 'description' => '父用户ID。RAM用户会涉及该参数。', + 'type' => 'string', + 'example' => '123', + ], + ], + ], + ], + 'RequestId' => [ + 'description' => '请求的ID。用于定位日志，排查问题。', + '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' => '查询当前租户下的用户或角色列表', + ], + 'DsgDesensPlanQueryList' => [ + 'summary' => '调用DsgDesensPlanQueryList接口，查询数据保护伞的脱敏规则列表。', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'abilityTreeCode' => '219758', + 'abilityTreeNodes' => [ + 'FEATUREdideRZM9W6', + ], + ], + 'parameters' => [ + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '分页的页数。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '每页显示的数据条数，最大为100。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '10', + ], + ], + [ + 'name' => 'SceneId', + 'in' => 'query', + 'schema' => [ + 'description' => '二级脱敏场景ID。您可调用[DsgSceneQuerySceneListByName](~~2786322~~)接口获取。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '123', + ], + ], + [ + 'name' => 'RuleName', + 'in' => 'query', + 'schema' => [ + 'description' => '敏感字段名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'phone', + ], + ], + [ + 'name' => 'Owner', + 'in' => 'query', + 'schema' => [ + 'description' => '脱敏规则的负责人。', + 'type' => 'string', + 'required' => false, + 'example' => 'user1', + ], + ], + [ + 'name' => 'Status', + 'in' => 'query', + 'schema' => [ + 'description' => '脱敏规则的生效状态。取值如下：'."\n" + .'- 0：失效。'."\n" + .'- 1：生效。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'OpenApiResultModel<PagingResultModel<DesensPlanQueryListVO>>', + 'description' => 'OpenApiResultModel<PagingResultModel<DesensPlanQueryListVO>>', + 'type' => 'object', + 'properties' => [ + 'Success' => [ + 'description' => '调用是否成功。取值如下：'."\n" + .'- true：调用成功。'."\n" + .'- false：调用失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'ErrorCode' => [ + 'description' => '错误码。', + 'type' => 'string', + 'example' => '1029030003', + ], + 'ErrorMessage' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'param error', + ], + 'HttpStatusCode' => [ + 'description' => 'HTTP状态码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '400', + ], + 'PageData' => [ + 'description' => '分页数据。', + 'type' => 'object', + 'properties' => [ + 'PageNumber' => [ + 'description' => '页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '每页显示的数据条数，最大为100。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'TotalCount' => [ + 'description' => '返回的脱敏规则条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '100', + ], + 'Data' => [ + 'description' => '脱敏规则信息。', + 'type' => 'array', + 'items' => [ + 'description' => '脱敏规则信息。', + 'type' => 'object', + 'properties' => [ + 'Id' => [ + 'title' => '脱敏规则id', + 'description' => '脱敏规则ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '123', + ], + 'DataType' => [ + 'title' => '敏感类型', + 'description' => '敏感字段类型。', + 'type' => 'string', + 'example' => 'phone', + ], + 'RuleName' => [ + 'title' => '脱敏规则名称', + 'description' => '脱敏规则名称。', + 'type' => 'string', + 'example' => 'phone_hash', + ], + 'DesensPlan' => [ + 'title' => '脱敏规则详情', + 'description' => '脱敏规则详情。', + 'type' => 'object', + 'properties' => [ + 'DesensPlanType' => [ + 'description' => '脱敏规则类型。', + 'type' => 'string', + 'example' => 'hash', + ], + 'ExtParam' => [ + 'description' => '脱敏规则参数。参数信息可参考[DsgDesensPlanAddOrUpdate](~~2786295~~)接口文档。', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'any', + 'example' => '"extParam": { "algo":"MD5", "salt":"5" }', + 'description' => '脱敏规则参数详情。', + ], + ], + ], + ], + 'Owner' => [ + 'title' => '负责人', + 'description' => '脱敏规则的负责人。', + 'type' => 'string', + 'example' => 'user1', + ], + 'GmtCreate' => [ + 'title' => '规则创建时间', + 'description' => '脱敏规则的创建时间。', + 'type' => 'string', + 'example' => '2024-05-09 15:46:20', + ], + 'GmtModified' => [ + 'title' => '规则修改时间', + 'description' => '脱敏规则的修改时间。', + 'type' => 'string', + 'example' => '2024-05-09 15:46:20', + ], + 'Status' => [ + 'title' => '生效状态0/1', + 'description' => '脱敏规则的生效状态。取值如下：'."\n" + .'- 0：失效。'."\n" + .'- 1：生效。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'DesensWay' => [ + 'title' => '脱敏方式', + 'description' => '脱敏方式。', + 'type' => 'string', + 'example' => 'HASH', + ], + 'DesenMode' => [ + 'title' => '脱敏方式类型', + 'description' => '脱敏方式类型。', + 'type' => 'string', + 'example' => 'HASH', + ], + 'DesensRule' => [ + 'title' => '脱敏规则', + 'description' => '脱敏规则。', + 'type' => 'string', + 'example' => 'HASH', + ], + 'SceneCode' => [ + 'title' => '一级场景code', + 'description' => '脱敏规则所属的一级脱敏场景Code。取值如下：'."\n" + .'- 数据开发/数据地图展示脱敏：dataworks_display_desense_code'."\n" + .'- MaxCompute引擎层脱敏：maxcompute_desense_code'."\n" + .'- MaxCompute引擎层脱敏（新）：maxcompute_new_desense_code'."\n" + .'- Hologres引擎层脱敏：hologres_display_desense_code'."\n" + .'- 数据集成静态脱敏：dataworks_data_integration_desense_code'."\n" + .'- 数据分析展示脱敏：dataworks_analysis_desense_code', + 'type' => 'string', + 'example' => 'dataworks_display_desense_code', + ], + 'CheckWatermark' => [ + 'title' => '是否插入水印', + 'description' => '是否添加水印。取值如下：'."\n" + .'- true：添加。'."\n" + .'- false：不添加。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'SceneName' => [ + 'title' => '二级场景名称', + 'description' => '脱敏规则所属的二级脱敏场景名称。', + 'type' => 'string', + 'example' => 'test_scene', + ], + ], + ], + ], + ], + ], + 'RequestId' => [ + 'description' => '请求的ID。用于定位日志，排查问题。', + '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' => '脱敏规则列表', + ], + 'DsgWhiteListAddOrUpdate' => [ + 'summary' => '调用DsgWhiteListAddOrUpdate接口，新增或编辑脱敏白名单。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'abilityTreeCode' => '219461', + 'abilityTreeNodes' => [ + 'FEATUREdideRZM9W6', + ], + ], + 'parameters' => [ + [ + 'name' => 'WhiteLists', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '白名单集合。', + 'type' => 'array', + 'items' => [ + 'description' => '白名单信息。', + 'type' => 'object', + 'properties' => [ + 'RuleId' => [ + 'description' => '脱敏规则ID。您可调用[DsgDesensPlanQueryList](~~2786578~~)接口获取。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '123', + ], + 'Id' => [ + 'description' => '脱敏白名单ID。'."\n" + .'- 不配置该参数：表示当前操作为新增脱敏白名单。'."\n" + .'- 配置该参数：表示编辑指定脱敏白名单信息。您可调用[DsgWhiteListQueryList](~~2786508~~)接口查询白名单ID。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '123', + ], + 'StartTime' => [ + 'description' => '脱敏白名单的生效时间。', + 'type' => 'string', + 'required' => true, + 'example' => '2024-04-10 00:00:00', + ], + 'EndTime' => [ + 'description' => '脱敏白名单的失效时间。输入null表示白名单永久生效。', + 'type' => 'string', + 'required' => false, + 'example' => 'null', + ], + 'UserGroupIds' => [ + 'description' => '用户组ID集合。', + 'type' => 'array', + 'items' => [ + 'description' => '用户组ID。您可调用[DsgUserGroupQueryList](~~2786441~~)接口获取。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '123', + ], + 'required' => true, + ], + ], + 'required' => false, + ], + 'required' => true, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'OpenApiResultModel<Boolean>', + 'description' => 'OpenApiResultModel<Boolean>', + 'type' => 'object', + 'properties' => [ + 'Success' => [ + 'description' => '调用是否成功。取值如下：'."\n" + .'- true：调用成功。'."\n" + .'- false：调用失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'ErrorCode' => [ + 'description' => '错误码。', + 'type' => 'string', + 'example' => '1029030003', + ], + 'ErrorMessage' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'param error', + ], + 'HttpStatusCode' => [ + 'description' => 'HTTP状态码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '400', + ], + 'Data' => [ + 'description' => '操作结果。取值如下：'."\n" + .'- true：操作成功。'."\n" + .'- false：操作失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'RequestId' => [ + 'description' => '请求的ID。用于定位日志，排查问题。', + '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' => '新增或编辑脱敏白名单', + ], + 'DsgQueryDefaultTemplates' => [ + 'summary' => '调用DsgQueryDefaultTemplates接口，查询可选择的敏感类型模版列表及该模版支持的脱敏规则。您可参考该接口的返回参数配置脱敏规则。', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'abilityTreeCode' => '219249', + 'abilityTreeNodes' => [ + 'FEATUREdideRZM9W6', + ], + ], + 'parameters' => [ + [ + 'name' => 'SceneId', + 'in' => 'query', + 'schema' => [ + 'title' => '二级场景id', + 'description' => '二级脱敏场景ID。您可调用[DsgSceneQuerySceneListByName](~~2786322~~)接口获取。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '123', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'OpenApiResultModel<List<QueryDefaultTemplatesVO>>', + 'description' => 'OpenApiResultModel<List<QueryDefaultTemplatesVO>>', + 'type' => 'object', + 'properties' => [ + 'Success' => [ + 'description' => '调用是否成功。取值如下：'."\n" + .'- true：调用成功。'."\n" + .'- false：调用失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'ErrorCode' => [ + 'description' => '错误码。', + 'type' => 'string', + 'example' => '1029030003', + ], + 'ErrorMessage' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'param error', + ], + 'HttpStatusCode' => [ + 'description' => 'HTTP状态码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '400', + ], + 'Data' => [ + 'description' => '返回数据。', + 'type' => 'array', + 'items' => [ + 'description' => '返回数据。', + 'type' => 'object', + 'properties' => [ + 'DataType' => [ + 'description' => '敏感字段类型。', + 'type' => 'string', + 'example' => 'phone', + ], + 'DesensPlanTemplate' => [ + 'description' => '支持的脱敏方式及参数说明列表。', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'type' => 'string', + 'example' => 'hash', + 'description' => '脱敏方式名称。', + ], + 'SupportWaterMark' => [ + 'type' => 'boolean', + 'example' => 'true', + 'description' => '是否允许添加水印。取值如下：'."\n" + .'- true：允许。'."\n" + .'- false：不允许。', + ], + 'ExtParamTemplate' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'any', + 'description' => '支持的脱敏规则及相关参数配置参考，Json格式。'."\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' => '脱敏参数及其说明列表。', + ], + ], + 'description' => '脱敏方式及参数信息。', + ], + 'description' => '脱敏方式及参数信息。', + ], + ], + ], + ], + ], + 'RequestId' => [ + 'description' => '请求的ID。用于定位日志，排查问题。', + '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' => '查询可选择的敏感类型模版列表及详情', + ], + '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' => 'DataWorks工作空间的ID。您可以登录DataWorks管控台，进入工作空间配置页面获取工作空间ID。'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + 'minimum' => '2', + 'example' => '123456', + ], + ], + [ + 'name' => 'Name', + 'in' => 'formData', + 'schema' => [ + 'description' => '创建的导入任务的名称。项目空间内该名称必须唯一。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'test_import_001', + ], + ], + [ + 'name' => 'PackageType', + 'in' => 'formData', + 'schema' => [ + 'description' => '导入导出包的类型，取值如下：'."\n" + .'- DATAWORKS_MODEL（标准格式）'."\n" + .'- DATAWORKS_V2（专有云（V3.6.1-V3.11））'."\n" + .'- DATAWORKS_V3（专有云（V3.12及以上））'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'DATAWORKS_MODEL', + 'enum' => [ + 'DATAWORKS_MODEL', + 'DATAWOKRS_V2', + 'DATAWORKS_V3', + 'SPEC', + ], + ], + ], + [ + 'name' => 'PackageFile', + 'in' => 'formData', + 'schema' => [ + 'description' => '导入包文件路径。'."\n" + .'**注意：本接口导入文件涉及文件上传。方式调用举例如下：**'."\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" + .'```', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '/home/admin/xxx/import.zip', + 'isFileTransferUrl' => true, + ], + ], + [ + 'name' => 'ResourceGroupMap', + 'in' => 'formData', + 'schema' => [ + 'description' => '调度资源组和数据集成资源组的映射关系。映射的key和value均为资源组的标识符（identifier）， 格式如下：'."\n" + ."\n" + .'```json'."\n" + .'{'."\n" + .' "SCHEDULER_RESOURCE_GROUP": {'."\n" + .' "xxx": "yyy"'."\n" + .' },'."\n" + .' "DI_RESOURCE_GROUP": {'."\n" + .' "ccc": "dfdd"'."\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' => '用于在执行导入导出操作时，根据该映射关系，修改导入导出包里的输入输出项目空间名称为映射后的项目空间名称。例如，导入时会根据映射关系，把输入输出里的项目空间名称的前缀做相应替换。', + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => '{"test_workspace_src": "test_workspace_target"}', + ], + ], + [ + 'name' => 'CalculateEngineMap', + 'in' => 'formData', + 'schema' => [ + 'description' => '导入任务中，导入的源计算引擎到导出的目标计算引擎实例的映射关系。'."\n" + .'计算引擎的类型，包括ODPS、EMR、HADOOP_CDH、HOLOGRES等。', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => '{ "ODPS": { "zxy_8221431_engine": "wzp_kaifazheban_engine" }, "EMR": { "aaaa": "bbb" } }', + ], + ], + [ + 'name' => 'CommitRule', + 'in' => 'formData', + 'schema' => [ + 'description' => '执行导入操作时，设定的自动提交发布任务的规则。参数如下：'."\n" + .'- resourceAutoCommit：资源是否自动提交。true 表示是，false表示否。'."\n" + .'- resourceAutoDeploy：资源是否自动发布。true 表示是，false表示否。'."\n" + .'- functionAutoCommit：函数是否自动提交。true 表示是，false表示否。'."\n" + .'- functionAutoDeploy： 函数是否自动发布。true 表示是，false表示否。'."\n" + .'- tableAutoCommitToDev：表是否自动提交到开发环境。true 表示是，false表示否。'."\n" + .'- tableAutoCommitToProd：表是否自动提交到生产环境。true 表示是，false表示否。'."\n" + .'- ignoreLock：是否自动绕过锁定。true 表示是，false表示否。当任务被其他人编辑锁定时，如果选择绕过锁定，则可以强制更新当前任务。'."\n" + .'- fileAutoCommit：文件是否自动提交，true 表示是，false表示否。'."\n" + .'- fileAutoDeploy：文件是否自动发布，true 表示是，false表示否。', + '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' => '导入导出包的描述信息。', + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => 'test description', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回数据。', + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => [ + 'description' => 'HTTP状态码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Data' => [ + 'description' => '导入导出包ID。作为后续执行导入任务或获取导入任务执行进度的入参。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '123456', + ], + 'ErrorMessage' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'test error message', + ], + 'RequestId' => [ + 'description' => '请求的ID。用于定位日志，排查问题。', + 'type' => 'string', + 'example' => 'ADFASDFASDFA-ADFASDF-ASDFADSDF-AFFADS', + ], + 'ErrorCode' => [ + 'description' => '错误码。', + 'type' => 'string', + 'example' => '110001123456', + ], + 'Success' => [ + 'description' => '调用是否成功。', + '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' => '创建导入迁移', + 'summary' => '调用CreateImportMigration创建导入任务，导入任务包含数据源信息、任务、表等对象的DataWorks导入导出包。', + 'description' => '注意：本接口导入文件涉及文件上传，方式调用举例如下：'."\n" + ."\n\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' => '项目空间的ID。您可以进入DataWorks项目空间的设置页面查看。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + 'minimum' => '2', + 'example' => '123456', + ], + ], + [ + 'name' => 'MigrationId', + 'in' => 'formData', + 'schema' => [ + 'description' => '导入导出包的ID。您可以调用CreateImportMigration接口获取。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + 'minimum' => '1', + 'example' => '123456', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回数据。', + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => [ + 'description' => 'HTTP状态码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'SADFSDFSD-SDFSDF-XDXCVX-ESWW', + ], + 'ErrorMessage' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'test error msg', + ], + 'Success' => [ + 'description' => '请求是否成功。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'ErrorCode' => [ + 'description' => '错误码。', + 'type' => 'string', + 'example' => '110001123456', + ], + 'Data' => [ + 'description' => '导入导出任务的进度信息，包括导入导出任务所有步骤的名称和进度状态。', + 'type' => 'array', + 'items' => [ + 'description' => '返回的任务状态。', + 'type' => 'object', + 'properties' => [ + 'TaskStatus' => [ + 'description' => '导入导出任务的步骤运行状态。取值如下：'."\n" + ."\n" + .'- INIT，初始状态。'."\n" + .'- RUNNING，运行中。'."\n" + .'- FAILURE，运行失败。'."\n" + .'- SUCCESS，运行成功。', + 'type' => 'string', + 'example' => 'SUCCESS', + ], + 'TaskName' => [ + 'description' => '导入导出任务的步骤名称。', + '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' => '获取迁移过程', + 'summary' => '调用GetMigrationProcess获取导入导出任务的进度状态。', + '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' => '项目空间的ID。您可以进入DataWorks项目空间的设置页面查看。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + 'minimum' => '2', + 'example' => '123456', + ], + ], + [ + 'name' => 'MigrationId', + 'in' => 'formData', + 'schema' => [ + 'description' => '导入导出包的ID。您可以调用[CreateImportMigration](~~206094~~)接口获取导入包ID，调用[CreateExportMigration](~~349325~~)接口获取导出包ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + 'minimum' => '2', + 'example' => '123456', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => [ + 'description' => 'HTTP状态码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Data' => [ + 'description' => '启动执行导入导出任务的状态信息。'."\n" + .'- true，任务启动成功。'."\n" + .'- false，任务启动失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'ErrorMessage' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'test error msg', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'FSDFSDF-WERWER-XVCX-DSFSDF', + ], + 'ErrorCode' => [ + 'description' => '错误码。', + 'type' => 'string', + 'example' => '110001123445', + ], + 'Success' => [ + 'description' => '调用是否成功。', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + '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' => '开始迁移', + 'summary' => '调用StartMigration启动执行导入导出任务。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'CreateExportMigration' => [ + 'summary' => '使用CreateExportMigration，新建DataWorks导出任务且仅创建导出任务。', + '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' => 'DataWorks工作空间的ID。您可以登录[DataWorks控制台](https://workbench.data.aliyun.com/console)，进入工作空间配置页面获取工作空间ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '12345', + ], + ], + [ + 'name' => 'Name', + 'in' => 'formData', + 'schema' => [ + 'description' => '导出任务的名称。'."\n" + ."\n" + .'名称必须唯一，即当前DataWorks工作空间中不能存在名称重复的导出任务。', + 'type' => 'string', + 'required' => true, + 'example' => 'test_export_01', + ], + ], + [ + 'name' => 'ExportMode', + 'in' => 'formData', + 'schema' => [ + 'description' => '任务的导出模式，取值如下：'."\n" + .'- FULL：全量导出目标任务。'."\n" + .'- INCREMENTAL：从指定的时间点开始，增量导出目标任务。选择该模式时，需要同时配置IncrementalSince参数。', + 'type' => 'string', + 'required' => true, + 'example' => 'FULL', + 'enum' => [ + 'FULL', + 'INCREMENTAL', + ], + ], + ], + [ + 'name' => 'IncrementalSince', + 'in' => 'formData', + 'schema' => [ + 'description' => '增量导出目标任务的起始时间。'."\n" + ."\n" + .'当ExportMode参数配置为INCREMENTAL时，IncrementalSince参数才生效。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1589904000000', + ], + ], + [ + 'name' => 'ExportObjectStatus', + 'in' => 'formData', + 'schema' => [ + 'description' => '导出任务的状态。系统会根据所选状态导出指定状态的任务。取值如下：'."\n" + .'- SAVED：保存状态，即导出已保存的任务。'."\n" + .'- SUBMITTED：提交状态，即导出已提交的任务。'."\n" + .'- DEPLOYED：发布状态，即导出已发布的任务。', + 'type' => 'string', + 'required' => false, + 'example' => 'SAVED', + 'default' => 'SAVED', + 'enum' => [ + 'SAVED', + 'SUBMITTED', + 'DEPLOYED', + ], + ], + ], + [ + 'name' => 'Description', + 'in' => 'formData', + 'schema' => [ + 'description' => '导出任务的描述信息。', + 'type' => 'string', + 'required' => false, + 'example' => 'test', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。用于定位日志，排查问题。', + 'type' => 'string', + 'example' => '34267E2E-0335-1A60-A1F0-ADA530890CBA', + ], + 'Data' => [ + 'description' => '导出任务的ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1234', + ], + 'Success' => [ + 'description' => '调用是否成功。取值如下：'."\n" + .'- true：调用成功。'."\n" + .'- false：调用失败，您可以根据请求ID定位具体问题。', + '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' => '创建导出任务', + ], + 'GetMigrationSummary' => [ + 'summary' => '调用GetMigrationSummary，获取导入导出任务的信息。', + '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' => 'DataWorks工作空间的ID。您可以登录[DataWorks控制台](https://workbench.data.aliyun.com/console)，进入工作空间配置页面获取工作空间ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + 'minimum' => '2', + 'example' => '12345', + ], + ], + [ + 'name' => 'MigrationId', + 'in' => 'formData', + 'schema' => [ + 'description' => '导入导出任务的ID。'."\n" + ."\n" + .'您可以调用[CreateImportMigration](~~2780280~~)接口获取导入任务的ID，调用[CreateExportMigration](~~2780281~~)接口获取导出任务的ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + 'minimum' => '1', + 'example' => '1234', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求的ID。用于定位日志，排查问题。', + 'type' => 'string', + 'example' => '19999A96-71BA-1845-B455-ED620EF4E37F', + ], + 'Success' => [ + 'description' => '调用是否成功。取值如下：'."\n" + .'- true：调用成功。'."\n" + .'- false：调用失败。您可以通过请求ID定位问题。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Data' => [ + 'description' => '请求返回的导入导出任务详情。', + 'type' => 'object', + 'properties' => [ + 'MigrationId' => [ + 'description' => '任务的ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1234', + ], + 'Name' => [ + 'description' => '任务的名称。', + 'type' => 'string', + 'example' => 'test_export_01', + ], + 'GmtCreate' => [ + 'description' => '任务的创建时间。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1589904000000', + ], + 'GmtModified' => [ + 'description' => '任务的修改时间。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1589904000000', + ], + 'CreateUser' => [ + 'description' => '任务创建人的用户ID。', + 'type' => 'string', + 'example' => '982293332403****', + ], + 'OpUser' => [ + 'description' => '任务操作人的用户ID。', + 'type' => 'string', + 'example' => '982293332403****', + ], + 'Status' => [ + 'description' => '导入导出任务的执行状态。取值如下：'."\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：仅部分任务导入或导出成功。', + 'type' => 'string', + 'example' => 'EXPORT_SUCCESS', + ], + 'ProjectId' => [ + 'description' => '任务所在DataWorks空间的ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '12345', + ], + 'DownloadUrl' => [ + 'description' => '导出任务包的下载链接。您可以通过该链接下载导出任务。', + 'type' => 'string', + 'example' => 'https://shanghai-xxx-oss.oss-cn-shanghai.aliyuncs.com/pre/store/f10_bf47_b4fa7df0860f.zip?Expires=1639540903&OSSAccessKeyId=****&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&OSSAccessKeyId=XXXXXXeF4Lv5j&Signature=qxxxxx</DownloadUrl>\\n </Data>\\n</GetMigrationSummaryResponse>","errorExample":""}]', + 'title' => '获取导入导出任务的信息', + ], + 'ListMigrations' => [ + 'summary' => '获取导入导出迁移任务列表。', + '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' => 'DataWorks工作空间的ID。您可以登录[DataWorks控制台](https://workbench.data.aliyun.com/console)，进入工作空间配置页面获取工作空间ID。', + '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' => '迁移任务的操作类型。包括：IMPORT、EXPORT。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'enumValueTitles' => [], + 'example' => 'IMPORT', + 'enum' => [ + 'IMPORT', + 'EXPORT', + ], + ], + ], + [ + 'name' => 'Owner', + 'in' => 'formData', + 'schema' => [ + 'description' => '负责人的ID。', + 'type' => 'string', + 'required' => false, + 'example' => '193379****', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'formData', + 'schema' => [ + 'description' => '请求数据的页码数。默认值：1 ，最大值100'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '100', + 'minimum' => '1', + 'example' => '1', + 'default' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'formData', + 'schema' => [ + 'description' => '每页显示的数据条数，默认值10，最大值为100。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '100', + 'minimum' => '10', + 'example' => '10', + 'default' => '10', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回数据结构。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID，一次请求的唯一标识。', + 'type' => 'string', + 'example' => 'F9198AA3-9010-53D5-9714-DC4****', + ], + 'Success' => [ + 'description' => '请求是否成功。取值如下：'."\n" + .'- true：成功。'."\n" + .'- false：失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Data' => [ + 'description' => '返回数据。', + 'type' => 'object', + 'properties' => [ + 'Migrations' => [ + 'description' => '迁移任务列表。', + 'type' => 'array', + 'items' => [ + 'description' => '迁移任务。', + 'type' => 'object', + 'properties' => [ + 'Id' => [ + 'description' => '主键ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '436064', + ], + 'Name' => [ + 'description' => '任务名称。', + 'type' => 'string', + 'example' => 'test_task_1638498642279', + ], + 'PackageType' => [ + 'description' => '导入导出包的类型，取值如下：'."\n" + .'- DWMA（标准格式）'."\n" + .'- DATAWORKS_MODEL（标准格式）'."\n" + .'- DATAWORKS_V2（专有云（V3.6.1-V3.11））'."\n" + .'- DATAWORKS_V3（专有云（V3.12及以上））'."\n" + ."\n" + .'DWMA和DATAWORKS_MODEL可通用'."\n", + 'type' => 'string', + 'enumValueTitles' => [], + 'example' => 'DATAWORKS_MODEL', + ], + 'MigrationType' => [ + 'description' => '迁移任务的操作类型。'."\n" + ."\n" + .'- IMPORT'."\n" + .'- EXPORT', + 'type' => 'string', + 'enumValueTitles' => [], + 'example' => 'EXPORT', + ], + 'CreateTime' => [ + 'description' => '创建时间。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '123124123123123', + ], + 'UpdateTime' => [ + 'description' => '更新时间。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '123123123123123', + ], + 'CreateUser' => [ + 'description' => '创建人。', + 'type' => 'string', + 'example' => '123123****', + ], + 'CreateUserName' => [ + 'description' => '创建人名称。', + 'type' => 'string', + 'example' => '3h1_test', + ], + 'UpdateUser' => [ + 'description' => '更新人。', + 'type' => 'string', + 'example' => '1231****', + ], + 'UpdateUserName' => [ + 'description' => '更新人名称。', + 'type' => 'string', + 'example' => '3h1_test', + ], + 'ProjectId' => [ + 'description' => '任务所在DataWorks空间的ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '72132', + ], + 'TenantId' => [ + 'description' => '租户ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '16307', + ], + 'Status' => [ + 'description' => '导入导出迁移任务的执行状态。取值如下：'."\n" + .'- INIT：任务为初始状态。'."\n" + .'- EDITING：任务在编辑中。'."\n" + .'- RUNNING，任务在运行中。'."\n" + .'- FAILURE，任务运行失败。'."\n" + .'- SUCCESS，任务运行成功。', + 'type' => 'string', + 'enumValueTitles' => [], + 'example' => 'SUCCESS', + ], + 'Message' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'An internal system error occurred. datasource kafka region is not cn-chengdu, can\'t open network for it', + ], + 'DownloadUrl' => [ + 'description' => '导出任务包的下载链接。您可以通过该链接下载导出任务。', + 'type' => 'string', + 'example' => 'http://geoip-sdk-user.oss-cn-zhangjiakou.aliyuncs.com/product/v1/ipv4/trace/v1.20220424123842.dex?Expires=1650780849&OSSAccessKeyId=*****&Signature=qxxxxx', + ], + 'Description' => [ + 'description' => '导出任务的描述信息。', + 'type' => 'string', + 'example' => 'Automated Test creation', + ], + ], + ], + ], + 'PageNumber' => [ + 'description' => '当前的页数。'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '每页显示的条数，默认为10条，最大为50条。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'TotalCount' => [ + 'description' => '总记录数。', + '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&OSSAccessKeyId=XXXXXXeF4Lv5j&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' => '获取迁移任务列表', + ], + 'CreatePermissionApplyOrder' => [ + 'summary' => '创建一个权限申请单。', + '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' => '申请权限的阿里云账户UID，当同时为多个账号申请权限时，使用逗号（,）隔开。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '26784260040899****,26784260040899****', + ], + ], + [ + 'name' => 'Deadline', + 'in' => 'query', + 'schema' => [ + 'description' => '申请权限的到期时间。此处需要输入一个unix时间戳，不输入默认到期时间为2065年1月1日。'."\n" + .'如果MaxCompute项目未开启LabelSecurity，或申请的表字段安全等级为0或小于等于申请账号的安全等级时，只能申请永久权限。'."\n" + .'您可以进入DataWorks工作空间的管理页面，在MaxCompute引擎的高级配置页面，查看是否启动列级别访问控制。'."\n" + .'您可以进入DataWorks工作空间，在数据地图查看字段的安全等级，在成员管理页面查看账号的安全等级。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1617115071885', + ], + ], + [ + 'name' => 'ApplyReason', + 'in' => 'query', + 'schema' => [ + 'description' => '申请的原因。用于管理员进行评估审批。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'I need to use this table', + ], + ], + [ + 'name' => 'MaxComputeProjectName', + 'in' => 'query', + 'schema' => [ + 'description' => '申请权限的MaxCompute项目名称。', + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => 'aMaxcomputeProjectName', + ], + ], + [ + 'name' => 'WorkspaceId', + 'in' => 'query', + 'schema' => [ + 'description' => '申请权限的MaxCompute项目所属的DataWorks工作空间ID，您可以进入DataWorks工作空间配置页面，查询工作空间ID。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'docRequired' => false, + 'maximum' => '999999', + 'minimum' => '0', + 'example' => '12345', + ], + ], + [ + 'name' => 'OrderType', + 'in' => 'query', + 'allowEmptyValue' => true, + 'schema' => [ + 'description' => '该字段已废弃，设置为空即可', + 'type' => 'integer', + 'format' => 'int32', + 'deprecated' => true, + 'required' => false, + 'example' => '1', + 'enum' => [ + '1', + ], + ], + ], + [ + 'name' => 'EngineType', + 'in' => 'query', + 'allowEmptyValue' => true, + 'schema' => [ + 'description' => '该字段已废弃，设置为空即可', + 'type' => 'string', + 'deprecated' => true, + 'required' => false, + 'example' => 'odps', + 'enum' => [ + 'odps', + ], + ], + ], + [ + 'name' => 'ApplyObject', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '申请对象列表。', + 'type' => 'array', + 'items' => [ + 'description' => '返回对象。', + 'type' => 'object', + 'properties' => [ + 'Actions' => [ + 'description' => '申请的权限类型，一次申请多种类型权限时使用逗号（,）分隔。目前仅支持申请Select、Describe、Drop、Alter、Update、Download类型。', + 'type' => 'string', + 'required' => false, + 'example' => 'Select,Describe', + ], + 'ColumnMetaList' => [ + 'description' => '字段对象列表。', + 'type' => 'array', + 'items' => [ + 'description' => '返回对象。', + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'description' => '申请目标列的权限，此处输入列名称。如果申请全表的权限，则需要输入表的所有列名。'."\n" + .'仅当MaxCompute项目开启了labelSecurity，才可以申请部分列的权限。如果MaxCompute项目没有开启labelSecurity，则只能申请全表的权限。', + 'type' => 'string', + 'required' => false, + 'example' => 'aColumnName', + ], + 'Actions' => [ + 'description' => '申请的权限类型，一次申请多种类型权限时使用逗号（,）分隔。目前仅支持申请Select、Describe、Download类型。', + 'type' => 'string', + 'required' => false, + 'example' => 'Select', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 200, + ], + 'Name' => [ + 'description' => '申请的对象。目前仅支持申请MaxCompute表的权限，此处需要输入目标表的名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'aTableName', + ], + ], + 'required' => false, + ], + 'required' => true, + 'maxItems' => 50, + ], + ], + [ + 'name' => 'ApplyType', + 'in' => 'query', + 'schema' => [ + 'description' => '设置申请单类型，枚举值为：'."\n" + ."\n" + .'- [ MaxComputeTable] MaxCompute表权限申请单'."\n" + .'- [ MaxComputeFunction] MaxCompute函数申请单'."\n" + .'- [ MaxComputeResource] MaxCompute资源申请单'."\n" + .'- [ DLFSchema] DLF1.0版本Schema权限申请单'."\n" + .'- [ DLFTable] DLF1.0版本表权限申请单'."\n" + .'- [ DLFColumn] DLF1.0版本列权限申请单'."\n" + .'- [ DsApiDeploy] 发布数据服务权限申请单', + 'type' => 'string', + 'required' => false, + 'example' => 'MaxComputeTable', + 'default' => 'MaxComputeTable', + 'enum' => [ + 'MaxComputeTable', + 'DLFSchema', + 'DLFTable', + 'DLFColumn', + 'DsApiDeploy', + ], + ], + ], + [ + 'name' => 'CatalogName', + 'in' => 'query', + 'schema' => [ + 'description' => '查询的数据目录名称。您可前往[数据湖控制台](https://dlf.console.aliyun.com/cn-hangzhou/metadata/catalog?spm=a2c4g.11186623.0.0.5a225658pT4Dkr)查看数据目录名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'hive', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回对象。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '0bc1ec92159376****', + ], + 'FlowId' => [ + 'description' => '流程id列表。', + 'type' => 'array', + 'items' => [ + 'description' => '生成的申请单ID。当同时申请多个对象并且各个对象的审批人不同时，会根据不同的审批人生成多张申请单，此时会返回一个数组。', + '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' => '创建权限申请单', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'GetPermissionApplyOrderDetail' => [ + 'summary' => '查询一个权限申请单的详细信息。', + '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' => '权限申请单ID。您可以调用[ListPermissionApplyOrders](~~211008~~)接口获取。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '48f36729-05f9-4a40-9286-933fd940****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回数据结构。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。'."\n", + 'type' => 'string', + 'example' => '0bc1ec92159376****', + ], + 'ApplyOrderDetail' => [ + 'description' => '申请单详情。', + 'type' => 'object', + 'properties' => [ + 'ApplyBaseId' => [ + 'description' => '提交申请单的阿里云用户UID。', + 'type' => 'string', + 'example' => '26784260040899****', + ], + 'ApplyTimestamp' => [ + 'description' => '发起申请单的时间，显示为一个unix时间戳。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1615284086000', + ], + 'FlowId' => [ + 'description' => '申请单ID。', + 'type' => 'string', + 'example' => 'ad8da78d-8135-455e-9486-27cf213f****', + ], + 'FlowStatus' => [ + 'description' => '申请单的状态。取值如下：'."\n" + .'- 1：待审批。'."\n" + .'- 2：审批通过，授权成功。'."\n" + .'- 3：审批通过，授权失败。'."\n" + .'- 4：审批拒绝。'."\n" + .'- 5：撤回申请单。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'ApproveAccountList' => [ + 'description' => '审批申请单的阿里云账号列表。', + 'type' => 'array', + 'items' => [ + 'description' => '返回数据结构。', + 'type' => 'object', + 'properties' => [ + 'BaseId' => [ + 'description' => '审批申请单的阿里云用户UID。', + 'type' => 'string', + 'example' => '182293110403****', + ], + ], + ], + ], + 'GranteeObjectList' => [ + 'description' => '申请权限的账号信息。', + 'type' => 'array', + 'items' => [ + 'description' => '返回数据结构。', + 'type' => 'object', + 'properties' => [ + 'GranteeType' => [ + 'description' => '申请权限的主体类型。目前只支持1（用户）。'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'GranteeTypeSub' => [ + 'description' => '申请权限的主体子类型，取值如下：'."\n" + .'- 101：生产云账号。'."\n" + .'- 103：个人云账号。'."\n" + .'- 105：代他人申请云账号。'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '103', + ], + 'GranteeName' => [ + 'description' => '申请权限的云账号名称。格式与MaxCompute的账号格式一致。'."\n" + .'- 主账号为ALIYUN$+账号名。'."\n" + .'- 子账号为RAM$+账号名。', + 'type' => 'string', + 'example' => 'RAM$dataworks_3h1_1:StsRamUser(StsRamUser)', + ], + 'GranteeId' => [ + 'description' => '申请权限的阿里云用户UID。', + 'type' => 'string', + 'example' => '26784260040899****', + ], + ], + ], + ], + 'ApproveContent' => [ + 'description' => '申请的具体内容。', + 'type' => 'object', + 'properties' => [ + 'ApplyReason' => [ + 'description' => '申请的原因，用于管理员审批参考。', + 'type' => 'string', + 'example' => 'I need to use this table', + ], + 'Deadline' => [ + 'description' => '申请权限的到期时间。此处显示为一个unix时间戳。'."\n" + .'如果MaxCompute项目未开启LabelSecurity，或申请的表字段安全等级为0或小于等于申请账号的安全等级时，只能申请永久权限。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1617115071885', + ], + 'OrderType' => [ + 'description' => '申请单类型。目前仅支持取值为1，表示对象ACL权限申请。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'ProjectMeta' => [ + 'description' => '申请对象所属的项目和工作空间信息。', + 'type' => 'object', + 'properties' => [ + 'MaxComputeProjectName' => [ + 'description' => '申请对象所在的MaxCompute项目。', + 'type' => 'string', + 'example' => 'aMaxComputeProject', + ], + 'WorkspaceId' => [ + 'description' => '申请对象所在的DataWorks工作空间ID。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '123456', + ], + 'ObjectMetaList' => [ + 'description' => '申请对象的详细信息。', + 'type' => 'array', + 'items' => [ + 'description' => '返回数据结构。', + 'type' => 'object', + 'properties' => [ + 'ObjectName' => [ + 'description' => '申请的表名。', + 'type' => 'string', + 'example' => 'aTableName', + ], + 'ColumnMetaList' => [ + 'description' => '申请对象的列字段信息。', + 'type' => 'array', + 'items' => [ + 'description' => '返回数据结构。', + 'type' => 'object', + 'properties' => [ + 'ColumnName' => [ + 'description' => '申请的列名称。', + 'type' => 'string', + 'example' => 'aColumnName', + ], + 'ColumnComment' => [ + 'description' => '申请的列描述。', + 'type' => 'string', + 'example' => 'Field description', + ], + 'SecurityLevel' => [ + 'description' => '申请的列安全级别。取值范围为0~9。', + 'type' => 'string', + 'example' => '9', + ], + 'ColumnActions' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + 'Actions' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'FinishAapprovalTimestamp' => [ + 'description' => '最终审批结束时间。显示为一个unix时间戳。', + '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' => '查询权限申请单的详细信息', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'ListPermissionApplyOrders' => [ + 'summary' => '查询权限申请单列表。', + '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' => '申请单的状态。取值如下：'."\n" + .'- 1：待审批。'."\n" + .'- 2：审批通过，授权成功。'."\n" + .'- 3：审批通过，授权失败。'."\n" + .'- 4：审批拒绝。'."\n" + .'- 5: 撤回申请单', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + 'enum' => [ + '0', + '1', + '2', + '3', + '4', + '5', + ], + ], + ], + [ + 'name' => 'WorkspaceId', + 'in' => 'query', + 'schema' => [ + 'description' => '申请单所属的工作空间ID，不输入则返回所有工作空间的申请单。您可登录DataWorks控制台，进入工作空间配置页面，查询工作空间ID。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '12345', + ], + ], + [ + 'name' => 'OrderType', + 'in' => 'query', + 'schema' => [ + 'description' => '该字段已废弃，不会生效', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'docRequired' => false, + 'maximum' => '1', + 'minimum' => '0', + 'example' => '1', + 'enum' => [ + '1', + '0', + ], + ], + ], + [ + 'name' => 'MaxComputeProjectName', + 'in' => 'query', + 'schema' => [ + 'description' => '申请单所属的MaxCompute项目名称，不输入则返回所有MaxCompute项目的申请单。', + 'type' => 'string', + 'required' => false, + 'example' => 'aMaxComputeProject', + ], + ], + [ + 'name' => 'TableName', + 'in' => 'query', + 'schema' => [ + 'description' => '申请单包含的表名称，不输入则返回所有表的申请单。', + 'type' => 'string', + 'required' => false, + 'example' => 'aTableName', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '查询目标起始时间发起的申请单，配置为一个unix时间戳。不输入则表示查询所有的申请单。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1616200471885', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '查询目标截至时间的申请单，配置为一个unix时间戳。不输入则表示查询截至当前时间的申请单。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1617200471885', + ], + ], + [ + 'name' => 'EngineType', + 'in' => 'query', + 'allowEmptyValue' => true, + 'schema' => [ + 'description' => '该字段已废弃，不会生效', + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => 'odps', + 'enum' => [ + 'odps', + ], + ], + ], + [ + 'name' => 'PageNum', + 'in' => 'query', + 'schema' => [ + 'description' => '分页查询页码。大于等于1的正整数，默认为1。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + 'default' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '每页显示的条数，默认为10条，最大100条。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '100', + 'default' => '10', + ], + ], + [ + 'name' => 'QueryType', + 'in' => 'query', + 'schema' => [ + 'description' => '申请单的查询类型。取值如下：'."\n" + .'- 0：我提交的申请单。'."\n" + .'- 1：由我审批的申请单。'."\n" + .'- 2: 全部申请单', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'docRequired' => true, + 'maximum' => '2', + 'minimum' => '0', + 'example' => '1', + 'enum' => [ + '0', + '1', + '2', + ], + ], + ], + [ + 'name' => 'ApplyType', + 'in' => 'query', + 'schema' => [ + 'description' => '设置申请单类型，枚举值为：'."\n" + ."\n" + .'- [ MaxComputeTable] MaxCompute表权限申请单'."\n" + .'- [ MaxComputeFunction] MaxCompute函数申请单'."\n" + .'- [ MaxComputeResource] MaxCompute资源申请单'."\n" + .'- [ DLFSchema] DLF1.0版本Schema权限申请单'."\n" + .'- [ DLFTable] DLF1.0版本表权限申请单'."\n" + .'- [ DLFColumn] DLF1.0版本列权限申请单'."\n" + .'- [ DsApiDeploy] 发布数据服务权限申请单', + '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' => '查询的数据目录名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'hive', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '0bc1ec92159376****', + ], + 'ApplyOrders' => [ + 'description' => '权限申请单的分页查询结果。', + 'type' => 'object', + 'properties' => [ + 'PageSize' => [ + 'description' => '每页显示的条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'PageNumber' => [ + 'description' => '页码。'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'TotalCount' => [ + 'description' => '返回的权限申请单总数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '150', + ], + 'ApplyOrder' => [ + 'description' => '权限申请单列表。', + 'type' => 'array', + 'items' => [ + 'description' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'ApplyBaseId' => [ + 'description' => '提交申请单的阿里云用户UID。', + 'type' => 'string', + 'example' => '267842600408993176', + ], + 'ApplyTimestamp' => [ + 'description' => '申请单的提交时间，显示为一个unix时间戳。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1615284086000', + ], + 'FlowId' => [ + 'description' => '申请单ID。'."\n", + 'type' => 'string', + 'example' => 'ad8da78d-8135-455e-9486-27cf213fc140', + ], + 'FlowStatus' => [ + 'description' => '申请单的状态。取值如下：'."\n" + .'- 1：待审批。'."\n" + .'- 2：审批通过，授权成功。'."\n" + .'- 3：审批通过，授权失败。'."\n" + .'- 4：审批拒绝。'."\n" + .'- 5：撤回申请单。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'ApproveContent' => [ + 'description' => '申请单的内容。', + 'type' => 'object', + 'properties' => [ + 'ApplyReason' => [ + 'description' => '申请的原因。用于管理员进行评估审批。', + 'type' => 'string', + 'example' => 'I need to use this table', + ], + 'OrderType' => [ + 'description' => '申请单类型。目前仅支持取值为1，表示对象ACL权限申请。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'ProjectMeta' => [ + 'description' => '申请对象的内容。'."\n", + 'type' => 'object', + 'properties' => [ + 'WorkspaceName' => [ + 'description' => '申请权限的MaxCompute项目所属的DataWorks工作空间名称。', + 'type' => 'string', + 'example' => 'aWorkspaceName', + ], + 'ObjectMetaList' => [ + 'description' => '申请的对象信息。'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'ObjectName' => [ + 'description' => '申请的表名称。'."\n", + 'type' => 'string', + 'example' => 'aTableName', + ], + 'Actions' => [ + 'description' => '操作类型。', + 'type' => 'array', + 'items' => [ + 'description' => '申请的权限类型，一次申请多种类型权限时使用英文逗号（,）分隔。'."\n" + .'目前仅支持申请Select、Describe、Drop、Alter、Update、Download类型。', + 'type' => 'string', + 'example' => 'Select,Describe', + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'FinishApprovalTimestamp' => [ + 'description' => '最终审批结束时间。显示为一个unix时间戳。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1757496687000', + ], + 'FinishApprovalComment' => [ + 'description' => '最终审批意见。', + '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' => '查询权限申请单列表', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'ApprovePermissionApplyOrder' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'FlowId', + 'in' => 'query', + 'schema' => [ + 'description' => '审批的申请单ID，您可以调用[ListPermissionApplyOrders](~~211008~~)接口获取。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '48f36729-05f9-4a40-9286-933fd940f30a', + ], + ], + [ + 'name' => 'ApproveComment', + 'in' => 'query', + 'schema' => [ + 'description' => '审批的备注信息。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'agree', + ], + ], + [ + 'name' => 'ApproveAction', + 'in' => 'query', + 'schema' => [ + 'description' => '执行的审批动作，取值如下：'."\n" + .'- 1：同意。'."\n" + .'- 2：拒绝。', + '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' => '审批是否成功。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '0bc1ec92159376****', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"ApproveSuccess\\": true,\\n \\"RequestId\\": \\"0bc1ec92159376****\\"\\n}","errorExample":""},{"type":"xml","example":"<RequestId>0bc1ec92159376****</RequestId>\\n<ApproveSuccess>true</ApproveSuccess>","errorExample":""}]', + 'title' => '审批权限申请单', + 'summary' => '审批一个权限申请单。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'RevokeTablePermission' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'WorkspaceId', + 'in' => 'query', + 'schema' => [ + 'description' => '需要撤销权限的MaxCompute表所属的DataWorks工作空间ID。您可以登录DataWorks控制台，进入工作空间配置页面，查询工作空间ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + 'maximum' => '9999999', + 'minimum' => '1', + 'example' => '12345', + ], + ], + [ + 'name' => 'MaxComputeProjectName', + 'in' => 'query', + 'schema' => [ + 'description' => '需要撤销权限的表所在的MaxCompute项目名称。您可以登录DataWorks控制台，进入工作空间配置页面，查询DataWorks工作空间绑定的MaxCompute项目名称。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'aMaxcomputeProjectName', + ], + ], + [ + 'name' => 'TableName', + 'in' => 'query', + 'schema' => [ + 'description' => '需要撤销权限的MaxCompute表名称。您可以调用[SearchMetaTables](~~173919~~)接口，获取MaxCompute表名称。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'aTableName', + ], + ], + [ + 'name' => 'Actions', + 'in' => 'query', + 'schema' => [ + 'description' => '需要撤销的表的操作权限，一次撤销多种操作权限时使用逗号（,）分隔。'."\n" + .'目前仅支持撤销MaxCompute表的Select、Describe、Download等操作权限。'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'Select,Describe', + ], + ], + [ + 'name' => 'RevokeUserName', + 'in' => 'query', + 'schema' => [ + 'description' => '撤销表权限的云账号名称。账号格式与MaxCompute的账号格式一致。'."\n" + .'- 主账号为ALIYUN$+账号名。'."\n" + .'- 子账号为RAM$+账号名。'."\n" + ."\n" + .'该参数与RevokeUserId参数配置一个即可。如果同时配置了该参数与RevokeUserId参数，但二者取值不同，则系统会以RevokeUserId参数的配置内容为准。'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'RAM$dataworks_3h1_1:stsramuser', + ], + ], + [ + 'name' => 'RevokeUserId', + 'in' => 'query', + 'schema' => [ + 'description' => '撤销表权限的阿里云账号ID。您可以登录DataWorks控制台，进入安全设置页面获取账号ID。'."\n" + .'该参数与RevokeUserName参数配置一个即可。如果同时配置了该参数与RevokeUserName参数，但二者取值不同，则系统会以RevokeUserId参数的配置为准。', + 'type' => 'string', + 'required' => false, + 'example' => '267842600408993176', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RevokeSuccess' => [ + 'description' => '撤销操作是否成功。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '0bc1ec92159376****', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RevokeSuccess\\": true,\\n \\"RequestId\\": \\"0bc1ec92159376****\\"\\n}","errorExample":""},{"type":"xml","example":"<RevokeSuccess>true</RevokeSuccess>\\n<RequestId>0bc1ec92159376****</RequestId>","errorExample":""}]', + 'title' => '撤销用户的表权限', + 'summary' => '撤销用户的表权限。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'ListExtensions' => [ + 'summary' => '拉取开放平台的扩展程序列表。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '请求的数据页数，用于翻页。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '每页显示的条数', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request', + 'type' => 'string', + 'example' => '0000-ABCD-****', + ], + 'PagingInfo' => [ + 'description' => '分页信息', + 'type' => 'object', + 'properties' => [ + 'PageNumber' => [ + 'description' => '请求的数据页数，用于翻页。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '每页显示的条数', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'TotalCount' => [ + 'description' => '满足条件的数据总条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '12', + ], + 'Extensions' => [ + 'description' => '扩展程序列表', + 'type' => 'array', + 'items' => [ + 'description' => '扩展程序详情', + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => '扩展程序状态：'."\n" + .'0：测试中,'."\n" + .'1：上线中,'."\n" + .'3：禁用中,'."\n" + .'4：审批中,'."\n" + .'5：审批通过,'."\n" + .'6：审批不通过', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'ExtensionDesc' => [ + 'description' => '扩展程序描述', + 'type' => 'string', + 'example' => 'This is a description', + ], + 'ExtensionName' => [ + 'description' => '扩展程序名称', + 'type' => 'string', + 'example' => 'Extension name', + ], + 'Owner' => [ + 'description' => '子账号ID', + 'type' => 'string', + 'example' => '2003****', + ], + 'ExtensionCode' => [ + 'description' => '唯一的扩展程序码', + 'type' => 'string', + 'example' => 'Extension Code', + ], + 'BindEventList' => [ + 'description' => '扩展点事件列表', + 'type' => 'array', + 'items' => [ + 'description' => '事件详情', + 'type' => 'object', + 'properties' => [ + 'EventName' => [ + 'description' => '事件名称', + 'type' => 'string', + 'example' => 'File submission pre-event', + ], + 'EventCode' => [ + 'description' => '事件码', + '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' => '获取扩展程序列表', + ], + 'GetExtension' => [ + 'summary' => '获取某个扩展程序详情。', + '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' => '扩展程序唯一编码。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ce4*********086da5', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求的ID。用于定位日志，排查问题。', + 'type' => 'string', + 'example' => '0000-ABCD-EFG', + ], + 'Extension' => [ + 'description' => '扩展程序详情。', + 'type' => 'object', + 'properties' => [ + 'ExtensionCode' => [ + 'description' => '扩展程序唯一码。', + 'type' => 'string', + 'example' => 'ce4*********086da5', + ], + 'ExtensionName' => [ + 'description' => '扩展程序名称。', + 'type' => 'string', + 'example' => 'Extension name', + ], + 'ExtensionDesc' => [ + 'description' => '扩展程序描述。', + 'type' => 'string', + 'example' => 'This is a description', + ], + 'HelpDocUrl' => [ + 'description' => '扩展程序帮助文档链接。', + 'type' => 'string', + 'example' => 'https://www.aliyun.com/', + ], + 'Status' => [ + 'description' => '扩展程序状态： 0：测试中, 1：上线中, 3：禁用中, 4：审批中, 5：审批通过, 6：审批不通过。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'ProjectTesting' => [ + 'description' => '测试用的项目空间，当扩展程序处于测试中时，只有测试项目空间可使用。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1355211', + ], + 'DetailUrl' => [ + 'description' => '扩展程序详情地址，用来扩展程序使用者查看本次被卡流程的详情。', + 'type' => 'string', + 'example' => 'https://www.aliyun.com/', + ], + 'ParameterSetting' => [ + 'description' => '参数配置，参考[扩展程序参数配置](~~405354~~)。', + 'type' => 'string', + 'example' => 'extension.project.disabled=projectId1,projectId2,projectId3', + ], + 'OptionSetting' => [ + 'description' => '选项配置。', + 'type' => 'string', + 'example' => 'Option configuration', + ], + 'BindEventList' => [ + 'description' => '扩展点列表。', + 'type' => 'array', + 'items' => [ + 'description' => '扩展点详情。', + 'type' => 'object', + 'properties' => [ + 'EventCode' => [ + 'description' => '扩展点事件编码。', + 'type' => 'string', + 'example' => 'commit-file', + ], + 'EventName' => [ + 'description' => '扩展点事件名称。', + 'type' => 'string', + 'example' => 'File submission pre-event'."\n", + ], + ], + ], + ], + 'EventCategoryList' => [ + 'description' => '事件类型列表。', + 'type' => 'array', + 'items' => [ + 'description' => '事件类型详情。', + 'type' => 'object', + 'properties' => [ + 'CategoryCode' => [ + 'description' => '事件类型编码。', + 'type' => 'string', + 'example' => 'file-change', + ], + 'CategoryName' => [ + 'description' => '事件类型名称。', + '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' => '获取扩展程序详情', + ], + 'GetOptionValueForProject' => [ + 'summary' => '获取扩展程序选项配置在项目空间下的配置。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'ExtensionCode', + 'in' => 'formData', + 'schema' => [ + 'description' => '扩展程序的唯一编码。', + 'type' => 'string', + 'required' => false, + 'example' => 'ce4*********086da5', + ], + ], + [ + 'name' => 'ProjectId', + 'in' => 'formData', + 'schema' => [ + 'description' => '工作空间的ID。', + 'type' => 'string', + 'required' => false, + 'example' => '234', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '返回数据。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'E6F0DBDD-5AD****', + ], + 'OptionValue' => [ + 'description' => '返回数据。示例中的cuNumber为自定义的Key。', + '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' => '获取扩展程序选项配置在项目空间下的配置', + ], + 'ListEnabledExtensionsForProject' => [ + 'summary' => '调用ListEnabledExtensionsForProject来获取项目空间下已经开启的扩展程序列表，包含系统扩展程序和自定义扩展程序。', + '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' => '扩展点事件编码。', + 'type' => 'string', + 'required' => true, + 'example' => 'commit-file', + ], + ], + [ + 'name' => 'ProjectId', + 'in' => 'formData', + 'schema' => [ + 'description' => 'DataWorks工作空间的ID。您可以[登录DataWorks控制台](https://workbench.data.aliyun.com/console?spm=a2c4g.11186623.0.0.6b4d4941azHd2k)，进入工作空间配置页面获取工作空间ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '10000', + ], + ], + [ + 'name' => 'FileType', + 'in' => 'formData', + 'schema' => [ + 'description' => '文件的代码类型。'."\n" + ."\n" + .'不同文件类型其代码不同，详情请参见[DataWorks节点合集](~~600169~~)。'."\n" + .'您也可以调用[ListFileType](~~212428~~)接口，查询文件的代码类型。', + 'type' => 'string', + 'required' => false, + 'example' => '10', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '返回结果', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求唯一ID', + 'type' => 'string', + 'example' => '4F2CA7ED-27E5-59EA-A8C4-F1F7A1FF0B22', + ], + 'Extensions' => [ + 'description' => '扩展程序详情', + 'type' => 'array', + 'items' => [ + 'description' => '扩展程序', + 'type' => 'object', + 'properties' => [ + 'ExtensionCode' => [ + 'description' => '扩展程序唯一编码。', + 'type' => 'string', + 'example' => 'a94a8e23bc0b4dfab9a5e4d2f374d645', + ], + 'ExtensionName' => [ + 'description' => '扩展程序名称', + 'type' => 'string', + 'example' => 'max_pt function is not allowed.', + ], + 'TenantId' => [ + 'description' => '租户ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '52988951865****', + ], + 'CreateUser' => [ + 'description' => '创建人', + 'type' => 'string', + 'example' => '3444434343555', + ], + 'ModifyUser' => [ + 'description' => '修改人', + 'type' => 'string', + 'example' => '34452335611988', + ], + 'ExtensionDesc' => [ + 'description' => '扩展程序描述', + 'type' => 'string', + 'example' => 'ODPS SQL compatible Spark engine detection', + ], + 'Owner' => [ + 'description' => '责任人ID。', + 'type' => 'string', + 'example' => '21323672*******55500', + ], + 'ParameterSetting' => [ + 'description' => '参数配置，参考[扩展程序参数配置](~~405354~~)。', + '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' => '获取已经开启的扩展程序列表', + 'description' => 'eventCode取值可参考文档：[扩展事件编码](~~463357~~)。', + ], + 'CallbackExtension' => [ + 'summary' => '用于在DataWorks平台使用过程中触发扩展点时，通过调用CallbackExtension接口，将扩展程序对扩展点事件的检查结果返回给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' => '扩展程序唯一编码。', + 'type' => 'string', + 'required' => true, + 'example' => '8abcb91f-d266-4073-b907-2****', + ], + ], + [ + 'name' => 'MessageId', + 'in' => 'formData', + 'schema' => [ + 'description' => 'DataWorks开放消息的消息ID。当触发扩展点事件后，您可以从接收到的事件消息中获取消息ID。'."\n" + ."\n" + .'<props="china">消息格式，可参考[消息格式](~~215367~~)。</props>'."\n" + ."\n", + 'type' => 'string', + 'required' => true, + 'example' => '034********091', + ], + ], + [ + 'name' => 'CheckResult', + 'in' => 'formData', + 'schema' => [ + 'description' => '扩展程序对本次扩展点事件的检查状态。取值如下：'."\n" + .'- OK：扩展程序对本次扩展点事件检查通过。'."\n" + .'- FAIL：扩展程序对本次扩展点事件检查不通过。您需要查看并及时处理报错，以免影响后续程序的正常执行。'."\n" + .'- WARN：扩展程序对本次扩展点事件检查通过，但存在警告。', + 'type' => 'string', + 'required' => true, + 'example' => 'FAIL', + 'enum' => [ + 'OK', + 'FAIL', + 'WARN', + ], + ], + ], + [ + 'name' => 'CheckMessage', + 'in' => 'formData', + 'schema' => [ + 'description' => '当CheckResult设置为FAIL，提供FAIL原因', + 'type' => 'string', + 'required' => false, + 'example' => 'The xxx rule is hit. Modify it and try again.', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '返回结果', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '唯一的请求ID', + 'type' => 'string', + 'example' => '7C352CB7-CD88-50CF-9D0D-E81BDF020E7F', + ], + 'Success' => [ + 'description' => '调用是否成功。取值如下：'."\n" + ."\n" + .'true：调用成功。'."\n" + ."\n" + .'false：调用失败。', + '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' => '返回扩展程序对扩展点事件的检查结果', + ], + 'ListCheckProcesses' => [ + 'summary' => '查询扩展事件的检查列表。', + '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' => '工作空间的ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '123465', + ], + ], + [ + 'name' => 'EventCode', + 'in' => 'formData', + 'schema' => [ + 'description' => '扩展点事件编码。', + 'type' => 'string', + 'required' => true, + 'example' => 'commit-file', + ], + ], + [ + 'name' => 'Operator', + 'in' => 'formData', + 'schema' => [ + 'description' => '操作者ID。', + 'type' => 'string', + 'required' => false, + 'example' => '123333', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'formData', + 'schema' => [ + 'description' => '分页查询，每页显示的条数。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '100', + 'minimum' => '10', + 'example' => '10', + 'default' => '10', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'formData', + 'schema' => [ + 'description' => '分页查询时的页码，默认值为1。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + 'default' => '1', + ], + ], + [ + 'name' => 'Status', + 'in' => 'formData', + 'schema' => [ + 'description' => '扩展程序检查状态。'."\n" + .'- CHECKING 检查中'."\n" + .'- PASSED 检查通过'."\n" + .'- BLOCKED 检查不通过', + 'type' => 'string', + 'required' => false, + 'example' => 'True', + 'enum' => [ + 'CHECKING', + 'PASSED', + 'BLOCKED', + ], + ], + ], + [ + 'name' => 'MessageId', + 'in' => 'formData', + 'schema' => [ + 'description' => 'DataWorks开放消息的消息ID。当触发扩展点事件后，您可以从接收到的事件消息中获取消息ID。'."\n" + ."\n" + .'<props="china">消息格式，可参考[消息格式](~~215367~~)。</props>', + 'type' => 'string', + 'required' => false, + 'example' => '03400b03-b721-4c34-8727-2****1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '0000-ABCD-EF****', + ], + 'PagingInfo' => [ + 'description' => '分页信息。', + 'type' => 'object', + 'properties' => [ + 'PageNumber' => [ + 'description' => '页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '每页显示的条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'TotalCount' => [ + 'description' => '总数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '12', + ], + 'CheckProcesses' => [ + 'description' => '扩展程序检查详情。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ProjectId' => [ + 'description' => 'DataWorks 工作空间的 ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '32563', + ], + 'Status' => [ + 'description' => '扩展程序检查状态。'."\n" + .'- CHECKING 检查中'."\n" + .'- PASSED 检查通过'."\n" + .'- BLOCKED 检查不通过', + 'type' => 'string', + 'example' => 'CHECKING', + ], + 'EventCode' => [ + 'description' => '扩展点事件编码。', + 'type' => 'string', + 'example' => 'commit-file', + ], + 'EventName' => [ + 'description' => '扩展点事件名称。', + 'type' => 'string', + 'example' => 'DnsEvent', + ], + 'EventNameEn' => [ + 'description' => '事件的英文名称。', + 'type' => 'string', + 'example' => 'Pre-event for Node Commit', + ], + 'ProcessName' => [ + 'description' => '操作对象的名称，比如文件名称，节点名称等。', + 'type' => 'string', + 'example' => 'odps_sql_test', + ], + 'MessageId' => [ + 'description' => 'DataWorks开放消息的消息ID。当触发扩展点事件后，您可以从接收到的事件消息中获取消息ID。', + 'type' => 'string', + 'example' => 'b824a5de-4223-4315-af3e-c4449d236db4', + ], + 'ProcessId' => [ + 'description' => '流程实例ID。', + 'type' => 'string', + 'example' => 'rdk_generate_d395da25-b0d3-4114-b2a5-d0247444a661_none_3496903_365203', + ], + 'Operator' => [ + 'description' => '操作人id。', + 'type' => 'string', + 'example' => '297635', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + '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' => '查询扩展事件的检查列表', + ], + 'UpdateTableAddColumn' => [ + 'summary' => '更新MaxCompute表的字段信息。', + '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' => 'MaxCompute表的唯一标识。格式为odps.projectName.tableName。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'odps.engine_name.table_name', + ], + ], + [ + 'name' => 'Column', + 'in' => 'formData', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '字段列表', + 'type' => 'array', + 'items' => [ + 'description' => '字段对象。', + 'type' => 'object', + 'properties' => [ + 'ColumnNameCn' => [ + 'description' => '字段的中文名称。', + 'type' => 'string', + 'required' => false, + 'example' => '中文', + ], + 'ColumnName' => [ + 'description' => '字段的名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'abc', + ], + 'Comment' => [ + 'description' => '字段的备注信息。', + 'type' => 'string', + 'required' => false, + 'example' => 'Remarks', + ], + 'ColumnType' => [ + 'description' => '字段的类型，请参见MaxCompute支持的字段类型。', + 'type' => 'string', + 'required' => true, + 'example' => 'string', + ], + ], + 'required' => false, + ], + 'required' => true, + 'maxItems' => 100, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回对象', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'abc', + ], + 'TaskInfo' => [ + 'description' => '请求任务的信息。'."\n" + .'请求任务提交成功后，会被分为多个子任务有序执行。当前子任务执行成功后，才会继续执行下一个子任务，所有子任务执行完毕，该请求任务结束。如下情况，请求任务会终止，您需要根据错误码信息解决问题后重新发起请求任务：'."\n" + .'- 请求任务提交失败。'."\n" + .'- 请求任务提交成功后，任意子任务执行失败。', + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => '当前执行的子任务的状态信息。取值如下：'."\n" + .'- operating表示子任务正在执行中。'."\n" + .'- success表示子任务执行成功。'."\n" + .'- failure表示子任务执行失败。详细的报错信息请参见Content参数。', + 'type' => 'string', + 'example' => 'success', + ], + 'NextTaskId' => [ + 'description' => '即将执行的子任务ID。如果该字段为空，则表示所有子任务均已结束。', + 'type' => 'string', + 'example' => 'abc1', + ], + 'TaskId' => [ + 'description' => '当前执行的子任务ID。', + 'type' => 'string', + 'example' => 'abc2', + ], + 'Content' => [ + 'description' => '当前子任务的执行状态详细信息。具体如下：'."\n" + .'- 执行成功，则显示success。'."\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' => '更新表的字段信息', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'GetMetaTableFullInfo' => [ + 'summary' => '获取表的完整信息（包括字段信息）。', + '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' => '表的唯一标识。您可以通过调用[GetMetaDBTableList](~~173916~~)，获取表的唯一标识。', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => 'odps.engine_name.table_name', + ], + ], + [ + 'name' => 'PageNum', + 'in' => 'query', + 'schema' => [ + 'description' => '请求获取的页码数，用于分页。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '每页显示的条数，默认为10条，最大100条。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'ClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'EMR集群的ID，仅当数据类型为EMR时，需要配置该参数。'."\n" + ."\n" + .'您可以登录[EMR的控制台](https://emr.console.aliyun.com/?spm=a2c4g.11186623.0.0.965cc5c2GeiHet#/cn-hangzhou)，获取集群ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'C-010A704DA760****', + ], + ], + [ + 'name' => 'DatabaseName', + 'in' => 'query', + 'schema' => [ + 'description' => '数据库的名称。仅当数据类型为EMR时，需要配置该参数。'."\n" + ."\n" + .'您可以调用[ListMetaDB](~~185662~~)接口获取。', + 'type' => 'string', + 'required' => false, + 'example' => 'abc', + ], + ], + [ + 'name' => 'TableName', + 'in' => 'query', + 'schema' => [ + 'description' => 'EMR的表名称。仅当数据类型为EMR时，需要配置该参数。'."\n" + ."\n" + .'您可以通过调用[GetMetaDBTableList](~~173916~~)接口，获取表名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'abc', + ], + ], + [ + 'name' => 'DataSourceType', + 'in' => 'query', + 'schema' => [ + 'description' => '数据类型，当前仅支持取值为EMR。', + 'type' => 'string', + 'required' => false, + 'example' => 'emr', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回的数据结构。', + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => [ + 'description' => 'HTTP状态码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'ErrorMessage' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'The specified parameters are invalid.', + ], + 'RequestId' => [ + 'description' => '请求ID。用于定位日志，排查问题。', + 'type' => 'string', + 'example' => '0bc1411515937****', + ], + 'Success' => [ + 'description' => '调用是否成功。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'ErrorCode' => [ + 'description' => '错误码。', + 'type' => 'string', + 'example' => '1031203110005', + ], + 'Data' => [ + 'description' => '业务数据。', + 'type' => 'object', + 'properties' => [ + 'TableName' => [ + 'description' => '表的名称。', + 'type' => 'string', + 'example' => 'table_name', + ], + 'Comment' => [ + 'description' => '表的备注信息。', + 'type' => 'string', + 'example' => 'comment', + ], + 'LifeCycle' => [ + 'description' => '表的生命周期，单位为天。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '5', + ], + 'CreateTime' => [ + 'description' => '创建表的时间。该结果显示为时间戳，您可以根据使用的时区将时间戳转换为相应日期。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1589870293000', + ], + 'ProjectName' => [ + 'description' => '表所在工作空间的名称。', + 'type' => 'string', + 'example' => 'test', + ], + 'ProjectId' => [ + 'description' => '表所在工作空间的ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '22', + ], + 'OwnerId' => [ + 'description' => '表所有者的ID。', + 'type' => 'string', + 'example' => '123', + ], + 'EnvType' => [ + 'description' => '环境类型，取值如下：'."\n" + .'- 0表示开发环境的表。'."\n" + .'- 1表示生产环境的表。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'LastAccessTime' => [ + 'description' => '最后一次访问表的时间。该结果显示为时间戳，您可以根据使用的时区将时间戳转换为相应日期。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1589870294000', + ], + 'DataSize' => [ + 'description' => '表占用的存储空间，单位为字节（B）。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10', + ], + 'LastModifyTime' => [ + 'description' => '最后更新表的时间。该结果显示为时间戳，您可以根据使用的时区将时间戳转换为相应日期。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1589870294000', + ], + 'DatabaseName' => [ + 'description' => '数据库的名称。', + 'type' => 'string', + 'example' => 'abc', + ], + 'IsVisible' => [ + 'description' => '表是否可见，取值如下：'."\n" + .'- 0表示该表对工作空间成员可见。'."\n" + .'- 1表示该表对租户内可见。'."\n" + .'- 2表示该表在租户间均可见。'."\n" + .'- 3表示该表仅对责任人可见。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'TotalColumnCount' => [ + 'description' => '字段的总数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '22', + ], + 'TableGuid' => [ + 'description' => '表的唯一标识。', + 'type' => 'string', + 'example' => 'odps.engine_name.table_name', + ], + 'PartitionKeys' => [ + 'description' => '分区键。', + 'type' => 'string', + 'example' => 'abc', + ], + 'LastDdlTime' => [ + 'description' => '最后变更表结构的时间。该结果显示为时间戳，您可以根据使用的时区将时间戳转换为相应日期。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1589870294000', + ], + 'Location' => [ + 'description' => 'Hive表的存储地址。', + 'type' => 'string', + 'example' => 'hdfs://localhost:777/user/hadoop/test.txt', + ], + 'ClusterId' => [ + 'description' => 'EMR集群的ID。', + 'type' => 'string', + 'example' => 'C-010A704DA760****', + ], + 'TenantId' => [ + 'description' => '租户ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '12345', + ], + 'Schema' => [ + 'description' => '表Schema信息。', + 'type' => 'string', + 'example' => 'default', + ], + 'ColumnList' => [ + 'description' => '字段列表。', + 'type' => 'array', + 'items' => [ + 'description' => '返回的数据结构。', + 'type' => 'object', + 'properties' => [ + 'ColumnName' => [ + 'description' => '字段的名称。', + 'type' => 'string', + 'example' => '1', + ], + 'ColumnGuid' => [ + 'description' => '字段的唯一标识。', + 'type' => 'string', + 'example' => 'odps.engine_name.table_name.1', + ], + 'IsPartitionColumn' => [ + 'description' => '字段是否为分区字段，取值如下：'."\n" + .'- true，是分区字段。'."\n" + .'- false，不是分区字段。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Comment' => [ + 'description' => '字段的备注。', + 'type' => 'string', + 'example' => 'comment', + ], + 'ColumnType' => [ + 'description' => '字段的类型。', + 'type' => 'string', + 'example' => 'string', + ], + 'IsPrimaryKey' => [ + 'description' => '字段是否为主键，取值如下：'."\n" + .'- true，是主键。'."\n" + .'- false，不是主键。', + 'type' => 'boolean', + 'example' => 'false', + ], + 'Position' => [ + 'description' => '字段的排序。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Caption' => [ + 'description' => '字段的描述信息。', + 'type' => 'string', + 'example' => 'data comment', + ], + 'IsForeignKey' => [ + 'description' => '字段是否为外键，取值如下：'."\n" + .'- true，是外键。'."\n" + .'- false，不是外键。', + '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' => '获取表的完整信息（包括字段信息）', + 'description' => '仅支持获取EMR引擎表的信息。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' GetMetaTableFullInfo接口的使用示例Demo请参见[DataWorks OpenAPI示例](https://developer.aliyun.com/article/780879?groupCode=dataworks)。', + ], + 'GetDDLJobStatus' => [ + 'summary' => '调用GetDDLJobStatus获取创建表、更新表和删除表的任务状态。', + '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' => 'DDL任务的ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'abc', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'abc', + ], + 'Data' => [ + 'description' => '任务的详情。', + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => '任务的状态。', + 'type' => 'string', + 'example' => 'success', + ], + 'NextTaskId' => [ + 'description' => '正在进行的TaskID。如果为空，说明全部任务已经结束。', + 'type' => 'string', + 'example' => 'abc1', + ], + 'TaskId' => [ + 'description' => '任务的ID。', + 'type' => 'string', + 'example' => 'abc', + ], + 'Content' => [ + 'description' => '任务的内容。', + '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 \\"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' => '获取创建表、更新表和删除表的任务状态', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DeleteTable' => [ + 'summary' => '删除MaxCompute表。', + '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' => 'DataWorks工作空间的ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'docRequired' => true, + 'maximum' => '9223372036854775807', + 'minimum' => '1', + 'example' => '101', + ], + ], + [ + 'name' => 'TableName', + 'in' => 'query', + 'schema' => [ + 'description' => 'MaxCompute表的名称。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'table1', + ], + ], + [ + 'name' => 'EnvType', + 'in' => 'query', + 'schema' => [ + 'description' => '引擎或数据源的类型。'."\n" + .'取值范围：'."\n" + .'- cdh'."\n" + .'- analyticdb_for_mysql'."\n" + .'- odps'."\n" + .'- emr'."\n" + .'- hadoop'."\n" + .'- holodb'."\n" + .'- hybriddb_for_postgresql', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'docRequired' => true, + 'maximum' => '1', + 'minimum' => '0', + 'example' => '1', + ], + ], + [ + 'name' => 'AppGuid', + 'in' => 'query', + 'schema' => [ + 'description' => 'MaxCompute项目的唯一标识，格式为odps.{projectName}。', + 'type' => 'string', + 'required' => false, + 'example' => 'odps.test', + ], + ], + [ + 'name' => 'Schema', + 'in' => 'query', + 'schema' => [ + 'description' => '表Schema信息。在ODPS，当您启动了三层模型时需要填写Schema信息。', + 'type' => 'string', + 'required' => false, + 'example' => 'default', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'abcde', + ], + 'TaskInfo' => [ + 'description' => '删除表的任务信息。', + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => '已经结束的任务状态。', + 'type' => 'string', + 'example' => 'success', + ], + 'NextTaskId' => [ + 'description' => '正在运行的任务ID。', + 'type' => 'string', + 'example' => 'abc1', + ], + 'TaskId' => [ + 'description' => '已经结束的任务ID。', + 'type' => 'string', + 'example' => 'abc', + ], + 'Content' => [ + 'description' => '任务的内容。', + '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' => '删除 MaxCompute 表', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'UpdateTable' => [ + 'summary' => '调用UpdateTable更新MaxCompute表。', + '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' => '是否为视图，包括0（否）和1（是）。该字段已废弃，请勿使用。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + ], + ], + [ + 'name' => 'Visibility', + 'in' => 'query', + 'schema' => [ + 'description' => '表的可见性，包括0（对所有成员不可见）、1（对所有成员可见）和2（对工作空间成员可见）。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'LifeCycle', + 'in' => 'query', + 'schema' => [ + 'description' => '表的生命周期，单位为天。生命周期为空时，表示永久存储。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'CategoryId', + 'in' => 'query', + 'schema' => [ + 'description' => '关联的类目ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'maximum' => '9223372036854775807', + 'minimum' => '1', + 'example' => '101', + ], + ], + [ + 'name' => 'LogicalLevelId', + 'in' => 'query', + 'schema' => [ + 'description' => '逻辑层级ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'maximum' => '9223372036854775807', + 'minimum' => '1', + 'example' => '101', + ], + ], + [ + 'name' => 'PhysicsLevelId', + 'in' => 'query', + 'schema' => [ + 'description' => '物理层级ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'maximum' => '9223372036854775807', + 'minimum' => '1', + 'example' => '101', + ], + ], + [ + 'name' => 'ExternalTableType', + 'in' => 'query', + 'schema' => [ + 'description' => '外表的类型，包括0（OSS）、1（TableStore）、2（Volume）和3（MySQL）。该字段已废弃，请勿使用。', + 'type' => 'string', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'Location', + 'in' => 'query', + 'schema' => [ + 'description' => '外表的存储地址。该字段已废弃，请勿使用。', + 'type' => 'string', + 'required' => false, + 'example' => 'location', + ], + ], + [ + 'name' => 'ProjectId', + 'in' => 'query', + 'schema' => [ + 'description' => 'DataWorks工作空间的ID。您可以登录DataWorks控制台获取工作空间ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'maximum' => '9223372036854775807', + 'minimum' => '1', + 'example' => '101', + ], + ], + [ + 'name' => 'TableName', + 'in' => 'query', + 'schema' => [ + 'description' => 'MaxCompute表名称。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'abc', + ], + ], + [ + 'name' => 'Endpoint', + 'in' => 'formData', + 'schema' => [ + 'description' => 'MaxCompute Endpoint。不填时，默认取项目对应的Endpoint。', + 'type' => 'string', + 'required' => false, + 'example' => 'odps://', + ], + ], + [ + 'name' => 'EnvType', + 'in' => 'formData', + 'schema' => [ + 'description' => 'DataWorks工作空间的环境，包括0（开发环境）和1（生产环境）。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'AppGuid', + 'in' => 'query', + 'schema' => [ + 'description' => 'MaxCompute项目的唯一标识，格式为odps.{projectName}。', + 'type' => 'string', + 'required' => false, + 'example' => 'odps.test', + ], + ], + [ + 'name' => 'CreateIfNotExists', + 'in' => 'query', + 'schema' => [ + 'description' => '表是否存在：'."\n" + .'- true：是，表存在。'."\n" + .'- false：否，表不存在。'."\n" + ."\n" + .'该字段已废弃，请勿使用。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'HasPart', + 'in' => 'query', + 'schema' => [ + 'description' => '需要更新的MaxCompute表是否为分区表，包括0（否）和1（是）。该字段已废弃，请勿使用。'."\n" + .'目前代码会根据Column.N.isPartitionCol参数判断MaxCompute表是否为分区表，当Column.N.isPartition参数取值为1时，则认为MaxCompute表为分区表。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + ], + ], + [ + 'name' => 'Comment', + 'in' => 'query', + 'schema' => [ + 'description' => '备注信息。', + 'type' => 'string', + 'required' => false, + 'example' => '备注', + ], + ], + [ + 'name' => 'Schema', + 'in' => 'query', + 'schema' => [ + 'description' => '表Schema信息。在ODPS，当您启动了三层模型时需要填写Schema信息。', + 'type' => 'string', + 'required' => false, + 'example' => 'default', + ], + ], + [ + 'name' => 'Columns', + 'in' => 'formData', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '字段列表', + 'type' => 'array', + 'items' => [ + 'description' => '返回对象', + 'type' => 'object', + 'properties' => [ + 'ColumnNameCn' => [ + 'description' => '字段的中文名称。', + 'type' => 'string', + 'required' => false, + 'example' => '中文', + ], + 'ColumnName' => [ + 'description' => '字段的名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'abc', + ], + 'Comment' => [ + 'description' => '字段的备注。', + 'type' => 'string', + 'required' => false, + 'example' => '备注', + ], + 'ColumnType' => [ + 'description' => '字段的类型，请参见MaxCompute支持的字段类型。', + 'type' => 'string', + 'required' => true, + 'example' => 'string', + ], + 'SeqNumber' => [ + 'description' => '字段的序号。如果字段为分区字段，则不支持配置Columns.N.SeqNumber。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + 'Length' => [ + 'description' => '字段的长度。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + ], + 'IsPartitionCol' => [ + 'description' => '是否为分区字段，包括0（否）和1（是）。', + 'type' => 'boolean', + 'required' => false, + 'example' => '0', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 100, + ], + ], + [ + 'name' => 'Themes', + 'in' => 'formData', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '字段列表', + 'type' => 'array', + 'items' => [ + 'description' => '返回对象', + 'type' => 'object', + 'properties' => [ + 'ThemeId' => [ + 'description' => '关联的主题ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'maximum' => '9223372036854775807', + 'minimum' => '1', + 'example' => '101', + ], + 'ThemeLevel' => [ + 'description' => '主题ID对应的层级。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '101', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 100, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回对象', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'abcde', + ], + 'TaskInfo' => [ + 'description' => '请求任务的信息。'."\n" + .'请求任务提交成功后，会被分为多个子任务有序执行。当前子任务执行成功后，才会继续执行下一个子任务，所有子任务执行完毕，该请求任务结束。如下情况，请求任务会终止，您需要根据错误码信息解决问题后重新发起请求任务：'."\n" + .'- 请求任务提交失败。'."\n" + .'- 请求任务提交成功后，任意子任务执行失败。', + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => '当前执行的子任务的状态信息。取值如下：'."\n" + .'- operating表示子任务正在执行中。'."\n" + .'- success表示子任务执行成功。'."\n" + .'- failure表示子任务执行失败。详细的报错信息请参见Content参数。', + 'type' => 'string', + 'example' => 'success', + ], + 'NextTaskId' => [ + 'description' => '即将执行的子任务ID。如果该字段为空，则表示所有子任务均已结束。您可以使用获取到的ID，从[GetDDLJobStatus](~~185659~~)接口查询对应子任务的状态。', + 'type' => 'string', + 'example' => 'abc1', + ], + 'TaskId' => [ + 'description' => '当前执行的子任务ID。', + 'type' => 'string', + 'example' => 'abc', + ], + 'Content' => [ + 'description' => '当前子任务的执行状态详细信息。具体如下：'."\n" + .'- 执行成功，则显示success。'."\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' => '更新MaxCompute表', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'CreateTable' => [ + 'summary' => '创建一个MaxCompute的表。', + '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' => '指定创建视图或创建表：'."\n" + .'- 0为创建表。'."\n" + .'- 1为创建视图。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + ], + ], + [ + 'name' => 'Visibility', + 'in' => 'query', + 'schema' => [ + 'description' => '表或工作空间是否可见：'."\n" + .'- 0为表和工作空间均不可见。'."\n" + .'- 1为表和工作空间均可见。'."\n" + .'- 2为仅工作空间可见。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'LifeCycle', + 'in' => 'query', + 'schema' => [ + 'description' => '表的生命周期，单位为天。默认取值为空，表示永久存储。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'CategoryId', + 'in' => 'query', + 'schema' => [ + 'description' => '关联类目的ID。您可以通过[GetMetaCategory](~~173932~~)接口查询可以关联的类目ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'maximum' => '9223372036854775807', + 'minimum' => '1', + 'example' => '101', + ], + ], + [ + 'name' => 'LogicalLevelId', + 'in' => 'query', + 'schema' => [ + 'description' => '逻辑层级ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'maximum' => '9223372036854775807', + 'minimum' => '1', + 'example' => '101', + ], + ], + [ + 'name' => 'PhysicsLevelId', + 'in' => 'query', + 'schema' => [ + 'description' => '物理层级ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'maximum' => '9223372036854775807', + 'minimum' => '1', + 'example' => '101', + ], + ], + [ + 'name' => 'ExternalTableType', + 'in' => 'query', + 'schema' => [ + 'description' => '外部表的存储类型。取值如下：'."\n" + .'- 0表示OSS。'."\n" + .'- 1表示TableStore。'."\n" + .'- 2表示Volume。'."\n" + .'- 3表示MySQL。', + 'type' => 'string', + 'required' => false, + 'example' => '0', + ], + ], + [ + 'name' => 'Location', + 'in' => 'query', + 'schema' => [ + 'description' => '外部表的存储地址。', + 'type' => 'string', + 'required' => false, + 'example' => 'location', + ], + ], + [ + 'name' => 'ProjectId', + 'in' => 'query', + 'schema' => [ + 'description' => 'DataWorks工作空间的ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'maximum' => '9223372036854775807', + 'minimum' => '1', + 'example' => '23', + ], + ], + [ + 'name' => 'TableName', + 'in' => 'query', + 'schema' => [ + 'description' => '表的名称。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'tableName1', + ], + ], + [ + 'name' => 'Endpoint', + 'in' => 'formData', + 'schema' => [ + 'description' => 'MaxCompute的Endpoint。', + 'type' => 'string', + 'required' => false, + 'example' => 'odps://abc', + ], + ], + [ + 'name' => 'EnvType', + 'in' => 'formData', + 'schema' => [ + 'description' => 'DataWorks工作空间的环境。取值如下：'."\n" + .'- 0表示开发环境。'."\n" + .'- 1表示生产环境。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'AppGuid', + 'in' => 'query', + 'schema' => [ + 'description' => 'MaxCompute项目的ID，格式为odps.{projectName}。', + 'type' => 'string', + 'required' => false, + 'example' => 'odps.test', + ], + ], + [ + 'name' => 'Comment', + 'in' => 'query', + 'schema' => [ + 'description' => '备注信息。', + 'type' => 'string', + 'required' => false, + 'example' => '备注', + ], + ], + [ + 'name' => 'HasPart', + 'in' => 'query', + 'schema' => [ + 'description' => '创建的MaxCompute表是否为分区表，包括1（是）和0（否）。该字段已废弃，请勿使用。'."\n" + .'目前代码会根据Column.N.isPartitionCol参数判断MaxCompute表是否为分区表，当Column.N.isPartitionCol参数取值为true时，则认为MaxCompute表为分区表。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'description' => '保留字段。', + 'type' => 'string', + 'required' => false, + 'example' => '保留字段', + ], + ], + [ + 'name' => 'Schema', + 'in' => 'query', + 'allowEmptyValue' => false, + 'schema' => [ + 'description' => '表Schema信息。在ODPS，当您启动了三层模型时需要填写Schema信息。', + 'type' => 'string', + 'required' => false, + 'example' => 'default', + ], + ], + [ + 'name' => 'Columns', + 'in' => 'formData', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '字段列表，最大支持1000个字段。', + 'type' => 'array', + 'items' => [ + 'description' => '字段对象', + 'type' => 'object', + 'properties' => [ + 'ColumnNameCn' => [ + 'description' => '字段的中文名称。', + 'type' => 'string', + 'required' => false, + 'example' => '中文名', + ], + 'ColumnName' => [ + 'description' => '字段的名称。'."\n" + .'CreateTable API当前最多支持配置1000个字段。', + 'type' => 'string', + 'required' => true, + 'example' => 'columnName1', + ], + 'Comment' => [ + 'description' => '字段的备注信息。', + 'type' => 'string', + 'required' => false, + 'example' => '备注', + ], + 'ColumnType' => [ + 'description' => '字段的类型。此处支持的字段类型，取决于您MaxCompute项目使用的数据类型版本，各版本支持的数据类型请参见[数据类型版本说明](~~27821~~)。', + 'type' => 'string', + 'required' => true, + 'example' => 'string', + ], + 'SeqNumber' => [ + 'description' => '字段的序列号。您可以指定字段在表中的排序，默认按照创建请求的顺序排序。'."\n" + .'如果字段为分区字段，则不支持配置Columns.N.SeqNumber。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + 'Length' => [ + 'description' => '字段的长度，详情请参见：<props="intl">[数据类型版本](~~159541~~)</props><props="china">[数据类型版本](~~159541~~)</props>。'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + ], + 'IsPartitionCol' => [ + 'description' => '当前字段是否为分区字段。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + 'required' => false, + ], + 'required' => true, + 'maxItems' => 1000, + ], + ], + [ + 'name' => 'Themes', + 'in' => 'formData', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '字段列表', + 'type' => 'array', + 'items' => [ + 'description' => '返回对象', + 'type' => 'object', + 'properties' => [ + 'ThemeId' => [ + 'description' => '主题ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'maximum' => '9223372036854775807', + 'minimum' => '1', + 'example' => '101', + ], + 'ThemeLevel' => [ + 'description' => '主题ID对应的主题层级。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '101', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 100, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回对象', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'abcdef', + ], + 'TaskInfo' => [ + 'description' => '请求任务的信息。'."\n" + .'请求任务提交成功后，会被分为多个子任务有序执行。当前子任务执行成功后，才会继续执行下一个子任务，所有子任务执行完毕，该请求任务结束。'."\n" + ."\n" + .'如下情况，请求任务会终止，您需要根据错误码信息解决问题后重新发起请求任务：'."\n" + .'- 请求任务提交失败。'."\n" + .'- 请求任务提交成功后，任意子任务执行失败。', + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => '当前执行的子任务的状态信息。取值如下：'."\n" + .'- operating表示子任务正在执行中。'."\n" + .'- success表示子任务执行成功。'."\n" + .'- failure表示子任务执行失败。详细的报错信息请参见Content参数。'."\n", + 'type' => 'string', + 'example' => 'success', + ], + 'NextTaskId' => [ + 'description' => '即将执行的子任务ID。如果该字段为空，则表示所有子任务均已结束。', + 'type' => 'string', + 'example' => 'abc1', + ], + 'TaskId' => [ + 'description' => '当前执行的子任务ID。', + 'type' => 'string', + 'example' => 'abc', + ], + 'Content' => [ + 'description' => '当前子任务的执行状态详细信息。具体如下：'."\n" + .'- 执行成功，则显示success。'."\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' => '创建一个MaxCompute表', + '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' => '文件检查器所属的实例ID。您可以从文件发布检查事件中的CheckerInstanceId获取。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '66_123455623_2', + ], + ], + [ + 'name' => 'Status', + 'in' => 'formData', + 'schema' => [ + 'description' => '待发布文件的检查状态，取值如下：'."\n" + .'- OK，表示文件检查通过。'."\n" + .'- WARN，表示文件检查通过，但是存在警告。'."\n" + .'- FAIL，表示文件检查未通过。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'OK', + 'enum' => [ + 'OK', + 'FAIL', + 'WARN', + ], + ], + ], + [ + 'name' => 'CheckDetailUrl', + 'in' => 'formData', + 'schema' => [ + 'description' => '已废弃。', + 'type' => 'string', + 'required' => false, + 'example' => 'https://result.aliyun.com/?checkerInstanceId=', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID，用于后续问题排查。', + 'type' => 'string', + 'example' => '86d5a5ac-0cc0-4c5f-a374-a15713b252ab', + ], + ], + ], + ], + ], + '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' => '检查文件部署', + 'summary' => '当您在DataWorks数据开发页面创建的文件提交成功后，文件将进入发布检查状态，DataWorks会将文件发布检查事件返回给您，您需要根据事件内容判断该文件是否可以继续进行发布校验。此时，可以通过将待发布文件的检查结果返回至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' => 'DataWorks工作空间的ID。您可以登录[DataWorks控制台](https://workbench.data.aliyun.com/console)，进入工作空间配置页面获取工作空间ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + 'maximum' => '10000000000', + 'minimum' => '1', + 'example' => '10000', + ], + ], + [ + 'name' => 'DatasourceName', + 'in' => 'query', + 'schema' => [ + 'description' => '需要查看的目标数据源名称。您可以调用[ListDataSources](~~211431~~)接口获取数据源名称。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'mysql_datasource', + ], + ], + [ + 'name' => 'TaskType', + 'in' => 'query', + 'schema' => [ + 'description' => '目标数据源所关联的数据集成同步任务的任务类型。取值如下：'."\n" + .'- DI_OFFLINE：表示数据集成离线同步任务。'."\n" + .'- DI_REALTIME：表示数据集成实时同步任务。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'DI_OFFLINE', + ], + ], + [ + 'name' => 'RefType', + 'in' => 'query', + 'schema' => [ + 'description' => '选择目标数据源作为数据集成同步任务的源端或目的端。取值如下：'."\n" + .'- from：目标数据源作为数据集成同步任务的源端。'."\n" + .'- to：目标数据源作为数据集成同步任务的目的端。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'from', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '页码数。最小值1，最大值100', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'docRequired' => true, + 'minimum' => '1', + 'example' => '11', + 'default' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '每页显示的数据条数。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'maximum' => '100000', + 'minimum' => '1', + 'example' => '50', + 'default' => '100', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Success' => [ + 'description' => '请求是否成功。取值如下：'."\n" + .'- true：成功。'."\n" + .'- false：失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'RequestId' => [ + 'description' => '请求ID。用于定位日志，排查问题。', + 'type' => 'string', + 'example' => '0bc1411515937635973****', + ], + 'Data' => [ + 'description' => '返回的数据结果。', + 'type' => 'object', + 'properties' => [ + 'DISyncTasks' => [ + 'description' => '返回数据结果的数组信息。'."\n" + .'通常，目标数据源会关联多个数据集成同步任务，调用ListRefDISyncTasks接口查询目标数据源关联的同步任务时，返回的结果为目标数据源所关联的同步任务的数组。如下信息为数组中一个同步任务的信息示例。', + 'type' => 'array', + 'items' => [ + 'description' => '返回数据结果的数组信息。'."\n" + .'通常，目标数据源会关联多个数据集成同步任务，调用ListRefDISyncTasks接口查询目标数据源关联的同步任务时，返回的结果为目标数据源所关联的同步任务的数组。如下信息为数组中一个同步任务的信息示例。', + 'type' => 'object', + 'properties' => [ + 'DiSourceDatasource' => [ + 'description' => '目标数据源所关联的当前同步任务的源端数据源。'."\n" + .'如果当前同步任务存在多个源端数据源，则会以JSON数组的形式返回多个源端数据源。例如，[\\"odps_writer\\", \\"mysql\\"]。'."\n" + .'当RefType参数取值为from时，即目标数据源作为数据集成同步任务的源端，则当前参数的返回结果为目标数据源本身。', + 'type' => 'string', + 'example' => '[\\"odps_writer\\"]', + ], + 'TaskType' => [ + 'description' => '目标数据源所关联的当前数据集成同步任务的任务类型。取值如下：'."\n" + .'- DI_OFFLINE：数据集成离线同步任务。'."\n" + .'- DI_REALTIME：数据集成实时同步任务。', + 'type' => 'string', + 'example' => 'DI_OFFLINE', + ], + 'DiDestinationDatasource' => [ + 'description' => '目标数据源所关联的当前同步任务的目的端数据源。'."\n" + .'如果当前同步任务存在多个目的端数据源，则会以JSON数组的形式返回多个目的端数据源。例如，[\\"odps_writer\\", \\"mysql\\"]。'."\n" + .'当RefType参数取值为to时，即目标数据源作为数据集成同步任务的目的端，则当前参数的返回结果为目标数据源本身。'."\n", + 'type' => 'string', + 'example' => '[\\"qcc_polardb2\\"]', + ], + 'NodeName' => [ + 'description' => '目标数据源所关联的当前数据集成同步任务的任务名称。', + 'type' => 'string', + 'example' => 'abcd1234', + ], + 'NodeId' => [ + 'description' => '目标数据源所关联的当前数据集成同步任务的任务ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '100000', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + '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' => '查看目标数据源所关联的数据集成同步任务', + 'summary' => '查看目标数据源所关联的数据集成同步任务。', + ], + 'ExportDataSources' => [ + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + [ + 'APP' => [], + ], + [ + 'PrivateKey' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'ProjectId', + 'in' => 'query', + 'schema' => [ + 'description' => '目标数据源所在的DataWorks工作空间ID。您可以调用[ListProjects](~~178393~~)接口获取工作空间ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + 'maximum' => '10000000000', + 'minimum' => '1', + 'example' => '10000', + ], + ], + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => [ + 'description' => '待导出的目标数据源名称所包含的关键字。'."\n" + .'当前仅支持配置一个关键字。例如，该参数配置为test（即待导出的目标数据源名称所包含的关键字为test），则调用ExportDataSources接口会导出目标工作空间中所有名称包含test的数据源。', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => 'test', + ], + ], + [ + 'name' => 'DataSourceType', + 'in' => 'query', + 'schema' => [ + 'description' => '目标数据源的类型。常用的类型如下：'."\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', + 'type' => 'string', + 'required' => false, + 'example' => 'rds', + ], + ], + [ + 'name' => 'SubType', + 'in' => 'query', + 'schema' => [ + 'description' => '目标数据源的子类型。仅当DataSourceType参数配置为RDS时，该参数生效。'."\n" + ."\n" + .'当DataSourceType参数配置为RDS时，该参数可以配置为mysql、sqlserver或postgresql。', + 'type' => 'string', + 'required' => false, + 'example' => 'mysql', + ], + ], + [ + 'name' => 'EnvType', + 'in' => 'query', + 'schema' => [ + 'description' => '目标数据源所属的环境。取值如下：'."\n" + .'- 0：开发环境。'."\n" + .'- 1：生产环境。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '每页显示的条数，默认为10条，最大为100条。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '100', + 'example' => '10', + 'default' => '10', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '分页查询的页码。取值为大于等于1的正整数。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '100', + 'minimum' => '1', + 'example' => '1', + 'default' => '1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => [ + 'description' => '此次调用的返回结果状态。取值如下：'."\n" + .'- 200：表示此次调用的返回结果成功。'."\n" + .'- 其他值：表示此次调用的返回结果异常。您可以根据对应错误码处理相关异常。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'RequestId' => [ + 'description' => '请求ID。用于定位日志，排查问题。', + 'type' => 'string', + 'example' => '0bc14115159376359****', + ], + 'Success' => [ + 'description' => '请求是否成功。取值如下：'."\n" + .'- true：成功。'."\n" + .'- false：失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Data' => [ + 'description' => '批量导出数据源的返回结果。'."\n", + 'type' => 'object', + 'properties' => [ + 'PageNumber' => [ + 'description' => '分页查询的页码。取值为大于等于1的正整数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'PageSize' => [ + 'description' => '每页显示的数据条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'TotalCount' => [ + 'description' => '返回满足条件的数据源总条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '100', + ], + 'DataSources' => [ + 'description' => '批量导出的数据源的详细信息。'."\n" + .'此次调用的返回结果为导出数据源的详细信息数组，如下信息为数组中的一个数据源的详细信息示例。'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => '数据源是否可用。取值如下：'."\n" + .'- 1：表示数据源可用。'."\n" + .'- 0：表示数据源不可用。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'ProjectId' => [ + 'description' => '数据源所属的DataWorks工作空间ID。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '123', + ], + 'SubType' => [ + 'description' => '数据源的子类型。仅当DataSourceType参数配置为RDS时，该参数生效。'."\n" + ."\n" + .'当DataSourceType参数配置为RDS时，该参数可以取值为mysql、sqlserver或postgresql。', + 'type' => 'string', + 'example' => 'mysql', + ], + 'GmtModified' => [ + 'description' => '最近一次修改数据源的时间。格式示例为：Mar 17, 2021 4:09:32 PM。', + 'type' => 'string', + 'example' => 'Mar 17, 2021 4:09:32 PM', + ], + 'EnvType' => [ + 'description' => '数据源所属的环境。取值如下：'."\n" + .'- 0：开发环境。'."\n" + .'- 1：生产环境。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'ConnectStatus' => [ + 'description' => '数据源与任意独享资源组的连通性状态。取值如下：'."\n" + .'- 1：表示数据源至少与一个独享资源组连通。'."\n" + .'- 0：表示数据源与所有独享资源组均未连通。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Sequence' => [ + 'description' => '数据源的序列。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '300', + ], + 'Description' => [ + 'description' => '数据源的描述信息。', + 'type' => 'string', + 'example' => 'a connection', + ], + 'DataSourceType' => [ + 'description' => '数据源的类型。常用的类型如下：'."\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', + 'type' => 'string', + 'example' => 'rds', + ], + 'GmtCreate' => [ + 'description' => '数据源的创建时间。格式示例为：Mar 17, 2021 4:09:32 PM。', + 'type' => 'string', + 'example' => 'Mar 17, 2021 4:09:32 PM', + ], + 'DefaultEngine' => [ + 'description' => '数据源所在的引擎是否为默认引擎。取值如下：'."\n" + .'- true：是默认引擎。'."\n" + .'- false：不是默认引擎。'."\n", + 'type' => 'boolean', + 'example' => 'false', + ], + 'Shared' => [ + 'description' => '数据源是否可以分享。取值如下：'."\n" + .'- true：数据源可以分享。'."\n" + .'- false：数据源不可以分享。', + 'type' => 'boolean', + 'example' => 'false', + ], + 'Operator' => [ + 'description' => '操作数据源的用户ID。', + 'type' => 'string', + 'example' => '193543050****', + ], + 'Name' => [ + 'description' => '数据源的名称。', + 'type' => 'string', + 'example' => 'abc', + ], + 'Content' => [ + 'description' => '数据源的详细配置。', + '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' => '数据源的ID。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'BindingCalcEngineId' => [ + 'description' => '数据源所绑定的引擎ID。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '123', + ], + 'TenantId' => [ + 'description' => '数据源所属租户的租户ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1234567', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + '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' => '导出数据源列表', + 'summary' => '导出数据源列表。', + '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' => 'DataWorks工作空间的ID。您可以登录[DataWorks控制台](https://workbench.data.aliyun.com/console)，进入工作空间配置页面获取工作空间ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + 'maximum' => '10000000000', + 'minimum' => '1', + 'example' => '10000', + ], + ], + [ + 'name' => 'DataSources', + 'in' => 'query', + 'schema' => [ + 'description' => '待导入数据源的数据源内容数组。其中Name，DataSourceType，SubType，Description，Content，EnvType参数为必填参数。参数的详情请参见[CreateDataSource](~~211429~~)接口。', + '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' => '请求是否成功。取值如下：'."\n" + .'- true：成功。'."\n" + .'- false：失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'RequestId' => [ + 'description' => '请求ID。用于定位日志，排查问题。', + 'type' => 'string', + 'example' => '0bc1411515937635973****', + ], + 'Data' => [ + 'description' => '批量导入数据源的返回结果。', + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => '批量导入数据源的结果状态。取值如下：'."\n" + .'- true：表示全部数据源导入成功。'."\n" + .'- false：表示部分数据源导入失败，您可以查看Message参数定位失败原因。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Message' => [ + 'description' => '批量导入数据源失败后的原因描述。如果批量导入数据源成功，则该参数的返回值为空。', + 'type' => 'string', + 'example' => ' Data source DEV XXX already exists', + ], + ], + ], + ], + ], + ], + ], + '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' => '批量导入本地数据源', + 'summary' => '批量导入本地数据源至目标DataWorks工作空间。', + 'description' => '您可以选择将本地自建的数据源或从其他工作空间导出至本地的数据源，导入至目标DataWorks工作空间。'."\n" + .'- 您本地自建的数据源类型必须是DataWorks所支持的数据源类型。DataWorks所支持的数据源类型，详情请参见[DataWorks支持的数据源](~~181656~~)。'."\n" + .'- 从其他工作空间导出数据源至本地，详情请参见[ExportDataSources](~~279570~~)接口。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'UpdateClusterConfigs' => [ + 'summary' => '更新集群在某个工作空间下分模块的配置信息，目前支持更新 SPARK 参数。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '231401', + 'abilityTreeNodes' => [ + 'FEATUREdideDGBIGO', + ], + ], + 'parameters' => [ + [ + 'name' => 'ClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'DataWorks 生成的集群 ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '12345', + ], + ], + [ + 'name' => 'ProjectId', + 'in' => 'query', + 'schema' => [ + 'description' => '工作空间的ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '5678', + ], + ], + [ + 'name' => 'ConfigType', + 'in' => 'query', + 'schema' => [ + 'description' => '集群配置的类型，支持的类型如下：'."\n" + .'- SPARK_CONF（SPARK 参数）', + 'type' => 'string', + 'required' => true, + 'enumValueTitles' => [], + 'example' => 'SPARK_CONF', + ], + ], + [ + 'name' => 'ConfigValues', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'description' => '集群分模块的配置信息列表。', + 'type' => 'array', + 'items' => [ + 'description' => '集群在某个模块的配置信息。', + 'required' => false, + '$ref' => '#/components/schemas/ClusterConfig', + ], + 'required' => true, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'OpenApiMetaResultModel', + 'description' => '返回结构。', + 'type' => 'object', + 'properties' => [ + 'Data' => [ + 'description' => '是否修改成功：'."\n" + .'- true（成功）'."\n" + .'- false（失败）', + 'type' => 'boolean', + 'enumValueTitles' => [], + 'example' => 'true', + ], + 'RequestId' => [ + 'description' => '请求的ID。用于定位日志，排查问题。'."\n" + ."\n", + 'type' => 'string', + 'example' => '0000-ABCD-E****', + ], + 'Success' => [ + 'description' => '请求是否成功：'."\n" + .'- true（成功）'."\n" + .'- false（失败）', + 'type' => 'boolean', + 'enumValueTitles' => [], + 'example' => 'true', + ], + 'ErrorCode' => [ + 'description' => '错误码。', + 'type' => 'string', + 'example' => '101011005', + ], + 'ErrorMessage' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'Invalid.Cluster.ClusterNotFound', + ], + 'HttpStatusCode' => [ + 'description' => 'HTTP 状态码。', + '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' => '更新集群的配置信息', + 'description' => '本接口当前处于试用阶段。需要体验的用户可以提出申请，管理员加入试用名单后即可调用。', + ], + 'ListClusterConfigs' => [ + 'summary' => '列出集群在某个工作空间下分模块的配置信息，目前支持列出 SPARK 参数。', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '231400', + 'abilityTreeNodes' => [ + 'FEATUREdideDGBIGO', + ], + ], + 'parameters' => [ + [ + 'name' => 'ClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'DataWorks 生成的集群 ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1234', + ], + ], + [ + 'name' => 'ProjectId', + 'in' => 'query', + 'schema' => [ + 'description' => 'DataWorks 工作空间的 ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '5678', + ], + ], + [ + 'name' => 'ConfigType', + 'in' => 'query', + 'schema' => [ + 'description' => '集群配置的类型，支持的类型如下：'."\n" + .'- SPARK_CONF（SPARK 参数）', + 'type' => 'string', + 'required' => true, + 'enumValueTitles' => [], + 'example' => 'SPARK_CONF', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回结构。', + 'type' => 'object', + 'properties' => [ + 'ClusterConfigs' => [ + 'description' => '集群分模块的配置信息列表。', + 'type' => 'array', + 'items' => [ + 'description' => '集群在某个模块的配置信息。', + '$ref' => '#/components/schemas/ClusterConfig', + ], + ], + 'RequestId' => [ + 'description' => '请求的ID。用于定位日志，排查问题。', + 'type' => 'string', + 'example' => '0000-ABCD-*****', + ], + 'Success' => [ + 'description' => '请求是否成功：'."\n" + .'- true（成功）'."\n" + .'- false（失败）', + 'type' => 'boolean', + 'enumValueTitles' => [], + 'example' => 'true', + ], + 'ErrorCode' => [ + 'description' => '错误码。', + 'type' => 'string', + 'example' => '101011005', + ], + 'ErrorMessage' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'Invalid.Cluster.ClusterNotFound', + ], + 'HttpStatusCode' => [ + 'description' => 'HTTP 状态码。', + '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' => '列出集群的配置信息', + 'description' => '本接口当前处于试用阶段。需要体验的用户可以提出申请，管理员加入试用名单后即可调用。', + ], + 'ListClusters' => [ + 'summary' => '列出注册到 DataWorks 的集群信息，目前支持 EMR 集群、CDH 集群。', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '231398', + 'abilityTreeNodes' => [ + 'FEATUREdideDGBIGO', + ], + ], + 'parameters' => [ + [ + 'name' => 'ClusterType', + 'in' => 'query', + 'schema' => [ + 'description' => '集群类型，支持的集群类型如下：'."\n" + .'- CDH（CDH 集群）'."\n" + .'- EMR（EMR 集群）', + 'type' => 'string', + 'required' => true, + 'enumValueTitles' => [], + 'example' => 'EMR', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '页码，大于等于 1 的正整数，默认为 1。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '每页记录数，默认为 10 条，最大 100 条。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回结构。', + 'type' => 'object', + 'properties' => [ + 'Data' => [ + 'description' => '返回数据。', + 'type' => 'object', + 'properties' => [ + 'PageNumber' => [ + 'description' => '页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '每页记录数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'TotalCount' => [ + 'description' => '总记录数。'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '100', + ], + 'Clusters' => [ + 'description' => '集群信息列表。', + 'type' => 'array', + 'items' => [ + 'description' => '集群信息。', + '$ref' => '#/components/schemas/Cluster', + ], + ], + ], + ], + 'RequestId' => [ + 'description' => '请求的 ID，用于定位日志、排查问题。', + 'type' => 'string', + 'example' => '0000-ABCD-E****', + ], + 'Success' => [ + 'description' => '请求是否成功：'."\n" + .'- true（成功）'."\n" + .'- false（失败）', + 'type' => 'boolean', + 'enumValueTitles' => [], + 'example' => 'true', + ], + 'ErrorCode' => [ + 'description' => '错误码。', + 'type' => 'string', + 'example' => '101011005', + ], + 'ErrorMessage' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'Invalid.Cluster.ClusterNotFound', + ], + 'HttpStatusCode' => [ + 'description' => 'HTTP 状态码。', + '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' => '列出集群信息', + 'description' => '本接口当前处于试用阶段。需要体验的用户可以提出申请，管理员加入试用名单后即可调用。', + ], + 'ListEntitiesByTags' => [ + 'summary' => '根据标签列出实体，目前只支持 maxcompute-table 类型的实体。', + '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' => '实体的类型。', + 'type' => 'string', + 'required' => true, + 'example' => 'maxcompute-table', + ], + ], + [ + 'name' => 'Tags', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '标签列表。', + 'type' => 'array', + 'items' => [ + 'description' => '标签。', + 'required' => false, + '$ref' => '#/components/schemas/UserEntityTag', + ], + 'required' => true, + 'maxItems' => 10, + ], + ], + [ + 'name' => 'NextToken', + 'in' => 'query', + 'schema' => [ + 'description' => '分页信息，指定本次读取的起始点。', + 'type' => 'string', + 'required' => false, + 'example' => '12345', + 'default' => '0', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '每页显示的条数，默认为 10 条、最大 100 条。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '1000', + 'example' => '10', + 'default' => '10', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'OpenApiMetaResultModel', + 'description' => '返回结构。', + 'type' => 'object', + 'properties' => [ + 'Data' => [ + 'description' => '返回数据。', + 'type' => 'object', + 'properties' => [ + 'NextToken' => [ + 'description' => '分页信息，指定下一页读取的起始点。', + 'type' => 'string', + 'example' => '12345', + ], + 'EntityList' => [ + 'description' => '实体列表。', + 'type' => 'array', + 'items' => [ + 'description' => '实体。', + '$ref' => '#/components/schemas/Entity', + ], + ], + ], + ], + 'RequestId' => [ + 'description' => '请求的 ID，用于定位日志、排查问题。', + 'type' => 'string', + 'example' => '0000-ABCD-E****', + ], + 'Success' => [ + 'description' => '请求是否成功：'."\n" + ."\n" + .'true: 成功； '."\n" + .'false: 失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'ErrorCode' => [ + 'description' => '错误码。', + 'type' => 'string', + 'example' => '101011005', + ], + 'ErrorMessage' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'Invalid.Entity.EntityTypeNotSupported', + ], + 'HttpStatusCode' => [ + 'description' => 'HTTP 状态码。', + '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' => '根据标签列出实体', + ], + 'RemoveEntityTags' => [ + 'summary' => '移除实体的标签，目前只支持 maxcompute-table 类型的实体。', + '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' => '实体唯一标识符，例如：maxcompute-table.projectA.tableA。', + 'type' => 'string', + 'required' => true, + 'example' => 'maxcompute-table.projectA.tableA', + ], + ], + [ + 'name' => 'TagKeys', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'description' => '标签 Key 列表。', + 'type' => 'array', + 'items' => [ + 'description' => '标签 Key。', + 'type' => 'string', + 'required' => false, + 'example' => 'priority', + ], + 'required' => true, + 'maxItems' => 100, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'OpenApiMetaResultModel', + 'description' => '返回结构。', + 'type' => 'object', + 'properties' => [ + 'Data' => [ + 'description' => '操作是否成功：'."\n" + ."\n" + .'true: 成功； '."\n" + .'false: 失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'RequestId' => [ + 'description' => '请求的 ID，用于定位日志、排查问题。', + 'type' => 'string', + 'example' => '0000-ABCD-E****', + ], + 'Success' => [ + 'description' => '请求是否成功：'."\n" + ."\n" + .'true: 成功； '."\n" + .'false: 失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'ErrorCode' => [ + 'description' => '错误码。', + 'type' => 'string', + 'example' => '101011005', + ], + 'ErrorMessage' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'Invalid.Entity.EntityTypeNotSupported', + ], + 'HttpStatusCode' => [ + 'description' => 'HTTP 状态码。', + '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' => '移除实体的标签', + ], + 'SetEntityTags' => [ + 'summary' => '设置实体的标签，目前只支持 maxcompute-table 类型的实体。', + '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' => '实体唯一标识符，例如：maxcompute-table.projectA.tableA。', + 'type' => 'string', + 'required' => true, + 'example' => 'maxcompute-table.projectA.tableA', + ], + ], + [ + 'name' => 'Tags', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'description' => '标签列表。', + 'type' => 'array', + 'items' => [ + 'description' => '标签。', + 'required' => false, + '$ref' => '#/components/schemas/UserEntityTag', + ], + 'required' => false, + 'maxItems' => 100, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'OpenApiMetaResultModel', + 'description' => '返回结构。', + 'type' => 'object', + 'properties' => [ + 'Data' => [ + 'description' => '操作是否成功：'."\n" + ."\n" + .'true: 成功；'."\n" + .'false: 失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'RequestId' => [ + 'description' => '请求的 ID，用于定位日志、排查问题。', + 'type' => 'string', + 'example' => '0000-ABCD-E****', + ], + 'Success' => [ + 'description' => '请求是否成功：'."\n" + ."\n" + .'true: 成功；'."\n" + .'false: 失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'ErrorCode' => [ + 'description' => '错误码。', + 'type' => 'string', + 'example' => '101011005', + ], + 'ErrorMessage' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'Invalid.Entity.EntityTypeNotSupported', + ], + 'HttpStatusCode' => [ + 'description' => 'HTTP 状态码。', + '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' => '设置实体的标签', + ], + 'ListEntityTags' => [ + 'summary' => '列出实体的标签，目前只支持 maxcompute-table 类型的实体。', + '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' => '实体唯一标识符，例如：maxcompute-table.projectA.tableA。', + 'type' => 'string', + 'required' => true, + 'example' => 'maxcompute-table.projectA.tableA', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'OpenApiMetaResultModel', + 'description' => '返回结构。', + 'type' => 'object', + 'properties' => [ + 'Data' => [ + 'description' => '标签列表。', + 'type' => 'array', + 'items' => [ + 'description' => '标签。', + '$ref' => '#/components/schemas/UserEntityTag', + ], + ], + 'RequestId' => [ + 'description' => '请求的 ID，用于定位日志、排查问题。', + 'type' => 'string', + 'example' => '0000-ABCD-E****', + ], + 'Success' => [ + 'description' => '请求是否成功：'."\n" + ."\n" + .'true: 成功； '."\n" + .'false: 失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'ErrorCode' => [ + 'description' => '错误码。', + 'type' => 'string', + 'example' => '101011005', + ], + 'ErrorMessage' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'Invalid.Entity.EntityTypeNotSupported', + ], + 'HttpStatusCode' => [ + 'description' => 'HTTP 状态码。', + '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' => '列出实体的标签', + ], + 'SetDataSourceShare' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + [ + 'PrivateKey' => [], + ], + [ + 'APP' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => true, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'ProjectId', + 'in' => 'query', + 'schema' => [ + 'description' => '目标数据源所在的DataWorks工作空间ID。您可以调用[ListProjects](~~178393~~)接口获取工作空间ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + 'maximum' => '10000000000', + 'minimum' => '1', + 'example' => '10000', + ], + ], + [ + 'name' => 'DatasourceName', + 'in' => 'query', + 'schema' => [ + 'description' => '待分享的目标数据源名称。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'mysql_name', + ], + ], + [ + 'name' => 'EnvType', + 'in' => 'query', + 'schema' => [ + 'description' => '目标数据源所属的环境。取值如下：'."\n" + .'- 0：开发环境。'."\n" + .'- 1：生产环境。', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => '1', + ], + ], + [ + 'name' => 'ProjectPermissions', + 'in' => 'query', + 'schema' => [ + 'description' => '指定需要分享目标数据源的DataWorks工作空间。分享后，该工作空间的所有成员均可查看或使用目标数据源。使用JSONARRAY格式。[{"projectId":1000,"permission":"WRITE","sharedName":"PX_DATAHUB1.shared_name"}]，'."\n" + .'参数说明如下：'."\n" + .'- projectId：需要分享目标数据源的工作空间ID。'."\n" + .'- permission：支持READ（读取）和WRITE（写入）两种模式权限。READ（读取）表示指定工作空间的所有成员仅可以读取目标数据源的数据，但是不能修改该数据；WRITE（写入）表示指定工作空间的所有成员可以修改目标数据源的数据。'."\n" + .'- sharedName：待分享的数据源名称。', + 'type' => 'string', + 'required' => false, + 'example' => '[{"projectId":1000,"permission":"WRITE","sharedName":"PX_DATAHUB1.shared_name"}]', + ], + ], + [ + 'name' => 'UserPermissions', + 'in' => 'query', + 'schema' => [ + 'description' => '指定需要分享目标数据源的用户。分享后，该用户可查看或使用目标数据源。使用JSONARRAY格式。[{"projectId":10000,"users":[{"userId":"276184575345452131","permission":"WRITE"}],"sharedName":"PX_DATAHUB1.shared_name"}]，'."\n" + .'参数说明如下：'."\n" + .'- projectId：指定DataWorks工作空间的ID。表示需要分享目标数据源的用户仅在该工作空间下可查看或使用目标数据源。'."\n" + .'- userId：需要分享目标数据源的用户ID。'."\n" + .'- permission：支持READ（读取）和WRITE（写入）两种模式权限。READ（读取）表示指定的用户仅可以读取目标数据源的数据，但是不能修改该数据；WRITE（写入）表示指定的用户可以修改目标数据源的数据。'."\n" + .'- sharedName：待分享的数据源名称。'."\n" + ."\n" + .'ProjectPermissions和UserPermissions如果都为空，则该接口不会做任何修改。如果都不为空，则既会UserPermissions生效，ProjectPermissions也会生效'."\n" + ."\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' => '请求是否成功。取值如下：'."\n" + .'- true：成功。'."\n" + .'- false：失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'RequestId' => [ + 'description' => '本次调用的唯一ID。用于出现错误后定位日志，排查问题。', + 'type' => 'string', + 'example' => '0000-ABCD-EFG ', + ], + 'Data' => [ + 'description' => '分享目标数据源的返回数据。', + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => '分享目标数据源的结果状态。取值如下：'."\n" + .'- success：表示目标数据源分享成功。'."\n" + .'- fail：表示目标数据源分享失败。您可以查看Message参数定位失败原因。', + 'type' => 'string', + 'example' => 'success', + ], + 'Message' => [ + 'description' => '分享目标数据源失败后的原因描述。如果分享目标数据源成功，则该参数的返回值为空。', + 'type' => 'string', + 'example' => 'datasource is wrong', + ], + ], + ], + ], + ], + ], + ], + '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' => '分享目标数据源', + 'summary' => '分享目标数据源至指定DataWorks工作空间或指定用户。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'CreateConnection' => [ + 'summary' => '调用CreateConnection创建一个数据源。', + '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' => '数据源关联的工作空间ID。您可以通过[ListProjects](~~178393~~)接口获取工作空间ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + 'example' => '1', + ], + ], + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => [ + 'description' => '数据源的名称。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'abc', + ], + ], + [ + 'name' => 'Description', + 'in' => 'query', + 'schema' => [ + 'description' => '连接串的描述。', + 'type' => 'string', + 'required' => false, + 'example' => 'abc', + ], + ], + [ + 'name' => 'ConnectionType', + 'in' => 'query', + 'schema' => [ + 'description' => '连接串的类型。常用类型枚举如下：'."\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', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'rds', + ], + ], + [ + 'name' => 'SubType', + 'in' => 'query', + 'schema' => [ + 'description' => '连接串的子类型，针对某些父类型type下包含子类型的场景。目前有以下组合：'."\n" + .'- 父类型：`rds`'."\n" + .'- 子类型：`mysql`、`sqlserver`或`postgresql`。', + 'type' => 'string', + 'required' => false, + 'example' => 'mysql', + ], + ], + [ + 'name' => 'EnvType', + 'in' => 'query', + 'schema' => [ + 'description' => '数据源所属的环境，包括0（开发环境）和1（生产环境）。'."\n" + ."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'docRequired' => true, + 'example' => '1', + ], + ], + [ + 'name' => 'Content', + 'in' => 'query', + 'schema' => [ + 'description' => '数据源的详细信息。部分常用数据源样例如下：'."\n" + .'- odps'."\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" + ."\n" + .'- mysql'."\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" + ."\n" + .'- rds'."\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" + ."\n" + .'- oss'."\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" + .' "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" + .' "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" + .' "jdbcUrl": "jdbc:oracle:saaa:@xxxxx:1521:PROD",'."\n" + .' "password": "sxasaxsa",'."\n" + .' "tag": "public",'."\n" + .' "username": "sasfadfa"'."\n" + .'}'."\n" + .'```'."\n" + ."\n" + .'- mongodb'."\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" + ."\n" + .'- emr'."\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" + ."\n" + .'- postgresql'."\n" + ."\n" + .'```'."\n" + .'{'."\n" + .' "jdbcUrl": "jdbc:postgresql://xxxx:1921/ssss",'."\n" + .' "password": "sdadsads",'."\n" + .' "tag": "public",'."\n" + .' "username": "sdsasda"'."\n" + .'}'."\n" + .'```'."\n" + ."\n" + .'- analyticdb_for_mysql'."\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" + ."\n" + .'- hybriddb_for_postgresql'."\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" + ."\n" + .'- holo'."\n" + ."\n" + .'```'."\n" + .'{'."\n" + .' "accessId": "xsaxsaxs",'."\n" + .' "accessKey": "xsaxsaxsa",'."\n" + .' "database": "xsaxsaxsa",'."\n" + .' "instanceId": "xsaxa",'."\n" + .' "tag": "aliyun"'."\n" + .'}'."\n" + .'```'."\n" + ."\n" + .'- kafka'."\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' => 'HTTP状态码。', + 'type' => 'string', + 'example' => '200', + ], + 'Data' => [ + 'description' => '数据源ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '123', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '0bc141151593763****', + ], + 'Success' => [ + 'description' => '请求是否成功。', + '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.', + ], + ], + ], + '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' => '创建一个数据源', + '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' => '工作空间的环境，包括PROD和DEV。', + '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' => '补数据的起始节点ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + 'example' => '1234', + ], + ], + [ + 'name' => 'IncludeNodeIds', + 'in' => 'formData', + 'schema' => [ + 'description' => '包含的节点ID列表。如果只补一个节点的数据，该节点需要在includeNodeIds中。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '74324,74325', + ], + ], + [ + 'name' => 'ExcludeNodeIds', + 'in' => 'formData', + 'schema' => [ + 'description' => '可选参数，排除无需补数据的节点ID列表。', + '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' => '传入一个 json 字符串，Key为节点 ID，Value为参数实际值', + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => '{74324:"key1=val1 key2=val"}', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => [ + 'description' => 'HTTP状态码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'RequestId' => [ + 'description' => '请求的ID。用于定位日志，排查问题。', + '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' => [ + 'description' => '工作流ID的列表。', + 'type' => 'array', + 'items' => [ + 'description' => '工作流ID的列表。', + '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":"<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' => '创建补数据工作流', + 'summary' => '调用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' => '工作空间的环境，包括PROD和DEV。', + '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' => '节点的ID。', + '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' => 'HTTP状态码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Data' => [ + 'description' => '工作流的ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '3333333', + ], + 'ErrorMessage' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'The connection does not exist.', + ], + 'RequestId' => [ + 'description' => '请求的ID。用于定位日志，排查问题。', + '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' => '创建冒烟测试工作流', + 'summary' => '调用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' => '调度运维中心的环境标识。PROD表示生产环境，DEV表示开发环境。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'PROD或者DEV', + 'enum' => [ + 'PROD', + 'DEV', + ], + ], + ], + [ + 'name' => 'ProjectName', + 'in' => 'formData', + 'schema' => [ + 'description' => '手动业务流程所属的工作空间英文名称。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'test_workspace', + ], + ], + [ + 'name' => 'FlowName', + 'in' => 'formData', + 'schema' => [ + 'description' => '手动业务流程的名称。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'test_workflow', + ], + ], + [ + 'name' => 'BizDate', + 'in' => 'formData', + 'schema' => [ + 'description' => '业务日期的值为小于等于当前日期-1天。例如，今天是2020年11月11日，则业务日期需要是2020年11月10日的00:00:00或者该日期之前的日期。业务日期的时分秒信息均填写00。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '2020-11-11 00:00:00', + ], + ], + [ + 'name' => 'NodeParameters', + 'in' => 'formData', + 'schema' => [ + 'description' => '传递手动业务流程执行时的节点参数信息，一个JSON格式：'."\n" + .'`'."\n" + .'{'."\n" + .' "<手动业务流程内部的某个节点ID>": "节点的调度参数信息，和数据开发调度配置里面的参数格式保持一致", '."\n" + .' "<手动业务流程内部的某个节点ID>": "节点的调度参数信息，和数据开发调度配置里面的参数格式保持一致"'."\n" + .'}'."\n" + .'`', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => '{"20000123121": "key1=val2 key2=val2", "20000123124": "kkkk=vvvvv aaaa=bbbb"}', + ], + ], + [ + 'name' => 'DagParameters', + 'in' => 'formData', + 'schema' => [ + 'description' => '业务流程参数，该参数会同步至本次Dag的所有实例中。如果内部节点的调度参数引用了DagParameters中的业务流程参数，则节点的对应参数值会被替换为DagParameter中的业务流程参数。', + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => '{"kaaaa": "vaaaaa", "kbbbb": "vbbbbb"}', + ], + ], + [ + 'name' => 'IncludeNodeIds', + 'in' => 'formData', + 'schema' => [ + 'description' => '需要运行的节点ID列表。', + 'type' => 'string', + 'required' => false, + 'example' => '74324,74325', + ], + ], + [ + 'name' => 'ExcludeNodeIds', + 'in' => 'formData', + 'schema' => [ + 'description' => '不需要运行的节点ID列表。', + 'type' => 'string', + 'required' => false, + 'example' => '123,456', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回实体。', + 'type' => 'object', + 'properties' => [ + 'DagId' => [ + 'description' => '手动业务流程运行Dag的实例ID。您可以通过接口和该DagId查询此次手动业务流程运行的内部节点实例的详细信息和状态。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '700000123123141', + ], + 'RequestId' => [ + 'description' => '请求唯一标识。', + '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' => '触发手动业务流程执行', + 'summary' => '手动业务流程必须已经在界面提交发布，运维中心能够找到对应的手动业务流程，才能使用该接口。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DeleteConnection' => [ + 'summary' => '调用DeleteConnection删除一个数据源。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => true, + 'systemTags' => [ + 'operationType' => 'delete', + ], + 'parameters' => [ + [ + 'name' => 'ConnectionId', + 'in' => 'query', + 'schema' => [ + 'description' => '数据源ID，您可以调用[listConnection](~~173911~~)获取数据源的ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + 'example' => '1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => [ + 'description' => 'HTTP状态码。', + 'type' => 'string', + 'example' => '200', + ], + 'Data' => [ + 'description' => '是否成功删除。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '0bc1411515937635****', + ], + 'Success' => [ + 'description' => '请求是否成功。', + '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.', + ], + ], + 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' => '删除一个数据源', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'UpdateConnection' => [ + 'summary' => '调用UpdateConnection更新一个数据源。', + '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' => '描述数据源。', + 'type' => 'string', + 'required' => false, + 'example' => 'abc', + ], + ], + [ + 'name' => 'EnvType', + 'in' => 'query', + 'schema' => [ + 'description' => '数据源所属的环境，包括0（开发环境）和1（生产环境）。'."\n" + ."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'docRequired' => true, + 'example' => '1', + ], + ], + [ + 'name' => 'Content', + 'in' => 'query', + 'schema' => [ + 'description' => '数据源的详细信息。部分常用数据源样例如下：'."\n" + .'- odps'."\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" + ."\n" + .'- mysql'."\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" + ."\n" + .'- rds'."\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" + ."\n" + .'- oss'."\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" + .' "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" + .' "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" + .' "jdbcUrl": "jdbc:oracle:saaa:@xxxxx:1521:PROD",'."\n" + .' "password": "sxasaxsa",'."\n" + .' "tag": "public",'."\n" + .' "username": "sasfadfa"'."\n" + .'}'."\n" + .'```'."\n" + ."\n" + .'- mongodb'."\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" + ."\n" + .'- emr'."\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" + ."\n" + .'- postgresql'."\n" + ."\n" + .'```'."\n" + .'{'."\n" + .' "jdbcUrl": "jdbc:postgresql://xxxx:1921/ssss",'."\n" + .' "password": "sdadsads",'."\n" + .' "tag": "public",'."\n" + .' "username": "sdsasda"'."\n" + .'}'."\n" + .'```'."\n" + ."\n" + .'- analyticdb_for_mysql'."\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" + ."\n" + .'- hybriddb_for_postgresql'."\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" + ."\n" + .'- holo'."\n" + ."\n" + .'```'."\n" + .'{'."\n" + .' "accessId": "xsaxsaxs",'."\n" + .' "accessKey": "xsaxsaxsa",'."\n" + .' "database": "xsaxsaxsa",'."\n" + .' "instanceId": "xsaxa",'."\n" + .' "tag": "aliyun"'."\n" + .'}'."\n" + .'```'."\n" + ."\n" + .'- kafka'."\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' => '数据源的状态，包括ENABLED（正常）和DISABLED（异常）。'."\n" + ."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'ENABLED', + ], + ], + [ + 'name' => 'ConnectionId', + 'in' => 'query', + 'schema' => [ + 'description' => '数据源ID。您可以通过[ListConnections](~~173911~~)接口获取项目空间下的数据源ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + 'example' => '1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => [ + 'description' => 'HTTP状态码。', + 'type' => 'string', + 'example' => '200', + ], + 'Data' => [ + 'description' => '请求是否成功更新。'."\n" + ."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '0bc14115159376359****', + ], + 'Success' => [ + 'description' => '请求是否成功。', + '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.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' => '更新一个数据源', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'ListConnections' => [ + 'summary' => '调用ListConnections查询数据源列表。', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => true, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'ProjectId', + 'in' => 'query', + 'schema' => [ + 'description' => '数据源所在的工作空间ID。您可以通过[ListProjects](~~178393~~)接口获取工作空间ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + 'example' => '76086', + ], + ], + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => [ + 'description' => '查询的数据源名称。', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => 'abc', + ], + ], + [ + 'name' => 'ConnectionType', + 'in' => 'query', + 'schema' => [ + 'description' => '连接串的类型。常用类型枚举如下：'."\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', + 'type' => 'string', + 'required' => false, + 'example' => 'rds', + ], + ], + [ + 'name' => 'SubType', + 'in' => 'query', + 'schema' => [ + 'description' => '连接串的子类型，针对某些父类型type中包含子类型的场景。目前有以下组合：'."\n" + .'- 父类型：`rds`'."\n" + .'- 子类型：`mysql`、 `sqlserver`或 `postgresql`。', + 'type' => 'string', + 'required' => false, + 'example' => 'mysql', + ], + ], + [ + 'name' => 'Status', + 'in' => 'query', + 'schema' => [ + 'description' => '数据源的状态。'."\n" + .'- ENABLED 正常'."\n" + .'- DISABLED 禁用', + 'type' => 'string', + 'required' => false, + 'example' => 'ENABLED', + ], + ], + [ + 'name' => 'EnvType', + 'in' => 'query', + 'schema' => [ + 'description' => '数据源所属的环境，包括0（开发环境）和1（生产环境）。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '每页显示的条数，默认为10条，最大100条。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '分页查询页码。取值为大于等于1的正整数。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => [ + 'description' => 'HTTP状态码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '0bc14115159376359****', + ], + 'Success' => [ + 'description' => '请求是否成功。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Data' => [ + 'description' => '连接串的分页查询结果。', + 'type' => 'object', + 'properties' => [ + 'PageNumber' => [ + 'description' => '页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '每页显示的条数，默认为10条，最大100条。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + 'TotalCount' => [ + 'description' => '数据源的总数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '3', + ], + 'Connections' => [ + 'description' => '连接串列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => '数据源的状态。'."\n" + .'- 1 正常'."\n" + .'- 2 禁用', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'ConnectionType' => [ + 'description' => '数据源的类型。常用类型枚举如下：'."\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', + 'type' => 'string', + 'example' => 'mysql', + ], + 'ProjectId' => [ + 'description' => '数据源关联的工作空间ID。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '123', + ], + 'SubType' => [ + 'description' => '数据源的子类型。针对某些父类型type中包含子类型的场景。目前有以下组合：'."\n" + .'- 父类型：`rds`'."\n" + .'- 子类型：`mysql`、`sqlserver`或`postgresql`。', + 'type' => 'string', + 'example' => 'mysql', + ], + 'GmtModified' => [ + 'description' => '修改数据源的时间。时间格式示例为Mar 17, 2021 4:09:32 PM。', + 'type' => 'string', + 'example' => 'Mar 17, 2021 4:09:32 PM', + ], + 'EnvType' => [ + 'description' => '数据源所在的环境。'."\n" + .'- 0 开发环境'."\n" + .'- 1 生产环境', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'ConnectStatus' => [ + 'description' => '数据源的状态。'."\n" + .'- 1 正常'."\n" + .'- 2 禁用', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Sequence' => [ + 'description' => '排序字段。数据源按此字段从大到小排序。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '300', + ], + 'Description' => [ + 'description' => '描述数据源。', + 'type' => 'string', + 'example' => 'a connection', + ], + 'GmtCreate' => [ + 'description' => '创建数据源的时间。时间格式示例为Mar 17, 2021 4:09:32 PM。', + 'type' => 'string', + 'example' => 'Mar 17, 2021 4:09:32 PM', + ], + 'DefaultEngine' => [ + 'description' => '数据源关联的引擎是否为同类型下的默认引擎。', + 'type' => 'boolean', + 'example' => 'false', + ], + 'Shared' => [ + 'description' => '是否为共享的数据源。', + 'type' => 'boolean', + 'example' => 'false', + ], + 'Operator' => [ + 'description' => '最近一次修改数据源的阿里云用户ID。'."\n" + ."\n", + 'type' => 'string', + 'example' => '193543050****', + ], + 'Name' => [ + 'description' => '数据源的名称。', + 'type' => 'string', + 'example' => 'abc', + ], + 'Content' => [ + 'description' => '数据源的详细信息。部分常用数据源样例如下：'."\n" + .'- odps'."\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" + ."\n" + .'- mysql'."\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" + ."\n" + .'- rds'."\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" + ."\n" + .'- oss'."\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" + .' "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" + .' "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" + .' "jdbcUrl": "jdbc:oracle:saaa:@xxxxx:1521:PROD",'."\n" + .' "password": "sxasaxsa",'."\n" + .' "tag": "public",'."\n" + .' "username": "sasfadfa"'."\n" + .'}'."\n" + .'```'."\n" + ."\n" + .'- mongodb'."\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" + ."\n" + .'- emr'."\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" + ."\n" + .'- postgresql'."\n" + ."\n" + .'```'."\n" + .'{'."\n" + .' "jdbcUrl": "jdbc:postgresql://xxxx:1921/ssss",'."\n" + .' "password": "sdadsads",'."\n" + .' "tag": "public",'."\n" + .' "username": "sdsasda"'."\n" + .'}'."\n" + .'```'."\n" + ."\n" + .'- analyticdb_for_mysql'."\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" + ."\n" + .'- hybriddb_for_postgresql'."\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" + ."\n" + .'- holo'."\n" + ."\n" + .'```'."\n" + .'{'."\n" + .' "accessId": "xsaxsaxs",'."\n" + .' "accessKey": "xsaxsaxsa",'."\n" + .' "database": "xsaxsaxsa",'."\n" + .' "instanceId": "xsaxa",'."\n" + .' "tag": "aliyun"'."\n" + .'}'."\n" + .'```'."\n" + ."\n" + .'- kafka'."\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' => '数据源ID。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'BindingCalcEngineId' => [ + 'description' => '数据源关联的计算引擎ID。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '123', + ], + 'TenantId' => [ + 'description' => '租户ID。', + '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\\": 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' => '查询数据源列表', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'GetProjectDetail' => [ + 'summary' => '查询一个DataWorks工作空间的信息。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => true, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'ProjectId', + 'in' => 'query', + 'schema' => [ + 'description' => 'DataWorks工作空间的ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + 'example' => '27', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => [ + 'description' => 'HTTP状态码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '0bc1411515937635973****', + ], + 'Success' => [ + 'description' => '是否成功查询工作空间的信息。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Data' => [ + 'description' => '工作空间的描述信息。', + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => '工作空间的状态。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'ResidentArea' => [ + 'description' => '工作空间的类型：private为私有区，swap为交换区。', + 'type' => 'string', + 'example' => 'private', + ], + 'ProjectId' => [ + 'description' => '工作空间的ID。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '27', + ], + 'ProjectIdentifier' => [ + 'description' => '工作空间的标识。', + 'type' => 'string', + 'example' => 'abc', + ], + 'ProjectName' => [ + 'description' => '工作空间的显示名称。', + 'type' => 'string', + 'example' => 'abc', + ], + 'IsAllowDownload' => [ + 'description' => '是否允许下载。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'ProjectMode' => [ + 'description' => '工作空间模式：简单工作空间模式为2，标准工作空间模式为3。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'ProjectDescription' => [ + 'description' => '工作空间的描述。', + 'type' => 'string', + 'example' => 'abc', + ], + 'GmtModified' => [ + 'description' => '修改工作空间的时间。', + 'type' => 'string', + 'example' => 'Dec 3, 2019 9:12:20 PM', + ], + 'ProjectOwnerBaseId' => [ + 'description' => '工作空间所有者的阿里云ID。', + 'type' => 'string', + 'example' => '18229311****', + ], + 'DevelopmentType' => [ + 'description' => '项目开发类型，目前均为4。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '4', + ], + 'DefaultDiResourceGroupIdentifier' => [ + 'description' => '默认节点的数据集成资源组标识。', + 'type' => 'string', + 'example' => 'group_280749521****', + ], + 'GmtCreate' => [ + 'description' => '创建工作空间的时间。', + 'type' => 'string', + 'example' => 'Oct 10, 2019 3:42:53 PM', + ], + 'SchedulerMaxRetryTimes' => [ + 'description' => '默认出错自动重跑的次数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '3', + ], + 'ProtectedMode' => [ + 'description' => '工作空间是否开启了保护模式。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'TenantId' => [ + 'description' => '租户ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '280749521950784', + ], + 'SchedulerRetryInterval' => [ + 'description' => '默认出错自动重跑的时间间隔。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '120000', + ], + 'EnvTypes' => [ + 'description' => '工作空间包含的环境：简单模式只有生产环境（PROD），标准模式包含开发环境（DEV）和生产环境（PROD）。', + 'type' => 'array', + 'items' => [ + 'description' => '工作空间包含的环境：简单模式只有生产环境（PROD），标准模式包含开发环境（DEV）和生产环境（PROD）。', + 'type' => 'string', + 'example' => '["PROD"]', + ], + ], + 'ResourceManagerResourceGroupId' => [ + 'description' => '资源组ID。', + 'type' => 'string', + 'example' => 'rg-acfmzbn7pti3zfa', + ], + 'Tags' => [ + 'description' => '标签信息。', + 'type' => 'array', + 'items' => [ + 'description' => '标签信息。', + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => '标签键。', + 'type' => 'string', + 'example' => 'Env', + ], + 'Value' => [ + 'description' => '标签值。', + 'type' => 'string', + 'example' => 'Test', + ], + ], + ], + ], + 'DisableDevelopment' => [ + 'description' => '是否禁用开发角色，取值如下：'."\n" + .' - **false**：默认值，开启开发角色。'."\n" + .' - **true**：禁用开发角色。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'UseProxyOdpsAccount' => [ + 'description' => '访问MaxCompute引擎是否使用代理账号。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'TablePrivacyMode' => [ + 'description' => 'MaxCompute表的可见性权限，取值如下：'."\n" + .'- 0，租户内用户不可见MaxCompute表。'."\n" + .'- 1，租户内用户可见MaxCompute表。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'IsDefault' => [ + 'description' => '是否为默认工作空间，取值如下：'."\n" + .'- 1，是。'."\n" + .'- 0，否。', + '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.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' => '查询工作空间信息', + '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' => '节点的ID。您可参见[ListNodes](~~173979~~)查看NodeId相关信息。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + 'minimum' => '2', + 'example' => '1234', + 'isFileTransferUrl' => false, + ], + ], + [ + 'name' => 'ProjectEnv', + 'in' => 'formData', + 'schema' => [ + 'description' => '运行的环境，包括DEV（开发环境）和PROD（生产环境）。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'PROD', + 'isFileTransferUrl' => false, + 'enum' => [ + 'PROD', + 'DEV', + ], + ], + ], + [ + 'name' => 'IoType', + 'in' => 'formData', + 'schema' => [ + 'description' => '指定查询节点为上游节点还是下游节点。包括input和output。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'output', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => [ + 'description' => 'HTTP状态码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'RequestId' => [ + 'description' => '请求的ID，用于定位日志，排查问题。', + 'type' => 'string', + 'example' => 'E6F0DBDD-5AD****', + ], + 'ErrorMessage' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'The project does not exist.', + ], + 'ErrorCode' => [ + 'description' => '错误码。', + 'type' => 'string', + 'example' => 'Invalid.Tenant.ProjectNotExists', + ], + 'Success' => [ + 'description' => '调用是否成功。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Data' => [ + 'description' => '上下游信息。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'TableName' => [ + 'description' => '输入或输出表的表名。', + 'type' => 'string', + 'example' => 'dataworks_a.datastudio_tenant_waitres_alarm', + ], + 'Data' => [ + 'description' => '输入或输出名称。', + 'type' => 'string', + 'example' => 'dataworks_a.1234_out', + ], + 'NodeId' => [ + 'description' => '节点ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '123123', + ], + ], + ], + ], + ], + ], + ], + ], + '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' => '查询上下游节点信息', + 'summary' => '查询上下游节点的信息，只能查询一层。', + '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' => '工作空间的ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + 'maximum' => '9223372036854775807', + 'minimum' => '1', + 'example' => '1234', + 'isFileTransferUrl' => false, + ], + ], + [ + 'name' => 'ProjectEnv', + 'in' => 'formData', + 'schema' => [ + 'description' => '运行的环境，包括PROD和DEV。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'PROD', + 'isFileTransferUrl' => false, + 'enum' => [ + 'PROD', + 'DEV', + ], + ], + ], + [ + 'name' => 'BizDate', + 'in' => 'formData', + 'schema' => [ + 'description' => '实例的业务日期。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '2020-01-01', + 'isFileTransferUrl' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID，用于定位日志，排查问题。', + 'type' => 'string', + 'example' => '0000-ABCD-EFG****', + ], + 'StatusCount' => [ + 'description' => '实例的状态统计。', + 'type' => 'object', + 'properties' => [ + 'FailureCount' => [ + 'description' => '失败实例的数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'WaitTimeCount' => [ + 'description' => '满足条件开始等待运行的实例数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'RunningCount' => [ + 'description' => '运行中实例的数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'SuccessCount' => [ + 'description' => '成功实例的数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'TotalCount' => [ + 'description' => '实例的总数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'NotRunCount' => [ + 'description' => '未运行实例的数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'WaitResCount' => [ + 'description' => '等待资源实例的数量。', + '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":"<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' => '获取实例不同状态的数量统计', + 'summary' => '调用GetInstanceStatusCount获取实例不同状态的数量统计。', + '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' => '工作空间的ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + 'maximum' => '9223372036854775807', + 'minimum' => '1', + 'example' => '1234', + 'isFileTransferUrl' => false, + ], + ], + [ + 'name' => 'ProjectEnv', + 'in' => 'formData', + 'schema' => [ + 'description' => '工作空间的环境，包括PROD和DEV。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'PROD', + 'isFileTransferUrl' => false, + 'enum' => [ + 'PROD', + 'DEV', + ], + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求的ID，用于定位日志，排查问题。', + 'type' => 'string', + 'example' => 'E6F0DBDD-5AD****', + ], + 'ProgramTypeAndCounts' => [ + 'description' => '节点的类型和数量。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Count' => [ + 'description' => '节点的数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '3', + ], + 'ProgramType' => [ + 'description' => '节点的类型。', + 'type' => 'string', + 'example' => 'ODPS_SQL', + ], + ], + ], + ], + ], + ], + ], + ], + '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' => '获取节点任务类型的分布', + 'summary' => '调用ListProgramTypeCount获取节点任务类型的分布。', + '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' => '运维中心的调度环境标识，包括PROD（生产环境）和DEV（开发环境）。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'RPOD', + 'enum' => [ + 'PROD', + 'DEV', + ], + ], + ], + [ + 'name' => 'ProjectName', + 'in' => 'formData', + 'schema' => [ + 'description' => '手动业务流程所属的工作空间名称。您可以进入DataWorks管控台，在工作空间配置页面获取。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'test_workspace', + ], + ], + [ + 'name' => 'DagId', + 'in' => 'formData', + 'schema' => [ + 'description' => '触发手动业务流程运行的Dag实例ID。您可以调用[CreateManualDag](~~189728~~)接口获取。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '7000001231241', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回实体。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求的唯一标识。', + 'type' => 'string', + 'example' => 'SDFSDFSDF-SDFSDF-SDFDSF-SDFSDF', + ], + 'Instances' => [ + 'description' => '手动业务流程的内部实例列表。', + 'type' => 'array', + 'items' => [ + 'description' => '返回实体。', + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => '实例任务的状态，取值如下：'."\n" + .'- NOT_RUN（未运行）'."\n" + .'- WAIT_TIME（等待定时时间dueTime或cycleTime到来）'."\n" + .'- WAIT_RESOURCE（等待资源）'."\n" + .'- RUNNING（运行中）'."\n" + .'- CHECKING（下发给数据质量进行数据校检）'."\n" + .'- CHECKING_CONDITION（正在进行分支条件校检）'."\n" + .'- FAILURE（执行失败）'."\n" + .'- SUCCESS（执行成功）', + 'type' => 'string', + 'example' => 'WAIT_TIME', + ], + 'BeginRunningTime' => [ + 'description' => '实例任务开始运行的时间。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1605178414676', + ], + 'BizDate' => [ + 'description' => '业务日期。通常为该任务运行时间的前一天。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1605178414676', + ], + 'CycTime' => [ + 'description' => '实例任务的定时时间。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1605178414676', + ], + 'FinishTime' => [ + 'description' => '实例任务运行的结束时间。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1605178414676', + ], + 'CreateTime' => [ + 'description' => '实例任务的创建时间。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1605178414676', + ], + 'DagId' => [ + 'description' => '手动业务流程实例的DagId。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '350850491', + ], + 'InstanceId' => [ + 'description' => '内部实例ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '11726873619', + ], + 'BeginWaitResTime' => [ + 'description' => '实例任务开始等待资源的时间。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1605178414676', + ], + 'TaskType' => [ + 'description' => '实例任务的调度类型，取值如下：'."\n" + .'- NORMAL(0)：正常调度任务。该任务被日常调度。'."\n" + .'- MANUAL(1)：手动任务。该任务不会被日常调度。'."\n" + .'- PAUSE(2)：暂停任务。该任务被日常调度，但启动调度时直接被置为失败状态。'."\n" + .'- SKIP(3)：空跑任务。该任务被日常调度，但启动调度时直接被置为成功状态。'."\n" + .'- SKIP_UNCHOOSE(4)：临时工作流中未选择的任务，仅存在于临时工作流中，启动调度时直接被置为成功状态。'."\n" + .'- SKIP_CYCLE(5)：未到运行周期的周或月任务。该任务被日常调度，但启动调度时直接被置为成功状态。'."\n" + .'- CONDITION_UNCHOOSE(6)：上游实例中有分支（IF）节点，但是该下游节点未被分支节点选中，直接置为空跑任务。'."\n" + .'- REALTIME_DEPRECATED(7)：实时生成的已经过期的周期实例，该类型的任务直接被置为成功状态。'."\n", + 'type' => 'string', + 'example' => 'NORMAL(0)', + ], + 'ParamValues' => [ + 'description' => '实例的参数信息。', + 'type' => 'string', + 'example' => 'xxx', + ], + 'DagType' => [ + 'description' => '手动业务流程的类型。', + 'type' => 'string', + 'example' => '5', + ], + 'NodeName' => [ + 'description' => '节点名称。', + 'type' => 'string', + 'example' => 'test2', + ], + 'BeginWaitTimeTime' => [ + 'description' => '实例任务开始等待调度的时间。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1605178414676', + ], + 'NodeId' => [ + 'description' => '业务流程的内部节点ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '37851', + ], + 'ModifyTime' => [ + 'description' => '实例任务最新的修改时间。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1605178414676', + ], + 'CreateUser' => [ + 'description' => '操作人。', + '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' => '获取手动业务流程执行实例的信息', + 'summary' => '调用GetManualDagInstances，获取手动执行的业务流程实例的信息。', + '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' => '调度运维中心环境标识：PROD表示生产环境，DEV表示开发环境。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'PROD', + 'enum' => [ + 'PROD', + 'DEV', + ], + ], + ], + [ + 'name' => 'Outputs', + 'in' => 'formData', + 'schema' => [ + 'description' => '节点的输出串。支持多个值，多个值时请使用英文逗号（,）分隔。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'aaaaa.1231412_out,bbbb.12313123_out', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => [ + 'description' => 'HTTP状态码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Data' => [ + 'description' => '返回数据为一个Map，Key是用户输入的每个output，Value是output对应的节点信息。', + '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' => '错误信息。', + 'type' => 'string', + 'example' => 'The connection does not exist.', + ], + 'RequestId' => [ + 'description' => '请求的ID。用于定位日志，排查问题。', + 'type' => 'string', + 'example' => 'SDFSDFSDF-asdfDFSDF-SDFSDf-SDfSFD', + ], + 'Success' => [ + 'description' => '调用是否成功。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'ErrorCode' => [ + 'description' => '错误码。', + 'type' => 'string', + 'example' => 'Invalid.Tenant.ConnectionNotExists', + ], + ], + ], + ], + ], + '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' => '根据输出精确查询节点', + 'summary' => '调用SearchNodesByOutput，根据输出精确查询节点。', + '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' => 'Dataworks工作空间的ID，您可以单击页面右上角的小扳手图标，进入工作空间管理页面进行查看。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'docRequired' => true, + 'example' => '10000', + ], + ], + [ + 'name' => 'ProjectIdentifier', + 'in' => 'formData', + 'schema' => [ + 'description' => 'Dataworks工作空间的唯一标识符，即数据开发页面顶部切换工作空间处的英文标识。该参数与ProjectId参数二者必须设置其一，以确定本次API调用操作的Dataworks工作空间。', + 'type' => 'string', + 'required' => false, + 'example' => 'dw_project', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'formData', + 'schema' => [ + 'description' => '请求的数据页数，用于翻页。'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'docRequired' => true, + 'maximum' => '100', + 'minimum' => '1', + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'formData', + 'schema' => [ + 'description' => '请求的数据页大小，最大值为100。'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'docRequired' => true, + 'maximum' => '100', + 'minimum' => '0', + 'example' => '50', + ], + ], + [ + 'name' => 'Keyword', + 'in' => 'formData', + 'schema' => [ + 'description' => '节点类型的名称，您可以在DataStudio目录树中看到某个节点类型的名称，支持中英文，与locale需要对齐。支持模糊搜索，不填的情况下返回所有节点类型。', + 'type' => 'string', + 'required' => false, + 'example' => 'ODPS SQ', + ], + ], + [ + 'name' => 'Locale', + 'in' => 'formData', + 'schema' => [ + 'description' => '语言筛选，支持zh-CN和en-US。', + 'type' => 'string', + 'required' => false, + 'example' => 'zh-CN', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用的唯一ID。出现错误后，您可以根据该ID排查问题。', + 'type' => 'string', + 'example' => '0000-ABCD-EFG****', + ], + 'NodeTypeInfoList' => [ + 'description' => '符合条件的节点类型信息列表。', + 'type' => 'object', + 'properties' => [ + 'PageNumber' => [ + 'description' => '当前数据页的页码。'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '当前数据页的大小。'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '50', + ], + 'TotalCount' => [ + 'description' => '满足查询条件的数据总条数。'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '127', + ], + 'NodeTypeInfo' => [ + 'description' => '单个节点类型的信息。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'NodeTypeName' => [ + 'description' => '节点类型的名称。', + 'type' => 'string', + 'example' => 'ODPS SQL', + ], + 'NodeType' => [ + 'description' => '节点类型Type（数字）。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + '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' => '查询节点类型信息', + 'summary' => '查询节点类型信息，包括类型Code和类型名称。', + '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' => '基线的ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + 'example' => '1234', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => [ + 'description' => 'HTTP返回码。'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'RequestId' => [ + 'description' => '本次调用的唯一ID。出现错误后，您可以根据该ID排查问题。'."\n", + 'type' => 'string', + 'example' => '0000-ABCD-E****', + ], + 'ErrorMessage' => [ + 'description' => '错误信息。'."\n", + 'type' => 'string', + 'example' => 'The specified parameters are invalid.', + ], + 'ErrorCode' => [ + 'description' => '错误码。', + 'type' => 'string', + 'example' => '1031203110005', + ], + 'Success' => [ + 'description' => '调用是否成功。', + 'type' => 'string', + 'example' => 'true', + ], + 'Data' => [ + 'description' => '基线上的节点列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Owner' => [ + 'description' => '节点责任人的阿里云UID。', + 'type' => 'string', + 'example' => '9527952****', + ], + 'NodeName' => [ + 'description' => '节点的名称。', + 'type' => 'string', + 'example' => '节点名称', + ], + 'NodeId' => [ + 'description' => '节点的ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1234', + ], + 'ProjectId' => [ + 'description' => '节点所在工作空间的ID。', + '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.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' => '获取基线上的节点', + 'summary' => '调用GetNodeOnBaseline获取基线上的节点。', + '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' => 'DataWorks工作空间的ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + 'maximum' => '99999999999', + 'minimum' => '2', + 'example' => '9527', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '每次请求生成的唯一标识。', + 'type' => 'string', + 'example' => '952795279527ab****', + ], + 'InstanceStatusTrend' => [ + 'description' => '分时段实例状态的统计趋势。', + 'type' => 'object', + 'properties' => [ + 'TodayTrend' => [ + 'description' => '今日趋势。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'TimePoint' => [ + 'description' => '时间点，分别为00:00～23:00。'."\n" + ."\n", + 'type' => 'string', + 'example' => '01:00', + ], + 'Count' => [ + 'description' => '实例的数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + ], + ], + ], + 'YesterdayTrend' => [ + 'description' => '昨日的趋势。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'TimePoint' => [ + 'description' => '时间点，分别为00:00～23:00。'."\n", + 'type' => 'string', + 'example' => '01:00', + ], + 'Count' => [ + 'description' => '实例的数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + ], + ], + ], + 'AvgTrend' => [ + 'description' => '历史平均趋势。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'TimePoint' => [ + 'description' => '时间点，分别为00:00～23:00。', + 'type' => 'string', + 'example' => '01:00', + ], + 'Count' => [ + 'description' => '实例的数量。', + '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":"<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' => '获取当天任务分时段的统计趋势', + 'summary' => '调用GetSuccessInstanceTrend获取当天任务分时段的统计趋势。', + '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' => 'DataWorks工作空间的ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + 'maximum' => '99999999999', + 'minimum' => '2', + 'example' => '10000', + ], + ], + [ + 'name' => 'BeginDate', + 'in' => 'formData', + 'schema' => [ + 'description' => '起始业务日期，精确到天。您需要使用yyyy-MM-dd\'T\'HH:mm:ssZ的UTC格式。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '2020-04-02T00:00:00+0800', + ], + ], + [ + 'name' => 'EndDate', + 'in' => 'formData', + 'schema' => [ + 'description' => '截止业务日期，精确到天。您需要使用yyyy-MM-dd\'T\'HH:mm:ssZ的UTC格式。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '2020-09-10T00:00:00+0800', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '每次请求生成的唯一标识。', + 'type' => 'string', + 'example' => '95279527adhfj****', + ], + 'InstanceCounts' => [ + 'description' => '实例数量趋势数据。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Date' => [ + 'description' => '业务日期对应的时间戳。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1600963200000', + ], + 'Count' => [ + 'description' => '实例的数量。', + '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.', + ], + [ + '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' => '获取周期实例数量的趋势', + 'summary' => '调用GetInstanceCountTrend获取周期实例数量的趋势。', + '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' => 'DataWorks工作空间的ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + 'maximum' => '99999999999', + 'minimum' => '2', + 'example' => '100000', + ], + ], + [ + 'name' => 'Bizdate', + 'in' => 'formData', + 'schema' => [ + 'description' => '业务日期，精确到天。您需要使用yyyy-MM-dd\'T\'HH:mm:ssZ的UTC格式。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '2020-09-21T00:00:00+0800', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '每次请求生成的唯一标识。', + 'type' => 'string', + 'example' => '6347364dadsfadf****', + ], + 'InstanceConsumeTimeRank' => [ + 'description' => '实例运行时长的排行记录。', + 'type' => 'object', + 'properties' => [ + 'UpdateTime' => [ + 'description' => '排行更新时间戳。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1600963200000', + ], + 'ConsumeTimeRank' => [ + 'description' => '实例运行时长的排行数据。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Owner' => [ + 'description' => '节点责任人的阿里云UID。', + 'type' => 'string', + 'example' => '952795279527', + ], + 'NodeName' => [ + 'description' => '节点的名称。', + 'type' => 'string', + 'example' => '节点名称', + ], + 'Bizdate' => [ + 'description' => '实例运行的业务日期。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1600963200000', + ], + 'InstanceId' => [ + 'description' => '实例ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '95279527', + ], + 'PrgType' => [ + 'description' => '任务的类型。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'NodeId' => [ + 'description' => '任务节点的ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '9527', + ], + 'Consumed' => [ + 'description' => '实例运行时长，单位为s。', + '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.', + ], + [ + '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' => '获取实例运行时长排行', + 'summary' => '调用GetInstanceConsumeTimeRank获取实例运行时长排行。', + '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' => 'DataWorks工作空间的ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + 'maximum' => '99999999999', + 'minimum' => '2', + 'example' => '9527', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '每次请求生成的唯一标识。', + 'type' => 'string', + 'example' => '952795279527****', + ], + 'InstanceErrorRank' => [ + 'description' => '节点出错的排行数据。', + 'type' => 'object', + 'properties' => [ + 'UpdateTime' => [ + 'description' => '出错排行更新的时间戳。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1600963200000', + ], + 'ErrorRank' => [ + 'description' => '节点近一个月出错排行数据。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Owner' => [ + 'description' => '节点责任人的阿里云UID。', + 'type' => 'string', + 'example' => '952795279527', + ], + 'NodeName' => [ + 'description' => '节点的名称。', + 'type' => 'string', + 'example' => '节点名称', + ], + 'ProjectId' => [ + 'description' => 'DataWorks工作空间的ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '9527', + ], + 'NodeId' => [ + 'description' => '节点的ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '9527', + ], + 'Count' => [ + 'description' => '节点出错的次数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '5', + ], + 'PrgType' => [ + 'description' => '节点任务的类型。', + '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.', + ], + [ + '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' => '获取近一个月节点的出错排行', + 'summary' => '调用GetInstanceErrorRank获取近一个月节点的出错排行。', + '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', + ], + ], +]; diff --git a/data/zh_cn/dataworks-public/2024-05-18/api-docs.php b/data/zh_cn/dataworks-public/2024-05-18/api-docs.php new file mode 100644 index 0000000..e2b72e8 --- /dev/null +++ b/data/zh_cn/dataworks-public/2024-05-18/api-docs.php @@ -0,0 +1,58613 @@ +<?php return [ + 'version' => '1.0', + 'info' => [ + 'style' => 'RPC', + 'product' => 'dataworks-public', + 'version' => '2024-05-18', + ], + 'directories' => [ + [ + 'id' => 203861, + 'title' => '认证文件管理', + 'type' => 'directory', + 'children' => [ + 'ImportCertificate', + 'GetCertificate', + 'ListCertificates', + 'DeleteCertificate', + ], + ], + [ + 'id' => 198217, + 'title' => '空间管理', + 'type' => 'directory', + 'children' => [ + [ + 'id' => 198218, + 'title' => '工作空间', + 'type' => 'directory', + 'children' => [ + 'CreateProject', + 'UpdateProject', + 'DeleteProject', + 'GetProject', + 'ListProjects', + ], + ], + [ + 'id' => 198566, + 'title' => '空间角色', + 'type' => 'directory', + 'children' => [ + 'GetProjectRole', + 'ListProjectRoles', + ], + ], + [ + 'id' => 198571, + 'title' => '空间成员', + 'type' => 'directory', + 'children' => [ + 'CreateProjectMember', + 'DeleteProjectMember', + 'GrantMemberProjectRoles', + 'RevokeMemberProjectRoles', + 'GetProjectMember', + 'ListProjectMembers', + ], + ], + ], + ], + [ + 'id' => 198149, + 'title' => '数据源', + 'type' => 'directory', + 'children' => [ + 'TestDataSourceConnectivity', + 'CreateDataSource', + 'DeleteDataSource', + 'UpdateDataSource', + 'CloneDataSource', + 'GetDataSource', + 'ListDataSources', + [ + 'id' => 198204, + 'title' => '数据源分享规则', + 'type' => 'directory', + 'children' => [ + 'CreateDataSourceSharedRule', + 'DeleteDataSourceSharedRule', + 'ListDataSourceSharedRules', + ], + ], + ], + ], + [ + 'id' => 321265, + 'title' => '计算资源', + 'type' => 'directory', + 'children' => [ + 'DeleteComputeResource', + 'DeleteComputeResource', + 'GetComputeResource', + 'UpdateComputeResource', + 'ListComputeResources', + 'CreateComputeResource', + ], + ], + [ + 'id' => 198537, + 'title' => '资源组管理', + 'type' => 'directory', + 'children' => [ + [ + 'id' => 198549, + 'title' => '资源组', + 'type' => 'directory', + 'children' => [ + 'CreateResourceGroup', + 'DeleteResourceGroup', + 'UpdateResourceGroup', + 'GetResourceGroup', + 'ListResourceGroups', + 'DissociateProjectFromResourceGroup', + 'AssociateProjectToResourceGroup', + 'ListResourceGroupAssociateProjects', + 'ListResourceGroupMetricData', + ], + ], + [ + 'id' => 198538, + 'title' => '路由', + 'type' => 'directory', + 'children' => [ + 'CreateRoute', + 'DeleteRoute', + 'UpdateRoute', + 'GetRoute', + 'ListRoutes', + ], + ], + [ + 'id' => 198544, + 'title' => '网络', + 'type' => 'directory', + 'children' => [ + 'CreateNetwork', + 'DeleteNetwork', + 'GetNetwork', + 'ListNetworks', + ], + ], + ], + ], + [ + 'id' => 197271, + 'title' => '数据开发（新版）', + 'type' => 'directory', + 'children' => [ + [ + 'id' => 268819, + 'title' => '组件', + 'type' => 'directory', + 'children' => [ + 'CreateComponent', + 'DeleteComponent', + 'GetComponent', + 'UpdateComponent', + 'ListComponents', + ], + ], + [ + 'id' => 197703, + 'title' => '节点', + 'type' => 'directory', + 'children' => [ + 'CreateNode', + 'DeleteNode', + 'UpdateNode', + 'MoveNode', + 'RenameNode', + 'GetNode', + 'ListNodes', + 'ListNodeDependencies', + ], + ], + [ + 'id' => 197702, + 'title' => '工作流定义', + 'type' => 'directory', + 'children' => [ + 'CreateWorkflowDefinition', + 'ImportWorkflowDefinition', + 'DeleteWorkflowDefinition', + 'UpdateWorkflowDefinition', + 'MoveWorkflowDefinition', + 'RenameWorkflowDefinition', + 'GetWorkflowDefinition', + 'ListWorkflowDefinitions', + ], + ], + [ + 'id' => 197700, + 'title' => '资源', + 'type' => 'directory', + 'children' => [ + 'CreateResource', + 'DeleteResource', + 'DeleteResource', + 'UpdateResource', + 'MoveResource', + 'RenameResource', + 'GetResource', + 'ListResources', + ], + ], + [ + 'id' => 197701, + 'title' => '函数', + 'type' => 'directory', + 'children' => [ + 'CreateFunction', + 'DeleteFunction', + 'UpdateFunction', + 'UpdateFunction', + 'MoveFunction', + 'RenameFunction', + 'GetFunction', + 'ListFunctions', + ], + ], + [ + 'id' => 197704, + 'title' => '发布流程', + 'type' => 'directory', + 'children' => [ + 'CreatePipelineRun', + 'AbolishPipelineRun', + 'ExecPipelineRunStage', + 'GetPipelineRun', + 'ListPipelineRuns', + 'ListPipelineRunItems', + ], + ], + ], + ], + [ + 'id' => 208290, + 'title' => '数据开发（旧版）', + 'type' => 'directory', + 'children' => [ + [ + 'id' => 208291, + 'title' => '文件', + 'type' => 'directory', + 'children' => [ + 'CreateFile', + 'CreateResourceFile', + 'CreateUdfFile', + 'DeleteFile', + 'UpdateFile', + 'UpdateUdfFile', + 'GetFile', + 'ListFiles', + 'SubmitFile', + 'DeployFile', + ], + ], + [ + 'id' => 208302, + 'title' => '文件夹', + 'type' => 'directory', + 'children' => [ + 'CreateFolder', + 'DeleteFolder', + 'UpdateFolder', + 'GetFolder', + 'ListFolders', + ], + ], + [ + 'id' => 208308, + 'title' => '业务流程', + 'type' => 'directory', + 'children' => [ + 'CreateBusiness', + 'DeleteBusiness', + 'UpdateBusiness', + 'GetBusiness', + 'ListBusiness', + ], + ], + [ + 'id' => 208314, + 'title' => '发布包', + 'type' => 'directory', + 'children' => [ + 'GetDeploymentPackage', + 'ListDeploymentPackages', + 'ListDeploymentPackageFiles', + ], + ], + [ + 'id' => 208318, + 'title' => '文件版本', + 'type' => 'directory', + 'children' => [ + 'GetFileVersion', + 'ListFileVersions', + ], + ], + [ + 'id' => 208321, + 'title' => '扩展点事件', + 'type' => 'directory', + 'children' => [ + 'UpdateIDEEventResult', + 'GetIDEEventDetail', + ], + ], + [ + 'id' => 208324, + 'title' => '表', + 'type' => 'directory', + 'children' => [ + 'EstablishRelationTableToBusiness', + ], + ], + ], + ], + [ + 'id' => 198342, + 'title' => '数据集成', + 'type' => 'directory', + 'children' => [ + [ + 'id' => 198343, + 'title' => '同步任务', + 'type' => 'directory', + 'children' => [ + 'CreateDIJob', + 'UpdateDIJob', + 'DeleteDIJob', + 'StopDIJob', + 'StartDIJob', + 'GetDIJob', + 'GetDIJobLog', + 'ListDIJobs', + 'ListDIJobRunDetails', + 'ListDIJobMetrics', + 'ListDIJobEvents', + ], + ], + [ + 'id' => 198354, + 'title' => '任务告警', + 'type' => 'directory', + 'children' => [ + 'CreateDIAlarmRule', + 'UpdateDIAlarmRule', + 'DeleteDIAlarmRule', + 'ListDIAlarmRules', + ], + ], + ], + ], + [ + 'id' => 204415, + 'title' => '数据地图', + 'type' => 'directory', + 'children' => [ + [ + 'id' => 204416, + 'title' => '元数据采集器类型', + 'type' => 'directory', + 'children' => [ + 'ListCrawlerTypes', + ], + ], + [ + 'id' => 204418, + 'title' => '元数据实体', + 'type' => 'directory', + 'children' => [ + [ + 'id' => 204419, + 'title' => '数据目录', + 'type' => 'directory', + 'children' => [ + 'ListCatalogs', + 'GetCatalog', + ], + ], + [ + 'id' => 204422, + 'title' => '数据库', + 'type' => 'directory', + 'children' => [ + 'ListDatabases', + 'GetDatabase', + ], + ], + [ + 'id' => 204425, + 'title' => '模式', + 'type' => 'directory', + 'children' => [ + 'ListSchemas', + 'GetSchema', + ], + ], + [ + 'id' => 204428, + 'title' => '数据表', + 'type' => 'directory', + 'children' => [ + 'ListTables', + 'GetTable', + 'UpdateTableBusinessMetadata', + ], + ], + [ + 'id' => 204432, + 'title' => '字段', + 'type' => 'directory', + 'children' => [ + 'ListColumns', + 'GetColumn', + 'UpdateColumnBusinessMetadata', + ], + ], + [ + 'id' => 344258, + 'title' => '数据集', + 'type' => 'directory', + 'children' => [ + 'ListDatasets', + 'GetDataset', + 'CreateDataset', + 'UpdateDataset', + 'DeleteDataset', + ], + ], + [ + 'id' => 347399, + 'title' => '数据集版本', + 'type' => 'directory', + 'children' => [ + 'ListDatasetVersions', + 'GetDatasetVersion', + 'CreateDatasetVersion', + 'UpdateDatasetVersion', + 'DeleteDatasetVersion', + 'PreviewDatasetVersion', + ], + ], + ], + ], + [ + 'id' => 204436, + 'title' => '分区', + 'type' => 'directory', + 'children' => [ + 'ListPartitions', + 'GetPartition', + ], + ], + [ + 'id' => 204439, + 'title' => '血缘关系', + 'type' => 'directory', + 'children' => [ + 'ListLineageRelationships', + 'GetLineageRelationship', + 'DeleteLineageRelationship', + 'CreateLineageRelationship', + 'ListLineages', + ], + ], + [ + 'id' => 204445, + 'title' => '元数据集合', + 'type' => 'directory', + 'children' => [ + 'ListMetaCollections', + 'CreateMetaCollection', + 'GetMetaCollection', + 'UpdateMetaCollection', + 'DeleteMetaCollection', + 'ListEntitiesInMetaCollection', + 'AddEntityIntoMetaCollection', + 'RemoveEntityFromMetaCollection', + ], + ], + ], + ], + [ + 'id' => 198752, + 'title' => '运维中心', + 'type' => 'directory', + 'children' => [ + [ + 'id' => 199222, + 'title' => '监控告警', + 'type' => 'directory', + 'children' => [ + 'ListAlertRules', + 'GetAlertRule', + 'UpdateAlertRule', + 'DeleteAlertRule', + 'CreateAlertRule', + ], + ], + [ + 'id' => 198753, + 'title' => '任务', + 'type' => 'directory', + 'children' => [ + 'DeleteTask', + 'UpdateTask', + 'BatchUpdateTasks', + 'GetTask', + 'ListTasks', + 'ListUpstreamTasks', + 'ListDownstreamTasks', + 'ListTaskOperationLogs', + ], + ], + [ + 'id' => 198759, + 'title' => '任务实例', + 'type' => 'directory', + 'children' => [ + 'UpdateTaskInstances', + 'GetTaskInstance', + 'GetTaskInstanceLog', + 'ListTaskInstances', + 'ListUpstreamTaskInstances', + 'ListTaskInstanceOperationLogs', + 'ListDownstreamTaskInstances', + 'SuspendTaskInstances', + 'ResumeTaskInstances', + 'StopTaskInstances', + 'SetSuccessTaskInstances', + 'RerunTaskInstances', + 'RemoveTaskInstanceDependencies', + 'TriggerSchedulerTaskInstance', + ], + ], + [ + 'id' => 201611, + 'title' => '工作流', + 'type' => 'directory', + 'children' => [ + 'DeleteWorkflow', + 'UpdateWorkflow', + 'GetWorkflow', + 'ListWorkflows', + ], + ], + [ + 'id' => 201615, + 'title' => '工作流实例', + 'type' => 'directory', + 'children' => [ + 'GetRerunWorkflowInstancesResult', + 'RerunWorkflowInstances', + 'CreateWorkflowInstances', + 'GetCreateWorkflowInstancesResult', + 'GetWorkflowInstance', + 'ListWorkflowInstances', + 'StartWorkflowInstances', + 'StopWorkflowInstances', + 'ExecuteAdhocWorkflowInstance', + ], + ], + ], + ], + [ + 'id' => 198728, + 'title' => '数据质量', + 'type' => 'directory', + 'children' => [ + [ + 'id' => 199702, + 'title' => '数据质量规则模板', + 'type' => 'directory', + 'children' => [ + 'CreateDataQualityTemplate', + 'UpdateDataQualityTemplate', + 'ListDataQualityTemplates', + 'GetDataQualityTemplate', + 'DeleteDataQualityTemplate', + ], + ], + [ + 'id' => 199687, + 'title' => '数据质量监控', + 'type' => 'directory', + 'children' => [ + 'CreateDataQualityScan', + 'UpdateDataQualityScan', + 'ListDataQualityScans', + 'GetDataQualityScan', + 'DeleteDataQualityScan', + ], + ], + [ + 'id' => 199694, + 'title' => '告警规则', + 'type' => 'directory', + 'children' => [ + 'CreateDataQualityAlertRule', + 'UpdateDataQualityAlertRule', + 'ListDataQualityAlertRules', + 'GetDataQualityAlertRule', + 'DeleteDataQualityAlertRule', + ], + ], + [ + 'id' => 199699, + 'title' => '数据质量运行', + 'type' => 'directory', + 'children' => [ + 'CreateDataQualityScanRun', + 'ListDataQualityScanRuns', + 'GetDataQualityScanRunLog', + 'GetDataQualityScanRun', + ], + ], + ], + ], + [ + 'id' => 339900, + 'title' => '安全中心', + 'type' => 'directory', + 'children' => [ + 'CreateIdentifyCredential', + ], + ], + [ + 'id' => 201385, + 'title' => '标签管理', + 'type' => 'directory', + 'children' => [ + 'CreateDataAssetTag', + 'DeleteDataAssetTag', + 'UpdateDataAssetTag', + 'ListDataAssetTags', + 'TagDataAssets', + 'UnTagDataAssets', + 'ListDataAssets', + ], + ], + [ + 'id' => 198491, + 'title' => '开放平台', + 'type' => 'directory', + 'children' => [ + 'GetJobStatus', + ], + ], + [ + 'id' => 246416, + 'title' => '其他', + 'type' => 'directory', + 'children' => [ + 'ListDataQualityEvaluationTasks', + 'ListDataQualityRules', + 'ListDataQualityEvaluationTaskInstances', + 'ListDataQualityResults', + 'DetachDataQualityRulesFromEvaluationTask', + 'DeleteDataQualityEvaluationTask', + 'GetDataQualityEvaluationTaskInstance', + 'GetDataQualityEvaluationTask', + 'AttachDataQualityRulesToEvaluationTask', + 'UpdateDataQualityEvaluationTask', + 'CreateDataQualityEvaluationTaskInstance', + 'CreateDataQualityEvaluationTask', + 'DeleteDataQualityRule', + 'UpdateDataQualityRuleTemplate', + 'CreateDataQualityRuleTemplate', + 'DeleteDataQualityRuleTemplate', + 'GetDataQualityRuleTemplate', + 'CreateDataQualityRule', + 'UpdateDataQualityRule', + 'GetDataQualityRule', + 'ListDataQualityRuleTemplates', + ], + ], + ], + 'components' => [ + 'schemas' => [ + 'Catalog' => [ + 'title' => '元数据数据目录', + 'description' => '元数据的数据目录。', + 'type' => 'object', + 'properties' => [ + 'Id' => [ + 'title' => 'ID', + 'description' => '数据目录实体ID，当前支持dlf与starrocks类型，可参考[元数据实体相关概念说明](~~2880092~~)。'."\n" + ."\n" + .'- 对于dlf类型，格式为 `dlf-catalog::catalog_id`'."\n" + ."\n" + .'- 对于starrocks类型，格式为`starrocks-catalog:(instance_id|encoded_jdbc_url):catalog_name`'."\n" + ."\n" + .'> 其中 '."\n" + .'`catalog_id`: dlf目录id '."\n" + .'`instance_id`: 实例ID，对应数据源以实例模式注册时需要提供 '."\n" + .'`encoded_jdbc_url`: JDBC连接串的URLEncode编码,对应数据源以连接串方式注册时需要提供 '."\n" + .'`catalog_name`: starrocks目录名称', + 'type' => 'string', + 'example' => 'dlf-catalog::catalog_id', + ], + 'Name' => [ + 'title' => '名称', + 'description' => '名称', + 'type' => 'string', + 'example' => 'default_catalog', + ], + 'Comment' => [ + 'title' => '注释', + 'description' => '注释', + 'type' => 'string', + 'example' => 'this is a comment', + ], + 'Type' => [ + 'title' => '类型', + 'description' => '类目类型，取值与元数据采集器类型相关', + 'type' => 'string', + 'example' => 'Internal', + ], + 'CreateTime' => [ + 'title' => '创建时间', + 'description' => '创建时间（毫秒级时间戳）', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1722073854000', + ], + 'ModifyTime' => [ + 'title' => '修改时间', + 'description' => '修改时间（毫秒级时间戳）', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1722073854000'."\n", + ], + 'ParentMetaEntityId' => [ + 'title' => '父层级实体ID', + 'description' => '父层级实体ID'."\n" + ."\n" + .'- 对于dlf类型，`ParentMetaEntityId`格式为 `dlf`'."\n" + ."\n" + .'- 对于starrocks类型，`ParentMetaEntityId`格式为 `starrocks:(instance_id|encoded_jdbc_url)`'."\n" + ."\n" + .'>其中 '."\n" + .'`instance_id`: 实例ID，对应数据源以实例模式注册时需要提供 '."\n" + .'`encoded_jdbc_url`: JDBC连接串的URLEncode编码,对应数据源以连接串方式注册时需要提供', + 'type' => 'string', + 'example' => 'dlf', + ], + ], + ], + 'Column' => [ + 'title' => '数据表字段', + 'description' => '字段。', + 'type' => 'object', + 'properties' => [ + 'Id' => [ + 'title' => 'ID', + 'description' => 'ID，可参考[元数据实体相关概念说明](~~2880092~~)。'."\n" + ."\n" + .'格式为`${EntityType}:${实例ID或转义后的URL}:${数据目录标识}:${数据库名称}:${模式名称}:${数据表名称}:${字段名称}`，对于不存在的层级使用空字符占位'."\n" + ."\n" + .'> 对于maxcompute和dlf类型，实例ID使用空字符占位。对于maxcompute类型，数据库名称即为maxcompute项目名称，开启三层模型的项目需要提供模式名称，未开启的项目模式名称处使用空字符占位。'."\n" + ."\n" + .'> starrocks类型的数据目录标识为目录名称，dlf类型的数据目录标识为目录ID, 其他类型不支持目录层级，可用空字符占位。'."\n" + ."\n" + .'几种常用类型的ID格式参考如下'."\n" + ."\n" + .'`maxcompute-column:::project_name:[schema_name]:table_name:column_name`'."\n" + ."\n" + .'`dlf-column::catalog_id:database_name::table_name:column_name`'."\n" + ."\n" + .'`hms-column:instance_id::database_name::table_name:column_name`'."\n" + ."\n" + .'`holo-column:instance_id::database_name:schema_name:table_name:column_name`'."\n" + ."\n" + .'`mysql-column:(instance_id|encoded_jdbc_url)::database_name::table_name:column_name`'."\n" + ."\n" + .'> 其中 '."\n" + .'`instance_id`: 实例ID，对应数据源以实例模式注册时需要提供 '."\n" + .'`encoded_jdbc_url`: JDBC连接串的URLEncode编码,对应数据源以连接串方式注册时需要提供 '."\n" + .'`catalog_id`: dlf目录ID '."\n" + .'`project_name`: maxcompute项目名称 '."\n" + .'`database_name`: 数据库名称 '."\n" + .'`schema_name`: schema名称，对于maxcompute类型，仅所属项目开启三层模型后需要提供，若未开启则使用空字符占位。 '."\n" + .'`table_name`: 表名称 '."\n" + .'`column_name`: 字段名称', + 'type' => 'string', + 'example' => 'maxcompute-column:::project_name:[schema_name]:table_name:column_name', + ], + 'Name' => [ + 'title' => '名称', + 'description' => '名称。', + 'type' => 'string', + 'example' => 'column_name', + ], + 'Comment' => [ + 'title' => '注释', + 'description' => '注释。', + 'type' => 'string', + 'example' => '字段1', + ], + 'TableId' => [ + 'title' => '所属表ID', + 'description' => '数据表ID，可参考`Table`对象。', + 'type' => 'string', + 'example' => 'maxcompute-table:::project_name:[schema_name]:table_name', + ], + 'Position' => [ + 'title' => '位置', + 'description' => '位置。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Type' => [ + 'title' => '类型', + 'description' => '类型。', + 'type' => 'string', + 'example' => 'bigint', + ], + 'PrimaryKey' => [ + 'title' => '是否为主键', + 'description' => '是否为主键, 当前仅MaxCompute类型支持。', + 'type' => 'boolean', + 'example' => 'false', + ], + 'PartitionKey' => [ + 'title' => '是否为分区键', + 'description' => '是否为分区键。', + 'type' => 'boolean', + 'example' => 'false', + ], + 'ForeignKey' => [ + 'title' => '是否为外键', + 'description' => '是否为外键，当前仅MaxCompute类型支持。', + 'type' => 'boolean', + 'example' => 'false', + ], + 'BusinessMetadata' => [ + 'title' => '业务元数据', + 'description' => '业务元数据。', + 'type' => 'object', + 'properties' => [ + 'Description' => [ + 'title' => '字段业务描述', + 'description' => '字段业务描述，当前仅MaxCompute，HMS（EMR集群），DLF类型支持。', + 'type' => 'string', + 'example' => '字段1的业务描述', + ], + ], + ], + ], + ], + 'CrawlerType' => [ + 'title' => '元数据采集器类型', + 'description' => '元数据采集器类型', + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'title' => '类型标识', + 'description' => '类型标识，当前支持的元数据采集器类型，取值有'."\n" + ."\n" + .'- `maxcompute`'."\n" + .'- `dlf` '."\n" + .'- `hms`（使用HMS管理元数据的EMR集群或CDH_HIVE集群）'."\n" + .'- `holo`'."\n" + .'- `mysql`'."\n" + .'- `oracle`'."\n" + .'- `postgresql`'."\n" + .'- `sqlserver`'."\n" + .'- `analyticdb_for_mysql`'."\n" + .'- `ads`'."\n" + .'- `hybriddb_for_postgresql`'."\n" + .'- `ots`'."\n" + .'- `clickhouse`'."\n" + .'- `starrocks` （仅支持查询Internal Catalog）', + 'type' => 'string', + 'example' => 'dlf', + ], + 'DisplayName' => [ + 'title' => '展示名称', + 'description' => '展示名称', + 'type' => 'string', + 'example' => 'Data Lake Formation', + ], + 'SupportedEntityTypes' => [ + 'title' => '支持的实体类型列表，实体类型之间按照声明顺序，具有自上而下的层级关系', + 'description' => '支持的实体类型列表，实体类型之间按照声明顺序，具有自上而下的层级关系', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'title' => '实体类型标识，与采集器类型相关，格式为(CrawlerType)-{SubType}', + 'description' => '实体类型标识，与采集器类型相关，格式为`${CrawlerType}-${SubType}`', + 'type' => 'string', + 'example' => 'dlf-table', + ], + 'SubType' => [ + 'title' => '实体子类型标识', + 'description' => '实体子类型标识，如`catalog/database/schema/table/column`', + 'type' => 'string', + 'example' => 'table', + ], + 'Optional' => [ + 'title' => '实体类型是否可选', + 'description' => '实体类型是否可选'."\n" + ."\n" + .'如对于maxcompute-schema类型，schema层级是否存在可选（是否开启三层模型）', + 'type' => 'boolean', + 'example' => 'true', + ], + 'ParentSubType' => [ + 'title' => '父层级的实体子类型，不存在时为null', + 'description' => '父层级的实体子类型，不存在时为null', + 'type' => 'string', + 'example' => 'database', + ], + ], + ], + ], + ], + ], + 'DataQualityEvaluationTask' => [ + 'title' => 'A short description of struct', + 'description' => '质量监控任务', + 'type' => 'object', + 'properties' => [ + 'Id' => [ + 'title' => '数据质量校验任务ID', + 'description' => '数据质量校验任务ID', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10001', + ], + 'Name' => [ + 'title' => '数据质量校验任务名称，数字、英文字母、汉字、半角全角标点符号组合，最长255个字符', + 'description' => '数据质量校验任务名称，数字、英文字母、汉字、半角全角标点符号组合，最长255个字符', + 'type' => 'string', + 'example' => '质量校验任务', + ], + 'Description' => [ + 'title' => '数据质量校验任务描述，最长65535个字符', + 'description' => '数据质量校验任务描述，最长65535个字符', + 'type' => 'string', + 'example' => 'This is a daily run data quality evaluation plan.', + ], + 'TenantId' => [ + 'title' => 'DataWorks租户ID', + 'description' => 'DataWorks租户ID', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10', + ], + 'ProjectId' => [ + 'title' => 'Dataworks项目空间ID', + 'description' => 'Dataworks项目空间ID', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '100', + ], + 'Target' => [ + 'title' => '数据质量校验任务的监控对象', + 'description' => '数据质量校验任务的监控对象', + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'title' => '监控对象类型', + 'description' => '监控对象类型'."\n" + .'- Table', + 'type' => 'string', + 'example' => 'Table', + ], + 'DatabaseType' => [ + 'title' => '表类型的数据集，表所属的数据库类型', + 'description' => '表类型的数据集，表所属的数据库类型'."\n" + .'- maxcompute'."\n" + .'- emr'."\n" + .'- cdh'."\n" + .'- hologres'."\n" + .'- analyticdb_for_postgresql'."\n" + .'- analyticdb_for_mysql'."\n" + .'- starrocks', + 'type' => 'string', + 'example' => 'maxcompute', + ], + 'TableGuid' => [ + 'title' => '表在数据地图中的唯一ID', + 'description' => '表在数据地图中的唯一ID', + 'type' => 'string', + 'example' => 'odps.unit_test.tb_unit_test', + ], + 'PartitionSpec' => [ + 'title' => '分区表的分区设置', + 'description' => '分区表的分区设置', + 'type' => 'string', + 'example' => 'ds=$[yyyymmdd-1]', + ], + ], + ], + 'Trigger' => [ + 'title' => '数据质量校验任务的触发配置', + 'description' => '数据质量校验任务的触发配置', + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'title' => '何种事件可以触发质量校验任务执行', + 'description' => '何种事件可以触发质量校验任务执行'."\n" + .'- ByScheduledTaskInstance：调度实例运行成功', + 'type' => 'string', + 'example' => 'ByScheduledTaskInstance', + ], + 'TaskIds' => [ + 'title' => 'type=ByScheduledTaskInstance时生效 ,具体指明哪些调度节点的实例执行成功后可以触发', + 'description' => 'type=ByScheduledTaskInstance时生效 ,具体指明哪些调度节点的实例执行成功后可以触发', + 'type' => 'array', + 'items' => [ + 'description' => '调度任务节点ID', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10001', + ], + ], + ], + ], + 'DataSourceId' => [ + 'title' => '数据质量校验任务执行时应使用的数据源', + 'description' => '数据质量校验任务执行时应使用的数据源', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '201', + ], + 'RuntimeConf' => [ + 'title' => '使用数据源时的一些设置，目前只支持指定EMR的yarn队列、采集EMR表时把SQL引擎指定为SPARK_SQL|KYUUBI|PRESTO_SQL|HIVE_SQL', + 'description' => '使用数据源时的一些设置，目前只支持指定EMR的yarn队列、采集EMR表时SQL引擎指定为SPARK_SQL|KYUUBI|PRESTO_SQL|HIVE_SQL', + 'type' => 'string', + 'example' => '{ "queue": "default", "sqlEngine": "SPARK_SQL" }', + ], + 'Hooks' => [ + 'title' => '数据质量校验任务实例生命周期中的回调设置，目前只支持一个阻塞调度任务的Hook', + 'description' => '数据质量校验任务实例生命周期中的回调设置，目前只支持一个阻塞调度任务的Hook', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'title' => '后续处理动作类型，如BLOCK_TASK_INSTANCE：阻塞DataWorks任务实例执行', + 'description' => '后续处理动作类型'."\n" + .'- BlockTaskInstance：阻塞DataWorks任务实例执行', + 'type' => 'string', + 'example' => 'BlockTaskInstance', + ], + 'Condition' => [ + 'title' => 'Hook触发条件', + 'description' => 'Hook触发条件', + 'type' => 'string', + 'example' => '${severity} == "High" AND ${status} == "Critical"', + ], + ], + ], + ], + 'Notifications' => [ + 'title' => '数据质量校验任务通知订阅配置', + 'description' => '数据质量校验任务通知订阅配置', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Condition' => [ + 'title' => '告警触发条件', + 'description' => '告警触发条件', + 'type' => 'string', + 'example' => '${blockType} == "Strong"', + ], + 'Notifications' => [ + 'title' => '具体的消息通知设置', + 'description' => '具体的消息通知设置', + 'type' => 'array', + 'items' => [ + 'description' => '告警方式', + 'type' => 'object', + 'properties' => [ + 'NotificationChannels' => [ + 'title' => '告警方式', + 'description' => '告警方式', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Channels' => [ + 'title' => '告警方式', + 'description' => '告警方式', + 'type' => 'array', + 'items' => [ + 'description' => '- Mail - 邮件'."\n" + .'- Sms - 短信'."\n" + .'- Phone - 电话'."\n" + .'- Feishu - 飞书'."\n" + .'- Weixin - 微信'."\n" + .'- Dingding - 钉钉'."\n" + .'- Webhook - 自定义Webhook', + 'type' => 'string', + 'example' => 'Mail', + ], + 'example' => 'Mail', + ], + ], + ], + ], + 'NotificationReceivers' => [ + 'title' => '告警接收人设置', + 'description' => '告警接收人设置', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ReceiverType' => [ + 'title' => '告警接收人类型', + 'description' => '告警接收人类型', + 'type' => 'string', + 'example' => 'AliUid', + ], + 'ReceiverValues' => [ + 'title' => '告警接收人具体值', + 'description' => '告警接收人具体值', + 'type' => 'array', + 'items' => [ + 'description' => '告警接收人具体值', + 'type' => 'string', + 'example' => 'user1', + ], + ], + 'Extension' => [ + 'title' => '扩展信息，格式为 json，例如钉钉机器人支持 at 所有人', + 'description' => '扩展信息，格式为 json，例如钉钉机器人支持 at 所有人', + 'type' => 'string', + 'example' => '{"atAll":"true"}', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'DataQualityEvaluationTaskInstance' => [ + 'title' => 'A short description of struct', + 'description' => '质量监控任务实例', + 'type' => 'object', + 'properties' => [ + 'Id' => [ + 'title' => '任务实例ID', + 'description' => '任务实例ID', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10001', + ], + 'CreateTime' => [ + 'title' => '任务实例创建时间', + 'description' => '任务实例创建时间', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1710239005403', + ], + 'FinishTime' => [ + 'title' => '任务实例结束时间', + 'description' => '任务实例结束时间', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1710239005403', + ], + 'Status' => [ + 'title' => '当前运行状态', + 'description' => '当前运行状态', + 'type' => 'string', + 'example' => 'Passed', + ], + 'Task' => [ + 'title' => '校验开始时，数据质量校验任务的快照', + 'description' => '校验开始时，数据质量校验任务的快照', + 'type' => 'object', + 'properties' => [ + 'Id' => [ + 'title' => '数据质量校验任务ID', + 'description' => '数据质量校验任务ID', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10001', + ], + 'Name' => [ + 'title' => '数据质量校验任务名称，数字、英文字母、汉字、半角全角标点符号组合，最长255个字符', + 'description' => '数据质量校验任务名称，数字、英文字母、汉字、半角全角标点符号组合，最长255个字符', + 'type' => 'string', + 'example' => '质量校验任务', + ], + 'TenantId' => [ + 'title' => 'DataWorks租户ID', + 'description' => 'DataWorks租户ID', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '195820716552192', + ], + 'ProjectId' => [ + 'title' => 'DataWorks项目空间ID', + 'description' => 'DataWorks项目空间ID', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2626', + ], + 'Target' => [ + 'title' => '数据质量校验任务的监控对象', + 'description' => '数据质量校验任务的监控对象', + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'title' => '监控对象类型', + 'description' => '监控对象类型'."\n" + ."\n" + .'- Table', + 'type' => 'string', + 'example' => 'Table', + ], + 'DatabaseType' => [ + 'title' => '表类型的数据集，表所属的数据库类型', + 'description' => '表类型的数据集，表所属的数据库类型'."\n" + .'- maxcompute'."\n" + .'- emr'."\n" + .'- cdh'."\n" + .'- hologres'."\n" + .'- analyticdb_for_postgresql'."\n" + .'- analyticdb_for_mysql'."\n" + .'- starrocks', + 'type' => 'string', + 'example' => 'maxcompute', + ], + 'TableGuid' => [ + 'title' => '表在数据地图中的唯一ID', + 'description' => '表在数据地图中的唯一ID', + 'type' => 'string', + 'example' => 'odps.unit_test.tb_unit_test', + ], + 'PartitionSpec' => [ + 'title' => '分区表的分区设置', + 'description' => '分区表的分区设置', + 'type' => 'string', + 'example' => 'ds=$[yyyymmdd-1]', + ], + ], + ], + 'Trigger' => [ + 'title' => '数据质量校验任务的触发配置', + 'description' => '数据质量校验任务的触发配置', + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'title' => '何种事件可以触发质量校验任务执行', + 'description' => '何种事件可以触发质量校验任务执行'."\n" + .'- ByScheduledTaskInstance：调度实例运行成功', + 'type' => 'string', + 'example' => 'ByScheduledTaskInstance', + ], + 'TaskIds' => [ + 'title' => 'type=ByScheduledTaskInstance时生效 ,具体指明哪些调度节点的实例执行成功后可以触发', + 'description' => 'type=ByScheduledTaskInstance时生效 ,具体指明哪些调度节点的实例执行成功后可以触发', + 'type' => 'array', + 'items' => [ + 'description' => '调度任务节点ID', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10001', + ], + ], + ], + ], + 'DataSourceId' => [ + 'title' => '数据质量校验任务执行时应使用的数据源', + 'description' => '数据质量校验任务执行时应使用的数据源', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '201', + ], + 'RuntimeConf' => [ + 'title' => '使用数据源时的一些设置，目前只支持指定EMR的yarn队列、采集EMR表时把SQL引擎指定为SPARK_SQL|KYUUBI|PRESTO_SQL|HIVE_SQL', + 'description' => '使用数据源时的一些设置，目前只支持指定EMR的yarn队列、采集EMR表时把SQL引擎指定为SPARK_SQL|KYUUBI|PRESTO_SQL|HIVE_SQL', + 'type' => 'string', + 'example' => '{ "queue": "default", "sqlEngine": "SPARK_SQL" }', + ], + 'Hooks' => [ + 'title' => '数据质量校验任务实例生命周期中的回调设置，目前只支持一个阻塞调度任务的Hook', + 'description' => '数据质量校验任务实例生命周期中的回调设置，目前只支持一个阻塞调度任务的Hook', + 'type' => 'array', + 'items' => [ + 'description' => '回调设置', + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'title' => '后续处理动作类型', + 'description' => '后续处理动作类型'."\n" + .'- BlockTaskInstance：阻塞DataWorks任务实例执行', + 'type' => 'string', + 'example' => 'BlockTaskInstance', + ], + 'Condition' => [ + 'title' => 'Hook触发条件', + 'description' => 'Hook触发条件', + 'type' => 'string', + 'example' => '${severity} == "High" AND ${status} == "Critical"', + ], + ], + ], + ], + 'Notifications' => [ + 'title' => '数据质量校验任务告警订阅配置', + 'description' => '数据质量校验任务告警订阅配置', + 'type' => 'array', + 'items' => [ + 'description' => '告警设置', + 'type' => 'object', + 'properties' => [ + 'Condition' => [ + 'title' => '告警触发条件', + 'description' => '告警触发条件', + 'type' => 'string', + 'example' => '${blockType} == "Strong"', + ], + 'Notifications' => [ + 'title' => '具体的消息通知设置', + 'description' => '具体的消息通知设置', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'NotificationChannels' => [ + 'title' => '告警方式', + 'description' => '告警方式', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Channels' => [ + 'title' => '告警方式', + 'description' => '告警方式', + 'type' => 'array', + 'items' => [ + 'description' => '- Mail - 邮件'."\n" + .'- Sms - 短信'."\n" + .'- Phone - 电话'."\n" + .'- Feishu - 飞书'."\n" + .'- Weixin - 微信'."\n" + .'- Dingding - 钉钉'."\n" + .'- Webhook - 自定义Webhook', + 'type' => 'string', + 'example' => 'Mail', + ], + 'example' => 'Mail', + ], + ], + 'example' => 'Dingding', + ], + ], + 'NotificationReceivers' => [ + 'title' => '告警接收人配置', + 'description' => '告警接收人配置', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ReceiverType' => [ + 'title' => '告警接收人配置', + 'description' => '告警接收人配置', + 'type' => 'string', + 'example' => 'AliUid', + ], + 'ReceiverValues' => [ + 'title' => '告警接收人具体值', + 'description' => '告警接收人具体值', + 'type' => 'array', + 'items' => [ + 'description' => '告警接收人具体值', + 'type' => 'string', + 'example' => 'user1', + ], + ], + 'Extension' => [ + 'title' => '扩展信息，格式为 json，例如钉钉机器人支持 at 所有人', + 'description' => '扩展信息，格式为 json，例如钉钉机器人支持 at 所有人', + 'type' => 'string', + 'example' => '{"atAll":"true"}', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'DataQualityResult' => [ + 'title' => 'A short description of struct', + 'description' => '数据质量结果', + 'type' => 'object', + 'properties' => [ + 'Id' => [ + 'title' => '校验结果ID', + 'description' => '校验结果ID', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10001', + ], + 'Status' => [ + 'title' => '校验结果状态', + 'description' => '校验结果状态', + 'type' => 'string', + 'example' => 'Passed', + ], + 'TaskInstanceId' => [ + 'title' => '质量校验任务实例ID', + 'description' => '质量校验任务实例ID', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '20001', + ], + 'Rule' => [ + 'title' => '校验开始时，规则配置快照', + 'description' => '校验开始时，规则配置快照', + 'type' => 'object', + 'properties' => [ + 'Id' => [ + 'title' => '规则ID，全局唯一标识', + 'description' => '规则ID，全局唯一标识', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '100001', + ], + 'Name' => [ + 'title' => '规则名称，数字、英文字母、汉字、半角全角标点符号组合，最长255个字符', + 'description' => '规则名称，数字、英文字母、汉字、半角全角标点符号组合，最长255个字符', + 'type' => 'string', + 'example' => '表不能为空', + ], + 'TenantId' => [ + 'title' => 'DataWorks租户ID', + 'description' => 'DataWorks租户ID', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'ProjectId' => [ + 'title' => 'DataWorks项目空间ID', + 'description' => 'DataWorks项目空间ID', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '100', + ], + 'Enabled' => [ + 'title' => '规则是否启用', + 'description' => '规则是否启用', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Severity' => [ + 'title' => '规则对于业务的等级（对应页面上的强弱规则）', + 'description' => '规则对于业务的等级（对应页面上的强弱规则）', + 'type' => 'string', + 'example' => 'High', + ], + 'Description' => [ + 'title' => '规则描述信息，最长500个字符', + 'description' => '规则描述信息，最长500个字符', + 'type' => 'string', + 'example' => 'this is a odps _sql task', + ], + 'Target' => [ + 'title' => '规则所监控的对象', + 'description' => '规则所监控的对象', + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'title' => '监控对象类型', + 'description' => '监控对象类型'."\n" + .'- Table', + 'type' => 'string', + 'example' => 'Table', + ], + 'DatabaseType' => [ + 'title' => '表类型的数据集，表所属的数据库类型', + 'description' => '表类型的数据集，表所属的数据库类型'."\n" + .'- maxcompute'."\n" + .'- emr'."\n" + .'- cdh'."\n" + .'- hologres'."\n" + .'- analyticdb_for_postgresql'."\n" + .'- analyticdb_for_mysql'."\n" + .'- starrocks', + 'type' => 'string', + 'example' => 'maxcompute', + ], + 'TableGuid' => [ + 'title' => '表在数据地图中的唯一ID', + 'description' => '表在数据地图中的唯一ID', + 'type' => 'string', + 'example' => 'odps.unit_test.tb_unit_test', + ], + 'PartitionSpec' => [ + 'title' => '分区表的分区设置', + 'description' => '分区表的分区设置', + 'type' => 'string', + 'example' => 'ds=$[yyyymmdd-1]', + ], + ], + ], + 'TemplateCode' => [ + 'title' => 'system::user创建规则时所引用的规则模板', + 'description' => '创建规则时所引用的规则模板', + 'type' => 'string', + 'example' => 'SYSTEM:user_defined_sql', + ], + 'SamplingConfig' => [ + 'title' => '样本采集所需的设置', + 'description' => '样本采集所需的设置', + 'type' => 'object', + 'properties' => [ + 'Metric' => [ + 'title' => '采样的指标名称', + 'description' => '采样的指标名称'."\n" + .'- Count：表行数'."\n" + .'- Min：字段最小值'."\n" + .'- Max：字段最大值'."\n" + .'- Avg：字段均值'."\n" + .'- DistinctCount：字段唯一值个数'."\n" + .'- DistinctPercent：字段唯一值个数与数据行数占比'."\n" + .'- DuplicatedCount：字段重复值个数'."\n" + .'- DuplicatedPercent：字段重复值个数与数据行数占比'."\n" + .'- TableSize：表大小'."\n" + .'- NullValueCount：字段为空的行数'."\n" + .'- NullValuePercent：字段为空的比例'."\n" + .'- GroupCount：按字段值聚合后每个值与对应的数据行数'."\n" + .'- CountNotIn：枚举值不匹配行数'."\n" + .'- CountDistinctNotIn：枚举值不匹配唯一值个数'."\n" + .'- UserDefinedSql：通过自定义SQL做样本采集', + 'type' => 'string', + 'example' => 'Min', + ], + 'MetricParameters' => [ + 'title' => '样本采集时，所需的参数', + 'description' => '样本采集时，所需的参数', + 'type' => 'string', + 'example' => '{ "Columns": [ "id", "name" ] }', + ], + 'SettingConfig' => [ + 'title' => '具体执行采样语句前，插入执行的一些运行时参数设置语句，最长1000个字符。目前只支持MaxCompute', + 'description' => '具体执行采样语句前，插入执行的一些运行时参数设置语句，最长1000个字符。目前只支持MaxCompute', + 'type' => 'string', + 'example' => 'SET odps.sql.udf.timeout=600s;', + ], + 'SamplingFilter' => [ + 'title' => '采样时，对不关注的数据进行二次过滤的条件，最多16777215个字符', + 'description' => '采样时，对不关注的数据进行二次过滤的条件，最多16777215个字符', + 'type' => 'string', + 'example' => 'id IS NULL', + ], + ], + ], + 'CheckingConfig' => [ + 'title' => '样本校验设置', + 'description' => '样本校验设置', + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'title' => '阈值计算方式', + 'description' => '阈值计算方式'."\n" + .'- Fixed'."\n" + .'- Fluctation'."\n" + .'- FluctationDiscreate'."\n" + .'- Auto'."\n" + .'- Average'."\n" + .'- Variance', + 'type' => 'string', + 'example' => 'Fixed', + ], + 'ReferencedSamplesFilter' => [ + 'title' => '有些类型的阈值需要查询出一些参考样本，然后对参考样本的值进行汇总得出进行比较的阈值，这里使用一个表达式来表示参考样本的查询方式', + 'description' => '有些类型的阈值需要查询出一些参考样本，然后对参考样本的值进行汇总得出进行比较的阈值，这里使用一个表达式来表示参考样本的查询方式', + 'type' => 'string', + 'example' => '{ "bizdate": [ "-1", "-7", "-1m" ] }', + ], + 'Thresholds' => [ + 'title' => '阈值设置', + 'description' => '阈值设置', + 'type' => 'object', + 'properties' => [ + 'Expected' => [ + 'title' => '期望的阈值设置', + 'description' => '期望的阈值设置', + 'type' => 'object', + 'properties' => [ + 'Value' => [ + 'title' => '阈值数值', + 'description' => '阈值数值', + 'type' => 'string', + 'example' => '100.0', + ], + 'Operator' => [ + 'title' => '比较符', + 'description' => '比较符'."\n" + .'- \\>'."\n" + .'- \\>='."\n" + .'- <'."\n" + .'- <='."\n" + .'- !='."\n" + .'- =', + 'type' => 'string', + 'example' => '>', + ], + ], + ], + 'Warned' => [ + 'title' => '普通警告的阈值设置', + 'description' => '普通警告的阈值设置', + 'type' => 'object', + 'properties' => [ + 'Value' => [ + 'title' => '阈值数值', + 'description' => '阈值数值', + 'type' => 'string', + 'example' => '100.0', + ], + 'Operator' => [ + 'title' => '比较符', + 'description' => '比较符'."\n" + .'- \\>'."\n" + .'- \\>='."\n" + .'- <'."\n" + .'- <='."\n" + .'- !='."\n" + .'- =', + 'type' => 'string', + 'example' => '>', + ], + ], + ], + 'Critical' => [ + 'title' => '严重警告的阈值设置', + 'description' => '严重警告的阈值设置', + 'type' => 'object', + 'properties' => [ + 'Value' => [ + 'title' => '阈值数值', + 'description' => '阈值数值', + 'type' => 'string', + 'example' => '100.0', + ], + 'Operator' => [ + 'title' => '比较符', + 'description' => '比较符'."\n" + .'- \\>'."\n" + .'- \\>='."\n" + .'- <'."\n" + .'- <='."\n" + .'- !='."\n" + .'- =', + 'type' => 'string', + 'example' => '>', + ], + ], + ], + ], + ], + ], + ], + 'ErrorHandlers' => [ + 'title' => '质量规则校验问题处理器', + 'description' => '质量规则校验问题处理器', + 'type' => 'array', + 'items' => [ + 'description' => '质量规则校验问题处理器', + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'title' => '处理器类型', + 'description' => '处理器类型', + 'type' => 'string', + 'example' => 'SaveErrorData', + ], + 'ErrorDataFilter' => [ + 'title' => '如果是自定义SQL规则，需要用户指定SQL来过滤问题数据', + 'description' => '如果是自定义SQL规则，需要用户指定SQL来过滤问题数据', + 'type' => 'string', + 'example' => 'SELECT * FROM tb_api_log WHERE id IS NULL', + ], + ], + ], + ], + ], + ], + 'Sample' => [ + 'title' => '本次校验所使用的样本值', + 'description' => '本次校验所使用的样本值', + 'type' => 'string', + 'example' => '[ { "gender": "male", "_count": 100 }, { "gender": "female", "_count": 100 } ]', + ], + 'Details' => [ + 'title' => '本次校验的详情', + 'description' => '本次校验的详情', + 'type' => 'array', + 'items' => [ + 'description' => '校验详情', + 'type' => 'object', + 'properties' => [ + 'ReferencedValue' => [ + 'title' => '使用引用的样本，用来参与CheckedValue计算的基准值', + 'description' => '使用引用的样本，用来参与CheckedValue计算的基准值', + 'type' => 'string', + 'example' => '0.0', + ], + 'CheckedValue' => [ + 'title' => '最终用来与阈值比较的值', + 'description' => '最终用来与阈值比较的值', + 'type' => 'string', + 'example' => '100.0', + ], + 'Status' => [ + 'title' => '最终的比较结果状态', + 'description' => '最终的比较结果状态', + 'type' => 'string', + 'example' => 'Passed', + ], + ], + ], + ], + ], + ], + 'DataQualityRule' => [ + 'title' => 'A short description of struct', + 'description' => '数据质量规则', + 'type' => 'object', + 'properties' => [ + 'Id' => [ + 'title' => '规则ID', + 'description' => '规则ID', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1', + ], + 'Name' => [ + 'title' => '规则名称，数字、英文字母、汉字、半角全角标点符号组合，最长255个字符', + 'description' => '规则名称，数字、英文字母、汉字、半角全角标点符号组合，最长255个字符', + 'type' => 'string', + 'example' => '表不能为空', + ], + 'TenantId' => [ + 'title' => 'Dataworks租户ID', + 'description' => 'Dataworks租户ID', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'ProjectId' => [ + 'title' => 'Dataworks项目空间ID', + 'description' => 'Dataworks项目空间ID', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '100', + ], + 'Enabled' => [ + 'title' => '规则是否启用', + 'description' => '规则是否启用', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Severity' => [ + 'title' => '规则对于业务的等级（对应页面上的强弱规则）', + 'description' => '规则对于业务的等级（对应页面上的强弱规则），可选的枚举值：'."\n" + .'- Normal'."\n" + .'- High', + 'type' => 'string', + 'example' => 'High', + ], + 'Description' => [ + 'title' => '规则描述信息，最长500个字符', + 'description' => '规则描述信息，最长500个字符', + 'type' => 'string', + 'example' => 'this is a odps _sql task', + ], + 'TemplateCode' => [ + 'title' => '创建规则时所引用的规则模板', + 'description' => '创建规则时所引用的规则模板', + 'type' => 'string', + 'example' => 'SYSTEM:user_defined_sql', + ], + 'Target' => [ + 'title' => '规则所监控的对象', + 'description' => '规则所监控的对象', + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'title' => '监控对象类型', + 'description' => '监控对象类型'."\n" + .'- Table', + 'type' => 'string', + 'example' => 'Table', + ], + 'DatabaseType' => [ + 'title' => '表类型的数据集，表所属的数据库类型', + 'description' => '表类型的数据集，表所属的数据库类型'."\n" + .'- maxcompute'."\n" + .'- emr'."\n" + .'- cdh'."\n" + .'- hologres'."\n" + .'- analyticdb_for_postgresql'."\n" + .'- analyticdb_for_mysql'."\n" + .'- starrocks', + 'type' => 'string', + 'example' => 'maxcompute', + ], + 'TableGuid' => [ + 'title' => '表在数据地图中的唯一ID', + 'description' => '表在数据地图中的唯一ID', + 'type' => 'string', + 'example' => 'odps.unit_test.tb_unit_test', + ], + 'PartitionSpec' => [ + 'title' => '分区表的分区设置', + 'description' => '分区表的分区设置', + 'type' => 'string', + 'example' => 'ds=$[yyyymmdd-1]', + ], + ], + ], + 'SamplingConfig' => [ + 'title' => '样本采集所需的设置', + 'description' => '样本采集所需的设置', + 'type' => 'object', + 'properties' => [ + 'Metric' => [ + 'title' => '采样的指标名称', + 'description' => '采样的指标名称'."\n" + .'- Count：表行数'."\n" + .'- Min：字段最小值'."\n" + .'- Max：字段最大值'."\n" + .'- Avg：字段均值'."\n" + .'- DistinctCount：字段唯一值个数'."\n" + .'- DistinctPercent：字段唯一值个数与数据行数占比'."\n" + .'- DuplicatedCount：字段重复值个数'."\n" + .'- DuplicatedPercent：字段重复值个数与数据行数占比'."\n" + .'- TableSize：表大小'."\n" + .'- NullValueCount：字段为空的行数'."\n" + .'- NullValuePercent：字段为空的比例'."\n" + .'- GroupCount：按字段值聚合后每个值与对应的数据行数'."\n" + .'- CountNotIn：枚举值不匹配行数'."\n" + .'- CountDistinctNotIn：枚举值不匹配唯一值个数'."\n" + .'- UserDefinedSql：通过自定义SQL做样本采集', + 'type' => 'string', + 'example' => 'Min', + ], + 'MetricParameters' => [ + 'title' => '样本采集时，所需的参数', + 'description' => '样本采集时，所需的参数', + 'type' => 'string', + 'example' => '{ "Columns": [ "id", "name" ] }', + ], + 'SettingConfig' => [ + 'title' => '具体执行采样语句前，插入执行的一些运行时参数设置语句，最长1000个字符。目前只支持MaxCompute', + 'description' => '具体执行采样语句前，插入执行的一些运行时参数设置语句，最长1000个字符。目前只支持MaxCompute', + 'type' => 'string', + 'example' => 'SET odps.sql.udf.timeout=600s;', + ], + 'SamplingFilter' => [ + 'title' => '采样时，对不关注的数据进行二次过滤的条件，最多16777215个字符', + 'description' => '采样时，对不关注的数据进行二次过滤的条件，最多16777215个字符', + 'type' => 'string', + 'example' => 'id IS NULL', + ], + ], + ], + 'CheckingConfig' => [ + 'title' => '样本校验设置', + 'description' => '样本校验设置', + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'title' => '阈值计算方式', + 'description' => '阈值计算方式'."\n" + .'- Fixed'."\n" + .'- Fluctation'."\n" + .'- FluctationDiscreate'."\n" + .'- Auto'."\n" + .'- Average'."\n" + .'- Variance', + 'type' => 'string', + 'example' => 'Fixed', + ], + 'ReferencedSamplesFilter' => [ + 'title' => '有些类型的阈值需要查询出一些参考样本，然后对参考样本的值进行汇总得出进行比较的阈值，这里使用一个表达式来表示参考样本的查询方式', + 'description' => '有些类型的阈值需要查询出一些参考样本，然后对参考样本的值进行汇总得出进行比较的阈值，这里使用一个表达式来表示参考样本的查询方式', + 'type' => 'string', + 'example' => '{ "bizdate": [ "-1", "-7", "-1m" ] }', + ], + 'Thresholds' => [ + 'title' => '阈值设置', + 'description' => '阈值设置', + 'type' => 'object', + 'properties' => [ + 'Expected' => [ + 'title' => '期望的阈值设置', + 'description' => '期望的阈值设置', + 'type' => 'object', + 'properties' => [ + 'Value' => [ + 'title' => '阈值数值', + 'description' => '阈值数值', + 'type' => 'string', + 'example' => '100.0', + ], + 'Operator' => [ + 'title' => '比较符', + 'description' => '比较符'."\n" + .'- />'."\n" + .'- />='."\n" + .'- <'."\n" + .'- <='."\n" + .'- !='."\n" + .'- =', + 'type' => 'string', + 'example' => '>', + ], + 'Expression' => [ + 'title' => '阈值表达式', + 'description' => '阈值表达式', + 'type' => 'string', + 'example' => '波动率类型规则使用，通过表达式来表示波动阈值。如：波动上升大于0.01： $checkValue > 0.01 波动下降大于0.01：$checkValue < -0.01 波动率绝对值：abs($checkValue) > 0.01', + ], + ], + ], + 'Warned' => [ + 'title' => '普通警告的阈值设置', + 'description' => '普通警告的阈值设置', + 'type' => 'object', + 'properties' => [ + 'Value' => [ + 'title' => '阈值数值', + 'description' => '阈值数值', + 'type' => 'string', + 'example' => '100.0', + ], + 'Operator' => [ + 'title' => '比较符', + 'description' => '比较符'."\n" + .'- />'."\n" + .'- />='."\n" + .'- <'."\n" + .'- <='."\n" + .'- !='."\n" + .'- =', + 'type' => 'string', + 'example' => '>', + ], + 'Expression' => [ + 'title' => '阈值表达式', + 'description' => '阈值表达式', + 'type' => 'string', + 'example' => '波动率类型规则使用，通过表达式来表示波动阈值。如：波动上升大于0.01： $checkValue > 0.01 波动下降大于0.01：$checkValue < -0.01 波动率绝对值：abs($checkValue) > 0.01', + ], + ], + ], + 'Critical' => [ + 'title' => '严重警告的阈值设置', + 'description' => '严重警告的阈值设置', + 'type' => 'object', + 'properties' => [ + 'Value' => [ + 'title' => '阈值数值', + 'description' => '阈值数值', + 'type' => 'string', + 'example' => '100.0', + ], + 'Operator' => [ + 'title' => '比较符', + 'description' => '比较符'."\n" + .'- />'."\n" + .'- />='."\n" + .'- <'."\n" + .'- <='."\n" + .'- !='."\n" + .'- =', + 'type' => 'string', + 'example' => '>', + ], + 'Expression' => [ + 'title' => '校验表达式', + 'description' => '校验表达式', + 'type' => 'string', + 'example' => '波动率类型规则使用，通过表达式来表示波动阈值。如：波动上升大于0.01： $checkValue > 0.01 波动下降大于0.01：$checkValue < -0.01 波动率绝对值：abs($checkValue) > 0.01', + ], + ], + ], + ], + ], + ], + ], + 'ErrorHandlers' => [ + 'title' => '质量规则校验问题处理器', + 'description' => '质量规则校验问题处理器', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'title' => '处理器类型', + 'description' => '处理器类型：'."\n" + ."\n" + .'- SaveErrorData', + 'type' => 'string', + 'example' => 'SaveErrorData', + ], + 'ErrorDataFilter' => [ + 'title' => '如果是自定义SQL规则，需要用户指定SQL来过滤问题数据', + 'description' => '如果是自定义SQL规则，需要用户指定SQL来过滤问题数据', + 'type' => 'string', + 'example' => 'SELECT * FROM tb_api_log WHERE id IS NULL', + ], + ], + ], + ], + ], + ], + 'DataQualityRuleTemplate' => [ + 'title' => '质量规则模版', + 'description' => '质量规则模版', + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'title' => '规则模板Code，全局唯一标识', + 'type' => 'string', + ], + 'Name' => [ + 'title' => '规则模板名称', + 'type' => 'string', + ], + 'TenantId' => [ + 'title' => 'DataWorks租户ID', + 'type' => 'integer', + 'format' => 'int64', + ], + 'ProjectId' => [ + 'title' => 'DataWorks工作空间ID', + 'type' => 'integer', + 'format' => 'int64', + ], + 'SamplingConfig' => [ + 'title' => '样本采集设置', + 'type' => 'object', + 'properties' => [ + 'Metric' => [ + 'title' => '采样的指标名称', + 'type' => 'string', + 'example' => 'Min', + ], + 'MetricParameters' => [ + 'title' => '样本采集时，所需的参数', + 'type' => 'string', + 'example' => '{ "SQL": "SELECT min(id) from table;" }', + ], + 'SettingConfig' => [ + 'title' => '具体执行采样语句前，插入执行的一些运行时参数设置语句，最长1000个字符。目前只支持MaxCompute', + 'type' => 'string', + 'example' => 'SET odps.sql.udf.timeout=600s;', + ], + ], + ], + 'CheckingConfig' => [ + 'title' => '样本校验设置', + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'title' => '阈值计算方式', + 'type' => 'string', + 'example' => 'Fixed', + ], + 'ReferencedSamplesFilter' => [ + 'title' => '有些类型的阈值需要查询出一些参考样本，然后对参考样本的值进行汇总得出进行比较的阈值，这里使用一个表达式来表示参考样本的查询方式', + 'type' => 'string', + 'example' => '{ "bizdate": [ "-1", "-7", "-1m" ] }', + ], + ], + ], + 'VisibleScope' => [ + 'title' => '模板的可用范围', + 'type' => 'string', + 'example' => 'Project', + ], + 'DirectoryPath' => [ + 'title' => '自定义模板被存放的类目目录，斜线分隔层级', + 'type' => 'string', + 'example' => '/ods/订单数据', + ], + ], + ], + 'Database' => [ + 'title' => '数据库', + 'description' => '数据库', + 'type' => 'object', + 'properties' => [ + 'Id' => [ + 'title' => 'ID', + 'description' => '数据库实体ID，可参考[元数据实体相关概念说明](~~2880092~~)。'."\n" + ."\n" + .'格式为`${EntityType}:${实例ID或转义后的URL}:${数据目录标识}:${数据库名称}`，对于不存在的层级使用空字符占位'."\n" + ."\n" + .'> starrocks类型的数据目录标识为目录名称，dlf类型的数据目录标识为目录ID, 其他类型不支持目录层级，可用空字符占位。'."\n" + ."\n" + .'几种常用类型的ID格式参考如下'."\n" + ."\n" + .'`dlf-database::catalog_id:database_name`'."\n" + ."\n" + .'`holo-database:instance_id::database_name`'."\n" + ."\n" + .'`mysql-database:(instance_id|encoded_jdbc_url)::database_name`'."\n" + .' '."\n" + .'> 其中 '."\n" + .'`catalog_id`: dlf目录id '."\n" + .'`instance_id`: 实例ID，对应数据源以实例模式注册时需要提供 '."\n" + .'`encoded_jdbc_url`: JDBC连接串的URLEncode编码,对应数据源以连接串方式注册时需要提供 '."\n" + .'`database_name`: 数据库名称', + 'type' => 'string', + 'example' => 'dlf-database::catalog_id:database_name', + ], + 'Name' => [ + 'title' => '名称', + 'description' => '名称', + 'type' => 'string', + 'example' => 'database_name', + ], + 'Comment' => [ + 'title' => '注释', + 'description' => '注释', + 'type' => 'string', + 'example' => 'test comment', + ], + 'LocationUri' => [ + 'title' => '存储位置URI', + 'description' => '存储位置URI', + 'type' => 'string', + 'example' => 'oss://test-bucket/test_db', + ], + 'ParentMetaEntityId' => [ + 'title' => '父层级元数据实体ID', + 'description' => '父层级实体ID，可参考[元数据实体相关概念说明](~~2880092~~)。'."\n" + ."\n" + .'父层级实体类型参考ListCrawlerTypes接口'."\n" + ."\n" + .'- 若父层级实体为数据目录，`ParentMetaEntityId`格式参考`Catalog`对象'."\n" + .'- 如果父层级实体为元数据采集器，`ParentMetaEntityId`格式为`${CrawlerType}:${实例ID或转义后的URL}`'."\n" + ."\n" + .'几种常用类型的ParentMetaEntityId格式参考如下'."\n" + ."\n" + .'`dlf-catalog::catalog_id`'."\n" + ."\n" + .'`holo:instance_id`'."\n" + ."\n" + .'`mysql:(instance_id|encoded_jdbc_url)`'."\n" + ."\n" + .'> 其中 '."\n" + .'`catalog_id`: dlf目录id '."\n" + .'`instance_id`: 实例ID，对应数据源以实例模式注册时需要提供 '."\n" + .'`encoded_jdbc_url`: JDBC连接串的URLEncode编码,对应数据源以连接串方式注册时需要提供', + 'type' => 'string', + 'example' => 'dlf-catalog::catalog_id', + ], + 'CreateTime' => [ + 'title' => '创建时间（毫秒级时间戳）', + 'description' => '创建时间（毫秒级时间戳）', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1736852168000', + ], + 'ModifyTime' => [ + 'title' => '更新时间（毫秒级时间戳）', + 'description' => '更新时间（毫秒级时间戳）', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1736852168000', + ], + ], + ], + 'Dataset' => [ + 'title' => '数据集对象', + 'description' => '数据集对象', + 'type' => 'object', + 'properties' => [ + 'Id' => [ + 'title' => '数据集ID', + 'description' => '数据集ID', + 'type' => 'string', + 'example' => 'dataworks-dataset:1gxxxqjx155usz3hrv', + ], + 'Name' => [ + 'title' => '数据集名称，非空字符串，长度小于128', + 'description' => '数据集名称，非空字符串，长度小于128', + 'type' => 'string', + 'example' => 'test_dataset', + ], + 'Comment' => [ + 'title' => '数据集描述，长度小于1024', + 'description' => '数据集描述，长度小于1024', + 'type' => 'string', + 'example' => '测试数据集', + ], + 'ProjectId' => [ + 'title' => 'DataWorks工作空间ID', + 'description' => 'DataWorks工作空间ID', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '123456', + ], + 'Origin' => [ + 'title' => '数据集来源，当前支持'."\n" + .'- DataWorks'."\n" + .'- PAI', + 'description' => '数据集来源，当前支持'."\n" + .'- DataWorks'."\n" + .'- PAI', + 'type' => 'string', + 'example' => 'DataWorks', + ], + 'DataType' => [ + 'title' => '数据类型，取值有'."\n" + .'- COMMON 通用'."\n" + .'- PIC 图片'."\n" + .'- TEXT 文本'."\n" + .'- TABLE 表格'."\n" + .'- VIDEO 视频'."\n" + .'- AUDIO 音频'."\n" + .'- INDEX 索引', + 'description' => '数据类型，取值有'."\n" + .'- COMMON 通用'."\n" + .'- PIC 图片'."\n" + .'- TEXT 文本'."\n" + .'- TABLE 表格'."\n" + .'- VIDEO 视频'."\n" + .'- AUDIO 音频'."\n" + .'- INDEX 索引', + 'type' => 'string', + 'enumValueTitles' => [ + 'TABLE' => '表格', + 'VIDEO' => '视频', + 'COMMON' => '通用', + 'TEXT' => '文本', + 'PIC' => '图片', + 'INDEX' => '索引', + 'AUDIO' => '音频', + ], + 'example' => 'COMMON', + ], + 'StorageType' => [ + 'title' => '存储类型，取值有'."\n" + .'- OSS 对象存储'."\n" + .'- NAS 通用型NAS文件存储'."\n" + .'- EXTREM_NAS 极速型NAS文件存储'."\n" + .'- DLF_LANCE 数据湖构建'."\n" + .'- CPFS CPFS文件存储'."\n" + .'- BMCPFS 智算CPFS文件存储'."\n" + .'- MAXCOMPUTE MaxCompute表', + 'description' => '存储类型，取值有'."\n" + .'- OSS 对象存储'."\n" + .'- NAS 通用型NAS文件存储'."\n" + .'- EXTREM_NAS 极速型NAS文件存储'."\n" + .'- DLF_LANCE 数据湖构建'."\n" + .'- CPFS CPFS文件存储'."\n" + .'- BMCPFS 智算CPFS文件存储'."\n" + .'- MAXCOMPUTE MaxCompute表', + 'type' => 'string', + 'enumValueTitles' => [ + 'NAS' => '通用型NAS文件存储', + 'MAXCOMPUTE' => 'MaxCompute表', + 'CPFS' => 'CPFS文件存储', + 'BMCPFS' => '智算CPFS文件存储', + 'EXTREMENAS' => '极速型NAS文件存储', + 'OSS' => '对象存储', + 'DLF_LANCE' => '数据湖构建', + ], + 'example' => 'OSS', + ], + 'CreatorId' => [ + 'title' => '创建者ID', + 'description' => '创建者ID', + 'type' => 'string', + 'example' => '210484359', + ], + 'Readme' => [ + 'title' => '数据集使用说明，支持markdown富文本', + 'description' => '数据集使用说明，支持markdown富文本', + 'type' => 'string', + 'example' => '## introduction', + ], + 'LatestVersion' => [ + 'title' => '最新数据集版本对象', + 'description' => '最新数据集版本对象', + '$ref' => '#/components/schemas/DatasetVersion', + ], + 'CreateTime' => [ + 'title' => '创建时间毫秒级时间戳', + 'description' => '创建时间毫秒级时间戳', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1736756055000', + ], + 'ModifyTime' => [ + 'title' => '修改时间毫秒级时间戳', + 'description' => '修改时间毫秒级时间戳', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1736756055000', + ], + 'Labels' => [ + 'title' => '数据集标签，目前仅PAI数据集支持', + 'description' => '数据集标签，目前仅PAI数据集支持', + 'type' => 'array', + 'items' => [ + 'description' => 'PAI数据集标签对象', + '$ref' => '#/components/schemas/DatasetLabel', + ], + ], + ], + ], + 'DatasetLabel' => [ + 'title' => 'PAI数据集标签', + 'description' => 'PAI数据集标签', + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'title' => '数据集标签键', + 'description' => '数据集标签键', + 'type' => 'string', + 'example' => 'key1', + ], + 'Value' => [ + 'title' => '数据集标签值', + 'description' => '数据集标签值', + 'type' => 'string', + 'example' => 'value1', + ], + ], + ], + 'DatasetVersion' => [ + 'title' => '数据集版本对象', + 'description' => '数据集版本对象', + 'type' => 'object', + 'properties' => [ + 'Id' => [ + 'title' => '数据集版本ID', + 'description' => '数据集版本ID', + 'type' => 'string', + 'example' => 'dataworks-datasetVersion:0gfxxxjx155usz3hrv:1', + ], + 'DatasetId' => [ + 'title' => '对应数据集ID', + 'description' => '对应数据集ID', + 'type' => 'string', + 'example' => 'dataworks-datasetVersion:0gfxxxjx155usz3hrv', + ], + 'Comment' => [ + 'title' => '版本使用说明', + 'description' => '数据集版本描述', + 'type' => 'string', + 'example' => '初始版本', + ], + 'CreatorId' => [ + 'title' => '创建者ID', + 'description' => '创建者ID', + 'type' => 'string', + 'example' => '17815XXX61016173', + ], + 'VersionNumber' => [ + 'title' => '数据集版本号', + 'description' => '数据集版本号', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'StorageType' => [ + 'title' => '存储类型，只读，与所属数据集对应属性保持一致', + 'description' => '存储类型，只读，与所属数据集对应属性保持一致', + 'type' => 'string', + 'example' => 'OSS', + ], + 'Url' => [ + 'title' => 'URL地址', + 'description' => 'URL地址', + 'type' => 'string', + 'example' => 'oss://test-oss-bucket/test_dir/', + ], + 'MountPath' => [ + 'title' => '挂载路径，默认为 /mnt/data', + 'description' => '挂载路径，默认为 /mnt/data', + 'type' => 'string', + 'example' => '/mnt/data', + ], + 'CreateTime' => [ + 'title' => '创建时间毫秒级时间戳', + 'description' => '创建时间毫秒级时间戳', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1736756055000', + ], + 'ModifyTime' => [ + 'title' => '修改时间毫秒级时间戳', + 'description' => '修改时间毫秒级时间戳', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1736756055000', + ], + 'Labels' => [ + 'title' => 'PAI数据集标签', + 'description' => 'PAI数据集标签', + 'type' => 'array', + 'items' => [ + 'description' => 'PAI数据集标签', + '$ref' => '#/components/schemas/DatasetLabel', + ], + ], + 'ImportInfo' => [ + 'title' => '数据集的存储导入配置'."\n" + .'对于NAS类型，需要提供以下属性，取值可参考DescribeFileSystems接口的返回信息'."\n" + .'- fileSystemId 文件系统ID'."\n" + .'- fileSystemStorageType 文件系统的存储规格'."\n" + .'- vpcId 挂载点的 VPC ID', + 'description' => '数据集的存储导入配置, 对于不同存储类型，需要的配置信息不同'."\n" + .'<details>'."\n" + .'<summary>NAS</summary>'."\n" + .'取值可参考文件存储 API DescribeFileSystems 的返回信息'."\n" + ."\n" + .'```JSON'."\n" + .'{'."\n" + .' "fileSystemId": "3b6XXX89c9", // 文件系统ID'."\n" + .' "fileSystemStorageType": "Performance", // 文件系统的存储规格'."\n" + .' "vpcId": "vpc-uf66oxxxrqge1t2gson7s" // 挂载点的VPC ID'."\n" + .'}'."\n" + .'```'."\n" + ."\n" + .'</details>', + 'type' => 'object', + 'additionalProperties' => [ + 'description' => '数据集的存储导入配置信息', + 'type' => 'string', + 'example' => 'None', + ], + ], + ], + ], + 'IdentifyCredential' => [ + 'description' => '身份凭证对象', + 'type' => 'object', + 'properties' => [ + 'UserId' => [ + 'description' => '用户uid,如果是角色需要再前面添加 ROLE_ 前缀', + 'type' => 'string', + 'required' => false, + 'example' => 'ROLE_300888674340307309', + ], + 'UserType' => [ + 'description' => '- 主账号 PrimaryAccount'."\n" + .'- 子账号 SubAccount'."\n" + .'- 角色 Role', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'Role' => '角色', + 'PrimaryAccount' => '主账号', + 'SubAccount' => '子账号', + ], + 'example' => ' primaryAccount', + ], + 'ProjectId' => [ + 'description' => '空间id，非必选', + 'type' => 'string', + 'example' => '10000', + ], + 'DataSource' => [ + 'description' => '数据源', + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'description' => '数据源类型，支持的类型'."\n" + .'- hive'."\n" + .'- lindorm_for_engine'."\n" + .'- starrocks', + 'type' => 'string', + 'required' => false, + 'example' => 'hologres', + ], + 'Role' => [ + 'description' => '数据源用户类型'."\n" + .'- Admin'."\n" + .'- RegularUser', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'RegularUser' => '普通用户', + 'Admin' => '管理员', + ], + 'example' => 'admin', + ], + 'UserName' => [ + 'description' => '数据源用户名', + 'type' => 'string', + 'required' => false, + 'example' => 'tom', + ], + 'Password' => [ + 'description' => '数据源密码', + 'type' => 'string', + 'required' => false, + 'example' => '***', + ], + 'InstanceId' => [ + 'description' => '数据源实例id', + 'type' => 'string', + 'required' => false, + 'example' => '710007423244', + ], + 'InstanceName' => [ + 'description' => '数据源实例名称', + 'type' => 'string', + 'required' => false, + 'example' => 'rm-2zez82ho69yex7s7g', + ], + ], + ], + ], + ], + 'LineageEntity' => [ + 'title' => '血缘实体', + 'description' => '血缘实体', + 'type' => 'object', + 'properties' => [ + 'Id' => [ + 'title' => '实体ID', + 'description' => '实体ID', + 'type' => 'string', + 'example' => 'maxcompute-table:::project_name:[schema_name]:table_name', + ], + 'Name' => [ + 'title' => '名称', + 'description' => '名称', + 'type' => 'string', + 'example' => 'test_tbl', + ], + 'Attributes' => [ + 'title' => '其他属性', + 'description' => '其他属性', + 'type' => 'object', + 'additionalProperties' => [ + 'description' => '属性', + 'type' => 'string', + 'example' => 'value', + ], + 'example' => '{"key1":"value1"}', + ], + ], + ], + 'LineageRelationship' => [ + 'title' => '血缘关系', + 'description' => '血缘关系', + 'type' => 'object', + 'properties' => [ + 'SrcEntity' => [ + 'title' => '源实体', + 'description' => '源实体', + '$ref' => '#/components/schemas/LineageEntity', + ], + 'DstEntity' => [ + 'title' => '目标实体', + 'description' => '目标实体', + '$ref' => '#/components/schemas/LineageEntity', + ], + 'Task' => [ + 'title' => '任务', + 'description' => '任务', + '$ref' => '#/components/schemas/LineageTask', + ], + 'Id' => [ + 'title' => 'ID', + 'description' => 'ID', + 'type' => 'string', + 'example' => 'as78d756asd', + ], + 'CreateTime' => [ + 'title' => '创建时间', + 'description' => '创建时间', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1743040581000', + ], + ], + ], + 'LineageTask' => [ + 'title' => '任务信息', + 'description' => '任务信息', + 'type' => 'object', + 'properties' => [ + 'Id' => [ + 'title' => '任务ID', + 'description' => '任务ID', + 'type' => 'string', + 'example' => '12345', + ], + 'Type' => [ + 'title' => '任务类型', + 'description' => '任务类型', + 'type' => 'string', + 'example' => 'custom-sql', + ], + 'Attributes' => [ + 'title' => '任务属性', + 'description' => '任务属性', + 'type' => 'object', + 'additionalProperties' => [ + 'description' => '属性', + 'type' => 'string', + 'example' => 'value', + ], + ], + ], + ], + 'Partition' => [ + 'title' => '数据表的分区对象', + 'description' => '数据表的分区对象', + 'type' => 'object', + 'properties' => [ + 'TableId' => [ + 'title' => '所属数据表的资源标识', + 'description' => '所属数据表ID，可参考`Table`对象。', + 'type' => 'string', + 'example' => 'maxcompute-table:::project_name:[schema_name]:table_name', + ], + 'Name' => [ + 'title' => '名称', + 'description' => '名称', + 'type' => 'string', + 'example' => 'ds=20250101', + ], + 'CreateTime' => [ + 'title' => '创建时间（毫秒级时间戳）', + 'description' => '创建时间（毫秒级时间戳）', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1700192563000', + ], + 'ModifyTime' => [ + 'title' => '修改时间（毫秒级时间戳）', + 'description' => '修改时间（毫秒级时间戳）', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1700192563000', + ], + 'RecordCount' => [ + 'title' => '分区记录数', + 'description' => '分区记录数', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1000000', + ], + 'DataSize' => [ + 'title' => '分区存储量，单位：字节', + 'description' => '分区存储量，单位：字节', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '4096', + ], + ], + ], + 'Schema' => [ + 'title' => '模式', + 'description' => '模式。', + 'type' => 'object', + 'properties' => [ + 'Id' => [ + 'title' => 'ID', + 'description' => '模式ID，可参考[元数据实体相关概念说明](~~2880092~~)。'."\n" + ."\n" + .'格式为`${EntityType}:${实例ID或转义后的URL}:${数据目录标识}:${数据库名称}:${模式名称}`，对于不存在的层级使用空字符占位'."\n" + ."\n" + .'> 对于maxcompute类型，实例ID层级使用空字符占位，数据库名称为maxcompute项目名称，且要求该项目已开启三层模型。'."\n" + ."\n" + .'几种常用类型的ID格式参考如下'."\n" + ."\n" + .'`maxcompute-schema:::project_name:schema_name` （要求该项目已开启三层模型）'."\n" + ."\n" + .'`holo-schema:instance_id::database_name:schema_name`'."\n" + ."\n" + .'> 其中 '."\n" + .'`instance_id`: holo实例ID '."\n" + .'`database_name`: 数据库名称 '."\n" + .'`project_name`: maxcompute项目名 '."\n" + .'`schema_name`: schema名称', + 'type' => 'string', + 'example' => 'maxcompute-schema:::project_name:schema_name', + ], + 'Name' => [ + 'title' => '名称', + 'description' => '名称。', + 'type' => 'string', + 'example' => 'schema_name', + ], + 'Comment' => [ + 'title' => '注释', + 'description' => '注释。', + 'type' => 'string', + 'example' => 'test comment', + ], + 'Type' => [ + 'title' => '类型', + 'description' => '类型。', + 'type' => 'string', + 'example' => 'MANAGED', + ], + 'ParentMetaEntityId' => [ + 'title' => '父层级元数据实体ID', + 'description' => '父层级实体ID，可参考[元数据实体相关概念说明](~~2880092~~)。'."\n" + ."\n" + .'格式为`${EntityType}:${实例ID或转义后的URL}:${数据目录标识}:${数据库名称}`，对于不存在的层级使用空字符占位。'."\n" + ."\n" + .'> 对于maxcompute类型，实例id层级使用空字符占位，数据库名称为maxcompute项目名称，要求该项目已开启三层模型。'."\n" + ."\n" + .'几种常用类型的ParentMetaEntityId格式参考如下'."\n" + ."\n" + .'`maxcompute-project:::project_name` （要求该项目已开启三层模型）'."\n" + ."\n" + .'`holo-database:instance_id::database_name`'."\n" + ."\n" + .'> 其中 '."\n" + .'`instance_id`: holo实例ID '."\n" + .'`database_name`: 数据库名称 '."\n" + .'`project_name`: maxcompute项目名', + 'type' => 'string', + 'example' => 'maxcompute-project:::project_name', + ], + 'CreateTime' => [ + 'title' => '创建时间（毫秒级时间戳）', + 'description' => '创建时间（毫秒级时间戳），目前仅MaxCompute类型支持该字段。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1736852168000', + ], + 'ModifyTime' => [ + 'title' => '更新时间（毫秒级时间戳）', + 'description' => '更新时间（毫秒级时间戳），目前仅MaxCompute类型支持该字段。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1736852168000', + ], + ], + ], + 'Table' => [ + 'title' => '数据表对象', + 'description' => '数据表对象。', + 'type' => 'object', + 'properties' => [ + 'Id' => [ + 'title' => 'ID', + 'description' => 'ID，可参考[元数据实体相关概念说明](~~2880092~~)。'."\n" + ."\n" + .'格式为`${EntityType}:${实例ID或转义后的URL}:${数据目录标识}:${数据库名称}:${模式名称}:${数据表名称}`，对于不存在的层级使用空字符占位'."\n" + ."\n" + .'> 对于maxcompute和dlf类型，实例ID使用空字符占位。对于maxcompute类型，数据库名称即为maxcompute项目名称，开启三层模型的项目需要提供模式名称，未开启的项目模式名称处使用空字符占位。'."\n" + ."\n" + .'> starrocks类型的数据目录标识为目录名称，dlf类型的数据目录标识为目录ID, 其他类型不支持目录层级，可用空字符占位。 '."\n" + ."\n" + .'几种常用类型的ID格式如下 '."\n" + ."\n" + .'`maxcompute-table:::project_name:[schema_name]:table_name`'."\n" + ."\n" + .'`dlf-table::catalog_id:database_name::table_name`'."\n" + ."\n" + .'`hms-table:instance_id::database_name::table_name`'."\n" + ."\n" + .'`holo-table:instance_id::database_name:schema_name:table_name`'."\n" + ."\n" + .'`mysql-table:(instance_id|encoded_jdbc_url)::database_name::table_name`'."\n" + .'> 其中 '."\n" + .'`instance_id`: 实例ID，对应数据源以实例模式注册时需要提供 '."\n" + .'`encoded_jdbc_url`: JDBC连接串的URLEncode编码,对应数据源以连接串方式注册时需要提供 '."\n" + .'`catalog_id`: dlf目录ID '."\n" + .'`project_name`: maxcompute项目名称 '."\n" + .'`database_name`: 数据库名称 '."\n" + .'`schema_name`: schema名称，对于maxcompute类型，仅所属项目开启三层模型后需要提供。若未开启则使用空字符占位 '."\n" + .'`table_name`: 表名称', + 'type' => 'string', + 'example' => 'dlf-table::catalog_id:database_name::table_name', + ], + 'Name' => [ + 'title' => '名称', + 'description' => '名称。', + 'type' => 'string', + 'example' => 'table_name', + ], + 'Comment' => [ + 'title' => '注释', + 'description' => '注释。', + 'type' => 'string', + 'example' => '测试表', + ], + 'TableType' => [ + 'title' => '表类型', + 'description' => '表类型，取值与元数据采集器类型相关。', + 'type' => 'string', + 'example' => 'TABLE', + ], + 'PartitionKeys' => [ + 'title' => '分区键', + 'description' => '分区键列表，非分区表时为空。', + 'type' => 'array', + 'items' => [ + 'description' => '分区键。', + 'type' => 'string', + 'example' => 'ds', + ], + ], + 'ParentMetaEntityId' => [ + 'title' => '父层级元数据实体ID', + 'description' => '父层级元数据实体ID，可参考[元数据实体相关概念说明](~~2880092~~)。'."\n" + ."\n" + .'- 对于支持schema的类型（`maxcompute/holo/postgresql/sqlserver/hybriddb_for_postgresql/oracle， 其中maxcompute类型需要所属项目开启三层模型)`, `ParentMetaEntityId`为表所属数据库模式，格式为`${EntityType}:${实例ID或转义后的URL}:${数据目录标识}:${数据库名称}:${模式名称}`，对于不存在的层级空字符占位'."\n" + ."\n" + .'- 其他类型时，`ParentMetaEntityId`为表所属数据库，格式为`${EntityType}:${实例ID或转义后的URL}:${数据目录标识}:${数据库名称}`，对于不存在的层级空字符占位。'."\n" + ."\n" + .'> 对于maxcompute和dlf类型，实例ID使用空字符占位。对于maxcompute类型，数据库名称即为maxcompute项目名称。'."\n" + ."\n" + .'> starrocks类型的数据目录标识为目录名称，dlf类型的数据目录标识为目录ID, 其他类型不支持目录层级，可用空字符占位。'."\n" + ."\n" + .'几种常用类型的ParentMetaEntityId格式参考如下'."\n" + .' '."\n" + .'`maxcompute-project:::project_name`'."\n" + ."\n" + .'`maxcompute-schema:::project_name:schema_name` (仅项目开启三层模型时)'."\n" + ."\n" + .'`dlf-database::catalog_id:database_name`'."\n" + ."\n" + .'`hms-database:instance_id::database_name`'."\n" + ."\n" + .'`holo-schema:instance_id::database_name:schema_name`'."\n" + ."\n" + .'`mysql-database:(instance_id|encoded_jdbc_url)::database_name`'."\n" + ."\n" + .'> 其中 '."\n" + .'`instance_id`: 实例ID，对应数据源以实例模式注册时需要提供 '."\n" + .'`encoded_jdbc_url`: JDBC连接串的URLEncode编码,对应数据源以连接串方式注册时需要提供 '."\n" + .'`catalog_id`: dlf目录ID '."\n" + .'`project_name`: maxcompute项目名称 '."\n" + .'`database_name`: 数据库名称 '."\n" + .'`schema_name`: schema名称', + 'type' => 'string', + 'example' => 'dlf-database::catalog_id:database_name', + ], + 'CreateTime' => [ + 'title' => '创建时间（毫秒级时间戳）', + 'description' => '创建时间（毫秒级时间戳）。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1736852168000', + ], + 'ModifyTime' => [ + 'title' => '修改时间（毫秒级时间戳）', + 'description' => '修改时间（毫秒级时间戳）。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1736852168000', + ], + 'TechnicalMetadata' => [ + 'title' => '技术元数据', + 'description' => '技术元数据。', + 'type' => 'object', + 'properties' => [ + 'Owner' => [ + 'title' => '负责人', + 'description' => '负责人。', + 'type' => 'string', + 'example' => 'test_user', + ], + 'Location' => [ + 'title' => '存储位置', + 'description' => '存储位置。', + 'type' => 'string', + 'example' => 'oss://test-bucket/test_tbl', + ], + 'Compressed' => [ + 'title' => '是否为压缩表', + 'description' => '是否为压缩表。', + 'type' => 'boolean', + 'example' => 'false', + ], + 'InputFormat' => [ + 'title' => '输入格式', + 'description' => '输入格式。', + 'type' => 'string', + 'example' => 'org.apache.hadoop.hive.ql.io.parquet.MapredParquetInputFormat', + ], + 'OutputFormat' => [ + 'title' => '输出格式', + 'description' => '输出格式。', + 'type' => 'string', + 'example' => 'org.apache.hadoop.hive.ql.io.parquet.MapredParquetOutputFormat', + ], + 'SerializationLibrary' => [ + 'title' => 'SerDe使用的类', + 'description' => 'SerDe使用的类。', + 'type' => 'string', + 'example' => 'org.apache.hadoop.hive.ql.io.parquet.serde.ParquetHiveSerDe', + ], + 'Parameters' => [ + 'title' => '参数信息', + 'description' => '参数信息。', + 'type' => 'object', + 'additionalProperties' => [ + 'description' => '参数信息。', + 'type' => 'string', + 'example' => 'value', + ], + ], + ], + ], + 'BusinessMetadata' => [ + 'title' => '业务元数据', + 'description' => '业务元数据，DataWorks相关，包含使用说明，标签，类目，上游产出任务以及扩展信息。', + 'type' => 'object', + 'properties' => [ + 'Readme' => [ + 'title' => '使用说明', + 'description' => '使用说明。', + 'type' => 'string', + 'example' => '## 使用说明', + ], + 'Tags' => [ + 'title' => '标签列表', + 'description' => '标签列表。', + 'type' => 'array', + 'items' => [ + 'description' => '标签信息。', + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'title' => '标签键，非空', + 'description' => '标签键，非空。', + 'type' => 'string', + 'example' => 'tag_key', + ], + 'Value' => [ + 'title' => '标签值，可为空', + 'description' => '标签值，可为空。', + 'type' => 'string', + 'example' => 'tag_value', + ], + ], + ], + ], + 'Categories' => [ + 'title' => '所属类目列表', + 'description' => '所属类目列表。', + 'type' => 'array', + 'items' => [ + 'description' => '单一类目的层级列表（多级类目）。', + 'type' => 'array', + 'items' => [ + 'description' => '类目信息。', + 'type' => 'object', + 'properties' => [ + 'Id' => [ + 'title' => 'ID', + 'description' => '类目ID。', + 'type' => 'string', + 'example' => 'CATEGORY.456', + ], + 'Name' => [ + 'title' => '名称', + 'description' => '名称。', + 'type' => 'string', + 'example' => '测试类目', + ], + 'ParentId' => [ + 'title' => '父类目ID', + 'description' => '父类目ID，可为空。', + 'type' => 'string', + 'example' => 'CATEGORY.123', + ], + ], + ], + ], + ], + 'UpstreamTasks' => [ + 'title' => '上游产出任务列表', + 'description' => '上游产出任务列表。', + 'type' => 'array', + 'items' => [ + 'description' => '上游产出任务。', + 'type' => 'object', + 'properties' => [ + 'Id' => [ + 'title' => '任务ID', + 'description' => '任务ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '123456', + ], + 'Name' => [ + 'title' => '任务名称', + 'description' => '任务名称。', + 'type' => 'string', + 'example' => 'test_task', + ], + ], + ], + ], + 'Extension' => [ + 'title' => '扩展信息，目前仅MaxCompute类型支持', + 'description' => '扩展信息，目前仅MaxCompute类型支持。', + 'type' => 'object', + 'properties' => [ + 'ProjectId' => [ + 'title' => '工作空间ID', + 'description' => '工作空间ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '234', + ], + 'EnvType' => [ + 'title' => '环境类型', + 'description' => '环境类型，枚举值，取值范围'."\n" + ."\n" + .'- Prod：生产环境。'."\n" + .'- Dev：开发环境。', + 'type' => 'string', + 'enumValueTitles' => [], + 'example' => 'Dev', + 'enum' => [ + 'Dev', + 'Prod', + ], + ], + 'ViewCount' => [ + 'title' => '浏览次数', + 'description' => '浏览次数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'ReadCount' => [ + 'title' => '读取次数', + 'description' => '读取次数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'FavorCount' => [ + 'title' => '收藏次数', + 'description' => '收藏次数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'apis' => [ + 'ImportCertificate' => [ + 'summary' => '导入认证文件。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '250619', + 'abilityTreeNodes' => [ + 'FEATUREdideRWC5F7', + ], + ], + 'parameters' => [ + [ + 'name' => 'ProjectId', + 'in' => 'query', + 'schema' => [ + 'description' => '证书文件所属项目ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '106560', + ], + ], + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => [ + 'description' => '证书文件名称。'."\n" + .'在一个项目空间中，'."\n" + .'证书文件名称不允许重复。', + 'type' => 'string', + 'required' => true, + 'example' => 'ca1.crt', + ], + ], + [ + 'name' => 'CertificateFile', + 'in' => 'query', + 'schema' => [ + 'description' => '需要上传的认证文件，'."\n" + .'上传方式：通过构造InputStream上传文件。', + 'type' => 'string', + 'required' => true, + 'example' => '-', + 'isFileTransferUrl' => true, + ], + ], + [ + 'name' => 'Description', + 'in' => 'query', + 'schema' => [ + 'description' => '描述信息。', + 'type' => 'string', + 'required' => false, + 'example' => 'This is a file', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'Id' => [ + 'title' => '证书文件ID，即证书文件的唯一标识符。', + 'description' => '证书文件ID，'."\n" + .'即证书文件的唯一标识符。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '676303114031776', + ], + 'RequestId' => [ + 'description' => '请求的ID，用于定位日志，排查问题。', + 'type' => 'string', + 'example' => '7C352CB7-CD88-50CF-9D0D-E81BDF020E7F', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Id\\": 676303114031776,\\n \\"RequestId\\": \\"7C352CB7-CD88-50CF-9D0D-E81BDF020E7F\\"\\n}","type":"json"}]', + 'title' => '导入认证文件', + 'description' => '1. 需要购买DataWorks基础版及以上版本才能使用。'."\n" + .'2. 需要在DataWorks项目空间中具有如下至少一种角色： 租户所有者、空间管理员、项目所有者、运维', + ], + 'GetCertificate' => [ + 'summary' => '查看认证文件。', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '250938', + 'abilityTreeNodes' => [ + 'FEATUREdideRWC5F7', + ], + ], + 'parameters' => [ + [ + 'name' => 'Id', + 'in' => 'query', + 'schema' => [ + 'title' => '证书文件ID，即证书文件的唯一标识符。', + 'description' => '证书文件ID，即证书文件的唯一标识符。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '676303114031776', + ], + ], + [ + 'name' => 'ProjectId', + 'in' => 'query', + 'schema' => [ + 'description' => '证书文件所属项目ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1065601', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。用于定位日志，排查问题。', + 'type' => 'string', + 'example' => '0000-ABCD-EFG****', + ], + 'Certificate' => [ + 'description' => '证书详情。', + 'type' => 'object', + 'properties' => [ + 'Id' => [ + 'title' => '证书文件ID，即证书文件的唯一标识符。', + 'description' => '证书文件ID，即证书文件的唯一标识符。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '676303114031776', + ], + 'Name' => [ + 'title' => '文件名称', + 'description' => '文件名称', + 'type' => 'string', + 'example' => 'ca1.crt', + ], + 'ProjectId' => [ + 'title' => '证书文件所属项目ID。', + 'description' => '证书文件所属项目ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '177161', + ], + 'Description' => [ + 'title' => '描述信息', + 'description' => '描述信息', + 'type' => 'string', + 'example' => 'This is a file', + ], + 'CreateUser' => [ + 'title' => '认证文件的创建者ID', + 'description' => '认证文件的创建者ID', + 'type' => 'string', + 'example' => '1107550004253538', + ], + 'CreateTime' => [ + 'title' => '创建时间（时间戳，单位：毫秒）', + 'description' => '创建时间（时间戳，单位：毫秒）', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1730217600000', + ], + 'FileSizeInBytes' => [ + 'title' => '文件的字节大小', + 'description' => '文件的字节大小', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '77549', + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0000-ABCD-EFG****\\",\\n \\"Certificate\\": {\\n \\"Id\\": 676303114031776,\\n \\"Name\\": \\"ca1.crt\\",\\n \\"ProjectId\\": 177161,\\n \\"Description\\": \\"This is a file\\",\\n \\"CreateUser\\": \\"1107550004253538\\",\\n \\"CreateTime\\": 1730217600000,\\n \\"FileSizeInBytes\\": 77549\\n }\\n}","type":"json"}]', + 'title' => '查看认证文件', + 'description' => '1. 需要购买DataWorks基础版及以上版本才能使用。'."\n" + .'2. 需要在DataWorks项目空间中具有如下至少一种角色： 租户所有者、空间管理员、部署、开发、项目所有者、运维', + ], + 'ListCertificates' => [ + 'summary' => '查询认证文件列表。', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '250939', + 'abilityTreeNodes' => [ + 'FEATUREdideRWC5F7', + ], + ], + 'parameters' => [ + [ + 'name' => 'ProjectId', + 'in' => 'query', + 'schema' => [ + 'title' => '证书文件所属项目ID。', + 'description' => '证书文件所属项目ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '10000', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'title' => '分页大小，默认值为10，最大值100', + 'description' => '分页大小，默认值为10，最大值100', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'title' => '查询第几页，默认值为1表示第一页', + 'description' => '查询第几页，默认值为1表示第一页', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => [ + 'title' => '文件名称，基于此名称做模糊查询', + 'description' => '文件名称，基于此名称做模糊查询', + 'type' => 'string', + 'required' => false, + 'example' => 'xm_create_test', + ], + ], + [ + 'name' => 'CreateUser', + 'in' => 'query', + 'schema' => [ + 'title' => '查询某个创建者ID所创建的文件列表', + 'description' => '查询某个创建者ID所创建的文件列表', + 'type' => 'string', + 'required' => false, + 'example' => '1107550004253538', + ], + ], + [ + 'name' => 'StartCreateTime', + 'in' => 'query', + 'schema' => [ + 'title' => '查询创建时间在该日期之后的文件。'."\n" + .'单位：毫秒', + 'description' => '查询创建时间在该日期之后的文件。'."\n" + .'单位：毫秒', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1730217600000', + ], + ], + [ + 'name' => 'EndCreateTime', + 'in' => 'query', + 'schema' => [ + 'title' => '查询创建时间在该日期之前的文件。'."\n" + .'单位：毫秒', + 'description' => '查询创建时间在该日期之前的文件。'."\n" + .'单位：毫秒', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1593877765000', + ], + ], + [ + 'name' => 'SortBy', + 'in' => 'query', + 'schema' => [ + 'title' => '认证文件列表排序字段，支持名称、创建时间、文件ID排序'."\n" + .'● CreateTime'."\n" + .'● Id'."\n" + .'● Name'."\n" + .'默认值：Id', + 'description' => '认证文件列表排序字段，支持名称、创建时间、文件ID排序'."\n" + .'- CreateTime'."\n" + .'- Id'."\n" + .'- Name'."\n" + ."\n" + .'默认值：Id', + 'type' => 'string', + 'required' => false, + 'example' => 'Id', + ], + ], + [ + 'name' => 'Order', + 'in' => 'query', + 'schema' => [ + 'title' => '认证文件列表排序方向，枚举值：'."\n" + .'● Desc表示倒序'."\n" + .'● Asc表示正序'."\n" + .'默认值：Asc', + 'description' => '认证文件列表排序方向，枚举值：'."\n" + .'● Desc表示倒序'."\n" + .'● Asc表示正序'."\n" + .'默认值：Asc', + 'type' => 'string', + 'required' => false, + 'example' => 'Asc', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID，一次请求的唯一标识。', + 'type' => 'string', + 'example' => 'ecb967ec-c137-48****', + ], + 'PagingInfo' => [ + 'description' => '分页信息', + 'type' => 'object', + 'properties' => [ + 'PageSize' => [ + 'description' => '每页显示的条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'TotalCount' => [ + 'description' => '总条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '100', + ], + 'PageNumber' => [ + 'description' => '页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Certificates' => [ + 'title' => '认证文件列表', + 'description' => '认证文件列表', + 'type' => 'array', + 'items' => [ + 'description' => '证书列表信息。', + 'type' => 'object', + 'properties' => [ + 'Id' => [ + 'description' => '认证文件ID，即认证文件的唯一标识符', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '676303114031776', + ], + 'Name' => [ + 'description' => '文件名', + 'type' => 'string', + 'example' => 'ca1.crt', + ], + 'CreateUser' => [ + 'description' => '创建者ID', + 'type' => 'string', + 'example' => '1107550004253538', + ], + 'CreateTime' => [ + 'description' => '创建时间（时间戳）', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1730217600000', + ], + 'FileSizeInBytes' => [ + 'description' => '文件字节大小', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1024', + ], + 'Description' => [ + 'description' => '描述信息', + 'type' => 'string', + 'example' => 'This is a file', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ecb967ec-c137-48****\\",\\n \\"PagingInfo\\": {\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 100,\\n \\"PageNumber\\": 1,\\n \\"Certificates\\": [\\n {\\n \\"Id\\": 676303114031776,\\n \\"Name\\": \\"ca1.crt\\",\\n \\"CreateUser\\": \\"1107550004253538\\",\\n \\"CreateTime\\": 1730217600000,\\n \\"FileSizeInBytes\\": 1024,\\n \\"Description\\": \\"This is a file\\"\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => '查询证书文件列表', + 'description' => '1. 需要购买DataWorks基础版及以上版本才能使用。'."\n" + .'2. 需要在DataWorks项目空间中具有如下至少一种角色：租户所有者、空间管理员、部署、开发、访客、项目所有者、运维、模型设计师、安全管理员、数据分析师、开发平台管理员、数据治理管理员', + ], + 'DeleteCertificate' => [ + 'summary' => '删除认证文件。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '250936', + 'abilityTreeNodes' => [ + 'FEATUREdideRWC5F7', + ], + ], + 'parameters' => [ + [ + 'name' => 'Id', + 'in' => 'query', + 'schema' => [ + 'description' => '证书文件ID，即证书文件的唯一标识符', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '676303114031776', + ], + ], + [ + 'name' => 'ProjectId', + 'in' => 'query', + 'schema' => [ + 'description' => '删除的认证文件所属项目ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '106560', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'Success' => [ + 'title' => '是否删除成功', + 'description' => '是否删除成功', + 'type' => 'boolean', + 'example' => 'true', + ], + 'RequestId' => [ + 'description' => '请求ID。用于定位日志，排查问题。', + 'type' => 'string', + 'example' => 'D9A61DC0-B922-421B-B706', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"D9A61DC0-B922-421B-B706\\"\\n}","type":"json"}]', + 'title' => '删除认证文件', + 'description' => '1. 需要购买DataWorks基础版及以上版本才能使用。'."\n" + .'2. 需要在DataWorks项目空间中具有如下至少一种角色： 租户所有者、空间管理员、项目所有者、运维', + ], + 'CreateProject' => [ + 'summary' => '创建工作空间。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'abilityTreeCode' => '243667', + 'abilityTreeNodes' => [ + 'FEATUREdideYTM537', + ], + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'Name', + 'in' => 'formData', + 'schema' => [ + 'description' => '工作空间名称。'."\n" + ."\n" + .'约束说明：'."\n" + ."\n" + .'- 工作空间名称要求Region下唯一。'."\n" + ."\n" + .'- 需要字母开头，只能包含字母、数字和下划线（_）'."\n" + ."\n" + .'- 限制3~28个字符。', + 'type' => 'string', + 'required' => true, + 'example' => 'sora_finance', + ], + ], + [ + 'name' => 'DisplayName', + 'in' => 'formData', + 'schema' => [ + 'description' => '工作空间展示名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'Sora financial analysis', + ], + ], + [ + 'name' => 'Description', + 'in' => 'formData', + 'schema' => [ + 'description' => '工作空间描述。', + 'type' => 'string', + 'required' => false, + 'example' => 'Financial analysis group project data development', + ], + ], + [ + 'name' => 'AliyunResourceGroupId', + 'in' => 'formData', + 'schema' => [ + 'description' => '工作空间所属阿里云资源组ID。您可以登录[资源管理控制台](https://resourcemanager.console.aliyun.com/resource-groups)，进入资源组列表页面获取 ID。'."\n" + ."\n" + .'该参数用来将本次创建的DataWorks工作空间纳入选定的阿里云资源组管理。', + 'type' => 'string', + 'required' => false, + 'example' => 'rg-acfmzbn7****', + ], + ], + [ + 'name' => 'PaiTaskEnabled', + 'in' => 'formData', + 'schema' => [ + 'description' => '是否启用PAI任务调度：'."\n" + ."\n" + .'- true 可以在DataWorks工作空间创建机器学习（PAI）节点，并按照节点配置进行周期性调度运行。'."\n" + ."\n" + .'- false 禁用PAI任务调度。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'DevEnvironmentEnabled', + 'in' => 'formData', + 'schema' => [ + 'description' => '是否启用开发环境：'."\n" + ."\n" + .'- true'."\n" + .'工作空间启用开发环境，支持开发与生产环境隔离。'."\n" + ."\n" + .'- false 仅使用生产环境。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + [ + 'name' => 'AliyunResourceTags', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'description' => '标签列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => '标签键。', + 'type' => 'string', + 'required' => false, + 'example' => 'batch', + ], + 'Value' => [ + 'description' => '标签值。', + 'type' => 'string', + 'required' => false, + 'example' => 'blue', + ], + ], + 'required' => false, + ], + 'required' => false, + ], + ], + [ + 'name' => 'DevRoleDisabled', + 'in' => 'formData', + 'schema' => [ + 'description' => '是否禁用开发角色：'."\n" + ."\n" + .'- false，开启开发角色（默认）'."\n" + ."\n" + .'- true，禁用开发角色', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求 ID。用于定位日志，排查问题。', + 'type' => 'string', + 'example' => 'AFBB799F-8578-51C5-A766-E922EDB8XXXX'."\n", + ], + 'ProjectId' => [ + 'title' => '该字段即将废弃，请使用Id字段。', + 'description' => '本次创建的 DataWorks 工作空间的 ID。'."\n" + .'注意：该字段已废弃，将使用Id字段。', + 'type' => 'integer', + 'format' => 'int64', + 'deprecated' => true, + 'example' => '123456', + ], + 'Id' => [ + 'description' => '本次创建的 DataWorks 工作空间的 ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '123456', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'asynchronous', + 'callback' => 'dataworks-public::2024-05-18::GetProject', + 'callbackInterval' => 100, + 'maxCallbackTimes' => 3, + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"AFBB799F-8578-51C5-A766-E922EDB8XXXX\\\\n\\",\\n \\"ProjectId\\": 123456,\\n \\"Id\\": 123456\\n}","type":"json"}]', + 'title' => '新建工作空间', + 'description' => '需要购买DataWorks基础版及以上版本才能使用。', + ], + 'UpdateProject' => [ + 'summary' => '该接口用于更新DataWorks工作空间。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '244492', + 'abilityTreeNodes' => [ + 'FEATUREdideYTM537', + ], + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'Id', + 'in' => 'formData', + 'schema' => [ + 'description' => 'DataWorks 工作空间的 ID。您可以登录 [DataWorks 控制台](https://dataworks.console.aliyun.com/workspace/list)，进入工作空间管理页面获取 ID。'."\n" + ."\n" + .'该参数用来确定本次 API 调用操作使用的 DataWorks 工作空间。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '123456', + ], + ], + [ + 'name' => 'Description', + 'in' => 'formData', + 'schema' => [ + 'description' => '工作空间描述.', + 'type' => 'string', + 'required' => false, + 'example' => 'Financial analysis group project data development', + ], + ], + [ + 'name' => 'Status', + 'in' => 'formData', + 'schema' => [ + 'description' => '禁用/解禁工作空间：'."\n" + ."\n" + .'- Available 解除禁用'."\n" + ."\n" + .'- Forbidden 空间禁用', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [], + 'example' => 'Forbidden', + 'enum' => [ + 'Forbidden', + 'Available', + ], + ], + ], + [ + 'name' => 'DevEnvironmentEnabled', + 'in' => 'formData', + 'schema' => [ + 'description' => '是否启用开发环境：'."\n" + ."\n" + .'- true：工作空间启用开发环境，支持开发与生产环境隔离'."\n" + ."\n" + .'- false：仅使用生产环境', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'DevRoleDisabled', + 'in' => 'formData', + 'schema' => [ + 'description' => '是否禁用开发角色：'."\n" + ."\n" + .'- false，开启开发角色（默认）'."\n" + ."\n" + .'- true，禁用开发角色'."\n" + ."\n" + .'注意：禁用开发角色（即禁用工作流程和代码编辑功能）后，禁止开启。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'DisplayName', + 'in' => 'formData', + 'schema' => [ + 'description' => '工作空间展示名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'Sora financial analysis Space', + ], + ], + [ + 'name' => 'PaiTaskEnabled', + 'in' => 'formData', + 'schema' => [ + 'description' => '是否启用PAI任务调度：'."\n" + ."\n" + .'- true 可以在DataWorks工作空间创建机器学习（PAI）节点，并按照节点配置进行周期性调度运行。'."\n" + ."\n" + .'- false 禁用PAI任务调度。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求 ID。用于定位日志，排查问题。', + 'type' => 'string', + 'example' => 'AFBB799F-8578-51C5-A766-E922EDB8XXXX'."\n", + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"AFBB799F-8578-51C5-A766-E922EDB8XXXX\\\\n\\"\\n}","type":"json"}]', + 'title' => '更新工作空间', + 'description' => '需要购买DataWorks基础版及以上版本才能使用。', + ], + 'DeleteProject' => [ + 'summary' => '调用DeleteProject接口，删除DataWorks工作空间。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'abilityTreeCode' => '244493', + 'abilityTreeNodes' => [ + 'FEATUREdideYTM537', + ], + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'Id', + 'in' => 'formData', + 'schema' => [ + 'description' => 'DataWorks 工作空间的 ID。您可以登录 [DataWorks 控制台](https://dataworks.console.aliyun.com/workspace/list)，进入工作空间管理页面获取 ID。'."\n" + ."\n" + .'该参数用来确定本次 API 调用操作使用的 DataWorks 工作空间。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '123456', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求 ID。用于定位日志，排查问题。', + 'type' => 'string', + 'example' => 'AFBB799F-8578-51C5-A766-E922EDB8XXXX'."\n", + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"AFBB799F-8578-51C5-A766-E922EDB8XXXX\\\\n\\"\\n}","type":"json"}]', + 'title' => '移除工作空间', + 'description' => '需要购买DataWorks基础版及以上版本才能使用。', + ], + 'GetProject' => [ + 'summary' => '该接口用于查询一个DataWorks工作空间的详细信息。', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '244495', + 'abilityTreeNodes' => [ + 'FEATUREdideYTM537', + ], + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'Id', + 'in' => 'query', + 'schema' => [ + 'description' => 'DataWorks 工作空间的 ID。您可以登录 [DataWorks 控制台](https://dataworks.console.aliyun.com/workspace/list)，进入工作空间管理页面获取 ID。'."\n" + ."\n" + .'该参数用来确定本次 API 调用操作使用的 DataWorks 工作空间。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '123456', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求的ID，用于定位日志，排查问题。', + 'type' => 'string', + 'example' => '22C97E95-F023-56B5-8852-B1A77A1****', + ], + 'Project' => [ + 'description' => '工作空间详细信息。', + 'type' => 'object', + 'properties' => [ + 'Id' => [ + 'description' => '工作空间ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '28477242', + ], + 'Name' => [ + 'description' => '工作空间名称。', + 'type' => 'string', + 'example' => 'sora_finance', + ], + 'DisplayName' => [ + 'description' => '工作空间展示名称。', + 'type' => 'string', + 'example' => 'Sora financial analysis', + ], + 'Description' => [ + 'description' => '工作空间描述。', + 'type' => 'string', + 'example' => 'Financial analysis group project data development', + ], + 'Owner' => [ + 'description' => '工作空间拥有者UserId，即阿里云账号ID。', + 'type' => 'string', + 'example' => '207947397706614299', + ], + 'AliyunResourceGroupId' => [ + 'description' => '工作空间所属阿里云资源组ID。', + 'type' => 'string', + 'example' => 'rg-acfmzbn7pti3zfa', + ], + 'Status' => [ + 'description' => '空间状态：'."\n" + ."\n" + .'- Available：工作空间运行正常'."\n" + .'- Initializing：初始化工作空间'."\n" + .'- InitFailed：工作空间初始化失败'."\n" + .'- Forbidden：手动禁用工作空间'."\n" + .'- Deleting：正在删除工作空间'."\n" + .'- DeleteFailed：工作空间删除失败'."\n" + .'- Frozen：工作空间欠费冻结'."\n" + .'- Updating：更新工作空间中'."\n" + .'- UpdateFailed：更新工作空间失败', + 'type' => 'string', + 'enumValueTitles' => [], + 'example' => 'Available', + ], + 'PaiTaskEnabled' => [ + 'description' => '是否启用PAI任务调度：'."\n" + ."\n" + .'- true 可以在DataWorks工作空间创建机器学习（PAI）节点，并按照节点配置进行周期性调度运行。'."\n" + ."\n" + .'- false 禁用PAI任务调度。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'DevEnvironmentEnabled' => [ + 'description' => '是否启用开发环境：'."\n" + ."\n" + .'- true 工作空间启用开发环境，支持开发与生产环境隔离。'."\n" + ."\n" + .'- false 仅使用生产环境。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'DevRoleDisabled' => [ + 'description' => '是否禁用开发角色：'."\n" + ."\n" + .'- false，开启开发角色'."\n" + ."\n" + .'- true，禁用开发角色', + 'type' => 'boolean', + 'example' => 'false', + ], + 'AliyunResourceTags' => [ + 'description' => '标签组。', + 'type' => 'array', + 'items' => [ + 'description' => '标签详情。', + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => '标签键。', + 'type' => 'string', + 'example' => 'batch', + ], + 'Value' => [ + 'description' => '标签值。', + 'type' => 'string', + 'example' => 'blue', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"22C97E95-F023-56B5-8852-B1A77A1****\\",\\n \\"Project\\": {\\n \\"Id\\": 28477242,\\n \\"Name\\": \\"sora_finance\\",\\n \\"DisplayName\\": \\"Sora financial analysis\\",\\n \\"Description\\": \\"Financial analysis group project data development\\",\\n \\"Owner\\": \\"207947397706614299\\",\\n \\"AliyunResourceGroupId\\": \\"rg-acfmzbn7pti3zfa\\",\\n \\"Status\\": \\"Available\\",\\n \\"PaiTaskEnabled\\": true,\\n \\"DevEnvironmentEnabled\\": true,\\n \\"DevRoleDisabled\\": false,\\n \\"AliyunResourceTags\\": [\\n {\\n \\"Key\\": \\"batch\\",\\n \\"Value\\": \\"blue\\"\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => '获取工作空间详情', + 'description' => '需要购买DataWorks基础版及以上版本才能使用。', + ], + 'ListProjects' => [ + 'summary' => '该接口用于查询用户所在租户下的DataWorks工作空间列表。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'abilityTreeCode' => '244496', + 'abilityTreeNodes' => [ + 'FEATUREdideYTM537', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'Ids', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'description' => 'DataWorks工作空间ID列表。'."\n" + ."\n" + .'该参数用来查询符合工作空间 ID列表的空间详情。', + 'type' => 'array', + 'items' => [ + 'description' => '工作空间ID。您可以登录 [DataWorks 控制台](https://dataworks.console.aliyun.com/workspace/list)，进入工作空间管理页面获取 ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '123456', + ], + 'required' => false, + ], + ], + [ + 'name' => 'Names', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'description' => 'DataWorks工作空间名称列表。'."\n" + ."\n" + .'该参数用来查询符合工作空间 Name列表的空间详情。', + 'type' => 'array', + 'items' => [ + 'description' => '工作空间名称。您可以登录 [DataWorks 控制台](https://dataworks.console.aliyun.com/workspace/list)，进入工作空间管理页面获取 Name。', + 'type' => 'string', + 'required' => false, + 'example' => 'sora_finance', + ], + 'required' => false, + ], + ], + [ + 'name' => 'AliyunResourceGroupId', + 'in' => 'formData', + 'schema' => [ + 'description' => '工作空间所属阿里云资源组ID。您可以登录[资源管理控制台](https://resourcemanager.console.aliyun.com/resource-groups)，进入资源组列表页面获取 ID。'."\n" + ."\n" + .'该参数用来查询归属该资源组的工作空间详情。', + 'type' => 'string', + 'required' => false, + 'example' => 'rg-acfmzbn****', + ], + ], + [ + 'name' => 'Status', + 'in' => 'formData', + 'schema' => [ + 'description' => '空间状态：'."\n" + ."\n" + .'- Available：工作空间运行正常'."\n" + .'- Initializing：初始化工作空间'."\n" + .'- InitFailed：工作空间初始化失败'."\n" + .'- Forbidden：手动禁用工作空间'."\n" + .'- Deleting：正在删除工作空间'."\n" + .'- DeleteFailed：工作空间删除失败'."\n" + .'- Frozen：工作空间欠费冻结'."\n" + .'- Updating：更新工作空间中'."\n" + .'- UpdateFailed：更新工作空间失败'."\n" + ."\n" + .'该参数用于查询符合该状态的工作空间详情。', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [], + 'example' => 'Available', + ], + ], + [ + 'name' => 'DevEnvironmentEnabled', + 'in' => 'formData', + 'schema' => [ + 'description' => '是否启用开发环境：'."\n" + ."\n" + .'- true 工作空间启用开发环境，支持开发与生产环境隔离'."\n" + ."\n" + .'- false 仅使用生产环境'."\n" + ."\n" + .'该参数用于查询符合“启用/未启用开发环境”条件的工作空间详情。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'DevRoleDisabled', + 'in' => 'formData', + 'schema' => [ + 'description' => '是否禁用开发角色：'."\n" + ."\n" + .'- false，开启开发角色（默认）'."\n" + ."\n" + .'- true，禁用开发角色'."\n" + ."\n" + .'该参数用于查询符合“开启/禁用开发角色”条件的工作空间详情。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + [ + 'name' => 'PaiTaskEnabled', + 'in' => 'formData', + 'schema' => [ + 'description' => '是否启用PAI任务调度：'."\n" + ."\n" + .'- true 可以在DataWorks工作空间创建机器学习（PAI）节点，并按照节点配置进行周期性调度运行。'."\n" + ."\n" + .'- false 禁用PAI任务调度'."\n" + ."\n" + .'该参数用于查询符合“开启/未开启PAI任务调用”条件的工作空间详情。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'AliyunResourceTags', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'description' => '标签列表。'."\n" + ."\n" + .'该参数用于查询拥有任意标签键值信息的工作空间详情。', + 'type' => 'array', + 'items' => [ + 'description' => '标签详情。 您可以登录 [资源管理控制台](https://resourcemanager.console.aliyun.com/tags)，进入标签列表页面获取 Key、Value。', + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => '标签键。', + 'type' => 'string', + 'required' => false, + 'example' => 'batch', + ], + 'Value' => [ + 'description' => '标签值。', + 'type' => 'string', + 'required' => false, + 'example' => 'blue', + ], + ], + 'required' => false, + ], + 'required' => false, + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'formData', + 'schema' => [ + 'description' => '请求的数据页数，用于翻页。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + 'default' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'formData', + 'schema' => [ + 'description' => '每页显示的条数，默认为 10 条，最大 100 条。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + 'default' => '10', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求的ID，用于定位日志，排查问题。', + 'type' => 'string', + 'example' => '6D24AD9A-652F-59E2-AC1F-05029300F8A4', + ], + 'PagingInfo' => [ + 'description' => '分页信息。', + 'type' => 'object', + 'properties' => [ + 'PageSize' => [ + 'description' => '每页显示的条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageNumber' => [ + 'description' => '请求的数据页数，用于翻页。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'TotalCount' => [ + 'description' => '满足条件的数据总条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '100', + ], + 'Projects' => [ + 'description' => '工作空间列表。', + 'type' => 'array', + 'items' => [ + 'description' => '工作空间详细信息。', + 'type' => 'object', + 'properties' => [ + 'Id' => [ + 'description' => '工作空间ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '123456', + ], + 'Name' => [ + 'description' => '工作空间名称。', + 'type' => 'string', + 'example' => 'sora_finance', + ], + 'DisplayName' => [ + 'description' => '工作空间展示名称。', + 'type' => 'string', + 'example' => 'Sora financial analysis'."\n", + ], + 'Description' => [ + 'description' => '工作空间描述。', + 'type' => 'string', + 'example' => 'Financial analysis group project data development', + ], + 'Owner' => [ + 'description' => '工作空间拥有者UserId，即阿里云账号ID。', + 'type' => 'string', + 'example' => '123532153125', + ], + 'AliyunResourceGroupId' => [ + 'description' => '工作空间所属阿里云资源组ID。', + 'type' => 'string', + 'example' => 'rg-acfmzbn7pti3zfa', + ], + 'Status' => [ + 'description' => '空间状态：'."\n" + ."\n" + .'- Available：工作空间运行正常'."\n" + .'- Initializing：初始化工作空间'."\n" + .'- InitFailed：工作空间初始化失败'."\n" + .'- Forbidden：手动禁用工作空间'."\n" + .'- Deleting：正在删除工作空间'."\n" + .'- DeleteFailed：工作空间删除失败'."\n" + .'- Frozen：工作空间欠费冻结'."\n" + .'- Updating：更新工作空间中'."\n" + .'- UpdateFailed：更新工作空间失败', + 'type' => 'string', + 'example' => 'Available', + ], + 'PaiTaskEnabled' => [ + 'description' => '是否启用PAI任务调度：'."\n" + ."\n" + .'- true 可以在DataWorks工作空间创建机器学习（PAI）节点，并按照节点配置进行周期性调度运行。'."\n" + ."\n" + .'- false 禁用PAI任务调度。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'DevEnvironmentEnabled' => [ + 'description' => '是否启用开发环境：'."\n" + ."\n" + .'- true 工作空间启用开发环境，支持开发与生产环境隔离。'."\n" + ."\n" + .'- false 仅使用生产环境。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'DevRoleDisabled' => [ + 'description' => '是否禁用开发角色：'."\n" + ."\n" + .'- false，开启开发角色'."\n" + ."\n" + .'- true，禁用开发角色', + 'type' => 'boolean', + 'example' => 'false', + ], + 'AliyunResourceTags' => [ + 'description' => '标签组。', + 'type' => 'array', + 'items' => [ + 'description' => '标签详情。', + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => '标签键。', + 'type' => 'string', + 'example' => 'batch', + ], + 'Value' => [ + 'description' => '标签值。', + 'type' => 'string', + 'example' => 'blue', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"6D24AD9A-652F-59E2-AC1F-05029300F8A4\\",\\n \\"PagingInfo\\": {\\n \\"PageSize\\": 1,\\n \\"PageNumber\\": 10,\\n \\"TotalCount\\": 100,\\n \\"Projects\\": [\\n {\\n \\"Id\\": 123456,\\n \\"Name\\": \\"sora_finance\\",\\n \\"DisplayName\\": \\"Sora financial analysis\\\\n\\",\\n \\"Description\\": \\"Financial analysis group project data development\\",\\n \\"Owner\\": \\"123532153125\\",\\n \\"AliyunResourceGroupId\\": \\"rg-acfmzbn7pti3zfa\\",\\n \\"Status\\": \\"Available\\",\\n \\"PaiTaskEnabled\\": true,\\n \\"DevEnvironmentEnabled\\": true,\\n \\"DevRoleDisabled\\": false,\\n \\"AliyunResourceTags\\": [\\n {\\n \\"Key\\": \\"batch\\",\\n \\"Value\\": \\"blue\\"\\n }\\n ]\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => '获取工作空间详情列表', + 'description' => '需要购买DataWorks基础版及以上版本才能使用。', + ], + 'GetProjectRole' => [ + 'summary' => '查询工作空间角色详情。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '244504', + 'abilityTreeNodes' => [ + 'FEATUREdideYTM537', + ], + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'ProjectId', + 'in' => 'query', + 'schema' => [ + 'description' => 'DataWorks工作空间的ID。您可以登录[DataWorks控制台](https://workbench.data.aliyun.com/console)，进入工作空间配置页面获取工作空间ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '10002', + ], + ], + [ + 'name' => 'Code', + 'in' => 'query', + 'schema' => [ + 'description' => '工作空间的角色 Code。'."\n" + .'- role_project_admin：空间管理员'."\n" + .'- role_project_dev：开发'."\n" + .'- role_project_dg_admin：数据治理管理员'."\n" + .'- role_project_guest：访客'."\n" + .'- role_project_security：安全管理员'."\n" + .'- role_project_deploy：部署'."\n" + .'- role_project_owner：空间所有者'."\n" + .'- role_project_data_analyst：数据分析师'."\n" + .'- role_project_pe：运维'."\n" + .'- role_project_erd(模型设计师', + 'type' => 'string', + 'required' => true, + 'enumValueTitles' => [], + 'example' => 'role_project_guest', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求 ID。用于定位日志，排查问题。', + 'type' => 'string', + 'example' => '82F28E60-CF48-5EDF-AB25-D806847B97D1', + ], + 'ProjectRole' => [ + 'description' => '工作空间角色详情', + 'type' => 'object', + 'properties' => [ + 'ProjectId' => [ + 'description' => 'DataWorks工作空间的ID。'."\n" + ."\n" + .'特殊说明：系统默认的工作空间角色，ProjectId返回固定值-1。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10002', + ], + 'Code' => [ + 'description' => '工作空间的角色 Code。', + 'type' => 'string', + 'enumValueTitles' => [], + 'example' => 'role_project_guest', + ], + 'Name' => [ + 'description' => '工作空间的角色 Name。', + 'type' => 'string', + 'example' => 'Visitors', + ], + 'Type' => [ + 'description' => '工作空间的角色类型。'."\n" + .'- UserCustom：用户自定义角色'."\n" + .'- System：系统角色', + 'type' => 'string', + 'enumValueTitles' => [], + 'example' => 'System', + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"82F28E60-CF48-5EDF-AB25-D806847B97D1\\",\\n \\"ProjectRole\\": {\\n \\"ProjectId\\": 10002,\\n \\"Code\\": \\"role_project_guest\\",\\n \\"Name\\": \\"Visitors\\",\\n \\"Type\\": \\"System\\"\\n }\\n}","type":"json"}]', + 'title' => '获取工作空间角色详情', + 'description' => '需要购买DataWorks基础版及以上版本才能使用。', + ], + 'ListProjectRoles' => [ + 'summary' => '分页查询工作空间角色详情。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'abilityTreeCode' => '244505', + 'abilityTreeNodes' => [ + 'FEATUREdideYTM537', + ], + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'ProjectId', + 'in' => 'formData', + 'schema' => [ + 'description' => 'DataWorks工作空间的ID。您可以登录[DataWorks控制台](https://workbench.data.aliyun.com/console)，进入工作空间管理页面获取ID。'."\n" + ."\n" + .'该参数用来确定本次API调用操作使用的DataWorks工作空间。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '21229', + ], + ], + [ + 'name' => 'Codes', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'description' => '工作空间角色 Code 列表', + 'type' => 'array', + 'items' => [ + 'description' => '工作空间的角色 Code。'."\n" + .'- role_project_admin：空间管理员'."\n" + .'- role_project_dev：开发'."\n" + .'- role_project_dg_admin：数据治理管理员'."\n" + .'- role_project_guest：访客'."\n" + .'- role_project_security：安全管理员'."\n" + .'- role_project_deploy：部署'."\n" + .'- role_project_owner：工作空间所有者'."\n" + .'- role_project_data_analyst：数据分析师'."\n" + .'- role_project_pe：运维'."\n" + .'- role_project_erd：模型设计师', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [], + 'example' => 'role_project_guest', + ], + 'required' => false, + ], + ], + [ + 'name' => 'Names', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'description' => '工作空间的角色 Name 列表', + 'type' => 'array', + 'items' => [ + 'description' => '工作空间的角色 Name。', + 'type' => 'string', + 'required' => false, + 'example' => 'Visitors', + ], + 'required' => false, + ], + ], + [ + 'name' => 'Type', + 'in' => 'formData', + 'schema' => [ + 'description' => '工作空间的角色类型。'."\n" + .'- UserCustom：用户自定义角色'."\n" + .'- System：系统角色', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [], + 'example' => 'System', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'formData', + 'schema' => [ + 'description' => '请求的数据页数，用于翻页。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'formData', + 'schema' => [ + 'description' => '每页显示的条数，默认为 10 条，最大 100 条。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求 ID。用于定位日志，排查问题。', + 'type' => 'string', + 'example' => '61649187-0BCF-5E75-8D4B-64FDBEBBB447', + ], + 'PagingInfo' => [ + 'description' => '分页信息', + 'type' => 'object', + 'properties' => [ + 'PageSize' => [ + 'description' => '每页显示的条数', + 'type' => 'string', + 'example' => '10', + ], + 'PageNumber' => [ + 'description' => '请求的数据页数，用于翻页。', + 'type' => 'string', + 'example' => '1', + ], + 'TotalCount' => [ + 'description' => '满足条件的数据总条数。', + 'type' => 'string', + 'example' => '42', + ], + 'ProjectRoles' => [ + 'description' => '工作空间角色列表', + 'type' => 'array', + 'items' => [ + 'description' => '工作空间角色详细信息', + 'type' => 'object', + 'properties' => [ + 'ProjectId' => [ + 'description' => 'DataWorks工作空间的ID。'."\n" + ."\n" + .'特殊说明：系统默认的工作空间角色，ProjectId返回固定值-1。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '21229', + ], + 'Code' => [ + 'description' => '工作空间的角色 Code。', + 'type' => 'string', + 'example' => 'role_project_guest'."\n", + ], + 'Name' => [ + 'description' => '工作空间的角色 Name。', + 'type' => 'string', + 'example' => 'Visitors', + ], + 'Type' => [ + 'description' => '工作空间的角色类型。', + 'type' => 'string', + 'example' => 'System', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"61649187-0BCF-5E75-8D4B-64FDBEBBB447\\",\\n \\"PagingInfo\\": {\\n \\"PageSize\\": \\"10\\",\\n \\"PageNumber\\": \\"1\\",\\n \\"TotalCount\\": \\"42\\",\\n \\"ProjectRoles\\": [\\n {\\n \\"ProjectId\\": 21229,\\n \\"Code\\": \\"role_project_guest\\\\n\\",\\n \\"Name\\": \\"Visitors\\",\\n \\"Type\\": \\"System\\"\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => '获取工作空间角色详情列表', + 'description' => '需要购买DataWorks基础版及以上版本才能使用。', + ], + 'CreateProjectMember' => [ + 'summary' => '添加工作空间成员同时授予工作空间角色。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'abilityTreeCode' => '244498', + 'abilityTreeNodes' => [ + 'FEATUREdideYTM537', + ], + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'ProjectId', + 'in' => 'formData', + 'schema' => [ + 'description' => 'DataWorks工作空间的ID。您可以登录[DataWorks控制台](https://workbench.data.aliyun.com/console)，进入工作空间管理页面获取ID。'."\n" + ."\n" + .'该参数用来确定本次API调用操作使用的DataWorks工作空间。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '24054', + ], + ], + [ + 'name' => 'UserId', + 'in' => 'formData', + 'schema' => [ + 'description' => 'Dataworks账号 ID 。您可以登录[ DataWorks 控制台—管理中心](https://dataworks.console.aliyun.com/product/ms_menu)，选择需要添加成员的工作空间进入管理中心页面，进入 **租户成员与角色** 页面，查看需要加入工作空间的账号 ID。', + 'type' => 'string', + 'required' => true, + 'example' => '123422344899', + ], + ], + [ + 'name' => 'RoleCodes', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'description' => '工作空间角色 Code 列表。 您可以调用[ListProjectRoles](~~2853930~~) 获取角色的 Code。'."\n" + ."\n" + .'该参数用来添加空间成员时同步授予其工作空间角色 。', + 'type' => 'array', + 'items' => [ + 'description' => '工作空间角色 Code 。', + 'type' => 'string', + 'required' => false, + 'example' => 'role_project_guest', + ], + 'required' => true, + 'maxItems' => 10, + 'minItems' => 1, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求 ID。用于定位日志，排查问题。', + 'type' => 'string', + 'example' => '2B2F0B26-9253-5780-B6DB-F1A886D44D6F', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"2B2F0B26-9253-5780-B6DB-F1A886D44D6F\\"\\n}","type":"json"}]', + 'title' => '创建工作空间成员', + 'description' => '需要购买DataWorks基础版及以上版本才能使用。', + ], + 'DeleteProjectMember' => [ + 'summary' => '移除工作空间成员及其已授予的工作空间角色。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'abilityTreeCode' => '244499', + 'abilityTreeNodes' => [ + 'FEATUREdideYTM537', + ], + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'ProjectId', + 'in' => 'formData', + 'schema' => [ + 'description' => 'DataWorks工作空间的ID。您可以登录[DataWorks控制台](https://workbench.data.aliyun.com/console)，进入工作空间配置页面获取工作空间ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '534752', + ], + ], + [ + 'name' => 'UserId', + 'in' => 'formData', + 'schema' => [ + 'description' => 'DataWorks账号 ID 。您可以登录[ DataWorks 控制台——管理中心](https://dataworks.console.aliyun.com/product/ms_menu)，选择需要移除成员的工作空间进入管理中心页面，进入**租户成员与角色**页面，查看需要从工作空间移除的账号 ID。', + 'type' => 'string', + 'required' => true, + 'example' => '123422344899', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求 ID。用于定位日志，排查问题。', + 'type' => 'string', + 'example' => '1FF0465F-209C-5964-8F30-FAF21B677CC6', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1FF0465F-209C-5964-8F30-FAF21B677CC6\\"\\n}","type":"json"}]', + 'title' => '移除工作空间成员', + 'description' => '需要购买DataWorks基础版及以上版本才能使用。', + ], + 'GrantMemberProjectRoles' => [ + 'summary' => '授予工作空间成员角色。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '244500', + 'abilityTreeNodes' => [ + 'FEATUREdideYTM537', + ], + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'ProjectId', + 'in' => 'formData', + 'schema' => [ + 'description' => 'DataWorks工作空间的ID。您可以登录[DataWorks控制台](https://workbench.data.aliyun.com/console)，进入工作空间配置页面获取工作空间ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '105149', + ], + ], + [ + 'name' => 'UserId', + 'in' => 'formData', + 'schema' => [ + 'description' => 'DataWorks账号 ID 。您可以登录[ DataWorks 控制台——管理中心](https://dataworks.console.aliyun.com/product/ms_menu)，选择需要操作的工作空间进入管理中心页面，进入租户成员与角色页面，查看授予新角色的账号 ID。', + 'type' => 'string', + 'required' => true, + 'example' => '123422344899', + ], + ], + [ + 'name' => 'RoleCodes', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'description' => '工作空间角色 Code 列表。 您可以调用 [ListProjectRoles](~~2853930~~) 获取角色的 Code。 '."\n" + ."\n" + .'该参数用来描述本次 API 调用操作将要新增授予的工作空间角色 。', + 'type' => 'array', + 'items' => [ + 'description' => '工作空间角色 Code 。', + 'type' => 'string', + 'required' => false, + 'example' => 'role_project_guest', + ], + 'required' => true, + 'maxItems' => 10, + 'minItems' => 1, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求 ID。用于定位日志，排查问题。', + 'type' => 'string', + 'example' => '2d9ced66-38ef-4923-baf6-391dd3a7e656', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"2d9ced66-38ef-4923-baf6-391dd3a7e656\\"\\n}","type":"json"}]', + 'title' => '授予工作空间成员新的空间角色', + 'description' => '需要购买DataWorks基础版及以上版本才能使用。', + ], + 'RevokeMemberProjectRoles' => [ + 'summary' => '撤销工作空间成员的角色。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '244501', + 'abilityTreeNodes' => [ + 'FEATUREdideYTM537', + ], + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'ProjectId', + 'in' => 'formData', + 'schema' => [ + 'description' => 'DataWorks工作空间的ID。您可以登录[DataWorks控制台](https://dataworks.console.aliyun.com/workspace/list)，进入工作空间配置页面获取工作空间ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '105149', + ], + ], + [ + 'name' => 'UserId', + 'in' => 'formData', + 'schema' => [ + 'description' => 'Dataworks账号 ID。您可以登录[ DataWorks 控制台——管理中心](https://dataworks.console.aliyun.com/product/ms_menu)，选择需要操作的工作空间进入管理中心页面，进入租户成员与角色页面，查看需要移除角色的账号 ID。', + 'type' => 'string', + 'required' => true, + 'example' => '123422344899'."\n", + ], + ], + [ + 'name' => 'RoleCodes', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'description' => '工作空间角色 Code 列表。 您可以调用 [ListProjectRoles](~~2853930~~) 获取角色的 Code。 '."\n" + ."\n" + .'该参数用来描述本次 API 调用操作将要撤销的工作空间角色 。', + 'type' => 'array', + 'items' => [ + 'description' => '工作空间角色 Code 。', + 'type' => 'string', + 'required' => false, + 'example' => 'role_project_guest', + ], + 'required' => true, + 'maxItems' => 10, + 'minItems' => 1, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求 ID。用于定位日志，排查问题。', + 'type' => 'string', + 'example' => '676271D6-53B4-57BE-89FA-72F7AE1418DF', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"676271D6-53B4-57BE-89FA-72F7AE1418DF\\"\\n}","type":"json"}]', + 'title' => '撤销空间成员的空间角色', + 'description' => '需要购买DataWorks基础版及以上版本才能使用。', + ], + 'GetProjectMember' => [ + 'summary' => '查询工作空间成员详情。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '244502', + 'abilityTreeNodes' => [ + 'FEATUREdideYTM537', + ], + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'ProjectId', + 'in' => 'formData', + 'schema' => [ + 'description' => 'DataWorks工作空间的ID。您可以登录[DataWorks控制台](https://dataworks.console.aliyun.com/workspace/list)，进入工作空间管理页面获取ID。'."\n" + ."\n" + .'该参数用来确定本次API调用操作使用的DataWorks工作空间。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '88757', + ], + ], + [ + 'name' => 'UserId', + 'in' => 'formData', + 'schema' => [ + 'description' => 'Dataworks账号 ID。您可以登录[ DataWorks 控制台——管理中心](https://dataworks.console.aliyun.com/product/ms_menu)，选择需要操作的工作空间进入管理中心页面，进入租户成员与角色页面，查看需要操作的账号 ID。', + 'type' => 'string', + 'required' => true, + 'example' => '123422****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求 ID。用于定位日志，排查问题。', + 'type' => 'string', + 'example' => '8abcb91f-d266-4073-b907-2ed670378ed1', + ], + 'ProjectMember' => [ + 'description' => '工作空间成员详情。', + 'type' => 'object', + 'properties' => [ + 'ProjectId' => [ + 'description' => '工作空间的ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '88757', + ], + 'UserId' => [ + 'description' => 'Dataworks账号 ID。', + 'type' => 'string', + 'example' => '123422344899', + ], + 'Status' => [ + 'description' => '工作空间成员状态。'."\n" + ."\n" + .'- Normal 正常。'."\n" + ."\n" + .'- Forbidden 已禁用。', + 'type' => 'string', + 'example' => 'Normal', + ], + 'Roles' => [ + 'description' => '工作空间成员已经授予的空间角色列表。', + 'type' => 'array', + 'items' => [ + 'description' => '已授予的空间角色详情。', + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '工作空间的角色 Code。'."\n" + ."\n" + .'Dataworks系统内置的工作空间角色：'."\n" + ."\n" + .'- role_project_admin 空间管理员'."\n" + .'- role_project_dev 开发'."\n" + .'- role_project_dg_admin 数据治理管理员'."\n" + .'- role_project_guest 访客'."\n" + .'- role_project_security 安全管理员'."\n" + .'- role_project_deploy 部署'."\n" + .'- role_project_owner 工作空间所有者'."\n" + .'- role_project_data_analyst 数据分析师'."\n" + .'- role_project_pe 运维'."\n" + .'- role_project_erd 模型设计师', + 'type' => 'string', + 'example' => 'role_project_guest', + ], + 'Name' => [ + 'description' => '工作空间的角色 Name。', + 'type' => 'string', + 'example' => 'Visitors', + ], + 'Type' => [ + 'description' => '工作空间的角色类型。'."\n" + ."\n" + .'- UserCustom 用户自定义角色'."\n" + .'- System 系统角色', + 'type' => 'string', + 'example' => 'System', + ], + ], + ], + ], + 'UserName' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"8abcb91f-d266-4073-b907-2ed670378ed1\\",\\n \\"ProjectMember\\": {\\n \\"ProjectId\\": 88757,\\n \\"UserId\\": \\"123422344899\\",\\n \\"Status\\": \\"Normal\\",\\n \\"Roles\\": [\\n {\\n \\"Code\\": \\"role_project_guest\\",\\n \\"Name\\": \\"Visitors\\",\\n \\"Type\\": \\"System\\"\\n }\\n ],\\n \\"UserName\\": \\"\\"\\n }\\n}","type":"json"}]', + 'title' => '查询工作空间成员详情', + 'description' => '需要购买DataWorks基础版及以上版本才能使用。', + ], + 'ListProjectMembers' => [ + 'summary' => '分页查询工作空间成员详情。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '244503', + 'abilityTreeNodes' => [ + 'FEATUREdideYTM537', + ], + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'ProjectId', + 'in' => 'formData', + 'schema' => [ + 'description' => 'DataWorks工作空间的ID。您可以登录[DataWorks控制台](https://workbench.data.aliyun.com/console)，进入工作空间管理页面获取ID。'."\n" + ."\n" + .'该参数用来确定本次API调用操作使用的DataWorks工作空间。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '62136', + ], + ], + [ + 'name' => 'UserIds', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'description' => 'DataWorks账号 ID 列表。您可以登录[ DataWorks 控制台——管理中心](https://dataworks.console.aliyun.com/product/ms_menu)，选择需要操作的工作空间进入管理中心页面，进入租户成员与角色页面，查看需要操作的账号 ID。', + 'type' => 'array', + 'items' => [ + 'description' => 'DataWorks账号 ID 。', + 'type' => 'string', + 'required' => false, + 'example' => '123422344899', + ], + 'required' => false, + ], + ], + [ + 'name' => 'RoleCodes', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'description' => '工作空间角色 Code 列表。 您可以调用 [ListProjectRoles](~~2853930~~) 获取角色的 Code。', + 'type' => 'array', + 'items' => [ + 'description' => '工作空间角色 Code 。', + 'type' => 'string', + 'required' => false, + 'example' => 'role_project_guest', + ], + 'required' => false, + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'formData', + 'schema' => [ + 'description' => '请求的数据页数，用于翻页。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'formData', + 'schema' => [ + 'description' => '每页显示的条数，默认为 10 条，最大 100 条。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求 ID。用于定位日志，排查问题。', + 'type' => 'string', + 'example' => '9FBBBB1F-DD5E-5D8E-8F50-37F77460F056', + ], + 'PagingInfo' => [ + 'description' => '分页信息', + 'type' => 'object', + 'properties' => [ + 'PageSize' => [ + 'description' => '每页显示的条数', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'PageNumber' => [ + 'description' => '请求的数据页数，用于翻页。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'TotalCount' => [ + 'description' => '满足条件的数据总条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '12', + ], + 'ProjectMembers' => [ + 'description' => '工作空间成员列表。', + 'type' => 'array', + 'items' => [ + 'description' => '工作空间成员详情。', + 'type' => 'object', + 'properties' => [ + 'ProjectId' => [ + 'description' => 'DataWorks工作空间的ID。'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '62136', + ], + 'UserId' => [ + 'description' => 'DataWorks账号 ID。', + 'type' => 'string', + 'example' => '123422344899', + ], + 'Status' => [ + 'description' => '工作空间成员状态。'."\n" + ."\n" + .'- Normal 正常。'."\n" + ."\n" + .'- Forbidden 已禁用。', + 'type' => 'string', + 'enumValueTitles' => [], + 'example' => 'Normal', + ], + 'Roles' => [ + 'description' => '工作空间成员已经授予的空间角色列表。', + 'type' => 'array', + 'items' => [ + 'description' => '已授予的空间角色详情。', + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '工作空间的角色 Code。', + 'type' => 'string', + 'enumValueTitles' => [], + 'example' => 'role_project_guest', + ], + 'Name' => [ + 'description' => '工作空间的角色 Name。', + 'type' => 'string', + 'example' => 'Visitors', + ], + 'Type' => [ + 'description' => '工作空间的角色类型。'."\n" + ."\n" + .'- UserCustom 用户自定义角色'."\n" + .'- System 系统角色', + 'type' => 'string', + 'example' => 'System', + ], + ], + ], + ], + 'UserName' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"9FBBBB1F-DD5E-5D8E-8F50-37F77460F056\\",\\n \\"PagingInfo\\": {\\n \\"PageSize\\": 10,\\n \\"PageNumber\\": 1,\\n \\"TotalCount\\": 12,\\n \\"ProjectMembers\\": [\\n {\\n \\"ProjectId\\": 62136,\\n \\"UserId\\": \\"123422344899\\",\\n \\"Status\\": \\"Normal\\",\\n \\"Roles\\": [\\n {\\n \\"Code\\": \\"role_project_guest\\",\\n \\"Name\\": \\"Visitors\\",\\n \\"Type\\": \\"System\\"\\n }\\n ],\\n \\"UserName\\": \\"\\"\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => '查询工作空间成员列表', + 'description' => '需要购买DataWorks基础版及以上版本才能使用。', + ], + 'TestDataSourceConnectivity' => [ + 'summary' => '测试数据源在资源组上的连通性。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '250948', + 'abilityTreeNodes' => [ + 'FEATUREdideRWC5F7', + ], + ], + 'parameters' => [ + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'title' => '资源组ID，即资源组的唯一标识符。', + 'description' => '资源组ID，即资源组的唯一标识符。', + 'type' => 'string', + 'required' => true, + 'example' => 'Serverless_res_group_524257424564736_6831777003XXXXX', + ], + ], + [ + 'name' => 'DataSourceId', + 'in' => 'query', + 'schema' => [ + 'title' => '待测试连通性的数据源ID，数据源ID是数据源的唯一标识符。', + 'description' => '待测试连通性的数据源ID，数据源ID是数据源的唯一标识符。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '144544', + ], + ], + [ + 'name' => 'ProjectId', + 'in' => 'query', + 'schema' => [ + 'title' => 'DataWorks项目空间ID。', + 'description' => 'DataWorks项目空间ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '10001', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID，一次请求的唯一标识。'."\n", + 'type' => 'string', + 'example' => '4CDF7B72-020B-542A-8465-21CFFA81****', + ], + 'Connectivity' => [ + 'description' => '连通性详情', + 'type' => 'object', + 'properties' => [ + 'ConnectState' => [ + 'title' => '测试后的连通性状态。'."\n" + .'枚举值：'."\n" + .'● Connectable：可连通'."\n" + .'● ConfigError：网络可通，但是配置有误'."\n" + .'● Unreachable：不可连通'."\n" + .'● Unsupport：其他不支持的场景，例如资源组处于初始化中', + 'description' => '测试后的连通性状态。'."\n" + .'枚举值：'."\n" + .'● Connectable：可连通'."\n" + .'● ConfigError：网络可通，但是配置有误'."\n" + .'● Unreachable：不可连通'."\n" + .'● Unsupport：其他不支持的场景，例如资源组处于初始化中', + 'type' => 'string', + 'example' => 'Connectable', + ], + 'ConnectMessage' => [ + 'title' => '连通性测试失败时，具体的描述信息。'."\n" + .'连通性测试成功时，无该信息。', + 'description' => '连通性测试失败时，具体的描述信息。'."\n" + .'连通性测试成功时，无该信息。', + 'type' => 'string', + 'example' => '连接数据库失败', + ], + 'DetailLogs' => [ + 'description' => '测试连通性各个阶段的详细日志', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'StartTime' => [ + 'description' => '表示该步骤的起始时间', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1730217600001', + ], + 'EndTime' => [ + 'description' => '表示该步骤的终止时间', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1730217604002', + ], + 'Code' => [ + 'description' => '测试项代码', + 'type' => 'string', + 'example' => 'validate_input_parameters', + ], + 'Message' => [ + 'description' => '测试步骤名称', + 'type' => 'string', + 'example' => '校验输入参数', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"4CDF7B72-020B-542A-8465-21CFFA81****\\",\\n \\"Connectivity\\": {\\n \\"ConnectState\\": \\"Connectable\\",\\n \\"ConnectMessage\\": \\"连接数据库失败\\",\\n \\"DetailLogs\\": [\\n {\\n \\"StartTime\\": 1730217600001,\\n \\"EndTime\\": 1730217604002,\\n \\"Code\\": \\"validate_input_parameters\\",\\n \\"Message\\": \\"校验输入参数\\"\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => '测试数据源的连通性', + 'description' => '1. 需要购买DataWorks基础版及以上版本才能使用。'."\n" + .'2. 需要在DataWorks项目空间中具有如下至少一种角色：'."\n" + .'租户所有者、空间管理员、部署、开发、项目所有者、运维', + ], + 'CreateDataSource' => [ + 'summary' => '在指定项目空间创建一条数据源，可以是开发环境或生产环境。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'high', + 'chargeType' => 'free', + 'abilityTreeCode' => '232205', + 'abilityTreeNodes' => [ + 'FEATUREdideRWC5F7', + ], + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'ProjectId', + 'in' => 'query', + 'schema' => [ + 'title' => 'Dataworks项目空间Id', + 'description' => 'DataWorks工作空间的ID。您可以登录[DataWorks控制台](https://dataworks.console.aliyun.com/overview)，进入工作空间管理页面获取ID。'."\n" + ."\n" + .'该参数用来确定本次API调用操作使用的DataWorks工作空间。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'minimum' => '0', + 'example' => '2', + ], + ], + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => [ + 'title' => '数据源的名称，由字母、数字、下划线组合，且不能以数字和下划线开头，最长255 个字符', + 'description' => '数据源的名称，由字母、数字、下划线组合，且不能以数字和下划线开头，最长255 个字符。', + 'type' => 'string', + 'required' => true, + 'example' => 'demo_holo_datasource', + ], + ], + [ + 'name' => 'Type', + 'in' => 'query', + 'schema' => [ + 'title' => '数据源的类型，目前已经支持数据源类型 70+', + 'description' => '数据源的类型，目前已经支持数据源类型 70+，数据源类型枚举说明参考文档：[数据源类型列表](~~2852465~~)', + 'type' => 'string', + 'required' => true, + 'example' => 'hologres', + ], + ], + [ + 'name' => 'ConnectionPropertiesMode', + 'in' => 'query', + 'schema' => [ + 'title' => '据源添加的类别，不同Type下会有不同的子类型，对应有不同的参数约束，以mysql数据源举例有：InstanceMode（实例模式）、UrlMode（连接串模式）', + 'description' => '数据源添加的类别，不同Type下会有不同的子类型，对应有不同的参数约束，以MySQL数据源举例有：'."\n" + .'- InstanceMode（实例模式）'."\n" + .'- UrlMode（连接串模式）', + 'type' => 'string', + 'required' => true, + 'example' => 'UrlMode', + 'enum' => [ + 'UrlMode', + 'InstanceMode', + 'CdhMode', + ], + ], + ], + [ + 'name' => 'Description', + 'in' => 'query', + 'schema' => [ + 'title' => '数据源描述信息，长度不超过 3000 个字符', + 'description' => '数据源描述信息，长度不超过 3000 个字符。', + 'type' => 'string', + 'required' => false, + 'example' => 'this is a holo datasource', + ], + ], + [ + 'name' => 'ConnectionProperties', + 'in' => 'query', + 'schema' => [ + 'title' => '数据源具体连接配置信息，包括连接地址、访问身份、环境信息等。数据源环境EnvType信息是此对象的成员属性，包括DEV（开发环境）和PROD（生产环境），EnvType取值不区分大小写。'."\n" + .'```'."\n", + 'description' => '数据源的具体连接配置信息，包括连接地址、访问身份、环境信息等。数据源环境envType信息是此对象的成员属性，包括'."\n" + .'- Dev（开发环境）'."\n" + .'- Prod（生产环境）'."\n" + ."\n" + .'不同类型的数据源在不同的配置模式（ConnectionPropertiesMode）下具有不同的属性信息规范，请参考[数据源连接信息ConnectionProperties](~~2852465~~)', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '{'."\n" + .' "envType": "Prod",'."\n" + .' "regionId": "cn-beijing",'."\n" + .' "instanceId": "hgprecn-cn-x0r3oun4k001",'."\n" + .' "database": "testdb",'."\n" + .' "securityProtocol": "authTypeNone",'."\n" + .' "authType": "Executor",'."\n" + .' "authIdentity": "1107550004253538"'."\n" + .'}', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求 ID。用于定位日志，排查问题。', + 'type' => 'string', + 'example' => 'B62EC203-B39E-5DC1-B5B8-EB3C6****', + ], + 'Id' => [ + 'title' => '返回创建的数据源Id', + 'description' => '返回创建的数据源ID，数据源的唯一标识符。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '22130', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"B62EC203-B39E-5DC1-B5B8-EB3C6****\\",\\n \\"Id\\": 22130\\n}","type":"json"}]', + 'title' => '创建数据源', + 'description' => '1. 需要购买DataWorks基础版及以上版本才能使用。'."\n" + .'2. 需要在DataWorks项目空间中具有如下至少一种角色：'."\n" + .'- 租户所有者、空间管理员、项目所有者、运维', + ], + 'DeleteDataSource' => [ + 'summary' => '根据数据源ID，删除指定的数据源。', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '232438', + 'abilityTreeNodes' => [ + 'FEATUREdideRWC5F7', + ], + ], + 'parameters' => [ + [ + 'name' => 'Id', + 'in' => 'query', + 'schema' => [ + 'description' => '数据源ID，数据源的唯一标识符。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1234', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。用于定位日志，排查问题。', + 'type' => 'string', + 'example' => 'B56432E0-2112-5C97-88D0-AA0AE5****', + ], + 'Success' => [ + 'description' => '调用是否成功。'."\n" + .'- true：成功。'."\n" + .'- false：失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"B56432E0-2112-5C97-88D0-AA0AE5****\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => '删除数据源', + 'description' => '1. 需要购买DataWorks基础版及以上版本才能使用。'."\n" + .'2. 需要在DataWorks项目空间下具有如下至少一种角色：'."\n" + .'- 租户所有者、空间管理员、项目所有者、运维', + ], + 'UpdateDataSource' => [ + 'summary' => '根据数据源ID，修改指定的数据源。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'high', + 'chargeType' => 'free', + 'abilityTreeCode' => '232392', + 'abilityTreeNodes' => [ + 'FEATUREdideRWC5F7', + ], + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'Id', + 'in' => 'query', + 'schema' => [ + 'title' => '数据源Id', + 'description' => '数据源ID，数据源的唯一标识符。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '16033', + ], + ], + [ + 'name' => 'ProjectId', + 'in' => 'query', + 'schema' => [ + 'title' => 'Dataworks项目空间Id', + 'description' => 'DataWorks项目空间ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '5678', + ], + ], + [ + 'name' => 'ConnectionPropertiesMode', + 'in' => 'query', + 'schema' => [ + 'title' => '数据源添加的类别，不同type下会有不同的子类型，对应有不同的参数schema约束，场景举例：InstanceMode 实例模式；UrlMode 连接串模式', + 'description' => '数据源添加的类别，不同type下会有不同的子类型，对应有不同的参数约束，场景举例：'."\n" + .'- InstanceMode：实例模式。'."\n" + .'- UrlMode：连接串模式。', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [], + 'example' => 'UrlMode', + 'enum' => [ + 'UrlMode', + 'InstanceMode', + 'CdhMode', + ], + ], + ], + [ + 'name' => 'Description', + 'in' => 'query', + 'schema' => [ + 'title' => '数据源描述信息，长度不超过 3000 个字符', + 'description' => '数据源描述信息，长度不超过 3000 个字符。', + 'type' => 'string', + 'required' => false, + 'example' => 'test ', + ], + ], + [ + 'name' => 'ConnectionProperties', + 'in' => 'query', + 'schema' => [ + 'title' => '数据源具体连接配置信息，包括连接地址、访问身份、环境信息等。数据源环境EnvType信息是此对象的成员属性，包括DEV（开发环境）和PROD（生产环境），不区分大小写。', + 'description' => '数据源具体连接配置信息，包括连接地址、访问身份、环境信息等。数据源环境EnvType信息是此对象的成员属性，包括'."\n" + .'- Dev（开发环境）'."\n" + .'- Prod（生产环境）'."\n" + ."\n" + .'不同类型的数据源在不同的配置模式（ConnectionPropertiesMode）下具有不同的属性信息规范，请参考[数据源连接信息ConnectionProperties](~~2852465~~)', + 'type' => 'string', + 'required' => true, + 'example' => '{'."\n" + .' "envType": "Prod",'."\n" + .' "regionId": "cn-beijing",'."\n" + .' "instanceId": "hgprecn-cn-x0r3oun4k001",'."\n" + .' "database": "testdb",'."\n" + .' "securityProtocol": "authTypeNone",'."\n" + .' "authType": "Executor",'."\n" + .' "authIdentity": "1107550004253538"'."\n" + .'}', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。用于定位日志，排查问题。', + 'type' => 'string', + 'example' => '102E8E24-0387-531D-8A75-1C0AE7DD03E5', + ], + 'Success' => [ + 'description' => '数据源是否修改成功：'."\n" + ."\n" + .'- true：是'."\n" + ."\n" + .'- false：否', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"102E8E24-0387-531D-8A75-1C0AE7DD03E5\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => '修改数据源', + 'description' => '1. 需要购买DataWorks基础版及以上版本才能使用。'."\n" + .'2. 需要在DataWorks项目空间中具有如下至少一种角色：'."\n" + .'- 租户所有者、租户管理员、空间管理员、项目所有者、运维', + ], + 'CloneDataSource' => [ + 'summary' => '根据已有的数据源，克隆一条新的数据源。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '232442', + 'abilityTreeNodes' => [ + 'FEATUREdideRWC5F7', + ], + ], + 'parameters' => [ + [ + 'name' => 'Id', + 'in' => 'query', + 'schema' => [ + 'description' => '数据源ID，数据源的唯一标识符。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1603612', + ], + ], + [ + 'name' => 'CloneDataSourceName', + 'in' => 'query', + 'schema' => [ + 'description' => '目标数据源的名称，由字母、数字、下划线组合，且不能以数字和下划线开头，最长60个字符。', + 'type' => 'string', + 'required' => true, + 'example' => 'demo_holo_datasource', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求 ID。用于定位日志，排查问题。', + 'type' => 'string', + 'example' => 'FCD583B9-346B-5E75-82C1-4A7C192C48DB', + ], + 'Id' => [ + 'description' => '返回克隆创建的数据源ID，数据源的唯一标识符。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '19715', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"FCD583B9-346B-5E75-82C1-4A7C192C48DB\\",\\n \\"Id\\": 19715\\n}","type":"json"}]', + 'title' => '克隆数据源', + 'description' => '1. 需要购买DataWorks基础版及以上版本才能使用。'."\n" + .'2. 需要在DataWorks项目空间中具有如下至少一种角色：'."\n" + .'- 租户所有者、空间管理员、项目所有者、运维', + ], + 'GetDataSource' => [ + 'summary' => '根据数据源ID，查询指定的数据源。', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '232399', + 'abilityTreeNodes' => [ + 'FEATUREdideRWC5F7', + ], + ], + 'parameters' => [ + [ + 'name' => 'Id', + 'in' => 'query', + 'schema' => [ + 'description' => '数据源ID，数据源的唯一标识符。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '16035', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求 ID。用于定位日志，排查问题。', + 'type' => 'string', + 'example' => '9252F32F-D855-549E-8898-61CF5A733050', + ], + 'DataSource' => [ + 'description' => '数据源详情。', + 'type' => 'object', + 'properties' => [ + 'Id' => [ + 'description' => '数据源的ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '16738', + ], + 'ProjectId' => [ + 'description' => '数据源所属的项目空间ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '52660', + ], + 'Name' => [ + 'description' => '数据源的名称。', + 'type' => 'string', + 'example' => 'test', + ], + 'Type' => [ + 'description' => '数据源的类型。', + 'type' => 'string', + 'example' => 'hologres', + ], + 'ConnectionProperties' => [ + 'description' => '数据源的具体连接配置信息，包括连接地址、访问身份、环境信息等。数据源环境envType信息是此对象的成员属性，包括'."\n" + .'- Dev（开发环境）'."\n" + .'- Prod（生产环境）'."\n" + ."\n" + .'不同类型的数据源在不同的配置模式（ConnectionPropertiesMode）下具有不同的属性信息规范，请参考[数据源连接信息ConnectionProperties](~~2852465~~)', + 'type' => 'any', + 'example' => '{'."\n" + .' "envType": "Prod",'."\n" + .' "regionId": "cn-beijing",'."\n" + .' "instanceId": "hgprecn-cn-x0r3oun4k001",'."\n" + .' "database": "testdb",'."\n" + .' "securityProtocol": "authTypeNone",'."\n" + .' "authType": "Executor",'."\n" + .' "authIdentity": "1107550004253538"'."\n" + .'}', + ], + 'ConnectionPropertiesMode' => [ + 'description' => '数据源添加的类别，不同type下会有不同的子类型，对应有不同的参数约束，场景举例：'."\n" + .'- InstanceMode 实例模式；'."\n" + .'- UrlMode 连接串模式；'."\n" + .'- CdhMode：CDH模式。', + 'type' => 'string', + 'example' => 'UrlMode', + ], + 'Description' => [ + 'description' => '数据源的描述信息。', + 'type' => 'string', + 'example' => 'test', + ], + 'CreateTime' => [ + 'description' => '数据源的创建时间（时间戳）。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1698286929333', + ], + 'CreateUser' => [ + 'description' => '数据源的创建者ID。', + 'type' => 'string', + 'example' => '1107550004253538', + ], + 'ModifyTime' => [ + 'description' => '数据源的最近修改时间（时间戳）。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1698286929333', + ], + 'ModifyUser' => [ + 'description' => '数据源的修改者ID。', + 'type' => 'string', + 'example' => '1107550004253538', + ], + 'QualifiedName' => [ + 'description' => '数据源的业务唯一键，以holo举例格式是`${tenantOwnerId}:${regionId}:${type}:${instanceId}:${database}`。', + 'type' => 'string', + 'example' => '1107550004253538:cn-beijing:holo:hgprecn-cn-x0r3oun4k001:testdb', + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"9252F32F-D855-549E-8898-61CF5A733050\\",\\n \\"DataSource\\": {\\n \\"Id\\": 16738,\\n \\"ProjectId\\": 52660,\\n \\"Name\\": \\"test\\",\\n \\"Type\\": \\"hologres\\",\\n \\"ConnectionProperties\\": \\"{\\\\n\\\\t\\\\\\"envType\\\\\\": \\\\\\"Prod\\\\\\",\\\\n\\\\t\\\\\\"regionId\\\\\\": \\\\\\"cn-beijing\\\\\\",\\\\n \\\\\\"instanceId\\\\\\": \\\\\\"hgprecn-cn-x0r3oun4k001\\\\\\",\\\\n \\\\\\"database\\\\\\": \\\\\\"testdb\\\\\\",\\\\n \\\\\\"securityProtocol\\\\\\": \\\\\\"authTypeNone\\\\\\",\\\\n \\\\\\"authType\\\\\\": \\\\\\"Executor\\\\\\",\\\\n \\\\\\"authIdentity\\\\\\": \\\\\\"1107550004253538\\\\\\"\\\\n}\\",\\n \\"ConnectionPropertiesMode\\": \\"UrlMode\\",\\n \\"Description\\": \\"test\\",\\n \\"CreateTime\\": 1698286929333,\\n \\"CreateUser\\": \\"1107550004253538\\",\\n \\"ModifyTime\\": 1698286929333,\\n \\"ModifyUser\\": \\"1107550004253538\\",\\n \\"QualifiedName\\": \\"1107550004253538:cn-beijing:holo:hgprecn-cn-x0r3oun4k001:testdb\\"\\n }\\n}","type":"json"}]', + 'title' => '查看数据源详情', + 'description' => '1. 需要购买DataWorks基础版及以上版本才能使用。'."\n" + .'2. 需要在DataWorks项目空间中具有如下至少一种角色：'."\n" + .'- 租户所有者、空间管理员、部署、开发、项目所有者、运维', + ], + 'ListDataSources' => [ + 'summary' => '根据数据源业务信息，查询符合的数据源列表。', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '232439', + 'abilityTreeNodes' => [ + 'FEATUREdideRWC5F7', + ], + ], + 'parameters' => [ + [ + 'name' => 'ProjectId', + 'in' => 'query', + 'schema' => [ + 'description' => 'DataWorks工作空间的ID。您可以登录[DataWorks控制台](https://workbench.data.aliyun.com/console)，进入工作空间配置页面获取工作空间ID。'."\n" + ."\n" + .'该参数用来确定本次API调用操作使用的DataWorks工作空间。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '17820', + ], + ], + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => [ + 'description' => '数据源名称，基于此名称做模糊查询。', + 'type' => 'string', + 'required' => false, + 'example' => 'test', + ], + ], + [ + 'name' => 'Types', + 'in' => 'query', + 'style' => 'simple', + 'schema' => [ + 'description' => '数据源类型查询过滤，可以配置多个类型查询过滤。', + 'type' => 'array', + 'items' => [ + 'description' => '数据源的类型。', + 'type' => 'string', + 'required' => false, + 'example' => 'mysql', + ], + 'required' => false, + ], + ], + [ + 'name' => 'EnvType', + 'in' => 'query', + 'schema' => [ + 'description' => '数据源环境类型，枚举值：'."\n" + .'- Dev：开发环境'."\n" + .'- Prod：生产环境', + 'type' => 'string', + 'required' => false, + 'example' => 'Prod', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '查询第几页，默认值为1表示第一页。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '分页大小，默认值为10，最大值100。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'SortBy', + 'in' => 'query', + 'schema' => [ + 'description' => '数据源列表排序字段，支持名称、创建时间、数据源ID排序'."\n" + .'- CreateTime：创建时间'."\n" + .'- Id：数据源ID'."\n" + .'- Name：数据源名称'."\n" + ."\n" + .'默认值：CreateTime', + 'type' => 'string', + 'required' => false, + 'example' => 'CreateTime', + ], + ], + [ + 'name' => 'Order', + 'in' => 'query', + 'schema' => [ + 'description' => '数据源列表排序方向，枚举值：'."\n" + .'- Desc：倒序'."\n" + .'- Asc：正序'."\n" + ."\n" + .'默认值：Desc', + 'type' => 'string', + 'required' => false, + 'example' => 'Desc', + ], + ], + [ + 'name' => 'Tags', + 'in' => 'query', + 'schema' => [ + 'description' => '数据源可以打标签，基于标签做数据源查询过滤：'."\n" + .'- 多个值之间是“且”的关系，比如`["tag1", "tag2", "tag3"]`底层查询同时有这3个标签打标的数据源列表。'."\n" + .'- 不传递，或者传递为空表示不作tag过滤，查询最多支持10个标签。', + 'type' => 'string', + 'required' => false, + 'example' => '["tag1", "tag2", "tag3"] ', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求 ID。用于定位日志，排查问题。', + 'type' => 'string', + 'example' => '7BE1433F-6D55-5D86-9344-CA6F7DD19B13', + ], + 'PagingInfo' => [ + 'description' => '分页信息。', + 'type' => 'object', + 'properties' => [ + 'TotalCount' => [ + 'description' => '总条数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '131', + ], + 'PageSize' => [ + 'description' => '页大小。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10', + ], + 'PageNumber' => [ + 'description' => '页码。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'DataSources' => [ + 'description' => '数据源列表，每一个元素是一个数据源组，包含开发环境（如有）和生产环境的信息。', + 'type' => 'array', + 'items' => [ + 'description' => '数据源组信息，包含开发环境（如有）和生产环境的数据源。开发环境和生产环境的数据源具有相同的数据源名称和数据源类型，不相同的数据源ID。', + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'description' => '数据源的名称。', + 'type' => 'string', + 'example' => 'test', + ], + 'Type' => [ + 'description' => '数据源类型。', + 'type' => 'string', + 'example' => 'mysql', + ], + 'DataSource' => [ + 'description' => '数据源列表，每个元素是单个数据源信息，具有唯一的数据源ID。', + 'type' => 'array', + 'items' => [ + 'description' => '单条数据源信息。', + 'type' => 'object', + 'properties' => [ + 'Id' => [ + 'description' => '数据源ID，数据源的唯一标识符。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '16035', + ], + 'ConnectionProperties' => [ + 'description' => '数据源的具体连接配置信息，包括连接地址、访问身份、环境信息等。数据源环境envType信息是此对象的成员属性，包括'."\n" + .'- Dev（开发环境）'."\n" + .'- Prod（生产环境）'."\n" + ."\n" + .'不同类型的数据源在不同的配置模式（ConnectionPropertiesMode）下具有不同的属性信息规范，请参考[数据源连接信息ConnectionProperties](~~2852465~~)', + 'type' => 'any', + 'example' => '{'."\n" + .' "envType": "Prod",'."\n" + .' "regionId": "cn-beijing",'."\n" + .' "instanceId": "hgprecn-cn-x0r3oun4k001",'."\n" + .' "database": "testdb",'."\n" + .' "securityProtocol": "authTypeNone",'."\n" + .' "authType": "Executor",'."\n" + .' "authIdentity": "1107550004253538"'."\n" + .'}', + ], + 'ConnectionPropertiesMode' => [ + 'description' => '数据源添加的类别，不同type下会有不同的子类型，对应有不同的参数约束，场景举例：'."\n" + .'- InstanceMode 实例模式。'."\n" + .'- UrlMode 连接串模式。', + 'type' => 'string', + 'example' => 'UrlMode', + ], + 'Description' => [ + 'description' => '数据源的描述信息。', + 'type' => 'string', + 'example' => 'test ', + ], + 'CreateTime' => [ + 'description' => '数据源的创建时间（时间戳）。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1648711113000', + ], + 'CreateUser' => [ + 'description' => '数据源的创建者ID。', + 'type' => 'string', + 'example' => '1624387842781448', + ], + 'ModifyTime' => [ + 'description' => '数据源的最近修改时间（时间戳）。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1648711113000', + ], + 'ModifyUser' => [ + 'description' => '数据源的修改者ID。', + 'type' => 'string', + 'example' => '1624387842781448', + ], + 'QualifiedName' => [ + 'description' => '数据源的业务唯一键，以holo举例格式是`${tenantOwnerId}:${regionId}:${type}:${instanceId}:${database}`。', + 'type' => 'string', + 'example' => '1648711121000:cn-beijing:odps:yongxunQA_beijing_standard', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"7BE1433F-6D55-5D86-9344-CA6F7DD19B13\\",\\n \\"PagingInfo\\": {\\n \\"TotalCount\\": 131,\\n \\"PageSize\\": 10,\\n \\"PageNumber\\": 1,\\n \\"DataSources\\": [\\n {\\n \\"Name\\": \\"test\\",\\n \\"Type\\": \\"mysql\\",\\n \\"DataSource\\": [\\n {\\n \\"Id\\": 16035,\\n \\"ConnectionProperties\\": \\"{\\\\n\\\\t\\\\\\"envType\\\\\\": \\\\\\"Prod\\\\\\",\\\\n\\\\t\\\\\\"regionId\\\\\\": \\\\\\"cn-beijing\\\\\\",\\\\n \\\\\\"instanceId\\\\\\": \\\\\\"hgprecn-cn-x0r3oun4k001\\\\\\",\\\\n \\\\\\"database\\\\\\": \\\\\\"testdb\\\\\\",\\\\n \\\\\\"securityProtocol\\\\\\": \\\\\\"authTypeNone\\\\\\",\\\\n \\\\\\"authType\\\\\\": \\\\\\"Executor\\\\\\",\\\\n \\\\\\"authIdentity\\\\\\": \\\\\\"1107550004253538\\\\\\"\\\\n}\\",\\n \\"ConnectionPropertiesMode\\": \\"UrlMode\\",\\n \\"Description\\": \\"test \\",\\n \\"CreateTime\\": 1648711113000,\\n \\"CreateUser\\": \\"1624387842781448\\",\\n \\"ModifyTime\\": 1648711113000,\\n \\"ModifyUser\\": \\"1624387842781448\\",\\n \\"QualifiedName\\": \\"1648711121000:cn-beijing:odps:yongxunQA_beijing_standard\\"\\n }\\n ]\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => '获取数据源列表', + 'description' => '1. 需要购买DataWorks基础版及以上版本才能使用。'."\n" + .'2. 需要在DataWorks项目空间中具有如下至少一种角色：'."\n" + .'- 租户所有者、空间管理员、部署、开发、访客、项目所有者、运维、模型设计师、安全管理员、数据分析师、开发平台管理员、数据治理管理员', + ], + 'CreateDataSourceSharedRule' => [ + 'summary' => '创建一条数据源分享规则，即将数据源分享给其他空间或者子账号使用。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '235541', + 'abilityTreeNodes' => [ + 'FEATUREdideRWC5F7', + ], + ], + 'parameters' => [ + [ + 'name' => 'DataSourceId', + 'in' => 'query', + 'schema' => [ + 'description' => '数据源ID，数据源的唯一标识符。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '144544', + ], + ], + [ + 'name' => 'TargetProjectId', + 'in' => 'query', + 'schema' => [ + 'description' => '数据源分享到的目标项目空间ID，不支持分享到本项目。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '106560', + ], + ], + [ + 'name' => 'SharedUser', + 'in' => 'query', + 'schema' => [ + 'description' => '如果指定了SharedUser则表示分享到指定人，而不是到整个项目；不指定表示分享到整个项目。', + 'type' => 'string', + 'required' => false, + 'example' => '110755000****', + ], + ], + [ + 'name' => 'EnvType', + 'in' => 'query', + 'schema' => [ + 'description' => '数据源分享到目标项目空间环境，包括'."\n" + .'- Dev（开发环境）'."\n" + .'- Prod（生产环境）', + 'type' => 'string', + 'required' => true, + 'example' => 'Dev', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。用于定位日志，排查问题。', + 'type' => 'string', + 'example' => '46F594E6-84AB-5FA5-8144-6F3D149961E1', + ], + 'Id' => [ + 'description' => '返回创建的数据源分享规则ID，数据源分享规则的唯一标识符。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '105412', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"46F594E6-84AB-5FA5-8144-6F3D149961E1\\",\\n \\"Id\\": 105412\\n}","type":"json"}]', + 'title' => '创建数据源分享规则', + 'description' => '1. 需要购买DataWorks基础版及以上版本才能使用。'."\n" + .'2. 操作人需要将数据源从A空间分享到B空间，则需要操作人在A、B空间均具有数据源分享的权限点。需要在DataWorks项目空间中具有如下至少一种角色：'."\n" + .'- 租户所有者、租户管理员、空间管理员、项目所有者', + ], + 'DeleteDataSourceSharedRule' => [ + 'summary' => '根据数据源分享规则ID，删除一条数据源分享规则。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '235549', + 'abilityTreeNodes' => [ + 'FEATUREdideRWC5F7', + ], + ], + 'parameters' => [ + [ + 'name' => 'Id', + 'in' => 'query', + 'schema' => [ + 'title' => '数据源分享记录Id', + 'description' => '数据源分享规则ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '22127', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。用于定位日志，排查问题。', + 'type' => 'string', + 'example' => '64B-587A-8CED-969E1973887F****', + ], + 'Success' => [ + 'description' => '数据源分享规则是否删除成功，取值如下：'."\n" + .'- true：请求成功'."\n" + .'- false：请求失败', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"64B-587A-8CED-969E1973887F****\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => '删除数据源分享规则', + 'description' => '1. 需要购买DataWorks基础版及以上版本才能使用。'."\n" + .'2. 操作人需要删除一条分享规则，该分享规则是数据源从A空间分享到B空间，则需要操作人在A空间具有数据源分享权限点；或者在B空间具有数据源分享权限点。需要在DataWorks项目空间中具有如下至少一种角色：'."\n" + .'- 租户所有者、租户管理员、空间管理员、项目所有者', + ], + 'ListDataSourceSharedRules' => [ + 'summary' => '查询某个数据源配置的规则列表。', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '235551', + 'abilityTreeNodes' => [ + 'FEATUREdideRWC5F7', + ], + ], + 'parameters' => [ + [ + 'name' => 'DataSourceId', + 'in' => 'query', + 'schema' => [ + 'title' => '数据源Id', + 'description' => '数据源ID，数据源的唯一标识符。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '135123', + ], + ], + [ + 'name' => 'TargetProjectId', + 'in' => 'query', + 'schema' => [ + 'title' => '数据源分享到的目标项目空间ID，不支持分享到本项目', + 'description' => '数据源分享到的目标项目空间ID，不支持分享到本项目。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '106565', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求 ID。用于定位日志，排查问题。', + 'type' => 'string', + 'example' => '0000-ABCD-EFG****', + ], + 'DataSourceSharedRules' => [ + 'description' => '数据源的分享规则列表。', + 'type' => 'array', + 'items' => [ + 'description' => '数据源分享规则的详细信息。', + 'type' => 'object', + 'properties' => [ + 'Id' => [ + 'description' => '数据源分享规则的ID，数据源分享规则的唯一标识符。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '101412', + ], + 'DataSourceId' => [ + 'description' => '数据源ID，您可以调用[ListDataSources](~~211431~~)获取数据源的ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '265133', + ], + 'SharedDataSourceName' => [ + 'description' => '分享后在目标项目空间的数据源名称。', + 'type' => 'string', + 'example' => 'targetProject.datasource', + ], + 'SourceProjectId' => [ + 'description' => '数据源的源项目空间ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '106560', + ], + 'TargetProjectId' => [ + 'description' => '数据源的目标项目空间ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '106561', + ], + 'SharedUser' => [ + 'description' => '数据源分享到目标项目空间下的用户。若分享到整个项目，则该字段为空。', + 'type' => 'string', + 'example' => '1107550004253538', + ], + 'EnvType' => [ + 'description' => '目标数据源所属的环境。取值如下：'."\n" + .'- Dev：开发环境。'."\n" + .'- Prod：生产环境。', + 'type' => 'string', + 'example' => 'Dev', + ], + 'CreateTime' => [ + 'description' => '数据源分享规则的创建时间（时间戳）。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1724379762000', + ], + 'CreateUser' => [ + 'description' => '数据源分享规则的创建者ID。', + 'type' => 'string', + 'example' => '1107550****', + ], + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0000-ABCD-EFG****\\",\\n \\"DataSourceSharedRules\\": [\\n {\\n \\"Id\\": 101412,\\n \\"DataSourceId\\": 265133,\\n \\"SharedDataSourceName\\": \\"targetProject.datasource\\",\\n \\"SourceProjectId\\": 106560,\\n \\"TargetProjectId\\": 106561,\\n \\"SharedUser\\": \\"1107550004253538\\",\\n \\"EnvType\\": \\"Dev\\",\\n \\"CreateTime\\": 1724379762000,\\n \\"CreateUser\\": \\"1107550****\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => '查询数据源分享规则列表', + 'description' => '1. 需要购买DataWorks基础版及以上版本才能使用。'."\n" + .'2. 操作人想要查看一个数据源的分享规则，该数据源位于A空间，则操作人需要在A空间具有数据源分享的权限点。需要在DataWorks项目空间中具有如下至少一种角色：'."\n" + .'- 租户所有者、租户管理员、空间管理员、项目所有者', + ], + 'DeleteComputeResource' => [ + 'summary' => '根据计算资源ID，删除指定的计算资源。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '232438', + 'abilityTreeNodes' => [ + 'FEATUREdideRWC5F7', + ], + ], + 'parameters' => [ + [ + 'name' => 'Id', + 'in' => 'query', + 'schema' => [ + 'description' => '计算资源ID，数据源唯一标识符。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1234', + ], + ], + [ + 'name' => 'ProjectId', + 'in' => 'query', + 'schema' => [ + 'description' => '工作空间id', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1234', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '返回结果', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID，用于定位日志，排查问题。', + 'type' => 'string', + 'example' => 'B56432E0-2112-5C97-88D0-AA0AE5****'."\n", + ], + 'Success' => [ + 'description' => '调用是否成功。'."\n" + .'- true：成功；'."\n" + .'- false：失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"B56432E0-2112-5C97-88D0-AA0AE5****\\\\n\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => '删除计算资源', + 'description' => '1. 需要购买DataWorks基础版及以上版本才能使用。'."\n" + .'2. 需要在DataWorks项目空间下具有如下至少一种角色：'."\n" + .'3. 租户所有者、空间管理员、项目所有者、运维', + ], + 'GetComputeResource' => [ + 'summary' => '根据计算资源ID，查询指定的计算资源。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '232399', + 'abilityTreeNodes' => [ + 'FEATUREdideRWC5F7', + ], + ], + 'parameters' => [ + [ + 'name' => 'Id', + 'in' => 'query', + 'schema' => [ + 'description' => '计算资源 ID，计算资源的唯一标识符。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '11792', + ], + ], + [ + 'name' => 'ProjectId', + 'in' => 'query', + 'schema' => [ + 'description' => 'DataWorks工作空间的ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '10003', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求 ID，用于定位日志，排查问题。', + 'type' => 'string', + 'example' => '9252F32F-D855-549E-8898-61CF5A733050', + ], + 'ComputeResource' => [ + 'description' => '计算资源的详情。', + 'type' => 'object', + 'properties' => [ + 'Id' => [ + 'description' => '计算资源 ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '16738', + ], + 'ProjectId' => [ + 'description' => '计算资源所属项目空间 ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '52660', + ], + 'Name' => [ + 'description' => '计算资源名称。', + 'type' => 'string', + 'example' => 'MyCs', + ], + 'Type' => [ + 'description' => '计算资源类型。', + 'type' => 'string', + 'example' => 'hologres', + ], + 'ConnectionProperties' => [ + 'description' => '计算资源的具体连接配置信息，包括连接地址、访问身份、环境信息等。计算资源环境 envType 信息是此对象的成员属性，包括'."\n" + ."\n" + .'- Dev（开发环境）；'."\n" + .'- Prod（生产环境）；'."\n" + .'不同类型的计算资源在不同的配置模式（ConnectionPropertiesMode）下具有不同的属性信息规范，', + 'type' => 'any', + 'example' => '{'."\n" + .' "envType": "Prod",'."\n" + .' "regionId": "cn-beijing",'."\n" + .' "instanceId": "hgprecn-cn-x0r3oun4k001",'."\n" + .' "database": "testdb",'."\n" + .' "securityProtocol": "authTypeNone",'."\n" + .' "authType": "Executor",'."\n" + .' "authIdentity": "1107550004253538"'."\n" + .'}', + ], + 'ConnectionPropertiesMode' => [ + 'description' => '计算资源添加的类别，不同 type 下会有不同的子类型，对应有不同的参数约束，场景举例：'."\n" + .'- InstanceMode 实例模式；'."\n" + .'- UrlMode 连接串模式；'."\n" + .'- CdhMode：CDH 模式。', + 'type' => 'string', + 'example' => 'InstanceMode', + ], + 'Description' => [ + 'description' => '计算资源描述信息。', + 'type' => 'string', + 'example' => 'My Description', + ], + 'CreateTime' => [ + 'description' => '创建时间（时间戳格式）。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1698286929333', + ], + 'CreateUser' => [ + 'description' => '创建者的 ID。', + 'type' => 'string', + 'example' => '1107550004253538', + ], + 'ModifyTime' => [ + 'description' => '最近修改的时间（时间戳）。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1698286929333', + ], + 'ModifyUser' => [ + 'description' => '修改者 的ID。', + 'type' => 'string', + 'example' => '1107550004253538', + ], + 'QualifiedName' => [ + 'description' => '计算资源的业务唯一键，以 Holo 举例格式是${tenantOwnerId}:${regionId}:${type}:${instanceId}:${database}。', + 'type' => 'string', + 'example' => '1107550004253538:cn-beijing:holo:hgprecn-cn-x0r3oun4k001:testdb', + ], + 'WhetherDefault' => [ + 'description' => '是否为默认计算资源。', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"9252F32F-D855-549E-8898-61CF5A733050\\",\\n \\"ComputeResource\\": {\\n \\"Id\\": 16738,\\n \\"ProjectId\\": 52660,\\n \\"Name\\": \\"MyCs\\",\\n \\"Type\\": \\"hologres\\",\\n \\"ConnectionProperties\\": \\"{\\\\n\\\\t\\\\\\"envType\\\\\\": \\\\\\"Prod\\\\\\",\\\\n\\\\t\\\\\\"regionId\\\\\\": \\\\\\"cn-beijing\\\\\\",\\\\n \\\\\\"instanceId\\\\\\": \\\\\\"hgprecn-cn-x0r3oun4k001\\\\\\",\\\\n \\\\\\"database\\\\\\": \\\\\\"testdb\\\\\\",\\\\n \\\\\\"securityProtocol\\\\\\": \\\\\\"authTypeNone\\\\\\",\\\\n \\\\\\"authType\\\\\\": \\\\\\"Executor\\\\\\",\\\\n \\\\\\"authIdentity\\\\\\": \\\\\\"1107550004253538\\\\\\"\\\\n}\\",\\n \\"ConnectionPropertiesMode\\": \\"InstanceMode\\",\\n \\"Description\\": \\"My Description\\",\\n \\"CreateTime\\": 1698286929333,\\n \\"CreateUser\\": \\"1107550004253538\\",\\n \\"ModifyTime\\": 1698286929333,\\n \\"ModifyUser\\": \\"1107550004253538\\",\\n \\"QualifiedName\\": \\"1107550004253538:cn-beijing:holo:hgprecn-cn-x0r3oun4k001:testdb\\",\\n \\"WhetherDefault\\": true\\n }\\n}","type":"json"}]', + 'title' => '查看计算资源详情', + 'description' => '1. 需要购买 DataWorks 基础版及以上版本才能使用。'."\n" + .'2. 需要在 DataWorks 项目空间中具有如下至少一种角色：'."\n" + .'- 租户所有者、空间管理员、部署、开发、项目所有者、运维', + ], + 'UpdateComputeResource' => [ + 'summary' => '根据计算资源ID，修改指定的计算资源。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '232392', + 'abilityTreeNodes' => [ + 'FEATUREdideRWC5F7', + ], + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'Id', + 'in' => 'query', + 'schema' => [ + 'title' => '数据源Id', + 'description' => '计算资源Id', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '10001', + ], + ], + [ + 'name' => 'ProjectId', + 'in' => 'query', + 'schema' => [ + 'title' => 'Dataworks项目空间Id', + 'description' => 'Dataworks项目空间Id', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '10001', + ], + ], + [ + 'name' => 'ConnectionPropertiesMode', + 'in' => 'query', + 'schema' => [ + 'title' => '数据源添加的类别，不同type下会有不同的子类型，对应有不同的参数schema约束，场景举例：InstanceMode 实例模式；UrlMode 连接串模式', + 'description' => '计算资源添加的类别，不同type下会有不同的子类型，对应有不同的参数schema约束，场景举例：InstanceMode 实例模式；UrlMode 连接串模式', + 'type' => 'string', + 'required' => false, + 'example' => 'InstanceMode', + 'enum' => [ + 'UrlMode', + 'InstanceMode', + 'CdhMode', + ], + ], + ], + [ + 'name' => 'Description', + 'in' => 'query', + 'schema' => [ + 'title' => '数据源描述信息，长度不超过 3000 个字符', + 'description' => '计算资源描述信息，长度不超过 3000 个字符', + 'type' => 'string', + 'required' => false, + 'example' => '层级描述', + ], + ], + [ + 'name' => 'ConnectionProperties', + 'in' => 'query', + 'schema' => [ + 'title' => '数据源具体连接配置信息，包括连接地址、访问身份、环境信息等。数据源环境EnvType信息是此对象的成员属性，包括DEV（开发环境）和PROD（生产环境），不区分大小写。', + 'description' => '计算资源具体连接配置信息，包括连接地址、访问身份、环境信息等。计算资源环境EnvType信息是此对象的成员属性，包括DEV（开发环境）和PROD（生产环境），不区分大小写。', + 'type' => 'string', + 'required' => true, + 'example' => '{'."\n" + .' "envType": "Prod",'."\n" + .' "regionId": "cn-beijing",'."\n" + .' "instanceId": "hgprecn-cn-x0r3oun4k001",'."\n" + .' "database": "testdb",'."\n" + .' "securityProtocol": "authTypeNone",'."\n" + .' "authType": "Executor",'."\n" + .' "authIdentity": "1107550004253538"'."\n" + .'}', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。用于定位日志，排查问题。', + 'type' => 'string', + 'example' => '7C352CB7-CD88-50CF-9D0D-E81BDF02XXXX', + ], + 'Success' => [ + 'description' => '计算资源是否修改成功：'."\n" + .'- true：是'."\n" + .'- false：否', + 'type' => 'boolean', + 'enumValueTitles' => [ + 'true' => 'true', + 'false' => 'false', + ], + 'example' => 'true', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"7C352CB7-CD88-50CF-9D0D-E81BDF02XXXX\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => '修改计算资源', + 'description' => '1. 需要购买DataWorks基础版及以上版本才能使用。'."\n" + .'2. 需要在DataWorks项目空间中具有如下至少一种角色：'."\n" + .'3. 租户所有者、租户管理员、空间管理员、项目所有者、运维', + ], + 'ListComputeResources' => [ + 'summary' => '根据计算资源业务信息，查询符合的计算资源列表。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '232439', + 'abilityTreeNodes' => [ + 'FEATUREdideRWC5F7', + ], + ], + 'parameters' => [ + [ + 'name' => 'ProjectId', + 'in' => 'query', + 'schema' => [ + 'description' => 'DataWorks工作空间的ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '21229', + ], + ], + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => [ + 'description' => '计算资源的名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'category name ', + ], + ], + [ + 'name' => 'Types', + 'in' => 'query', + 'style' => 'simple', + 'schema' => [ + 'description' => '计算资源类型查询过滤，可以配置多个类型查询过滤。', + 'type' => 'array', + 'items' => [ + 'description' => '计算资源的类型。', + 'type' => 'string', + 'required' => false, + 'example' => 'hologres', + ], + 'required' => false, + ], + ], + [ + 'name' => 'EnvType', + 'in' => 'query', + 'schema' => [ + 'description' => '计算资源环境类型，枚举值：'."\n" + .'- Dev：开发环境'."\n" + .'- Prod：生产环境', + 'type' => 'string', + 'required' => false, + 'example' => 'Dev', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '查询第几页，默认值为1表示第一页。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '分页大小，默认值为10，最大值100。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'SortBy', + 'in' => 'query', + 'schema' => [ + 'description' => '计算资源列表排序字段，支持名称、创建时间、计算资源ID排序'."\n" + ."\n" + .'- CreateTime：创建时间'."\n" + .'- Id：计算资源ID'."\n" + .'- Name：计算资源名称'."\n" + .'- CreateTimeWithDefaultFirst：基于默认与否和创建时间排序，默认计算资源排序在前'."\n" + ."\n" + .'默认值：CreateTime', + 'type' => 'string', + 'required' => false, + 'example' => 'CreateTimeWithDefaultFirst', + ], + ], + [ + 'name' => 'Order', + 'in' => 'query', + 'schema' => [ + 'description' => '计算资源列表排序方向，枚举值：'."\n" + ."\n" + .'- Desc：倒序'."\n" + .'- Asc：正序'."\n" + ."\n" + .'默认值：Desc', + 'type' => 'string', + 'required' => false, + 'example' => 'Asc', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求 ID。用于定位日志，排查问题。', + 'type' => 'string', + 'example' => '7C352CB7-CD88-50CF-9D0D-E81BDF02XXXX', + ], + 'PagingInfo' => [ + 'description' => '分页信息。', + 'type' => 'object', + 'properties' => [ + 'TotalCount' => [ + 'description' => '总条数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '100', + ], + 'PageSize' => [ + 'description' => '页大小。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10', + ], + 'PageNumber' => [ + 'description' => '页码。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'ComputeResources' => [ + 'description' => '计算资源列表，每一个元素是一个计算资源组，包含开发环境（如有）和生产环境的信息。', + 'type' => 'array', + 'items' => [ + 'description' => '计算资源组信息，包含开发环境（如有）和生产环境的计算资源。开发环境和生产环境的计算资源具有相同的计算资源名称和计算资源类型，不相同的计算资源ID。', + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'description' => '计算资源的名称。', + 'type' => 'string', + 'example' => 'cal_all_vemg_workflow_parallel', + ], + 'Type' => [ + 'description' => '计算资源类型。', + 'type' => 'string', + 'example' => 'hologres', + ], + 'ComputeResource' => [ + 'description' => '单条计算资源信息。', + 'type' => 'array', + 'items' => [ + 'description' => '单条计算资源信息。', + 'type' => 'object', + 'properties' => [ + 'Id' => [ + 'description' => '计算资源ID，计算资源的唯一标识符。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '8649832502405358603', + ], + 'ConnectionProperties' => [ + 'description' => '计算资源添加的类别，不同type下会有不同的子类型，对应有不同的参数约束，场景举例：'."\n" + .'InstanceMode 实例模式。'."\n" + .'UrlMode 连接串模式。', + 'type' => 'any', + 'example' => '{\\n \\"clusterIdentifier\\": \\"c-da123456\\",\\n \\"database\\": \\"testdb\\",\\n \\"loginMode\\":\\"Anonymous\\",\\n \\"defaultFS\\":\\"127.0.0.1\\",\\n \\"envType\\": \\"Prod\\"\\n}', + ], + 'ConnectionPropertiesMode' => [ + 'description' => '计算资源的具体连接配置信息，包括连接地址、访问身份、环境信息等。计算资源环境envType信息是此对象的成员属性，包括'."\n" + .'- Dev（开发环境）'."\n" + .'- Prod（生产环境）'."\n" + .'不同类型的计算资源在不同的配置模式（ConnectionPropertiesMode）下具有不同的属性信息规范', + 'type' => 'string', + 'example' => 'UrlMode', + ], + 'Description' => [ + 'description' => '计算资源ID，计算资源的唯一标识符。', + 'type' => 'string', + 'example' => 'home_feed', + ], + 'CreateTime' => [ + 'description' => '创建时间（时间戳）', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1624387842781448', + ], + 'CreateUser' => [ + 'description' => '创建者ID。', + 'type' => 'string', + 'example' => '1648711113000', + ], + 'ModifyTime' => [ + 'description' => '计算资源的最近修改时间（时间戳）。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1624387842781448', + ], + 'ModifyUser' => [ + 'description' => '计算资源的修改者ID。', + 'type' => 'string', + 'example' => '1648711113000', + ], + 'WhetherDefault' => [ + 'description' => '是否为默认计算资源', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"7C352CB7-CD88-50CF-9D0D-E81BDF02XXXX\\",\\n \\"PagingInfo\\": {\\n \\"TotalCount\\": 100,\\n \\"PageSize\\": 10,\\n \\"PageNumber\\": 1,\\n \\"ComputeResources\\": [\\n {\\n \\"Name\\": \\"cal_all_vemg_workflow_parallel\\",\\n \\"Type\\": \\"hologres\\",\\n \\"ComputeResource\\": [\\n {\\n \\"Id\\": 8649832502405359000,\\n \\"ConnectionProperties\\": \\"{\\\\\\\\n \\\\\\\\\\\\\\"clusterIdentifier\\\\\\\\\\\\\\": \\\\\\\\\\\\\\"c-da123456\\\\\\\\\\\\\\",\\\\\\\\n \\\\\\\\\\\\\\"database\\\\\\\\\\\\\\": \\\\\\\\\\\\\\"testdb\\\\\\\\\\\\\\",\\\\\\\\n \\\\\\\\\\\\\\"loginMode\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"Anonymous\\\\\\\\\\\\\\",\\\\\\\\n \\\\\\\\\\\\\\"defaultFS\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"127.0.0.1\\\\\\\\\\\\\\",\\\\\\\\n \\\\\\\\\\\\\\"envType\\\\\\\\\\\\\\": \\\\\\\\\\\\\\"Prod\\\\\\\\\\\\\\"\\\\\\\\n}\\",\\n \\"ConnectionPropertiesMode\\": \\"UrlMode\\",\\n \\"Description\\": \\"home_feed\\",\\n \\"CreateTime\\": 1624387842781448,\\n \\"CreateUser\\": \\"1648711113000\\",\\n \\"ModifyTime\\": 1624387842781448,\\n \\"ModifyUser\\": \\"1648711113000\\",\\n \\"WhetherDefault\\": true\\n }\\n ]\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => '获取计算资源列表', + 'description' => '1. 需要购买DataWorks基础版及以上版本才能使用。'."\n" + .'2. 需要在DataWorks项目空间中具有如下至少一种角色：'."\n" + .'3. 租户所有者、空间管理员、部署、开发、访客、项目所有者、运维、模型设计师、安全管理员、数据分析师、开发平台管理员、数据治理管理员', + ], + 'CreateComputeResource' => [ + 'summary' => '在指定项目空间创建一条计算资源，可以是开发环境或生产环境。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '232205', + 'abilityTreeNodes' => [ + 'FEATUREdideRWC5F7', + ], + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'ProjectId', + 'in' => 'query', + 'schema' => [ + 'title' => 'Dataworks项目空间Id', + 'description' => 'Dataworks项目空间ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'minimum' => '0', + 'example' => '2', + ], + ], + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => [ + 'title' => '数据源的名称，由字母、数字、下划线组合，且不能以数字和下划线开头，最长255 个字符', + 'description' => '计算资源的名称，由字母、数字、下划线组合，且不能以数字和下划线开头，最长255 个字符。', + 'type' => 'string', + 'required' => true, + 'example' => 'demo_holo_cs', + ], + ], + [ + 'name' => 'Type', + 'in' => 'query', + 'schema' => [ + 'title' => '数据源的类型，目前已经支持数据源类型 70+', + 'description' => '计算资源的类型，目前已经支持多种计算资源类型。', + 'type' => 'string', + 'required' => true, + 'example' => 'hologres', + ], + ], + [ + 'name' => 'ConnectionPropertiesMode', + 'in' => 'query', + 'schema' => [ + 'title' => '据源添加的类别，不同Type下会有不同的子类型，对应有不同的参数约束，以mysql数据源举例有：InstanceMode（实例模式）、UrlMode（连接串模式）', + 'description' => '据源添加的类别，不同Type下会有不同的子类型，对应有不同的参数约束，以Hologres计算资源举例有：InstanceMode（实例模式）、UrlMode（连接串模式）。', + 'type' => 'string', + 'required' => true, + 'example' => 'InstanceMode', + 'enum' => [ + 'UrlMode', + 'InstanceMode', + 'CdhMode', + ], + ], + ], + [ + 'name' => 'Description', + 'in' => 'query', + 'schema' => [ + 'title' => '数据源描述信息，长度不超过 3000 个字符', + 'description' => '计算资源描述信息，长度不超过 3000 个字符。', + 'type' => 'string', + 'required' => false, + 'example' => 'demo_holo_cs', + ], + ], + [ + 'name' => 'ConnectionProperties', + 'in' => 'query', + 'schema' => [ + 'title' => '数据源具体连接配置信息，包括连接地址、访问身份、环境信息等。数据源环境EnvType信息是此对象的成员属性，包括DEV（开发环境）和PROD（生产环境），EnvType取值不区分大小写。'."\n" + .'```'."\n", + 'description' => '计算资源具体连接配置信息，包括连接地址、访问身份、环境信息等。计算资源环境EnvType信息是此对象的成员属性，包括DEV（开发环境）和PROD（生产环境），EnvType取值不区分大小写。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '{ "EndpointMode": "custom", "Database": "testdb", "TaskSubmitter": "1107550004253538", "InstanceId": "hgprecn-cn-x0r3oun4k001", "SecurityProtocol": "authTypeNone", "RegionId": "cn-beijing", "EnvType": "Prod", "AuthType": "Executor" }', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求 ID，用于定位日志，排查问题。', + 'type' => 'string', + 'example' => '22C97E95-F023-56B5-8852-B1A77A17XXXX', + ], + 'Id' => [ + 'title' => '返回创建的数据源Id', + 'description' => '返回创建的计算资源Id。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10001', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"22C97E95-F023-56B5-8852-B1A77A17XXXX\\",\\n \\"Id\\": 10001\\n}","type":"json"}]', + 'title' => '创建计算资源', + 'description' => '需要购买 DataWorks 基础版及以上版本才能使用。'."\n" + .'需要在 DataWorks 项目空间中具有如下至少一种角色：'."\n" + .'租户所有者、空间管理员、项目所有者、运维', + ], + 'CreateResourceGroup' => [ + 'summary' => '创建资源组。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'paid', + 'abilityTreeCode' => '245182', + 'abilityTreeNodes' => [ + 'FEATUREdide2SV6DS', + ], + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'Name', + 'in' => 'formData', + 'schema' => [ + 'title' => '创建通用资源组的名称，必须以字母开头，可包含字母、数字、下划线（_），最多128个字符', + 'description' => '创建通用资源组的名称，必须以字母开头，可包含字母、数字、下划线（_），最多128个字符。', + 'type' => 'string', + 'required' => true, + 'example' => 'common_resource_group', + ], + ], + [ + 'name' => 'Remark', + 'in' => 'formData', + 'schema' => [ + 'title' => '创建通用资源组的备注，可包含字母、中文、数字、下划线（_），最多128个字符', + 'description' => '创建通用资源组的备注，可包含字母、中文、数字、下划线（_），最多128个字符。', + 'type' => 'string', + 'required' => false, + 'example' => 'Create a serverless resource group for common tasks', + ], + ], + [ + 'name' => 'PaymentType', + 'in' => 'formData', + 'schema' => [ + 'title' => '资源组的付费类型，PrePaid代表包年包月，PostPaid代表按量付费 ', + 'description' => '资源组的付费类型，PrePaid代表包年包月，PostPaid代表按量付费。', + 'type' => 'string', + 'required' => true, + 'enumValueTitles' => [], + 'example' => 'PrePaid', + 'enum' => [ + 'PrePaid', + 'PostPaid', + ], + ], + ], + [ + 'name' => 'PaymentDurationUnit', + 'in' => 'formData', + 'schema' => [ + 'title' => '付费时长单位，Month代表包月，Year代表包年', + 'description' => '付费时长单位，Month代表包月，Year代表包年。', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [], + 'example' => 'Month', + 'enum' => [ + 'Month', + 'Year', + ], + ], + ], + [ + 'name' => 'PaymentDuration', + 'in' => 'formData', + 'schema' => [ + 'title' => '付费时长', + 'description' => '付费时长。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'AutoRenewEnabled', + 'in' => 'formData', + 'schema' => [ + 'title' => '是否自动续费', + 'description' => '是否自动续费。', + 'type' => 'boolean', + 'required' => false, + 'default' => 'false', + ], + ], + [ + 'name' => 'Spec', + 'in' => 'formData', + 'schema' => [ + 'title' => '资源组规格,单位CU，当资源组付费模式为PRE_PAY时，必填', + 'description' => '资源组规格,单位CU，当资源组付费模式为PrePaid时，必填。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '2', + ], + ], + [ + 'name' => 'VpcId', + 'in' => 'formData', + 'schema' => [ + 'title' => '默认绑定的VPC ID', + 'description' => '默认绑定的VPC ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'vpc-m2et4f3oc8m****', + ], + ], + [ + 'name' => 'VswitchId', + 'in' => 'formData', + 'schema' => [ + 'title' => '默认绑定的交换机ID', + 'description' => '默认绑定的交换机ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'vsw-uf8usrhs7hjd9****', + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'formData', + 'schema' => [ + 'title' => '客户端幂等性标识，用于保证创建通用资源组操作的幂等性', + 'description' => '客户端幂等性标识，用于保证创建通用资源组操作的幂等性。', + 'type' => 'string', + 'required' => true, + 'example' => 'eb870033-74c8-4b1b-9664-04c4e7cc3465', + ], + ], + [ + 'name' => 'AliyunResourceGroupId', + 'in' => 'formData', + 'schema' => [ + 'title' => '阿里云资源组ID', + 'description' => '阿里云资源组ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'rg-aek2kqofrgXXXXX', + ], + ], + [ + 'name' => 'AliyunResourceTags', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'title' => '阿里云标签列表', + 'description' => '阿里云标签列表。', + 'type' => 'array', + 'items' => [ + 'title' => '阿里云标签', + 'description' => '阿里云标签。', + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'title' => '标签Key', + 'description' => '标签Key。', + 'type' => 'string', + 'required' => false, + 'example' => 'key', + ], + 'Value' => [ + 'title' => '标签value', + 'description' => '标签value。', + 'type' => 'string', + 'required' => false, + 'example' => 'value', + ], + ], + 'required' => false, + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'Success' => [ + 'title' => '是否请求成功', + 'description' => '是否请求成功。', + 'type' => 'boolean', + 'example' => 'true', + 'default' => 'true', + ], + 'ResourceGroupOrder' => [ + 'title' => '创建通用资源组的订单信息', + 'description' => '创建通用资源组的订单信息。', + 'type' => 'object', + 'properties' => [ + 'OrderId' => [ + 'title' => '创建通用资源组的订单ID', + 'description' => '创建通用资源组的订单ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2391982058XXXXX', + ], + 'OrderInstanceId' => [ + 'title' => '创建通用资源组的订单实例ID', + 'description' => '创建通用资源组的订单实例ID。', + 'type' => 'string', + 'example' => 'c442b330-3b10-4584-959e-736e4edXXXXX', + ], + 'Id' => [ + 'title' => '创建通用资源组的唯一标识符', + 'description' => '创建通用资源组的唯一标识符。', + 'type' => 'string', + 'example' => 'Serverless_res_group_524257424564736_6831777003XXXXX', + ], + ], + ], + 'RequestId' => [ + 'title' => '请求的ID，用于定位日志，排查问题', + 'description' => '请求的ID，用于定位日志，排查问题。', + 'type' => 'string', + 'example' => '6A6CBE87-9F91-1323-B680-E7A7065XXXXX', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'asynchronous', + 'callback' => 'dataworks-public::2024-05-18::GetResourceGroup', + 'callbackInterval' => 5000, + 'maxCallbackTimes' => 10, + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"ResourceGroupOrder\\": {\\n \\"OrderId\\": 0,\\n \\"OrderInstanceId\\": \\"c442b330-3b10-4584-959e-736e4edXXXXX\\",\\n \\"Id\\": \\"Serverless_res_group_524257424564736_6831777003XXXXX\\"\\n },\\n \\"RequestId\\": \\"6A6CBE87-9F91-1323-B680-E7A7065XXXXX\\"\\n}","type":"json"}]', + 'title' => '创建资源组', + 'description' => '1. 需要购买DataWorks基础版及以上版本才能使用。'."\n" + .'2. **请确保在使用该接口前，已充分了解Dataworks通用资源组的收费方式和[价格](~~2680173~~)。**', + ], + 'DeleteResourceGroup' => [ + 'summary' => '删除通用资源组。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'paid', + 'abilityTreeCode' => '245171', + 'abilityTreeNodes' => [ + 'FEATUREdide2SV6DS', + ], + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'Id', + 'in' => 'formData', + 'schema' => [ + 'title' => '资源组唯一标识', + 'description' => '资源组唯一标识', + 'type' => 'string', + 'required' => true, + 'example' => 'Serverless_res_group_524257424564736_6831777003XXXXX', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'Success' => [ + 'title' => '是否请求成功', + 'description' => '是否请求成功', + 'type' => 'boolean', + 'example' => 'true', + 'default' => 'true', + ], + 'RequestId' => [ + 'title' => '请求的ID，用于定位日志，排查问题', + 'description' => '请求的ID，用于定位日志，排查问题', + 'type' => 'string', + 'example' => '6A6CBE87-9F91-1323-B680-E7A7065XXXXX', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"6A6CBE87-9F91-1323-B680-E7A7065XXXXX\\"\\n}","type":"json"}]', + 'title' => '删除通用资源组', + 'description' => '1. 需要购买DataWorks基础版及以上版本才能使用。'."\n" + .'2. **请确保在使用该接口前，已充分了解Dataworks通用资源组的收费方式和[价格](~~2680173~~)。**', + ], + 'UpdateResourceGroup' => [ + 'summary' => '更新资源组基本信息。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '245164', + 'abilityTreeNodes' => [ + 'FEATUREdide2SV6DS', + ], + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'Id', + 'in' => 'formData', + 'schema' => [ + 'title' => '通用资源组唯一标识', + 'description' => '通用资源组唯一标识。', + 'type' => 'string', + 'required' => true, + 'example' => 'Serverless_res_group_524257424564736_6831777003XXXXX', + ], + ], + [ + 'name' => 'Name', + 'in' => 'formData', + 'schema' => [ + 'title' => '要修改的通用资源组的名称', + 'description' => '要修改的通用资源组的名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'common_resource_group', + ], + ], + [ + 'name' => 'Remark', + 'in' => 'formData', + 'schema' => [ + 'title' => '要修改的通用资源组的备注', + 'description' => '要修改的通用资源组的备注。', + 'type' => 'string', + 'required' => false, + 'example' => 'Create a common resource group for common tasks', + ], + ], + [ + 'name' => 'AliyunResourceGroupId', + 'in' => 'formData', + 'schema' => [ + 'title' => '阿里云资源组ID', + 'description' => '要修改的所属阿里云资源组ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'rg-aek2kqofrg****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'Success' => [ + 'title' => '是否请求成功', + 'description' => '是否请求成功。', + 'type' => 'boolean', + 'example' => 'true', + 'default' => 'true', + ], + 'RequestId' => [ + 'title' => '请求的ID，用于定位日志，排查问题', + 'description' => '请求的ID，用于定位日志，排查问题。', + 'type' => 'string', + 'example' => '6A6CBE87-9F91-1323-B680-E7A7065XXXXX', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"6A6CBE87-9F91-1323-B680-E7A7065XXXXX\\"\\n}","type":"json"}]', + 'title' => '更新资源组基本信息', + 'description' => '需要购买DataWorks基础版及以上版本才能使用。', + ], + 'GetResourceGroup' => [ + 'summary' => '根据ID获取指定资源组信息。', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '245094', + 'abilityTreeNodes' => [ + 'FEATUREdide2SV6DS', + ], + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'Id', + 'in' => 'query', + 'schema' => [ + 'title' => '通用资源组唯一标识', + 'description' => '通用资源组唯一标识。', + 'type' => 'string', + 'required' => true, + 'example' => 'Serverless_res_group_524257424564736_6831777003XXXXX', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'Success' => [ + 'title' => '是否请求成功', + 'description' => '是否请求成功。', + 'type' => 'boolean', + 'example' => 'true', + 'default' => 'true', + ], + 'ResourceGroup' => [ + 'title' => '资源组详细信息', + 'description' => '资源组详细信息。', + 'type' => 'object', + 'properties' => [ + 'Id' => [ + 'title' => '资源组唯一标识', + 'description' => '资源组唯一标识。', + 'type' => 'string', + 'example' => 'Serverless_res_group_524257424564736_6831777003XXXXX', + ], + 'Name' => [ + 'title' => '资源组的名称', + 'description' => '资源组的名称。', + 'type' => 'string', + 'example' => 'common_resource_group', + ], + 'Remark' => [ + 'title' => '资源组的备注', + 'description' => '资源组的备注。', + 'type' => 'string', + 'example' => 'Create a common resource group for common tasks', + ], + 'PaymentType' => [ + 'title' => '资源组的付费类型，PrePaid代表包年包月，PostPaid代表按量付费 ', + 'description' => '资源组的付费类型，PrePaid代表包年包月，PostPaid代表按量付费 。', + 'type' => 'string', + 'enumValueTitles' => [], + 'example' => 'PrePaid', + 'enum' => [ + 'PrePaid', + 'PostPaid', + ], + ], + 'Status' => [ + 'title' => '通用资源组状态，Normal: 正常 (运行中/服务中)；Stop: 冻结 (已到期)；Deleted: 删除 (已释放/已销毁)；Creating: 创建中 (启动中)；CreateFailed: 创建失败 (启动失败)；Updating: 更新中 (扩容中/缩容中/变配中)；UpdateFailed: 更新失败 (扩容失败/升级失败)；Deleting: 删除中 (释放中/销毁中)；DeleteFailed: 删除失败 (释放失败/销毁失败)；Timeout: 超时。', + 'description' => '查询的资源组状态：'."\n" + ."\n" + .'- Normal：正常（运行中/服务中）。'."\n" + .'- Stop：冻结（已到期）。'."\n" + .'- Deleted：删除（已释放/已销毁）。'."\n" + .'- Creating：创建中。'."\n" + .'- CreateFailed：创建失败。'."\n" + .'- Updating：更新中（扩容中/缩容中/变配中）。'."\n" + .'- UpdateFailed：更新失败（扩容失败/升级失败）。'."\n" + .'- Deleting：删除中（释放中/销毁中）。'."\n" + .'- DeleteFailed：删除失败（释放失败/销毁失败）。'."\n" + .'- Timeout：操作超时。'."\n" + .'- Freezed：冻结。'."\n" + .'- Starting：启动中。', + 'type' => 'string', + 'enumValueTitles' => [], + 'example' => 'Normal', + 'enum' => [ + 'Normal', + 'Stop', + 'Deleted', + 'Creating', + 'CreateFailed', + 'Updating', + 'UpdateFailed', + 'Deleting', + 'DeleteFailed', + 'Timeout', + ], + ], + 'Spec' => [ + 'title' => '资源组规格', + 'description' => '资源组规格。', + 'type' => 'object', + 'properties' => [ + 'Standard' => [ + 'title' => '规格详情', + 'description' => '规格详情。', + 'type' => 'string', + 'example' => '2CU', + ], + 'Amount' => [ + 'title' => '数量', + 'description' => '资源数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + ], + ], + 'ResourceGroupType' => [ + 'title' => '资源组类型，CommonV2：通用2.0资源组；ExclusiveDataIntegration：独享数据集成资源组；ExclusiveScheduler：独享调度资源组；ExclusiveDataService：独享数据服务资源组', + 'description' => '资源组类型：'."\n" + ."\n" + .'- CommonV2：新版通用资源组；'."\n" + .'- ExclusiveDataIntegration：独享数据集成资源组；'."\n" + .'- ExclusiveScheduler：独享调度资源组；'."\n" + .'- ExclusiveDataService：独享数据服务资源组', + 'type' => 'string', + 'enumValueTitles' => [], + 'example' => 'CommonV2', + 'enum' => [ + 'CommonV2', + 'ExclusiveDataIntegration', + 'ExclusiveScheduler', + 'ExclusiveDataService', + ], + ], + 'OrderInstanceId' => [ + 'title' => '资源组的订单实例ID', + 'description' => '资源组的订单实例ID。', + 'type' => 'string', + 'example' => 'c442b330-3b10-4584-959e-736e4edXXXXX', + ], + 'CreateUser' => [ + 'title' => '创建该资源组的用户ID', + 'description' => '创建该资源组的用户ID。', + 'type' => 'string', + 'example' => '11075500042XXXXX', + ], + 'CreateTime' => [ + 'title' => '创建时间，为64位时间戳', + 'description' => '创建时间，为64位时间戳。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1727055811000', + ], + 'DefaultVpcId' => [ + 'title' => '通用资源组绑定的默认VPC ID', + 'description' => '通用资源组绑定的默认VPC ID。', + 'type' => 'string', + 'example' => 'vpc-m2et4f3oc8msfbccXXXXX', + ], + 'DefaultVswitchId' => [ + 'title' => '通用资源组绑定的默认交换机ID', + 'description' => '通用资源组绑定的默认交换机ID。', + 'type' => 'string', + 'example' => 'vsw-uf8usrhs7hjd9amsXXXXX', + ], + 'AliyunResourceGroupId' => [ + 'title' => '所属阿里云资源组ID', + 'description' => '所属阿里云资源组ID。', + 'type' => 'string', + 'example' => 'rg-aek2kqofrgXXXXX', + ], + 'AliyunResourceTags' => [ + 'title' => '阿里云标签列表', + 'description' => '阿里云标签列表。', + 'type' => 'array', + 'items' => [ + 'title' => '阿里云标签', + 'description' => '阿里云标签。', + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'title' => '标签key', + 'description' => '标签key。', + 'type' => 'string', + 'example' => 'key', + ], + 'Value' => [ + 'title' => '标签value', + 'description' => '标签value。', + 'type' => 'string', + 'example' => 'value', + ], + ], + ], + ], + ], + ], + 'RequestId' => [ + 'title' => '请求的ID，用于定位日志，排查问题', + 'description' => '请求的ID，用于定位日志，排查问题。', + 'type' => 'string', + 'example' => '6A6CBE87-9F91-1323-B680-E7A7065XXXXX', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"ResourceGroup\\": {\\n \\"Id\\": \\"Serverless_res_group_524257424564736_6831777003XXXXX\\",\\n \\"Name\\": \\"common_resource_group\\",\\n \\"Remark\\": \\"Create a common resource group for common tasks\\",\\n \\"PaymentType\\": \\"PrePaid\\",\\n \\"Status\\": \\"Normal\\",\\n \\"Spec\\": {\\n \\"Standard\\": \\"2CU\\",\\n \\"Amount\\": 1\\n },\\n \\"ResourceGroupType\\": \\"CommonV2\\",\\n \\"OrderInstanceId\\": \\"c442b330-3b10-4584-959e-736e4edXXXXX\\",\\n \\"CreateUser\\": \\"11075500042XXXXX\\",\\n \\"CreateTime\\": 1727055811000,\\n \\"DefaultVpcId\\": \\"vpc-m2et4f3oc8msfbccXXXXX\\",\\n \\"DefaultVswitchId\\": \\"vsw-uf8usrhs7hjd9amsXXXXX\\",\\n \\"AliyunResourceGroupId\\": \\"rg-aek2kqofrgXXXXX\\",\\n \\"AliyunResourceTags\\": [\\n {\\n \\"Key\\": \\"key\\",\\n \\"Value\\": \\"value\\"\\n }\\n ]\\n },\\n \\"RequestId\\": \\"6A6CBE87-9F91-1323-B680-E7A7065XXXXX\\"\\n}","type":"json"}]', + 'title' => '根据ID获取指定资源组信息', + 'description' => '需要购买DataWorks基础版及以上版本才能使用。', + ], + 'ListResourceGroups' => [ + 'summary' => '获取资源组列表。', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '245169', + 'abilityTreeNodes' => [ + 'FEATUREdide2SV6DS', + ], + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => [ + 'title' => '资源组名称，用于模糊查询', + 'description' => '资源组名称，用于模糊查询', + 'type' => 'string', + 'required' => false, + 'example' => 'Resource', + ], + ], + [ + 'name' => 'ProjectId', + 'in' => 'query', + 'schema' => [ + 'title' => '所属工作空间ID', + 'description' => '所属工作空间ID', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1000', + ], + ], + [ + 'name' => 'Statuses', + 'in' => 'query', + 'allowEmptyValue' => true, + 'style' => 'json', + 'schema' => [ + 'title' => '查询的资源组状态列表', + 'description' => '查询的资源组状态列表', + 'type' => 'array', + 'items' => [ + 'title' => '查询的资源组状态，Normal: 正常 (运行中/服务中)；Stop: 冻结 (已到期)；Deleted: 删除 (已释放/已销毁)；Creating: 创建中 (启动中)；CreateFailed: 创建失败 (启动失败)；Updating: 更新中 (扩容中/缩容中/变配中)；UpdateFailed: 更新失败 (扩容失败/升级失败)；Deleting: 删除中 (释放中/销毁中)；DeleteFailed: 删除失败 (释放失败/销毁失败)；Timeout: 超时；Freezed: 冻结；Starting: 启动中。', + 'description' => '查询的资源组状态：'."\n" + ."\n" + .'- Normal: 正常 (运行中/服务中)；'."\n" + .'- Stop: 冻结 (已到期)；'."\n" + .'- Deleted: 删除 (已释放/已销毁)；'."\n" + .'- Creating: 创建中；'."\n" + .'- CreateFailed: 创建失败；'."\n" + .'- Updating: 更新中 (扩容中/缩容中/变配中)；'."\n" + .'- UpdateFailed: 更新失败 (扩容失败/升级失败)；'."\n" + .'- Deleting: 删除中 (释放中/销毁中)；'."\n" + .'- DeleteFailed: 删除失败 (释放失败/销毁失败)；'."\n" + .'- Timeout: 操作超时；'."\n" + .'- Freezed：冻结；'."\n" + .'- Starting：启动中。', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [], + 'example' => 'Normal', + 'enum' => [ + 'Normal', + 'Stop', + 'Deleted', + 'Creating', + 'CreateFailed', + 'Updating', + 'UpdateFailed', + 'Deleting', + 'DeleteFailed', + 'Timeout', + 'Freezed', + 'Starting', + ], + ], + 'required' => false, + ], + ], + [ + 'name' => 'ResourceGroupTypes', + 'in' => 'query', + 'allowEmptyValue' => true, + 'style' => 'json', + 'schema' => [ + 'title' => '查询的资源组类型列表，如果为空默认返回通用资源组', + 'description' => '查询的资源组类型列表，为空默认查询通用资源组', + 'type' => 'array', + 'items' => [ + 'title' => '查询的资源组类型，CommonV2：通用2.0资源组；ExclusiveDataIntegration：独享数据集成资源组；ExclusiveScheduler：独享调度资源组；ExclusiveDataService：独享数据服务资源组', + 'description' => '资源组类型：'."\n" + ."\n" + .'- CommonV2：新版通用资源组；'."\n" + .'- ExclusiveDataIntegration：独享数据集成资源组；'."\n" + .'- ExclusiveScheduler：独享调度资源组；'."\n" + .'- ExclusiveDataService：独享数据服务资源组', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [], + 'example' => 'CommonV2', + 'enum' => [ + 'CommonV2', + 'ExclusiveScheduler', + 'ExclusiveDataIntegration', + 'ExclusiveDataService', + ], + ], + 'required' => false, + ], + ], + [ + 'name' => 'PaymentType', + 'in' => 'query', + 'schema' => [ + 'title' => '资源组的付费类型，PrePaid代表包年包月，PostPaid代表按量付费 ', + 'description' => '资源组的付费类型。'."\n" + .'- PrePaid：包年包月。'."\n" + .'- PostPaid：按量付费 。', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [], + 'example' => 'PrePaid', + 'enum' => [ + 'PrePaid', + 'PostPaid', + ], + ], + ], + [ + 'name' => 'AliyunResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'title' => '阿里云资源组ID', + 'description' => '阿里云资源组ID', + 'type' => 'string', + 'required' => false, + 'example' => 'rg-aek2kqofrgXXXXX', + ], + ], + [ + 'name' => 'AliyunResourceTags', + 'in' => 'query', + 'allowEmptyValue' => true, + 'style' => 'json', + 'schema' => [ + 'title' => '阿里云标签列表', + 'description' => '阿里云标签列表', + 'type' => 'array', + 'items' => [ + 'title' => '阿里云标签', + 'description' => '阿里云标签', + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'title' => '标签Key', + 'description' => '标签Key', + 'type' => 'string', + 'required' => false, + 'example' => 'key', + ], + 'Value' => [ + 'title' => '标签Value', + 'description' => '标签Value', + 'type' => 'string', + 'required' => false, + 'example' => 'value', + ], + ], + 'required' => false, + ], + 'required' => false, + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'title' => '分页大小', + 'description' => '分页大小', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '100', + 'default' => '100', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'title' => '分页页码', + 'description' => '分页页码', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + 'default' => '1', + ], + ], + [ + 'name' => 'SortBy', + 'in' => 'query', + 'schema' => [ + 'title' => '排序字段列表，支持定时时间、开始时间等字段。格式为"排序字段+排序方式(Desc/Asc)"（Asc可以缺省）。排序字段的枚举值如下：'."\n" + .'● Id (Desc/Asc)：资源组ID'."\n" + .'● Name (Desc/Asc)：资源组名称'."\n" + .'● Remark (Desc/Asc)：资源组备注'."\n" + .'● Type (Desc/Asc)：资源组类型'."\n" + .'● Status (Desc/Asc)：资源组资源状态'."\n" + .'● Spec (Desc/Asc)：资源组规格'."\n" + .'● CreateUser (Desc/Asc)：创建人'."\n" + .'● CreateTime (Desc/Asc)：创建时间'."\n" + .'默认值为CreateTime Asc', + 'description' => '排序字段列表，支持定时时间、开始时间等字段。格式为"排序字段+排序方式(Desc/Asc)"（Asc可以缺省）。排序字段的枚举值如下：'."\n" + ."\n" + .'- Id (Desc/Asc)：资源组ID'."\n" + .'- Name (Desc/Asc)：资源组名称'."\n" + .'- Remark (Desc/Asc)：资源组备注'."\n" + .'- Type (Desc/Asc)：资源组类型'."\n" + .'- Status (Desc/Asc)：资源组资源状态'."\n" + .'- Spec (Desc/Asc)：资源组规格'."\n" + .'- CreateUser (Desc/Asc)：创建人'."\n" + .'- CreateTime (Desc/Asc)：创建时间'."\n" + ."\n" + .'默认值为CreateTime Asc', + 'type' => 'string', + 'required' => false, + 'example' => 'CreateTime Asc', + 'default' => 'CreateTime Asc', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'Success' => [ + 'title' => '是否请求成功', + 'description' => '是否请求成功', + 'type' => 'boolean', + 'example' => 'true', + ], + 'PagingInfo' => [ + 'title' => '分页列表', + 'description' => '分页列表', + 'type' => 'object', + 'properties' => [ + 'ResourceGroupList' => [ + 'title' => '获取到的资源组详情列表', + 'description' => '获取到的资源组详情列表', + 'type' => 'array', + 'items' => [ + 'title' => '资源组详细信息', + 'description' => '资源组详细信息', + 'type' => 'object', + 'properties' => [ + 'Id' => [ + 'title' => '资源组唯一标识', + 'description' => '资源组唯一标识', + 'type' => 'string', + 'example' => 'Serverless_res_group_524257424564736_6831777003XXXXX', + ], + 'Name' => [ + 'title' => '资源组的名称', + 'description' => '资源组的名称', + 'type' => 'string', + 'example' => 'common_resource_group', + ], + 'Remark' => [ + 'title' => '资源组的备注', + 'description' => '资源组的备注', + 'type' => 'string', + 'example' => '创建用于普通任务的通用资源组', + ], + 'PaymentType' => [ + 'title' => '资源组的付费类型，PrePaid代表包年包月，PostPaid代表按量付费 ', + 'description' => '资源组的付费类型，PrePaid代表包年包月，PostPaid代表按量付费 ', + 'type' => 'string', + 'enumValueTitles' => [], + 'example' => 'PrePaid', + 'enum' => [ + 'PrePaid', + 'PostPaid', + ], + ], + 'Status' => [ + 'title' => '资源组状态，Normal: 正常 (运行中/服务中)；Stop: 冻结 (已到期)；Deleted: 删除 (已释放/已销毁)；Creating: 创建中 (启动中)；CreateFailed: 创建失败 (启动失败)；Updating: 更新中 (扩容中/缩容中/变配中)；UpdateFailed: 更新失败 (扩容失败/升级失败)；Deleting: 删除中 (释放中/销毁中)；DeleteFailed: 删除失败 (释放失败/销毁失败)；Timeout: 超时；Freezed: 冻结；Starting: 启动中。', + 'description' => '查询的资源组状态：'."\n" + ."\n" + .'- Normal: 正常 (运行中/服务中)；'."\n" + .'- Stop: 冻结 (已到期)；'."\n" + .'- Deleted: 删除 (已释放/已销毁)；'."\n" + .'- Creating: 创建中；'."\n" + .'- CreateFailed: 创建失败；'."\n" + .'- Updating: 更新中 (扩容中/缩容中/变配中)；'."\n" + .'- UpdateFailed: 更新失败 (扩容失败/升级失败)；'."\n" + .'- Deleting: 删除中 (释放中/销毁中)；'."\n" + .'- DeleteFailed: 删除失败 (释放失败/销毁失败)；'."\n" + .'- Timeout: 操作超时；'."\n" + .'- Freezed：冻结；'."\n" + .'- Starting：启动中。', + 'type' => 'string', + 'enumValueTitles' => [], + 'example' => 'Normal', + 'enum' => [ + 'Normal', + 'Stop', + 'Deleted', + 'Creating', + 'CreateFailed', + 'Updating', + 'UpdateFailed', + 'Deleting', + 'DeleteFailed', + 'Timeout', + 'Freezed', + 'Starting', + ], + ], + 'Spec' => [ + 'title' => '资源组规格', + 'description' => '资源组规格', + 'type' => 'object', + 'properties' => [ + 'Standard' => [ + 'title' => '规格详情', + 'description' => '规格详情', + 'type' => 'string', + 'example' => '2CU', + ], + 'Amount' => [ + 'title' => '数量', + 'description' => '数量', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + ], + ], + 'ResourceGroupType' => [ + 'title' => '资源组类型，CommonV2：通用2.0资源组；ExclusiveDataIntegration：独享数据集成资源组；ExclusiveScheduler：独享调度资源组；ExclusiveDataService：独享数据服务资源组', + 'description' => '资源组类型：'."\n" + ."\n" + .'- CommonV2：新版通用资源组；'."\n" + .'- ExclusiveDataIntegration：独享数据集成资源组；'."\n" + .'- ExclusiveScheduler：独享调度资源组；'."\n" + .'- ExclusiveDataService：独享数据服务资源组', + 'type' => 'string', + 'enumValueTitles' => [], + 'example' => 'CommonV2', + 'enum' => [ + 'CommonV2', + 'ExclusiveDataIntegration', + 'ExclusiveScheduler', + 'ExclusiveDataService', + ], + ], + 'OrderInstanceId' => [ + 'title' => '资源组的订单实例ID', + 'description' => '资源组的订单实例ID', + 'type' => 'string', + 'example' => 'c442b330-3b10-4584-959e-736e4edXXXXX', + ], + 'CreateUser' => [ + 'title' => '创建该资源组的用户ID', + 'description' => '创建该资源组的用户ID', + 'type' => 'string', + 'example' => '11075500042XXXXX', + ], + 'CreateTime' => [ + 'title' => '创建时间，为64位时间戳', + 'description' => '创建时间，为64位时间戳', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1727055811000', + ], + 'DefaultVpcId' => [ + 'title' => '通用资源组绑定的默认VPC ID', + 'description' => '通用资源组绑定的默认VPC ID', + 'type' => 'string', + 'example' => 'vpc-m2et4f3oc8msfbccXXXXX', + ], + 'DefaultVswicthId' => [ + 'title' => '通用资源组绑定的默认交换机ID', + 'description' => '通用资源组绑定的默认交换机ID', + 'type' => 'string', + 'example' => 'vsw-uf8usrhs7hjd9amsXXXXX', + ], + 'AliyunResourceGroupId' => [ + 'title' => '阿里云资源组ID', + 'description' => '阿里云资源组ID', + 'type' => 'string', + 'example' => 'rg-aek2kqofrgXXXXX', + ], + 'AliyunResourceTags' => [ + 'title' => '阿里云标签列表', + 'description' => '阿里云标签列表', + 'type' => 'array', + 'items' => [ + 'title' => '阿里云标签', + 'description' => '阿里云标签', + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'title' => '标签键', + 'description' => '标签键', + 'type' => 'string', + 'example' => 'Key', + ], + 'Value' => [ + 'title' => '标签值', + 'description' => '标签值', + 'type' => 'string', + 'example' => 'Value', + ], + ], + ], + ], + ], + ], + ], + 'PageNumber' => [ + 'title' => '分页页码', + 'description' => '分页页码', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + 'default' => '1', + ], + 'PageSize' => [ + 'title' => '分页大小', + 'description' => '分页大小', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '100', + 'default' => '100', + ], + 'TotalCount' => [ + 'title' => '全部数据条目', + 'description' => '全部数据条目', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '100', + ], + ], + ], + 'RequestId' => [ + 'title' => '请求的ID，用于定位日志，排查问题', + 'description' => '请求的ID，用于定位日志，排查问题', + 'type' => 'string', + 'example' => '6A6CBE87-9F91-1323-B680-E7A7065XXXXX', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"PagingInfo\\": {\\n \\"ResourceGroupList\\": [\\n {\\n \\"Id\\": \\"Serverless_res_group_524257424564736_6831777003XXXXX\\",\\n \\"Name\\": \\"common_resource_group\\",\\n \\"Remark\\": \\"创建用于普通任务的通用资源组\\",\\n \\"PaymentType\\": \\"PrePaid\\",\\n \\"Status\\": \\"Normal\\",\\n \\"Spec\\": {\\n \\"Standard\\": \\"2CU\\",\\n \\"Amount\\": 1\\n },\\n \\"ResourceGroupType\\": \\"CommonV2\\",\\n \\"OrderInstanceId\\": \\"c442b330-3b10-4584-959e-736e4edXXXXX\\",\\n \\"CreateUser\\": \\"11075500042XXXXX\\",\\n \\"CreateTime\\": 1727055811000,\\n \\"DefaultVpcId\\": \\"vpc-m2et4f3oc8msfbccXXXXX\\",\\n \\"DefaultVswicthId\\": \\"vsw-uf8usrhs7hjd9amsXXXXX\\",\\n \\"AliyunResourceGroupId\\": \\"rg-aek2kqofrgXXXXX\\",\\n \\"AliyunResourceTags\\": [\\n {\\n \\"Key\\": \\"Key\\",\\n \\"Value\\": \\"Value\\"\\n }\\n ]\\n }\\n ],\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 100,\\n \\"TotalCount\\": 100\\n },\\n \\"RequestId\\": \\"6A6CBE87-9F91-1323-B680-E7A7065XXXXX\\"\\n}","type":"json"}]', + 'title' => '获取资源组列表', + 'description' => '需要购买DataWorks基础版及以上版本才能使用。', + ], + 'DissociateProjectFromResourceGroup' => [ + 'summary' => '将资源组和某个工作空间解除关联。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '245167', + 'abilityTreeNodes' => [ + 'FEATUREdide2SV6DS', + ], + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'ResourceGroupId', + 'in' => 'formData', + 'schema' => [ + 'title' => '资源组唯一标识', + 'description' => '资源组唯一标识', + 'type' => 'string', + 'required' => true, + 'example' => 'Serverless_res_group_524257424564736_6831777003XXXXX', + ], + ], + [ + 'name' => 'ProjectId', + 'in' => 'formData', + 'schema' => [ + 'title' => '解绑的工作空间ID', + 'description' => '解绑的工作空间ID', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1000', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'Success' => [ + 'title' => '是否请求成功', + 'description' => '是否请求成功', + 'type' => 'boolean', + 'example' => 'true', + 'default' => 'true', + ], + 'RequestId' => [ + 'title' => '请求的ID，用于定位日志，排查问题', + 'description' => '请求的ID，用于定位日志，排查问题', + 'type' => 'string', + 'example' => '6A6CBE87-9F91-1323-B680-E7A7065XXXXX', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"6A6CBE87-9F91-1323-B680-E7A7065XXXXX\\"\\n}","type":"json"}]', + 'title' => '将资源组和某个工作空间解除关联', + 'description' => '1. 需要购买DataWorks基础版及以上版本才能使用。'."\n" + .'2. 需要在DataWorks项目空间中具有如下至少一种角色：'."\n" + .'- 租户所有者、空间管理员、项目所有者、运维', + ], + 'AssociateProjectToResourceGroup' => [ + 'summary' => '关联资源组到某个工作空间。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '245168', + 'abilityTreeNodes' => [ + 'FEATUREdide2SV6DS', + ], + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'ResourceGroupId', + 'in' => 'formData', + 'schema' => [ + 'title' => '资源组唯一标识', + 'description' => '资源组唯一标识', + 'type' => 'string', + 'required' => true, + 'example' => 'Serverless_res_group_524257424564736_6831777003XXXXX', + ], + ], + [ + 'name' => 'ProjectId', + 'in' => 'formData', + 'schema' => [ + 'title' => '要绑定的工作空间ID', + 'description' => '要绑定的工作空间ID', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1000', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'Success' => [ + 'title' => '是否请求成功', + 'description' => '是否请求成功', + 'type' => 'boolean', + 'example' => 'true', + 'default' => 'true', + ], + 'RequestId' => [ + 'title' => '请求的ID，用于定位日志，排查问题', + 'description' => '请求的ID，用于定位日志，排查问题', + 'type' => 'string', + 'example' => '6A6CBE87-9F91-1323-B680-E7A7065XXXXX', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"6A6CBE87-9F91-1323-B680-E7A7065XXXXX\\"\\n}","type":"json"}]', + 'title' => '关联资源组到某个工作空间', + 'description' => '1. 需要购买DataWorks基础版及以上版本才能使用。'."\n" + .'2. 需要在DataWorks项目空间中具有如下至少一种角色：'."\n" + .'- 租户所有者、空间管理员、项目所有者、运维', + ], + 'ListResourceGroupAssociateProjects' => [ + 'summary' => '获取资源组绑定工作空间列表。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREdide2SV6DS', + ], + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'title' => '通用资源组唯一标识', + 'description' => '通用资源组唯一标识', + 'type' => 'string', + 'required' => true, + 'example' => 'Serverless_res_group_524257424564736_6831777003****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'Success' => [ + 'title' => '是否请求成功', + 'description' => '是否请求成功', + 'type' => 'boolean', + 'example' => 'true', + 'default' => 'true', + ], + 'ProjectIdList' => [ + 'title' => '项目空间ID列表', + 'description' => '项目空间ID列表', + 'type' => 'array', + 'items' => [ + 'title' => '项目空间ID', + 'description' => '项目空间ID', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '123', + ], + ], + 'RequestId' => [ + 'title' => '请求的ID，用于定位日志，排查问题', + 'description' => '请求的ID，用于定位日志，排查问题', + 'type' => 'string', + 'example' => '6A6CBE87-9F91-1323-B680-E7A7065XXXXX'."\n", + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"ProjectIdList\\": [\\n 123\\n ],\\n \\"RequestId\\": \\"6A6CBE87-9F91-1323-B680-E7A7065XXXXX\\\\n\\"\\n}","type":"json"}]', + 'title' => '获取资源组绑定工作空间列表', + 'description' => '1. 需要购买DataWorks基础版及以上版本才能使用。'."\n" + .'2. **请确保在使用该接口前，已创建服务关联角色 AliyunServiceRoleForDataWorks。**'."\n" + .'3. 本接口仅返回当前调用者具备访问权限的工作空间，未授权的工作空间不会出现在返回结果中。', + ], + 'ListResourceGroupMetricData' => [ + 'summary' => '查询资源组指标数据。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREdide2SV6DS', + ], + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'ResourceGroupId', + 'in' => 'formData', + 'schema' => [ + 'title' => '通用资源组唯一标识', + 'description' => '通用资源组唯一标识。', + 'type' => 'string', + 'required' => true, + 'example' => 'Serverless_res_group_524257424564736_6831777003XXXXX', + ], + ], + [ + 'name' => 'MetricName', + 'in' => 'formData', + 'schema' => [ + 'title' => '指标名称', + 'description' => '指标名称，可选指标有：'."\n" + ."\n" + .'- CUSpec：资源组最大CU容量，单位，CU。'."\n" + .'- CUUsage：资源组CU使用量，单位：CU。'."\n" + .'- CUUtilization：资源组CU使用率，单位：%。'."\n" + .'- SlotSpec：资源组调度最大并发数，单位，slot。'."\n" + .'- SlotUsage：资源组调度已使用并发数，单位，slot。'."\n" + .'- SchedulerCUMaxSpec：数据计算用途最大CU配额，单位，CU。'."\n" + .'- SchedulerCUUsage：数据计算用途CU使用量，单位，CU。'."\n" + .'- SchedulerCUMinSpec：数据计算用途最低保障CU，单位，CU。'."\n" + .'- DataIntegrationCUMaxSpec：数据集成用途最大CU配额，单位，CU。'."\n" + .'- DataIntegrationCUUsage：数据集成用途CU使用量，单位，CU。'."\n" + .'- DataIntegrationCUMinSpec：数据集成用途最低保障CU，单位，CU。'."\n" + .'- DataServiceCUMaxSpec：数据服务用途最大CU配额，单位，CU。'."\n" + .'- DataServiceCUUsage：数据服务用途CU使用量，单位，CU。'."\n" + .'- DataServiceCUMinSpec：数据服务用途最低保障CU，单位，CU。'."\n" + .'- ServerIdeCUMaxSpec：个人开发环境用途最大CU配额，单位，CU。'."\n" + .'- ServerIdeCUUsage：个人开发环境用途CU使用量，单位，CU。'."\n" + .'- ServerIdeCUMinSpec：个人开发环境用途最低保障CU，单位，CU。', + 'type' => 'string', + 'required' => true, + 'enumValueTitles' => [], + 'example' => 'CUSpec', + 'enum' => [ + 'CUSpec', + 'CUUsage', + 'CUUtilization', + 'SlotSpec', + 'SlotUsage', + 'SchedulerCUMaxSpec', + 'SchedulerCUUsage', + 'SchedulerCUMinSpec', + 'DataIntegrationCUMaxSpec', + 'DataIntegrationCUUsage', + 'DataIntegrationCUMinSpec', + 'DataServiceCUMaxSpec', + 'DataServiceCUUsage', + 'DataServiceCUMinSpec', + 'ServerIdeCUMaxSpec', + 'ServerIdeCUUsage', + 'ServerIdeCUMinSpec', + ], + ], + ], + [ + 'name' => 'Period', + 'in' => 'formData', + 'schema' => [ + 'title' => '监控数据的统计周期。'."\n" + .'取值：60的倍数。'."\n" + .'单位：秒。', + 'description' => '监控数据的统计周期。'."\n" + ."\n" + .'取值：60的倍数。'."\n" + ."\n" + .'单位：秒。'."\n" + ."\n" + .'默认值：60。', + 'type' => 'string', + 'required' => false, + 'example' => '60', + ], + ], + [ + 'name' => 'BeginTime', + 'in' => 'formData', + 'schema' => [ + 'title' => '开始时间。支持的格式：'."\n" + .'Unix 时间戳：从 1970 年 1 月 1 日开始所经过的毫秒数。'."\n" + .'BeginTime 和 EndTime 之间的间隔小于等于 31 天。', + 'description' => '开始时间。'."\n" + ."\n" + .'支持的格式：Unix 时间戳：从 1970 年 1 月 1 日开始所经过的毫秒数。'."\n" + ."\n" + .'BeginTime 和 EndTime 之间的间隔小于等于 31 天。'."\n" + ."\n" + .'默认值：当前时间 - 2小时，以毫秒级 Unix 时间戳格式表示。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'minimum' => '0', + 'example' => '1593950832000', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'formData', + 'schema' => [ + 'title' => '结束时间。支持的格式：'."\n" + .'Unix 时间戳：从 1970 年 1 月 1 日开始所经过的毫秒数。'."\n" + .'BeginTime 和 EndTime 之间的间隔小于等于 31 天。', + 'description' => '结束时间。'."\n" + ."\n" + .'支持的格式：Unix 时间戳：从 1970 年 1 月 1 日开始所经过的毫秒数。'."\n" + ."\n" + .'BeginTime 和 EndTime 之间的间隔小于等于 31 天。'."\n" + ."\n" + .'默认值：当前时间，以毫秒级 Unix 时间戳格式表示。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'minimum' => '0', + 'example' => '1750176000000', + ], + ], + [ + 'name' => 'NextToken', + 'in' => 'formData', + 'schema' => [ + 'title' => '分页游标标识。'."\n" + .'说明：如果不设置该参数，则表示获取第一页的数据。当该参数有返回值时，说明还有下一页，您可以将返回的 NextToken 作为参数再次请求获得下一页的数据，直到返回为 Null 为止，表示获取到了所有的数据。', + 'description' => '分页游标标识。'."\n" + ."\n" + .'> 如果不设置该参数，则表示获取第一页的数据。当该参数有返回值时，说明还有下一页，您可以将返回的 NextToken 作为参数再次请求获得下一页的数据，直到返回为 Null 为止，表示获取到了所有的数据。', + 'type' => 'string', + 'required' => false, + 'example' => 'FFqBJBxE8I0PE0IUO6K69k7m2FfyWNNc2qQ9ReUkazhz9VA7dWZKlxBcjUwOV0imSM', + ], + ], + [ + 'name' => 'Length', + 'in' => 'formData', + 'schema' => [ + 'title' => '每页显示的记录条数，用于分页查询。'."\n" + .'说明：单次请求 Length 的最大值为 1440。', + 'description' => '每页显示的记录条数，用于分页查询。'."\n" + .'> 单次请求 Length 的最大值为 1440。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '1440', + 'minimum' => '0', + 'example' => '100', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'Success' => [ + 'title' => '是否请求成功', + 'description' => '是否请求成功。', + 'type' => 'boolean', + 'example' => 'true', + 'default' => 'true', + ], + 'MetricData' => [ + 'title' => '监控指标数据', + 'description' => '监控指标数据。', + 'type' => 'object', + 'properties' => [ + 'Id' => [ + 'title' => '资源组唯一标识', + 'description' => '资源组唯一标识。', + 'type' => 'string', + 'example' => 'Serverless_res_group_524257424564736_6831777003XXXXX'."\n", + ], + 'MetricName' => [ + 'title' => '指标名称', + 'description' => '指标名称，可选指标有：'."\n" + ."\n" + .'- CUSpec：资源组最大CU容量，单位，CU。'."\n" + .'- CUUsage：资源组CU使用量，单位：CU。'."\n" + .'- CUUtilization：资源组CU使用率，单位：%。'."\n" + .'- SlotSpec：资源组调度最大并发数，单位，slot。'."\n" + .'- SlotUsage：资源组调度已使用并发数，单位，slot。'."\n" + .'- SchedulerCUMaxSpec：数据计算用途最大CU配额，单位，CU。'."\n" + .'- SchedulerCUUsage：数据计算用途CU使用量，单位，CU。'."\n" + .'- SchedulerCUMinSpec：数据计算用途最低保障CU，单位，CU。'."\n" + .'- DataIntegrationCUMaxSpec：数据集成用途最大CU配额，单位，CU。'."\n" + .'- DataIntegrationCUUsage：数据集成用途CU使用量，单位，CU。'."\n" + .'- DataIntegrationCUMinSpec：数据集成用途最低保障CU，单位，CU。'."\n" + .'- DataServiceCUMaxSpec：数据服务用途最大CU配额，单位，CU。'."\n" + .'- DataServiceCUUsage：数据服务用途CU使用量，单位，CU。'."\n" + .'- DataServiceCUMinSpec：数据服务用途最低保障CU，单位，CU。'."\n" + .'- ServerIdeCUMaxSpec：个人开发环境用途最大CU配额，单位，CU。'."\n" + .'- ServerIdeCUUsage：个人开发环境用途CU使用量，单位，CU。'."\n" + .'- ServerIdeCUMinSpec：个人开发环境用途最低保障CU，单位，CU。', + 'type' => 'string', + 'example' => 'CUSpec', + ], + 'NextToken' => [ + 'title' => '分页游标标识', + 'description' => '分页游标标识。', + 'type' => 'string', + 'example' => 'tSBOXZcAmk+akxRkwRuXnGQEsIDODyd5ulPqgytNTbLp4bhb7fuvz13FXtm87Kfl', + ], + 'Metrics' => [ + 'title' => '指标数据列表', + 'description' => '指标数据列表。', + 'type' => 'array', + 'items' => [ + 'title' => '指标数据', + 'description' => '指标数据。', + 'type' => 'object', + 'properties' => [ + 'Value' => [ + 'title' => '指标数据值', + 'description' => '指标数据值。', + 'type' => 'number', + 'format' => 'double', + 'example' => '1.0', + ], + 'Timestamp' => [ + 'title' => '时间戳', + 'description' => '时间戳。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1761184929633', + ], + ], + ], + ], + ], + ], + 'RequestId' => [ + 'title' => '请求的ID，用于定位日志，排查问题', + 'description' => '请求的ID，用于定位日志，排查问题。', + 'type' => 'string', + 'example' => '6A6CBE87-9F91-1323-B680-E7A7065XXXXX'."\n", + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"MetricData\\": {\\n \\"Id\\": \\"Serverless_res_group_524257424564736_6831777003XXXXX\\\\n\\",\\n \\"MetricName\\": \\"CUSpec\\",\\n \\"NextToken\\": \\"tSBOXZcAmk+akxRkwRuXnGQEsIDODyd5ulPqgytNTbLp4bhb7fuvz13FXtm87Kfl\\",\\n \\"Metrics\\": [\\n {\\n \\"Value\\": 1,\\n \\"Timestamp\\": 1761184929633\\n }\\n ]\\n },\\n \\"RequestId\\": \\"6A6CBE87-9F91-1323-B680-E7A7065XXXXX\\\\n\\"\\n}","type":"json"}]', + 'title' => '查询资源组指标数据', + 'description' => '1. 需要购买DataWorks基础版及以上版本才能使用。'."\n" + .'2. **请确保在使用该接口前，已创建服务关联角色 AliyunServiceRoleForDataWorks。**'."\n" + .'3. 该接口只适用于Serverless资源组。', + ], + 'CreateRoute' => [ + 'summary' => '创建网络资源的路由。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '245176', + 'abilityTreeNodes' => [ + 'FEATUREdide2SV6DS', + ], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'NetworkId', + 'in' => 'formData', + 'schema' => [ + 'title' => '网络资源ID', + 'description' => '网络资源ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '10001', + ], + ], + [ + 'name' => 'DestinationCidr', + 'in' => 'formData', + 'schema' => [ + 'title' => '路由目的的CIDR', + 'description' => '路由目的的CIDR。', + 'type' => 'string', + 'required' => true, + 'example' => '192.168.0.0/16', + ], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'formData', + 'schema' => [ + 'title' => '所属通用资源组的唯一标识', + 'description' => '所属通用资源组的唯一标识', + 'type' => 'string', + 'required' => false, + 'example' => 'Serverless_res_group_524257424564736_6831777003XXXXX', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'Success' => [ + 'title' => '是否请求成功', + 'description' => '是否请求成功。', + 'type' => 'boolean', + 'example' => 'true', + 'default' => 'true', + ], + 'Id' => [ + 'title' => '创建的路由ID', + 'description' => '创建的路由ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1000', + ], + 'RequestId' => [ + 'title' => '请求的ID，用于定位日志，排查问题', + 'description' => '请求的ID，用于定位日志，排查问题。', + 'type' => 'string', + 'example' => '6A6CBE87-9F91-1323-B680-E7A7065XXXXX', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"Id\\": 1000,\\n \\"RequestId\\": \\"6A6CBE87-9F91-1323-B680-E7A7065XXXXX\\"\\n}","type":"json"}]', + 'title' => '创建网络资源的路由', + 'description' => '需要购买DataWorks基础版及以上版本才能使用。', + ], + 'DeleteRoute' => [ + 'summary' => '删除网络资源的路由。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'abilityTreeCode' => '245174', + 'abilityTreeNodes' => [ + 'FEATUREdide2SV6DS', + ], + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'Id', + 'in' => 'formData', + 'schema' => [ + 'title' => '网络资源的路由ID', + 'description' => '网络资源的路由ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1000', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'Success' => [ + 'title' => '是否请求成功', + 'description' => '是否请求成功。', + 'type' => 'boolean', + 'example' => 'true', + 'default' => 'true', + ], + 'RequestId' => [ + 'title' => '请求的ID，用于定位日志，排查问题', + 'description' => '请求的ID，用于定位日志，排查问题。', + 'type' => 'string', + 'example' => '6A6CBE87-9F91-1323-B680-E7A7065****', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"6A6CBE87-9F91-1323-B680-E7A7065****\\"\\n}","type":"json"}]', + 'title' => '删除网络资源的路由', + 'description' => '需要购买DataWorks基础版及以上版本才能使用。', + ], + 'UpdateRoute' => [ + 'summary' => '更新路由信息。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '245175', + 'abilityTreeNodes' => [ + 'FEATUREdide2SV6DS', + ], + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'Id', + 'in' => 'formData', + 'schema' => [ + 'title' => '网络资源的路由ID', + 'description' => '网络资源的路由ID', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1000', + ], + ], + [ + 'name' => 'DestinationCidr', + 'in' => 'formData', + 'schema' => [ + 'title' => '更新的路由目的的CIDR', + 'description' => '更新的路由目的的CIDR', + 'type' => 'string', + 'required' => true, + 'example' => '192.168.0.0/16', + 'enum' => [], + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'Success' => [ + 'title' => '是否请求成功', + 'description' => '是否请求成功', + 'type' => 'boolean', + 'example' => 'true', + 'default' => 'true', + ], + 'RequestId' => [ + 'title' => '请求的ID，用于定位日志，排查问题', + 'description' => '请求的ID，用于定位日志，排查问题', + 'type' => 'string', + 'example' => '6A6CBE87-9F91-1323-B680-E7A7065****', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"6A6CBE87-9F91-1323-B680-E7A7065****\\"\\n}","type":"json"}]', + 'title' => '更新路由信息', + 'description' => '需要购买DataWorks基础版及以上版本才能使用。', + ], + 'GetRoute' => [ + 'summary' => '根据ID获取指定路由信息。', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '245172', + 'abilityTreeNodes' => [ + 'FEATUREdide2SV6DS', + ], + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'Id', + 'in' => 'query', + 'schema' => [ + 'title' => '路由ID', + 'description' => '路由ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1000', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'Success' => [ + 'title' => '是否请求成功', + 'description' => '是否请求成功。', + 'type' => 'boolean', + 'example' => 'true', + 'default' => 'true', + ], + 'Route' => [ + 'title' => '路由详细信息', + 'description' => '路由详细信息。', + 'type' => 'object', + 'properties' => [ + 'Id' => [ + 'title' => '路由ID', + 'description' => '路由ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1000', + ], + 'ResourceGroupId' => [ + 'title' => '所属资源组唯一标识', + 'description' => '所属资源组唯一标识。', + 'type' => 'string', + 'example' => 'Serverless_res_group_524257424564736_6831777****', + ], + 'ResourceId' => [ + 'title' => '所属网络资源唯一标识', + 'description' => '所属网络资源唯一标识。', + 'type' => 'string', + 'example' => 'ns-679XXXXX', + ], + 'DestinationCidr' => [ + 'title' => '目的路由CIDR', + 'description' => '目的路由CIDR。', + 'type' => 'string', + 'example' => '192.168.0.0/16', + ], + 'CreateTime' => [ + 'title' => '创建时间，为64位时间戳', + 'description' => '创建时间，为64位时间戳。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1727055811000', + ], + 'NetworkId' => [ + 'title' => '所属网络资源ID', + 'description' => '所属网络ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1000', + ], + ], + ], + 'RequestId' => [ + 'title' => '请求的ID，用于定位日志，排查问题', + 'description' => '请求的ID，用于定位日志，排查问题。', + 'type' => 'string', + 'example' => '6A6CBE87-9F91-1323-B680-E7A7065XXXXX', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"Route\\": {\\n \\"Id\\": 1000,\\n \\"ResourceGroupId\\": \\"Serverless_res_group_524257424564736_6831777****\\",\\n \\"ResourceId\\": \\"ns-679XXXXX\\",\\n \\"DestinationCidr\\": \\"192.168.0.0/16\\",\\n \\"CreateTime\\": 1727055811000,\\n \\"NetworkId\\": 1000\\n },\\n \\"RequestId\\": \\"6A6CBE87-9F91-1323-B680-E7A7065XXXXX\\"\\n}","type":"json"}]', + 'title' => '根据ID获取指定路由信息', + 'description' => '需要购买DataWorks基础版及以上版本才能使用。', + ], + 'ListRoutes' => [ + 'summary' => '获取网络资源的路由列表。', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '245173', + 'abilityTreeNodes' => [ + 'FEATUREdide2SV6DS', + ], + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'title' => '通用资源组唯一标识', + 'description' => '通用资源组唯一标识', + 'type' => 'string', + 'required' => true, + 'example' => 'Serverless_res_group_524257424564736_6831777003XXXXX', + ], + ], + [ + 'name' => 'NetworkId', + 'in' => 'query', + 'schema' => [ + 'title' => '网络资源ID', + 'description' => '网络资源ID', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1000', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'title' => '分页大小', + 'description' => '分页大小', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '100', + 'default' => '100', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'title' => '分页页码', + 'description' => '分页页码', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + 'default' => '1', + ], + ], + [ + 'name' => 'SortBy', + 'in' => 'query', + 'schema' => [ + 'title' => '排序字段列表，支持定时时间、开始时间等字段。格式为"排序字段+排序方式(Desc/Asc)"（Asc可以缺省）。排序字段的枚举值如下：'."\n" + .'● Id (Desc/Asc)：路由ID'."\n" + .'● DestinationCidr (Desc/Asc)：目的CIDR'."\n" + .'● CreateTime (Desc/Asc)：创建时间'."\n" + .'默认为CreateTime Asc'."\n", + 'description' => '排序字段列表，支持定时时间、开始时间等字段。格式为"排序字段+排序方式(Desc/Asc)"（Asc可以缺省）。排序字段的枚举值如下：'."\n" + ."\n" + .'- Id (Desc/Asc)：路由ID'."\n" + .'- DestinationCidr (Desc/Asc)：目的CIDR'."\n" + .'- CreateTime (Desc/Asc)：创建时间'."\n" + ."\n" + .'默认为CreateTime Asc', + 'type' => 'string', + 'required' => false, + 'example' => 'CreateTime Asc', + 'default' => 'CreateTime Asc', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'Success' => [ + 'title' => '是否请求成功', + 'description' => '是否请求成功', + 'type' => 'boolean', + 'example' => 'true', + 'default' => 'true', + ], + 'PagingInfo' => [ + 'title' => '分页列表', + 'description' => '分页列表', + 'type' => 'object', + 'properties' => [ + 'RouteList' => [ + 'title' => '获取到的网络资源路由信息列表', + 'description' => '获取到的网络资源路由信息列表', + 'type' => 'array', + 'items' => [ + 'title' => '路由详细信息', + 'description' => '路由详细信息', + 'type' => 'object', + 'properties' => [ + 'Id' => [ + 'title' => '路由ID', + 'description' => '路由ID', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1000', + ], + 'ResourceGroupId' => [ + 'title' => '所属资源组唯一标识符', + 'description' => '所属资源组唯一标识符', + 'type' => 'string', + 'example' => 'Serverless_res_group_524257424564736_6831777003****', + ], + 'ResourceId' => [ + 'title' => '网络资源唯一标识符', + 'description' => '网络资源唯一标识符', + 'type' => 'string', + 'example' => 'ns-679XXXXXX', + ], + 'DestinationCidr' => [ + 'title' => '路由目的CIDR', + 'description' => '路由目的CIDR', + 'type' => 'string', + 'example' => '192.168.0.0/16', + ], + 'CreateTime' => [ + 'title' => '创建时间，为64位时间戳', + 'description' => '创建时间，为64位时间戳', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1727055811000', + ], + 'NetworkId' => [ + 'title' => '所属网络资源ID', + 'description' => '所属网络资源ID', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1000', + ], + ], + ], + ], + 'PageNumber' => [ + 'title' => '分页页码', + 'description' => '分页页码', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + 'default' => '1', + ], + 'PageSize' => [ + 'title' => '分页大小', + 'description' => '分页大小', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '100', + 'default' => '100', + ], + 'TotalCount' => [ + 'title' => '全部数据条目', + 'description' => '全部数据条目', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '100', + ], + ], + ], + 'RequestId' => [ + 'title' => '请求的ID，用于定位日志，排查问题', + 'description' => '请求的ID，用于定位日志，排查问题', + 'type' => 'string', + 'example' => '6A6CBE87-9F91-1323-B680-E7A7065XXXXX', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"PagingInfo\\": {\\n \\"RouteList\\": [\\n {\\n \\"Id\\": 1000,\\n \\"ResourceGroupId\\": \\"Serverless_res_group_524257424564736_6831777003****\\",\\n \\"ResourceId\\": \\"ns-679XXXXXX\\",\\n \\"DestinationCidr\\": \\"192.168.0.0/16\\",\\n \\"CreateTime\\": 1727055811000,\\n \\"NetworkId\\": 1000\\n }\\n ],\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 100,\\n \\"TotalCount\\": 100\\n },\\n \\"RequestId\\": \\"6A6CBE87-9F91-1323-B680-E7A7065XXXXX\\"\\n}","type":"json"}]', + 'title' => '获取网络资源的路由列表', + 'description' => '需要购买DataWorks基础版及以上版本才能使用。', + ], + 'CreateNetwork' => [ + 'summary' => '创建并绑定通用资源组网络资源。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '245180', + 'abilityTreeNodes' => [ + 'FEATUREdide2SV6DS', + ], + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'ResourceGroupId', + 'in' => 'formData', + 'schema' => [ + 'title' => '所属通用资源组的唯一标识', + 'description' => '所属通用资源组的唯一标识。', + 'type' => 'string', + 'required' => true, + 'example' => 'Serverless_res_group_524257424564736_6831777003****', + ], + ], + [ + 'name' => 'VpcId', + 'in' => 'formData', + 'schema' => [ + 'title' => '网络资源的VPC ID', + 'description' => '网络资源的VPC ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'vpc-m2et4f3oc8msfbccXXXXX', + ], + ], + [ + 'name' => 'VswitchId', + 'in' => 'formData', + 'schema' => [ + 'title' => '网络资源的交换机ID', + 'description' => '网络资源的交换机ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'vsw-uf8usrhs7hjd9amsXXXXX', + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'formData', + 'schema' => [ + 'title' => '客户端幂等性标识，用于保证创建网络资源操作的幂等性', + 'description' => '客户端幂等性标识，用于保证创建网络资源操作的幂等性。', + 'type' => 'string', + 'required' => true, + 'example' => 'eb870033-74c8-4b1b-9664-04c4e7cc3465', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'Success' => [ + 'title' => '是否请求成功', + 'description' => '是否请求成功。', + 'type' => 'boolean', + 'example' => 'true', + 'default' => 'true', + ], + 'Id' => [ + 'title' => '创建的网络资源ID', + 'description' => '创建的网络资源ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1000', + ], + 'RequestId' => [ + 'title' => '请求的ID，用于定位日志，排查问题', + 'description' => '请求的ID，用于定位日志，排查问题。', + 'type' => 'string', + 'example' => '6A6CBE87-9F91-1323-B680-E7A7065XXXXX', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"Id\\": 1000,\\n \\"RequestId\\": \\"6A6CBE87-9F91-1323-B680-E7A7065XXXXX\\"\\n}","type":"json"}]', + 'title' => '创建资源组网络', + 'description' => '需要购买DataWorks基础版及以上版本才能使用。', + ], + 'DeleteNetwork' => [ + 'summary' => '解绑并删除通用资源组网络资源。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '245179', + 'abilityTreeNodes' => [ + 'FEATUREdide2SV6DS', + ], + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'Id', + 'in' => 'formData', + 'schema' => [ + 'title' => '删除的网络资源ID', + 'description' => '删除的网络资源ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1000', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'Success' => [ + 'title' => '是否请求成功', + 'description' => '是否请求成功。', + 'type' => 'boolean', + 'example' => 'true', + 'default' => 'true', + ], + 'RequestId' => [ + 'title' => '请求的ID，用于定位日志，排查问题', + 'description' => '请求的ID，用于定位日志，排查问题。', + 'type' => 'string', + 'example' => '6A6CBE87-9F91-1323-B680-E7A7065****', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"6A6CBE87-9F91-1323-B680-E7A7065****\\"\\n}","type":"json"}]', + 'title' => '解绑并删除通用资源组网络资源', + 'description' => '需要购买DataWorks基础版及以上版本才能使用。', + ], + 'GetNetwork' => [ + 'summary' => '获取某个网络资源详细信息。', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '245177', + 'abilityTreeNodes' => [ + 'FEATUREdide2SV6DS', + ], + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'Id', + 'in' => 'query', + 'schema' => [ + 'title' => '网络资源ID', + 'description' => '网络资源ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1000', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'Success' => [ + 'title' => '是否请求成功', + 'description' => '是否请求成功。', + 'type' => 'boolean', + 'example' => 'true', + 'default' => 'true', + ], + 'Network' => [ + 'title' => '获取到的网络资源详细信息', + 'description' => '获取到的网络资源详细信息。', + 'type' => 'object', + 'properties' => [ + 'Id' => [ + 'title' => '网络资源ID', + 'description' => '网络资源ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1000', + ], + 'ResourceGroupId' => [ + 'title' => '所属通用资源组的唯一标识', + 'description' => '所属通用资源组的唯一标识。', + 'type' => 'string', + 'example' => 'Serverless_res_group_524257424564736_6831777003XXXXX', + ], + 'VpcId' => [ + 'title' => '网络资源的VPC ID', + 'description' => '网络资源的VPC ID。', + 'type' => 'string', + 'example' => 'vpc-m2et4f3oc8msfbccXXXXX', + ], + 'VswitchId' => [ + 'title' => '网络资源的交换机ID', + 'description' => '网络资源的交换机ID。', + 'type' => 'string', + 'example' => 'vsw-uf8usrhs7hjd9amsXXXXX', + ], + 'SecurityGroupId' => [ + 'title' => '网络资源的安全组ID', + 'description' => '网络资源的安全组ID。', + 'type' => 'string', + 'example' => 'sg-2ze13vamugr7jenXXXXX', + ], + 'Status' => [ + 'title' => '当前网络资源状态，Pending代表等待，Creating代表创建中，Running代表正常运行中，Deleting代表删除中，Deleted代表已删除', + 'description' => '当前网络资源状态：'."\n" + ."\n" + .'- Pending代表等待；'."\n" + .'- Creating代表创建中；'."\n" + .'- Running代表正常运行中；'."\n" + .'- Deleting代表删除中；'."\n" + .'- Deleted代表已删除。', + 'type' => 'string', + 'enumValueTitles' => [], + 'example' => 'Running', + 'enum' => [ + 'Pending', + 'Running', + 'Deleting', + 'Deleted', + 'Creating', + ], + ], + 'CreateUser' => [ + 'title' => '创建该网络资源的用户ID', + 'description' => '创建该网络资源的用户ID。', + 'type' => 'string', + 'example' => '11075500042XXXXX', + ], + 'CreateTime' => [ + 'title' => '创建时间，为64位时间戳', + 'description' => '创建时间，为64位时间戳。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1727055811000', + ], + ], + ], + 'RequestId' => [ + 'title' => '请求的ID，用于定位日志，排查问题', + 'description' => '请求的ID，用于定位日志，排查问题。', + 'type' => 'string', + 'example' => '6A6CBE87-9F91-1323-B680-E7A7065XXXXX', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"Network\\": {\\n \\"Id\\": 1000,\\n \\"ResourceGroupId\\": \\"Serverless_res_group_524257424564736_6831777003XXXXX\\",\\n \\"VpcId\\": \\"vpc-m2et4f3oc8msfbccXXXXX\\",\\n \\"VswitchId\\": \\"vsw-uf8usrhs7hjd9amsXXXXX\\",\\n \\"SecurityGroupId\\": \\"sg-2ze13vamugr7jenXXXXX\\",\\n \\"Status\\": \\"Running\\",\\n \\"CreateUser\\": \\"11075500042XXXXX\\",\\n \\"CreateTime\\": 1727055811000\\n },\\n \\"RequestId\\": \\"6A6CBE87-9F91-1323-B680-E7A7065XXXXX\\"\\n}","type":"json"}]', + 'title' => '获取某个网络资源详细信息', + 'description' => '需要购买DataWorks基础版及以上版本才能使用。', + ], + 'ListNetworks' => [ + 'summary' => '获取资源组网络资源列表。', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '245178', + 'abilityTreeNodes' => [ + 'FEATUREdide2SV6DS', + ], + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'title' => '通用资源组唯一标识', + 'description' => '通用资源组唯一标识', + 'type' => 'string', + 'required' => true, + 'example' => 'Serverless_res_group_524257424564736_6831777003****', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '分页大小', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '分页页码', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'SortBy', + 'in' => 'query', + 'schema' => [ + 'title' => '排序字段列表，支持定时时间、开始时间等字段。格式为"排序字段+排序方式(Desc/Asc)"（Asc可以缺省）。排序字段的枚举值如下：'."\n" + .'● Id (Desc/Asc)：网络ID'."\n" + .'● Status (Desc/Asc)：网络状态'."\n" + .'● CreateUser (Desc/Asc)：创建用户'."\n" + .'● CreateTime (Desc/Asc)：创建时间'."\n" + .'默认值为CreateTime Asc', + 'description' => '排序字段列表，支持定时时间、开始时间等字段。格式为"排序字段+排序方式(Desc/Asc)"（Asc可以缺省）。排序字段的枚举值如下：'."\n" + ."\n" + .'- Id (Desc/Asc)：网络ID'."\n" + .'- Status (Desc/Asc)：网络状态'."\n" + .'- CreateUser (Desc/Asc)：创建用户'."\n" + .'- CreateTime (Desc/Asc)：创建时间'."\n" + ."\n" + .'默认值为CreateTime Asc', + 'type' => 'string', + 'required' => false, + 'example' => 'CreateTime Asc', + 'default' => 'CreateTime Asc', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'Success' => [ + 'title' => '是否请求成功', + 'description' => '是否请求成功', + 'type' => 'boolean', + 'example' => 'true', + 'default' => 'true', + ], + 'PagingInfo' => [ + 'title' => '分页列表', + 'description' => '分页列表', + 'type' => 'object', + 'properties' => [ + 'NetworkList' => [ + 'title' => '获取到的通用资源组网络资源详细信息列表', + 'description' => '获取到的通用资源组网络资源详细信息列表', + 'type' => 'array', + 'items' => [ + 'title' => '网络资源详细信息', + 'description' => '网络资源详细信息', + 'type' => 'object', + 'properties' => [ + 'Id' => [ + 'title' => '网络资源ID', + 'description' => '网络资源ID', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1000', + ], + 'ResourceGroupId' => [ + 'title' => '所属通用资源组的唯一标识', + 'description' => '所属通用资源组的唯一标识', + 'type' => 'string', + 'example' => 'Serverless_res_group_524257424564736_6831777003XXXXX', + ], + 'VpcId' => [ + 'title' => '网络资源的VPC ID', + 'description' => '网络资源的VPC ID', + 'type' => 'string', + 'example' => 'vpc-m2et4f3oc8msfbccXXXXX', + ], + 'VswitchId' => [ + 'title' => '网络资源的交换机ID', + 'description' => '网络资源的交换机ID', + 'type' => 'string', + 'example' => 'vsw-uf8usrhs7hjd9amsXXXXX', + ], + 'SecurityGroupId' => [ + 'title' => '网络资源组的安全组ID', + 'description' => '网络资源组的安全组ID', + 'type' => 'string', + 'example' => 'sg-2ze13vamugr7jenXXXXX', + ], + 'Status' => [ + 'title' => '当前网络资源状态，Pending代表等待，Creating代表创建中，Running代表正常运行中，Deleting代表删除中，Deleted代表已删除', + 'description' => '当前网络资源状态，Pending代表等待，Creating代表创建中，Running代表正常运行中，Deleting代表删除中，Deleted代表已删除', + 'type' => 'string', + 'enumValueTitles' => [], + 'example' => 'Running', + 'enum' => [ + 'Pending', + 'Running', + 'Deleting', + 'Deleted', + 'Creating', + ], + ], + 'CreateUser' => [ + 'title' => '创建该网络资源的用户ID', + 'description' => '创建该网络资源的用户ID', + 'type' => 'string', + 'example' => '11075500042XXXXX', + ], + 'CreateTime' => [ + 'title' => '创建时间，为64位时间戳', + 'description' => '创建时间，为64位时间戳', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1727055811000', + ], + ], + ], + ], + 'PageNumber' => [ + 'title' => '分页页码', + 'description' => '分页页码', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + 'default' => '1', + ], + 'PageSize' => [ + 'title' => '分页大小', + 'description' => '分页大小', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '100', + 'default' => '100', + ], + 'TotalCount' => [ + 'title' => '全部数据条目', + 'description' => '全部数据条目', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '100', + ], + ], + ], + 'RequestId' => [ + 'title' => '请求的ID，用于定位日志，排查问题', + 'description' => '请求的ID，用于定位日志，排查问题', + 'type' => 'string', + 'example' => '6A6CBE87-9F91-1323-B680-E7A7065XXXXX', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"PagingInfo\\": {\\n \\"NetworkList\\": [\\n {\\n \\"Id\\": 1000,\\n \\"ResourceGroupId\\": \\"Serverless_res_group_524257424564736_6831777003XXXXX\\",\\n \\"VpcId\\": \\"vpc-m2et4f3oc8msfbccXXXXX\\",\\n \\"VswitchId\\": \\"vsw-uf8usrhs7hjd9amsXXXXX\\",\\n \\"SecurityGroupId\\": \\"sg-2ze13vamugr7jenXXXXX\\",\\n \\"Status\\": \\"Running\\",\\n \\"CreateUser\\": \\"11075500042XXXXX\\",\\n \\"CreateTime\\": 1727055811000\\n }\\n ],\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 100,\\n \\"TotalCount\\": 100\\n },\\n \\"RequestId\\": \\"6A6CBE87-9F91-1323-B680-E7A7065XXXXX\\"\\n}","type":"json"}]', + 'title' => '获取资源组网络资源列表', + 'description' => '需要购买DataWorks基础版及以上版本才能使用。', + ], + 'CreateComponent' => [ + 'summary' => '创建组件。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '236012', + 'abilityTreeNodes' => [ + 'FEATUREdideITYNXL', + ], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'ProjectId', + 'in' => 'formData', + 'schema' => [ + 'description' => '数据源所在的DataWorks工作空间ID。您可以通过[ListProjects](~~2780068~~)接口获取工作空间ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '10000', + ], + ], + [ + 'name' => 'Spec', + 'in' => 'formData', + 'schema' => [ + 'description' => '描述这个工作流的FlowSpec信息，具体规范详见[FlowSpec](https://github.com/aliyun/alibabacloud-dataworks-tool-dflow/)。', + 'type' => 'string', + 'required' => true, + 'example' => '{'."\n" + .' "kind": "Component",'."\n" + .' "name": "com1",'."\n" + .' "spec": {'."\n" + .' "components": ['."\n" + .' {'."\n" + .' "name": "test11",'."\n" + .' "id": "1234",'."\n" + .' "owner": "1234456",'."\n" + .' "description": "",'."\n" + .' "script": {'."\n" + .' "language": "odps-sql",'."\n" + .' "path": "test11",'."\n" + .' "content": "select \'@@{bizdate}\', \'@@{my_input_table}\'",'."\n" + .' "runtime": {'."\n" + .' "command": "SQL_COMPONENT"'."\n" + .' }'."\n" + .' },'."\n" + .' "inputs": ['."\n" + .' {'."\n" + .' "name": "bizdate",'."\n" + .' "type": "string"'."\n" + .' },'."\n" + .' {'."\n" + .' "name": "my_input_table",'."\n" + .' "type": "string"'."\n" + .' }'."\n" + .' ],'."\n" + .' "outputs": ['."\n" + .' {'."\n" + .' "name": "my_output_table1",'."\n" + .' "type": "string"'."\n" + .' }'."\n" + .' ]'."\n" + .' }'."\n" + .' ]'."\n" + .' }'."\n" + .'}', + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'formData', + 'schema' => [ + 'description' => '保留字段。', + 'type' => 'string', + 'required' => false, + 'example' => '1AFAE64E-D1BE-432B-A9****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request', + 'type' => 'string', + 'example' => 'adssd****', + ], + 'ComponentId' => [ + 'description' => '数据集加速组件ID。如何获取组件ID，请参见[ListComponents](~~2979566~~)。', + 'type' => 'string', + 'example' => '123123123123123', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"adssd****\\",\\n \\"ComponentId\\": \\"123123123123123\\"\\n}","type":"json"}]', + 'title' => '创建组件', + 'description' => '><notice>该接口目前不支持批量操作，参数中填写多个发布实体时，除第一个以外的部分会被直接忽略。></notice>', + ], + 'DeleteComponent' => [ + 'summary' => '删除组件。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '236013', + 'abilityTreeNodes' => [ + 'FEATUREdideITYNXL', + ], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'ProjectId', + 'in' => 'formData', + 'schema' => [ + 'description' => 'DataWorks工作空间的ID。您可以登录[DataWorks控制台](https://workbench.data.aliyun.com/console)，进入工作空间管理页面获取ID。'."\n" + ."\n" + .'该参数用来确定本次API调用操作使用的DataWorks工作空间。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1000', + ], + ], + [ + 'name' => 'ComponentId', + 'in' => 'formData', + 'schema' => [ + 'description' => '组件ID。可作为查询导播台组件列表、修改导播台组件的请求参数。', + 'type' => 'string', + 'required' => true, + 'example' => '123123123123', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request', + 'type' => 'string', + 'example' => '0000-ABCD-EF****', + ], + 'Success' => [ + 'description' => '请求是否成功。', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0000-ABCD-EF****\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => '删除组件', + 'description' => '><notice>当这个udf函数被发布后，无法删除，必须先下线再进行删除。></notice>', + ], + 'GetComponent' => [ + 'summary' => '获取组件信息。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '236011', + 'abilityTreeNodes' => [ + 'FEATUREdideITYNXL', + ], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'ProjectId', + 'in' => 'query', + 'schema' => [ + 'description' => 'DataWorks工作空间的ID。您可以登录DataWorks管控台，进入工作空间配置页面获取工作空间ID。该参数与ProjectIdentifier参数，二者必须设置其一，用来确定本次API调用操作的DataWorks工作空间。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '10000', + ], + ], + [ + 'name' => 'ComponentId', + 'in' => 'query', + 'schema' => [ + 'description' => '组件ID。', + 'type' => 'string', + 'required' => true, + 'example' => '1112312312312', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request', + 'type' => 'string', + 'example' => '0000-ABCD-EFG****', + ], + 'Component' => [ + 'description' => 'component模块的JSON序列化。', + 'type' => 'object', + 'properties' => [ + 'ComponentId' => [ + 'description' => '数据集加速组件ID。如何获取组件ID，请参见[ListComponents](~~2979566~~)。', + 'type' => 'string', + 'example' => '43cd873b-235c-44f8-be07-e4d4cf7e73b0', + ], + 'ProjectId' => [ + 'description' => 'DataWorks工作空间的ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '64623', + ], + 'Name' => [ + 'description' => '名称', + 'type' => 'string', + 'example' => 'dim_whse_epet_warehouse_jz_storage_stock_lot_relation_id', + ], + 'Owner' => [ + 'description' => '任务的责任人的账号ID。', + 'type' => 'string', + 'example' => '207316543660665792', + ], + 'CreateTime' => [ + 'description' => '创建时间。', + 'type' => 'string', + 'format' => 'iso8601_normal', + 'example' => '2017-04-27T05:37:05Z', + ], + 'ModifyTime' => [ + 'description' => '修改时间（毫秒级时间戳）', + 'type' => 'string', + 'format' => 'iso8601_normal', + 'example' => '2024-01-26T07:44:21Z', + ], + 'Spec' => [ + 'description' => '描述这个工作流的FlowSpec信息，具体规范详见[FlowSpec](https://github.com/aliyun/alibabacloud-dataworks-tool-dflow/)。', + 'type' => 'string', + 'example' => '{'."\n" + .' "kind": "Component",'."\n" + .' "name": "com1",'."\n" + .' "spec": {'."\n" + .' "components": ['."\n" + .' {'."\n" + .' "name": "test11",'."\n" + .' "id": "8196828925037*****",'."\n" + .' "owner": "054664",'."\n" + .' "description": "",'."\n" + .' "script": {'."\n" + .' "language": "odps-sql",'."\n" + .' "path": "test11",'."\n" + .' "content": "select \'@@{bizdate}\', \'@@{my_input_table}\'",'."\n" + .' "runtime": {'."\n" + .' "command": "SQL_COMPONENT"'."\n" + .' }'."\n" + .' },'."\n" + .' "inputs": ['."\n" + .' {'."\n" + .' "name": "bizdate",'."\n" + .' "type": "string"'."\n" + .' },'."\n" + .' {'."\n" + .' "name": "my_input_table",'."\n" + .' "type": "string"'."\n" + .' }'."\n" + .' ],'."\n" + .' "outputs": ['."\n" + .' {'."\n" + .' "name": "my_output_table1",'."\n" + .' "type": "string"'."\n" + .' }'."\n" + .' ]'."\n" + .' }'."\n" + .' ]'."\n" + .' }'."\n" + .'}', + ], + 'Description' => [ + 'description' => '描述信息。', + 'type' => 'string', + 'example' => 'None', + ], + 'RegionId' => [ + 'description' => '地域信息，通常为服务所在的地域。例如，华东2（上海）为cn-shanghai，华北3（张家口）为cn-zhangjiakou。您无需填写RegionId，会根据调用的Endpoint自动解析。', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 404 => [ + [ + 'errorCode' => 'InvalidComponent.NotFound', + 'errorMessage' => 'The specified Component does not exist.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0000-ABCD-EFG****\\",\\n \\"Component\\": {\\n \\"ComponentId\\": \\"43cd873b-235c-44f8-be07-e4d4cf7e73b0\\",\\n \\"ProjectId\\": 64623,\\n \\"Name\\": \\"dim_whse_epet_warehouse_jz_storage_stock_lot_relation_id\\",\\n \\"Owner\\": \\"207316543660665792\\",\\n \\"CreateTime\\": \\"2017-04-27T05:37:05Z\\",\\n \\"ModifyTime\\": \\"2024-01-26T07:44:21Z\\",\\n \\"Spec\\": \\"{\\\\n \\\\\\"kind\\\\\\": \\\\\\"Component\\\\\\",\\\\n \\\\\\"name\\\\\\": \\\\\\"com1\\\\\\",\\\\n \\\\\\"spec\\\\\\": {\\\\n \\\\\\"components\\\\\\": [\\\\n {\\\\n \\\\\\"name\\\\\\": \\\\\\"test11\\\\\\",\\\\n \\\\\\"id\\\\\\": \\\\\\"8196828925037*****\\\\\\",\\\\n \\\\\\"owner\\\\\\": \\\\\\"054664\\\\\\",\\\\n \\\\\\"description\\\\\\": \\\\\\"\\\\\\",\\\\n \\\\\\"script\\\\\\": {\\\\n \\\\\\"language\\\\\\": \\\\\\"odps-sql\\\\\\",\\\\n \\\\\\"path\\\\\\": \\\\\\"test11\\\\\\",\\\\n \\\\\\"content\\\\\\": \\\\\\"select \'@@{bizdate}\', \'@@{my_input_table}\'\\\\\\",\\\\n \\\\\\"runtime\\\\\\": {\\\\n \\\\\\"command\\\\\\": \\\\\\"SQL_COMPONENT\\\\\\"\\\\n }\\\\n },\\\\n \\\\\\"inputs\\\\\\": [\\\\n {\\\\n \\\\\\"name\\\\\\": \\\\\\"bizdate\\\\\\",\\\\n \\\\\\"type\\\\\\": \\\\\\"string\\\\\\"\\\\n },\\\\n {\\\\n \\\\\\"name\\\\\\": \\\\\\"my_input_table\\\\\\",\\\\n \\\\\\"type\\\\\\": \\\\\\"string\\\\\\"\\\\n }\\\\n ],\\\\n \\\\\\"outputs\\\\\\": [\\\\n {\\\\n \\\\\\"name\\\\\\": \\\\\\"my_output_table1\\\\\\",\\\\n \\\\\\"type\\\\\\": \\\\\\"string\\\\\\"\\\\n }\\\\n ]\\\\n }\\\\n ]\\\\n }\\\\n}\\",\\n \\"Description\\": \\"None\\",\\n \\"RegionId\\": \\"cn-hangzhou\\"\\n }\\n}","type":"json"}]', + 'title' => '获取组件详情', + 'description' => '1. 需要购买DataWorks基础版及以上版本才能使用。', + ], + 'UpdateComponent' => [ + 'summary' => '更新组件。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '236014', + 'abilityTreeNodes' => [ + 'FEATUREdideITYNXL', + ], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'ComponentId', + 'in' => 'formData', + 'schema' => [ + 'description' => '组件ID。', + 'type' => 'string', + 'required' => true, + 'example' => '568780096083*******', + ], + ], + [ + 'name' => 'Spec', + 'in' => 'formData', + 'schema' => [ + 'description' => '描述这个udf函数的FlowSpec信息，具体规范详见[FlowSpec](https://github.com/aliyun/dataworks-spec/blob/master/README_zh_CN.md)。', + 'type' => 'string', + 'required' => true, + 'example' => '{'."\n" + .' "kind": "Component",'."\n" + .' "version": "1.1.2",'."\n" + .' "spec": {'."\n" + .' "components": ['."\n" + .' {'."\n" + .' "id": "568780096083*******",'."\n" + .' "script": {'."\n" + .' "content": "select \'@@{para1}\', \'@@{para2}\'"'."\n" + .' }'."\n" + .' }'."\n" + .' ]'."\n" + .' }'."\n" + .'}', + ], + ], + [ + 'name' => 'ProjectId', + 'in' => 'query', + 'schema' => [ + 'description' => 'DataWorks工作空间的ID。您可以登录[DataWorks控制台](https://workbench.data.aliyun.com/console)，进入工作空间配置页面获取工作空间ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '10000', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '0bc1ec92159376', + ], + 'Success' => [ + 'description' => '请求是否成功。', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0bc1ec92159376\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => '更新组件', + 'description' => '本接口当前处于试用阶段。需要体验的用户可以提出申请，管理员加入试用名单后即可调用。', + ], + 'ListComponents' => [ + 'summary' => '获取组件列表。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '236015', + 'abilityTreeNodes' => [ + 'FEATUREdideITYNXL', + ], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'ProjectId', + 'in' => 'query', + 'schema' => [ + 'description' => '数据源关联的工作空间ID。您可以通过[ListProjects](~~178393~~)接口获取工作空间ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '100001', + ], + ], + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => [ + 'description' => '数据源的名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'xm_create_test', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '请求的数据页数，用于翻页。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '2147483647', + 'minimum' => '1', + 'example' => '1', + 'default' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '每页显示的条数，默认为10条，最大为100条。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '100', + 'minimum' => '10', + 'example' => '1000', + 'default' => '10', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。用于出现错误后排查问题。'."\n", + 'type' => 'string', + 'example' => '952795279527ab****', + ], + 'PagingInfo' => [ + 'description' => '分页信息。', + 'type' => 'object', + 'properties' => [ + 'TotalCount' => [ + 'description' => '总记录数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '100', + ], + 'PageNumber' => [ + 'description' => '分页页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '每页显示的条数', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'Components' => [ + 'description' => '数据集加速组件的创建者的Uid，在阿里云内为RAM用户ID （阿里云账号创建则直接为阿里云账号ID）。', + 'type' => 'array', + 'items' => [ + 'description' => '数据集加速组件的创建者的Uid，在阿里云内为RAM用户ID （阿里云账号创建则直接为阿里云账号ID）。', + 'type' => 'object', + 'properties' => [ + 'ModifyTime' => [ + 'description' => '发布流程修改时间戳。', + 'type' => 'string', + 'format' => 'iso8601_normal', + 'example' => '2023-11-30T13:30:58Z', + ], + 'Script' => [ + 'title' => '脚本信息', + 'description' => '脚本信息', + 'type' => 'object', + 'properties' => [ + 'Path' => [ + 'title' => '脚本路径', + 'description' => '脚本路径', + 'type' => 'string', + 'example' => '/', + 'pattern' => '', + 'default' => '', + ], + 'Runtime' => [ + 'title' => '运行时', + 'description' => '运行时', + 'type' => 'object', + 'properties' => [ + 'Command' => [ + 'title' => '命令', + 'description' => '命令', + 'type' => 'string', + 'example' => 'SQL_COMPONENT', + 'pattern' => '', + 'default' => '', + ], + ], + ], + 'Id' => [ + 'description' => 'ID', + 'type' => 'string', + 'example' => '348100', + ], + ], + ], + 'Owner' => [ + 'title' => '责任人', + 'description' => '责任人', + 'type' => 'string', + 'example' => '252675537980665607', + 'pattern' => '', + 'default' => '', + ], + 'Description' => [ + 'title' => '描述', + 'description' => '描述', + 'type' => 'string', + 'example' => 'vpc peering management_staging', + 'pattern' => '', + 'default' => '', + ], + 'CreateTime' => [ + 'description' => '创建时间。', + 'type' => 'string', + 'format' => 'iso8601_normal', + 'example' => '2023-03-13 16:35:59', + ], + 'Outputs' => [ + 'title' => '输出参数', + 'description' => '输出参数', + 'type' => 'array', + 'items' => [ + 'description' => '节点输出项', + 'type' => 'object', + 'properties' => [ + 'DefaultValue' => [ + 'title' => '默认值', + 'description' => '默认值', + 'type' => 'string', + 'example' => '32000', + 'pattern' => '', + 'default' => '', + ], + 'Type' => [ + 'title' => '参数类型', + 'description' => '参数类型', + 'type' => 'string', + 'example' => 'string', + 'pattern' => '', + 'default' => '', + ], + 'Description' => [ + 'title' => '参数描述', + 'description' => '参数描述', + 'type' => 'string', + 'example' => 'zdy', + 'pattern' => '', + 'default' => '', + ], + 'Name' => [ + 'title' => '参数名称', + 'description' => '参数名称', + 'type' => 'string', + 'example' => 'auto_updateAlertRule_test_bULIRo', + 'pattern' => '', + 'default' => '', + ], + ], + ], + ], + 'ProjectId' => [ + 'description' => 'DataWorks工作空间的ID。您可以登录DataWorks管控台，进入工作空间配置页面获取工作空间ID。该参数与ProjectIdentifier参数，二者必须设置其一，用来确定本次API调用操作的DataWorks工作空间。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '199925', + ], + 'ComponentId' => [ + 'description' => '组件ID。可作为查询导播台组件、修改导播台组件、删除导播台组件的请求参数。', + 'type' => 'string', + 'example' => '12312313123', + ], + 'Inputs' => [ + 'title' => '输入参数', + 'description' => '输入参数', + 'type' => 'array', + 'items' => [ + 'description' => '变量元素', + 'type' => 'object', + 'properties' => [ + 'DefaultValue' => [ + 'title' => '默认值', + 'description' => '默认值', + 'type' => 'string', + 'example' => 'mdb.shard.2x.2xlarge.d', + 'pattern' => '', + 'default' => '', + ], + 'Type' => [ + 'title' => '参数类型', + 'description' => '参数类型', + 'type' => 'string', + 'example' => 'string', + 'pattern' => '', + 'default' => '', + ], + 'Description' => [ + 'title' => '参数描述', + 'description' => '参数描述', + 'type' => 'string', + 'example' => 'None', + 'pattern' => '', + 'default' => '', + ], + 'Name' => [ + 'title' => '参数名称', + 'description' => '参数名称', + 'type' => 'string', + 'example' => 'auto_updateAlertRule_test_bULIRo', + 'pattern' => '', + 'default' => '', + ], + ], + ], + ], + 'Name' => [ + 'title' => '资源名称', + 'description' => '资源名称', + 'type' => 'string', + 'example' => 'auto_updateAlertRule_test_lJd81f', + 'pattern' => '', + 'default' => '', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"952795279527ab****\\",\\n \\"PagingInfo\\": {\\n \\"TotalCount\\": 100,\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"Components\\": [\\n {\\n \\"ModifyTime\\": \\"2023-11-30T13:30:58Z\\",\\n \\"Script\\": {\\n \\"Path\\": \\"/\\",\\n \\"Runtime\\": {\\n \\"Command\\": \\"SQL_COMPONENT\\"\\n },\\n \\"Id\\": \\"348100\\"\\n },\\n \\"Owner\\": \\"252675537980665607\\",\\n \\"Description\\": \\"vpc peering management_staging\\",\\n \\"CreateTime\\": \\"2023-03-13 16:35:59\\",\\n \\"Outputs\\": [\\n {\\n \\"DefaultValue\\": \\"32000\\",\\n \\"Type\\": \\"string\\",\\n \\"Description\\": \\"zdy\\",\\n \\"Name\\": \\"auto_updateAlertRule_test_bULIRo\\"\\n }\\n ],\\n \\"ProjectId\\": 199925,\\n \\"ComponentId\\": \\"12312313123\\",\\n \\"Inputs\\": [\\n {\\n \\"DefaultValue\\": \\"mdb.shard.2x.2xlarge.d\\",\\n \\"Type\\": \\"string\\",\\n \\"Description\\": \\"None\\",\\n \\"Name\\": \\"auto_updateAlertRule_test_bULIRo\\"\\n }\\n ],\\n \\"Name\\": \\"auto_updateAlertRule_test_lJd81f\\"\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => '获取组件列表', + 'description' => '需要购买DataWorks基础版及以上版本才能使用。', + ], + 'CreateNode' => [ + 'summary' => '调用该接口，会在新版数据开发中创建一个数据开发节点。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '236773', + 'abilityTreeNodes' => [ + 'FEATUREdideHO4TQP', + 'FEATUREdide8FM783', + 'FEATUREdideQUQUVB', + 'FEATUREdideIQU97M', + ], + ], + 'parameters' => [ + [ + 'name' => 'ProjectId', + 'in' => 'formData', + 'schema' => [ + 'description' => 'DataWorks工作空间的ID。您可以登录[DataWorks控制台](https://workbench.data.aliyun.com/console)，进入工作空间管理页面获取ID。'."\n" + ."\n" + .'该参数用来确定本次API调用操作使用的DataWorks工作空间。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '123456', + ], + ], + [ + 'name' => 'ContainerId', + 'in' => 'formData', + 'schema' => [ + 'description' => '当你需要将节点创建在一个容器内部时，你需要指定这个参数。该参数为一个容器的唯一标识，这个容器可以是一个Workflow或者一个容器节点。'."\n" + ."\n" + .'><notice>该参数填写后，FlowSpec中定义的path字段将无效></notice>'."\n" + ."\n" + .'><notice>该字段在SDK8.0.0版本之前为Long类型，SDK8.0.0版本及之后为String类型。**该变更不影响SDK正常使用，参数仍会按SDK中定义的类型返回**。只有在跨8.0.0版本的SDK升级时，类型变更可能会导致项目编译不通过，需要用户手动修正数据类型。></notice>', + 'type' => 'string', + 'required' => false, + 'example' => '23451286945488XXXX'."\n", + ], + ], + [ + 'name' => 'Scene', + 'in' => 'formData', + 'schema' => [ + 'description' => '节点创建的场景，决定节点创建在手动节点区域还是数据开发区域。DataworksManualWorkflow只在填写了ContainerId且Container为手动工作流时才能使用。'."\n" + ."\n" + .'可选值：'."\n" + ."\n" + .'- DATAWORKS_PROJECT 项目目录'."\n" + .'- DATAWORKS_MANUAL_WORKFLOW 手动工作流'."\n" + .'- DATAWORKS_MANUAL_TASK 手动任务', + 'type' => 'string', + 'required' => true, + 'enumValueTitles' => [], + 'example' => 'DATAWORKS_PROJECT', + ], + ], + [ + 'name' => 'Spec', + 'in' => 'formData', + 'schema' => [ + 'description' => '描述这个节点的FlowSpec信息，具体规范详见[FlowSpec](https://github.com/aliyun/alibabacloud-dataworks-tool-dflow)。'."\n" + ."\n" + .'> 如何快速获取FlowSpec模板？'."\n" + .'> - 在数据开发中打开节点->点击右侧版本->查看最新版本->查看调度配置，即可得到针对当前节点的FlowSpec描述。可以基于版本中的FlowSpec描述快速构建符合要求的模板。'."\n" + ."\n" + .'> 节点的内容如何填写？'."\n" + .'> - 节点的内容填写到$.spec.nodes[*].script.content字段中。'."\n" + ."\n" + .'> 离线同步节点的内容如何配置？'."\n" + .'> - 需要参考[通过脚本模式配置离线同步任务](https://help.aliyun.com/zh/dataworks/user-guide/configure-a-batch-synchronization-node-by-using-the-code-editor)中的步骤四编写脚本，并将内容填写到$.spec.nodes[*].script.content字段中。或者在页面上创建一个离线同步节点，通过查看版本的方式获取离线同步节点的脚本内容。', + 'type' => 'string', + 'required' => true, + 'example' => '{'."\n" + .' "version": "1.1.0",'."\n" + .' "kind": "Node",'."\n" + .' "spec": {'."\n" + .' "nodes": ['."\n" + .' {'."\n" + .' "recurrence": "Normal",'."\n" + .' "timeout": 0,'."\n" + .' "instanceMode": "T+1",'."\n" + .' "rerunMode": "Allowed",'."\n" + .' "rerunTimes": 3,'."\n" + .' "rerunInterval": 180000,'."\n" + .' "datasource": {'."\n" + .' "name": "odps_test"'."\n" + .' },'."\n" + .' "script": {'."\n" + .' "path": "XX/OpenAPI_Test/odpsSQL_Test",'."\n" + .' "runtime": {'."\n" + .' "command": "ODPS_SQL"'."\n" + .' },'."\n" + .' "content": "select now();"'."\n" + .' },'."\n" + .' "trigger": {'."\n" + .' "type": "Scheduler",'."\n" + .' "cron": "00 00 00 * * ?",'."\n" + .' "startTime": "1970-01-01 00:00:00",'."\n" + .' "endTime": "9999-01-01 00:00:00",'."\n" + .' "timezone": "Asia/Shanghai",'."\n" + .' "delaySeconds": 0'."\n" + .' },'."\n" + .' "runtimeResource": {'."\n" + .' "resourceGroup": "S_res_group_XXXX_XXXX"'."\n" + .' },'."\n" + .' "name": "odpsSQL_Test",'."\n" + .' "inputs": {'."\n" + .' "nodeOutputs": ['."\n" + .' {'."\n" + .' "data": "project_root",'."\n" + .' "artifactType": "NodeOutput"'."\n" + .' }'."\n" + .' ]'."\n" + .' },'."\n" + .' "outputs": {'."\n" + .' "nodeOutputs": ['."\n" + .' {'."\n" + .' "data": "output_data",'."\n" + .' "artifactType": "NodeOutput",'."\n" + .' "refTableName": "odpsSQL_Test"'."\n" + .' }'."\n" + .' ]'."\n" + .' }'."\n" + .' }'."\n" + .' ]'."\n" + .' }'."\n" + .'}', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。用于定位日志，排查问题。', + 'type' => 'string', + 'example' => 'AFBB799F-8578-51C5-A766-E922EDB8XXXX', + ], + 'Id' => [ + 'description' => '数据开发节点的唯一标识符。'."\n" + ."\n" + .'><notice>该字段在SDK8.0.0版本之前为Long类型，SDK8.0.0版本及之后为String类型。**该变更不影响SDK正常使用，参数仍会按SDK中定义的类型返回**。只有在跨8.0.0版本的SDK升级时，类型变更可能会导致项目编译不通过，需要用户手动修正数据类型。></notice>', + 'type' => 'string', + 'example' => '860438872620113XXXX', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"AFBB799F-8578-51C5-A766-E922EDB8XXXX\\",\\n \\"Id\\": \\"860438872620113XXXX\\"\\n}","type":"json"}]', + 'title' => '创建数据开发节点', + 'description' => '><notice>该接口不支持批量操作，若FlowSpec中定义了不止一个节点，则除第一个以外的后续节点均会被忽略。></notice>', + ], + 'DeleteNode' => [ + 'summary' => '调用此接口，可以删除指定的数据开发节点。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '236786', + 'abilityTreeNodes' => [ + 'FEATUREdideHO4TQP', + 'FEATUREdide8FM783', + 'FEATUREdideQUQUVB', + 'FEATUREdideIQU97M', + ], + ], + 'parameters' => [ + [ + 'name' => 'ProjectId', + 'in' => 'formData', + 'schema' => [ + 'description' => 'DataWorks工作空间的ID。您可以登录[DataWorks控制台](https://workbench.data.aliyun.com/console)，进入工作空间配置页面获取工作空间ID。'."\n" + ."\n" + .'该参数用来确定本次API调用操作使用的DataWorks工作空间。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '10000', + ], + ], + [ + 'name' => 'Id', + 'in' => 'formData', + 'schema' => [ + 'description' => '数据开发节点的唯一标识符。'."\n" + ."\n" + .'><notice>该字段在SDK8.0.0版本之前为Long类型，SDK8.0.0版本及之后为String类型。**该变更不影响SDK正常使用，参数仍会按SDK中定义的类型返回**。只有在跨8.0.0版本的SDK升级时，类型变更可能会导致项目编译不通过，需要用户手动修正数据类型。></notice>', + 'type' => 'string', + 'required' => true, + 'example' => '860438872620113XXXX', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求的ID。用于定位日志，排查问题。', + 'type' => 'string', + 'example' => 'A1E54497-5122-505E-91C6-BAC14980XXXX', + ], + 'Success' => [ + 'description' => '请求是否成功：'."\n" + ."\n" + .'true: 成功； '."\n" + .'false: 失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A1E54497-5122-505E-91C6-BAC14980XXXX\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => '删除数据开发节点', + 'description' => '><notice>当这个节点被发布后，无法删除，必须先下线再进行删除。></notice>', + ], + 'UpdateNode' => [ + 'summary' => '调用此接口，可以更新数据开发节点信息。更新通过增量更新的方式进行，更新的信息通过FlowSpec进行描述。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '236780', + 'abilityTreeNodes' => [ + 'FEATUREdideHO4TQP', + 'FEATUREdide8FM783', + 'FEATUREdideQUQUVB', + 'FEATUREdideIQU97M', + ], + ], + 'parameters' => [ + [ + 'name' => 'ProjectId', + 'in' => 'formData', + 'schema' => [ + 'description' => 'DataWorks工作空间的ID，您可以登录[DataWorks控制台](https://workbench.data.aliyun.com/console)，进入工作空间管理页面查看ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '10000', + ], + ], + [ + 'name' => 'Id', + 'in' => 'formData', + 'schema' => [ + 'description' => '数据开发节点的唯一标识符。'."\n" + ."\n" + .'><notice>该字段在SDK8.0.0版本之前为Long类型，SDK8.0.0版本及之后为String类型。**该变更不影响SDK正常使用，参数仍会按SDK中定义的类型返回**。只有在跨8.0.0版本的SDK升级时，类型变更可能会导致项目编译不通过，需要用户手动修正数据类型。></notice>', + 'type' => 'string', + 'required' => true, + 'example' => '860438872620113XXXX', + ], + ], + [ + 'name' => 'Spec', + 'in' => 'formData', + 'schema' => [ + 'description' => '描述这个节点的FlowSpec信息，具体规范详见[FlowSpec](https://github.com/aliyun/alibabacloud-dataworks-tool-dflow)。'."\n" + ."\n" + .'> 如何快速获取FlowSpec模板？'."\n" + .'> - 在数据开发中打开节点->点击右侧版本->查看最新版本->查看调度配置，即可得到针对当前节点的FlowSpec描述。可以基于版本中的FlowSpec描述快速构建符合要求的模板。'."\n" + ."\n" + .'> 节点的内容如何填写？'."\n" + .'> - 节点的内容填写到$.spec.nodes[*].script.content字段中。', + 'type' => 'string', + 'required' => true, + 'example' => '{'."\n" + .' "version": "1.1.0",'."\n" + .' "kind": "Node",'."\n" + .' "spec": {'."\n" + .' "nodes": ['."\n" + .' {'."\n" + .' "id": "860438872620113XXXX",'."\n" + .' "recurrence": "Normal",'."\n" + .' "timeout": 0,'."\n" + .' "instanceMode": "T+1",'."\n" + .' "rerunMode": "Allowed",'."\n" + .' "rerunTimes": 3,'."\n" + .' "rerunInterval": 180000,'."\n" + .' "datasource": {'."\n" + .' "name": "odps_test"'."\n" + .' },'."\n" + .' "script": {'."\n" + .' "path": "XX/OpenAPI_Test/odpsSQL_Test",'."\n" + .' "runtime": {'."\n" + .' "command": "ODPS_SQL"'."\n" + .' },'."\n" + .' "content": "select now();"'."\n" + .' },'."\n" + .' "trigger": {'."\n" + .' "type": "Scheduler",'."\n" + .' "cron": "00 00 00 * * ?",'."\n" + .' "startTime": "1970-01-01 00:00:00",'."\n" + .' "endTime": "9999-01-01 00:00:00",'."\n" + .' "timezone": "Asia/Shanghai",'."\n" + .' "delaySeconds": 0'."\n" + .' },'."\n" + .' "runtimeResource": {'."\n" + .' "resourceGroup": "S_res_group_XXXX_XXXX"'."\n" + .' },'."\n" + .' "name": "odpsSQL_Test",'."\n" + .' "inputs": {'."\n" + .' "nodeOutputs": ['."\n" + .' {'."\n" + .' "data": "project_root",'."\n" + .' "artifactType": "NodeOutput"'."\n" + .' }'."\n" + .' ]'."\n" + .' },'."\n" + .' "outputs": {'."\n" + .' "nodeOutputs": ['."\n" + .' {'."\n" + .' "data": "output_data",'."\n" + .' "artifactType": "NodeOutput",'."\n" + .' "refTableName": "odpsSQL_Test"'."\n" + .' }'."\n" + .' ]'."\n" + .' }'."\n" + .' }'."\n" + .' ],'."\n" + .' "flow": ['."\n" + .' {'."\n" + .' "nodeId": "860438872620113XXXX",'."\n" + .' "depends": ['."\n" + .' {'."\n" + .' "type": "Normal",'."\n" + .' "output": "project_root"'."\n" + .' }'."\n" + .' ]'."\n" + .' }'."\n" + .' ]'."\n" + .' }'."\n" + .'}', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '本次调用的唯一ID。出现错误后，您可以根据该ID排查问题。', + 'type' => 'string', + 'example' => '99EBE7CF-69C0-5089-BE3E-79563C31****', + ], + 'Success' => [ + 'description' => '调用是否成功。'."\n" + ."\n" + .'- true：调用成功'."\n" + ."\n" + .'- false：调用失败', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"99EBE7CF-69C0-5089-BE3E-79563C31****\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => '更新数据开发节点信息', + ], + 'MoveNode' => [ + 'summary' => '调用此接口，可以将指定的数据开发节点的路径移动到指定位置。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '236795', + 'abilityTreeNodes' => [ + 'FEATUREdideHO4TQP', + 'FEATUREdide8FM783', + 'FEATUREdideQUQUVB', + 'FEATUREdideIQU97M', + ], + ], + 'parameters' => [ + [ + 'name' => 'ProjectId', + 'in' => 'formData', + 'schema' => [ + 'description' => 'DataWorks工作空间的ID。您可以登录[DataWorks控制台](https://workbench.data.aliyun.com/console)，进入工作空间管理页面获取ID。'."\n" + ."\n" + .'该参数用来确定本次API调用操作使用的DataWorks工作空间。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '10000', + ], + ], + [ + 'name' => 'Id', + 'in' => 'formData', + 'schema' => [ + 'description' => '数据开发节点的唯一标识符。'."\n" + ."\n" + .'><notice>该字段在SDK8.0.0版本之前为Long类型，SDK8.0.0版本及之后为String类型。**该变更不影响SDK正常使用，参数仍会按SDK中定义的类型返回**。只有在跨8.0.0版本的SDK升级时，类型变更可能会导致项目编译不通过，需要用户手动修正数据类型。></notice>', + 'type' => 'string', + 'required' => true, + 'example' => '652567824470354XXXX', + ], + ], + [ + 'name' => 'Path', + 'in' => 'formData', + 'schema' => [ + 'description' => '移动的目标路径，不需要带节点名。'."\n" + ."\n" + .'例如将test节点的路径变成到root/demo/test，则此参数需要填写root/demo', + 'type' => 'string', + 'required' => true, + 'example' => 'root/demo', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。用于出现错误后排查问题。', + 'type' => 'string', + 'example' => 'C99E2BE6-9DEA-5C2E-8F51-1DDCFEADXXXX', + ], + 'Success' => [ + 'description' => '调用是否成功：'."\n" + ."\n" + .'- true：是'."\n" + ."\n" + .'- false：否', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"C99E2BE6-9DEA-5C2E-8F51-1DDCFEADXXXX\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => '移动数据开发节点路径', + ], + 'RenameNode' => [ + 'summary' => '调用此接口，可以重命名数据开发节点。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '236794', + 'abilityTreeNodes' => [ + 'FEATUREdideHO4TQP', + 'FEATUREdide8FM783', + 'FEATUREdideQUQUVB', + 'FEATUREdideIQU97M', + ], + ], + 'parameters' => [ + [ + 'name' => 'ProjectId', + 'in' => 'formData', + 'schema' => [ + 'description' => 'DataWorks工作空间的ID，您可以登录[DataWorks控制台](https://workbench.data.aliyun.com/console)，进入工作空间管理页面查看ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '12345', + ], + ], + [ + 'name' => 'Id', + 'in' => 'formData', + 'schema' => [ + 'description' => '数据开发节点的唯一标识符。'."\n" + ."\n" + .'><notice>该字段在SDK8.0.0版本之前为Long类型，SDK8.0.0版本及之后为String类型。**该变更不影响SDK正常使用，参数仍会按SDK中定义的类型返回**。只有在跨8.0.0版本的SDK升级时，类型变更可能会导致项目编译不通过，需要用户手动修正数据类型。></notice>', + 'type' => 'string', + 'required' => true, + 'example' => '652567824470354****', + ], + ], + [ + 'name' => 'Name', + 'in' => 'formData', + 'schema' => [ + 'description' => '希望重命名的名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'Rename', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求的ID。用于定位日志，排查问题。', + 'type' => 'string', + 'example' => '4CDF7B72-020B-542A-8465-21CFFA81XXXX', + ], + 'Success' => [ + 'description' => '调用是否成功。取值如下：'."\n" + ."\n" + .'- true：调用成功。'."\n" + ."\n" + .'- false：调用失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"4CDF7B72-020B-542A-8465-21CFFA81XXXX\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => '重命名数据开发节点', + ], + 'GetNode' => [ + 'summary' => '获取指定的数据开发节点详细信息。', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '236761', + 'abilityTreeNodes' => [ + 'FEATUREdideHO4TQP', + 'FEATUREdide8FM783', + 'FEATUREdideQUQUVB', + 'FEATUREdideIQU97M', + ], + ], + 'parameters' => [ + [ + 'name' => 'ProjectId', + 'in' => 'query', + 'schema' => [ + 'description' => 'DataWorks工作空间的ID。您可以登录[DataWorks控制台](https://workbench.data.aliyun.com/console)，进入工作空间管理页面获取ID。'."\n" + ."\n" + .'该参数用来确定本次API调用操作使用的DataWorks工作空间。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '10000', + ], + ], + [ + 'name' => 'Id', + 'in' => 'query', + 'schema' => [ + 'description' => '数据开发节点的唯一标识符。'."\n" + ."\n" + .'><notice>该字段在SDK8.0.0版本之前为Long类型，SDK8.0.0版本及之后为String类型。**该变更不影响SDK正常使用，参数仍会按SDK中定义的类型返回**。只有在跨8.0.0版本的SDK升级时，类型变更可能会导致项目编译不通过，需要用户手动修正数据类型。></notice>', + 'type' => 'string', + 'required' => true, + 'example' => '86043887262011****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求的id，用于定位日志，排查问题。', + 'type' => 'string', + 'example' => '22C97E95-F023-56B5-8852-B1A77A17XXXX', + ], + 'Node' => [ + 'description' => '数据开发节点详细信息', + 'type' => 'object', + 'properties' => [ + 'ProjectId' => [ + 'description' => '工作空间的ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10000', + ], + 'Name' => [ + 'description' => '数据开发节点名称', + 'type' => 'string', + 'example' => 'Node name', + ], + 'Owner' => [ + 'description' => '数据开发节点责任人', + 'type' => 'string', + 'example' => '196596664824XXXX', + ], + 'CreateTime' => [ + 'description' => '创建数据开发节点时间戳', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1700539206000', + ], + 'ModifyTime' => [ + 'description' => '最近修改数据开发节点时间戳', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1700539206000', + ], + 'Spec' => [ + 'description' => '描述这个节点的FlowSpec信息，具体规范详见[FlowSpec](https://github.com/aliyun/alibabacloud-dataworks-tool-dflow)。', + 'type' => 'string', + 'example' => '{'."\n" + .' "version": "1.1.0",'."\n" + .' "kind": "Node",'."\n" + .' "spec": {'."\n" + .' "nodes": ['."\n" + .' {'."\n" + .' "recurrence": "Normal",'."\n" + .' "id": "860438872620113XXXX",'."\n" + .' "timeout": 0,'."\n" + .' "instanceMode": "T+1",'."\n" + .' "rerunMode": "Allowed",'."\n" + .' "rerunTimes": 3,'."\n" + .' "rerunInterval": 180000,'."\n" + .' "datasource": {'."\n" + .' "name": "odps_test",'."\n" + .' "type": "odps"'."\n" + .' },'."\n" + .' "script": {'."\n" + .' "language": "odps-sql",'."\n" + .' "path": "XX/OpenAPI_Test/ODPS_SQL_Test",'."\n" + .' "runtime": {'."\n" + .' "command": "ODPS_SQL",'."\n" + .' "commandTypeId": 10'."\n" + .' },'."\n" + .' "content": "select now();",'."\n" + .' "id": "853573334108680XXXX"'."\n" + .' },'."\n" + .' "trigger": {'."\n" + .' "type": "Scheduler",'."\n" + .' "id": "543680677872062XXXX",'."\n" + .' "cron": "00 00 00 * * ?",'."\n" + .' "startTime": "1970-01-01 00:00:00",'."\n" + .' "endTime": "9999-01-01 00:00:00",'."\n" + .' "timezone": "Asia/Shanghai",'."\n" + .' "delaySeconds": 0'."\n" + .' },'."\n" + .' "runtimeResource": {'."\n" + .' "resourceGroup": "S_res_group_XXXX_XXXX",'."\n" + .' "id": "623731286945488XXXX",'."\n" + .' "resourceGroupId": "7201XXXX"'."\n" + .' },'."\n" + .' "name": "ODPS_SQL_Test",'."\n" + .' "owner": "110755000425XXXX",'."\n" + .' "metadata": {'."\n" + .' "owner": "110755000425XXXX",'."\n" + .' "ownerName": "[email protected]",'."\n" + .' "projectId": "307XXX"'."\n" + .' },'."\n" + .' "inputs": {'."\n" + .' "nodeOutputs": ['."\n" + .' {'."\n" + .' "data": "lwttest_standard_root",'."\n" + .' "artifactType": "NodeOutput"'."\n" + .' }'."\n" + .' ]'."\n" + .' },'."\n" + .' "outputs": {'."\n" + .' "nodeOutputs": ['."\n" + .' {'."\n" + .' "data": "860438872620113XXXX",'."\n" + .' "artifactType": "NodeOutput",'."\n" + .' "refTableName": "ODPS_SQL_Test",'."\n" + .' "isDefault": true'."\n" + .' }'."\n" + .' ]'."\n" + .' }'."\n" + .' }'."\n" + .' ],'."\n" + .' "flow": ['."\n" + .' {'."\n" + .' "nodeId": "860438872620113XXXX",'."\n" + .' "depends": ['."\n" + .' {'."\n" + .' "type": "Normal",'."\n" + .' "output": "lwttest_standard_root"'."\n" + .' }'."\n" + .' ]'."\n" + .' }'."\n" + .' ]'."\n" + .' },'."\n" + .' "metadata": {'."\n" + .' "uuid": "860438872620113XXXX"'."\n" + .' }'."\n" + .'}', + ], + 'TaskId' => [ + 'description' => '节点发布后对应的调度任务Id', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '700006680527', + ], + 'Id' => [ + 'description' => '数据开发节点唯一标识符。'."\n" + ."\n" + .'><notice>该字段在SDK8.0.0版本之前为Long类型，SDK8.0.0版本及之后为String类型。**该变更不影响SDK正常使用，参数仍会按SDK中定义的类型返回**。只有在跨8.0.0版本的SDK升级时，类型变更可能会导致项目编译不通过，需要用户手动修正数据类型。></notice>', + 'type' => 'string', + 'example' => '860438872620113XXXX'."\n", + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"22C97E95-F023-56B5-8852-B1A77A17XXXX\\",\\n \\"Node\\": {\\n \\"ProjectId\\": 10000,\\n \\"Name\\": \\"Node name\\",\\n \\"Owner\\": \\"196596664824XXXX\\",\\n \\"CreateTime\\": 1700539206000,\\n \\"ModifyTime\\": 1700539206000,\\n \\"Spec\\": \\"{\\\\n \\\\\\"version\\\\\\": \\\\\\"1.1.0\\\\\\",\\\\n \\\\\\"kind\\\\\\": \\\\\\"Node\\\\\\",\\\\n \\\\\\"spec\\\\\\": {\\\\n \\\\\\"nodes\\\\\\": [\\\\n {\\\\n \\\\\\"recurrence\\\\\\": \\\\\\"Normal\\\\\\",\\\\n \\\\\\"id\\\\\\": \\\\\\"860438872620113XXXX\\\\\\",\\\\n \\\\\\"timeout\\\\\\": 0,\\\\n \\\\\\"instanceMode\\\\\\": \\\\\\"T+1\\\\\\",\\\\n \\\\\\"rerunMode\\\\\\": \\\\\\"Allowed\\\\\\",\\\\n \\\\\\"rerunTimes\\\\\\": 3,\\\\n \\\\\\"rerunInterval\\\\\\": 180000,\\\\n \\\\\\"datasource\\\\\\": {\\\\n \\\\\\"name\\\\\\": \\\\\\"odps_test\\\\\\",\\\\n \\\\\\"type\\\\\\": \\\\\\"odps\\\\\\"\\\\n },\\\\n \\\\\\"script\\\\\\": {\\\\n \\\\\\"language\\\\\\": \\\\\\"odps-sql\\\\\\",\\\\n \\\\\\"path\\\\\\": \\\\\\"XX/OpenAPI_Test/ODPS_SQL_Test\\\\\\",\\\\n \\\\\\"runtime\\\\\\": {\\\\n \\\\\\"command\\\\\\": \\\\\\"ODPS_SQL\\\\\\",\\\\n \\\\\\"commandTypeId\\\\\\": 10\\\\n },\\\\n \\\\\\"content\\\\\\": \\\\\\"select now();\\\\\\",\\\\n \\\\\\"id\\\\\\": \\\\\\"853573334108680XXXX\\\\\\"\\\\n },\\\\n \\\\\\"trigger\\\\\\": {\\\\n \\\\\\"type\\\\\\": \\\\\\"Scheduler\\\\\\",\\\\n \\\\\\"id\\\\\\": \\\\\\"543680677872062XXXX\\\\\\",\\\\n \\\\\\"cron\\\\\\": \\\\\\"00 00 00 * * ?\\\\\\",\\\\n \\\\\\"startTime\\\\\\": \\\\\\"1970-01-01 00:00:00\\\\\\",\\\\n \\\\\\"endTime\\\\\\": \\\\\\"9999-01-01 00:00:00\\\\\\",\\\\n \\\\\\"timezone\\\\\\": \\\\\\"Asia/Shanghai\\\\\\",\\\\n \\\\\\"delaySeconds\\\\\\": 0\\\\n },\\\\n \\\\\\"runtimeResource\\\\\\": {\\\\n \\\\\\"resourceGroup\\\\\\": \\\\\\"S_res_group_XXXX_XXXX\\\\\\",\\\\n \\\\\\"id\\\\\\": \\\\\\"623731286945488XXXX\\\\\\",\\\\n \\\\\\"resourceGroupId\\\\\\": \\\\\\"7201XXXX\\\\\\"\\\\n },\\\\n \\\\\\"name\\\\\\": \\\\\\"ODPS_SQL_Test\\\\\\",\\\\n \\\\\\"owner\\\\\\": \\\\\\"110755000425XXXX\\\\\\",\\\\n \\\\\\"metadata\\\\\\": {\\\\n \\\\\\"owner\\\\\\": \\\\\\"110755000425XXXX\\\\\\",\\\\n \\\\\\"ownerName\\\\\\": \\\\\\"[email protected]\\\\\\",\\\\n \\\\\\"projectId\\\\\\": \\\\\\"307XXX\\\\\\"\\\\n },\\\\n \\\\\\"inputs\\\\\\": {\\\\n \\\\\\"nodeOutputs\\\\\\": [\\\\n {\\\\n \\\\\\"data\\\\\\": \\\\\\"lwttest_standard_root\\\\\\",\\\\n \\\\\\"artifactType\\\\\\": \\\\\\"NodeOutput\\\\\\"\\\\n }\\\\n ]\\\\n },\\\\n \\\\\\"outputs\\\\\\": {\\\\n \\\\\\"nodeOutputs\\\\\\": [\\\\n {\\\\n \\\\\\"data\\\\\\": \\\\\\"860438872620113XXXX\\\\\\",\\\\n \\\\\\"artifactType\\\\\\": \\\\\\"NodeOutput\\\\\\",\\\\n \\\\\\"refTableName\\\\\\": \\\\\\"ODPS_SQL_Test\\\\\\",\\\\n \\\\\\"isDefault\\\\\\": true\\\\n }\\\\n ]\\\\n }\\\\n }\\\\n ],\\\\n \\\\\\"flow\\\\\\": [\\\\n {\\\\n \\\\\\"nodeId\\\\\\": \\\\\\"860438872620113XXXX\\\\\\",\\\\n \\\\\\"depends\\\\\\": [\\\\n {\\\\n \\\\\\"type\\\\\\": \\\\\\"Normal\\\\\\",\\\\n \\\\\\"output\\\\\\": \\\\\\"lwttest_standard_root\\\\\\"\\\\n }\\\\n ]\\\\n }\\\\n ]\\\\n },\\\\n \\\\\\"metadata\\\\\\": {\\\\n \\\\\\"uuid\\\\\\": \\\\\\"860438872620113XXXX\\\\\\"\\\\n }\\\\n}\\",\\n \\"TaskId\\": 700006680527,\\n \\"Id\\": \\"860438872620113XXXX\\\\n\\"\\n }\\n}","type":"json"}]', + 'title' => '获取数据开发节点详情', + ], + 'ListNodes' => [ + 'summary' => '分页获取数据开发节点列表，也可以通过筛选条件对列表进行筛选查询。', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '236792', + 'abilityTreeNodes' => [ + 'FEATUREdideHO4TQP', + ], + ], + 'parameters' => [ + [ + 'name' => 'ProjectId', + 'in' => 'query', + 'schema' => [ + 'description' => 'DataWorks工作空间的ID。您可以登录[DataWorks控制台](https://workbench.data.aliyun.com/console)，进入工作空间配置页面获取工作空间ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '12345', + ], + ], + [ + 'name' => 'Scene', + 'in' => 'query', + 'schema' => [ + 'description' => '筛选条件：节点所在场景，如未指定则不填写，在数据开发中对应左侧目录树的分区可选值： '."\n" + ."\n" + .'- DataworksProject 项目目录'."\n" + ."\n" + .'- DataworksManualWorkflow 手动工作流 '."\n" + ."\n" + .'- DataworksManualTask 手动任务。', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [], + 'example' => 'DataworksProject', + ], + ], + [ + 'name' => 'ContainerId', + 'in' => 'query', + 'schema' => [ + 'description' => '如未指定则不填写，筛选条件：在指定容器内。填写容器ID，与资源组（ResourceGroupId）无关。'."\n" + ."\n" + .'><notice>该字段在SDK8.0.0版本之前为Long类型，SDK8.0.0版本及之后为String类型。**该变更不影响SDK正常使用，参数仍会按SDK中定义的类型返回**。只有在跨8.0.0版本的SDK升级时，类型变更可能会导致项目编译不通过，需要用户手动修正数据类型。></notice>', + 'type' => 'string', + 'required' => false, + 'example' => '860438872620113XXXX', + ], + ], + [ + 'name' => 'Recurrence', + 'in' => 'query', + 'schema' => [ + 'description' => '筛选条件：调度类型可选值： '."\n" + ."\n" + .'- Normal：正常执行任务。'."\n" + ."\n" + .'- Pause：节点状态被置为暂停，并且会阻塞依赖当前节点的下游节点执行。'."\n" + .' '."\n" + .'- Skip：节点状态被置为空跑，系统会直接返回成功（执行时长为0秒），不会阻塞下游节点执行，也不会占用资源。', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [], + 'example' => 'Normal', + ], + ], + [ + 'name' => 'RerunMode', + 'in' => 'query', + 'schema' => [ + 'description' => '重跑属性，如不指定则不填写。取值如下： '."\n" + ."\n" + .'- Allowed：运行成功或失败后皆可重跑。'."\n" + .' '."\n" + .'- FailureAllowed：运行成功后不可重跑，运行失败后可以重跑。'."\n" + .' '."\n" + .'- Denied：运行成功或失败皆不可重跑。', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [], + 'example' => 'Allowed', + ], + ], + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => [ + 'description' => '节点名称，支持模糊查询', + 'type' => 'string', + 'required' => false, + 'example' => 'test', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '请求的数据页数，用于翻页。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '2147483647', + 'minimum' => '1', + 'example' => '1', + 'default' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '每页显示的条数，默认为10条，最大100条。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '100', + 'minimum' => '10', + 'example' => '10', + 'default' => '10', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求的id。用于定位日志，排查问题。', + 'type' => 'string', + 'example' => '2197B9C4-39CE-55EA-8EEA-FDBAE52DXXXX', + ], + 'PagingInfo' => [ + 'description' => '分页信息', + 'type' => 'object', + 'properties' => [ + 'TotalCount' => [ + 'description' => '满足条件的数据总条数。', + 'type' => 'string', + 'example' => '42', + ], + 'PageSize' => [ + 'description' => '每页显示的条数', + 'type' => 'string', + 'example' => '10', + ], + 'PageNumber' => [ + 'description' => '请求的数据页数，用于翻页。', + 'type' => 'string', + 'example' => '1', + ], + 'Nodes' => [ + 'description' => '数据开发节点列表', + 'type' => 'array', + 'items' => [ + 'description' => '数据开发节点信息', + 'type' => 'object', + 'properties' => [ + 'Description' => [ + 'title' => '描述', + 'description' => '节点描述', + 'type' => 'string', + 'example' => 'Node description'."\n", + ], + 'Name' => [ + 'title' => '节点名', + 'description' => '节点名称', + 'type' => 'string', + 'example' => 'test', + ], + 'ProjectId' => [ + 'description' => 'DataWorks工作空间的ID，您可以登录[DataWorks控制台](https://workbench.data.aliyun.com/console)，进入工作空间管理页面查看ID。', + 'type' => 'integer', + 'format' => 'int64', + 'deprecated' => false, + 'example' => '33233', + ], + 'Owner' => [ + 'title' => '责任人', + 'description' => '数据开发节点责任人', + 'type' => 'string', + 'deprecated' => false, + 'example' => '110755000425XXXX', + 'pattern' => '', + 'default' => '', + ], + 'CreateTime' => [ + 'title' => '创建时间', + 'description' => '数据开发节点创建时间戳', + 'type' => 'integer', + 'format' => 'int64', + 'deprecated' => false, + 'example' => '1722910655000', + 'pattern' => '', + 'default' => '', + ], + 'ModifyTime' => [ + 'title' => '修改时间', + 'description' => '数据开发节点最近修改时间戳', + 'type' => 'integer', + 'format' => 'int64', + 'deprecated' => false, + 'example' => '1722910655000', + 'pattern' => '', + 'default' => '', + ], + 'DataSource' => [ + 'title' => '数据源', + 'description' => '数据源', + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'title' => '数据源名称', + 'description' => '数据源名称', + 'type' => 'string', + 'deprecated' => false, + 'example' => 'odps_first', + 'pattern' => '', + 'default' => '', + ], + 'Type' => [ + 'title' => '数据源类型', + 'description' => '数据源类型', + 'type' => 'string', + 'deprecated' => false, + 'example' => 'odps', + 'pattern' => '', + 'default' => '', + ], + ], + 'deprecated' => false, + ], + 'TaskId' => [ + 'title' => '调度任务Id', + 'description' => '调度任务Id', + 'type' => 'integer', + 'format' => 'int64', + 'deprecated' => false, + 'example' => '88888888888', + 'pattern' => '', + 'default' => '', + ], + 'Tags' => [ + 'title' => '标签信息', + 'description' => '标签信息，暂未使用', + 'type' => 'array', + 'items' => [ + 'title' => '单个标签', + 'description' => '单个标签，暂未使用', + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'title' => '标签键', + 'description' => '标签键', + 'type' => 'string', + 'deprecated' => false, + 'example' => 'null', + 'pattern' => '', + 'default' => '', + ], + 'Value' => [ + 'title' => '标签值', + 'description' => '标签值', + 'type' => 'string', + 'deprecated' => false, + 'example' => 'null', + 'pattern' => '', + 'default' => '', + ], + ], + 'deprecated' => false, + ], + 'deprecated' => false, + ], + 'Strategy' => [ + 'title' => '调度策略', + 'description' => '调度策略', + 'type' => 'object', + 'properties' => [ + 'Timeout' => [ + 'title' => '超时时间', + 'description' => '超时时间', + 'type' => 'integer', + 'format' => 'int32', + 'deprecated' => false, + 'example' => '0', + 'pattern' => '', + 'default' => '', + ], + 'InstanceMode' => [ + 'title' => '生成实例的模式', + 'description' => '生成实例的模式'."\n" + .'- T+1'."\n" + .'- Immediately', + 'type' => 'string', + 'deprecated' => false, + 'enumValueTitles' => [], + 'example' => 'T+1', + 'pattern' => '', + 'default' => '', + 'enum' => [ + 'T+1', + 'Immediately', + ], + ], + 'RerunMode' => [ + 'title' => '允许重跑的模式', + 'description' => '允许重跑的模式'."\n" + .'- Allowed'."\n" + .'- Denied'."\n" + .'- FailureAllowed', + 'type' => 'string', + 'deprecated' => false, + 'enumValueTitles' => [], + 'example' => 'Allowed', + 'pattern' => '', + 'default' => '', + 'enum' => [ + 'Allowed', + 'Denied', + 'FailureAllowed', + ], + ], + 'RerunTimes' => [ + 'title' => '重试次数', + 'description' => '重试次数', + 'type' => 'integer', + 'format' => 'int32', + 'deprecated' => false, + 'example' => '3', + 'pattern' => '', + 'default' => '', + ], + 'RerunInterval' => [ + 'title' => '重试时间间隔', + 'description' => '重试时间间隔，单位毫秒', + 'type' => 'integer', + 'format' => 'int32', + 'deprecated' => false, + 'example' => '180000', + 'pattern' => '', + 'default' => '', + ], + ], + 'deprecated' => false, + ], + 'Outputs' => [ + 'title' => '节点输出', + 'description' => '节点输出', + 'type' => 'object', + 'properties' => [ + 'Variables' => [ + 'title' => '变量列表', + 'description' => '变量列表', + 'type' => 'array', + 'items' => [ + 'title' => '变量元素', + 'description' => '变量元素', + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'title' => '变量名', + 'description' => '变量名', + 'type' => 'string', + 'deprecated' => false, + 'example' => 'output'."\n", + 'pattern' => '', + 'default' => '', + ], + 'ArtifactType' => [ + 'title' => '制品类型', + 'description' => '制品类型', + 'type' => 'string', + 'deprecated' => false, + 'example' => 'Variable', + 'pattern' => '', + 'default' => '', + ], + 'Scope' => [ + 'title' => '范围', + 'description' => '变量作用范围'."\n" + .'- NodeParameter'."\n" + .'- NodeContext'."\n" + .'- Workflow'."\n" + .'- Workspace', + 'type' => 'string', + 'deprecated' => false, + 'enumValueTitles' => [], + 'example' => 'NodeParameter', + 'pattern' => '', + 'default' => '', + ], + 'Type' => [ + 'title' => '类型', + 'description' => '变量类型'."\n" + .'- NoKvVariableExpression'."\n" + .'- Constant'."\n" + .'- PassThrough'."\n" + .'- System'."\n" + .'- NodeOutput', + 'type' => 'string', + 'deprecated' => false, + 'enumValueTitles' => [], + 'example' => 'Constant', + 'pattern' => '', + 'default' => '', + ], + 'Value' => [ + 'title' => '变量值', + 'description' => '变量值', + 'type' => 'string', + 'deprecated' => false, + 'example' => '111', + 'pattern' => '', + 'default' => '', + ], + 'Node' => [ + 'title' => '变量所属节点', + 'description' => '变量所属节点', + 'type' => 'object', + 'properties' => [ + 'Output' => [ + 'title' => '节点输出', + 'description' => '节点输出', + 'type' => 'string', + 'deprecated' => false, + 'example' => '860438872620113XXXX', + 'pattern' => '', + 'default' => '', + ], + ], + 'deprecated' => false, + ], + 'Id' => [ + 'description' => '变量id。'."\n" + ."\n" + .'><notice>该字段在SDK8.0.0版本之前为Long类型，SDK8.0.0版本及之后为String类型。**该变更不影响SDK正常使用，参数仍会按SDK中定义的类型返回**。只有在跨8.0.0版本的SDK升级时，类型变更可能会导致项目编译不通过，需要用户手动修正数据类型。></notice>', + 'type' => 'string', + 'deprecated' => false, + 'example' => '623731286945488XXXX', + ], + ], + 'deprecated' => false, + ], + 'deprecated' => false, + ], + 'NodeOutputs' => [ + 'title' => '节点输出列表', + 'description' => '节点输出列表', + 'type' => 'array', + 'items' => [ + 'title' => '节点输出项', + 'description' => '节点输出项', + 'type' => 'object', + 'properties' => [ + 'Data' => [ + 'title' => '节点输出', + 'description' => '节点输出', + 'type' => 'string', + 'deprecated' => false, + 'example' => '860438872620113XXXX', + 'pattern' => '', + 'default' => '', + ], + ], + 'deprecated' => false, + ], + 'deprecated' => false, + ], + 'Tables' => [ + 'title' => '表列表', + 'description' => '表列表', + 'type' => 'array', + 'items' => [ + 'title' => '表输出项', + 'description' => '表输出项', + 'type' => 'object', + 'properties' => [ + 'Guid' => [ + 'title' => '表id', + 'description' => '表id', + 'type' => 'string', + 'deprecated' => false, + 'example' => 'odps.autotest.test_output_table_1', + 'pattern' => '', + 'default' => '', + ], + ], + 'deprecated' => false, + ], + 'deprecated' => false, + ], + ], + 'deprecated' => false, + ], + 'Inputs' => [ + 'title' => '节点输入', + 'description' => '节点输入', + 'type' => 'object', + 'properties' => [ + 'Variables' => [ + 'title' => '变量列表', + 'description' => '变量列表', + 'type' => 'array', + 'items' => [ + 'title' => '变量元素', + 'description' => '变量元素', + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'title' => '变量名', + 'description' => '变量名', + 'type' => 'string', + 'deprecated' => false, + 'example' => 'input', + 'pattern' => '', + 'default' => '', + ], + 'ArtifactType' => [ + 'title' => '制品类型', + 'description' => '制品类型', + 'type' => 'string', + 'deprecated' => false, + 'example' => 'Variable', + 'pattern' => '', + 'default' => '', + ], + 'Scope' => [ + 'title' => '范围', + 'description' => '输入变量作用范围'."\n" + .'- WorkSpace'."\n" + .'- NodeParameter'."\n" + .'- NodeContext'."\n" + .'- Workflow', + 'type' => 'string', + 'deprecated' => false, + 'enumValueTitles' => [], + 'example' => 'NodeParameter', + 'pattern' => '', + 'default' => '', + ], + 'Type' => [ + 'title' => '类型', + 'description' => '类型'."\n" + .'- NoKvVariableExpression'."\n" + .'- Constant'."\n" + .'- PassThrough'."\n" + .'- System'."\n" + .'- NodeOutput', + 'type' => 'string', + 'deprecated' => false, + 'enumValueTitles' => [], + 'example' => 'Constant', + 'pattern' => '', + 'default' => '', + ], + 'Value' => [ + 'title' => '变量值', + 'description' => '变量值', + 'type' => 'string', + 'deprecated' => false, + 'example' => '222', + 'pattern' => '', + 'default' => '', + ], + 'Node' => [ + 'title' => '变量所属节点', + 'description' => '变量所属节点', + 'type' => 'object', + 'properties' => [ + 'Output' => [ + 'title' => '节点输出', + 'description' => '节点输出', + 'type' => 'string', + 'deprecated' => false, + 'example' => '623731286945488XXXX', + 'pattern' => '', + 'default' => '', + ], + ], + 'deprecated' => false, + ], + 'Id' => [ + 'description' => '变量id。'."\n" + ."\n" + .'><notice>该字段在SDK8.0.0版本之前为Long类型，SDK8.0.0版本及之后为String类型。**该变更不影响SDK正常使用，参数仍会按SDK中定义的类型返回**。只有在跨8.0.0版本的SDK升级时，类型变更可能会导致项目编译不通过，需要用户手动修正数据类型。></notice>', + 'type' => 'string', + 'deprecated' => false, + 'example' => '543211286945488XXXX', + ], + ], + 'deprecated' => false, + ], + 'deprecated' => false, + ], + 'NodeOutputs' => [ + 'title' => '节点输出列表', + 'description' => '节点输出列表', + 'type' => 'array', + 'items' => [ + 'title' => '节点输出项', + 'description' => '节点输出项', + 'type' => 'object', + 'properties' => [ + 'Data' => [ + 'title' => '节点输出', + 'description' => '节点输出', + 'type' => 'string', + 'deprecated' => false, + 'example' => '623731286945488XXXX', + 'pattern' => '', + 'default' => '', + ], + ], + 'deprecated' => false, + ], + 'deprecated' => false, + ], + 'Tables' => [ + 'title' => '表列表', + 'description' => '表列表', + 'type' => 'array', + 'items' => [ + 'title' => '表输出项', + 'description' => '表输出项', + 'type' => 'object', + 'properties' => [ + 'Guid' => [ + 'title' => '表id', + 'description' => '表id', + 'type' => 'string', + 'deprecated' => false, + 'example' => 'odps.autotest.test_output_table_1', + 'pattern' => '', + 'default' => '', + ], + ], + 'deprecated' => false, + ], + 'deprecated' => false, + ], + ], + 'deprecated' => false, + ], + 'Trigger' => [ + 'title' => '触发器', + 'description' => '触发器', + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'title' => '类型', + 'description' => '触发器类型'."\n" + ."\n" + .'可选值：'."\n" + ."\n" + .'- Scheduler 周期调度'."\n" + .'- Manual 手动触发'."\n" + .'- Steaming 流式任务', + 'type' => 'string', + 'deprecated' => false, + 'enumValueTitles' => [], + 'example' => 'Scheduler', + 'pattern' => '', + 'default' => '', + ], + 'Cron' => [ + 'title' => 'cron表达式', + 'description' => '调度的cron表达式', + 'type' => 'string', + 'deprecated' => false, + 'example' => '00 00 00 * * ?', + 'pattern' => '', + 'default' => '', + ], + 'StartTime' => [ + 'title' => '开始时间', + 'description' => '触发器有效期开始时间', + 'type' => 'string', + 'deprecated' => false, + 'example' => '1970-01-01 00:00:00', + 'pattern' => '', + 'default' => '', + ], + 'EndTime' => [ + 'title' => '结束时间', + 'description' => '触发器有效期结束时间', + 'type' => 'string', + 'deprecated' => false, + 'example' => '9999-01-01 00:00:00', + 'pattern' => '', + 'default' => '', + ], + 'Timezone' => [ + 'title' => '时区', + 'description' => '时区', + 'type' => 'string', + 'deprecated' => false, + 'example' => 'Asia/Shanghai', + 'pattern' => '', + 'default' => '', + ], + 'Id' => [ + 'description' => '触发器id。'."\n" + ."\n" + .'><notice>该字段在SDK8.0.0版本之前为Long类型，SDK8.0.0版本及之后为String类型。**该变更不影响SDK正常使用，参数仍会按SDK中定义的类型返回**。只有在跨8.0.0版本的SDK升级时，类型变更可能会导致项目编译不通过，需要用户手动修正数据类型。></notice>', + 'type' => 'string', + 'deprecated' => false, + 'example' => '543680677872062XXXX', + ], + ], + 'deprecated' => false, + ], + 'Script' => [ + 'title' => '脚本信息', + 'description' => '脚本信息', + 'type' => 'object', + 'properties' => [ + 'Path' => [ + 'title' => '脚本路径', + 'description' => '脚本路径', + 'type' => 'string', + 'deprecated' => false, + 'example' => 'root/demo', + 'pattern' => '', + 'default' => '', + ], + 'Runtime' => [ + 'title' => '运行时', + 'description' => '运行时', + 'type' => 'object', + 'properties' => [ + 'Command' => [ + 'title' => '命令', + 'description' => '命令，用于区分节点类型。', + 'type' => 'string', + 'deprecated' => false, + 'example' => 'ODPS_SQL', + 'pattern' => '', + 'default' => '', + ], + ], + 'deprecated' => false, + ], + 'Id' => [ + 'description' => '脚本id。'."\n" + ."\n" + .'><notice>该字段在SDK8.0.0版本之前为Long类型，SDK8.0.0版本及之后为String类型。**该变更不影响SDK正常使用，参数仍会按SDK中定义的类型返回**。只有在跨8.0.0版本的SDK升级时，类型变更可能会导致项目编译不通过，需要用户手动修正数据类型。></notice>', + 'type' => 'string', + 'deprecated' => false, + 'example' => '853573334108680XXXX', + ], + ], + 'deprecated' => false, + 'required' => false, + ], + 'RuntimeResource' => [ + 'title' => '资源组信息', + 'description' => '资源组信息', + 'type' => 'object', + 'properties' => [ + 'ResourceGroupId' => [ + 'title' => '资源组id', + 'description' => '资源组id', + 'type' => 'string', + 'deprecated' => false, + 'example' => '123456XXX', + 'pattern' => '', + 'default' => '', + ], + 'ResourceGroup' => [ + 'description' => '资源组的标识（Identifier）。您可以调用[ListResourceGroups](~~173913~~)接口获取资源组的标识（Identifier）。', + 'type' => 'string', + 'example' => 'S_res_group_XXXX', + ], + ], + 'deprecated' => false, + ], + 'Recurrence' => [ + 'description' => '调度类型'."\n" + ."\n" + .'可选值：'."\n" + ."\n" + .'- Normal：正常执行任务。'."\n" + ."\n" + .'- Pause：节点状态被置为暂停，并且会阻塞依赖当前节点的下游节点执行。'."\n" + ."\n" + .'- Skip：节点状态被置为空跑，系统会直接返回成功（执行时长为0秒），不会阻塞下游节点执行，也不会占用资源。', + 'type' => 'string', + 'enumValueTitles' => [], + 'example' => 'Normal', + ], + 'Id' => [ + 'description' => '数据开发节点的唯一标识符。'."\n" + ."\n" + .'><notice>该字段在SDK8.0.0版本之前为Long类型，SDK8.0.0版本及之后为String类型。**该变更不影响SDK正常使用，参数仍会按SDK中定义的类型返回**。只有在跨8.0.0版本的SDK升级时，类型变更可能会导致项目编译不通过，需要用户手动修正数据类型。></notice>', + 'type' => 'string', + 'example' => '860438872620113XXXX', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"2197B9C4-39CE-55EA-8EEA-FDBAE52DXXXX\\",\\n \\"PagingInfo\\": {\\n \\"TotalCount\\": \\"42\\",\\n \\"PageSize\\": \\"10\\",\\n \\"PageNumber\\": \\"1\\",\\n \\"Nodes\\": [\\n {\\n \\"Description\\": \\"Node description\\\\n\\",\\n \\"Name\\": \\"test\\",\\n \\"ProjectId\\": 33233,\\n \\"Owner\\": \\"110755000425XXXX\\",\\n \\"CreateTime\\": 1722910655000,\\n \\"ModifyTime\\": 1722910655000,\\n \\"DataSource\\": {\\n \\"Name\\": \\"odps_first\\",\\n \\"Type\\": \\"odps\\"\\n },\\n \\"TaskId\\": 88888888888,\\n \\"Tags\\": [\\n {\\n \\"Key\\": \\"null\\",\\n \\"Value\\": \\"null\\"\\n }\\n ],\\n \\"Strategy\\": {\\n \\"Timeout\\": 0,\\n \\"InstanceMode\\": \\"T+1\\",\\n \\"RerunMode\\": \\"Allowed\\",\\n \\"RerunTimes\\": 3,\\n \\"RerunInterval\\": 180000\\n },\\n \\"Outputs\\": {\\n \\"Variables\\": [\\n {\\n \\"Name\\": \\"output\\\\n\\",\\n \\"ArtifactType\\": \\"Variable\\",\\n \\"Scope\\": \\"NodeParameter\\",\\n \\"Type\\": \\"Constant\\",\\n \\"Value\\": \\"111\\",\\n \\"Node\\": {\\n \\"Output\\": \\"860438872620113XXXX\\"\\n },\\n \\"Id\\": \\"623731286945488XXXX\\"\\n }\\n ],\\n \\"NodeOutputs\\": [\\n {\\n \\"Data\\": \\"860438872620113XXXX\\"\\n }\\n ],\\n \\"Tables\\": [\\n {\\n \\"Guid\\": \\"odps.autotest.test_output_table_1\\"\\n }\\n ]\\n },\\n \\"Inputs\\": {\\n \\"Variables\\": [\\n {\\n \\"Name\\": \\"input\\",\\n \\"ArtifactType\\": \\"Variable\\",\\n \\"Scope\\": \\"NodeParameter\\",\\n \\"Type\\": \\"Constant\\",\\n \\"Value\\": \\"222\\",\\n \\"Node\\": {\\n \\"Output\\": \\"623731286945488XXXX\\"\\n },\\n \\"Id\\": \\"543211286945488XXXX\\"\\n }\\n ],\\n \\"NodeOutputs\\": [\\n {\\n \\"Data\\": \\"623731286945488XXXX\\"\\n }\\n ],\\n \\"Tables\\": [\\n {\\n \\"Guid\\": \\"odps.autotest.test_output_table_1\\"\\n }\\n ]\\n },\\n \\"Trigger\\": {\\n \\"Type\\": \\"Scheduler\\",\\n \\"Cron\\": \\"00 00 00 * * ?\\",\\n \\"StartTime\\": \\"1970-01-01 00:00:00\\",\\n \\"EndTime\\": \\"9999-01-01 00:00:00\\",\\n \\"Timezone\\": \\"Asia/Shanghai\\",\\n \\"Id\\": \\"543680677872062XXXX\\"\\n },\\n \\"Script\\": {\\n \\"Path\\": \\"root/demo\\",\\n \\"Runtime\\": {\\n \\"Command\\": \\"ODPS_SQL\\"\\n },\\n \\"Id\\": \\"853573334108680XXXX\\"\\n },\\n \\"RuntimeResource\\": {\\n \\"ResourceGroupId\\": \\"123456XXX\\",\\n \\"ResourceGroup\\": \\"S_res_group_XXXX\\"\\n },\\n \\"Recurrence\\": \\"Normal\\",\\n \\"Id\\": \\"860438872620113XXXX\\"\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => '获取数据开发节点列表', + ], + 'ListNodeDependencies' => [ + 'summary' => '分页获取指定数据开发节点的依赖节点。', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '236793', + 'abilityTreeNodes' => [ + 'FEATUREdideHO4TQP', + 'FEATUREdide8FM783', + 'FEATUREdideQUQUVB', + 'FEATUREdideIQU97M', + ], + ], + 'parameters' => [ + [ + 'name' => 'ProjectId', + 'in' => 'query', + 'schema' => [ + 'description' => 'DataWorks工作空间的ID。您可以登录[DataWorks控制台](https://workbench.data.aliyun.com/console)，进入工作空间配置页面获取工作空间ID。'."\n" + ."\n" + .'该参数用于确定本次API调用操作使用的DataWorks工作空间。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '10001', + ], + ], + [ + 'name' => 'Id', + 'in' => 'query', + 'schema' => [ + 'description' => '数据开发节点的唯一标识符。'."\n" + ."\n" + .'><notice>该字段在SDK8.0.0版本之前为Long类型，SDK8.0.0版本及之后为String类型。**该变更不影响SDK正常使用，参数仍会按SDK中定义的类型返回**。只有在跨8.0.0版本的SDK升级时，类型变更可能会导致项目编译不通过，需要用户手动修正数据类型。></notice>', + 'type' => 'string', + 'required' => true, + 'example' => '860438872620113XXXX', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '页码，从1开始。默认值为1。'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '2147483647', + 'minimum' => '1', + 'example' => '1', + 'default' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '每页显示的条数，默认为10条，最大100条。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '100', + 'minimum' => '10', + 'example' => '10', + 'default' => '10', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求的ID，用于定位日志，排查问题。', + 'type' => 'string', + 'example' => '204EAF68-CCE3-5112-8DA0-E7A60F02XXXX', + ], + 'PagingInfo' => [ + 'description' => '分页信息', + 'type' => 'object', + 'properties' => [ + 'TotalCount' => [ + 'description' => '满足条件的数据总条数。', + 'type' => 'string', + 'example' => '90', + ], + 'PageSize' => [ + 'description' => '每页显示的条数', + 'type' => 'string', + 'example' => '10', + ], + 'PageNumber' => [ + 'description' => '请求的数据页数，用于翻页。', + 'type' => 'string', + 'example' => '1', + ], + 'Nodes' => [ + 'description' => '查询到的依赖节点列表', + 'type' => 'array', + 'items' => [ + 'description' => '依赖节点列表元素', + 'type' => 'object', + 'properties' => [ + 'Description' => [ + 'title' => '描述', + 'description' => '节点描述信息', + 'type' => 'string', + 'example' => 'Node description', + ], + 'Name' => [ + 'title' => '节点名', + 'description' => '数据开发节点名称', + 'type' => 'string', + 'example' => 'Node name', + ], + 'ProjectId' => [ + 'description' => '数据开发节点所属的项目空间ID', + 'type' => 'integer', + 'format' => 'int64', + 'deprecated' => false, + 'example' => '65133', + ], + 'Owner' => [ + 'title' => '责任人', + 'description' => '数据开发节点的责任人', + 'type' => 'string', + 'deprecated' => false, + 'example' => '110755000425XXXX', + 'pattern' => '', + 'default' => '', + ], + 'CreateTime' => [ + 'title' => '创建时间', + 'description' => '数据开发节点的创建时间戳', + 'type' => 'integer', + 'format' => 'int64', + 'deprecated' => false, + 'example' => '1724505917000', + 'pattern' => '', + 'default' => '', + ], + 'ModifyTime' => [ + 'title' => '修改时间', + 'description' => '数据开发节点的最近修改时间戳', + 'type' => 'integer', + 'format' => 'int64', + 'deprecated' => false, + 'example' => '1724505917000', + 'pattern' => '', + 'default' => '', + ], + 'DataSource' => [ + 'title' => '数据源', + 'description' => '数据源', + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'title' => '数据源名称', + 'description' => '数据源名称', + 'type' => 'string', + 'deprecated' => false, + 'example' => 'odps_first', + 'pattern' => '', + 'default' => '', + ], + 'Type' => [ + 'title' => '数据源类型', + 'description' => '数据源类型', + 'type' => 'string', + 'deprecated' => false, + 'example' => 'odps', + 'pattern' => '', + 'default' => '', + ], + ], + 'deprecated' => false, + ], + 'TaskId' => [ + 'title' => '调度任务Id', + 'description' => '调度任务Id', + 'type' => 'integer', + 'format' => 'int64', + 'deprecated' => false, + 'example' => '580667964888595XXXX', + 'pattern' => '', + 'default' => '', + ], + 'Tags' => [ + 'title' => '标签信息', + 'description' => '标签信息，暂未使用', + 'type' => 'array', + 'items' => [ + 'title' => '单个标签', + 'description' => '单个标签信息，暂未使用', + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'title' => '标签键', + 'description' => '标签键', + 'type' => 'string', + 'deprecated' => false, + 'example' => 'null', + 'pattern' => '', + 'default' => '', + ], + 'Value' => [ + 'title' => '标签值', + 'description' => '标签值', + 'type' => 'string', + 'deprecated' => false, + 'example' => 'null', + 'pattern' => '', + 'default' => '', + ], + ], + 'deprecated' => false, + ], + 'deprecated' => false, + ], + 'Strategy' => [ + 'title' => '调度策略', + 'description' => '调度策略', + 'type' => 'object', + 'properties' => [ + 'Timeout' => [ + 'title' => '超时时间', + 'description' => '超时时间，单位为毫秒', + 'type' => 'integer', + 'format' => 'int32', + 'deprecated' => false, + 'example' => '0', + 'pattern' => '', + 'default' => '', + ], + 'InstanceMode' => [ + 'title' => '生成实例的模式', + 'description' => '生成实例的模式'."\n" + .'- T+1'."\n" + .'- Immediately', + 'type' => 'string', + 'deprecated' => false, + 'enumValueTitles' => [], + 'example' => 'T+1', + 'pattern' => '', + 'default' => '', + 'enum' => [ + 'T+1', + 'Immediately', + ], + ], + 'RerunMode' => [ + 'title' => '允许重跑的模式', + 'description' => '允许重跑的模式'."\n" + .'- Allowed'."\n" + .'- Denied'."\n" + .'- FailureAllowed', + 'type' => 'string', + 'deprecated' => false, + 'enumValueTitles' => [], + 'example' => 'Allowed', + 'pattern' => '', + 'default' => '', + 'enum' => [ + 'Allowed', + 'Denied', + 'FailureAllowed', + ], + ], + 'RerunTimes' => [ + 'title' => '重试次数', + 'description' => '失败后的重试次数', + 'type' => 'integer', + 'format' => 'int32', + 'deprecated' => false, + 'example' => '3', + 'pattern' => '', + 'default' => '', + ], + 'RerunInterval' => [ + 'title' => '重试时间间隔', + 'description' => '失败后重试时间间隔，单位毫秒', + 'type' => 'integer', + 'format' => 'int32', + 'deprecated' => false, + 'example' => '180000', + 'pattern' => '', + 'default' => '', + ], + ], + 'deprecated' => false, + ], + 'Outputs' => [ + 'title' => '节点输出', + 'description' => '节点输出', + 'type' => 'object', + 'properties' => [ + 'Variables' => [ + 'title' => '变量列表', + 'description' => '变量列表', + 'type' => 'array', + 'items' => [ + 'title' => '变量元素', + 'description' => '变量元素', + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'title' => '变量名', + 'description' => '变量名', + 'type' => 'string', + 'deprecated' => false, + 'example' => 'output', + 'pattern' => '', + 'default' => '', + ], + 'ArtifactType' => [ + 'title' => '制品类型', + 'description' => '制品类型', + 'type' => 'string', + 'deprecated' => false, + 'example' => 'Variable', + 'pattern' => '', + 'default' => '', + ], + 'Scope' => [ + 'title' => '范围', + 'description' => '变量作用范围'."\n" + .'- NodeParameter'."\n" + .'- NodeContext'."\n" + .'- Workflow'."\n" + .'- Workspace', + 'type' => 'string', + 'deprecated' => false, + 'enumValueTitles' => [], + 'example' => 'NodeParameter', + 'pattern' => '', + 'default' => '', + ], + 'Type' => [ + 'title' => '类型', + 'description' => '变量类型'."\n" + .'- NoKvVariableExpression'."\n" + .'- Constant'."\n" + .'- PassThrough'."\n" + .'- System'."\n" + .'- NodeOutput', + 'type' => 'string', + 'deprecated' => false, + 'enumValueTitles' => [], + 'example' => 'Constant', + 'pattern' => '', + 'default' => '', + ], + 'Value' => [ + 'title' => '变量值', + 'description' => '变量值', + 'type' => 'string', + 'deprecated' => false, + 'example' => '111', + 'pattern' => '', + 'default' => '', + ], + 'Node' => [ + 'title' => '变量所属节点', + 'description' => '变量所属节点', + 'type' => 'object', + 'properties' => [ + 'Output' => [ + 'title' => '节点输出', + 'description' => '变量对应的节点输出', + 'type' => 'string', + 'deprecated' => false, + 'example' => '463497880880954XXXX', + 'pattern' => '', + 'default' => '', + ], + ], + 'deprecated' => false, + ], + 'Id' => [ + 'description' => '变量id。'."\n" + ."\n" + .'><notice>该字段在SDK8.0.0版本之前为Long类型，SDK8.0.0版本及之后为String类型。**该变更不影响SDK正常使用，参数仍会按SDK中定义的类型返回**。只有在跨8.0.0版本的SDK升级时，类型变更可能会导致项目编译不通过，需要用户手动修正数据类型。></notice>', + 'type' => 'string', + 'deprecated' => false, + 'example' => '543217824470354XXXX', + ], + ], + 'deprecated' => false, + ], + 'deprecated' => false, + ], + 'NodeOutputs' => [ + 'title' => '节点输出列表', + 'description' => '节点输出列表', + 'type' => 'array', + 'items' => [ + 'title' => '节点输出项', + 'description' => '节点输出项', + 'type' => 'object', + 'properties' => [ + 'Data' => [ + 'title' => '节点输出', + 'description' => '节点输出', + 'type' => 'string', + 'deprecated' => false, + 'example' => '463497880880954XXXX', + 'pattern' => '', + 'default' => '', + ], + ], + 'deprecated' => false, + ], + 'deprecated' => false, + ], + 'Tables' => [ + 'title' => '表列表', + 'description' => '表列表', + 'type' => 'array', + 'items' => [ + 'title' => '表输出项', + 'description' => '表输出项', + 'type' => 'object', + 'properties' => [ + 'Guid' => [ + 'title' => '表id', + 'description' => '表id', + 'type' => 'string', + 'deprecated' => false, + 'example' => 'odps.autotest.test_output_table_1', + 'pattern' => '', + 'default' => '', + ], + ], + 'deprecated' => false, + ], + 'deprecated' => false, + ], + ], + 'deprecated' => false, + ], + 'Inputs' => [ + 'title' => '节点输入', + 'description' => '节点输入', + 'type' => 'object', + 'properties' => [ + 'Variables' => [ + 'title' => '变量列表', + 'description' => '变量列表', + 'type' => 'array', + 'items' => [ + 'title' => '变量元素', + 'description' => '变量元素', + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'title' => '变量名', + 'description' => '变量名', + 'type' => 'string', + 'deprecated' => false, + 'example' => 'input', + 'pattern' => '', + 'default' => '', + ], + 'ArtifactType' => [ + 'title' => '制品类型', + 'description' => '制品类型', + 'type' => 'string', + 'deprecated' => false, + 'example' => 'Variable', + 'pattern' => '', + 'default' => '', + ], + 'Scope' => [ + 'title' => '范围', + 'description' => '范围'."\n" + .'- NodeParameter'."\n" + .'- NodeContext'."\n" + .'- Workflow'."\n" + .'- Workspace', + 'type' => 'string', + 'deprecated' => false, + 'enumValueTitles' => [], + 'example' => 'NodeParameter', + 'pattern' => '', + 'default' => '', + ], + 'Type' => [ + 'title' => '类型', + 'description' => '类型'."\n" + .'- NoKvVariableExpression'."\n" + .'- Constant'."\n" + .'- PassThrough'."\n" + .'- System'."\n" + .'- NodeOutput', + 'type' => 'string', + 'deprecated' => false, + 'enumValueTitles' => [], + 'example' => 'Constant', + 'pattern' => '', + 'default' => '', + ], + 'Value' => [ + 'title' => '变量值', + 'description' => '变量值', + 'type' => 'string', + 'deprecated' => false, + 'example' => '111', + 'pattern' => '', + 'default' => '', + ], + 'Node' => [ + 'title' => '变量所属节点', + 'description' => '变量所属节点', + 'type' => 'object', + 'properties' => [ + 'Output' => [ + 'title' => '节点输出', + 'description' => '节点输出', + 'type' => 'string', + 'deprecated' => false, + 'example' => '860438872620113XXXX', + 'pattern' => '', + 'default' => '', + ], + ], + 'deprecated' => false, + ], + 'Id' => [ + 'description' => '变量id。'."\n" + ."\n" + .'><notice>该字段在SDK8.0.0版本之前为Long类型，SDK8.0.0版本及之后为String类型。**该变更不影响SDK正常使用，参数仍会按SDK中定义的类型返回**。只有在跨8.0.0版本的SDK升级时，类型变更可能会导致项目编译不通过，需要用户手动修正数据类型。></notice>', + 'type' => 'string', + 'deprecated' => false, + 'example' => '543218872620113XXXX', + ], + ], + 'deprecated' => false, + ], + 'deprecated' => false, + ], + 'NodeOutputs' => [ + 'title' => '节点输出列表', + 'description' => '节点输出列表', + 'type' => 'array', + 'items' => [ + 'title' => '节点输出项', + 'description' => '节点输出项', + 'type' => 'object', + 'properties' => [ + 'Data' => [ + 'title' => '节点输出', + 'description' => '节点输出', + 'type' => 'string', + 'deprecated' => false, + 'example' => '860438872620113XXXX', + 'pattern' => '', + 'default' => '', + ], + ], + 'deprecated' => false, + ], + 'deprecated' => false, + ], + 'Tables' => [ + 'title' => '表列表', + 'description' => '表列表', + 'type' => 'array', + 'items' => [ + 'title' => '表输出项', + 'description' => '表输出项', + 'type' => 'object', + 'properties' => [ + 'Guid' => [ + 'title' => '表id', + 'description' => '表id', + 'type' => 'string', + 'deprecated' => false, + 'example' => 'odps.autotest.test_output_table_1', + 'pattern' => '', + 'default' => '', + ], + ], + 'deprecated' => false, + ], + 'deprecated' => false, + ], + ], + 'deprecated' => false, + ], + 'Trigger' => [ + 'title' => '触发器', + 'description' => '触发器', + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'title' => '类型', + 'description' => '触发器类型'."\n" + ."\n" + .'可选值：'."\n" + ."\n" + .'- Scheduler： 周期调度'."\n" + .'- Manual：手动调度'."\n" + .'- Streaming：流式调度器', + 'type' => 'string', + 'deprecated' => false, + 'enumValueTitles' => [], + 'example' => 'Scheduler', + 'pattern' => '', + 'default' => '', + ], + 'Cron' => [ + 'title' => 'cron表达式', + 'description' => '调度的cron表达式', + 'type' => 'string', + 'deprecated' => false, + 'example' => '00 00 00 * * ?', + 'pattern' => '', + 'default' => '', + ], + 'StartTime' => [ + 'title' => '开始时间', + 'description' => '调度有效的开始时间，格式为yyyy-MM-dd HH:mm:ss', + 'type' => 'string', + 'deprecated' => false, + 'example' => '1970-01-01 00:00:00', + 'pattern' => '', + 'default' => '', + ], + 'EndTime' => [ + 'title' => '结束时间', + 'description' => '调度有效的结束时间，格式为yyyy-MM-dd HH:mm:ss', + 'type' => 'string', + 'deprecated' => false, + 'example' => '9999-01-01 00:00:00', + 'pattern' => '', + 'default' => '', + ], + 'Timezone' => [ + 'title' => '时区', + 'description' => '时区', + 'type' => 'string', + 'deprecated' => false, + 'example' => 'Asia/Shanghai', + 'pattern' => '', + 'default' => '', + ], + 'Id' => [ + 'description' => '触发器的唯一标识符。'."\n" + ."\n" + .'><notice>该字段在SDK8.0.0版本之前为Long类型，SDK8.0.0版本及之后为String类型。**该变更不影响SDK正常使用，参数仍会按SDK中定义的类型返回**。只有在跨8.0.0版本的SDK升级时，类型变更可能会导致项目编译不通过，需要用户手动修正数据类型。></notice>', + 'type' => 'string', + 'deprecated' => false, + 'example' => '543680677872062XXXX', + ], + ], + 'deprecated' => false, + ], + 'Script' => [ + 'title' => '脚本信息', + 'description' => '脚本信息', + 'type' => 'object', + 'properties' => [ + 'Path' => [ + 'title' => '脚本路径', + 'description' => '脚本路径', + 'type' => 'string', + 'deprecated' => false, + 'example' => 'root/demo', + 'pattern' => '', + 'default' => '', + ], + 'Runtime' => [ + 'title' => '运行时', + 'description' => '运行时', + 'type' => 'object', + 'properties' => [ + 'Command' => [ + 'title' => '命令', + 'description' => '命令，用于区分节点类型。', + 'type' => 'string', + 'deprecated' => false, + 'example' => 'ODPS_SQL', + 'pattern' => '', + 'default' => '', + ], + ], + 'deprecated' => false, + ], + 'Id' => [ + 'description' => '脚本id。'."\n" + ."\n" + .'><notice>该字段在SDK8.0.0版本之前为Long类型，SDK8.0.0版本及之后为String类型。**该变更不影响SDK正常使用，参数仍会按SDK中定义的类型返回**。只有在跨8.0.0版本的SDK升级时，类型变更可能会导致项目编译不通过，需要用户手动修正数据类型。></notice>', + 'type' => 'string', + 'deprecated' => false, + 'example' => '853573334108680XXXX', + ], + ], + 'deprecated' => false, + 'required' => false, + ], + 'RuntimeResource' => [ + 'title' => '资源组信息', + 'description' => '资源组信息', + 'type' => 'object', + 'properties' => [ + 'ResourceGroupId' => [ + 'title' => '资源组id', + 'description' => '资源组id', + 'type' => 'string', + 'deprecated' => false, + 'example' => 'S_res_group_XXXX_XXXX', + 'pattern' => '', + 'default' => '', + ], + ], + 'deprecated' => false, + ], + 'Recurrence' => [ + 'description' => '调度类型'."\n" + ."\n" + .'可选值：'."\n" + ."\n" + .'- Normal：正常执行任务。'."\n" + ."\n" + .'- Pause：节点状态被置为暂停，并且会阻塞依赖当前节点的下游节点执行。'."\n" + ."\n" + .'- Skip：节点状态被置为空跑，系统会直接返回成功（执行时长为0秒），不会阻塞下游节点执行，也不会占用资源。', + 'type' => 'string', + 'enumValueTitles' => [], + 'example' => 'Normal', + ], + 'Id' => [ + 'description' => '数据开发节点唯一标识符。'."\n" + ."\n" + .'><notice>该字段在SDK8.0.0版本之前为Long类型，SDK8.0.0版本及之后为String类型。**该变更不影响SDK正常使用，参数仍会按SDK中定义的类型返回**。只有在跨8.0.0版本的SDK升级时，类型变更可能会导致项目编译不通过，需要用户手动修正数据类型。></notice>', + 'type' => 'string', + 'example' => '723932906364267XXXX', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"204EAF68-CCE3-5112-8DA0-E7A60F02XXXX\\",\\n \\"PagingInfo\\": {\\n \\"TotalCount\\": \\"90\\",\\n \\"PageSize\\": \\"10\\",\\n \\"PageNumber\\": \\"1\\",\\n \\"Nodes\\": [\\n {\\n \\"Description\\": \\"Node description\\",\\n \\"Name\\": \\"Node name\\",\\n \\"ProjectId\\": 65133,\\n \\"Owner\\": \\"110755000425XXXX\\",\\n \\"CreateTime\\": 1724505917000,\\n \\"ModifyTime\\": 1724505917000,\\n \\"DataSource\\": {\\n \\"Name\\": \\"odps_first\\",\\n \\"Type\\": \\"odps\\"\\n },\\n \\"TaskId\\": 0,\\n \\"Tags\\": [\\n {\\n \\"Key\\": \\"null\\",\\n \\"Value\\": \\"null\\"\\n }\\n ],\\n \\"Strategy\\": {\\n \\"Timeout\\": 0,\\n \\"InstanceMode\\": \\"T+1\\",\\n \\"RerunMode\\": \\"Allowed\\",\\n \\"RerunTimes\\": 3,\\n \\"RerunInterval\\": 180000\\n },\\n \\"Outputs\\": {\\n \\"Variables\\": [\\n {\\n \\"Name\\": \\"output\\",\\n \\"ArtifactType\\": \\"Variable\\",\\n \\"Scope\\": \\"NodeParameter\\",\\n \\"Type\\": \\"Constant\\",\\n \\"Value\\": \\"111\\",\\n \\"Node\\": {\\n \\"Output\\": \\"463497880880954XXXX\\"\\n },\\n \\"Id\\": \\"543217824470354XXXX\\"\\n }\\n ],\\n \\"NodeOutputs\\": [\\n {\\n \\"Data\\": \\"463497880880954XXXX\\"\\n }\\n ],\\n \\"Tables\\": [\\n {\\n \\"Guid\\": \\"odps.autotest.test_output_table_1\\"\\n }\\n ]\\n },\\n \\"Inputs\\": {\\n \\"Variables\\": [\\n {\\n \\"Name\\": \\"input\\",\\n \\"ArtifactType\\": \\"Variable\\",\\n \\"Scope\\": \\"NodeParameter\\",\\n \\"Type\\": \\"Constant\\",\\n \\"Value\\": \\"111\\",\\n \\"Node\\": {\\n \\"Output\\": \\"860438872620113XXXX\\"\\n },\\n \\"Id\\": \\"543218872620113XXXX\\"\\n }\\n ],\\n \\"NodeOutputs\\": [\\n {\\n \\"Data\\": \\"860438872620113XXXX\\"\\n }\\n ],\\n \\"Tables\\": [\\n {\\n \\"Guid\\": \\"odps.autotest.test_output_table_1\\"\\n }\\n ]\\n },\\n \\"Trigger\\": {\\n \\"Type\\": \\"Scheduler\\",\\n \\"Cron\\": \\"00 00 00 * * ?\\",\\n \\"StartTime\\": \\"1970-01-01 00:00:00\\",\\n \\"EndTime\\": \\"9999-01-01 00:00:00\\",\\n \\"Timezone\\": \\"Asia/Shanghai\\",\\n \\"Id\\": \\"543680677872062XXXX\\"\\n },\\n \\"Script\\": {\\n \\"Path\\": \\"root/demo\\",\\n \\"Runtime\\": {\\n \\"Command\\": \\"ODPS_SQL\\"\\n },\\n \\"Id\\": \\"853573334108680XXXX\\"\\n },\\n \\"RuntimeResource\\": {\\n \\"ResourceGroupId\\": \\"S_res_group_XXXX_XXXX\\"\\n },\\n \\"Recurrence\\": \\"Normal\\",\\n \\"Id\\": \\"723932906364267XXXX\\"\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => '获取数据开发节点的依赖节点', + ], + 'CreateWorkflowDefinition' => [ + 'summary' => '调用该接口，在数据开发指定目录下创建一个工作流。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '234974', + 'abilityTreeNodes' => [ + 'FEATUREdideHO4TQP', + 'FEATUREdide8FM783', + 'FEATUREdideQUQUVB', + 'FEATUREdideIQU97M', + ], + ], + 'parameters' => [ + [ + 'name' => 'ProjectId', + 'in' => 'formData', + 'schema' => [ + 'description' => 'DataWorks工作空间的ID。您可以登录[DataWorks控制台](https://workbench.data.aliyun.com/console)，进入工作空间配置页面获取工作空间ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '10000', + ], + ], + [ + 'name' => 'Spec', + 'in' => 'formData', + 'schema' => [ + 'description' => '描述这个工作流的FlowSpec信息，具体规范详见[FlowSpec](https://github.com/aliyun/alibabacloud-dataworks-tool-dflow)。'."\n" + ."\n" + .'> 如何快速获取FlowSpec模板？'."\n" + .'> - 在数据开发中打开工作流->点击右上角“显示Spec，即可得到针对当前工作流的FlowSpec描述。可以基于该FlowSpec描述快速构建符合要求的模板。'."\n" + ."\n" + .'><notice>该接口只支持创建Workflow，FlowSpec描述的内部节点不会被创建出来。></notice>', + 'type' => 'string', + 'required' => true, + 'example' => '{'."\n" + .' "kind": "CycleWorkflow",'."\n" + .' "version": "1.1.0",'."\n" + .' "spec": {'."\n" + .' "name": "OpenAPITestWorkflowDemo",'."\n" + .' "type": "CycleWorkflow",'."\n" + .' "workflows": ['."\n" + .' {'."\n" + .' "script": {'."\n" + .' "path": "XX/OpenAPITest/WorkflowTest/OpenAPITestWorkflowDemo",'."\n" + .' "runtime": {'."\n" + .' "command": "WORKFLOW"'."\n" + .' }'."\n" + .' },'."\n" + .' "trigger": {'."\n" + .' "type": "Scheduler",'."\n" + .' "cron": "00 02 00 * * ?",'."\n" + .' "startTime": "1970-01-01 00:00:00",'."\n" + .' "endTime": "9999-01-01 00:00:00",'."\n" + .' "timezone": "Asia/Shanghai",'."\n" + .' "delaySeconds": 0'."\n" + .' },'."\n" + .' "strategy": {'."\n" + .' "timeout": 0,'."\n" + .' "instanceMode": "T+1",'."\n" + .' "rerunMode": "Allowed",'."\n" + .' "rerunTimes": 3,'."\n" + .' "rerunInterval": 180000,'."\n" + .' "failureStrategy": "Break"'."\n" + .' },'."\n" + .' "name": "OpenAPITestWorkflowDemo",'."\n" + .' "outputs": {'."\n" + .' "nodeOutputs": ['."\n" + .' {'."\n" + .' "data": "workflow_output",'."\n" + .' "artifactType": "NodeOutput",'."\n" + .' "refTableName": "OpenAPITestWorkflowDemo"'."\n" + .' }'."\n" + .' ]'."\n" + .' },'."\n" + .' "dependencies": []'."\n" + .' }'."\n" + .' ]'."\n" + .' }'."\n" + .'}', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。用于定位日志，排查问题。', + 'type' => 'string', + 'example' => '0EF298E5-0940-5AC7-9CB0-6502507****', + ], + 'Id' => [ + 'description' => '数据开发工作流的唯一标识符。'."\n" + ."\n" + .'><notice>该字段在SDK8.0.0版本之前为Long类型，SDK8.0.0版本及之后为String类型。**该变更不影响SDK正常使用，参数仍会按SDK中定义的类型返回**。只有在跨8.0.0版本的SDK升级时，类型变更可能会导致项目编译不通过，需要用户手动修正数据类型。></notice>', + 'type' => 'string', + 'example' => '463497880880954XXXX', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0EF298E5-0940-5AC7-9CB0-6502507****\\",\\n \\"Id\\": \\"463497880880954XXXX\\"\\n}","type":"json"}]', + 'title' => '创建数据开发工作流', + 'description' => '><notice>该接口不支持批量操作，若FlowSpec中定义了不止一个工作流，则除第一个以外的后续工作流均会被忽略。此外，工作流内部定义的节点也会被直接忽略，请调用CreateNode接口依次创建内部节点。></notice>', + ], + 'ImportWorkflowDefinition' => [ + 'summary' => '调用此接口，可以将通过FlowSpec定义的工作流节点和其内部的子节点都导入到数据开发中。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '246297', + 'abilityTreeNodes' => [ + 'FEATUREdideHO4TQP', + 'FEATUREdide8FM783', + 'FEATUREdideQUQUVB', + 'FEATUREdideIQU97M', + ], + ], + 'parameters' => [ + [ + 'name' => 'ProjectId', + 'in' => 'formData', + 'schema' => [ + 'description' => 'DataWorks工作空间的ID。您可以登录[DataWorks控制台](https://workbench.data.aliyun.com/console)，进入工作空间管理页面获取ID。'."\n" + ."\n" + .'该参数用来确定本次API调用操作使用的DataWorks工作空间。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '123456', + ], + ], + [ + 'name' => 'Spec', + 'in' => 'formData', + 'schema' => [ + 'description' => '描述这个工作流的FlowSpec信息，具体规范详见[FlowSpec](https://github.com/aliyun/alibabacloud-dataworks-tool-dflow/)。'."\n" + ."\n" + .'> 如何快速获取FlowSpec模板？'."\n" + .'> - 在数据开发中打开工作流->点击右上角“显示Spec，即可得到针对当前工作流的FlowSpec描述。可以基于该FlowSpec描述快速构建符合要求的模板。'."\n" + ."\n" + .'><notice>该接口支持同时创建Workflow和其内部节点，因此请注意FlowSpec中填写的ID。如果当前ID已经存在，则会变为更新操作，只有不填写ID或ID不存在时才会变为创建操作。></notice>', + 'type' => 'string', + 'required' => true, + 'example' => '{'."\n" + .' "version": "1.1.0",'."\n" + .' "kind": "CycleWorkflow",'."\n" + .' "spec": {'."\n" + .' "name": "Asynchronous_Workflow_Creation_Test",'."\n" + .' "id": "632647691239009XXXX",'."\n" + .' "type": "CycleWorkflow",'."\n" + .' "workflows": ['."\n" + .' {'."\n" + .' "script": {'."\n" + .' "path": "XX/OpenAPI_Test/Workflow_Test/Asynchronous_Workflow_Creation_Test",'."\n" + .' "runtime": {'."\n" + .' "command": "WORKFLOW"'."\n" + .' }'."\n" + .' },'."\n" + .' "id": "632647691239009XXXX",'."\n" + .' "trigger": {'."\n" + .' "type": "Scheduler",'."\n" + .' "cron": "00 03 00 * * ?",'."\n" + .' "startTime": "1970-01-01 00:00:00",'."\n" + .' "endTime": "9999-01-01 00:00:00",'."\n" + .' "timezone": "Asia/Shanghai",'."\n" + .' "delaySeconds": 0'."\n" + .' },'."\n" + .' "strategy": {'."\n" + .' "timeout": 0,'."\n" + .' "instanceMode": "T+1",'."\n" + .' "rerunMode": "Allowed",'."\n" + .' "rerunTimes": 3,'."\n" + .' "rerunInterval": 180000,'."\n" + .' "failureStrategy": "Break"'."\n" + .' },'."\n" + .' "name": "Asynchronous_Workflow_Creation_Test",'."\n" + .' "inputs": {},'."\n" + .' "outputs": {'."\n" + .' "nodeOutputs": ['."\n" + .' {'."\n" + .' "data": "632647691239009XXXX",'."\n" + .' "artifactType": "NodeOutput",'."\n" + .' "refTableName": "Asynchronous_Workflow_Creation_Test"'."\n" + .' }'."\n" + .' ]'."\n" + .' },'."\n" + .' "nodes": ['."\n" + .' {'."\n" + .' "recurrence": "Normal",'."\n" + .' "id": "742981001612325XXXX",'."\n" + .' "timeout": 0,'."\n" + .' "instanceMode": "T+1",'."\n" + .' "rerunMode": "Allowed",'."\n" + .' "rerunTimes": 3,'."\n" + .' "rerunInterval": 180000,'."\n" + .' "script": {'."\n" + .' "path": "XX/OpenAPI_Test/Workflow_Test/Asynchronous_Workflow_Creation_Test/111",'."\n" + .' "runtime": {'."\n" + .' "command": "ODPS_SQL"'."\n" + .' },'."\n" + .' "content": "select now();\\n"'."\n" + .' },'."\n" + .' "trigger": {'."\n" + .' "type": "Scheduler",'."\n" + .' "cron": "00 24 00 * * ?",'."\n" + .' "startTime": "1970-01-01 00:00:00",'."\n" + .' "endTime": "9999-01-01 00:00:00",'."\n" + .' "timezone": "Asia/Shanghai",'."\n" + .' "delaySeconds": 0'."\n" + .' },'."\n" + .' "name": "111",'."\n" + .' "inputs": {},'."\n" + .' "outputs": {'."\n" + .' "nodeOutputs": ['."\n" + .' {'."\n" + .' "data": "742981001612325XXXX",'."\n" + .' "artifactType": "NodeOutput",'."\n" + .' "refTableName": "111"'."\n" + .' }'."\n" + .' ]'."\n" + .' }'."\n" + .' },'."\n" + .' {'."\n" + .' "recurrence": "Normal",'."\n" + .' "id": "595182137303408XXXX",'."\n" + .' "timeout": 0,'."\n" + .' "instanceMode": "T+1",'."\n" + .' "rerunMode": "Allowed",'."\n" + .' "rerunTimes": 3,'."\n" + .' "rerunInterval": 180000,'."\n" + .' "script": {'."\n" + .' "path": "XX/OpenAPI_Test/Workflow_Test/Asynchronous_Workflow_Creation_Test/222",'."\n" + .' "runtime": {'."\n" + .' "command": "ODPS_SQL"'."\n" + .' },'."\n" + .' "content": "select now();\\n select 1;"'."\n" + .' },'."\n" + .' "trigger": {'."\n" + .' "type": "Scheduler",'."\n" + .' "cron": "00 00 00 * * ?",'."\n" + .' "startTime": "1970-01-01 00:00:00",'."\n" + .' "endTime": "9999-01-01 00:00:00",'."\n" + .' "timezone": "Asia/Shanghai",'."\n" + .' "delaySeconds": 0'."\n" + .' },'."\n" + .' "name": "222",'."\n" + .' "inputs": {},'."\n" + .' "outputs": {'."\n" + .' "nodeOutputs": ['."\n" + .' {'."\n" + .' "data": "595182137303408XXXX",'."\n" + .' "artifactType": "NodeOutput",'."\n" + .' "refTableName": "222" '."\n" + .' }'."\n" + .' ]'."\n" + .' }'."\n" + .' }'."\n" + .' ],'."\n" + .' "dependencies": ['."\n" + .' {'."\n" + .' "nodeId": "595182137303408XXXX",'."\n" + .' "depends": ['."\n" + .' {'."\n" + .' "type": "Normal",'."\n" + .' "output": "742981001612325XXXX",'."\n" + .' "refTableName": "111"'."\n" + .' }'."\n" + .' ]'."\n" + .' }'."\n" + .' ]'."\n" + .' }'."\n" + .' ]'."\n" + .' }'."\n" + .'}', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。用于出现错误后排查问题。', + 'type' => 'string', + 'example' => '7C352CB7-CD88-50CF-9D0D-E81BDF020E7F', + ], + 'AsyncJob' => [ + 'description' => '异步任务状态信息。', + 'type' => 'object', + 'properties' => [ + 'Completed' => [ + 'description' => '异步任务是否完成。', + 'type' => 'boolean', + 'example' => 'false', + ], + 'CreateTime' => [ + 'description' => '异步任务创建时间戳。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1706581425000', + ], + 'Error' => [ + 'description' => '当异步任务失败时的错误信息。', + 'type' => 'string', + 'example' => 'target folder already exists: XXXX', + ], + 'Id' => [ + 'description' => '异步任务的ID。', + 'type' => 'string', + 'example' => '1234567691239009XXXX', + ], + 'Progress' => [ + 'description' => '异步任务完成进度，范围区间为0-100', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'Response' => [ + 'description' => '该异步任务希望返回的内容。'."\n" + ."\n" + .'> 该字段目前存放在异步任务中被创建的工作流的ID。', + 'type' => 'string', + 'example' => '632647691239009XXXX', + ], + 'Status' => [ + 'description' => '异步任务的状态。'."\n" + ."\n" + .'可选值'."\n" + ."\n" + .'- Running 正在运行'."\n" + .'- Success 执行成功'."\n" + .'- Fail 执行失败'."\n" + .'- Cancel 任务被取消', + 'type' => 'string', + 'enumValueTitles' => [], + 'example' => 'Running', + ], + 'Type' => [ + 'description' => '异步任务操作类型'."\n" + ."\n" + .'可选值'."\n" + ."\n" + .'- Create 创建，创建一个资源的Job。 '."\n" + .'- Cancel 取消，取消某一个创建Job。', + 'type' => 'string', + 'enumValueTitles' => [], + 'example' => 'Create', + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'asynchronous', + 'callback' => 'dataworks-public::2024-05-18::GetJobStatus', + 'callbackInterval' => 1000, + 'maxCallbackTimes' => 10, + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"7C352CB7-CD88-50CF-9D0D-E81BDF020E7F\\",\\n \\"AsyncJob\\": {\\n \\"Completed\\": false,\\n \\"CreateTime\\": 1706581425000,\\n \\"Error\\": \\"target folder already exists: XXXX\\",\\n \\"Id\\": \\"1234567691239009XXXX\\",\\n \\"Progress\\": 0,\\n \\"Response\\": \\"632647691239009XXXX\\",\\n \\"Status\\": \\"Running\\",\\n \\"Type\\": \\"Create\\"\\n }\\n}","type":"json"}]', + 'title' => '导入数据开发工作流', + 'description' => '><notice>'."\n" + ."\n" + .'- 该接口不支持导入多个工作流，若FlowSpec中定义了不止一个工作流，则除第一个以外的后续工作流将被忽略。'."\n" + ."\n" + .'- 这是一个异步接口，调用该接口将返回一个异步任务的对象。任务具体的执行状态需要调用GetJobStatus查询。></notice>', + ], + 'DeleteWorkflowDefinition' => [ + 'summary' => '调用该接口，在数据开发中删除指定的工作流。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '234975', + 'abilityTreeNodes' => [ + 'FEATUREdideHO4TQP', + 'FEATUREdide8FM783', + 'FEATUREdideQUQUVB', + 'FEATUREdideIQU97M', + ], + ], + 'parameters' => [ + [ + 'name' => 'ProjectId', + 'in' => 'formData', + 'schema' => [ + 'description' => 'DataWorks工作空间的ID。您可以登录[DataWorks控制台](https://workbench.data.aliyun.com/console)，进入工作空间配置页面获取工作空间ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '10000', + ], + ], + [ + 'name' => 'Id', + 'in' => 'formData', + 'schema' => [ + 'description' => '数据开发工作流的唯一标识符。'."\n" + ."\n" + .'><notice>该字段在SDK8.0.0版本之前为Long类型，SDK8.0.0版本及之后为String类型。**该变更不影响SDK正常使用，参数仍会按SDK中定义的类型返回**。只有在跨8.0.0版本的SDK升级时，类型变更可能会导致项目编译不通过，需要用户手动修正数据类型。></notice>', + 'type' => 'string', + 'required' => true, + 'example' => '860438872620113XXXX', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID，用于后续错误排查使用。', + 'type' => 'string', + 'example' => 'B17730C0-D959-548A-AE23-E754177CXXXX', + ], + 'Success' => [ + 'description' => '操作是否成功。取值如下：'."\n" + ."\n" + .'- true：成功。'."\n" + ."\n" + .'- false：失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"B17730C0-D959-548A-AE23-E754177CXXXX\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => '删除数据开发工作流', + 'description' => '><notice>当这个工作流被发布后，无法删除，必须先下线再进行删除。></notice>', + ], + 'UpdateWorkflowDefinition' => [ + 'summary' => '调用此接口，可以更新数据开发工作流基本信息。更新以增量更新的方式进行，更新信息以FlowSpec格式描述。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '234976', + 'abilityTreeNodes' => [ + 'FEATUREdideHO4TQP', + 'FEATUREdide8FM783', + 'FEATUREdideQUQUVB', + 'FEATUREdideIQU97M', + ], + ], + 'parameters' => [ + [ + 'name' => 'ProjectId', + 'in' => 'formData', + 'schema' => [ + 'description' => 'DataWorks工作空间的ID，您可以登录[DataWorks控制台](https://workbench.data.aliyun.com/console)，进入工作空间管理页面查看ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '10001', + ], + ], + [ + 'name' => 'Id', + 'in' => 'formData', + 'schema' => [ + 'description' => '数据开发工作流唯一标识符。'."\n" + ."\n" + .'><notice>该字段在SDK8.0.0版本之前为Long类型，SDK8.0.0版本及之后为String类型。**该变更不影响SDK正常使用，参数仍会按SDK中定义的类型返回**。只有在跨8.0.0版本的SDK升级时，类型变更可能会导致项目编译不通过，需要用户手动修正数据类型。></notice>', + 'type' => 'string', + 'required' => true, + 'example' => '652567824470354XXXX', + ], + ], + [ + 'name' => 'Spec', + 'in' => 'formData', + 'schema' => [ + 'description' => '描述这个工作流的FlowSpec信息，具体规范详见[FlowSpec](https://github.com/aliyun/alibabacloud-dataworks-tool-dflow)。'."\n" + ."\n" + .'><notice>该接口只支持更新Workflow自身的信息，FlowSpec描述的内部节点信息不会被更新。></notice>', + 'type' => 'string', + 'required' => true, + 'example' => '{'."\n" + .' "kind": "CycleWorkflow",'."\n" + .' "version": "1.1.0",'."\n" + .' "spec": {'."\n" + .' "workflows": ['."\n" + .' {'."\n" + .' "id": "652567824470354XXXX",'."\n" + .' "script": {'."\n" + .' "path": "XX/OpenAPI_Test/Workflow_Test/OpenAPI_Test_Workflow_Demo",'."\n" + .' "runtime": {'."\n" + .' "command": "WORKFLOW"'."\n" + .' }'."\n" + .' },'."\n" + .' "trigger": {'."\n" + .' "type": "Scheduler",'."\n" + .' "cron": "00 02 00 * * ?",'."\n" + .' "startTime": "1970-01-01 00:00:00",'."\n" + .' "endTime": "9999-01-01 00:00:00",'."\n" + .' "timezone": "Asia/Shanghai",'."\n" + .' "delaySeconds": 0'."\n" + .' },'."\n" + .' "strategy": {'."\n" + .' "timeout": 0,'."\n" + .' "instanceMode": "T+1",'."\n" + .' "rerunMode": "Allowed",'."\n" + .' "rerunTimes": 3,'."\n" + .' "rerunInterval": 180000,'."\n" + .' "failureStrategy": "Break"'."\n" + .' },'."\n" + .' "name": "OpenAPI_Test_Workflow_Demo",'."\n" + .' "outputs": {'."\n" + .' "nodeOutputs": ['."\n" + .' {'."\n" + .' "data": "workflow_output",'."\n" + .' "artifactType": "NodeOutput",'."\n" + .' "refTableName": "OpenAPI_Test_Workflow_Demo"'."\n" + .' }'."\n" + .' ]'."\n" + .' },'."\n" + .' "dependencies": []'."\n" + .' }'."\n" + .' ]'."\n" + .' }'."\n" + .'}', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求的ID。用于定位日志，排查问题。', + 'type' => 'string', + 'example' => '20BF7E80-668A-5620-8AD8-879B8FEA****', + ], + 'Success' => [ + 'description' => '是否调用成功，取值如下：'."\n" + ."\n" + .'- true：调用成功。 '."\n" + .'- false：调用失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"20BF7E80-668A-5620-8AD8-879B8FEA****\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => '更新数据开发工作流信息', + 'description' => '><notice>该接口不支持批量操作，若FlowSpec中定义了不止一个工作流，则除第一个以外的后续工作流均会被忽略。此外，工作流内部定义的节点也会被直接忽略，请调用UpdateNode接口依次更新内部节点。></notice>', + ], + 'MoveWorkflowDefinition' => [ + 'summary' => '调用此接口，可以将指定的数据开发工作流移动到数据开发目录的目标路径。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '235450', + 'abilityTreeNodes' => [ + 'FEATUREdideHO4TQP', + 'FEATUREdide8FM783', + 'FEATUREdideQUQUVB', + 'FEATUREdideIQU97M', + ], + ], + 'parameters' => [ + [ + 'name' => 'ProjectId', + 'in' => 'formData', + 'schema' => [ + 'description' => 'DataWorks工作空间的ID。您可以登录[DataWorks控制台](https://workbench.data.aliyun.com/console)，进入工作空间配置页面获取工作空间ID。'."\n" + .'该参数用来确定本次API调用操作使用的DataWorks工作空间。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '10001', + ], + ], + [ + 'name' => 'Id', + 'in' => 'formData', + 'schema' => [ + 'description' => '数据开发工作流的唯一标识符。'."\n" + ."\n" + .'><notice>该字段在SDK8.0.0版本之前为Long类型，SDK8.0.0版本及之后为String类型。**该变更不影响SDK正常使用，参数仍会按SDK中定义的类型返回**。只有在跨8.0.0版本的SDK升级时，类型变更可能会导致项目编译不通过，需要用户手动修正数据类型。></notice>', + 'type' => 'string', + 'required' => true, + 'example' => '543217824470354XXXX', + ], + ], + [ + 'name' => 'Path', + 'in' => 'formData', + 'schema' => [ + 'description' => '移动的目标路径，不需要带工作流名称。'."\n" + ."\n" + .'例如将test工作流的路径变成到root/demo/test，则此参数需要填写root/demo', + 'type' => 'string', + 'required' => true, + 'example' => 'root/demo', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求的ID。用于定位日志，排查问题。', + 'type' => 'string', + 'example' => '05ADAF4F-7709-5FB1-B606-3513483FXXXX', + ], + 'Success' => [ + 'description' => '请求是否成功：'."\n" + .'- true（成功）'."\n" + .'- false（失败）', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"05ADAF4F-7709-5FB1-B606-3513483FXXXX\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => '移动数据开发工作流路径', + ], + 'RenameWorkflowDefinition' => [ + 'summary' => '调用此接口，可以重命名数据开发工作流。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '235462', + 'abilityTreeNodes' => [ + 'FEATUREdideHO4TQP', + 'FEATUREdideQUQUVB', + 'FEATUREdideLJFKLG', + 'FEATUREdideIQU97M', + ], + ], + 'parameters' => [ + [ + 'name' => 'ProjectId', + 'in' => 'query', + 'schema' => [ + 'description' => 'DataWorks工作空间的ID。您可以登录[DataWorks控制台](https://workbench.data.aliyun.com/console)，进入工作空间配置页面获取工作空间ID。'."\n" + .'该参数用来确定本次API调用操作使用的DataWorks工作空间。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '10000', + ], + ], + [ + 'name' => 'Id', + 'in' => 'query', + 'schema' => [ + 'description' => '数据开发工作流的唯一标识符。'."\n" + ."\n" + .'><notice>该字段在SDK8.0.0版本之前为Long类型，SDK8.0.0版本及之后为String类型。**该变更不影响SDK正常使用，参数仍会按SDK中定义的类型返回**。只有在跨8.0.0版本的SDK升级时，类型变更可能会导致项目编译不通过，需要用户手动修正数据类型。></notice>', + 'type' => 'string', + 'required' => true, + 'example' => '463497880880954****', + ], + ], + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => [ + 'description' => '希望重命名的名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'Rename', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。用于出现错误后排查问题。', + 'type' => 'string', + 'example' => '975BD43D-C421-595C-A29C-565A8AD5XXXX', + ], + 'Success' => [ + 'description' => '调用是否成功。取值如下：'."\n" + .'- true：调用成功。'."\n" + .'- false：调用失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"975BD43D-C421-595C-A29C-565A8AD5XXXX\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => '重命名数据开发工作流', + ], + 'GetWorkflowDefinition' => [ + 'summary' => '调用该接口，可以获取指定工作流的详细信息。', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '234973', + 'abilityTreeNodes' => [ + 'FEATUREdideHO4TQP', + 'FEATUREdide8FM783', + 'FEATUREdideQUQUVB', + 'FEATUREdideIQU97M', + ], + ], + 'parameters' => [ + [ + 'name' => 'ProjectId', + 'in' => 'query', + 'schema' => [ + 'description' => 'DataWorks工作空间的ID。您可以登录[DataWorks控制台](https://workbench.data.aliyun.com/console)，进入工作空间管理页面获取ID。'."\n" + ."\n" + .'该参数用来确定本次API调用操作使用的DataWorks工作空间。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '10000', + ], + ], + [ + 'name' => 'Id', + 'in' => 'query', + 'schema' => [ + 'description' => '数据开发工作流唯一标识符。'."\n" + ."\n" + .'><notice>该字段在SDK8.0.0版本之前为Long类型，SDK8.0.0版本及之后为String类型。**该变更不影响SDK正常使用，参数仍会按SDK中定义的类型返回**。只有在跨8.0.0版本的SDK升级时，类型变更可能会导致项目编译不通过，需要用户手动修正数据类型。></notice>', + 'type' => 'string', + 'required' => true, + 'example' => '860438872620****', + ], + ], + [ + 'name' => 'IncludeScriptContent', + 'in' => 'query', + 'schema' => [ + 'description' => '查询结果是否包含工作流内部节点的脚本内容（对于内容较多的节点，可能存在较长的网络传输延时）。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求的ID。用于定位日志，排查问题。', + 'type' => 'string', + 'example' => 'F2BDD628-8A21-5BD1-B930-1A2D5989XXXX', + ], + 'WorkflowDefinition' => [ + 'description' => '数据开发工作流的详细信息', + 'type' => 'object', + 'properties' => [ + 'ProjectId' => [ + 'description' => '数据开发工作流所在工作空间的ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '307XXX', + ], + 'Name' => [ + 'description' => '数据开发工作流名称', + 'type' => 'string', + 'example' => 'OpenAPI test workflow Demo', + ], + 'Owner' => [ + 'description' => '数据开发工作流的责任人', + 'type' => 'string', + 'example' => '110755000425XXXX', + ], + 'CreateTime' => [ + 'description' => '数据开发工作流的创建时间戳', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1708481905000', + ], + 'ModifyTime' => [ + 'description' => '数据开发工作流的最近更新时间戳', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1708481905000'."\n", + ], + 'Spec' => [ + 'description' => '描述这个工作流的FlowSpec信息，具体规范详见[FlowSpec](https://github.com/aliyun/alibabacloud-dataworks-tool-dflow/)。', + 'type' => 'string', + 'example' => '{'."\n" + .' "metadata": {'."\n" + .' "tenantId": "52425742456XXXX",'."\n" + .' "projectId": "307XXXX",'."\n" + .' "uuid": "463497880880954XXXX"'."\n" + .' },'."\n" + .' "kind": "CycleWorkflow",'."\n" + .' "version": "1.1.0",'."\n" + .' "spec": {'."\n" + .' "name": "OpenAPI_Test_Workflow_Demo",'."\n" + .' "id": "463497880880954XXXX",'."\n" + .' "type": "CycleWorkflow",'."\n" + .' "owner": "110755000425XXXX",'."\n" + .' "workflows": ['."\n" + .' {'."\n" + .' "script": {'."\n" + .' "path": "XX/OpenAPI_Test/Workflow_Test/OpenAPI_Test_Workflow_Demo",'."\n" + .' "runtime": {'."\n" + .' "command": "WORKFLOW"'."\n" + .' },'."\n" + .' "id": "698002781368644XXXX"'."\n" + .' },'."\n" + .' "id": "463497880880954XXXX",'."\n" + .' "trigger": {'."\n" + .' "type": "Scheduler",'."\n" + .' "id": "652567824470354XXXX",'."\n" + .' "cron": "00 02 00 * * ?",'."\n" + .' "startTime": "1970-01-01 00:00:00",'."\n" + .' "endTime": "9999-01-01 00:00:00",'."\n" + .' "timezone": "Asia/Shanghai",'."\n" + .' "delaySeconds": 0'."\n" + .' },'."\n" + .' "strategy": {'."\n" + .' "timeout": 0,'."\n" + .' "instanceMode": "T+1",'."\n" + .' "rerunMode": "Allowed",'."\n" + .' "rerunTimes": 3,'."\n" + .' "rerunInterval": 180000,'."\n" + .' "failureStrategy": "Break"'."\n" + .' },'."\n" + .' "name": "OpenAPI_Test_Workflow_Demo",'."\n" + .' "owner": "110755000425XXXX",'."\n" + .' "metadata": {'."\n" + .' "owner": "110755000425XXXX",'."\n" + .' "ownerName": "[email protected]",'."\n" + .' "tenantId": "52425742456XXXX",'."\n" + .' "project": {'."\n" + .' "mode": "STANDARD",'."\n" + .' "projectId": "307303",'."\n" + .' "projectIdentifier": "lwttest_standard",'."\n" + .' "projectName": "XXXX",'."\n" + .' "projectOwnerId": "110755000425XXXX",'."\n" + .' "simple": false,'."\n" + .' "tenantId": "52425742456XXXX"'."\n" + .' },'."\n" + .' "projectId": "307XXXX"'."\n" + .' },'."\n" + .' "inputs": {},'."\n" + .' "outputs": {'."\n" + .' "nodeOutputs": ['."\n" + .' {'."\n" + .' "data": "463497880880954XXXX",'."\n" + .' "artifactType": "NodeOutput",'."\n" + .' "refTableName": "OpenAPI_Test_Workflow_Demo",'."\n" + .' "isDefault": true'."\n" + .' }'."\n" + .' ]'."\n" + .' },'."\n" + .' "nodes": [],'."\n" + .' "dependencies": []'."\n" + .' }'."\n" + .' ]'."\n" + .' }'."\n" + .'}', + ], + 'WorkflowId' => [ + 'description' => '发布后在调度侧的工作流ID', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '700006657495', + ], + 'Id' => [ + 'description' => '数据开发工作流唯一标识符。'."\n" + ."\n" + .'><notice>该字段在SDK8.0.0版本之前为Long类型，SDK8.0.0版本及之后为String类型。**该变更不影响SDK正常使用，参数仍会按SDK中定义的类型返回**。只有在跨8.0.0版本的SDK升级时，类型变更可能会导致项目编译不通过，需要用户手动修正数据类型。></notice>', + 'type' => 'string', + 'example' => '463497880880954XXXX', + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F2BDD628-8A21-5BD1-B930-1A2D5989XXXX\\",\\n \\"WorkflowDefinition\\": {\\n \\"ProjectId\\": 0,\\n \\"Name\\": \\"OpenAPI test workflow Demo\\",\\n \\"Owner\\": \\"110755000425XXXX\\",\\n \\"CreateTime\\": 1708481905000,\\n \\"ModifyTime\\": 1708481905000,\\n \\"Spec\\": \\"{\\\\n \\\\\\"metadata\\\\\\": {\\\\n \\\\\\"tenantId\\\\\\": \\\\\\"52425742456XXXX\\\\\\",\\\\n \\\\\\"projectId\\\\\\": \\\\\\"307XXXX\\\\\\",\\\\n \\\\\\"uuid\\\\\\": \\\\\\"463497880880954XXXX\\\\\\"\\\\n },\\\\n \\\\\\"kind\\\\\\": \\\\\\"CycleWorkflow\\\\\\",\\\\n \\\\\\"version\\\\\\": \\\\\\"1.1.0\\\\\\",\\\\n \\\\\\"spec\\\\\\": {\\\\n \\\\\\"name\\\\\\": \\\\\\"OpenAPI_Test_Workflow_Demo\\\\\\",\\\\n \\\\\\"id\\\\\\": \\\\\\"463497880880954XXXX\\\\\\",\\\\n \\\\\\"type\\\\\\": \\\\\\"CycleWorkflow\\\\\\",\\\\n \\\\\\"owner\\\\\\": \\\\\\"110755000425XXXX\\\\\\",\\\\n \\\\\\"workflows\\\\\\": [\\\\n {\\\\n \\\\\\"script\\\\\\": {\\\\n \\\\\\"path\\\\\\": \\\\\\"XX/OpenAPI_Test/Workflow_Test/OpenAPI_Test_Workflow_Demo\\\\\\",\\\\n \\\\\\"runtime\\\\\\": {\\\\n \\\\\\"command\\\\\\": \\\\\\"WORKFLOW\\\\\\"\\\\n },\\\\n \\\\\\"id\\\\\\": \\\\\\"698002781368644XXXX\\\\\\"\\\\n },\\\\n \\\\\\"id\\\\\\": \\\\\\"463497880880954XXXX\\\\\\",\\\\n \\\\\\"trigger\\\\\\": {\\\\n \\\\\\"type\\\\\\": \\\\\\"Scheduler\\\\\\",\\\\n \\\\\\"id\\\\\\": \\\\\\"652567824470354XXXX\\\\\\",\\\\n \\\\\\"cron\\\\\\": \\\\\\"00 02 00 * * ?\\\\\\",\\\\n \\\\\\"startTime\\\\\\": \\\\\\"1970-01-01 00:00:00\\\\\\",\\\\n \\\\\\"endTime\\\\\\": \\\\\\"9999-01-01 00:00:00\\\\\\",\\\\n \\\\\\"timezone\\\\\\": \\\\\\"Asia/Shanghai\\\\\\",\\\\n \\\\\\"delaySeconds\\\\\\": 0\\\\n },\\\\n \\\\\\"strategy\\\\\\": {\\\\n \\\\\\"timeout\\\\\\": 0,\\\\n \\\\\\"instanceMode\\\\\\": \\\\\\"T+1\\\\\\",\\\\n \\\\\\"rerunMode\\\\\\": \\\\\\"Allowed\\\\\\",\\\\n \\\\\\"rerunTimes\\\\\\": 3,\\\\n \\\\\\"rerunInterval\\\\\\": 180000,\\\\n \\\\\\"failureStrategy\\\\\\": \\\\\\"Break\\\\\\"\\\\n },\\\\n \\\\\\"name\\\\\\": \\\\\\"OpenAPI_Test_Workflow_Demo\\\\\\",\\\\n \\\\\\"owner\\\\\\": \\\\\\"110755000425XXXX\\\\\\",\\\\n \\\\\\"metadata\\\\\\": {\\\\n \\\\\\"owner\\\\\\": \\\\\\"110755000425XXXX\\\\\\",\\\\n \\\\\\"ownerName\\\\\\": \\\\\\"[email protected]\\\\\\",\\\\n \\\\\\"tenantId\\\\\\": \\\\\\"52425742456XXXX\\\\\\",\\\\n \\\\\\"project\\\\\\": {\\\\n \\\\\\"mode\\\\\\": \\\\\\"STANDARD\\\\\\",\\\\n \\\\\\"projectId\\\\\\": \\\\\\"307303\\\\\\",\\\\n \\\\\\"projectIdentifier\\\\\\": \\\\\\"lwttest_standard\\\\\\",\\\\n \\\\\\"projectName\\\\\\": \\\\\\"XXXX\\\\\\",\\\\n \\\\\\"projectOwnerId\\\\\\": \\\\\\"110755000425XXXX\\\\\\",\\\\n \\\\\\"simple\\\\\\": false,\\\\n \\\\\\"tenantId\\\\\\": \\\\\\"52425742456XXXX\\\\\\"\\\\n },\\\\n \\\\\\"projectId\\\\\\": \\\\\\"307XXXX\\\\\\"\\\\n },\\\\n \\\\\\"inputs\\\\\\": {},\\\\n \\\\\\"outputs\\\\\\": {\\\\n \\\\\\"nodeOutputs\\\\\\": [\\\\n {\\\\n \\\\\\"data\\\\\\": \\\\\\"463497880880954XXXX\\\\\\",\\\\n \\\\\\"artifactType\\\\\\": \\\\\\"NodeOutput\\\\\\",\\\\n \\\\\\"refTableName\\\\\\": \\\\\\"OpenAPI_Test_Workflow_Demo\\\\\\",\\\\n \\\\\\"isDefault\\\\\\": true\\\\n }\\\\n ]\\\\n },\\\\n \\\\\\"nodes\\\\\\": [],\\\\n \\\\\\"dependencies\\\\\\": []\\\\n }\\\\n ]\\\\n }\\\\n}\\",\\n \\"WorkflowId\\": 700006657495,\\n \\"Id\\": \\"463497880880954XXXX\\"\\n }\\n}","type":"json"}]', + 'title' => '获取数据开发工作流详情', + ], + 'ListWorkflowDefinitions' => [ + 'summary' => '分页获取数据开发工作流列表，也可以根据筛选条件对工作流进行筛选。', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '235375', + 'abilityTreeNodes' => [ + 'FEATUREdideHO4TQP', + 'FEATUREdide8FM783', + 'FEATUREdideQUQUVB', + 'FEATUREdideIQU97M', + ], + ], + 'parameters' => [ + [ + 'name' => 'ProjectId', + 'in' => 'query', + 'schema' => [ + 'description' => 'DataWorks工作空间的ID。您可以登录[DataWorks控制台](https://workbench.data.aliyun.com/console)，进入工作空间配置页面获取工作空间ID。'."\n" + ."\n" + .'该参数用来确定本次API调用操作使用的DataWorks工作空间。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '10000', + ], + ], + [ + 'name' => 'Type', + 'in' => 'query', + 'schema' => [ + 'description' => '筛选条件：工作流的类型，未填写则默认为CycleWorkflow'."\n" + ."\n" + .'可选值'."\n" + ."\n" + .'- CycleWorkflow'."\n" + .'- ManualWorkflow', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [], + 'example' => 'CycleWorkflow', + 'default' => 'CycleWorkflow', + ], + ], + [ + 'name' => 'Owner', + 'in' => 'query', + 'schema' => [ + 'description' => '负责人的ID，即工作空间管理员的账号UID。您可登录阿里云控制台后，在账号管理的安全管理中查看账号UID。', + 'type' => 'string', + 'required' => false, + 'example' => '110755000425XXXX', + ], + ], + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => [ + 'description' => '工作流的名称，支持模糊搜索。', + 'type' => 'string', + 'required' => false, + 'example' => 'test', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '请求的数据页数，用于翻页。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '2147483647', + 'minimum' => '1', + 'example' => '1', + 'default' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '每页显示的条数，默认为10条，最大为100条。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '100', + 'minimum' => '10', + 'example' => '10', + 'default' => '10', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。用于定位日志，排查问题。'."\n", + 'type' => 'string', + 'example' => '8C3ED0C5-ABAB-55E1-854B-DAC02B11XXXX', + ], + 'PagingInfo' => [ + 'description' => '分页信息', + 'type' => 'object', + 'properties' => [ + 'TotalCount' => [ + 'description' => '满足条件的数据总条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '227', + ], + 'PageSize' => [ + 'description' => '每页显示的条数', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'PageNumber' => [ + 'description' => '请求的数据页数，用于翻页。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'WorkflowDefinitions' => [ + 'description' => '查询到的工作流列表', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ProjectId' => [ + 'title' => '所属项目空间', + 'description' => '工作流所在DataWorks空间的ID。', + 'type' => 'integer', + 'format' => 'int64', + 'deprecated' => false, + 'required' => true, + 'example' => '4710', + 'pattern' => '', + 'default' => '', + ], + 'Owner' => [ + 'title' => '责任人', + 'description' => '责任人', + 'type' => 'string', + 'deprecated' => false, + 'required' => false, + 'example' => '110755000425XXXX', + 'pattern' => '', + 'default' => '', + ], + 'CreateTime' => [ + 'title' => '创建时间', + 'description' => '创建工作流时间戳', + 'type' => 'integer', + 'format' => 'int64', + 'deprecated' => false, + 'required' => false, + 'example' => '1698057323000', + 'pattern' => '', + 'default' => '', + ], + 'ModifyTime' => [ + 'title' => '修改时间', + 'description' => '最近修改工作流的时间戳', + 'type' => 'integer', + 'format' => 'int64', + 'deprecated' => false, + 'required' => false, + 'example' => '1698057323000', + 'pattern' => '', + 'default' => '', + ], + 'Description' => [ + 'title' => '描述', + 'description' => '描述', + 'type' => 'string', + 'deprecated' => false, + 'required' => false, + 'example' => 'Workflow description', + 'pattern' => '', + 'default' => '', + ], + 'Type' => [ + 'title' => '工作流类型', + 'description' => '工作流类型'."\n" + ."\n" + .'可选值'."\n" + ."\n" + .'- CycleWorkflow'."\n" + .'- ManualWorkflow', + 'type' => 'string', + 'deprecated' => false, + 'required' => false, + 'enumValueTitles' => [], + 'example' => 'CycleWorkflow', + 'pattern' => '', + 'default' => '', + 'enum' => [ + 'CycleWorkflow', + 'ManualWorkflow', + ], + ], + 'Script' => [ + 'title' => '脚本信息', + 'description' => '脚本信息', + 'type' => 'object', + 'properties' => [ + 'Path' => [ + 'title' => '脚本路径', + 'description' => '脚本路径', + 'type' => 'string', + 'deprecated' => false, + 'example' => 'XX/OpenAPI_test/workflow_test/OpenAPI_test_workflow_Demo', + 'pattern' => '', + 'default' => '', + ], + 'Runtime' => [ + 'title' => '运行时', + 'description' => '运行时', + 'type' => 'object', + 'properties' => [ + 'Command' => [ + 'title' => '命令', + 'description' => '命令', + 'type' => 'string', + 'deprecated' => false, + 'example' => 'WORKFLOW', + 'pattern' => '', + 'default' => '', + ], + ], + 'deprecated' => false, + ], + 'Id' => [ + 'description' => '脚本id。'."\n" + ."\n" + .'><notice>该字段在SDK8.0.0版本之前为Long类型，SDK8.0.0版本及之后为String类型。**该变更不影响SDK正常使用，参数仍会按SDK中定义的类型返回**。只有在跨8.0.0版本的SDK升级时，类型变更可能会导致项目编译不通过，需要用户手动修正数据类型。></notice>', + 'type' => 'string', + 'deprecated' => false, + 'example' => '698002781368644XXXX', + ], + ], + 'deprecated' => false, + 'required' => false, + ], + 'Name' => [ + 'title' => '名称', + 'description' => '工作流名称', + 'type' => 'string', + 'deprecated' => false, + 'required' => false, + 'example' => 'OpenAPI test workflow Demo', + 'pattern' => '', + 'default' => '', + ], + 'Id' => [ + 'description' => '工作流唯一标识。'."\n" + ."\n" + .'><notice>该字段在SDK8.0.0版本之前为Long类型，SDK8.0.0版本及之后为String类型。**该变更不影响SDK正常使用，参数仍会按SDK中定义的类型返回**。只有在跨8.0.0版本的SDK升级时，类型变更可能会导致项目编译不通过，需要用户手动修正数据类型。></notice>', + 'type' => 'string', + 'deprecated' => false, + 'example' => '463497880880954XXXX', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"8C3ED0C5-ABAB-55E1-854B-DAC02B11XXXX\\",\\n \\"PagingInfo\\": {\\n \\"TotalCount\\": 227,\\n \\"PageSize\\": 10,\\n \\"PageNumber\\": 1,\\n \\"WorkflowDefinitions\\": [\\n {\\n \\"ProjectId\\": 4710,\\n \\"Owner\\": \\"110755000425XXXX\\",\\n \\"CreateTime\\": 1698057323000,\\n \\"ModifyTime\\": 1698057323000,\\n \\"Description\\": \\"Workflow description\\",\\n \\"Type\\": \\"CycleWorkflow\\",\\n \\"Script\\": {\\n \\"Path\\": \\"XX/OpenAPI_test/workflow_test/OpenAPI_test_workflow_Demo\\",\\n \\"Runtime\\": {\\n \\"Command\\": \\"WORKFLOW\\"\\n },\\n \\"Id\\": \\"698002781368644XXXX\\"\\n },\\n \\"Name\\": \\"OpenAPI test workflow Demo\\",\\n \\"Id\\": \\"463497880880954XXXX\\"\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => '获取数据开发工作流列表', + ], + 'CreateResource' => [ + 'summary' => '调用此接口，可以在数据开发中创建一个数据开发文件资源，文件资源的信息定义以FlowSpec格式描述。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '235474', + 'abilityTreeNodes' => [ + 'FEATUREdideJ3TPTK', + ], + ], + 'parameters' => [ + [ + 'name' => 'ProjectId', + 'in' => 'formData', + 'schema' => [ + 'title' => '项目id', + 'description' => 'DataWorks工作空间的ID。您可以登录[DataWorks控制台](https://workbench.data.aliyun.com/console)，进入工作空间配置页面获取工作空间ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '123456', + 'pattern' => '', + 'default' => '', + ], + ], + [ + 'name' => 'Spec', + 'in' => 'formData', + 'schema' => [ + 'description' => '描述这个资源文件的FlowSpec信息，具体规范详见[FlowSpec](https://github.com/aliyun/dataworks-spec/blob/master/README_zh_CN.md)。', + 'type' => 'string', + 'required' => true, + 'example' => '{'."\n" + .' "version": "1.1.0",'."\n" + .' "kind": "Resource",'."\n" + .' "spec": {'."\n" + .' "fileResources": ['."\n" + .' {'."\n" + .' "name": "OpenAPITestResource.py",'."\n" + .' "script": {'."\n" + .' "content": "",'."\n" + .' "path": "XX/OpenAPITest/ResourcesTest/OpenAPITestResource.py",'."\n" + .' "runtime": {'."\n" + .' "command": "ODPS_PYTHON"'."\n" + .' }'."\n" + .' },'."\n" + .' "type": "python",'."\n" + .' "file": {'."\n" + .' "storage": {}'."\n" + .' },'."\n" + .' "datasource": {'."\n" + .' "name": "odps_first",'."\n" + .' "type": "odps"'."\n" + .' }'."\n" + .' }'."\n" + .' ]'."\n" + .' }'."\n" + .'}', + ], + ], + [ + 'name' => 'ResourceFile', + 'in' => 'formData', + 'schema' => [ + 'description' => '资源包含的具体的文件流或OSS下载链接。'."\n" + .'><notice>该字段允许用户填写文件流或OSS下载链接。当填写OSS下载链接时，请确保该OSS链接可被公开访问。推荐提供预签名URL。></notice>', + 'type' => 'string', + 'required' => false, + 'example' => 'http://bucketname1.oss-cn-shanghai.aliyuncs.com/example', + 'isFileTransferUrl' => true, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID，用于定位日志，排查问题。', + 'type' => 'string', + 'example' => 'A5B97987-66EA-5563-9599-A2752292****', + ], + 'Id' => [ + 'description' => '资源文件的唯一标识符。'."\n" + ."\n" + .'><notice>该字段在SDK8.0.0版本之前为Long类型，SDK8.0.0版本及之后为String类型。**该变更不影响SDK正常使用，参数仍会按SDK中定义的类型返回**。只有在跨8.0.0版本的SDK升级时，类型变更可能会导致项目编译不通过，需要用户手动修正数据类型。></notice>', + 'type' => 'string', + 'example' => '631478864897630XXXX', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A5B97987-66EA-5563-9599-A2752292****\\",\\n \\"Id\\": \\"631478864897630XXXX\\"\\n}","type":"json"}]', + 'title' => '创建数据开发文件资源', + 'description' => '><notice>该接口不支持批量操作，若FlowSpec中定义了不止一个资源文件，则除第一个以外的后续资源文件均会被忽略。></notice>', + ], + 'DeleteResource' => [ + 'summary' => '调用此接口，可以删除指定的数据开发文件资源。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '235475', + 'abilityTreeNodes' => [ + 'FEATUREdideJ3TPTK', + ], + ], + 'parameters' => [ + [ + 'name' => 'ProjectId', + 'in' => 'formData', + 'schema' => [ + 'description' => 'DataWorks工作空间的ID。您可以登录[DataWorks控制台](https://workbench.data.aliyun.com/console)，进入工作空间配置页面获取工作空间ID。'."\n" + .'该参数用来确定本次API调用操作使用的DataWorks工作空间。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '10000', + ], + ], + [ + 'name' => 'Id', + 'in' => 'formData', + 'schema' => [ + 'description' => '资源文件的唯一标识符。'."\n" + ."\n" + .'><notice>该字段在SDK8.0.0版本之前为Long类型，SDK8.0.0版本及之后为String类型。**该变更不影响SDK正常使用，参数仍会按SDK中定义的类型返回**。只有在跨8.0.0版本的SDK升级时，类型变更可能会导致项目编译不通过，需要用户手动修正数据类型。></notice>', + 'type' => 'string', + 'required' => true, + 'example' => '860438872620113XXXX', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。用于定位日志，排查问题。', + 'type' => 'string', + 'example' => '88198F19-A36B-52A9-AE44-4518A688XXXX', + ], + 'Success' => [ + 'description' => '调用是否成功。'."\n" + .'- true：成功。'."\n" + .'- false：失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"88198F19-A36B-52A9-AE44-4518A688XXXX\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => '删除数据开发文件资源', + 'description' => '><notice>当这个文件资源被发布后，无法删除，必须先下线再进行删除。></notice>', + ], + 'UpdateResource' => [ + 'summary' => '调用此接口，可以更新数据开发文件资源的基本信息。更新以增量更新的方式进行，更新信息以FlowSpec格式描述。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '235476', + 'abilityTreeNodes' => [ + 'FEATUREdideJ3TPTK', + ], + ], + 'parameters' => [ + [ + 'name' => 'ProjectId', + 'in' => 'formData', + 'schema' => [ + 'description' => 'DataWorks工作空间的ID。您可以登录[DataWorks控制台](https://workbench.data.aliyun.com/console)，进入工作空间配置页面获取工作空间ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '10000', + ], + ], + [ + 'name' => 'Id', + 'in' => 'formData', + 'schema' => [ + 'description' => '数据开发文件资源唯一标识符。'."\n" + ."\n" + .'><notice>该字段在SDK8.0.0版本之前为Long类型，SDK8.0.0版本及之后为String类型。**该变更不影响SDK正常使用，参数仍会按SDK中定义的类型返回**。只有在跨8.0.0版本的SDK升级时，类型变更可能会导致项目编译不通过，需要用户手动修正数据类型。></notice>', + 'type' => 'string', + 'required' => true, + 'example' => '543217824470354XXXX', + ], + ], + [ + 'name' => 'Spec', + 'in' => 'formData', + 'schema' => [ + 'description' => '描述这个数据开发文件资源的FlowSpec信息，具体规范详见[FlowSpec](https://github.com/aliyun/dataworks-spec/blob/master/README_zh_CN.md)。', + 'type' => 'string', + 'required' => true, + 'example' => '{'."\n" + .' "version": "1.1.0",'."\n" + .' "kind": "Resource",'."\n" + .' "spec": {'."\n" + .' "fileResources": ['."\n" + .' {'."\n" + .' "name": "OpenAPI_Test_Resource.py",'."\n" + .' "script": {'."\n" + .' "content": "",'."\n" + .' "path": "XX/OpenAPI_Test/Resources_Test/OpenAPI_Test_Resource.py",'."\n" + .' "runtime": {'."\n" + .' "command": "ODPS_PYTHON"'."\n" + .' }'."\n" + .' },'."\n" + .' "type": "python",'."\n" + .' "file": {'."\n" + .' "storage": {}'."\n" + .' },'."\n" + .' "datasource": {'."\n" + .' "name": "odps_first",'."\n" + .' "type": "odps"'."\n" + .' }'."\n" + .' }'."\n" + .' ]'."\n" + .' }'."\n" + .'}', + ], + ], + [ + 'name' => 'ResourceFile', + 'in' => 'formData', + 'schema' => [ + 'description' => '资源包含的具体的文件流或OSS下载链接。'."\n" + .'><notice>该字段允许用户填写文件流或OSS下载链接。当填写OSS下载链接时，请确保该OSS链接可被公开访问。推荐提供预签名URL。></notice>', + 'type' => 'string', + 'required' => false, + 'example' => 'http://bucketname1.oss-cn-shanghai.aliyuncs.com/example', + 'isFileTransferUrl' => true, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。用于出现错误后排查问题。', + 'type' => 'string', + 'example' => '4CDF7B72-020B-542A-8465-21CFFA81****', + ], + 'Success' => [ + 'description' => '调用是否成功。取值如下：'."\n" + .'- true：调用成功。'."\n" + .'- false：调用失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"4CDF7B72-020B-542A-8465-21CFFA81****\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => '更新数据开发文件资源信息', + ], + 'MoveResource' => [ + 'summary' => '调用此接口，可以将指定数据开发文件资源移动到指定的数据开发目录中。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '235504', + 'abilityTreeNodes' => [ + 'FEATUREdideJ3TPTK', + ], + ], + 'parameters' => [ + [ + 'name' => 'ProjectId', + 'in' => 'formData', + 'schema' => [ + 'description' => 'DataWorks工作空间的ID。您可以登录[DataWorks控制台](https://workbench.data.aliyun.com/console)，进入工作空间配置页面获取工作空间ID。'."\n" + ."\n" + .'该参数用来确定本次API调用操作使用的DataWorks工作空间。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '10000', + ], + ], + [ + 'name' => 'Id', + 'in' => 'formData', + 'schema' => [ + 'description' => '数据开发文件资源唯一标识符。'."\n" + ."\n" + .'><notice>该字段在SDK8.0.0版本之前为Long类型，SDK8.0.0版本及之后为String类型。**该变更不影响SDK正常使用，参数仍会按SDK中定义的类型返回**。只有在跨8.0.0版本的SDK升级时，类型变更可能会导致项目编译不通过，需要用户手动修正数据类型。></notice>', + 'type' => 'string', + 'required' => true, + 'example' => '652567824470354XXXX', + ], + ], + [ + 'name' => 'Path', + 'in' => 'formData', + 'schema' => [ + 'description' => '移动的目标路径，不需要带文件资源名称。'."\n" + ."\n" + .'例如将math.py文件的路径变成到root/demo/math.py，则此参数需要填写root/demo', + 'type' => 'string', + 'required' => true, + 'example' => 'root/demo', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID，用于后续错误排查使用。', + 'type' => 'string', + 'example' => 'F332BED4-DD73-5972-A9C2-642BA6CFXXXX', + ], + 'Success' => [ + 'description' => '调用是否成功。'."\n" + ."\n" + .'- true：调用成功'."\n" + ."\n" + .'- false：调用失败', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F332BED4-DD73-5972-A9C2-642BA6CFXXXX\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => '移动数据开发文件资源路径', + ], + 'RenameResource' => [ + 'summary' => '调用此接口，可以对数据开发文件资源进行重命名。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '235503', + 'abilityTreeNodes' => [ + 'FEATUREdideJ3TPTK', + ], + ], + 'parameters' => [ + [ + 'name' => 'ProjectId', + 'in' => 'formData', + 'schema' => [ + 'description' => 'DataWorks工作空间的ID。您可以登录[DataWorks控制台](https://workbench.data.aliyun.com/console)，进入工作空间配置页面获取工作空间ID。'."\n" + ."\n" + .'该参数用来确定本次API调用操作使用的DataWorks工作空间。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '10000', + ], + ], + [ + 'name' => 'Id', + 'in' => 'formData', + 'schema' => [ + 'description' => '数据开发文件资源唯一标识符。'."\n" + ."\n" + .'><notice>该字段在SDK8.0.0版本之前为Long类型，SDK8.0.0版本及之后为String类型。**该变更不影响SDK正常使用，参数仍会按SDK中定义的类型返回**。只有在跨8.0.0版本的SDK升级时，类型变更可能会导致项目编译不通过，需要用户手动修正数据类型。></notice>', + 'type' => 'string', + 'required' => true, + 'example' => '543217824470354****', + ], + ], + [ + 'name' => 'Name', + 'in' => 'formData', + 'schema' => [ + 'description' => '希望重命名的名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'Rename', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求的ID：用于定位日志、排查问题', + 'type' => 'string', + 'example' => '4CDF7B72-020B-542A-8465-21CFFA8XXXXX', + ], + 'Success' => [ + 'description' => '请求是否成功。取值如下：'."\n" + ."\n" + .'- true：成功。'."\n" + .'- false：失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"4CDF7B72-020B-542A-8465-21CFFA8XXXXX\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => '重命名数据开发文件资源', + ], + 'GetResource' => [ + 'summary' => '获取指定文件资源的详细信息。', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '235473', + 'abilityTreeNodes' => [ + 'FEATUREdideJ3TPTK', + ], + ], + 'parameters' => [ + [ + 'name' => 'ProjectId', + 'in' => 'query', + 'schema' => [ + 'description' => 'DataWorks工作空间的ID。您可以登录[DataWorks控制台](https://workbench.data.aliyun.com/console)，进入工作空间管理页面获取ID。'."\n" + ."\n" + .'该参数用来确定本次API调用操作使用的DataWorks工作空间。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '10000', + ], + ], + [ + 'name' => 'Id', + 'in' => 'query', + 'schema' => [ + 'description' => '文件资源的唯一标识符。'."\n" + ."\n" + .'><notice>该字段在SDK8.0.0版本之前为Long类型，SDK8.0.0版本及之后为String类型。**该变更不影响SDK正常使用，参数仍会按SDK中定义的类型返回**。只有在跨8.0.0版本的SDK升级时，类型变更可能会导致项目编译不通过，需要用户手动修正数据类型。></notice>', + 'type' => 'string', + 'required' => true, + 'example' => '86043887262011****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。用于出现错误后排查问题。', + 'type' => 'string', + 'example' => 'E871F6C0-2EFF-5790-A00D-C57543EEXXXX', + ], + 'Resource' => [ + 'description' => '文件资源详情', + 'type' => 'object', + 'properties' => [ + 'ProjectId' => [ + 'description' => '文件资源所在工作空间的ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10000', + ], + 'Name' => [ + 'description' => '文件资源名称', + 'type' => 'string', + 'example' => 'OpenAPI_Test_Resource. py', + ], + 'Owner' => [ + 'description' => '文件资源责任人', + 'type' => 'string', + 'example' => '110755000425XXXX', + ], + 'CreateTime' => [ + 'description' => '文件资源创建时间戳', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1700539206000', + ], + 'ModifyTime' => [ + 'description' => '文件资源最近更新时间', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1700539206000', + ], + 'Spec' => [ + 'description' => '描述这个文件资源的FlowSpec信息，具体规范详见[FlowSpec](https://github.com/aliyun/alibabacloud-dataworks-tool-dflow)。', + 'type' => 'string', + 'example' => '{'."\n" + .' "version": "1.1.0",'."\n" + .' "kind": "Resource",'."\n" + .' "spec": {'."\n" + .' "fileResources": ['."\n" + .' {'."\n" + .' "name": "OpenAPI_Test_Resource.py",'."\n" + .' "id": "631478864897630XXXX",'."\n" + .' "script": {'."\n" + .' "content": "",'."\n" + .' "path": "XX/OpenAPI_Test/Resource_Test/OpenAPI_Test_Resource.py",'."\n" + .' "runtime": {'."\n" + .' "command": "ODPS_PYTHON"'."\n" + .' }'."\n" + .' },'."\n" + .' "type": "python",'."\n" + .' "file": {'."\n" + .' "storage": {}'."\n" + .' },'."\n" + .' "datasource": {'."\n" + .' "name": "odps_first",'."\n" + .' "type": "odps"'."\n" + .' },'."\n" + .' "metadata": {'."\n" + .' "owner": "110755000425XXXX"'."\n" + .' }'."\n" + .' }'."\n" + .' ]'."\n" + .' }'."\n" + .'}', + ], + 'Id' => [ + 'description' => '文件资源的唯一标识符。'."\n" + ."\n" + .'><notice>该字段在SDK8.0.0版本之前为Long类型，SDK8.0.0版本及之后为String类型。**该变更不影响SDK正常使用，参数仍会按SDK中定义的类型返回**。只有在跨8.0.0版本的SDK升级时，类型变更可能会导致项目编译不通过，需要用户手动修正数据类型。></notice>', + 'type' => 'string', + 'example' => '860438872620113XXXX', + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"E871F6C0-2EFF-5790-A00D-C57543EEXXXX\\",\\n \\"Resource\\": {\\n \\"ProjectId\\": 10000,\\n \\"Name\\": \\"OpenAPI_Test_Resource. py\\",\\n \\"Owner\\": \\"110755000425XXXX\\",\\n \\"CreateTime\\": 1700539206000,\\n \\"ModifyTime\\": 1700539206000,\\n \\"Spec\\": \\"{\\\\n \\\\\\"version\\\\\\": \\\\\\"1.1.0\\\\\\",\\\\n \\\\\\"kind\\\\\\": \\\\\\"Resource\\\\\\",\\\\n \\\\\\"spec\\\\\\": {\\\\n \\\\\\"fileResources\\\\\\": [\\\\n {\\\\n \\\\\\"name\\\\\\": \\\\\\"OpenAPI_Test_Resource.py\\\\\\",\\\\n \\\\\\"id\\\\\\": \\\\\\"631478864897630XXXX\\\\\\",\\\\n \\\\\\"script\\\\\\": {\\\\n \\\\\\"content\\\\\\": \\\\\\"\\\\\\",\\\\n \\\\\\"path\\\\\\": \\\\\\"XX/OpenAPI_Test/Resource_Test/OpenAPI_Test_Resource.py\\\\\\",\\\\n \\\\\\"runtime\\\\\\": {\\\\n \\\\\\"command\\\\\\": \\\\\\"ODPS_PYTHON\\\\\\"\\\\n }\\\\n },\\\\n \\\\\\"type\\\\\\": \\\\\\"python\\\\\\",\\\\n \\\\\\"file\\\\\\": {\\\\n \\\\\\"storage\\\\\\": {}\\\\n },\\\\n \\\\\\"datasource\\\\\\": {\\\\n \\\\\\"name\\\\\\": \\\\\\"odps_first\\\\\\",\\\\n \\\\\\"type\\\\\\": \\\\\\"odps\\\\\\"\\\\n },\\\\n \\\\\\"metadata\\\\\\": {\\\\n \\\\\\"owner\\\\\\": \\\\\\"110755000425XXXX\\\\\\"\\\\n }\\\\n }\\\\n ]\\\\n }\\\\n}\\",\\n \\"Id\\": \\"860438872620113XXXX\\"\\n }\\n}","type":"json"}]', + 'title' => '获取数据开发文件资源详情', + ], + 'ListResources' => [ + 'summary' => '调用此接口，可以分页获取资源文件，也可以对资源进行筛选。', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '235477', + 'abilityTreeNodes' => [ + 'FEATUREdideJ3TPTK', + ], + ], + 'parameters' => [ + [ + 'name' => 'ProjectId', + 'in' => 'query', + 'schema' => [ + 'description' => 'DataWorks工作空间的ID。您可以登录[DataWorks控制台](https://workbench.data.aliyun.com/console)，进入工作空间配置页面获取工作空间ID。'."\n" + ."\n" + .'该参数用来确定本次API调用操作使用的DataWorks工作空间。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '10002', + ], + ], + [ + 'name' => 'Owner', + 'in' => 'query', + 'schema' => [ + 'description' => '负责人的ID，即工作空间管理员的账号UID。您可登录阿里云控制台后，在账号管理的安全管理中查看账号UID。', + 'type' => 'string', + 'required' => false, + 'example' => '110755000425XXXX', + ], + ], + [ + 'name' => 'Type', + 'in' => 'query', + 'schema' => [ + 'description' => '筛选条件：资源类型'."\n" + ."\n" + .'可选值'."\n" + ."\n" + .'- Python'."\n" + .'- Jar'."\n" + .'- Archive'."\n" + .'- File', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'Archive' => 'Archive', + 'Jar' => 'Jar', + 'File' => 'File', + 'Python' => 'Python', + ], + 'example' => 'Python', + ], + ], + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => [ + 'description' => '文件资源名称，支持模糊搜索。', + 'type' => 'string', + 'required' => false, + 'example' => 'test', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '请求的数据页数，用于翻页。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '2147483647', + 'minimum' => '1', + 'example' => '1', + 'default' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '每页显示的条数，默认为10条，最大100条。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '100', + 'minimum' => '10', + 'example' => '10', + 'default' => '10', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用的唯一ID。出现错误后，您可以根据该ID排查问题。', + 'type' => 'string', + 'example' => '99EBE7CF-69C0-5089-BE3E-79563C31XXXX', + ], + 'PagingInfo' => [ + 'description' => '分页信息', + 'type' => 'object', + 'properties' => [ + 'TotalCount' => [ + 'description' => '满足条件的数据总条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '131', + ], + 'PageSize' => [ + 'description' => '每页显示的条数', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'PageNumber' => [ + 'description' => '请求的数据页数，用于翻页。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Resources' => [ + 'description' => '查询返回的资源列表', + 'type' => 'array', + 'items' => [ + 'description' => '资源列表元素', + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'title' => '资源名称', + 'description' => '资源名称', + 'type' => 'string', + 'deprecated' => false, + 'example' => 'math.py', + 'pattern' => '', + 'default' => '', + ], + 'ProjectId' => [ + 'title' => '项目id', + 'description' => 'DataWorks工作空间的ID。您可以登录[DataWorks控制台](https://workbench.data.aliyun.com/console)，进入工作空间配置页面获取工作空间ID。', + 'type' => 'integer', + 'format' => 'int64', + 'deprecated' => false, + 'example' => '344247', + 'pattern' => '', + 'default' => '', + ], + 'Owner' => [ + 'title' => '责任人', + 'description' => '文件资源的责任人', + 'type' => 'string', + 'deprecated' => false, + 'example' => '110755000425XXXX', + 'pattern' => '', + 'default' => '', + ], + 'CreateTime' => [ + 'description' => '文件资源的创建时间戳', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1724505917000', + ], + 'ModifyTime' => [ + 'title' => '修改时间', + 'description' => '文件资源最近修改的时间戳。', + 'type' => 'integer', + 'format' => 'int64', + 'deprecated' => false, + 'example' => '1724505917000', + 'pattern' => '', + 'default' => '', + ], + 'DataSource' => [ + 'title' => '数据源', + 'description' => '数据源', + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'title' => '数据源名称', + 'description' => '数据源名称', + 'type' => 'string', + 'deprecated' => false, + 'example' => 'odps_first', + 'pattern' => '', + 'default' => '', + ], + 'Type' => [ + 'title' => '数据源类型', + 'description' => '数据源类型', + 'type' => 'string', + 'deprecated' => false, + 'example' => 'odps', + 'pattern' => '', + 'default' => '', + ], + ], + 'deprecated' => false, + ], + 'Script' => [ + 'title' => '脚本信息', + 'description' => '脚本信息', + 'type' => 'object', + 'properties' => [ + 'Path' => [ + 'title' => '脚本路径', + 'description' => '脚本路径', + 'type' => 'string', + 'deprecated' => false, + 'example' => 'root/demo', + 'pattern' => '', + 'default' => '', + ], + 'Runtime' => [ + 'title' => '运行时', + 'description' => '运行时', + 'type' => 'object', + 'properties' => [ + 'Command' => [ + 'title' => '命令', + 'description' => '命令，表示文件类型', + 'type' => 'string', + 'deprecated' => false, + 'example' => 'ODPS_PYTHON', + 'pattern' => '', + 'default' => '', + ], + ], + 'deprecated' => false, + ], + 'Id' => [ + 'description' => '脚本id。'."\n" + ."\n" + .'><notice>该字段在SDK8.0.0版本之前为Long类型，SDK8.0.0版本及之后为String类型。**该变更不影响SDK正常使用，参数仍会按SDK中定义的类型返回**。只有在跨8.0.0版本的SDK升级时，类型变更可能会导致项目编译不通过，需要用户手动修正数据类型。></notice>', + 'type' => 'string', + 'deprecated' => false, + 'example' => '123348864897630XXXX', + ], + ], + 'deprecated' => false, + 'required' => false, + ], + 'Type' => [ + 'title' => '资源类型', + 'description' => '资源类型'."\n" + ."\n" + .'可选值：'."\n" + ."\n" + .'- Python'."\n" + .'- Jar'."\n" + .'- Archive'."\n" + .'- File', + 'type' => 'string', + 'deprecated' => false, + 'enumValueTitles' => [ + 'Archive' => 'Archive', + 'Jar' => 'Jar', + 'File' => 'File', + 'Python' => 'Python', + ], + 'example' => 'Jar', + 'pattern' => '', + 'default' => '', + 'enum' => [ + 'jar', + 'python', + 'file', + 'archive', + ], + ], + 'SourceType' => [ + 'title' => '文件资源来源存储类型', + 'description' => '文件资源来源存储类型'."\n" + ."\n" + .'可选值'."\n" + ."\n" + .'- Local 本地'."\n" + .'- Oss 对象存储', + 'type' => 'string', + 'deprecated' => false, + 'enumValueTitles' => [ + 'Local' => 'Local', + 'Oss' => 'Oss', + ], + 'example' => 'Local', + 'pattern' => '', + 'default' => '', + 'enum' => [ + 'local', + 'oss', + ], + ], + 'SourcePath' => [ + 'title' => '文件目标存储路径', + 'description' => '文件资源来源路径，type为local是为空。', + 'type' => 'string', + 'deprecated' => false, + 'example' => 'XXX/unknown/ide/1/XXX/20240820200851_963a9da676de44ef8d06a6576a8c4d6a.py', + 'pattern' => '', + 'default' => '', + ], + 'TargetType' => [ + 'title' => '文件目标存储类型', + 'description' => '文件目标存储类型'."\n" + ."\n" + .'可选值'."\n" + ."\n" + .'- Gateway 网关'."\n" + .'- Oss 对象存储服务'."\n" + .'- Hdfs hdfs文件存储系统', + 'type' => 'string', + 'deprecated' => false, + 'enumValueTitles' => [ + 'Gateway' => 'Gateway', + 'Hdfs' => 'Hdfs', + 'Oss' => 'Oss', + ], + 'example' => 'Oss', + 'pattern' => '', + 'default' => '', + 'enum' => [ + 'gateway', + 'oss', + 'hdfs', + ], + ], + 'TargetPath' => [ + 'title' => '文件来源路径', + 'description' => '文件目标存储路径', + 'type' => 'string', + 'deprecated' => false, + 'example' => 'XXX/unknown/ide/1/XXX/20240820200851_963a9da676de44ef8d06a6576a8c4d6a.py', + 'pattern' => '', + 'default' => '', + ], + 'Id' => [ + 'description' => '文件资源唯一标识符。'."\n" + ."\n" + .'><notice>该字段在SDK8.0.0版本之前为Long类型，SDK8.0.0版本及之后为String类型。**该变更不影响SDK正常使用，参数仍会按SDK中定义的类型返回**。只有在跨8.0.0版本的SDK升级时，类型变更可能会导致项目编译不通过，需要用户手动修正数据类型。></notice>', + 'type' => 'string', + 'example' => '631478864897630XXXX', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"99EBE7CF-69C0-5089-BE3E-79563C31XXXX\\",\\n \\"PagingInfo\\": {\\n \\"TotalCount\\": 131,\\n \\"PageSize\\": 10,\\n \\"PageNumber\\": 1,\\n \\"Resources\\": [\\n {\\n \\"Name\\": \\"math.py\\",\\n \\"ProjectId\\": 344247,\\n \\"Owner\\": \\"110755000425XXXX\\",\\n \\"CreateTime\\": 1724505917000,\\n \\"ModifyTime\\": 1724505917000,\\n \\"DataSource\\": {\\n \\"Name\\": \\"odps_first\\",\\n \\"Type\\": \\"odps\\"\\n },\\n \\"Script\\": {\\n \\"Path\\": \\"root/demo\\",\\n \\"Runtime\\": {\\n \\"Command\\": \\"ODPS_PYTHON\\"\\n },\\n \\"Id\\": \\"123348864897630XXXX\\"\\n },\\n \\"Type\\": \\"Jar\\",\\n \\"SourceType\\": \\"Local\\",\\n \\"SourcePath\\": \\"XXX/unknown/ide/1/XXX/20240820200851_963a9da676de44ef8d06a6576a8c4d6a.py\\",\\n \\"TargetType\\": \\"Oss\\",\\n \\"TargetPath\\": \\"XXX/unknown/ide/1/XXX/20240820200851_963a9da676de44ef8d06a6576a8c4d6a.py\\",\\n \\"Id\\": \\"631478864897630XXXX\\"\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => '获取数据开发文件资源列表', + ], + 'CreateFunction' => [ + 'summary' => '调用此接口，可以在数据开发中创建一个udf函数。udf函数信息以FlowSpec格式描述。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '236012', + 'abilityTreeNodes' => [ + 'FEATUREdideZOYJZL', + ], + ], + 'parameters' => [ + [ + 'name' => 'ProjectId', + 'in' => 'formData', + 'schema' => [ + 'description' => 'DataWorks工作空间的ID，您可以登录[DataWorks控制台](https://workbench.data.aliyun.com/console)，进入工作空间管理页面查看ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '12345', + ], + ], + [ + 'name' => 'Spec', + 'in' => 'formData', + 'schema' => [ + 'description' => '描述这个udf函数的FlowSpec信息，具体规范详见[FlowSpec](https://github.com/aliyun/dataworks-spec/blob/master/README_zh_CN.md)。', + 'type' => 'string', + 'required' => true, + 'example' => '{'."\n" + .' "version": "1.1.0",'."\n" + .' "kind": "Function",'."\n" + .' "spec": {'."\n" + .' "functions": ['."\n" + .' {'."\n" + .' "name": "function name",'."\n" + .' "script": {'."\n" + .' "content": "{\\"name\\": \\"function name\\", \\"datasource\\": {\\"type\\": \\"ODPS\\", \\"name\\": \\"ODPS_first\\"}, \\"runtimeResource\\": {\\"resourceGroup\\": \\"s_res_group_xx_xxxx\\"}}",'."\n" + .' "path": "XXX/OpenAPI/function/function name",'."\n" + .' "runtime": {'."\n" + .' "command": "ODPS_FUNCTION"'."\n" + .' }'."\n" + .' },'."\n" + .' "datasource": {'."\n" + .' "name": "ODPS_first",'."\n" + .' "type": "ODPS"'."\n" + .' },'."\n" + .' "runtimeResource": {'."\n" + .' "resourceGroup": "S_res_group_XXXX_XXXX"'."\n" + .' }'."\n" + .' }'."\n" + .' ]'."\n" + .' }'."\n" + .'}', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。用于定位日志，排查问题。', + 'type' => 'string', + 'example' => 'AE49C88D-5BEE-5ADD-8B8C-C4BBC0D7****', + ], + 'Id' => [ + 'description' => 'UDF函数的唯一标识符。'."\n" + ."\n" + .'><notice>该字段在SDK8.0.0版本之前为Long类型，SDK8.0.0版本及之后为String类型。**该变更不影响SDK正常使用，参数仍会按SDK中定义的类型返回**。只有在跨8.0.0版本的SDK升级时，类型变更可能会导致项目编译不通过，需要用户手动修正数据类型。></notice>', + 'type' => 'string', + 'example' => '580667964888595XXXX', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"AE49C88D-5BEE-5ADD-8B8C-C4BBC0D7****\\",\\n \\"Id\\": \\"580667964888595XXXX\\"\\n}","type":"json"}]', + 'title' => '创建数据开发函数', + 'description' => '><notice>该接口不支持批量操作，若FlowSpec中定义了不止一个udf函数，则除第一个以外的后续函数均会被忽略。></notice>', + ], + 'DeleteFunction' => [ + 'summary' => '调用该接口，在数据开发中删除指定的udf函数。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '236013', + 'abilityTreeNodes' => [ + 'FEATUREdideZOYJZL', + ], + ], + 'parameters' => [ + [ + 'name' => 'ProjectId', + 'in' => 'formData', + 'schema' => [ + 'description' => 'DataWorks工作空间的ID。您可以登录[DataWorks控制台](https://workbench.data.aliyun.com/console)，进入工作空间配置页面获取工作空间ID。'."\n" + .'该参数用来确定本次API调用操作使用的DataWorks工作空间。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '10000', + ], + ], + [ + 'name' => 'Id', + 'in' => 'formData', + 'schema' => [ + 'description' => 'UDF函数的唯一标识符。'."\n" + ."\n" + .'><notice>该字段在SDK8.0.0版本之前为Long类型，SDK8.0.0版本及之后为String类型。**该变更不影响SDK正常使用，参数仍会按SDK中定义的类型返回**。只有在跨8.0.0版本的SDK升级时，类型变更可能会导致项目编译不通过，需要用户手动修正数据类型。></notice>', + 'type' => 'string', + 'required' => true, + 'example' => '860438872620113XXXX', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。用于定位日志，排查问题。', + 'type' => 'string', + 'example' => '88198F19-A36B-52A9-AE44-4518A688XXXX', + ], + 'Success' => [ + 'description' => '请求是否成功：'."\n" + .'- true（成功）'."\n" + .'- false（失败）', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"88198F19-A36B-52A9-AE44-4518A688XXXX\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => '删除数据开发函数', + 'description' => '><notice>当这个udf函数被发布后，无法删除，必须先下线再进行删除。></notice>', + ], + 'UpdateFunction' => [ + 'summary' => '调用此接口，可以更新udf函数信息。更新以增量更新的方式进行，更新信息通过FlowSpec格式描述。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '236014', + 'abilityTreeNodes' => [ + 'FEATUREdideZOYJZL', + ], + ], + 'parameters' => [ + [ + 'name' => 'ProjectId', + 'in' => 'formData', + 'schema' => [ + 'description' => 'DataWorks工作空间的ID，您可以登录[DataWorks控制台](https://workbench.data.aliyun.com/console)，进入工作空间管理页面查看ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '10000', + ], + ], + [ + 'name' => 'Id', + 'in' => 'formData', + 'schema' => [ + 'description' => 'udf函数的唯一标识符。'."\n" + ."\n" + .'><notice>该字段在SDK8.0.0版本之前为Long类型，SDK8.0.0版本及之后为String类型。**该变更不影响SDK正常使用，参数仍会按SDK中定义的类型返回**。只有在跨8.0.0版本的SDK升级时，类型变更可能会导致项目编译不通过，需要用户手动修正数据类型。></notice>', + 'type' => 'string', + 'required' => true, + 'example' => '463497880880954XXXX', + ], + ], + [ + 'name' => 'Spec', + 'in' => 'formData', + 'schema' => [ + 'description' => '描述这个udf函数的FlowSpec信息，具体规范详见[FlowSpec](https://github.com/aliyun/dataworks-spec/blob/master/README_zh_CN.md)。', + 'type' => 'string', + 'required' => true, + 'example' => '{'."\n" + .' "version": "1.1.0",'."\n" + .' "kind": "Function",'."\n" + .' "spec": {'."\n" + .' "functions": ['."\n" + .' {'."\n" + .' "name": "FunctionName",'."\n" + .' "script": {'."\n" + .' "content": "{\\"name\\": \\"FunctionName\\", \\"datasource\\": {\\"type\\": \\"odps\\", \\"name\\": \\"odps_first\\"}, \\"runtimeResource\\": {\\"resourceGroup\\": \\"S_res_group_XXXX_XXXX\\"}}",'."\n" + .' "path": "XXX/OpenAPI/Function/FunctionName",'."\n" + .' "runtime": {'."\n" + .' "command": "ODPS_FUNCTION"'."\n" + .' }'."\n" + .' },'."\n" + .' "datasource": {'."\n" + .' "name": "odps_first",'."\n" + .' "type": "odps"'."\n" + .' },'."\n" + .' "runtimeResource": {'."\n" + .' "resourceGroup": "S_res_group_XXXX_XXXX"'."\n" + .' }'."\n" + .' }'."\n" + .' ]'."\n" + .' }'."\n" + .'}', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。用于出现错误后排查问题。', + 'type' => 'string', + 'example' => '12123960-CB2C-5086-868E-C6C1D024****', + ], + 'Success' => [ + 'description' => '调用是否成功。取值如下：'."\n" + ."\n" + .'true：调用成功。'."\n" + ."\n" + .'false：调用失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"12123960-CB2C-5086-868E-C6C1D024****\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => '更新数据开发函数信息', + ], + 'MoveFunction' => [ + 'summary' => '调用此接口，可以将指定udf函数移动到数据开发目录的目标路径。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '236059', + 'abilityTreeNodes' => [ + 'FEATUREdideZOYJZL', + ], + ], + 'parameters' => [ + [ + 'name' => 'ProjectId', + 'in' => 'formData', + 'schema' => [ + 'description' => 'DataWorks工作空间的ID。您可以登录[DataWorks控制台](https://workbench.data.aliyun.com/console)，进入工作空间配置页面获取工作空间ID。'."\n" + ."\n" + .'该参数用来确定本次API调用操作使用的DataWorks工作空间。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '12345', + ], + ], + [ + 'name' => 'Id', + 'in' => 'formData', + 'schema' => [ + 'description' => 'udf函数的唯一标识符。'."\n" + ."\n" + .'><notice>该字段在SDK8.0.0版本之前为Long类型，SDK8.0.0版本及之后为String类型。**该变更不影响SDK正常使用，参数仍会按SDK中定义的类型返回**。只有在跨8.0.0版本的SDK升级时，类型变更可能会导致项目编译不通过，需要用户手动修正数据类型。></notice>', + 'type' => 'string', + 'required' => true, + 'example' => '543217824470354XXXX', + ], + ], + [ + 'name' => 'Path', + 'in' => 'formData', + 'schema' => [ + 'description' => '移动的目标路径，不需要带函数名称。'."\n" + ."\n" + .'例如将test函数的路径变成到root/demo/test，则此参数需要填写root/demo', + 'type' => 'string', + 'required' => true, + 'example' => 'root/demo', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。用于定位日志，排查问题。', + 'type' => 'string', + 'example' => '48C0E2F0-52BA-5888-BDFA-28F1B9AFXXXX', + ], + 'Success' => [ + 'description' => '调用是否成功。取值如下：'."\n" + .'- true：调用成功。'."\n" + .'- false：调用失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"48C0E2F0-52BA-5888-BDFA-28F1B9AFXXXX\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => '移动数据开发函数路径', + ], + 'RenameFunction' => [ + 'summary' => '调用此接口，可以对指定的udf函数进行重命名。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '236048', + 'abilityTreeNodes' => [ + 'FEATUREdideZOYJZL', + ], + ], + 'parameters' => [ + [ + 'name' => 'ProjectId', + 'in' => 'formData', + 'schema' => [ + 'description' => 'DataWorks工作空间的ID，您可以登录[DataWorks控制台](https://workbench.data.aliyun.com/console)，进入工作空间管理页面查看ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '10002', + ], + ], + [ + 'name' => 'Id', + 'in' => 'formData', + 'schema' => [ + 'description' => '数据开发udf函数的唯一标识。'."\n" + ."\n" + .'><notice>该字段在SDK8.0.0版本之前为Long类型，SDK8.0.0版本及之后为String类型。**该变更不影响SDK正常使用，参数仍会按SDK中定义的类型返回**。只有在跨8.0.0版本的SDK升级时，类型变更可能会导致项目编译不通过，需要用户手动修正数据类型。></notice>', + 'type' => 'string', + 'required' => true, + 'example' => '543217824470354****', + ], + ], + [ + 'name' => 'Name', + 'in' => 'formData', + 'schema' => [ + 'description' => '希望重命名的名称', + 'type' => 'string', + 'required' => true, + 'example' => 'Rename', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求的唯一标识，用于后续错误排查使用。', + 'type' => 'string', + 'example' => '1ED4C97F-BA2A-57C5-BA7C-8853627EXXXX', + ], + 'Success' => [ + 'description' => '请求是否成功。取值如下：'."\n" + .'- true：成功。'."\n" + .'- false：失败。', + 'type' => 'string', + 'example' => 'true', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1ED4C97F-BA2A-57C5-BA7C-8853627EXXXX\\",\\n \\"Success\\": \\"true\\"\\n}","type":"json"}]', + 'title' => '重命名数据开发函数', + ], + 'GetFunction' => [ + 'summary' => '获取指定数据开发udf函数的详细信息。', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '236011', + 'abilityTreeNodes' => [ + 'FEATUREdideZOYJZL', + ], + ], + 'parameters' => [ + [ + 'name' => 'ProjectId', + 'in' => 'query', + 'schema' => [ + 'description' => 'DataWorks工作空间的ID。您可以登录[DataWorks控制台](https://workbench.data.aliyun.com/console)，进入工作空间配置页面获取工作空间ID。'."\n" + ."\n" + .'该参数用来确定本次API调用操作使用的DataWorks工作空间。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '10000', + ], + ], + [ + 'name' => 'Id', + 'in' => 'query', + 'schema' => [ + 'description' => 'UDF函数的唯一标识符。'."\n" + ."\n" + .'><notice>该字段在SDK8.0.0版本之前为Long类型，SDK8.0.0版本及之后为String类型。**该变更不影响SDK正常使用，参数仍会按SDK中定义的类型返回**。只有在跨8.0.0版本的SDK升级时，类型变更可能会导致项目编译不通过，需要用户手动修正数据类型。></notice>', + 'type' => 'string', + 'required' => true, + 'example' => '86043887262011****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID，用于后续错误排查使用。', + 'type' => 'string', + 'example' => '6CF95929-6D12-5A88-8CC3-4B2F4C2EXXXX', + ], + 'Function' => [ + 'description' => 'udf函数详细信息', + 'type' => 'object', + 'properties' => [ + 'ProjectId' => [ + 'description' => 'udf函数所属的DataWorks工作空间ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10000', + ], + 'Name' => [ + 'description' => 'udf函数的名称', + 'type' => 'string', + 'example' => 'Function name', + ], + 'Owner' => [ + 'description' => 'udf函数的责任人', + 'type' => 'string', + 'example' => '110755000425XXXX', + ], + 'CreateTime' => [ + 'description' => 'udf函数的创建时间戳', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1724505917000', + ], + 'ModifyTime' => [ + 'description' => 'udf函数的最近修改时间戳', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1724506661000', + ], + 'Spec' => [ + 'description' => '描述这个udf函数的FlowSpec信息，具体规范详见[FlowSpec](https://github.com/aliyun/dataworks-spec/blob/master/README_zh_CN.md)。', + 'type' => 'string', + 'example' => '{'."\n" + .' "version": "1.1.0",'."\n" + .' "kind": "Function",'."\n" + .' "spec": {'."\n" + .' "functions": ['."\n" + .' {'."\n" + .' "name": "Function_Name",'."\n" + .' "id": "580667964888595XXXX",'."\n" + .' "script": {'."\n" + .' "content": "{ \\"uuid\\": \\"580667964888595XXXX\\", \\"name\\": \\"Function_Name\\", \\"datasource\\": { \\"type\\": \\"odps\\", \\"name\\": \\"odps_first\\" }, \\"runtimeResource\\": { \\"resourceGroup\\": \\"S_res_group_XXXX_XXXX\\", \\"resourceGroupId\\": 6591XXXX }}",'."\n" + .' "path": "XXX/OpenAPI/Function/Function_Name",'."\n" + .' "runtime": {'."\n" + .' "command": "ODPS_FUNCTION"'."\n" + .' }'."\n" + .' },'."\n" + .' "datasource": {'."\n" + .' "name": "odps_first",'."\n" + .' "type": "odps"'."\n" + .' },'."\n" + .' "runtimeResource": {'."\n" + .' "resourceGroup": "S_res_group_XXXX_XXXX",'."\n" + .' "id": "723932906364267XXXX",'."\n" + .' "resourceGroupId": "6591XXXX"'."\n" + .' },'."\n" + .' "metadata": {'."\n" + .' "owner": "110755000425XXXX"'."\n" + .' }'."\n" + .' }'."\n" + .' ]'."\n" + .' }'."\n" + .'}', + ], + 'Id' => [ + 'description' => 'udf函数唯一标识。'."\n" + ."\n" + .'><notice>该字段在SDK8.0.0版本之前为Long类型，SDK8.0.0版本及之后为String类型。**该变更不影响SDK正常使用，参数仍会按SDK中定义的类型返回**。只有在跨8.0.0版本的SDK升级时，类型变更可能会导致项目编译不通过，需要用户手动修正数据类型。></notice>', + 'type' => 'string', + 'example' => '860438872620113XXXX'."\n", + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"6CF95929-6D12-5A88-8CC3-4B2F4C2EXXXX\\",\\n \\"Function\\": {\\n \\"ProjectId\\": 10000,\\n \\"Name\\": \\"Function name\\",\\n \\"Owner\\": \\"110755000425XXXX\\",\\n \\"CreateTime\\": 1724505917000,\\n \\"ModifyTime\\": 1724506661000,\\n \\"Spec\\": \\"{\\\\n \\\\\\"version\\\\\\": \\\\\\"1.1.0\\\\\\",\\\\n \\\\\\"kind\\\\\\": \\\\\\"Function\\\\\\",\\\\n \\\\\\"spec\\\\\\": {\\\\n \\\\\\"functions\\\\\\": [\\\\n {\\\\n \\\\\\"name\\\\\\": \\\\\\"Function_Name\\\\\\",\\\\n \\\\\\"id\\\\\\": \\\\\\"580667964888595XXXX\\\\\\",\\\\n \\\\\\"script\\\\\\": {\\\\n \\\\\\"content\\\\\\": \\\\\\"{ \\\\\\\\\\\\\\"uuid\\\\\\\\\\\\\\": \\\\\\\\\\\\\\"580667964888595XXXX\\\\\\\\\\\\\\", \\\\\\\\\\\\\\"name\\\\\\\\\\\\\\": \\\\\\\\\\\\\\"Function_Name\\\\\\\\\\\\\\", \\\\\\\\\\\\\\"datasource\\\\\\\\\\\\\\": { \\\\\\\\\\\\\\"type\\\\\\\\\\\\\\": \\\\\\\\\\\\\\"odps\\\\\\\\\\\\\\", \\\\\\\\\\\\\\"name\\\\\\\\\\\\\\": \\\\\\\\\\\\\\"odps_first\\\\\\\\\\\\\\" }, \\\\\\\\\\\\\\"runtimeResource\\\\\\\\\\\\\\": { \\\\\\\\\\\\\\"resourceGroup\\\\\\\\\\\\\\": \\\\\\\\\\\\\\"S_res_group_XXXX_XXXX\\\\\\\\\\\\\\", \\\\\\\\\\\\\\"resourceGroupId\\\\\\\\\\\\\\": 6591XXXX }}\\\\\\",\\\\n \\\\\\"path\\\\\\": \\\\\\"XXX/OpenAPI/Function/Function_Name\\\\\\",\\\\n \\\\\\"runtime\\\\\\": {\\\\n \\\\\\"command\\\\\\": \\\\\\"ODPS_FUNCTION\\\\\\"\\\\n }\\\\n },\\\\n \\\\\\"datasource\\\\\\": {\\\\n \\\\\\"name\\\\\\": \\\\\\"odps_first\\\\\\",\\\\n \\\\\\"type\\\\\\": \\\\\\"odps\\\\\\"\\\\n },\\\\n \\\\\\"runtimeResource\\\\\\": {\\\\n \\\\\\"resourceGroup\\\\\\": \\\\\\"S_res_group_XXXX_XXXX\\\\\\",\\\\n \\\\\\"id\\\\\\": \\\\\\"723932906364267XXXX\\\\\\",\\\\n \\\\\\"resourceGroupId\\\\\\": \\\\\\"6591XXXX\\\\\\"\\\\n },\\\\n \\\\\\"metadata\\\\\\": {\\\\n \\\\\\"owner\\\\\\": \\\\\\"110755000425XXXX\\\\\\"\\\\n }\\\\n }\\\\n ]\\\\n }\\\\n}\\",\\n \\"Id\\": \\"860438872620113XXXX\\\\n\\"\\n }\\n}","type":"json"}]', + 'title' => '获取数据开发函数详情', + ], + 'ListFunctions' => [ + 'summary' => '调用此接口，可以分页获取数据开发中的udf函数列表，也可以使用筛选条件筛选udf函数。', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '236015', + 'abilityTreeNodes' => [ + 'FEATUREdideZOYJZL', + ], + ], + 'parameters' => [ + [ + 'name' => 'ProjectId', + 'in' => 'query', + 'schema' => [ + 'description' => 'DataWorks工作空间的ID。您可以登录[DataWorks控制台](https://workbench.data.aliyun.com/console)，进入工作空间管理页面获取ID。'."\n" + ."\n" + .'该参数用来确定本次API调用操作使用的DataWorks工作空间。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '12345', + ], + ], + [ + 'name' => 'Owner', + 'in' => 'query', + 'schema' => [ + 'description' => '筛选条件：udf函数的负责人ID', + 'type' => 'string', + 'required' => false, + 'example' => '110755000425XXXX', + ], + ], + [ + 'name' => 'Type', + 'in' => 'query', + 'schema' => [ + 'description' => '筛选条件：函数类型'."\n" + ."\n" + .'可选值：'."\n" + ."\n\n" + .'- Math： 数学运算函数'."\n" + .'- Aggregate： 聚合函数'."\n" + .'- String：字符串处理函数'."\n" + .'- Date：日期函数'."\n" + .'- Analytic：窗口函数'."\n" + .'- Other： 其他函数', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [], + 'example' => 'Math', + ], + ], + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => [ + 'description' => '筛选条件：udf函数名称，支持模糊搜索。', + 'type' => 'string', + 'required' => false, + 'example' => 'test', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '分页的页数。默认值为1，最小值为1。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '2147483647', + 'minimum' => '1', + 'example' => '1', + 'default' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '每页显示的数据条数，默认为10条，最大为100条。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '100', + 'minimum' => '10', + 'example' => '10', + 'default' => '10', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。用于出现错误后排查问题。', + 'type' => 'string', + 'example' => '89FB2BF0-EB00-5D03-9C34-05931001XXXX', + ], + 'PagingInfo' => [ + 'description' => '分页信息', + 'type' => 'object', + 'properties' => [ + 'TotalCount' => [ + 'description' => '满足条件的数据总条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '294', + ], + 'PageNumber' => [ + 'description' => '请求的数据页数，用于翻页。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '每页显示的条数', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'Functions' => [ + 'description' => '函数列表', + 'type' => 'array', + 'items' => [ + 'description' => '函数列表元素信息', + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'title' => '资源名称', + 'description' => 'udf函数名称', + 'type' => 'string', + 'deprecated' => false, + 'example' => 'Function name', + 'pattern' => '', + 'default' => '', + ], + 'CreateTime' => [ + 'title' => '创建时间', + 'description' => 'udf函数创建时间戳', + 'type' => 'integer', + 'format' => 'int64', + 'deprecated' => false, + 'example' => '1655953028000', + 'pattern' => '', + 'default' => '', + ], + 'ProjectId' => [ + 'title' => '项目Id', + 'description' => 'udf函数所在的项目ID', + 'type' => 'integer', + 'format' => 'int64', + 'deprecated' => false, + 'example' => '307XXX', + 'pattern' => '', + 'default' => '', + ], + 'Owner' => [ + 'title' => '责任人', + 'description' => 'udf函数的责任人', + 'type' => 'string', + 'deprecated' => false, + 'example' => '110755000425XXXX', + 'pattern' => '', + 'default' => '', + ], + 'Type' => [ + 'title' => '函数类型', + 'description' => 'udf函数类型'."\n" + ."\n" + .'可选值：'."\n" + ."\n" + .'- Math： 数学运算函数'."\n" + .'- Aggregate： 聚合函数'."\n" + .'- String：字符串处理函数'."\n" + .'- Date：日期函数'."\n" + .'- Analytic：窗口函数'."\n" + .'- Other： 其他函数', + 'type' => 'string', + 'deprecated' => false, + 'enumValueTitles' => [], + 'example' => 'Math', + 'pattern' => '', + 'default' => '', + ], + 'ModifyTime' => [ + 'title' => '修改时间', + 'description' => '修改时间', + 'type' => 'integer', + 'format' => 'int64', + 'deprecated' => false, + 'example' => '1655953028000'."\n", + 'pattern' => '', + 'default' => '', + ], + 'ClassName' => [ + 'title' => '函数实现类名', + 'description' => 'udf函数的全限定类名', + 'type' => 'string', + 'deprecated' => false, + 'example' => 'com.demo.Main', + 'pattern' => '', + 'default' => '', + ], + 'ArmResource' => [ + 'title' => 'ARM集群资源文件列表', + 'description' => 'ARM集群资源文件列表', + 'type' => 'string', + 'deprecated' => false, + 'example' => 'xxx.jar,yyy.jar', + 'pattern' => '', + 'default' => '', + ], + 'FileResource' => [ + 'title' => '函数的实现代码', + 'description' => '函数的实现代码，资源文件列表', + 'type' => 'string', + 'deprecated' => false, + 'example' => 'xxx.jar,yyy.jar', + 'pattern' => '', + 'default' => '', + ], + 'Description' => [ + 'title' => '描述', + 'description' => '对于函数的总体描述', + 'type' => 'string', + 'deprecated' => false, + 'example' => 'Description', + 'pattern' => '', + 'default' => '', + ], + 'CommandDescription' => [ + 'title' => '命令描述', + 'description' => '命令描述', + 'type' => 'string', + 'deprecated' => false, + 'example' => 'testUdf(xx,yy)', + 'pattern' => '', + 'default' => '', + ], + 'ParameterDescription' => [ + 'title' => '命令描述', + 'description' => '参数描述', + 'type' => 'string', + 'deprecated' => false, + 'example' => 'xx: parameter information XXX'."\n" + .'yy: parameter information YYY', + 'pattern' => '', + 'default' => '', + ], + 'ReturnValueDescription' => [ + 'title' => '返回值说明', + 'description' => '返回值说明', + 'type' => 'string', + 'deprecated' => false, + 'example' => 'The return value is a string.', + 'pattern' => '', + 'default' => '', + ], + 'ExampleDescription' => [ + 'title' => '示例说明', + 'description' => '示例说明', + 'type' => 'string', + 'deprecated' => false, + 'example' => 'Example description >>> select tsetUdf(xx,yy);'."\n" + .'abc', + 'pattern' => '', + 'default' => '', + ], + 'EmbeddedCodeType' => [ + 'title' => '嵌套代码类型', + 'description' => '嵌套代码类型'."\n" + ."\n" + .'可选值'."\n" + ."\n" + .'- Python2'."\n" + .'- Python3'."\n" + .'- Java8'."\n" + .'- Java11'."\n" + .'- Java17', + 'type' => 'string', + 'deprecated' => false, + 'enumValueTitles' => [], + 'example' => 'Python2', + 'pattern' => '', + 'default' => '', + ], + 'EmbeddedResourceType' => [ + 'title' => '嵌套资源类型', + 'description' => '嵌套资源类型'."\n" + ."\n" + .'可选值'."\n" + ."\n" + .'- File 普通资源文件'."\n" + .'- Embedded 嵌入式资源', + 'type' => 'string', + 'deprecated' => false, + 'enumValueTitles' => [], + 'example' => 'File', + 'pattern' => '', + 'default' => '', + ], + 'EmbeddedCode' => [ + 'title' => '嵌套函数代码内容', + 'description' => '嵌套函数代码内容', + 'type' => 'string', + 'deprecated' => false, + 'example' => 'print(\'hello,world!\')', + 'pattern' => '', + 'default' => '', + ], + 'DatabaseName' => [ + 'title' => '数据库名', + 'description' => '数据库名，仅当Function类型为EMR Function时使用', + 'type' => 'string', + 'deprecated' => false, + 'example' => 'EMR_lake', + 'pattern' => '', + 'default' => '', + ], + 'DataSource' => [ + 'title' => '数据源', + 'description' => 'udf函数数据源信息', + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'title' => '数据源名称', + 'description' => '数据源名称', + 'type' => 'string', + 'deprecated' => false, + 'example' => 'odps_first', + 'pattern' => '', + 'default' => '', + ], + 'Type' => [ + 'title' => '数据源类型', + 'description' => '数据源类型', + 'type' => 'string', + 'deprecated' => false, + 'example' => 'odps', + 'pattern' => '', + 'default' => '', + ], + ], + 'deprecated' => false, + ], + 'Script' => [ + 'title' => '脚本信息', + 'description' => 'udf函数脚本信息', + 'type' => 'object', + 'properties' => [ + 'Path' => [ + 'title' => '脚本路径', + 'description' => '脚本路径', + 'type' => 'string', + 'deprecated' => false, + 'example' => 'XXX/OpenAPI/function/function_name', + 'pattern' => '', + 'default' => '', + ], + 'Runtime' => [ + 'title' => '运行时', + 'description' => '运行时', + 'type' => 'object', + 'properties' => [ + 'Command' => [ + 'title' => '命令', + 'description' => '命令', + 'type' => 'string', + 'deprecated' => false, + 'example' => 'ODPS_FUNCTION', + 'pattern' => '', + 'default' => '', + ], + ], + 'deprecated' => false, + ], + 'Id' => [ + 'description' => '脚本id。'."\n" + ."\n" + .'><notice>该字段在SDK8.0.0版本之前为Long类型，SDK8.0.0版本及之后为String类型。**该变更不影响SDK正常使用，参数仍会按SDK中定义的类型返回**。只有在跨8.0.0版本的SDK升级时，类型变更可能会导致项目编译不通过，需要用户手动修正数据类型。></notice>', + 'type' => 'string', + 'deprecated' => false, + 'example' => '652567824470354XXXX', + ], + ], + 'deprecated' => false, + 'required' => false, + ], + 'RuntimeResource' => [ + 'title' => '运行时资源组信息', + 'description' => '运行时资源组信息', + 'type' => 'object', + 'properties' => [ + 'ResourceGroupId' => [ + 'title' => '运行时资源组Id', + 'description' => '运行时资源组Id', + 'type' => 'string', + 'deprecated' => false, + 'example' => 'S_resgrop_xxx', + 'pattern' => '', + 'default' => '', + ], + ], + 'deprecated' => false, + ], + 'Id' => [ + 'description' => 'udf函数唯一标识符。'."\n" + ."\n" + .'><notice>该字段在SDK8.0.0版本之前为Long类型，SDK8.0.0版本及之后为String类型。**该变更不影响SDK正常使用，参数仍会按SDK中定义的类型返回**。只有在跨8.0.0版本的SDK升级时，类型变更可能会导致项目编译不通过，需要用户手动修正数据类型。></notice>', + 'type' => 'string', + 'example' => '580667964888595XXXX', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"89FB2BF0-EB00-5D03-9C34-05931001XXXX\\",\\n \\"PagingInfo\\": {\\n \\"TotalCount\\": 294,\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"Functions\\": [\\n {\\n \\"Name\\": \\"Function name\\",\\n \\"CreateTime\\": 1655953028000,\\n \\"ProjectId\\": 0,\\n \\"Owner\\": \\"110755000425XXXX\\",\\n \\"Type\\": \\"Math\\",\\n \\"ModifyTime\\": 1655953028000,\\n \\"ClassName\\": \\"com.demo.Main\\",\\n \\"ArmResource\\": \\"xxx.jar,yyy.jar\\",\\n \\"FileResource\\": \\"xxx.jar,yyy.jar\\",\\n \\"Description\\": \\"Description\\",\\n \\"CommandDescription\\": \\"testUdf(xx,yy)\\",\\n \\"ParameterDescription\\": \\"xx: parameter information XXX\\\\nyy: parameter information YYY\\",\\n \\"ReturnValueDescription\\": \\"The return value is a string.\\",\\n \\"ExampleDescription\\": \\"Example description >>> select tsetUdf(xx,yy);\\\\nabc\\",\\n \\"EmbeddedCodeType\\": \\"Python2\\",\\n \\"EmbeddedResourceType\\": \\"File\\",\\n \\"EmbeddedCode\\": \\"print(\'hello,world!\')\\",\\n \\"DatabaseName\\": \\"EMR_lake\\",\\n \\"DataSource\\": {\\n \\"Name\\": \\"odps_first\\",\\n \\"Type\\": \\"odps\\"\\n },\\n \\"Script\\": {\\n \\"Path\\": \\"XXX/OpenAPI/function/function_name\\",\\n \\"Runtime\\": {\\n \\"Command\\": \\"ODPS_FUNCTION\\"\\n },\\n \\"Id\\": \\"652567824470354XXXX\\"\\n },\\n \\"RuntimeResource\\": {\\n \\"ResourceGroupId\\": \\"S_resgrop_xxx\\"\\n },\\n \\"Id\\": \\"580667964888595XXXX\\"\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => '获取数据开发函数列表', + ], + 'CreatePipelineRun' => [ + 'summary' => '调用此接口，可以对新版数据开发中的实体创建一个发布流程。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'abilityTreeCode' => '267910', + 'abilityTreeNodes' => [ + 'FEATUREdide4AR6E0', + ], + ], + 'parameters' => [ + [ + 'name' => 'ProjectId', + 'in' => 'formData', + 'schema' => [ + 'title' => '项目Id', + 'description' => 'DataWorks工作空间的ID。您可以登录[DataWorks控制台](https://workbench.data.aliyun.com/console)，进入工作空间配置页面获取工作空间ID。'."\n" + .'该参数用来确定本次API调用操作使用的DataWorks工作空间。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '10000', + 'pattern' => '', + 'default' => '', + ], + ], + [ + 'name' => 'Type', + 'in' => 'formData', + 'schema' => [ + 'description' => '表示发布流程是上线还是下线'."\n" + ."\n" + .'- Online：上线'."\n" + ."\n" + .'- Offline：下线', + 'type' => 'string', + 'required' => true, + 'example' => 'Online', + ], + ], + [ + 'name' => 'ObjectIds', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'description' => '本次发布流程希望发布的实体Id列表。'."\n" + .'><notice>目前只支持对于单个实体及其子实体的发布，因此只有该array的第一个实体及其子实体会被发布成功。请确保该array的长度为1，超出1的部分会被忽略。></notice>', + 'type' => 'array', + 'items' => [ + 'description' => '希望发布的实体Id，如Node、WorkflowDefinition等实体的Id。'."\n" + .'><notice>WorkflowDefinition只允许作为整体发布，目前不支持单独发布Workflow内部的单个节点></notice>', + 'type' => 'string', + 'required' => false, + 'example' => '476506242076571XXXX', + ], + 'required' => true, + 'maxItems' => 10, + 'minItems' => 1, + ], + ], + [ + 'name' => 'Description', + 'in' => 'formData', + 'schema' => [ + 'description' => '对于发布流程的描述信息', + 'type' => 'string', + 'required' => false, + 'example' => 'This is a OdpsSQL-node publishing process. The function is XXXX.', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。用于定位日志，排查问题。'."\n", + 'type' => 'string', + 'example' => '7C352CB7-CD88-50CF-9D0D-E81BDF02XXXX', + ], + 'Id' => [ + 'description' => '发布流程的唯一标识符', + 'type' => 'string', + 'example' => 'a7ef0634-20ec-4a7c-a214-54020f91XXXX'."\n", + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"7C352CB7-CD88-50CF-9D0D-E81BDF02XXXX\\",\\n \\"Id\\": \\"a7ef0634-20ec-4a7c-a214-54020f91XXXX\\\\n\\"\\n}","type":"json"}]', + 'title' => '创建发布流程', + 'description' => '><notice>该接口目前不支持批量操作，参数中填写多个发布实体时，除第一个以外的部分会被直接忽略。></notice>'."\n" + .'><notice>低版本的SDK中可能无该接口，此时请使用CreateDeployment接口，参数与该文档一致。></notice>', + ], + 'AbolishPipelineRun' => [ + 'summary' => '调用该接口，会将指定发布流程的状态变更为终止状态，但不会删除这个发布流程，仍然可以通过查询接口查询到。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '267906', + 'abilityTreeNodes' => [ + 'FEATUREdide4AR6E0', + ], + ], + 'parameters' => [ + [ + 'name' => 'ProjectId', + 'in' => 'formData', + 'schema' => [ + 'description' => 'DataWorks工作空间的ID。您可以登录[DataWorks控制台](https://workbench.data.aliyun.com/console)，进入工作空间管理页面获取ID。'."\n" + ."\n" + .'该参数用来确定本次API调用操作使用的DataWorks工作空间。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '10000', + ], + ], + [ + 'name' => 'Id', + 'in' => 'formData', + 'schema' => [ + 'description' => '发布流程的唯一标识', + 'type' => 'string', + 'required' => true, + 'example' => '1606087c-9ac4-43f0-83a8-0b5ced21XXXX'."\n", + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求的ID。用于定位日志，排查问题。', + 'type' => 'string', + 'example' => '55D786C9-DD57-524D-884C-C5239278XXXX'."\n", + ], + 'Success' => [ + 'description' => '请求是否成功。取值如下：'."\n" + .'- true：成功。'."\n" + .'- false：失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"55D786C9-DD57-524D-884C-C5239278XXXX\\\\n\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => '终止发布流程', + 'description' => '><notice>低版本的SDK中可能无该接口，此时请使用AbolishDeployment接口，参数与该文档一致。></notice>', + ], + 'ExecPipelineRunStage' => [ + 'summary' => '调用此接口，可以执行发布流程的指定阶段。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'abilityTreeCode' => '267908', + 'abilityTreeNodes' => [ + 'FEATUREdide4AR6E0', + ], + ], + 'parameters' => [ + [ + 'name' => 'ProjectId', + 'in' => 'query', + 'schema' => [ + 'description' => 'DataWorks工作空间的ID。您可以登录[DataWorks控制台](https://workbench.data.aliyun.com/console)，进入工作空间配置页面获取工作空间ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '10000', + ], + ], + [ + 'name' => 'Id', + 'in' => 'formData', + 'schema' => [ + 'description' => '发布流程的唯一标识符', + 'type' => 'string', + 'required' => true, + 'example' => 'a7ef0634-20ec-4a7c-a214-54020f91XXXX', + ], + ], + [ + 'name' => 'Code', + 'in' => 'formData', + 'schema' => [ + 'description' => '表示发布流程阶段的代码，具体以GetPipelineRun接口的返回值为准', + 'type' => 'string', + 'required' => true, + 'example' => 'DEV_CHECK', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求的ID。用于定位日志，排查问题。', + 'type' => 'string', + 'example' => 'AFBB799F-8578-51C5-A766-E922EDB8XXXX'."\n", + ], + 'Success' => [ + 'description' => '调用是否成功。取值如下：'."\n" + .'- true：调用成功。'."\n" + .'- false：调用失败。'."\n" + .'><notice>只表示触发阶段执行是否成功，不代表发布阶段执行结果></notice>', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"AFBB799F-8578-51C5-A766-E922EDB8XXXX\\\\n\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => '执行发布流程的指定阶段', + 'description' => '><notice>发布流程的阶段是有顺序的，详见GetPipelineRun返回值。不允许跳过或重复执行某一阶段。></notice>'."\n" + .'><notice>执行过程是异步的，返回值只表示触发成功，不表示阶段执行成功。执行结果以GetPipelineRun返回值为准。></notice>'."\n" + .'><notice>低版本的SDK中可能无该接口，此时请使用ExecDeploymentStage接口，参数与该文档一致。></notice>', + ], + 'GetPipelineRun' => [ + 'summary' => '调用此接口，获取发布流程详细信息。', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '267907', + 'abilityTreeNodes' => [ + 'FEATUREdide4AR6E0', + ], + ], + 'parameters' => [ + [ + 'name' => 'ProjectId', + 'in' => 'query', + 'schema' => [ + 'description' => 'DataWorks工作空间的ID。您可以登录[DataWorks控制台](https://workbench.data.aliyun.com/console)，进入工作空间管理页面获取ID。'."\n" + ."\n" + .'该参数用来确定本次API调用操作使用的DataWorks工作空间。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '10000', + ], + ], + [ + 'name' => 'Id', + 'in' => 'query', + 'schema' => [ + 'title' => '实例 ID。', + 'description' => '发布流程的唯一标识符。', + 'type' => 'string', + 'required' => true, + 'example' => 'a7ef0634-20ec-4a7c-a214-54020f****'."\n", + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求的ID。用于定位日志，排查问题。', + 'type' => 'string', + 'example' => '08468352-032C-5262-AEDC-68C9FA05XXXX', + ], + 'Pipeline' => [ + 'description' => '整个发布流程的信息', + 'type' => 'object', + 'properties' => [ + 'Id' => [ + 'title' => '发布流程Id', + 'description' => '发布流程Id', + 'type' => 'string', + 'deprecated' => false, + 'example' => 'a7ef0634-20ec-4a7c-a214-54020f91XXXX'."\n", + 'pattern' => '', + 'default' => '', + ], + 'ProjectId' => [ + 'description' => 'DataWorks工作空间的ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '56160', + ], + 'CreateTime' => [ + 'title' => '发布包创建时间戳', + 'description' => '发布包创建时间戳', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1724984066000', + ], + 'ModifyTime' => [ + 'title' => '修改时间', + 'description' => '修改时间', + 'type' => 'integer', + 'format' => 'int64', + 'deprecated' => false, + 'example' => '1724984066000', + 'pattern' => '', + 'default' => '', + ], + 'Creator' => [ + 'title' => '创建人', + 'description' => '创建人', + 'type' => 'string', + 'deprecated' => false, + 'example' => '137946317766XXXX', + 'pattern' => '', + 'default' => '', + ], + 'Status' => [ + 'title' => '发布流程状态', + 'description' => '发布流程状态'."\n" + ."\n" + .'可选值：'."\n" + ."\n" + .'- Init 初始化'."\n" + .'- Running 运行中'."\n" + .'- Success 运行成功'."\n" + .'- Fail 运行失败'."\n" + .'- Termination 被终止'."\n" + .'- Cancel 被取消', + 'type' => 'string', + 'deprecated' => false, + 'example' => 'Running', + 'pattern' => '', + 'default' => '', + 'enum' => [ + 'Init', + 'Running', + 'Success', + 'Fail', + 'Termination', + 'Cancel', + ], + ], + 'Message' => [ + 'description' => '发布失败的错误信息', + 'type' => 'string', + 'example' => 'Error message', + ], + 'Stages' => [ + 'title' => '步骤详情', + 'description' => '步骤详情', + 'type' => 'array', + 'items' => [ + 'title' => 'stage的元素', + 'description' => 'stage的元素', + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'title' => '阶段代号', + 'description' => '发布阶段代号', + 'type' => 'string', + 'deprecated' => false, + 'example' => 'DEV_CHECK', + 'pattern' => '', + 'default' => '', + ], + 'Step' => [ + 'title' => '步骤', + 'description' => '发布阶段步骤编号', + 'type' => 'integer', + 'format' => 'int32', + 'deprecated' => false, + 'example' => '1', + 'pattern' => '', + 'default' => '', + ], + 'Type' => [ + 'title' => '阶段类型', + 'description' => '发布阶段类型'."\n" + ."\n" + .'可选值'."\n" + ."\n" + .'- Deploy 发布操作'."\n" + .'- Check 检查操作'."\n" + .'- Offline 下线操作'."\n" + .'- Build 构建操作'."\n" + .'- Delete 删除操作', + 'type' => 'string', + 'deprecated' => false, + 'enumValueTitles' => [ + 'Delete' => 'Delete', + 'Build' => 'Build', + 'Check' => 'Check', + 'Offline' => 'Offline', + 'Deploy' => 'Deploy', + ], + 'example' => 'Check', + 'pattern' => '', + 'default' => '', + ], + 'Name' => [ + 'title' => '阶段名称', + 'description' => '阶段名称', + 'type' => 'string', + 'deprecated' => false, + 'example' => 'Publish package build', + 'pattern' => '', + 'default' => '', + ], + 'Description' => [ + 'title' => '阶段描述', + 'description' => '阶段描述', + 'type' => 'string', + 'deprecated' => false, + 'example' => 'Phase description', + 'pattern' => '', + 'default' => '', + ], + 'Message' => [ + 'title' => '阶段信息', + 'description' => '发布阶段异常信息', + 'type' => 'string', + 'deprecated' => false, + 'example' => 'Exception information XXX', + 'pattern' => '', + 'default' => '', + ], + 'Status' => [ + 'title' => '阶段状态', + 'description' => '发布阶段状态'."\n" + ."\n" + .'可选值：'."\n" + ."\n" + .'- Init 初始化'."\n" + .'- Running 运行中'."\n" + .'- Success 运行成功'."\n" + .'- Fail 运行失败'."\n" + .'- Termination 被终止'."\n" + .'- Cancel 被取消', + 'type' => 'string', + 'deprecated' => false, + 'enumValueTitles' => [ + 'Init' => 'Init', + 'Cancel' => 'Cancel', + 'Running' => 'Running', + 'Termination' => 'Termination', + 'Success' => 'Success', + 'Fail' => 'Fail', + ], + 'example' => 'Running', + 'pattern' => '', + 'default' => '', + ], + 'Detail' => [ + 'description' => '阶段详细信息', + 'type' => 'object', + 'deprecated' => false, + 'additionalProperties' => [ + 'type' => 'any', + 'description' => '阶段额外的信息描述', + 'example' => '"checkerList": ['."\n" + .' {'."\n" + .' "code": "BuildPackageChecker",'."\n" + .' "name": "Build_Package_Checker"'."\n" + .' },'."\n" + .' {'."\n" + .' "code": "NodeParentDependency",'."\n" + .' "name": "Downstream_Dependency_Checker"'."\n" + .' },'."\n" + .' {'."\n" + .' "code": "NodeInProcess",'."\n" + .' "name": "Decommissioning_Process_Checker"'."\n" + .' }'."\n" + .']'."\n", + ], + ], + ], + 'deprecated' => false, + ], + 'deprecated' => false, + ], + 'Description' => [ + 'title' => '发布流程的描述信息', + 'description' => '发布流程的描述信息', + 'type' => 'string', + 'example' => '发布流程描述信息', + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"08468352-032C-5262-AEDC-68C9FA05XXXX\\",\\n \\"Pipeline\\": {\\n \\"Id\\": \\"a7ef0634-20ec-4a7c-a214-54020f91XXXX\\\\n\\",\\n \\"ProjectId\\": 56160,\\n \\"CreateTime\\": 1724984066000,\\n \\"ModifyTime\\": 1724984066000,\\n \\"Creator\\": \\"137946317766XXXX\\",\\n \\"Status\\": \\"Running\\",\\n \\"Message\\": \\"Error message\\",\\n \\"Stages\\": [\\n {\\n \\"Code\\": \\"DEV_CHECK\\",\\n \\"Step\\": 1,\\n \\"Type\\": \\"Check\\",\\n \\"Name\\": \\"Publish package build\\",\\n \\"Description\\": \\"Phase description\\",\\n \\"Message\\": \\"Exception information XXX\\",\\n \\"Status\\": \\"Running\\",\\n \\"Detail\\": {\\n \\"key\\": \\"\\\\\\"checkerList\\\\\\": [\\\\n {\\\\n \\\\\\"code\\\\\\": \\\\\\"BuildPackageChecker\\\\\\",\\\\n \\\\\\"name\\\\\\": \\\\\\"Build_Package_Checker\\\\\\"\\\\n },\\\\n {\\\\n \\\\\\"code\\\\\\": \\\\\\"NodeParentDependency\\\\\\",\\\\n \\\\\\"name\\\\\\": \\\\\\"Downstream_Dependency_Checker\\\\\\"\\\\n },\\\\n {\\\\n \\\\\\"code\\\\\\": \\\\\\"NodeInProcess\\\\\\",\\\\n \\\\\\"name\\\\\\": \\\\\\"Decommissioning_Process_Checker\\\\\\"\\\\n }\\\\n]\\\\n\\"\\n }\\n }\\n ],\\n \\"Description\\": \\"发布流程描述信息\\"\\n }\\n}","type":"json"}]', + 'title' => '获取发布流程详细信息', + 'description' => '><notice>低版本的SDK中可能无该接口，此时请使用GetDeployment接口，参数与该文档一致。></notice>', + ], + 'ListPipelineRuns' => [ + 'summary' => '分页获取发布流程列表，也可以使用筛选条件对发布流程进行筛选。', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '267909', + 'abilityTreeNodes' => [ + 'FEATUREdide4AR6E0', + ], + ], + 'parameters' => [ + [ + 'name' => 'ProjectId', + 'in' => 'query', + 'schema' => [ + 'description' => 'DataWorks工作空间的ID。您可以登录[DataWorks控制台](https://workbench.data.aliyun.com/console)，进入工作空间管理页面获取ID。'."\n" + ."\n" + .'该参数用来确定本次API调用操作使用的DataWorks工作空间。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '10000', + ], + ], + [ + 'name' => 'Creator', + 'in' => 'query', + 'schema' => [ + 'description' => '筛选条件：发布流程的创建者', + 'type' => 'string', + 'required' => false, + 'example' => '110755000425****'."\n", + ], + ], + [ + 'name' => 'Status', + 'in' => 'query', + 'schema' => [ + 'description' => '筛选条件：发布流程的当前状态'."\n" + ."\n" + .'可选值：'."\n" + ."\n" + .'- Init 初始化'."\n" + .'- Running 运行中'."\n" + .'- Success 运行成功'."\n" + .'- Fail 运行失败'."\n" + .'- Termination 被终止'."\n" + .'- Cancel 被取消', + 'type' => 'string', + 'required' => false, + 'example' => 'Running', + ], + ], + [ + 'name' => 'ObjectId', + 'in' => 'query', + 'schema' => [ + 'title' => '发布物的ID', + 'description' => '发布物的ID', + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '页码，从1开始，默认值为1。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '2147483647', + 'minimum' => '1', + 'example' => '1', + 'default' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '每页显示的条数，默认为10条，最大100条。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '100', + 'minimum' => '10', + 'example' => '10', + 'default' => '10', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求的ID。用于定位日志，排查问题。', + 'type' => 'string', + 'example' => '7C352CB7-CD88-50CF-9D0D-E81BDF02XXXX'."\n", + ], + 'PagingInfo' => [ + 'description' => '分页信息。', + 'type' => 'object', + 'properties' => [ + 'TotalCount' => [ + 'description' => '满足条件的数据总条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2524', + ], + 'PageSize' => [ + 'description' => '每页显示的条数', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'PageNumber' => [ + 'description' => '查询分页的页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PipelineRuns' => [ + 'description' => '发布流程信息列表。', + 'type' => 'array', + 'items' => [ + 'description' => '发布流程列表元素', + 'type' => 'object', + 'properties' => [ + 'Id' => [ + 'title' => '发布流程Id', + 'description' => '发布流程Id', + 'type' => 'string', + 'deprecated' => false, + 'example' => '097c73fe-ed6e-4fb1-b109-a5d59e46cd58', + 'pattern' => '', + 'default' => '', + ], + 'ProjectId' => [ + 'title' => '项目Id', + 'description' => '项目Id', + 'type' => 'integer', + 'format' => 'int64', + 'deprecated' => false, + 'example' => '70199', + 'pattern' => '', + 'default' => '', + ], + 'CreateTime' => [ + 'title' => '发布包创建时间戳', + 'description' => '发布包创建时间戳', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1702736654000', + ], + 'ModifyTime' => [ + 'title' => '修改时间', + 'description' => '修改时间', + 'type' => 'integer', + 'format' => 'int64', + 'deprecated' => false, + 'example' => '1702736654000', + 'pattern' => '', + 'default' => '', + ], + 'Creator' => [ + 'title' => '创建人', + 'description' => '创建人', + 'type' => 'string', + 'deprecated' => false, + 'example' => '110755000425XXXX', + 'pattern' => '', + 'default' => '', + ], + 'Status' => [ + 'title' => '发布流程状态', + 'description' => '发布流程状态'."\n" + ."\n" + .'可选值'."\n" + ."\n" + .'- Init 初始化'."\n" + .'- Running 运行中'."\n" + .'- Success 运行成功'."\n" + .'- Fail 运行失败'."\n" + .'- Termination 被终止'."\n" + .'- Cancel 被取消', + 'type' => 'string', + 'deprecated' => false, + 'example' => 'Running', + 'pattern' => '', + 'default' => '', + 'enum' => [ + 'Init', + 'Running', + 'Success', + 'Fail', + 'Termination', + 'Cancel', + ], + ], + 'Message' => [ + 'description' => '发布阶段发生错误时的错误信息', + 'type' => 'string', + 'example' => 'Error message', + ], + 'Stages' => [ + 'title' => '步骤详情', + 'description' => '发布阶段列表', + 'type' => 'array', + 'items' => [ + 'title' => 'stage的元素', + 'description' => '发布阶段列表元素', + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'title' => '阶段代号', + 'description' => '发布阶段代号', + 'type' => 'string', + 'deprecated' => false, + 'example' => 'DEV_CHECK', + 'pattern' => '', + 'default' => '', + ], + 'Step' => [ + 'title' => '步骤', + 'description' => '发布阶段步骤编号', + 'type' => 'integer', + 'format' => 'int32', + 'deprecated' => false, + 'example' => '1', + 'pattern' => '', + 'default' => '', + ], + 'Type' => [ + 'title' => '阶段类型', + 'description' => '发布阶段类型，是该发布阶段操作类型的一个分类。'."\n" + ."\n" + .'可选值'."\n" + ."\n" + .'- Deploy 发布操作'."\n" + .'- Check 检查操作'."\n" + .'- Offline 下线操作'."\n" + .'- Build 构建操作'."\n" + .'- Delete 删除操作', + 'type' => 'string', + 'deprecated' => false, + 'example' => 'Check', + 'pattern' => '', + 'default' => '', + ], + 'Name' => [ + 'title' => '阶段名称', + 'description' => '阶段名称', + 'type' => 'string', + 'deprecated' => false, + 'example' => 'Check before going online to development'."\n", + 'pattern' => '', + 'default' => '', + ], + 'Description' => [ + 'title' => '阶段描述', + 'description' => '阶段描述', + 'type' => 'string', + 'deprecated' => false, + 'example' => 'Check before going online to development'."\n", + 'pattern' => '', + 'default' => '', + ], + 'Message' => [ + 'title' => '阶段信息', + 'description' => '发布阶段发生错误时的错误信息', + 'type' => 'string', + 'deprecated' => false, + 'example' => 'Error message'."\n", + 'pattern' => '', + 'default' => '', + ], + 'Status' => [ + 'title' => '阶段状态', + 'description' => '发布阶段状态'."\n" + ."\n" + .'可选值'."\n" + ."\n\n" + .'- Init 初始化'."\n" + .'- Running 运行中'."\n" + .'- Success 运行成功'."\n" + .'- Fail 运行失败'."\n" + .'- Termination 被终止'."\n" + .'- Cancel 被取消', + 'type' => 'string', + 'deprecated' => false, + 'example' => 'Running', + 'pattern' => '', + 'default' => '', + ], + 'Detail' => [ + 'title' => '阶段详细信息', + 'description' => '发布阶段的其他补充信息', + 'type' => 'object', + 'deprecated' => false, + 'additionalProperties' => [ + 'type' => 'any', + 'description' => '补充信息', + 'example' => '{'."\n" + .' "checkerList": ['."\n" + .' {'."\n" + .' "code": "BuildPackageChecker",'."\n" + .' "name": "package check"'."\n" + .' },'."\n" + .' {'."\n" + .' "code": "NodeParentDependency",'."\n" + .' "name": "downstream dependency check"'."\n" + .' },'."\n" + .' {'."\n" + .' "code": "NodeInProcess",'."\n" + .' "name": "offline process check"'."\n" + .' }'."\n" + .' ]'."\n" + .'}', + ], + ], + ], + 'deprecated' => false, + ], + 'deprecated' => false, + ], + 'Description' => [ + 'title' => '发布流程的描述信息', + 'description' => '发布流程的描述信息', + 'type' => 'string', + 'example' => '发布流程描述信息', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"7C352CB7-CD88-50CF-9D0D-E81BDF02XXXX\\\\n\\",\\n \\"PagingInfo\\": {\\n \\"TotalCount\\": 2524,\\n \\"PageSize\\": 10,\\n \\"PageNumber\\": 1,\\n \\"PipelineRuns\\": [\\n {\\n \\"Id\\": \\"097c73fe-ed6e-4fb1-b109-a5d59e46cd58\\",\\n \\"ProjectId\\": 70199,\\n \\"CreateTime\\": 1702736654000,\\n \\"ModifyTime\\": 1702736654000,\\n \\"Creator\\": \\"110755000425XXXX\\",\\n \\"Status\\": \\"Running\\",\\n \\"Message\\": \\"Error message\\",\\n \\"Stages\\": [\\n {\\n \\"Code\\": \\"DEV_CHECK\\",\\n \\"Step\\": 1,\\n \\"Type\\": \\"Check\\",\\n \\"Name\\": \\"Check before going online to development\\\\n\\",\\n \\"Description\\": \\"Check before going online to development\\\\n\\",\\n \\"Message\\": \\"Error message\\\\n\\",\\n \\"Status\\": \\"Running\\",\\n \\"Detail\\": {\\n \\"key\\": \\"{\\\\n \\\\\\"checkerList\\\\\\": [\\\\n {\\\\n \\\\\\"code\\\\\\": \\\\\\"BuildPackageChecker\\\\\\",\\\\n \\\\\\"name\\\\\\": \\\\\\"package check\\\\\\"\\\\n },\\\\n {\\\\n \\\\\\"code\\\\\\": \\\\\\"NodeParentDependency\\\\\\",\\\\n \\\\\\"name\\\\\\": \\\\\\"downstream dependency check\\\\\\"\\\\n },\\\\n {\\\\n \\\\\\"code\\\\\\": \\\\\\"NodeInProcess\\\\\\",\\\\n \\\\\\"name\\\\\\": \\\\\\"offline process check\\\\\\"\\\\n }\\\\n ]\\\\n}\\"\\n }\\n }\\n ],\\n \\"Description\\": \\"发布流程描述信息\\"\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => '获取发布流程列表', + 'description' => '><notice>低版本的SDK中可能无该接口，此时请使用ListDeployments接口，参数与该文档一致。></notice>', + ], + 'ListPipelineRunItems' => [ + 'summary' => '通过发布流程的ID获取发布内容。', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '267918', + 'abilityTreeNodes' => [ + 'FEATUREdide4AR6E0', + ], + ], + 'parameters' => [ + [ + 'name' => 'ProjectId', + 'in' => 'query', + 'schema' => [ + 'description' => 'DataWorks工作空间的ID。'."\n" + .'您可以登录DataWorks管控台，进入工作空间配置页面获取工作空间ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '10001', + ], + ], + [ + 'name' => 'PipelineRunId', + 'in' => 'query', + 'schema' => [ + 'description' => '工作流任务ID，如何获取工作流任务ID，'."\n" + .'请参见[ListPipelineRuns](~~438042~~)。', + 'type' => 'string', + 'required' => true, + 'example' => ' '."\n" + .'097c73fe-ed6e-4fb1-b109-a5d59e46cd58'."\n", + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '请求的数据页数，'."\n" + .'用于翻页。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '2147483647', + 'minimum' => '1', + 'example' => '1', + 'default' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '每页显示的条数，'."\n" + .'默认为10条，最大100条。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '100', + 'minimum' => '10', + 'example' => '10', + 'default' => '10', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用的唯一ID。'."\n" + .'出现错误后，您可以根据该ID排查问题。', + 'type' => 'string', + 'example' => 'C99E2BE6-9DEA-5C2E-8F51-1DDCFEADE490', + ], + 'PagingInfo' => [ + 'description' => '分页信息。', + 'type' => 'object', + 'properties' => [ + 'TotalCount' => [ + 'description' => '满足条件数据总条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '12', + ], + 'PageSize' => [ + 'description' => '分页大小。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'PageNumber' => [ + 'description' => '页码'."\n" + .'。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PipelineRunItems' => [ + 'description' => '发布物列表。', + 'type' => 'array', + 'items' => [ + 'description' => '发布物详情。', + 'type' => 'object', + 'properties' => [ + 'Version' => [ + 'title' => '项目Id', + 'description' => '发布物版本。', + 'type' => 'integer', + 'format' => 'int64', + 'deprecated' => false, + 'example' => '1', + 'pattern' => '', + 'default' => '', + ], + 'Name' => [ + 'description' => '发布物名称。', + 'type' => 'string', + 'example' => 'test', + ], + 'CreateTime' => [ + 'title' => '发布包创建时间戳', + 'description' => '发布物创建时间。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1724984066000', + ], + 'ModifyTime' => [ + 'title' => '修改时间', + 'description' => '发布物修改时间。', + 'type' => 'integer', + 'format' => 'int64', + 'deprecated' => false, + 'example' => '1724984066000', + 'pattern' => '', + 'default' => '', + ], + 'Status' => [ + 'title' => '发布流程状态', + 'description' => '发布物状态'."\n" + ."\n" + .'- Init 初始化'."\n" + .'- Running 运行中'."\n" + .'- Success 成功'."\n" + .'- Fail 失败'."\n" + .'- Termination 终止', + 'type' => 'string', + 'deprecated' => false, + 'example' => 'Running', + 'pattern' => '', + 'default' => '', + 'enum' => [ + 'Init', + 'Running', + 'Success', + 'Fail', + 'Termination', + ], + ], + 'Message' => [ + 'title' => '创建人', + 'description' => '发布失败的错误信息。', + 'type' => 'string', + 'deprecated' => false, + 'example' => 'Error Message', + 'pattern' => '', + 'default' => '', + ], + 'Type' => [ + 'description' => '发布物类型'."\n" + ."\n" + .'- Node 节点'."\n" + .'- WorkflowDefinition 工作流定义'."\n" + .'- Resource 资源'."\n" + .'- Function 函数', + 'type' => 'string', + 'example' => 'Node', + ], + 'Spec' => [ + 'description' => '描述这个发布物的 FlowSpec 信息，'."\n" + .'具体规范详见[FlowSpec](https://github.com/aliyun/dataworks-spec/blob/master/README_zh_CN.md)。', + 'type' => 'string', + 'example' => '{ "version": "1.1.0", "kind": "Node", "spec": { "nodes": [ { "recurrence": "Normal", "id": "860438872620113XXXX", "timeout": 0, "instanceMode": "T+1", "rerunMode": "Allowed", "rerunTimes": 3, "rerunInterval": 180000, "datasource": { "name": "odps_test", "type": "odps" }, "script": { "language": "odps-sql", "path": "XX/OpenAPI_Test/ODPS_SQL_Test", "runtime": { "command": "ODPS_SQL", "commandTypeId": 10 }, "content": "select now();", "id": "853573334108680XXXX" }, "trigger": { "type": "Scheduler", "id": "543680677872062XXXX", "cron": "00 00 00 * * ?", "startTime": "1970-01-01 00:00:00", "endTime": "9999-01-01 00:00:00", "timezone": "Asia/Shanghai", "delaySeconds": 0 }, "runtimeResource": { "resourceGroup": "S_res_group_XXXX_XXXX", "id": "623731286945488XXXX", "resourceGroupId": "7201XXXX" }, "name": "ODPS_SQL_Test", "owner": "110755000425XXXX", "metadata": { "owner": "110755000425XXXX", "ownerName": "[email protected]", "projectId": "307XXX" }, "inputs": { "nodeOutputs": [ { "data": "lwttest_standard_root", "artifactType": "NodeOutput" } ] }, "outputs": { "nodeOutputs": [ { "data": "860438872620113XXXX", "artifactType": "NodeOutput", "refTableName": "ODPS_SQL_Test", "isDefault": true } ] } } ], "flow": [ { "nodeId": "860438872620113XXXX", "depends": [ { "type": "Normal", "output": "lwttest_standard_root" } ] } ] }, "metadata": { "uuid": "860438872620113XXXX" } }', + ], + 'Id' => [ + 'description' => '发布物唯一标识符。'."\n" + ."\n" + .'><notice>该字段在SDK8.0.0版本之前为Long类型，SDK8.0.0版本及之后为String类型。**该变更不影响SDK正常使用，参数仍会按SDK中定义的类型返回**。只有在跨8.0.0版本的SDK升级时，类型变更可能会导致项目编译不通过，需要用户手动修正数据类型。></notice>', + 'type' => 'string', + 'deprecated' => false, + 'example' => '860438872620113XXXX', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"C99E2BE6-9DEA-5C2E-8F51-1DDCFEADE490\\",\\n \\"PagingInfo\\": {\\n \\"TotalCount\\": 12,\\n \\"PageSize\\": 10,\\n \\"PageNumber\\": 1,\\n \\"PipelineRunItems\\": [\\n {\\n \\"Version\\": 1,\\n \\"Name\\": \\"test\\",\\n \\"CreateTime\\": 1724984066000,\\n \\"ModifyTime\\": 1724984066000,\\n \\"Status\\": \\"Running\\",\\n \\"Message\\": \\"Error Message\\",\\n \\"Type\\": \\"Node\\",\\n \\"Spec\\": \\"{ \\\\\\"version\\\\\\": \\\\\\"1.1.0\\\\\\", \\\\\\"kind\\\\\\": \\\\\\"Node\\\\\\", \\\\\\"spec\\\\\\": { \\\\\\"nodes\\\\\\": [ { \\\\\\"recurrence\\\\\\": \\\\\\"Normal\\\\\\", \\\\\\"id\\\\\\": \\\\\\"860438872620113XXXX\\\\\\", \\\\\\"timeout\\\\\\": 0, \\\\\\"instanceMode\\\\\\": \\\\\\"T+1\\\\\\", \\\\\\"rerunMode\\\\\\": \\\\\\"Allowed\\\\\\", \\\\\\"rerunTimes\\\\\\": 3, \\\\\\"rerunInterval\\\\\\": 180000, \\\\\\"datasource\\\\\\": { \\\\\\"name\\\\\\": \\\\\\"odps_test\\\\\\", \\\\\\"type\\\\\\": \\\\\\"odps\\\\\\" }, \\\\\\"script\\\\\\": { \\\\\\"language\\\\\\": \\\\\\"odps-sql\\\\\\", \\\\\\"path\\\\\\": \\\\\\"XX/OpenAPI_Test/ODPS_SQL_Test\\\\\\", \\\\\\"runtime\\\\\\": { \\\\\\"command\\\\\\": \\\\\\"ODPS_SQL\\\\\\", \\\\\\"commandTypeId\\\\\\": 10 }, \\\\\\"content\\\\\\": \\\\\\"select now();\\\\\\", \\\\\\"id\\\\\\": \\\\\\"853573334108680XXXX\\\\\\" }, \\\\\\"trigger\\\\\\": { \\\\\\"type\\\\\\": \\\\\\"Scheduler\\\\\\", \\\\\\"id\\\\\\": \\\\\\"543680677872062XXXX\\\\\\", \\\\\\"cron\\\\\\": \\\\\\"00 00 00 * * ?\\\\\\", \\\\\\"startTime\\\\\\": \\\\\\"1970-01-01 00:00:00\\\\\\", \\\\\\"endTime\\\\\\": \\\\\\"9999-01-01 00:00:00\\\\\\", \\\\\\"timezone\\\\\\": \\\\\\"Asia/Shanghai\\\\\\", \\\\\\"delaySeconds\\\\\\": 0 }, \\\\\\"runtimeResource\\\\\\": { \\\\\\"resourceGroup\\\\\\": \\\\\\"S_res_group_XXXX_XXXX\\\\\\", \\\\\\"id\\\\\\": \\\\\\"623731286945488XXXX\\\\\\", \\\\\\"resourceGroupId\\\\\\": \\\\\\"7201XXXX\\\\\\" }, \\\\\\"name\\\\\\": \\\\\\"ODPS_SQL_Test\\\\\\", \\\\\\"owner\\\\\\": \\\\\\"110755000425XXXX\\\\\\", \\\\\\"metadata\\\\\\": { \\\\\\"owner\\\\\\": \\\\\\"110755000425XXXX\\\\\\", \\\\\\"ownerName\\\\\\": \\\\\\"[email protected]\\\\\\", \\\\\\"projectId\\\\\\": \\\\\\"307XXX\\\\\\" }, \\\\\\"inputs\\\\\\": { \\\\\\"nodeOutputs\\\\\\": [ { \\\\\\"data\\\\\\": \\\\\\"lwttest_standard_root\\\\\\", \\\\\\"artifactType\\\\\\": \\\\\\"NodeOutput\\\\\\" } ] }, \\\\\\"outputs\\\\\\": { \\\\\\"nodeOutputs\\\\\\": [ { \\\\\\"data\\\\\\": \\\\\\"860438872620113XXXX\\\\\\", \\\\\\"artifactType\\\\\\": \\\\\\"NodeOutput\\\\\\", \\\\\\"refTableName\\\\\\": \\\\\\"ODPS_SQL_Test\\\\\\", \\\\\\"isDefault\\\\\\": true } ] } } ], \\\\\\"flow\\\\\\": [ { \\\\\\"nodeId\\\\\\": \\\\\\"860438872620113XXXX\\\\\\", \\\\\\"depends\\\\\\": [ { \\\\\\"type\\\\\\": \\\\\\"Normal\\\\\\", \\\\\\"output\\\\\\": \\\\\\"lwttest_standard_root\\\\\\" } ] } ] }, \\\\\\"metadata\\\\\\": { \\\\\\"uuid\\\\\\": \\\\\\"860438872620113XXXX\\\\\\" } }\\",\\n \\"Id\\": \\"860438872620113XXXX\\"\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => '获取发布内容', + ], + 'CreateFile' => [ + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'abilityTreeCode' => '267402', + 'abilityTreeNodes' => [ + 'FEATUREdideHO4TQP', + 'FEATUREdide8FM783', + ], + ], + 'parameters' => [ + [ + 'name' => 'FileFolderPath', + 'in' => 'formData', + 'schema' => [ + 'description' => '文件路径。', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => 'Business_process/First_Business_Process/MaxCompute/Folder_1/Folder_2', + ], + ], + [ + 'name' => 'ProjectId', + 'in' => 'formData', + 'schema' => [ + 'description' => 'DataWorks工作空间的ID。您可以登录[DataWorks控制台](https://workbench.data.aliyun.com/console)，进入工作空间配置页面获取工作空间ID。'."\n" + .'该参数与ProjectIdentifier参数，二者必须设置其一，用来确定本次API调用操作的DataWorks工作空间。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'docRequired' => true, + 'example' => '10000', + ], + ], + [ + 'name' => 'FileName', + 'in' => 'formData', + 'schema' => [ + 'description' => '文件的'."\n" + .'名称。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'File name', + ], + ], + [ + 'name' => 'FileDescription', + 'in' => 'formData', + 'schema' => [ + 'description' => '文件的'."\n" + .'描述信息。', + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => 'test', + ], + ], + [ + 'name' => 'FileType', + 'in' => 'formData', + 'schema' => [ + 'description' => '文件的代码类型。'."\n" + .'不同文件类型其代码不同，详情请参见[DataWorks节点合集](~~600169~~)。'."\n" + .'您可以调用[ListFileType](~~212428~~)接口，查询文件的代码类型。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'docRequired' => true, + 'example' => '10', + ], + ], + [ + 'name' => 'Owner', + 'in' => 'formData', + 'schema' => [ + 'description' => '文件责任人的阿里云用户ID。如果该参数为空，'."\n" + .'则默认使用调用者的阿里云用户ID。', + 'type' => 'string', + 'required' => false, + 'example' => '1000000000001', + ], + ], + [ + 'name' => 'Content', + 'in' => 'formData', + 'schema' => [ + 'description' => '文件代码内容，不同代码类型（fileType）的文件，代码格式不同。'."\n" + .'您可以在运维中心找到对应类型的任务，右键单击查看代码，查看具体的代码格式。', + 'type' => 'string', + 'required' => false, + 'example' => 'SHOW TABLES;', + ], + ], + [ + 'name' => 'AutoRerunTimes', + 'in' => 'formData', + 'schema' => [ + 'description' => '出错自动重跑的次数，'."\n" + .'取值最大为10。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'docRequired' => false, + 'example' => '3', + ], + ], + [ + 'name' => 'AutoRerunIntervalMillis', + 'in' => 'formData', + 'schema' => [ + 'description' => '失败自动重跑时间间隔，单位为毫秒。'."\n" + .'最大为1800000毫秒（30分钟）。'."\n" + ."\n" + .'该参数与[DataWorks控制台](https://workbench.data.aliyun.com/console)中，数据开发任务的“调度配置>时间属性>失败自动重跑”的”重跑间隔“配置对应。'."\n" + .'控制台中“重跑间隔”的时间单位为分钟，请在调用时注意转换时间。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '120000', + ], + ], + [ + 'name' => 'RerunMode', + 'in' => 'formData', + 'schema' => [ + 'description' => '重跑属性。取值如下：'."\n" + .'- ALL_ALLOWED：运行成功或失败后皆可重跑。'."\n" + .'- FAILURE_ALLOWED：运行成功后不可重跑，运行失败后可以重跑。'."\n" + .'- ALL_DENIED：运行成功或失败皆不可重跑。'."\n" + ."\n" + .'该参数与[DataWorks控制台](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' => '是否暂停调度，取值如下：'."\n" + .'- true：暂停调度。'."\n" + .'- false：不暂停调度。'."\n" + ."\n\n" + .'该参数与[DataWorks控制台](https://workbench.data.aliyun.com/console)中，数据开发任务的“调度配置>时间属性>调度类型”配置为“暂停调度”时对应。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + 'default' => 'false', + ], + ], + [ + 'name' => 'ParaValue', + 'in' => 'formData', + 'schema' => [ + 'description' => '调度参数。多个参数之间用空格进行分割。 '."\n" + ."\n\n" + .'该参数与[DataWorks控制台](https://workbench.data.aliyun.com/console)中，数据开发任务的“调度配置>调度参数”对应。您可以参考[调度参数](~~137548~~)配置。', + 'type' => 'string', + 'required' => false, + 'example' => 'a=x b=y', + ], + ], + [ + 'name' => 'StartEffectDate', + 'in' => 'formData', + 'schema' => [ + 'description' => '开始自动调度的毫秒时间戳。'."\n" + ."\n\n" + .'该参数与[DataWorks控制台](https://workbench.data.aliyun.com/console)中，数据开发任务的“调度配置>时间属性>生效日期”配置的开始时间的毫秒时间戳对应。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'minimum' => '0', + 'example' => '1671608450000', + 'default' => '0', + ], + ], + [ + 'name' => 'EndEffectDate', + 'in' => 'formData', + 'schema' => [ + 'description' => '停止自动调度的时间戳，单位为毫秒。'."\n" + ."\n\n" + .'该参数与[DataWorks控制台](https://workbench.data.aliyun.com/console)中，数据开发任务的“调度配置>时间属性>生效日期”配置的结束时间的毫秒时间戳对应。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'minimum' => '0', + 'example' => '1671694850000', + ], + ], + [ + 'name' => 'CronExpress', + 'in' => 'formData', + 'schema' => [ + 'description' => '周期调度的cron表达式，该参数与[DataWorks控制台](https://workbench.data.aliyun.com/console)中，数据开发任务的“调度配置>时间属性>cron表达式”对应。配置完“调度周期”及“定时调度时间”后，DataWorks会自动生成相应cron表达式。'."\n" + ."\n\n" + .'示例如下：'."\n" + .'- 每天凌晨5点30分定时调度：`00 30 05 * * ?`'."\n" + ."\n" + .'- 每个小时的第15分钟定时调度：`00 15 00-23/1 * * ?`'."\n" + ."\n" + .'- 每隔十分钟调度一次：`00 00/10 * * * ?`'."\n" + ."\n" + .'- 每天8点到17点，每隔十分钟调度一次：`00 00-59/10 8-17 * * * ?`'."\n" + ."\n" + .'- 每月的1日0点20分自动调度：`00 20 00 1 * ?`'."\n" + ."\n" + .'- 从1月1日0点10分开始，每过3个月调度一次：`00 10 00 1 1-12/3 ?`'."\n" + ."\n" + .'- 每周二、周五的0点5分自动调度：`00 05 00 * * 2,5`'."\n" + ."\n" + .'由于DataWorks调度系统的规则，cron表达式有以下限制：'."\n" + ."\n" + .'- 最短调度间隔时间为5分钟。'."\n" + ."\n" + .'- 每天最早调度时间为0点5分。', + 'type' => 'string', + 'required' => false, + 'example' => '00 05 00 * * ?', + 'default' => 'day', + ], + ], + [ + 'name' => 'CycleType', + 'in' => 'formData', + 'schema' => [ + 'description' => '调度周期的类型，包括NOT_DAY（分钟、小时）和DAY（日、周、月）。'."\n" + ."\n\n" + .'该参数与[DataWorks控制台](https://workbench.data.aliyun.com/console)中，数据开发任务的“调度配置>时间属性>调度周期”对应。', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [], + 'example' => 'DAY', + 'default' => 'DAY', + 'enum' => [ + 'DAY', + 'NOT_DAY', + ], + ], + ], + [ + 'name' => 'DependentType', + 'in' => 'formData', + 'schema' => [ + 'description' => '依赖上一周期的方式。取值如下：'."\n" + ."\n" + .'- SELF：依赖项选择本节点。'."\n" + .'- CHILD：依赖项选择一级子节点。'."\n" + .'- USER_DEFINE：依赖项选择其他节点。'."\n" + .'- NONE：未选择依赖项，即不会依赖上一周期。 '."\n" + .'- USER\\_DEFINE\\_AND\\_SELF： 跨周期依赖本节点和其他节点的组合的情况'."\n" + .'- CHILD\\_AND\\_SELF：跨周期依赖一层子节点和本节点的组合的情况', + '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' => '当DependentType参数配置为USER_DEFINE时，用于设置当前文件具体依赖的节点ID。依赖多个节点时，使用英文逗号（,）分隔。'."\n" + ."\n\n" + .'该参数与[DataWorks控制台](https://workbench.data.aliyun.com/console)中，数据开发任务的“调度配置>调度依赖”配置为“跨周期依赖（原上一周期）”后，依赖项选择“其他节点”时配置的内容对应。', + 'type' => 'string', + 'required' => false, + 'example' => 'abc', + ], + ], + [ + 'name' => 'InputList', + 'in' => 'formData', + 'schema' => [ + 'description' => '文件依赖的上游文件的输出名称，多个输出使用英文逗号（,）分隔。'."\n" + ."\n\n" + .'该参数与[DataWorks控制台](https://workbench.data.aliyun.com/console)中，数据开发任务的“调度配置>调度依赖”中配置的“上游节点输出名”对应。', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => 'project_root,project.file1,project.001_out', + ], + ], + [ + 'name' => 'ProjectIdentifier', + 'in' => 'formData', + 'schema' => [ + 'description' => 'DataWorks工作空间的名称。您可以登录[DataWorks控制台](https://workbench.data.aliyun.com/console)，进入工作空间配置页面获取工作空间名称。'."\n" + ."\n\n" + .'该参数与ProjectId参数，二者必须设置其一，用来确定本次API调用操作的DataWorks工作空间。', + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => 'dw_project', + ], + ], + [ + 'name' => 'ResourceGroupIdentifier', + 'in' => 'formData', + 'schema' => [ + 'description' => '文件发布成任务后，任务执行时对应的资源组。您可以登录[DataWorks控制台](https://workbench.data.aliyun.com/console)，'."\n" + .'进入工作空间配置页面，在左侧导航栏单击**资源组**，获取当前工作空间已绑定资源组的ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'S_res_group_559_1613715566828', + ], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'formData', + 'schema' => [ + 'description' => '该字段已废弃，请勿使用。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '375827434852437', + ], + ], + [ + 'name' => 'ConnectionName', + 'in' => 'formData', + 'schema' => [ + 'description' => '文件发布成任务后，任务执行时连接的数据源。'."\n" + ."\n" + .'您可以调用[UpdateDataSource](~~211432~~)接口获取工作空间可用的数据源列表。', + 'type' => 'string', + 'required' => false, + 'example' => 'odps_source', + ], + ], + [ + 'name' => 'AutoParsing', + 'in' => 'formData', + 'schema' => [ + 'description' => '文件是否开启自动解析功能。取值如下：'."\n" + .'- true：文件会自动解析代码。'."\n" + .'- false：文件不会自动解析代码。'."\n" + ."\n\n" + .'该参数与[DataWorks控制台](https://workbench.data.aliyun.com/console)中，数据开发任务的“调度配置>调度依赖”的代码解析对应。', + 'type' => 'boolean', + 'required' => false, + 'docRequired' => false, + 'example' => 'true', + 'default' => 'true', + ], + ], + [ + 'name' => 'SchedulerType', + 'in' => 'formData', + 'schema' => [ + 'description' => '调度的类型，取值如下：'."\n" + ."\n" + .'- NORMAL：正常调度任务。'."\n" + .'- MANUAL：手动任务，不会被日常调度，对应手动业务流程下的节点。'."\n" + .'- PAUSE：暂停任务。'."\n" + .'- SKIP：空跑任务，被日常调度，但启动调度时直接被置为成功。', + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'enumValueTitles' => [], + 'example' => 'NORMAL', + 'enum' => [ + 'NORMAL', + 'MANUAL', + 'PAUSE', + 'SKIP', + ], + ], + ], + [ + 'name' => 'AdvancedSettings', + 'in' => 'formData', + 'schema' => [ + 'description' => '任务的高级配置。'."\n" + ."\n\n" + .'该参数与[DataWorks控制台](https://workbench.data.aliyun.com/console)中，EMR Spark Streaming和EMR Streaming SQL数据开发任务，编辑页面右侧导航栏的“高级设置”对应。'."\n" + ."\n" + .'当前仅EMR Spark Streaming和EMR Streaming SQL任务支持配置该参数，并且参数为JSON格式。', + 'type' => 'string', + 'required' => false, + 'example' => '{"queue":"default","SPARK_CONF":"--conf spark.driver.memory=2g"}', + ], + ], + [ + 'name' => 'StartImmediately', + 'in' => 'formData', + 'schema' => [ + 'description' => '发布后是否立即启动。'."\n" + ."\n\n" + .'该参数与[DataWorks控制台](https://workbench.data.aliyun.com/console)中，EMR Spark Streaming和EMR Streaming SQL数据开发任务，编辑页面右侧导航栏的“配置>时间属性>启动方式”对应。', + 'type' => 'boolean', + 'required' => false, + 'docRequired' => false, + 'example' => 'true', + 'default' => 'false', + ], + ], + [ + 'name' => 'InputParameters', + 'in' => 'formData', + 'schema' => [ + 'description' => '节点的上下文输入参数。参数为JSON格式，包含的字段可参考[GetFile](~~173954~~)接口返回值中的InputContextParameterList参数结构。'."\n" + ."\n\n" + .'该参数与[DataWorks控制台](https://workbench.data.aliyun.com/console)中，数据开发任务的“调度配置>节点上下文参数>本节点输入参数”对应。', + 'type' => 'string', + 'required' => false, + 'example' => '[{"ValueSource": "project_001.first_node:bizdate_param","ParameterName": "bizdate_input"}]', + ], + ], + [ + 'name' => 'OutputParameters', + 'in' => 'formData', + 'schema' => [ + 'description' => '节点的上下文输出参数。参数为JSON格式，包含的字段可参考[GetFile](~~173954~~)接口返回值中的OutputContextParameterList参数结构。'."\n" + ."\n\n" + .'该参数与[DataWorks控制台](https://workbench.data.aliyun.com/console)中，数据开发任务的“调度配置>节点上下文参数>本节点输出参数”对应。', + 'type' => 'string', + 'required' => false, + 'example' => '[{"Type": 1,"Value": "${bizdate}","ParameterName": "bizdate_param"}]', + ], + ], + [ + 'name' => 'IgnoreParentSkipRunningProperty', + 'in' => 'formData', + 'schema' => [ + 'description' => '是否沿用上一周期空跑属性。取值如下：'."\n" + ."\n\n" + .'- true：沿用上一周期空跑属性。'."\n" + ."\n" + .'- false：不沿用上一周期空跑属性。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + [ + 'name' => 'CreateFolderIfNotExists', + 'in' => 'formData', + 'schema' => [ + 'description' => '当参数中指定的目录（FileFolderPath）在系统中不存在时，是否自动创建此目录。取值如下：'."\n" + ."\n\n" + .'- true：若此目录不存在，自动创建此目录'."\n" + .'- false：若此目录不存在，调用失败', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + [ + 'name' => 'ApplyScheduleImmediately', + 'in' => 'formData', + 'schema' => [ + 'description' => '是否发布后立即生效调度配置。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'Timeout', + 'in' => 'formData', + 'schema' => [ + 'description' => '调度配置超时定义。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'ImageId', + 'in' => 'formData', + 'schema' => [ + 'description' => '自定义镜像ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'm-bp1h4b5a8ogkbll2f3tr', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => [ + 'description' => 'HTTP状态码'."\n" + .'。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Data' => [ + 'description' => '文件创建成功后的ID'."\n" + .'。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1000001', + ], + 'RequestId' => [ + 'description' => '本次调用的唯一ID。'."\n" + .'出现错误后，您可以根据该ID排查问题。', + 'type' => 'string', + 'example' => '0000-ABCD-EFG', + ], + 'ErrorMessage' => [ + 'description' => '错误消息'."\n" + .'。', + 'type' => 'string', + 'example' => 'The connection does not exist.', + ], + 'Success' => [ + 'description' => '调用是否成功。取值如下：'."\n" + ."\n" + .'- true：调用成功。'."\n" + .'- false：调用失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'ErrorCode' => [ + 'description' => '错误码'."\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' => '[{"errorExample":"","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}","type":"json"}]', + 'title' => '在数据开发中创建一个文件', + 'summary' => '调用CreateFile，在数据开发中创建一个文件。目前不支持调用该接口创建数据集成节点任务。', + ], + 'CreateResourceFile' => [ + 'summary' => '支持用户指定自己的文件（比如jar，py，arhive，file等）创建数据开发资源文件。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'abilityTreeCode' => '269305', + 'abilityTreeNodes' => [ + 'FEATUREdide8FM783', + 'FEATUREdideJ3TPTK', + ], + ], + 'parameters' => [ + [ + 'name' => 'ProjectId', + 'in' => 'formData', + 'schema' => [ + 'description' => 'DataWorks工作空间的ID。您可以登录DataWorks控制台，进入工作空间配置页面获取工作空间ID。需要用该参数来确定本次API调用操作的DataWorks工作空间。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + 'minimum' => '0', + 'example' => '10000', + ], + ], + [ + 'name' => 'FileFolderPath', + 'in' => 'formData', + 'schema' => [ + 'description' => '文件的路径。'."\n" + ."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'Business_process/First_Business_Process/MaxCompute/Folder_1/Folder_2', + ], + ], + [ + 'name' => 'FileName', + 'in' => 'formData', + 'schema' => [ + 'description' => '文件的名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'Filename', + ], + ], + [ + 'name' => 'FileType', + 'in' => 'formData', + 'schema' => [ + 'description' => '文件的代码类型。'."\n" + ."\n" + .'不同文件类型其代码不同，详情请参见[DataWorks节点合集](~~600169~~)。'."\n" + .'您也可以调用[ListFileType](~~212428~~)接口，查询文件的代码类型。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'docRequired' => true, + 'minimum' => '0', + 'example' => '10', + ], + ], + [ + 'name' => 'FileDescription', + 'in' => 'formData', + 'schema' => [ + 'description' => '文件的描述信息。', + 'type' => 'string', + 'required' => false, + 'example' => 'This is a description', + ], + ], + [ + 'name' => 'Owner', + 'in' => 'formData', + 'schema' => [ + 'description' => '文件责任人的阿里云用户ID。如果该参数为空，则默认使用调用者的阿里云用户ID。', + 'type' => 'string', + 'required' => false, + 'example' => '1000000000001', + ], + ], + [ + 'name' => 'Content', + 'in' => 'formData', + 'schema' => [ + 'description' => '文件代码内容，不同代码类型（fileType）的文件，代码格式不同。您可以在运维中心找到对应类型的任务，右键单击查看代码，查看具体的代码格式。', + 'type' => 'string', + 'required' => false, + 'example' => 'SHOW TABLES;', + ], + ], + [ + 'name' => 'ResourceFile', + 'in' => 'formData', + 'schema' => [ + 'description' => 'POP提供的文件上传OSS URL。', + 'type' => 'string', + 'required' => false, + 'example' => 'http://bucketname1.oss-cn-shanghai.aliyuncs.com/example', + 'isFileTransferUrl' => true, + ], + ], + [ + 'name' => 'OriginResourceName', + 'in' => 'formData', + 'schema' => [ + 'description' => '原始资源文件的名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'origin_file_name.sql', + ], + ], + [ + 'name' => 'UploadMode', + 'in' => 'formData', + 'schema' => [ + 'description' => '文件资源上传模式。目前仅对MaxCompute的File类型文件生效，取值如下：'."\n" + ."\n" + .'- true：可下载的资源模式。'."\n" + ."\n" + .'- false：在线编辑的文本模式。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + [ + 'name' => 'RegisterToCalcEngine', + 'in' => 'formData', + 'schema' => [ + 'description' => '是否将资源同步上传到计算引擎。', + 'type' => 'boolean', + 'required' => true, + 'example' => 'false', + ], + ], + [ + 'name' => 'StorageURL', + 'in' => 'formData', + 'schema' => [ + 'description' => '资源文件在计算引擎上的存储路径，目前只有EMR和CDH用到该字段。EMR格式为[osshdfs]://path/to/object，CDH默认需要填写为/user/admin/lib。', + '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' => '文件创建成功后的ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1000001', + ], + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '本次调用的唯一ID。出现错误后，您可以根据该ID排查问题。', + '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' => '[{"errorExample":"","example":"{\\n \\"Data\\": 1000001,\\n \\"RequestId\\": \\"0000-ABCD-EFG\\"\\n}","type":"json"}]', + 'title' => '创建资源文件', + ], + 'CreateUdfFile' => [ + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'abilityTreeCode' => '269313', + 'abilityTreeNodes' => [ + 'FEATUREdide8FM783', + ], + ], + 'parameters' => [ + [ + 'name' => 'FileFolderPath', + 'in' => 'formData', + 'schema' => [ + 'description' => '函数文件所在的文件夹路径'."\n" + .'。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'Business_process/First_Business_Process/function/string_processing', + ], + ], + [ + 'name' => 'ProjectId', + 'in' => 'formData', + 'schema' => [ + 'description' => 'DataWorks工作空间的ID，'."\n" + .'您可以单击页面右上角的小扳手图标，进入工作空间管理页面查看。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'docRequired' => false, + 'example' => '10000', + ], + ], + [ + 'name' => 'FileName', + 'in' => 'formData', + 'schema' => [ + 'description' => '函数的名称'."\n" + .'。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'StringConcat', + ], + ], + [ + 'name' => 'FunctionType', + 'in' => 'formData', + 'schema' => [ + 'description' => '函数的分类，对应创建函数表单中的函数类型一项，'."\n" + .'包括MATH（数学运算函数）、AGGREGATE（聚合函数）、STRING（字符串处理函数）、DATE（日期处理函数）、ANALYTIC（窗口函数）和OTHER（其他函数）。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'STRING', + 'enum' => [ + 'MATH', + 'AGGREGATE', + 'STRING', + 'DATE', + 'ANALYTIC', + 'OTHER', + ], + ], + ], + [ + 'name' => 'ClassName', + 'in' => 'formData', + 'schema' => [ + 'description' => '函数定义所在的类名，'."\n" + .'对应创建函数表单的类名一项。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'com.alibaba.DataWorks.api.udf.StringConcat', + ], + ], + [ + 'name' => 'Resources', + 'in' => 'formData', + 'schema' => [ + 'description' => '函数引用的资源名列表，对应创建表中的资源列表。'."\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' => '函数用途的说明，'."\n" + .'对应创建函数表单中的描述。', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => 'Concatenate several strings to generate a new string', + ], + ], + [ + 'name' => 'CmdDescription', + 'in' => 'formData', + 'schema' => [ + 'description' => '函数调用的命令格式，'."\n" + .'对应创建函数表单中的命令格式。', + 'type' => 'string', + 'required' => false, + 'example' => 'StringConcat(String... substrs)', + ], + ], + [ + 'name' => 'ParameterDescription', + 'in' => 'formData', + 'schema' => [ + 'description' => '函数入参的说明，'."\n" + .'对应创建函数表单中的参数说明。', + 'type' => 'string', + 'required' => false, + 'example' => 'List of strings to be connected', + 'default' => '', + ], + ], + [ + 'name' => 'ReturnValue', + 'in' => 'formData', + 'schema' => [ + 'description' => '函数的返回值说明，'."\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' => '函数调用示例，'."\n" + .'对应创建函数表单中的示例。', + 'type' => 'string', + 'required' => false, + 'example' => 'StringConcat(\'a\', \'b\', \'c\')', + ], + ], + [ + 'name' => 'ProjectIdentifier', + 'in' => 'formData', + 'schema' => [ + 'description' => 'DataWorks工作空间的唯一标识符，'."\n" + .'即数据开发页面顶部切换工作空间处的英文标识。', + 'type' => 'string', + 'required' => false, + 'example' => 'dw_project', + ], + ], + [ + 'name' => 'CreateFolderIfNotExists', + 'in' => 'formData', + 'schema' => [ + 'description' => '当参数中指定的目录（FileFolderPath）在系统中不存在时，'."\n" + .'是否自动创建此目录。取值如下：'."\n" + ."\n" + .'- true：若此目录不存在，自动创建此目录'."\n" + ."\n" + .'- false：若此目录不存在，调用失败', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回结果'."\n" + .'。', + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => [ + 'description' => 'HTTP状态码'."\n" + .'。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Data' => [ + 'description' => '文件创建成功后的ID'."\n" + .'。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '100000002', + ], + 'RequestId' => [ + 'description' => '本次调用的唯一ID。出现错误后，您可以根据该ID排查问题'."\n" + .'。', + 'type' => 'string', + 'example' => '0000-ABCD-EFG****', + ], + 'ErrorMessage' => [ + 'description' => '错误信息'."\n" + .'。', + 'type' => 'string', + 'example' => 'The connection does not exist.', + ], + 'Success' => [ + 'description' => '调用是否成功'."\n" + .'。'."\n" + .'- true：成功。'."\n" + .'- false：失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'ErrorCode' => [ + 'description' => '错误码'."\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' => '[{"errorExample":"","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}","type":"json"}]', + 'title' => '在数据开发中创建函数类型文件', + 'summary' => '调用CreateUdfFile，在数据开发中创建函数类型文件。', + ], + 'DeleteFile' => [ + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'abilityTreeCode' => '268111', + 'abilityTreeNodes' => [ + 'FEATUREdide8FM783', + ], + ], + 'parameters' => [ + [ + 'name' => 'ProjectId', + 'in' => 'formData', + 'schema' => [ + 'description' => 'DataWorks工作空间的ID。您可以登录[DataWorks控制台](https://workbench.data.aliyun.com/console)，进入工作空间配置页面获取工作空间ID。'."\n" + ."\n\n" + .'该参数与ProjectIdentifier参数，二者必须设置其一，用来确定本次API调用操作的DataWorks工作空间。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'docRequired' => false, + 'example' => '10000', + ], + ], + [ + 'name' => 'ProjectIdentifier', + 'in' => 'formData', + 'schema' => [ + 'description' => 'DataWorks工作空间的名称。您可以登录[DataWorks控制台](https://workbench.data.aliyun.com/console)，进入工作空间配置页面获取工作空间名称。'."\n" + ."\n\n" + .'该参数与ProjectId参数，二者必须设置其一，用来确定本次API调用操作的DataWorks工作空间。', + 'type' => 'string', + 'required' => false, + 'example' => 'dw_project', + ], + ], + [ + 'name' => 'FileId', + 'in' => 'formData', + 'schema' => [ + 'description' => '文件的ID，'."\n" + .'您可以使用[ListFiles](~~173942~~)接口查询对应文件的ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + 'example' => '10000201', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回结果'."\n" + .'。', + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => [ + 'description' => 'HTTP状态码'."\n" + .'。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'DeploymentId' => [ + 'description' => '如果文件已经提交过，那么DeleteFile接口会同时触发一个异步在调度系统删除的流程，需要用DeleteFile接口返回的DeploymentId继续调用GetDeployment轮询被触发的异步删除流程的状态。'."\n" + ."\n\n" + .'如果该字段为空，则说明文件已经删除完毕，无需继续轮询。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1000000001', + ], + 'RequestId' => [ + 'description' => '请求ID。用于出现错误后排查问题'."\n" + .'。', + 'type' => 'string', + 'example' => '0000-ABCD-EFG****', + ], + 'ErrorMessage' => [ + 'description' => '错误信息'."\n" + .'。', + 'type' => 'string', + 'example' => 'The connection does not exist.', + ], + 'Success' => [ + 'description' => '调用是否成功。取值如下：'."\n" + ."\n" + .'- true：调用成功。'."\n" + .'- false：调用失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'ErrorCode' => [ + 'description' => '错误码'."\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.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]', + 'title' => '删除数据开发中的文件', + 'summary' => '调用DeleteFile删除数据开发中的文件。如果文件已经提交过，那么DeleteFile API会同时触发一个异步在调度系统删除的流程，需要用DeleteFile API返回的DeploymentId继续调用GetDeployment轮询被触发的异步删除流程的状态。', + ], + 'UpdateFile' => [ + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '268116', + 'abilityTreeNodes' => [ + 'FEATUREdide8FM783', + ], + ], + 'parameters' => [ + [ + 'name' => 'FileFolderPath', + 'in' => 'formData', + 'schema' => [ + 'description' => '文件所在的路径'."\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' => 'DataWorks工作空间的ID。'."\n" + .'您可以登录[DataWorks控制台](https://workbench.data.aliyun.com/console)，进入工作空间管理页面获取ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'docRequired' => false, + 'example' => '100001', + ], + ], + [ + 'name' => 'FileName', + 'in' => 'formData', + 'schema' => [ + 'description' => '文件的名称。'."\n" + .'您可以通过重新设置FileName的值来修改文件名称。'."\n" + .'例如，使用[ListFiles](~~173942~~)接口查询目标目录下的文件ID，通过[UpdateFile](~~173951~~)接口，输入查询的文件ID至FileId参数，并配置FileName的参数值，即可修改相应文件的名称。', + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => 'ods_user_info_d', + ], + ], + [ + 'name' => 'FileDescription', + 'in' => 'formData', + 'schema' => [ + 'description' => '文件的描述'."\n" + .'。', + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => 'Here is the file description', + ], + ], + [ + 'name' => 'Content', + 'in' => 'formData', + 'schema' => [ + 'description' => '文件代码内容，不同代码类型（fileType）的文件，代码格式不同。'."\n" + .'您可以在运维中心，右键单击对应类型的任务，选择查看代码，查看具体的代码格式。', + 'type' => 'string', + 'required' => false, + 'example' => 'SELECT "1";', + ], + ], + [ + 'name' => 'AutoRerunTimes', + 'in' => 'formData', + 'schema' => [ + 'description' => '文件出错后，'."\n" + .'自动重跑的次数。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'docRequired' => true, + 'example' => '3', + ], + ], + [ + 'name' => 'AutoRerunIntervalMillis', + 'in' => 'formData', + 'schema' => [ + 'description' => '失败自动重跑时间间隔，单位为毫秒。最大为1800000毫秒（30分钟）。'."\n" + ."\n\n" + .'该参数与[DataWorks控制台](https://workbench.data.aliyun.com/console)中，数据开发任务的“调度配置>时间属性>失败自动重跑”的”重跑间隔“配置对应。'."\n" + .'控制台中“重跑间隔”的时间单位为分钟，请在调用时注意转换时间。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '120000', + ], + ], + [ + 'name' => 'RerunMode', + 'in' => 'formData', + 'schema' => [ + 'description' => '重跑属性。取值如下：'."\n" + ."\n" + .'- ALL_ALLOWED：运行成功或失败后皆可重跑。'."\n" + .'- FAILURE_ALLOWED：运行成功后不可重跑，运行失败后可以重跑。'."\n" + .'- ALL_DENIED：运行成功或失败皆不可重跑。'."\n" + ."\n" + .'该参数与[DataWorks控制台](https://workbench.data.aliyun.com/console)中，数据开发任务的“调度配置>时间属性>重跑属性”配置内容对应。', + 'type' => 'string', + 'required' => false, + 'example' => 'ALL_ALLOWED', + 'enum' => [ + 'ALL_ALLOWD', + 'FAILURE_ALLOWED', + 'ALL_DENIED', + 'ALL_ALLOWED', + ], + ], + ], + [ + 'name' => 'Stop', + 'in' => 'formData', + 'schema' => [ + 'description' => '是否暂停调度，取值如下：'."\n" + ."\n" + .'- true：暂停调度。'."\n" + .'- false：不暂停调度。'."\n" + ."\n" + .'该参数与[DataWorks控制台](https://workbench.data.aliyun.com/console)中，数据开发任务的“调度配置>时间属性>调度类型”配置为“暂停调度”时对应。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + [ + 'name' => 'ParaValue', + 'in' => 'formData', + 'schema' => [ + 'description' => '调度参数。'."\n" + ."\n\n" + .'该参数与[DataWorks控制台](https://workbench.data.aliyun.com/console)中，数据开发任务的“调度配置>调度参数”对应。您可以参考[调度参数](~~137548~~)配置。', + 'type' => 'string', + 'required' => false, + 'example' => 'x=a y=b z=c', + ], + ], + [ + 'name' => 'StartEffectDate', + 'in' => 'formData', + 'schema' => [ + 'description' => '开始自动调度的毫秒时间戳。'."\n" + ."\n\n" + .'该参数与[DataWorks控制台](https://workbench.data.aliyun.com/console)中，数据开发任务的“调度配置>时间属性>生效日期”配置的开始时间的毫秒时间戳对应。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'minimum' => '0', + 'example' => '936923400000', + ], + ], + [ + 'name' => 'EndEffectDate', + 'in' => 'formData', + 'schema' => [ + 'description' => '停止自动调度的时间戳，单位为毫秒。'."\n" + ."\n\n" + .'该参数与[DataWorks控制台](https://workbench.data.aliyun.com/console)中，数据开发任务的“调度配置>时间属性>生效日期”配置的结束时间的毫秒时间戳对应。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'minimum' => '0', + 'example' => '4155787800000', + ], + ], + [ + 'name' => 'CronExpress', + 'in' => 'formData', + 'schema' => [ + 'description' => '周期调度的cron表达式，该参数与[DataWorks控制台](https://workbench.data.aliyun.com/console)中，数据开发任务的“调度配置>时间属性>cron表达式”对应。配置完“调度周期”及“定时调度时间”后，DataWorks会自动生成相应cron表达式。'."\n" + ."\n\n" + .'示例如下：'."\n" + ."\n" + .'- 每天凌晨5点30分定时调度：`00 30 05 * * ?`。'."\n" + ."\n" + .'- 每个小时的第15分钟定时调度：`00 15 * * * ?`。'."\n" + ."\n" + .'- 每隔十分钟调度一次：`00 00/10 * * * ?`。'."\n" + ."\n" + .'- 每天8点到17点，每个十分钟调度一次：`00 00-59/10 8-23 * * * ?`。'."\n" + ."\n" + .'- 每月的1日0点20分自动调度：`00 20 00 1 * ?`。'."\n" + ."\n" + .'- 从1月1日0点10分开始，每过3个月调度一次：`00 10 00 1 1-12/3 ?`。'."\n" + ."\n" + .'- 每周二、周五的0点5分自动调度：`00 05 00 * * 2,5`。'."\n" + ."\n\n" + .'由于DataWorks调度系统的规则，cron表达式有以下限制：'."\n" + ."\n" + .'- 最短调度间隔时间为5分钟。'."\n" + ."\n" + .'- 每天最早调度时间为0点5分。', + 'type' => 'string', + 'required' => false, + 'example' => '00 00-59/5 1-23 * * ?', + ], + ], + [ + 'name' => 'CycleType', + 'in' => 'formData', + 'schema' => [ + 'description' => '调度周期的类型，包括NOT_DAY（分钟、小时）和DAY（日、周、月）。'."\n" + ."\n\n" + .'该参数与[DataWorks控制台](https://workbench.data.aliyun.com/console)中，数据开发任务的“调度配置>时间属性>调度周期”对应。', + 'type' => 'string', + 'required' => false, + 'example' => 'NOT_DAY', + 'default' => 'DAY', + 'enum' => [ + 'DAY', + 'NOT_DAY', + ], + ], + ], + [ + 'name' => 'DependentType', + 'in' => 'formData', + 'schema' => [ + 'description' => '依赖上一周期的方式。取值如下：'."\n" + ."\n" + .'- SELF：依赖项选择本节点。'."\n" + .'- CHILD：依赖项选择一级子节点。'."\n" + .'- USER_DEFINE：依赖项选择其他节点。'."\n" + .'- NONE：未选择依赖项，即不会依赖上一周期。', + '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' => '当DependentType参数配置为USER_DEFINE时，用于设置当前文件具体依赖的节点ID。依赖多个节点时，使用英文逗号（,）分隔。'."\n" + ."\n\n" + .'该参数与[DataWorks控制台](https://workbench.data.aliyun.com/console)中，数据开发任务的“调度配置>调度依赖”配置为“跨周期依赖（原上一周期）”后，依赖项选择“其他节点”时配置的内容对应。', + 'type' => 'string', + 'required' => false, + 'example' => '5,10,15,20', + ], + ], + [ + 'name' => 'InputList', + 'in' => 'formData', + 'schema' => [ + 'description' => '文件依赖的上游文件的输出名称。依赖多个输出时，使用英文逗号（,）分隔。'."\n" + ."\n\n" + .'该参数与[DataWorks控制台](https://workbench.data.aliyun.com/console)中，数据开发任务的“调度配置>调度依赖”中配置的“上游节点输出名”对应。'."\n" + ."\n" + .'> 通过CreateDISyncTask和UpdateFile方式创建离线同步任务时此参数必须配置。', + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => 'project_root,project.file1,project.001_out', + ], + ], + [ + 'name' => 'ProjectIdentifier', + 'in' => 'formData', + 'schema' => [ + 'description' => 'DataWorks工作空间的名称。您可以登录[DataWorks控制台](https://workbench.data.aliyun.com/console)，进入工作空间配置页面获取工作空间名称。'."\n" + ."\n\n" + .'该参数与ProjectId参数，二者必须设置其一，用来确定本次API调用操作的DataWorks工作空间。', + 'type' => 'string', + 'required' => false, + 'example' => 'dw_project', + ], + ], + [ + 'name' => 'FileId', + 'in' => 'formData', + 'schema' => [ + 'description' => '文件的ID。'."\n" + .'您可以调用[ListFiles](~~173942~~)接口获取文件ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + 'example' => '100000001', + ], + ], + [ + 'name' => 'OutputList', + 'in' => 'formData', + 'schema' => [ + 'description' => '文件的输出。'."\n" + ."\n\n" + .'该参数与[DataWorks控制台](https://workbench.data.aliyun.com/console)中，数据开发任务的“调度配置>调度依赖”中配置的“本节点的输出名称”对应。', + 'type' => 'string', + 'required' => false, + 'example' => 'dw_project.ods_user_info_d', + ], + ], + [ + 'name' => 'ResourceGroupIdentifier', + 'in' => 'formData', + 'schema' => [ + 'description' => '文件发布成任务后，任务执行时对应的资源组。'."\n" + .'您可以调用[ListResourceGroups](~~173913~~)获取工作空间可用的资源组列表。', + 'type' => 'string', + 'required' => false, + 'example' => 'default_group', + ], + ], + [ + 'name' => 'ConnectionName', + 'in' => 'formData', + 'schema' => [ + 'description' => '文件对应任务执行时，任务使用的数据源标识符。'."\n" + .'您可以调用[ListDataSources](~~211431~~)获取可用的数据源列表。', + 'type' => 'string', + 'required' => false, + 'example' => 'odps_source', + ], + ], + [ + 'name' => 'Owner', + 'in' => 'formData', + 'schema' => [ + 'description' => '文件所有者的用户'."\n" + .'ID。', + 'type' => 'string', + 'required' => false, + 'example' => '18023848927592', + ], + ], + [ + 'name' => 'AutoParsing', + 'in' => 'formData', + 'schema' => [ + 'description' => '文件是否开启自动解析功能。'."\n" + .'取值如下：'."\n" + .'- true：文件会自动解析代码。'."\n" + .'- false：文件不会自动解析代码。'."\n" + ."\n" + .'该参数与[DataWorks控制台](https://workbench.data.aliyun.com/console)中，数据开发任务的“调度配置>调度依赖”的代码解析对应。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'SchedulerType', + 'in' => 'formData', + 'schema' => [ + 'description' => '调度的类型，取值如下：'."\n" + ."\n" + .'- NORMAL：正常调度任务。'."\n" + .'- MANUAL：手动任务，不会被日常调度，对应手动业务流程下的节点。'."\n" + .'- PAUSE：暂停任务。'."\n" + .'- SKIP：空跑任务，被日常调度，但启动调度时直接被置为成功。', + 'type' => 'string', + 'required' => false, + 'example' => 'NORMAL', + 'enum' => [ + 'NORMAL', + 'SKIP', + 'PAUSE', + 'MANUAL', + ], + ], + ], + [ + 'name' => 'AdvancedSettings', + 'in' => 'formData', + 'schema' => [ + 'description' => '任务的高级配置。'."\n" + ."\n\n" + .'该参数与[DataWorks控制台](https://workbench.data.aliyun.com/console)中，EMR Spark Streaming和EMR Streaming SQL数据开发任务，编辑页面右侧导航栏的“高级设置“对应。'."\n" + ."\n" + .'当前仅EMR Spark Streaming和EMR Streaming SQL任务支持配置该参数，并且参数为JSON格式。', + 'type' => 'string', + 'required' => false, + 'example' => '{"queue":"default","SPARK_CONF":"--conf spark.driver.memory=2g"}', + ], + ], + [ + 'name' => 'StartImmediately', + 'in' => 'formData', + 'schema' => [ + 'description' => '发布后是否立即启动。取值如下：'."\n" + ."\n" + .'- true：发布后立即启动。'."\n" + .'- false：发布后暂不启动。'."\n" + ."\n" + .'该参数与[DataWorks控制台](https://workbench.data.aliyun.com/console)中，EMR Spark Streaming和EMR Streaming SQL数据开发任务，编辑页面右侧导航栏的“配置>时间属性>启动方式“对应。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'InputParameters', + 'in' => 'formData', + 'schema' => [ + 'description' => '节点的上下文输入参数。参数为JSON格式，包含的字段可参考[GetFile](~~173954~~)接口返回值中的InputContextParameterList参数结构。'."\n" + ."\n\n" + .'该参数与[DataWorks控制台](https://workbench.data.aliyun.com/console)中，数据开发任务的“调度配置>节点上下文参数>本节点输入参数“对应。', + 'type' => 'string', + 'required' => false, + 'example' => '[{"ValueSource": "project_001.first_node:bizdate_param","ParameterName": "bizdate_input"}]', + ], + ], + [ + 'name' => 'OutputParameters', + 'in' => 'formData', + 'schema' => [ + 'description' => '节点的上下文输出参数。'."\n" + .'参数为JSON格式，包含的字段可参考[GetFile](~~173954~~)接口返回值中的OutputContextParameterList参数结构。'."\n" + ."\n" + .'该参数与[DataWorks控制台](https://workbench.data.aliyun.com/console)中，数据开发任务的“调度配置>节点上下文参数>本节点输出参数”对应。', + 'type' => 'string', + 'required' => false, + 'example' => '[{"Type": 1,"Value": "${bizdate}","ParameterName": "bizdate_param"}]', + ], + ], + [ + 'name' => 'IgnoreParentSkipRunningProperty', + 'in' => 'formData', + 'schema' => [ + 'description' => '该参数与[DataWorks控制台](https://workbench.data.aliyun.com/console)中，数据开发任务的“调度配置>调度依赖”配置为“跨周期依赖（原上一周期）”后，依赖项选择“本节点”或“一级子节点”时配置的“跳过上游的空跑属性”对应。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'ApplyScheduleImmediately', + 'in' => 'formData', + 'schema' => [ + 'description' => '是否发布后立即生效调度配置'."\n" + .'。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'Timeout', + 'in' => 'formData', + 'schema' => [ + 'description' => '调度配置超时定义'."\n" + .'。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'ImageId', + 'in' => 'formData', + 'schema' => [ + 'description' => '自定义镜像ID'."\n" + .'。', + 'type' => 'string', + 'required' => false, + 'example' => 'm-uf6d7npxk1hhek8ng0cb', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回结果'."\n" + .'。', + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => [ + 'description' => 'HTTP状态码'."\n" + .'。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'ErrorMessage' => [ + 'description' => '错误信息'."\n" + .'。', + 'type' => 'string', + 'example' => 'The connection does not exist.', + ], + 'RequestId' => [ + 'description' => '本次调用的唯一ID。出现错误后，您可以根据该ID排查问题'."\n" + .'。', + 'type' => 'string', + 'example' => '0000-ABCD-EFGH-IJKLMNOPQ', + ], + 'ErrorCode' => [ + 'description' => '错误码'."\n" + .'。', + 'type' => 'string', + 'example' => 'Invalid.Tenant.ConnectionNotExists', + ], + 'Success' => [ + 'description' => '调用是否成功。取值如下：'."\n" + ."\n" + .'- true：调用成功。'."\n" + .'- false：调用失败。', + '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.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]', + 'title' => '更新已有的文件节点', + 'summary' => '调用UpdateFile更新已创建的文件。', + ], + 'UpdateUdfFile' => [ + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '269316', + 'abilityTreeNodes' => [ + 'FEATUREdide8FM783', + ], + ], + 'parameters' => [ + [ + 'name' => 'FileFolderPath', + 'in' => 'formData', + 'schema' => [ + 'description' => '函数文件所在文件夹的路径'."\n" + .'。', + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => 'Business_process/First_Business_Process/function/string_processing_function', + ], + ], + [ + 'name' => 'ProjectId', + 'in' => 'formData', + 'schema' => [ + 'description' => 'DataWorks工作空间的ID，'."\n" + .'您可以单击页面右上角的小扳手图标，进入工作空间管理页面查看。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'docRequired' => false, + 'example' => '10000', + ], + ], + [ + 'name' => 'FunctionType', + 'in' => 'formData', + 'schema' => [ + 'description' => '函数的分类，'."\n" + .'对应创建函数表单中的函数类型，包括MATH（数学运算函数）、AGGREGATE（聚合函数）、STRING（字符串处理函数）、DATE（日期处理函数）、ANALYTIC（窗口函数）和OTHER（其他函数）。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'STRING', + 'enum' => [ + 'MATH', + 'AGGREGATE', + 'STRING', + 'DATE', + 'ANALYTIC', + 'OTHER', + ], + ], + ], + [ + 'name' => 'ClassName', + 'in' => 'formData', + 'schema' => [ + 'description' => '函数定义所在的类名，'."\n" + .'对应创建函数表单的类名。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'com.alibaba.DataWorks.api.udf.StringConcat', + ], + ], + [ + 'name' => 'Resources', + 'in' => 'formData', + 'schema' => [ + 'description' => '函数引用的资源名列表，'."\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' => '函数用途的说明，'."\n" + .'对应创建函数表单中的描述。', + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => 'Concatenate several strings to generate a new string', + ], + ], + [ + 'name' => 'CmdDescription', + 'in' => 'formData', + 'schema' => [ + 'description' => '函数的调用命令格式，'."\n" + .'对应创建函数表单中的命令格式。', + 'type' => 'string', + 'required' => false, + 'example' => 'StringConcat(String... substrs)', + ], + ], + [ + 'name' => 'ParameterDescription', + 'in' => 'formData', + 'schema' => [ + 'description' => '函数入参的说明，'."\n" + .'对应创建函数表单中的参数说明。', + 'type' => 'string', + 'required' => false, + 'example' => 'List of strings to be connected', + 'default' => 'ALL_ALLOWED', + 'enum' => [ + 'ALL_ALLOWD', + 'FAILURE_ALLOWED', + 'ALL_DENIED', + ], + ], + ], + [ + 'name' => 'ReturnValue', + 'in' => 'formData', + 'schema' => [ + 'description' => '函数的返回值说明，'."\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' => '函数的调用示例，'."\n" + .'对应创建函数表单中的示例。', + 'type' => 'string', + 'required' => false, + 'example' => 'StringConcat(\'a\', \'b\', \'c\')', + ], + ], + [ + 'name' => 'ProjectIdentifier', + 'in' => 'formData', + 'schema' => [ + 'description' => 'DataWorks工作空间的唯一标识符，'."\n" + .'即数据开发页面顶部切换工作空间处的英文标识。'."\n" + ."\n" + .'该参数与ProjectId参数二者必须设置其一，以确定本次API调用操作的DataWorks工作空间。', + 'type' => 'string', + 'required' => false, + 'example' => 'dw_project', + ], + ], + [ + 'name' => 'FileId', + 'in' => 'formData', + 'schema' => [ + 'description' => '文件的'."\n" + .'ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '10000001', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回结果'."\n" + .'。', + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => [ + 'description' => 'HTTP状态码'."\n" + .'。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'ErrorMessage' => [ + 'description' => '错误消息'."\n" + .'。', + 'type' => 'string', + 'example' => 'The connection does not exist.', + ], + 'RequestId' => [ + 'description' => '本次调用的唯一ID。出现错误后，您可以根据该ID排查问题'."\n" + .'。', + 'type' => 'string', + 'example' => '0000-ABCD-EFG****', + ], + 'ErrorCode' => [ + 'description' => '错误码'."\n" + .'。', + 'type' => 'string', + 'example' => 'Invalid.Tenant.ConnectionNotExists', + ], + 'Success' => [ + 'description' => '请求是否成功：'."\n" + ."\n" + .'- true（成功）'."\n" + .'- false（失败）', + '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' => '[{"errorExample":"","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}","type":"json"}]', + 'title' => '更新函数的文件信息', + 'summary' => '调用UpdateUdfFile更新函数的文件信息。', + ], + 'GetFile' => [ + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '267409', + 'abilityTreeNodes' => [ + 'FEATUREdide8FM783', + ], + ], + 'parameters' => [ + [ + 'name' => 'ProjectId', + 'in' => 'formData', + 'schema' => [ + 'description' => 'DataWorks工作空间的ID。您可以登录[DataWorks控制台](https://workbench.data.aliyun.com/console)，进入工作空间配置页面获取工作空间ID。'."\n" + ."\n" + .'该参数与ProjectIdentifier参数，二者必须设置其一，用来确定本次API调用操作的DataWorks工作空间。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'docRequired' => false, + 'example' => '10000', + ], + ], + [ + 'name' => 'ProjectIdentifier', + 'in' => 'formData', + 'schema' => [ + 'description' => 'DataWorks工作空间的名称。您可以登录[DataWorks控制台](https://workbench.data.aliyun.com/console)，进入工作空间配置页面获取工作空间名称。'."\n" + ."\n" + .'该参数与ProjectId参数，二者必须设置其一，用来确定本次API调用操作的DataWorks工作空间。', + 'type' => 'string', + 'required' => false, + 'example' => 'dw_project', + ], + ], + [ + 'name' => 'FileId', + 'in' => 'formData', + 'schema' => [ + 'description' => '文件的ID。您可以调用[ListFiles](~~173942~~)接口查询对应文件的ID。'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '100000001', + ], + ], + [ + 'name' => 'NodeId', + 'in' => 'formData', + 'schema' => [ + 'description' => '调度节点的ID。您可以调用[ListFiles](~~173942~~)接口获取节点ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '200000001', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => [ + 'description' => 'HTTP状态码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'ErrorMessage' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'The connection does not exist.', + ], + 'RequestId' => [ + 'description' => '请求ID。用于出现错误后排查问题。', + 'type' => 'string', + 'example' => '0000-ABCD-EFG****', + ], + 'ErrorCode' => [ + 'description' => '错误码。', + 'type' => 'string', + 'example' => 'Invalid.Tenant.ConnectionNotExists', + ], + 'Success' => [ + 'description' => '调用是否成功。取值如下：'."\n" + .'- true：调用成功。'."\n" + .'- false：调用失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Data' => [ + 'description' => '文件的详情。', + 'type' => 'object', + 'properties' => [ + 'File' => [ + 'description' => '文件的基本信息。', + 'type' => 'object', + 'properties' => [ + 'CommitStatus' => [ + 'description' => '文件当前的提交状态，包括0（未提交最新的代码）和1（已提交最新的代码）。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'AutoParsing' => [ + 'description' => '文件是否开启自动解析功能。取值如下：'."\n" + .'- true：文件会自动解析代码。'."\n" + .'- false：文件不会自动解析代码。'."\n" + ."\n" + .'该参数与[DataWorks控制台](https://workbench.data.aliyun.com/console)中，数据开发任务的“调度配置>调度依赖”选择“同周期”时的“代码解析”对应。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Owner' => [ + 'description' => '文件责任人的阿里云用户ID。', + 'type' => 'string', + 'example' => '7775674356****', + ], + 'CreateTime' => [ + 'description' => '文件创建的时间戳，单位为毫秒。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1593879116000', + ], + 'FileType' => [ + 'description' => '文件的代码类型。文件类型，不同文件类型其代码不同，详情请参见[DataWorks节点合集](~~600169~~)。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'CurrentVersion' => [ + 'description' => '文件当前已经提交的最新版本号。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '3', + ], + 'BizId' => [ + 'description' => '文件所属业务流程的ID。该字段已废弃，请使用BusinessId字段。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1000001', + ], + 'LastEditUser' => [ + 'description' => '最近一次编辑文件的阿里云用户ID。', + 'type' => 'string', + 'example' => '424732****'."\n", + ], + 'FileName' => [ + 'description' => '文件的名称。', + 'type' => 'string', + 'example' => 'ods_user_info_d', + ], + 'ConnectionName' => [ + 'description' => '执行文件对应的任务时，所使用的数据源名称。', + 'type' => 'string', + 'example' => 'odps_source', + ], + 'UseType' => [ + 'description' => '文件所属的功能模块。取值如下：'."\n" + .'- NORMAL：数据开发。'."\n" + .'- MANUAL：手动任务。'."\n" + .'- MANUAL_BIZ：手动业务流程。'."\n" + .'- SKIP：数据开发的空跑调度。'."\n" + .'- ADHOCQUERY：临时查询。'."\n" + .'- COMPONENT：组件管理。'."\n", + 'type' => 'string', + 'example' => 'NORMAL', + ], + 'FileFolderId' => [ + 'description' => '文件所属文件夹的ID。', + 'type' => 'string', + 'example' => '2735c2****', + ], + 'ParentId' => [ + 'description' => '如果当前文件是组合节点文件的内部文件，该字段标识对应组合节点文件的ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '-1', + ], + 'CreateUser' => [ + 'description' => '文件创建人的阿里云用户ID。', + 'type' => 'string', + 'example' => '424732****'."\n", + ], + 'IsMaxCompute' => [ + 'description' => '标识该资源文件是否需要上传至MaxCompute。'."\n" + .'仅当文件是MaxCompute资源文件时才需要配置该参数。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'BusinessId' => [ + 'description' => '文件的业务流程ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1000001', + ], + 'FileDescription' => [ + 'description' => '文件的描述信息。', + 'type' => 'string', + 'example' => 'My first DataWorks file', + ], + 'DeletedStatus' => [ + 'description' => '文件的删除状态。取值如下：'."\n" + .'- NORMAL：未删除。'."\n" + .'- RECYCLE_BIN：回收站。'."\n" + .'- DELETED：被删除。', + 'type' => 'string', + 'example' => 'RECYCLE', + ], + 'LastEditTime' => [ + 'description' => '最近一次编辑文件的时间戳，单位为毫秒。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1593879116000', + ], + 'Content' => [ + 'description' => '文件的代码。', + 'type' => 'string', + 'example' => 'SHOW TABLES;', + ], + 'NodeId' => [ + 'description' => '提交文件后，在调度系统生成的调度任务ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '300001', + ], + 'AdvancedSettings' => [ + 'description' => '任务的高级配置。'."\n" + ."\n" + .'该参数与[DataWorks控制台](https://workbench.data.aliyun.com/console)中，EMR数据开发任务，编辑页面右侧导航栏的“高级设置“对应。'."\n" + ."\n" + .'> 当前EMR Shell任务不支持配置高级参数。'."\n" + ."\n" + .'各EMR任务开发的高级参数说明，请参见[EMR任务开发](~~473077~~)。', + 'type' => 'string', + 'example' => '{\\"priority\\":\\"1\\",\\"ENABLE_SPARKSQL_JDBC\\":false,\\"FLOW_SKIP_SQL_ANALYZE\\":false,\\"queue\\":\\"default\\"}', + ], + 'FileId' => [ + 'description' => '文件的ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '100000001', + ], + ], + ], + 'NodeConfiguration' => [ + 'description' => '文件的调度配置。', + 'type' => 'object', + 'properties' => [ + 'RerunMode' => [ + 'description' => '重跑属性。取值如下：'."\n" + .'- ALL_ALLOWED：运行成功或失败后皆可重跑。'."\n" + .'- FAILURE_ALLOWED：运行成功后不可重跑，运行失败后可以重跑。'."\n" + .'- ALL_DENIED：运行成功或失败皆不可重跑。'."\n" + ."\n" + .'该参数与[DataWorks控制台](https://workbench.data.aliyun.com/console)中，数据开发任务的“调度配置>时间属性>重跑属性”配置内容对应。', + 'type' => 'string', + 'example' => 'ALL_ALLOWED', + ], + 'SchedulerType' => [ + 'description' => '调度的类型，取值如下：'."\n" + .'- NORMAL：正常调度任务。'."\n" + .'- MANUAL：手动任务，不会被日常调度，对应手动业务流程下的节点。'."\n" + .'- PAUSE：暂停任务。'."\n" + .'- SKIP：空跑任务，被日常调度，但启动调度时直接被置为成功。', + 'type' => 'string', + 'example' => 'NORMAL', + ], + 'Stop' => [ + 'description' => '是否暂停调度，取值如下：'."\n" + .'- true：暂停调度。'."\n" + .'- false：不暂停调度。'."\n" + ."\n" + .'该参数与[DataWorks控制台](https://workbench.data.aliyun.com/console)中，数据开发任务的“调度配置>时间属性>调度类型”配置为”暂停调度“时对应。', + 'type' => 'boolean', + 'example' => 'false', + ], + 'ParaValue' => [ + 'description' => '调度参数。'."\n" + ."\n" + .'该参数与[DataWorks控制台](https://workbench.data.aliyun.com/console)中，数据开发任务的“调度配置>参数”对应。您可以参考[调度参数](~~137548~~)配置。', + 'type' => 'string', + 'example' => 'a=x b=y', + ], + 'StartEffectDate' => [ + 'description' => '开始自动调度的毫秒时间戳。'."\n" + ."\n" + .'该参数与[DataWorks控制台](https://workbench.data.aliyun.com/console)中，数据开发任务的“调度配置>时间属性>生效日期”配置的开始时间的毫秒时间戳对应。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '936923400000', + ], + 'EndEffectDate' => [ + 'description' => '停止自动调度的时间戳，单位为毫秒。'."\n" + ."\n" + .'该参数与[DataWorks控制台](https://workbench.data.aliyun.com/console)中，数据开发任务的“调度配置>时间属性>生效日期”配置的结束时间的毫秒时间戳对应。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '4155787800000', + ], + 'CycleType' => [ + 'description' => '调度周期的类型，包括NOT_DAY（分钟、小时）和DAY（日、周、月）。'."\n" + ."\n" + .'该参数与[DataWorks控制台](https://workbench.data.aliyun.com/console)中，数据开发任务的“调度配置>时间属性>调度周期”对应。', + 'type' => 'string', + 'example' => 'DAY', + ], + 'DependentNodeIdList' => [ + 'description' => '当DependentType参数配置为USER_DEFINE时，用于设置当前文件具体依赖的节点ID。依赖多个节点时，使用英文逗号（,）分隔。'."\n" + ."\n" + .'该参数与[DataWorks控制台](https://workbench.data.aliyun.com/console)中，数据开发任务的“调度配置>调度依赖”配置为“上一周期”后，依赖项选择”其他节点“时配置的内容对应。', + 'type' => 'string', + 'example' => '5,10,15,20', + ], + 'ResourceGroupId' => [ + 'description' => '文件发布成任务后，任务执行时对应的资源组。您可以调用[ListResourceGroups](~~173913~~)获取工作空间可用的资源组列表。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '375827434852437', + ], + 'DependentType' => [ + 'description' => '依赖上一周期的方式。取值如下：'."\n" + .'- SELF：依赖项选择本节点。'."\n" + .'- CHILD：依赖项选择一级子节点。'."\n" + .'- USER_DEFINE：依赖项选择其他节点。'."\n" + .'- NONE：未选择依赖项，即不会依赖上一周期。', + 'type' => 'string', + 'example' => 'USER_DEFINE', + ], + 'AutoRerunTimes' => [ + 'description' => '出错自动重跑的次数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '3', + ], + 'AutoRerunIntervalMillis' => [ + 'description' => '出错自动重跑时间间隔，单位为毫秒。'."\n" + ."\n" + .'该参数与[DataWorks控制台](https://workbench.data.aliyun.com/console)中，数据开发任务的“调度配置>时间属性>出错自动重跑”的”重跑间隔“配置对应。'."\n" + .'控制台中“重跑间隔”的时间单位为分钟，请在调用时注意转换时间。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '120000', + ], + 'CronExpress' => [ + 'description' => '文件定时调度的cron表达式。', + 'type' => 'string', + 'example' => '00 05 00 * * ?', + ], + 'InputList' => [ + 'description' => '依赖的上游文件输出信息。', + 'type' => 'array', + 'items' => [ + 'description' => '依赖的上游文件输出信息。', + 'type' => 'object', + 'properties' => [ + 'Input' => [ + 'description' => '文件依赖的上游文件的输出名称。'."\n" + ."\n" + .'该参数与[DataWorks控制台](https://workbench.data.aliyun.com/console)中，数据开发任务的“调度配置>调度依赖“选择”同周期“时的”父节点输出名称”对应。', + 'type' => 'string', + 'example' => 'project.001_out', + ], + 'ParseType' => [ + 'description' => '配置文件依赖的方式，取值如下：'."\n" + .'- MANUAL：手动配置。'."\n" + .'- AUTO：自动解析。', + 'type' => 'string', + 'example' => 'MANUAL', + ], + ], + ], + ], + 'OutputList' => [ + 'description' => '文件的输出信息。', + 'type' => 'array', + 'items' => [ + 'description' => '文件的输出信息。', + 'type' => 'object', + 'properties' => [ + 'RefTableName' => [ + 'description' => '文件的输出值。'."\n" + ."\n" + .'该参数与[DataWorks控制台](https://workbench.data.aliyun.com/console)中，数据开发任务的“调度配置>调度依赖“选择”同周期“时的“本节点的输出表”列的值对应。', + 'type' => 'string', + 'example' => 'ods_user_info_d', + ], + 'Output' => [ + 'description' => '文件的输出名称。'."\n" + ."\n" + .'该参数与[DataWorks控制台](https://workbench.data.aliyun.com/console)中，数据开发任务的“调度配置>调度依赖“选择”同周期“时的“本节点的输出名称”列值对应。', + 'type' => 'string', + 'example' => 'dw_project.002_out', + ], + ], + ], + ], + 'StartImmediately' => [ + 'description' => '发布后是否立即启动。'."\n" + ."\n" + .'该参数与[DataWorks控制台](https://workbench.data.aliyun.com/console)中，EMR Spark Streaming和EMR Streaming SQL数据开发任务，编辑页面右侧导航栏的“配置>时间属性>启动方式“对应。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'InputParameters' => [ + 'description' => '返回结果。', + 'type' => 'array', + 'items' => [ + 'description' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'ParameterName' => [ + 'description' => '节点上下文输入参数的参数名称。在代码中可以使用${...}方式引用该参数。'."\n" + ."\n" + .'该参数与[DataWorks控制台](https://workbench.data.aliyun.com/console)中，数据开发任务的“调度配置>节点上下文>本节点输入参数“的”参数名“对应。', + 'type' => 'string', + 'example' => 'input', + ], + 'ValueSource' => [ + 'description' => '节点上下文输入参数的取值来源。'."\n" + ."\n" + .'该参数与[DataWorks控制台](https://workbench.data.aliyun.com/console)中，数据开发任务的“调度配置>节点上下文>本节点输入参数“的”取值来源“对应。', + 'type' => 'string', + 'example' => 'project_001.parent_node:outputs', + ], + ], + ], + ], + 'OutputParameters' => [ + 'description' => '返回结果。', + 'type' => 'array', + 'items' => [ + 'description' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'ParameterName' => [ + 'description' => '节点上下文输出参数的参数名称。'."\n" + ."\n" + .'该参数与[DataWorks控制台](https://workbench.data.aliyun.com/console)中，数据开发任务的“调度配置>节点上下文>本节点输出参数“的”参数名“对应。', + 'type' => 'string', + 'example' => 'output', + ], + 'Value' => [ + 'description' => '节点上下文输出参数的表达式。'."\n" + ."\n" + .'该参数与[DataWorks控制台](https://workbench.data.aliyun.com/console)中，数据开发任务的“调度配置>节点上下文>本节点输出参数“的”取值“对应。', + 'type' => 'string', + 'example' => '${bizdate}', + ], + 'Type' => [ + 'description' => '节点上下文输出参数表达式的类型。取值如下：'."\n" + .'- 1：表示常量。'."\n" + .'- 2：表示变量。'."\n" + .'- 3：表示参数节点透传变量。'."\n" + ."\n" + .'该参数与[DataWorks控制台](https://workbench.data.aliyun.com/console)中，数据开发任务的“调度配置>节点上下文>本节点输出参数“的”类型“对应。', + 'type' => 'string', + 'example' => '1', + ], + 'Description' => [ + 'description' => '节点上下文输出的参数描述。', + 'type' => 'string', + 'example' => 'It\'s a context output parameter.', + ], + ], + ], + ], + 'ApplyScheduleImmediately' => [ + 'description' => '是否发布后立即生效调度配置', + 'type' => 'string', + 'example' => 'true', + ], + 'IgnoreParentSkipRunningProperty' => [ + 'description' => '调度配置->上一周期->是否跳过上游的空跑属性', + 'type' => 'string', + 'example' => 'true', + ], + 'Timeout' => [ + 'description' => '调度配置超时定义', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'ImageId' => [ + 'description' => '自定义镜像ID', + 'type' => 'string', + 'example' => 'm-bp1h4b5a8ogkbll2f3tr', + ], + ], + ], + 'ResourceDownloadLink' => [ + 'description' => '资源下载地址', + 'type' => 'object', + 'properties' => [ + 'downloadLink' => [ + 'description' => '资源下载地址链接', + '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\\": \\"424732****\\\\n\\",\\n \\"FileName\\": \\"ods_user_info_d\\",\\n \\"ConnectionName\\": \\"odps_source\\",\\n \\"UseType\\": \\"NORMAL\\",\\n \\"FileFolderId\\": \\"2735c2****\\",\\n \\"ParentId\\": -1,\\n \\"CreateUser\\": \\"424732****\\\\n\\",\\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' => '获取文件的详情', + 'summary' => '该接口用于获取文件的详情。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'ListFiles' => [ + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '267410', + 'abilityTreeNodes' => [ + 'FEATUREdide8FM783', + ], + ], + 'parameters' => [ + [ + 'name' => 'FileFolderPath', + 'in' => 'formData', + 'schema' => [ + 'description' => '文件所在的文件夹路径'."\n" + .'。', + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => 'Business_process/my_first_business_process/MaxCompute/ods_layer', + ], + ], + [ + 'name' => 'ProjectId', + 'in' => 'formData', + 'schema' => [ + 'description' => 'DataWorks工作空间的ID。您可以登录[DataWorks控制台](https://workbench.data.aliyun.com/console)，进入工作空间配置页面获取工作空间ID。'."\n" + ."\n\n" + .'该参数与ProjectIdentifier参数，二者必须设置其一，用来确定本次API调用操作的DataWorks工作空间。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'docRequired' => false, + 'example' => '10000', + ], + ], + [ + 'name' => 'Keyword', + 'in' => 'formData', + 'schema' => [ + 'description' => '文件名称的关键字。支持模糊匹配，'."\n" + .'即输入关键字即可查询包含该关键字的所有文件。', + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => 'ods', + ], + ], + [ + 'name' => 'ProjectIdentifier', + 'in' => 'formData', + 'schema' => [ + 'description' => 'DataWorks工作空间的名称。您可以登录[DataWorks控制台](https://workbench.data.aliyun.com/console)，进入工作空间配置页面获取工作空间名称。'."\n" + ."\n\n" + .'该参数与ProjectId参数，二者必须设置其一，用来确定本次API调用操作的DataWorks工作空间。', + 'type' => 'string', + 'required' => false, + 'example' => 'dw_project', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'formData', + 'schema' => [ + 'description' => '请求的数据页数，'."\n" + .'用于翻页。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'minimum' => '1', + 'example' => '1', + 'default' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'formData', + 'schema' => [ + 'description' => '每页显示的条数，默认为10条，'."\n" + .'最大为100条。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'docRequired' => false, + 'maximum' => '100', + 'minimum' => '0', + 'example' => '10', + 'default' => '10', + ], + ], + [ + 'name' => 'UseType', + 'in' => 'formData', + 'schema' => [ + 'description' => '文件所属的功能模块。取值如下：'."\n" + ."\n" + .'- NORMAL：数据开发。'."\n" + .'- MANUAL：手动任务。'."\n" + .'- MANUAL_BIZ：手动业务流程。'."\n" + .'- SKIP：数据开发的空跑调度。'."\n" + .'- ADHOCQUERY：临时查询。'."\n" + .'- COMPONENT：组件管理。', + 'type' => 'string', + 'required' => false, + 'example' => 'NORMAL', + ], + ], + [ + 'name' => 'FileTypes', + 'in' => 'formData', + 'schema' => [ + 'description' => '文件的代码类型。'."\n" + ."\n\n" + .'常用的代码及其对应的文件类型包括6（Shell）、10（ODPS SQL）、11（ODPS MR）、23（数据集成）、24（ODPS Script）、97（PAI）、98（组合节点）、99（虚拟节点）、221（PyODPS 2）、225（ODPS Spark）、227（EMR Hive）、228（EMR Spark）、229（EMR Spark SQL）、230（EMR MR）、239（OSS对象检查）、257（EMR Shell）、258（EMR Spark Shell）、259（EMR Presto）、260（EMR Impala）、900（实时同步）、1002（PAI内部节点）、1089（跨租户节点）、1091（Hologres开发）、1093（Hologres SQL）、1100（赋值节点）、1106（遍历节点（foreach））、1221（PyODPS 3）。', + 'type' => 'string', + 'required' => false, + 'example' => '10,23', + ], + ], + [ + 'name' => 'Owner', + 'in' => 'formData', + 'schema' => [ + 'description' => '文件责任人'."\n" + .'。', + 'type' => 'string', + 'required' => false, + 'example' => '3726346****', + ], + ], + [ + 'name' => 'NodeId', + 'in' => 'formData', + 'schema' => [ + 'description' => '调度节点的ID。'."\n" + .'您可以调用[ListNodes](~~173979~~)接口获取节点ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '123541234', + ], + ], + [ + 'name' => 'NeedContent', + 'in' => 'formData', + 'schema' => [ + 'description' => '查询结果是否包含文件内容（对于内容较多的文件，'."\n" + .'可能存在较长的网络传输延时）。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + [ + 'name' => 'NeedAbsoluteFolderPath', + 'in' => 'formData', + 'schema' => [ + 'description' => '查询结果是否包含文件所在的文件夹的路径'."\n" + .'。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + [ + 'name' => 'ExactFileName', + 'in' => 'formData', + 'schema' => [ + 'description' => '精确匹配的文件名称，'."\n" + .'查询结果的文件名称与该参数完全一致。', + 'type' => 'string', + 'required' => false, + 'example' => 'ods_create.sql', + ], + ], + [ + 'name' => 'FileIdIn', + 'in' => 'formData', + 'schema' => [ + 'description' => 'Fileld列表，查询结果的文件ID集合只能是该列表的子集。'."\n" + .'最多支持一次指定50个FileId。', + 'type' => 'string', + 'required' => false, + 'example' => '78237,816123', + ], + ], + [ + 'name' => 'LastEditUser', + 'in' => 'formData', + 'schema' => [ + 'description' => '文件最后更新人的阿里云ID。', + 'type' => 'string', + 'required' => false, + 'example' => '11233***', + ], + ], + [ + 'name' => 'CommitStatus', + 'in' => 'formData', + 'schema' => [ + 'description' => '文件当前的提交状态，'."\n" + .'包括0（未提交最新的代码）和1（已提交最新的代码）。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回结果'."\n" + .'。', + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => [ + 'description' => 'HTTP状态码'."\n" + .'。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'ErrorMessage' => [ + 'description' => '错误信息'."\n" + .'。', + 'type' => 'string', + 'example' => 'The connection does not exist.', + ], + 'RequestId' => [ + 'description' => '请求ID。用于出现错误后排查问题'."\n" + .'。', + 'type' => 'string', + 'example' => '0000-ABCD-****', + ], + 'ErrorCode' => [ + 'description' => '错误码'."\n" + .'。', + 'type' => 'string', + 'example' => 'Invalid.Tenant.ConnectionNotExists', + ], + 'Success' => [ + 'description' => '调用是否成功。取值如下：'."\n" + ."\n" + .'- true：调用成功。'."\n" + .'- false：调用失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Data' => [ + 'description' => '返回数据详情'."\n" + .'。', + 'type' => 'object', + 'properties' => [ + 'PageNumber' => [ + 'description' => '请求的数据页数'."\n" + .'。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '每页显示的数据条数'."\n" + .'。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'TotalCount' => [ + 'description' => '满足条件的数据总条数'."\n" + .'。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '13', + ], + 'Files' => [ + 'description' => '文件详情'."\n" + .'。', + 'type' => 'array', + 'items' => [ + 'description' => '文件信息'."\n" + .'。', + 'type' => 'object', + 'properties' => [ + 'CommitStatus' => [ + 'description' => '文件当前的提交状态，包括0（未提交最新的代码）和1（已提交最新的代码）'."\n" + .'。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'AutoParsing' => [ + 'description' => '文件是否开启自动解析功能。取值如下：'."\n" + ."\n" + .'- true：文件会自动解析代码。'."\n" + .'- false：文件不会自动解析代码。'."\n" + ."\n" + .'该参数与[DataWorks控制台](https://workbench.data.aliyun.com/console)中，数据开发任务的“调度配置>调度依赖”选择“同周期”时的“代码解析”对应。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Owner' => [ + 'description' => '文件责任人的阿里云用户ID'."\n" + .'。', + 'type' => 'string', + 'example' => '3872572****', + ], + 'CreateTime' => [ + 'description' => '文件创建时间的毫秒时间戳'."\n" + .'。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1593950832000', + ], + 'FileType' => [ + 'description' => '文件类型。不同文件类型其代码不同，详情请参见[DataWorks节点合集](~~600169~~)'."\n" + .'。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'CurrentVersion' => [ + 'description' => '当前文件的最新版本'."\n" + .'。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'BizId' => [ + 'description' => '文件所属的业务流程ID。该字段已废弃，请使用BusinessId字段'."\n" + .'。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '300000', + ], + 'LastEditUser' => [ + 'description' => '文件最后更新人的阿里云ID'."\n" + .'。', + 'type' => 'string', + 'example' => '382762****', + ], + 'FileName' => [ + 'description' => '文件的名称'."\n" + .'。', + 'type' => 'string', + 'example' => 'ods_user_info_d', + ], + 'ConnectionName' => [ + 'description' => '文件对应的任务执行时所使用的数据源名称'."\n" + .'。', + 'type' => 'string', + 'example' => 'odps_source', + ], + 'UseType' => [ + 'description' => '文件所属的功能模块。'."\n" + .'取值如下：'."\n" + .'- NORMAL：数据开发。'."\n" + .'- MANUAL：手动任务。'."\n" + .'- MANUAL_BIZ：手动业务流程。'."\n" + .'- SKIP：数据开发的空跑调度。'."\n" + .'- ADHOCQUERY：临时查询。'."\n" + .'- COMPONENT：组件管理。', + 'type' => 'string', + 'example' => 'NORMAL', + ], + 'FileFolderId' => [ + 'description' => '文件所在文件夹的ID'."\n" + .'。', + 'type' => 'string', + 'example' => '2735c2****', + ], + 'FileId' => [ + 'description' => '文件的ID'."\n" + .'。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10000001', + ], + 'ParentId' => [ + 'description' => '如果当前文件是组合节点文件的内部文件，该字段标识对应组合节点文件的ID'."\n" + .'。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '-1', + ], + 'CreateUser' => [ + 'description' => '文件创建者的阿里云用户ID'."\n" + .'。', + 'type' => 'string', + 'example' => '382762****', + ], + 'IsMaxCompute' => [ + 'description' => '如果当前文件是MaxCompute资源文件，该字段标识该资源文件是否需要上传至MaxCompute。'."\n" + ."\n\n" + .'仅当文件是MaxCompute资源文件时才需要配置该参数。', + 'type' => 'boolean', + 'example' => 'false', + ], + 'BusinessId' => [ + 'description' => '文件所属的业务流程ID'."\n" + .'。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '300000', + ], + 'FileDescription' => [ + 'description' => '文件的描述信息'."\n" + .'。', + 'type' => 'string', + 'example' => 'my test datastudio file', + ], + 'LastEditTime' => [ + 'description' => '最近一次编辑文件的毫秒时间戳'."\n" + .'。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1593950832000', + ], + 'Content' => [ + 'description' => '该参数已废弃。您可通过[GetFile](~~173954~~)接口查询'."\n" + .'。', + 'type' => 'string', + 'example' => 'SHOW TABLES;', + ], + 'NodeId' => [ + 'description' => '提交文件后，在调度系统生成的调度任务的ID'."\n" + .'。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '300001', + ], + 'AbsoluteFolderPath' => [ + 'description' => '文件所在的文件夹的路径'."\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' => '[{"errorExample":"","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\\": \\"382762****\\",\\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}","type":"json"}]', + 'title' => '查询文件列表', + 'summary' => '调用ListFiles查询文件列表。', + ], + 'SubmitFile' => [ + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '268112', + 'abilityTreeNodes' => [ + 'FEATUREdide8FM783', + ], + ], + 'parameters' => [ + [ + 'name' => 'ProjectId', + 'in' => 'formData', + 'schema' => [ + 'description' => 'DataWorks工作空间的ID。'."\n" + .'您可以登录DataWorks管控台，进入工作空间配置页面获取工作空间ID。该参数与ProjectIdentifier参数，二者必须设置其一，用来确定本次API调用操作的DataWorks工作空间。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'docRequired' => false, + 'example' => '100001', + ], + ], + [ + 'name' => 'ProjectIdentifier', + 'in' => 'formData', + 'schema' => [ + 'description' => 'DataWorks工作空间名称。'."\n" + .'您可以登录DataWorks控制台，进入工作空间配置页面获取工作空间名称。该参数与ProjectId参数，二者必须设置其一，用来确定本次API调用操作的DataWorks工作空间。', + 'type' => 'string', + 'required' => false, + 'example' => 'dw_project', + ], + ], + [ + 'name' => 'FileId', + 'in' => 'formData', + 'schema' => [ + 'description' => '文件的ID，'."\n" + .'您可以通过[ListFiles](~~173942~~)查询对应文件的ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + 'example' => '1000000', + ], + ], + [ + 'name' => 'Comment', + 'in' => 'formData', + 'schema' => [ + 'description' => '提交的说明信息。', + 'type' => 'string', + 'required' => false, + 'example' => 'Submit a task for the first time', + ], + ], + [ + 'name' => 'SkipAllDeployFileExtensions', + 'in' => 'formData', + 'schema' => [ + 'description' => '文件提交成功后是否跳过发布前检查：'."\n" + ."\n" + .'- false：不跳过。文件提交后会自动触发发布前检查流程，检查通过后才会进入可发布状态。'."\n" + .'- true：跳过。文件提交后不会触发发布前检查流程，可直接进入发布流程。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + 'default' => 'false', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => [ + 'description' => 'Http状态码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Data' => [ + 'description' => '发布包的ID。后续需要将该ID作为参数调用[GetDeployment](~~173950~~)接口，获取本次发布的具体情况。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '3000001', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '0000-ABCD-EFG****', + ], + 'ErrorMessage' => [ + 'description' => '错误信息', + 'type' => 'string', + 'example' => 'The connection does not exist.', + ], + 'Success' => [ + 'description' => '调用是否成功。'."\n" + ."\n" + .'- true：成功。'."\n" + .'- false：失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'ErrorCode' => [ + 'description' => '错误码', + '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.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]', + 'title' => '提交文件至调度系统开发环境', + 'summary' => '提交文件至调度系统的开发环境，生成对应的任务。', + ], + 'DeployFile' => [ + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '268115', + 'abilityTreeNodes' => [ + 'FEATUREdide8FM783', + ], + ], + 'parameters' => [ + [ + 'name' => 'ProjectId', + 'in' => 'formData', + 'schema' => [ + 'description' => 'DataWorks工作空间的ID。'."\n" + .'您可以登录DataWorks管控台，进入工作空间配置页面获取工作空间ID。该参数与ProjectIdentifier参数，二者必须设置其一，用来确定本次API调用操作的DataWorks工作空间。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'docRequired' => false, + 'example' => '10000', + ], + ], + [ + 'name' => 'ProjectIdentifier', + 'in' => 'formData', + 'schema' => [ + 'description' => 'DataWorks工作空间名称。'."\n" + .'您可以登录DataWorks控制台，进入工作空间配置页面获取工作空间名称。该参数与ProjectId参数，二者必须设置其一，用来确定本次API调用操作的DataWorks工作空间。', + 'type' => 'string', + 'required' => false, + 'example' => 'dw_project', + ], + ], + [ + 'name' => 'FileId', + 'in' => 'formData', + 'schema' => [ + 'description' => '文件的ID，您可以通过[ListFiles](~~173942~~)查询对应文件的ID。该参数与NodeId参数配置一个即可。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'docRequired' => true, + 'example' => '10000001', + ], + ], + [ + 'name' => 'Comment', + 'in' => 'formData', + 'schema' => [ + 'description' => '发布的说明信息。', + 'type' => 'string', + 'required' => false, + 'example' => 'First release task', + ], + ], + [ + 'name' => 'NodeId', + 'in' => 'formData', + 'schema' => [ + 'description' => '待发布文件在调度系统对应的任务ID。'."\n" + .'该参数与FileId参数配置一个即可。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '2000001', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => [ + 'description' => 'Http状态码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Data' => [ + 'description' => '发布包的ID。后续需要将该ID作为参数调用[GetDeployment](~~173950~~)接口，获取本次发布的具体情况。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '30000001', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '0000-ABCD-EFG****', + ], + 'ErrorMessage' => [ + 'description' => '错误信息', + 'type' => 'string', + 'example' => 'The connection does not exist.', + ], + 'Success' => [ + 'description' => '调用是否成功。'."\n" + .'取值如下：'."\n" + .'- true：调用成功。'."\n" + .'- false：调用失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'ErrorCode' => [ + 'description' => '错误码', + '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.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]', + 'title' => '部署文件', + 'summary' => '发布文件至生产环境。', + ], + 'CreateFolder' => [ + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'abilityTreeCode' => '268606', + 'abilityTreeNodes' => [ + 'FEATUREdide8FM783', + ], + ], + 'parameters' => [ + [ + 'name' => 'ProjectId', + 'in' => 'formData', + 'schema' => [ + 'description' => 'DataWorks工作空间的ID。'."\n" + .'您可以登录DataWorks管控台，进入工作空间配置页面获取工作空间ID。该参数与**ProjectIdentifier**参数，二者必须设置其一，用来确定本次API调用操作的DataWorks工作空间。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'docRequired' => false, + 'example' => '10000', + ], + ], + [ + 'name' => 'ProjectIdentifier', + 'in' => 'formData', + 'schema' => [ + 'description' => 'DataWorks工作空间名称。'."\n" + .'您可以登录DataWorks控制台，进入工作空间配置页面获取工作空间名称。该参数与**ProjectId**参数，二者必须设置其一，用来确定本次API调用操作的DataWorks工作空间。', + 'type' => 'string', + 'required' => false, + 'example' => 'dw_project', + ], + ], + [ + 'name' => 'FolderPath', + 'in' => 'formData', + 'schema' => [ + 'description' => '文件夹的路径'."\n" + .'。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'Business_process/System_Data/MaxCompute/import_layer', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => [ + 'description' => 'HTTP状态码'."\n" + .'。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Data' => [ + 'description' => '新建文件夹的唯一标识符'."\n" + .'。', + 'type' => 'string', + 'example' => 'bdfd68****', + ], + 'RequestId' => [ + 'description' => '请求ID。用于出现错误后排查问题'."\n" + .'。', + 'type' => 'string', + 'example' => '0000-ABCD-EFG', + ], + 'ErrorMessage' => [ + 'description' => '错误信息'."\n" + .'。', + 'type' => 'string', + 'example' => 'The connection does not exist.', + ], + 'Success' => [ + 'description' => '调用是否成功。'."\n" + .'取值如下：'."\n" + ."\n" + .'true：调用成功'."\n" + ."\n" + .'false：调用失败', + 'type' => 'boolean', + 'example' => 'true', + ], + 'ErrorCode' => [ + 'description' => '错误码'."\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' => '[{"errorExample":"","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}","type":"json"}]', + 'title' => '创建文件夹', + 'summary' => '调用CreateFolder创建文件夹。', + ], + 'DeleteFolder' => [ + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'abilityTreeCode' => '268607', + 'abilityTreeNodes' => [ + 'FEATUREdide8FM783', + ], + ], + 'parameters' => [ + [ + 'name' => 'ProjectId', + 'in' => 'formData', + 'schema' => [ + 'description' => 'DataWorks工作空间的ID。'."\n" + .'您可以登录DataWorks管控台，进入工作空间配置页面获取工作空间ID。该参数与ProjectIdentifier参数，二者必须设置其一，用来确定本次API调用操作的DataWorks工作空间。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'docRequired' => false, + 'example' => '10000', + ], + ], + [ + 'name' => 'ProjectIdentifier', + 'in' => 'formData', + 'schema' => [ + 'description' => 'DataWorks工作空间名称。'."\n" + .'您可以登录DataWorks控制台，进入工作空间配置页面获取工作空间名称。该参数与ProjectId参数，二者必须设置其一，用来确定本次API调用操作的DataWorks工作空间。', + 'type' => 'string', + 'required' => false, + 'example' => 'dw_project', + ], + ], + [ + 'name' => 'FolderId', + 'in' => 'formData', + 'schema' => [ + 'description' => '文件夹的ID，'."\n" + .'您可以通过[ListFolders](~~173955~~)查询对应文件夹的ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '2eb6f9****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回结果'."\n" + .'。', + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => [ + 'description' => 'HTTP状态码'."\n" + .'。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'ErrorMessage' => [ + 'description' => '错误信息'."\n" + .'。', + 'type' => 'string', + 'example' => 'The connection does not exist.', + ], + 'RequestId' => [ + 'description' => '请求ID。用于出现错误后排查问题'."\n" + .'。', + 'type' => 'string', + 'example' => '0000-ABCD-EFG****', + ], + 'ErrorCode' => [ + 'description' => '错误码'."\n" + .'。', + 'type' => 'string', + 'example' => 'Invalid.Tenant.ConnectionNotExists', + ], + 'Success' => [ + 'description' => '调用是否成功。取值如下：'."\n" + ."\n" + .'- true：调用成功。'."\n" + .'- false：调用失败。', + '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' => '[{"errorExample":"","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}","type":"json"}]', + 'title' => ' 删除数据开发页面的文件夹', + 'summary' => '调用DeleteFolder删除数据开发页面的文件夹。', + ], + 'UpdateFolder' => [ + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '268610', + 'abilityTreeNodes' => [ + 'FEATUREdide8FM783', + ], + ], + 'parameters' => [ + [ + 'name' => 'ProjectId', + 'in' => 'formData', + 'schema' => [ + 'description' => 'DataWorks工作空间的ID。'."\n" + .'您可以登录DataWorks管控台，进入工作空间配置页面获取工作空间ID。该参数与ProjectIdentifier参数，二者必须设置其一，用来确定本次API调用操作的DataWorks工作空间。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'docRequired' => false, + 'example' => '10000', + ], + ], + [ + 'name' => 'ProjectIdentifier', + 'in' => 'formData', + 'schema' => [ + 'description' => 'DataWorks工作空间名称。'."\n" + .'您可以登录DataWorks控制台，进入工作空间配置页面获取工作空间名称。该参数与ProjectId参数，二者必须设置其一，用来确定本次API调用操作的DataWorks工作空间。', + 'type' => 'string', + 'required' => false, + 'example' => 'dw_project', + ], + ], + [ + 'name' => 'FolderId', + 'in' => 'formData', + 'schema' => [ + 'description' => '文件夹的ID，'."\n" + .'您可以调用[ListFolders](~~173955~~)获取文件夹的ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '2735c2c19d58', + ], + ], + [ + 'name' => 'FolderName', + 'in' => 'formData', + 'schema' => [ + 'description' => '文件夹名称。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'MySecondFolder', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => [ + 'description' => 'Http状态码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'ErrorMessage' => [ + 'description' => '错误信息', + 'type' => 'string', + 'example' => 'The connection does not exist.', + ], + 'RequestId' => [ + 'description' => '请求ID。', + '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' => '[{"errorExample":"","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}","type":"json"}]', + 'title' => ' 更新文件夹的信息', + 'summary' => '调用UpdateFolder更新文件夹的信息。', + ], + 'GetFolder' => [ + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '268603', + 'abilityTreeNodes' => [ + 'FEATUREdide8FM783', + ], + ], + 'parameters' => [ + [ + 'name' => 'ProjectId', + 'in' => 'formData', + 'schema' => [ + 'description' => 'DataWorks工作空间的ID。'."\n" + .'您可以登录DataWorks管控台，进入工作空间配置页面获取工作空间ID。该参数与ProjectIdentifier参数，二者必须设置其一，用来确定本次API调用操作的DataWorks工作空间。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'docRequired' => false, + 'example' => '1000011', + ], + ], + [ + 'name' => 'ProjectIdentifier', + 'in' => 'formData', + 'schema' => [ + 'description' => 'DataWorks工作空间名称。'."\n" + .'您可以登录DataWorks控制台，进入工作空间配置页面获取工作空间名称。该参数与ProjectId参数，二者必须设置其一，用来确定本次API调用操作的DataWorks工作空间。', + 'type' => 'string', + 'required' => false, + 'example' => 'dw_project', + ], + ], + [ + 'name' => 'FolderId', + 'in' => 'formData', + 'schema' => [ + 'description' => '文件夹的ID，该参数与FolderPath参数，二者必须设置其一。'."\n" + .'您可以调用[ListFolders](~~173955~~)接口获取文件夹ID。', + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => '273****', + ], + ], + [ + 'name' => 'FolderPath', + 'in' => 'formData', + 'schema' => [ + 'description' => '文件夹的路径，该参数与FolderId参数，二者必须设置其一。'."\n" + .'您可以调用[ListFolders](~~173955~~)接口获取文件夹路径。', + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => 'Business_process/my_first_business_process/MaxCompute/ods_layer', + 'minLength' => 1, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => [ + 'description' => 'HTTP状态码'."\n" + .'。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'ErrorMessage' => [ + 'description' => '错误信息'."\n" + .'。', + 'type' => 'string', + 'example' => 'The connection does not exist.', + ], + 'RequestId' => [ + 'description' => '请求ID。'."\n" + .'用于出现错误后排查问题。', + 'type' => 'string', + 'example' => '0000-ABCD-EFG****', + ], + 'ErrorCode' => [ + 'description' => '错误码'."\n" + .'。', + 'type' => 'string', + 'example' => 'Invalid.Tenant.ConnectionNotExists', + ], + 'Success' => [ + 'description' => '是否调用成功。'."\n" + ."\n" + .'- **true**：调用成功。'."\n" + .'- **false**：调用失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Data' => [ + 'description' => '文件夹的详情'."\n" + .'。', + 'type' => 'object', + 'properties' => [ + 'FolderPath' => [ + 'description' => '文件夹的路径'."\n" + .'。', + 'type' => 'string', + 'example' => 'Business_process/my_first_business_process/MaxCompute/ods_layer', + ], + 'FolderId' => [ + 'description' => '文件夹的ID'."\n" + .'。', + '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' => '[{"errorExample":"","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}","type":"json"}]', + 'title' => '获取文件夹的详情', + 'summary' => '调用GetFolder获取文件夹的详情。', + ], + 'ListFolders' => [ + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '268609', + 'abilityTreeNodes' => [ + 'FEATUREdide8FM783', + ], + ], + 'parameters' => [ + [ + 'name' => 'ProjectId', + 'in' => 'formData', + 'schema' => [ + 'description' => 'DataWorks工作空间的ID。'."\n" + .'您可以登录DataWorks管控台，进入工作空间配置页面获取工作空间ID。该参数与ProjectIdentifier参数，二者必须设置其一，用来确定本次API调用操作的DataWorks工作空间。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'docRequired' => false, + 'example' => '10000', + ], + ], + [ + 'name' => 'ProjectIdentifier', + 'in' => 'formData', + 'schema' => [ + 'description' => 'DataWorks工作空间名称。'."\n" + .'您可以登录DataWorks控制台，进入工作空间配置页面获取工作空间名称。该参数与ProjectId参数，二者必须设置其一，用来确定本次API调用操作的DataWorks工作空间。', + 'type' => 'string', + 'required' => false, + 'example' => 'dw_project', + ], + ], + [ + 'name' => 'ParentFolderPath', + 'in' => 'formData', + 'schema' => [ + 'description' => '父文件夹的路径'."\n" + .'。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'Business_process/my_first_business_process/MaxCompute', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'formData', + 'schema' => [ + 'description' => '请求的数据页数，用于翻页'."\n" + .'。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'docRequired' => true, + 'minimum' => '1', + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'formData', + 'schema' => [ + 'description' => '每页显示的数据条数，默认为10条，最大为100条'."\n" + .'。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'docRequired' => true, + 'maximum' => '100', + 'minimum' => '0', + 'example' => '10', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回结果'."\n" + .'。', + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => [ + 'description' => 'HTTP状态码'."\n" + .'。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'ErrorMessage' => [ + 'description' => '错误信息'."\n" + .'。', + 'type' => 'string', + 'example' => 'The connection does not exist.', + ], + 'RequestId' => [ + 'description' => '请求ID。用于出现错误后排查问题'."\n" + .'。', + 'type' => 'string', + 'example' => '0000-ABCD-****', + ], + 'ErrorCode' => [ + 'description' => '错误码'."\n" + .'。', + 'type' => 'string', + 'example' => 'Invalid.Tenant.ConnectionNotExists', + ], + 'Success' => [ + 'description' => '调用是否成功。取值如下：'."\n" + ."\n" + .'- true：调用成功。'."\n" + .'- false：调用失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Data' => [ + 'description' => '满足条件的文件夹的列表信息'."\n" + .'。', + 'type' => 'object', + 'properties' => [ + 'PageNumber' => [ + 'description' => '当前数据页的页码'."\n" + .'。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '当前数据页的数据条数'."\n" + .'。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'TotalCount' => [ + 'description' => '满足查询条件的数据总条数'."\n" + .'。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '13', + ], + 'Folders' => [ + 'description' => '文件夹的列表'."\n" + .'。', + 'type' => 'array', + 'items' => [ + 'description' => '文件夹的信息'."\n" + .'。', + 'type' => 'object', + 'properties' => [ + 'FolderPath' => [ + 'description' => '文件夹的路径'."\n" + .'。', + 'type' => 'string', + 'example' => 'Business_process/my_first_business_process/MaxCompute/ods_layer', + ], + 'FolderId' => [ + 'description' => '文件夹的ID'."\n" + .'。', + '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' => '[{"errorExample":"","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}","type":"json"}]', + 'title' => '查询文件夹的列表', + 'summary' => '调用ListFolders查询文件夹的列表。', + ], + 'CreateBusiness' => [ + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'abilityTreeCode' => '268146', + 'abilityTreeNodes' => [ + 'FEATUREdide8FM783', + ], + ], + 'parameters' => [ + [ + 'name' => 'ProjectId', + 'in' => 'formData', + 'schema' => [ + 'description' => 'DataWorks工作空间的ID，'."\n" + .'您可以登录[DataWorks控制台](https://workbench.data.aliyun.com/console)，进入工作空间管理页面查看ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'docRequired' => false, + 'example' => '10000', + ], + ], + [ + 'name' => 'ProjectIdentifier', + 'in' => 'formData', + 'schema' => [ + 'description' => 'DataWorks工作空间的唯一标识符，'."\n" + .'即数据开发页面顶部切换工作空间处的英文标识。该参数与projectid参数二者必须设置其一，以确定本次API调用操作的DataWorks项目。', + 'type' => 'string', + 'required' => false, + 'example' => 'dw_project', + ], + ], + [ + 'name' => 'BusinessName', + 'in' => 'formData', + 'schema' => [ + 'description' => '业务流程名称，'."\n" + .'同一个项目空间下的业务流程名称必须唯一。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'My business process', + ], + ], + [ + 'name' => 'Description', + 'in' => 'formData', + 'schema' => [ + 'description' => '业务流程的描述信息'."\n" + .'。', + 'type' => 'string', + 'required' => false, + 'example' => 'test', + ], + ], + [ + 'name' => 'Owner', + 'in' => 'formData', + 'schema' => [ + 'description' => '业务流程对应责任人的阿里云账号ID。'."\n" + .'您可以登录[DataWorks控制台](https://workbench.data.aliyun.com/console)，鼠标悬停至顶部菜单栏右侧的用户头像，查看账号ID。如果该参数为空，则默认使用调用者的阿里云账号ID。', + 'type' => 'string', + 'required' => false, + 'example' => '1000000000001', + ], + ], + [ + 'name' => 'UseType', + 'in' => 'formData', + 'schema' => [ + 'description' => '业务流程所属的功能模块。取值如下：'."\n" + ."\n" + .'- NORMAL（数据开发）'."\n" + .'- MANUAL_BIZ（手动业务流程）', + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'enumValueTitles' => [], + 'example' => 'NORMAL', + 'default' => 'NORMAL', + 'enum' => [ + 'NORMAL', + 'MANUAL_BIZ', + ], + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => [ + 'description' => 'HTTP状态码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'RequestId' => [ + 'description' => '本次调用的唯一ID。'."\n" + .'出现错误后，您可以根据该id排查问题。', + 'type' => 'string', + 'example' => '0000-ABCD-EFG****', + ], + 'ErrorMessage' => [ + 'description' => '错误信息'."\n" + .'。', + 'type' => 'string', + 'example' => 'The connection does not exist.', + ], + 'Success' => [ + 'description' => '调用是否成功。取值如下：'."\n" + ."\n" + .'- true：调用成功。'."\n" + .'- false：调用失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'ErrorCode' => [ + 'description' => '错误码。取值说明如下：'."\n" + .'- 请求成功：不返回ErrorCode字段。'."\n" + .'- 请求失败：返回ErrorCode字段。'."\n" + ."\n" + .'具体信息，请参见本文的错误码列表。', + 'type' => 'string', + 'example' => 'Invalid.Tenant.ConnectionNotExists', + ], + 'BusinessId' => [ + 'description' => '业务流程ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '100001', + ], + ], + ], + ], + ], + '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' => '[{"errorExample":"","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}","type":"json"}]', + 'title' => '创建业务流程', + 'summary' => '调用CreateBusiness，创建数据开发（DataStudio）的业务流程。', + ], + 'DeleteBusiness' => [ + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'abilityTreeCode' => '268604', + 'abilityTreeNodes' => [ + 'FEATUREdide8FM783', + ], + ], + 'parameters' => [ + [ + 'name' => 'ProjectId', + 'in' => 'formData', + 'schema' => [ + 'description' => 'DataWorks工作空间的ID。'."\n" + .'您可以登录DataWorks管控台，进入工作空间配置页面获取工作空间ID。该参数与ProjectIdentifier参数，二者必须设置其一，用来确定本次API调用操作的DataWorks工作空间。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'docRequired' => false, + 'example' => '10000', + ], + ], + [ + 'name' => 'ProjectIdentifier', + 'in' => 'formData', + 'schema' => [ + 'description' => 'DataWorks工作空间名称。'."\n" + .'您可以登录DataWorks控制台，进入工作空间配置页面获取工作空间名称。该参数与ProjectId参数，二者必须设置其一，用来确定本次API调用操作的DataWorks工作空间。', + 'type' => 'string', + 'required' => false, + 'example' => 'dw_project', + ], + ], + [ + 'name' => 'BusinessId', + 'in' => 'formData', + 'schema' => [ + 'description' => '业务流程的ID，'."\n" + .'您可以调用[ListBusiness](~~173945~~)接口，根据名称查询对应业务流程的ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + 'example' => '1000001', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回结果'."\n" + .'。', + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => [ + 'description' => 'HTTP状态码'."\n" + .'。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'ErrorMessage' => [ + 'description' => '错误信息'."\n" + .'。', + 'type' => 'string', + 'example' => 'The connection does not exist.', + ], + 'RequestId' => [ + 'description' => '请求ID。用于出现错误后排查问题'."\n" + .'。', + 'type' => 'string', + 'example' => '0000-ABCD-EFG****', + ], + 'ErrorCode' => [ + 'description' => '错误码'."\n" + .'。', + 'type' => 'string', + 'example' => 'Invalid.Tenant.ConnectionNotExists', + ], + 'Success' => [ + 'description' => '调用是否成功。取值如下：'."\n" + ."\n\n" + .'- true：调用成功。'."\n" + ."\n" + .'- false：调用失败。', + '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' => '[{"errorExample":"","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}","type":"json"}]', + 'title' => '删除业务流程', + 'summary' => '调用DeleteBusiness删除业务流程。', + ], + 'UpdateBusiness' => [ + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '268602', + 'abilityTreeNodes' => [ + 'FEATUREdide8FM783', + ], + ], + 'parameters' => [ + [ + 'name' => 'ProjectId', + 'in' => 'formData', + 'schema' => [ + 'description' => 'DataWorks工作空间的ID。您可以[登录DataWorks管控台](https://dataworks.console.aliyun.com/workspace/list)，进入工作空间配置页面获取工作空间ID。该参数与`ProjectIdentifier`参数，二者必须设置其一，用来确定本次API调用操作的DataWorks工作空间。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'docRequired' => false, + 'example' => '10001', + ], + ], + [ + 'name' => 'ProjectIdentifier', + 'in' => 'formData', + 'schema' => [ + 'description' => 'DataWorks工作空间名称。您可以登录[DataWorks控制台](https://dataworks.console.aliyun.com/workspace/list)，进入工作空间配置页面获取工作空间名称。该参数与`ProjectId`参数，二者必须设置其一，用来确定本次API调用操作的DataWorks工作空间。', + 'type' => 'string', + 'required' => false, + 'example' => 'project_dw', + ], + ], + [ + 'name' => 'BusinessName', + 'in' => 'formData', + 'schema' => [ + 'description' => '业务流程的名称。'."\n" + ."\n" + .'您可以调用[ListBusiness](~~173945~~)接口获取。', + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => 'firstBusiness', + ], + ], + [ + 'name' => 'Description', + 'in' => 'formData', + 'schema' => [ + 'description' => '业务流程的描述信息。', + 'type' => 'string', + 'required' => false, + 'example' => 'modified from first business', + ], + ], + [ + 'name' => 'Owner', + 'in' => 'formData', + 'schema' => [ + 'description' => '业务流程的责任人。'."\n" + ."\n" + .'您可以调用[ListBusiness](~~173945~~)接口获取。', + 'type' => 'string', + 'required' => false, + 'example' => '34842****', + ], + ], + [ + 'name' => 'BusinessId', + 'in' => 'formData', + 'schema' => [ + 'description' => '业务流程的ID。'."\n" + ."\n" + .'您可以调用[ListBusiness](~~173945~~)接口获取。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + 'example' => '300001', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => [ + 'description' => 'HTTP状态码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'ErrorMessage' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'The connection does not exist.', + ], + 'RequestId' => [ + 'description' => '请求ID。用于出现错误后排查问题。', + 'type' => 'string', + 'example' => '0000-ABCD-EFG****', + ], + 'ErrorCode' => [ + 'description' => '错误码。', + 'type' => 'string', + 'example' => 'Invalid.Tenant.ConnectionNotExists', + ], + 'Success' => [ + 'description' => '请求是否成功：'."\n" + ."\n" + .'- true: 成功。'."\n" + .'- false: 失败。', + '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' => '[{"errorExample":"","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}","type":"json"}]', + 'title' => '更新业务流程', + 'summary' => '该接口用于更新业务流程。', + ], + 'GetBusiness' => [ + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '268608', + 'abilityTreeNodes' => [ + 'FEATUREdide8FM783', + ], + ], + 'parameters' => [ + [ + 'name' => 'ProjectId', + 'in' => 'formData', + 'schema' => [ + 'description' => 'DataWorks工作空间的ID。'."\n" + .'您可以登录DataWorks管控台，进入工作空间配置页面获取工作空间ID。该参数与ProjectIdentifier参数，二者必须设置其一，用来确定本次API调用操作的DataWorks工作空间。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'docRequired' => false, + 'example' => '10000', + ], + ], + [ + 'name' => 'ProjectIdentifier', + 'in' => 'formData', + 'schema' => [ + 'description' => 'DataWorks工作空间名称。'."\n" + .'您可以登录DataWorks控制台，进入工作空间配置页面获取工作空间名称。该参数与ProjectId参数，二者必须设置其一，用来确定本次API调用操作的DataWorks工作空间。', + 'type' => 'string', + 'required' => false, + 'example' => 'dw_project', + ], + ], + [ + 'name' => 'BusinessId', + 'in' => 'formData', + 'schema' => [ + 'description' => '业务流程的ID，'."\n" + .'您可以调用[ListBusiness](~~173945~~)接口获取。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + 'example' => '1000000111', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回结果'."\n" + .'。', + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => [ + 'description' => 'HTTP状态码'."\n" + .'。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'ErrorMessage' => [ + 'description' => '错误信息'."\n" + .'。', + 'type' => 'string', + 'example' => 'The connection does not exist.', + ], + 'RequestId' => [ + 'description' => '请求ID。用于出现错误后排查问题'."\n" + .'。', + 'type' => 'string', + 'example' => '0000-ABCD-EFG****', + ], + 'ErrorCode' => [ + 'description' => '错误码'."\n" + .'。', + 'type' => 'string', + 'example' => 'Invalid.Tenant.ConnectionNotExists', + ], + 'Success' => [ + 'description' => '调用是否成功。取值如下：'."\n" + ."\n" + .'- true：调用成功。'."\n" + .'- false：调用失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Data' => [ + 'description' => '业务流程的详情'."\n" + .'。', + 'type' => 'object', + 'properties' => [ + 'Owner' => [ + 'description' => '业务流程责任人的阿里云用户ID'."\n" + .'。', + 'type' => 'string', + 'example' => '20000****', + ], + 'Description' => [ + 'description' => '业务流程的描述信息'."\n" + .'。', + 'type' => 'string', + 'example' => 'This is my first business process.', + ], + 'ProjectId' => [ + 'description' => '业务流程所在DataWorks工作空间的ID'."\n" + .'。', + 'type' => 'string', + 'example' => '10000', + ], + 'BusinessId' => [ + 'description' => '业务流程的ID'."\n" + .'。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1000001', + ], + 'BusinessName' => [ + 'description' => '业务流程名称，同一个项目空间下的业务流程名称必须唯一'."\n" + .'。', + 'type' => 'string', + 'example' => 'The first business process', + ], + 'UseType' => [ + 'description' => '业务流程所属的功能模块，包括NORMAL（数据开发）和MANUAL_BIZ（手动业务流程）'."\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' => '[{"errorExample":"","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}","type":"json"}]', + 'title' => '查询业务流程的详情', + 'summary' => '调用GetBusiness查询业务流程的详情。', + ], + 'ListBusiness' => [ + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '268605', + 'abilityTreeNodes' => [ + 'FEATUREdide8FM783', + ], + ], + 'parameters' => [ + [ + 'name' => 'ProjectId', + 'in' => 'formData', + 'schema' => [ + 'description' => 'DataWorks工作空间的ID。'."\n" + .'您可以登录DataWorks管控台，进入工作空间配置页面获取工作空间ID。该参数与ProjectIdentifier参数，二者必须设置其一，用来确定本次API调用操作的DataWorks工作空间。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'docRequired' => false, + 'example' => '10000', + ], + ], + [ + 'name' => 'ProjectIdentifier', + 'in' => 'formData', + 'schema' => [ + 'description' => 'DataWorks工作空间名称。'."\n" + .'您可以登录DataWorks控制台，进入工作空间配置页面获取工作空间名称。该参数与ProjectId参数，二者必须设置其一，用来确定本次API调用操作的DataWorks工作空间。', + 'type' => 'string', + 'required' => false, + 'example' => 'dw_project', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'formData', + 'schema' => [ + 'description' => '请求的数据页数，'."\n" + .'用于翻页。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'docRequired' => true, + 'minimum' => '1', + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'formData', + 'schema' => [ + 'description' => '每页显示的条数，默认为10条，'."\n" + .'最大100条。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'docRequired' => true, + 'maximum' => '100', + 'minimum' => '0', + 'example' => '10', + ], + ], + [ + 'name' => 'Keyword', + 'in' => 'formData', + 'schema' => [ + 'description' => '关键字，'."\n" + .'用于模糊匹配业务流程的名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'my', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回结果 。', + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => [ + 'description' => 'HTTP状态码'."\n" + .'。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'ErrorMessage' => [ + 'description' => '错误信息'."\n" + .'。', + 'type' => 'string', + 'example' => 'The connection does not exist.', + ], + 'RequestId' => [ + 'description' => '请求ID。用于出现错误后排查问题'."\n" + .'。', + 'type' => 'string', + 'example' => '0000-ABCD-EFG****', + ], + 'ErrorCode' => [ + 'description' => '错误码'."\n" + .'。', + 'type' => 'string', + 'example' => 'Invalid.Tenant.ConnectionNotExists', + ], + 'Success' => [ + 'description' => '调用是否成功'."\n" + .'。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Data' => [ + 'description' => '业务流程列表的详情'."\n" + .'。', + 'type' => 'object', + 'properties' => [ + 'PageNumber' => [ + 'description' => '当前的页数'."\n" + .'。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '当前数据页的数据条数'."\n" + .'。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'TotalCount' => [ + 'description' => '满足查询条件的总数'."\n" + .'。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '13', + ], + 'Business' => [ + 'description' => '业务流程列表信息'."\n" + .'。', + 'type' => 'array', + 'items' => [ + 'description' => '业务流程列表信息'."\n" + .'。', + 'type' => 'object', + 'properties' => [ + 'Owner' => [ + 'description' => '业务流程的责任人'."\n" + .'。', + 'type' => 'string', + 'example' => '34824327****', + ], + 'Description' => [ + 'description' => '业务流程的描述信息'."\n" + .'。', + 'type' => 'string', + 'example' => 'test', + ], + 'ProjectId' => [ + 'description' => '业务流程所在工作空间的id'."\n" + .'。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10000', + ], + 'BusinessId' => [ + 'description' => '业务流程的ID'."\n" + .'。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '3000001', + ], + 'BusinessName' => [ + 'description' => '业务流程的名称'."\n" + .'。', + 'type' => 'string', + 'example' => 'test', + ], + 'UseType' => [ + 'description' => '业务流程所属的功能模块，包括NORMAL（数据开发）和MANUAL_BIZ（手动业务流程）'."\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' => '[{"errorExample":"","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\\": \\"test\\",\\n \\"ProjectId\\": 10000,\\n \\"BusinessId\\": 3000001,\\n \\"BusinessName\\": \\"test\\",\\n \\"UseType\\": \\"NORMAL\\"\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => '查询业务流程的列表', + 'summary' => '调用ListBusiness查询业务流程的列表。', + ], + 'GetDeploymentPackage' => [ + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '269309', + 'abilityTreeNodes' => [ + 'FEATUREdide8FM783', + ], + ], + 'parameters' => [ + [ + 'name' => 'ProjectId', + 'in' => 'formData', + 'schema' => [ + 'description' => 'DataWorks工作空间的ID。'."\n" + .'您可以登录[DataWorks控制台](https://workbench.data.aliyun.com/console)，进入工作空间配置页面获取工作空间ID。'."\n" + .'该参数用来确定本次API调用操作使用的DataWorks工作空间。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'docRequired' => false, + 'example' => '10000', + ], + ], + [ + 'name' => 'ProjectIdentifier', + 'in' => 'formData', + 'schema' => [ + 'description' => 'DataWorks工作空间的唯一标识符，即数据开发页面顶部切换工作空间处的英文标识。'."\n" + ."\n\n" + .'该参数与ProjectId参数二者必须设置其一，以确定本次API调用操作的DataWorks工作空间。', + 'type' => 'string', + 'required' => false, + 'example' => 'dw_project', + ], + ], + [ + 'name' => 'DeploymentId', + 'in' => 'formData', + 'schema' => [ + 'description' => '发布包的ID。'."\n" + .'执行[SubmitFile](~~173944~~) 和[DeployFile](~~173956~~)时，都会生成一个对应的发布包ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + 'example' => '1000000001', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => [ + 'description' => 'HTTP 状态码'."\n" + .'。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'ErrorMessage' => [ + 'description' => '错误信息'."\n" + .'。', + 'type' => 'string', + 'example' => 'You have no permission.', + ], + 'RequestId' => [ + 'description' => '请求ID。用于定位日志，排查问题'."\n" + .'。', + 'type' => 'string', + 'example' => '0bc1ec92159376****', + ], + 'ErrorCode' => [ + 'description' => '错误码'."\n" + .'。', + 'type' => 'string', + 'example' => 'Invalid.Tenant.ConnectionNotExists', + ], + 'Success' => [ + 'description' => '是否调用成功。'."\n" + ."\n" + .'- **true**：调用成功。'."\n" + .'- **false**：调用失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Data' => [ + 'description' => '发布包的详情'."\n" + .'。', + 'type' => 'object', + 'properties' => [ + 'Deployment' => [ + 'description' => '发布包的详'."\n" + .'情。', + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => '发布包当前的状态'."\n" + .'，包括0（就绪）、1（成功）和2（失败）。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'ErrorMessage' => [ + 'description' => '当发布包执行失败（status为2）后，'."\n" + .'该字段记录具体的错误信息。', + 'type' => 'string', + 'example' => 'Success', + ], + 'FromEnvironment' => [ + 'description' => '执行本次发布所在的环境'."\n" + .'，包括0（本地）和1（开发环境）。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'ToEnvironment' => [ + 'description' => '发布文件信息的目标环境，'."\n" + .'包括1（开发环境）和2（生产环境）。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'CheckingStatus' => [ + 'description' => '当前发布包涉及节点的检查状态，'."\n" + .'当发布包的目标环境是开发环境（toEnviroment=1）时，只有发布包的Status为1并且CheckingStatus为空时，才可以继续进行文件到生产环境的发布。'."\n" + .'- 7：检查未通过'."\n" + .'- 8：正在处于检查中的状态', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '7', + ], + 'CreateTime' => [ + 'description' => '发布包生成的毫秒时间'."\n" + .'戳。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1593877765000', + ], + 'HandlerId' => [ + 'description' => '发布包执行者的阿里云用'."\n" + .'户ID。', + 'type' => 'string', + 'example' => '2003****', + ], + 'CreatorId' => [ + 'description' => '发布包创建者的阿里云'."\n" + .'用户ID。', + 'type' => 'string', + 'example' => '20030****', + ], + 'ExecuteTime' => [ + 'description' => '发布包开始执行的毫秒时'."\n" + .'间戳。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1593877765000', + ], + 'Name' => [ + 'description' => '发布包的名称，'."\n" + .'显示在任务发布>发布包列表页面。', + 'type' => 'string', + 'example' => 'ods_user_info_d-2020-07-04_20030****', + ], + ], + ], + 'DeployedItems' => [ + 'description' => '发布项详情。', + 'type' => 'array', + 'items' => [ + 'description' => '发布项详情。', + 'type' => 'object', + 'properties' => [ + 'FileId' => [ + 'description' => '文件的ID'."\n" + .'。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '5076****', + ], + 'FileVersion' => [ + 'description' => '文件的版本'."\n" + .'。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '7', + ], + 'Status' => [ + 'description' => '* UNPUBLISHED(0): 未发布'."\n" + ."\n" + .'* SUCCESS(1): 发布成功'."\n" + .'* ERROR(2): 发布失败'."\n" + .'* CLONED(3): 克隆成功'."\n" + .'* DEPLOY_ERROR(4): 发布失败'."\n" + .'* CLONING(5): 克隆中'."\n" + .'* REJECT(6): 发布驳回', + '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' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"ErrorMessage\\": \\"You have no permission.\\",\\n \\"RequestId\\": \\"0bc1ec92159376****\\",\\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}","type":"json"}]', + 'title' => '获取发布包的详情', + 'summary' => '调用GetDeploymentPackage获取发布包的详情。', + ], + 'ListDeploymentPackages' => [ + 'summary' => '查询发布包列表。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'abilityTreeCode' => '269317', + 'abilityTreeNodes' => [ + 'FEATUREdide8FM783', + ], + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'ProjectIdentifier', + 'in' => 'formData', + 'schema' => [ + 'description' => 'DataWorks工作空间的唯一标识符，'."\n" + .'即数据开发页面顶部切换工作空间处的英文标识。该参数与ProjectId参数二者必须设置其一，以确定本次API调用操作的DataWorks工作空间。', + 'type' => 'string', + 'required' => false, + 'example' => 'dw_project', + ], + ], + [ + 'name' => 'ProjectId', + 'in' => 'formData', + 'schema' => [ + 'description' => 'DataWorks工作空间的ID。'."\n" + .'您可以登录DataWorks管控台，进入工作空间配置页面获取工作空间ID。该参数与ProjectIdentifier参数，二者必须设置其一，用来确定本次API调用操作的DataWorks工作空间。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '10003', + ], + ], + [ + 'name' => 'Creator', + 'in' => 'formData', + 'schema' => [ + 'description' => '发布包创建者的阿里云账号UID。', + 'type' => 'string', + 'required' => false, + 'example' => '110755000425****', + ], + ], + [ + 'name' => 'EndCreateTime', + 'in' => 'formData', + 'schema' => [ + 'description' => '生成发布包的'."\n" + .'最大毫秒时间戳。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1593877765000', + ], + ], + [ + 'name' => 'Executor', + 'in' => 'formData', + 'schema' => [ + 'description' => '发布包执行者的阿里云账号UID。', + 'type' => 'string', + 'required' => false, + 'example' => '2003****', + ], + ], + [ + 'name' => 'EndExecuteTime', + 'in' => 'formData', + 'schema' => [ + 'description' => '发布包开始执行的'."\n" + .'最大毫秒时间戳。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1593877765000', + ], + ], + [ + 'name' => 'Status', + 'in' => 'formData', + 'schema' => [ + 'description' => '发布包当前的状态。取值如下：'."\n" + .'- 0：发布包已准备就绪。'."\n" + .'- 1：发布包发布成功。'."\n" + .'- 2：发布包发布失败。'."\n" + .'- 6：发布包被驳回。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'Keyword', + 'in' => 'formData', + 'schema' => [ + 'description' => '发布包名称的关键字。'."\n" + .'DataWorks支持模糊匹配，即输入关键字，即可查询包含该关键字的发布包。', + 'type' => 'string', + 'required' => false, + 'example' => 'abc', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'formData', + 'schema' => [ + 'description' => '分页的'."\n" + .'页码。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'formData', + 'schema' => [ + 'description' => '每页显示的条数，默认为10条，'."\n" + .'最大100条。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '100', + 'example' => '10', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '本次调用的唯一ID。', + 'type' => 'string', + 'example' => '952795279527ab****', + ], + 'Data' => [ + 'description' => '满足查询条件的发布包列表。', + 'type' => 'object', + 'properties' => [ + 'PageNumber' => [ + 'description' => '页码'."\n" + .'数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '每页的'."\n" + .'大小。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10', + ], + 'TotalCount' => [ + 'description' => '满足条件的'."\n" + .'数据总条数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '20', + ], + 'Deployments' => [ + 'description' => '返回的'."\n" + .'发布包列表。', + 'type' => 'array', + 'items' => [ + 'description' => '发布包的'."\n" + .'详细信息。', + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => '发布包当前的状态。取值如下：'."\n" + ."\n" + .'- 0：发布包已准备就绪。'."\n" + .'- 1：发布包发布成功。'."\n" + .'- 2：发布包发布失败。'."\n" + .'- 6：发布包被驳回。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'ErrorMessage' => [ + 'description' => '当发布包执行失败，'."\n" + .'该参数用于记录错误信息。', + 'type' => 'string', + 'example' => 'OK', + ], + 'CreateTime' => [ + 'description' => '发布包创建的'."\n" + .'时间戳。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1593877765000', + ], + 'Executor' => [ + 'description' => '发布包执行者的'."\n" + .'阿里云用户ID。', + 'type' => 'string', + 'example' => '2003****', + ], + 'Creator' => [ + 'description' => '发布包创建者的'."\n" + .'阿里云用户ID。', + 'type' => 'string', + 'example' => '2003****', + ], + 'ExecuteTime' => [ + 'description' => '执行发布包的'."\n" + .'时间戳。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1593877765000', + ], + 'Name' => [ + 'description' => '发布包的'."\n" + .'名称。', + 'type' => 'string', + 'example' => 'auto_created', + ], + 'Id' => [ + 'description' => '发布包的ID，'."\n" + .'您可以根据此ID调用[GetDeployment](~~173950~~)接口，获取发布包详情。', + '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' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"952795279527ab****\\",\\n \\"Data\\": {\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 20,\\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}","type":"json"}]', + 'title' => '查询发布包列表信息', + ], + 'ListDeploymentPackageFiles' => [ + 'summary' => '获取待发布的文件版本列表。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '270534', + 'abilityTreeNodes' => [ + 'FEATUREdide4AR6E0', + ], + ], + 'parameters' => [ + [ + 'name' => 'ProjectId', + 'in' => 'query', + 'schema' => [ + 'description' => 'DataWorks工作空间的ID。您可以登录[DataWorks控制台](https://workbench.data.aliyun.com/console)，进入工作空间配置页面获取工作空间ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '12345', + ], + ], + [ + 'name' => 'BusinessId', + 'in' => 'query', + 'schema' => [ + 'description' => '业务流程的ID，您可以调用[ListBusiness](~~173945~~)接口，根据名称查询对应业务流程的ID。'."\n" + ."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '100001', + ], + ], + [ + 'name' => 'SolutionId', + 'in' => 'query', + 'schema' => [ + 'description' => '解决方案ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '8065', + ], + ], + [ + 'name' => 'CommitFrom', + 'in' => 'query', + 'schema' => [ + 'description' => '提交起始日期，格式yyyy-MM-dd', + 'type' => 'string', + 'required' => false, + 'example' => '2025-01-01', + ], + ], + [ + 'name' => 'CommitTo', + 'in' => 'query', + 'schema' => [ + 'description' => '提交截止日期（包含），格式yyyy-MM-dd', + 'type' => 'string', + 'required' => false, + 'example' => '2025-01-31', + ], + ], + [ + 'name' => 'CommitUserId', + 'in' => 'query', + 'schema' => [ + 'description' => '提交人的用户ID', + 'type' => 'string', + 'required' => false, + 'example' => '2003****'."\n", + ], + ], + [ + 'name' => 'FileType', + 'in' => 'query', + 'schema' => [ + 'description' => '文件的代码类型。'."\n" + ."\n" + .'不同文件类型其代码不同，详情请参见[DataWorks节点合集](~~600169~~)。'."\n" + .'您也可以调用[ListFileType](~~212428~~)接口，查询文件的代码类型。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'ChangeType', + 'in' => 'query', + 'schema' => [ + 'description' => '变更类型 '."\n" + .'- 0：新增'."\n" + .'- 1：更新'."\n" + .'- 2：删除', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + ], + ], + [ + 'name' => 'FileIds', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '需要查询的文件ID列表。', + 'type' => 'array', + 'items' => [ + 'description' => '需要查询的文件ID。', + 'type' => 'string', + 'required' => false, + 'example' => '11223**', + ], + 'required' => false, + ], + ], + [ + 'name' => 'FileName', + 'in' => 'query', + 'schema' => [ + 'description' => '文件的名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'Filename', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '分页的页数。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '2147483647', + 'minimum' => '1', + 'example' => '1', + 'default' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '每页显示的条数，默认为10，最大100条。'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '100', + 'minimum' => '10', + 'example' => '20', + 'default' => '10', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。用于出现错误后排查问题。', + 'type' => 'string', + 'example' => '0000-ABCD-EFG****', + ], + 'PagingInfo' => [ + 'description' => '分页信息。', + 'type' => 'object', + 'properties' => [ + 'TotalCount' => [ + 'description' => '满足条件的数据总条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '100', + ], + 'PageNumber' => [ + 'description' => '分页页码，从1开始。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '分页大小，默认为10。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'DeploymentPackageFiles' => [ + 'description' => '具体的待发布的文件版本信息列表', + 'type' => 'array', + 'items' => [ + 'description' => '具体的待发布的文件版本信息', + 'type' => 'object', + 'properties' => [ + 'Id' => [ + 'description' => '唯一标识', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '650433503', + ], + 'FileId' => [ + 'description' => '文件的ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '520246913', + ], + 'FileVersion' => [ + 'description' => '文件的版本号', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '34', + ], + 'CommitTime' => [ + 'description' => '提交时间', + 'type' => 'string', + 'example' => '2025-04-10 15:55:47', + ], + 'CommitUser' => [ + 'description' => '提交人的阿里云账号ID', + 'type' => 'string', + 'example' => '446***', + ], + 'CommitUserName' => [ + 'description' => '提交人的阿里云账号名称', + 'type' => 'string', + 'example' => 'user***', + ], + 'ProjectId' => [ + 'description' => '工作空间ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '27595', + ], + 'TenantId' => [ + 'description' => 'DataWorks租户ID', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '639415964191360', + ], + 'FileType' => [ + 'description' => '文件类型。不同文件类型其代码不同，详情请参见[DataWorks节点合集](~~600169~~)。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '13', + ], + 'FileName' => [ + 'description' => '生成本次文件版本的文件名。'."\n", + 'type' => 'string', + 'example' => 'bak_part_basc_person_relation_all_da', + ], + 'Status' => [ + 'description' => '该版本的代码文件的状态 '."\n" + .'- 2：提交检查中'."\n" + .'- 3：提交检查成功'."\n" + .'- 4：提交检查拒绝'."\n" + .'- 10：提交中 '."\n" + .'- 11：已经提交至调度的开发 '."\n" + .'- 20：审核通过'."\n" + .'- 21：审核失败'."\n" + .'- 22：检查存在告警'."\n" + .'- 23：代码审核中'."\n" + .'- 24：代码审核拒绝'."\n" + .'- 80：创建发布包成功 '."\n" + .'- 100：发布中 '."\n" + .'- 101：发布至生产 '."\n" + .'- 200：取消', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '100', + ], + 'ChangeType' => [ + 'description' => 'Integer 变更类型 '."\n" + .'- 0：新增'."\n" + .'- 1：更新'."\n" + .'- 2：删除', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'IsSameAsProductionVersion' => [ + 'description' => '该版本是否是当前调度生产上的版本', + 'type' => 'boolean', + 'example' => 'true', + ], + 'NodeId' => [ + 'description' => '该文件对应的调度上的节点id', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '700005008419', + ], + 'Comment' => [ + 'description' => '提交时的注释', + 'type' => 'string', + 'example' => '测试提交', + ], + 'NodeConfiguration' => [ + 'description' => '保存该文件所在调度节点的调度属性配置信息（Json串的形式保存）', + 'type' => 'string', + 'example' => '{'."\n" + .' "tagList": [],'."\n" + .' "fileId": -1,'."\n" + .' "taskRerunTime": 0,'."\n" + .' "taskRerunInterval": 0,'."\n" + .' "reRunAble": 1,'."\n" + .' "nodeId": 125803000,'."\n" + .' "nodeName": "new",'."\n" + .' "nodeType": 0,'."\n" + .' "isStop": 0,'."\n" + .' "paraValue": "",'."\n" + .' "startEffectDate": "1970-01-01 00:00:00",'."\n" + .' "endEffectDate": "9999-01-01 00:00:00",'."\n" + .' "cronExpress": "00 26 00 * * ?",'."\n" + .' "owner": "1107550004250000",'."\n" + .' "resgroupId": 6300000,'."\n" + .' "cu": "0.25",'."\n" + .' "appId": 170000,'."\n" + .' "tenantId": 524257424560000,'."\n" + .' "createTime": "2025-04-10 15:55:01",'."\n" + .' "createUser": "1107550004250000",'."\n" + .' "lastModifyTime": "2025-04-10 15:55:41",'."\n" + .' "cycleType": 0,'."\n" + .' "dependentType": 0,'."\n" + .' "dependentTypeList": [0],'."\n" + .' "lastModifyUser": "1107550004250000",'."\n" + .' "dependentDataNode": "",'."\n" + .' "input": "[{\\"regionId\\":\\"cn-hangzhou\\",\\"str\\":\\"root_input\\",\\"parseType\\":1}]",'."\n" + .' "output": "[{\\"str\\":\\"project_root.526586287_out\\",\\"parseType\\":2},{\\"str\\":\\"project_root.new\\",\\"parseType\\":1}]",'."\n" + .' "inputList": [{'."\n" + .' "regionId": "cn-hangzhou",'."\n" + .' "str": "root_input",'."\n" + .' "parseType": 1'."\n" + .' }],'."\n" + .' "outputList": [{'."\n" + .' "str": "project_root.526586287_out",'."\n" + .' "parseType": 2'."\n" + .' }, {'."\n" + .' "str": "project_root.new",'."\n" + .' "parseType": 1'."\n" + .' }],'."\n" + .' "isAutoParse": 1,'."\n" + .' "startRightNow": false,'."\n" + .' "extConfig": "{\\"openCustomCron\\":false,\\"formCron\\":\\"\\"}",'."\n" + .' "inputContextList": [],'."\n" + .' "outputContextList": []'."\n" + .'}', + ], + 'UseType' => [ + 'description' => '文件所属的功能模块。取值如下：'."\n" + .'- NORMAL：数据开发。'."\n" + .'- MANUAL：手动任务。'."\n" + .'- MANUAL_BIZ：手动业务流程。'."\n" + .'- SKIP：数据开发的空跑调度。'."\n" + .'- ADHOCQUERY：临时查询。'."\n" + .'- COMPONENT：组件管理。', + 'type' => 'string', + 'example' => 'NORMAL', + ], + 'SmokeTestStatus' => [ + 'description' => '开发环境测试情况', + 'type' => 'string', + 'example' => '未测试', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0000-ABCD-EFG****\\",\\n \\"PagingInfo\\": {\\n \\"TotalCount\\": 100,\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"DeploymentPackageFiles\\": [\\n {\\n \\"Id\\": 650433503,\\n \\"FileId\\": 520246913,\\n \\"FileVersion\\": 34,\\n \\"CommitTime\\": \\"2025-04-10 15:55:47\\",\\n \\"CommitUser\\": \\"446***\\",\\n \\"CommitUserName\\": \\"user***\\",\\n \\"ProjectId\\": 27595,\\n \\"TenantId\\": 639415964191360,\\n \\"FileType\\": 13,\\n \\"FileName\\": \\"bak_part_basc_person_relation_all_da\\",\\n \\"Status\\": 100,\\n \\"ChangeType\\": 0,\\n \\"IsSameAsProductionVersion\\": true,\\n \\"NodeId\\": 700005008419,\\n \\"Comment\\": \\"测试提交\\",\\n \\"NodeConfiguration\\": \\"{\\\\n\\\\t\\\\\\"tagList\\\\\\": [],\\\\n\\\\t\\\\\\"fileId\\\\\\": -1,\\\\n\\\\t\\\\\\"taskRerunTime\\\\\\": 0,\\\\n\\\\t\\\\\\"taskRerunInterval\\\\\\": 0,\\\\n\\\\t\\\\\\"reRunAble\\\\\\": 1,\\\\n\\\\t\\\\\\"nodeId\\\\\\": 125803000,\\\\n\\\\t\\\\\\"nodeName\\\\\\": \\\\\\"new\\\\\\",\\\\n\\\\t\\\\\\"nodeType\\\\\\": 0,\\\\n\\\\t\\\\\\"isStop\\\\\\": 0,\\\\n\\\\t\\\\\\"paraValue\\\\\\": \\\\\\"\\\\\\",\\\\n\\\\t\\\\\\"startEffectDate\\\\\\": \\\\\\"1970-01-01 00:00:00\\\\\\",\\\\n\\\\t\\\\\\"endEffectDate\\\\\\": \\\\\\"9999-01-01 00:00:00\\\\\\",\\\\n\\\\t\\\\\\"cronExpress\\\\\\": \\\\\\"00 26 00 * * ?\\\\\\",\\\\n\\\\t\\\\\\"owner\\\\\\": \\\\\\"1107550004250000\\\\\\",\\\\n\\\\t\\\\\\"resgroupId\\\\\\": 6300000,\\\\n\\\\t\\\\\\"cu\\\\\\": \\\\\\"0.25\\\\\\",\\\\n\\\\t\\\\\\"appId\\\\\\": 170000,\\\\n\\\\t\\\\\\"tenantId\\\\\\": 524257424560000,\\\\n\\\\t\\\\\\"createTime\\\\\\": \\\\\\"2025-04-10 15:55:01\\\\\\",\\\\n\\\\t\\\\\\"createUser\\\\\\": \\\\\\"1107550004250000\\\\\\",\\\\n\\\\t\\\\\\"lastModifyTime\\\\\\": \\\\\\"2025-04-10 15:55:41\\\\\\",\\\\n\\\\t\\\\\\"cycleType\\\\\\": 0,\\\\n\\\\t\\\\\\"dependentType\\\\\\": 0,\\\\n\\\\t\\\\\\"dependentTypeList\\\\\\": [0],\\\\n\\\\t\\\\\\"lastModifyUser\\\\\\": \\\\\\"1107550004250000\\\\\\",\\\\n\\\\t\\\\\\"dependentDataNode\\\\\\": \\\\\\"\\\\\\",\\\\n\\\\t\\\\\\"input\\\\\\": \\\\\\"[{\\\\\\\\\\\\\\"regionId\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"cn-hangzhou\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"str\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"root_input\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"parseType\\\\\\\\\\\\\\":1}]\\\\\\",\\\\n\\\\t\\\\\\"output\\\\\\": \\\\\\"[{\\\\\\\\\\\\\\"str\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"project_root.526586287_out\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"parseType\\\\\\\\\\\\\\":2},{\\\\\\\\\\\\\\"str\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"project_root.new\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"parseType\\\\\\\\\\\\\\":1}]\\\\\\",\\\\n\\\\t\\\\\\"inputList\\\\\\": [{\\\\n\\\\t\\\\t\\\\\\"regionId\\\\\\": \\\\\\"cn-hangzhou\\\\\\",\\\\n\\\\t\\\\t\\\\\\"str\\\\\\": \\\\\\"root_input\\\\\\",\\\\n\\\\t\\\\t\\\\\\"parseType\\\\\\": 1\\\\n\\\\t}],\\\\n\\\\t\\\\\\"outputList\\\\\\": [{\\\\n\\\\t\\\\t\\\\\\"str\\\\\\": \\\\\\"project_root.526586287_out\\\\\\",\\\\n\\\\t\\\\t\\\\\\"parseType\\\\\\": 2\\\\n\\\\t}, {\\\\n\\\\t\\\\t\\\\\\"str\\\\\\": \\\\\\"project_root.new\\\\\\",\\\\n\\\\t\\\\t\\\\\\"parseType\\\\\\": 1\\\\n\\\\t}],\\\\n\\\\t\\\\\\"isAutoParse\\\\\\": 1,\\\\n\\\\t\\\\\\"startRightNow\\\\\\": false,\\\\n\\\\t\\\\\\"extConfig\\\\\\": \\\\\\"{\\\\\\\\\\\\\\"openCustomCron\\\\\\\\\\\\\\":false,\\\\\\\\\\\\\\"formCron\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"\\\\\\\\\\\\\\"}\\\\\\",\\\\n\\\\t\\\\\\"inputContextList\\\\\\": [],\\\\n\\\\t\\\\\\"outputContextList\\\\\\": []\\\\n}\\",\\n \\"UseType\\": \\"NORMAL\\",\\n \\"SmokeTestStatus\\": \\"未测试\\"\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => '获取待发布的文件版本列表', + ], + 'GetFileVersion' => [ + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '269314', + 'abilityTreeNodes' => [ + 'FEATUREdide8FM783', + ], + ], + 'parameters' => [ + [ + 'name' => 'FileId', + 'in' => 'formData', + 'schema' => [ + 'description' => '文件的ID，您可以通过[ListFiles](~~173942~~)查询对应文件的ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + 'example' => '1000001', + ], + ], + [ + 'name' => 'ProjectId', + 'in' => 'formData', + 'schema' => [ + 'description' => 'DataWorks工作空间的ID，您可以单击页面右上角的小扳手图标，进入工作空间管理页面查看。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'docRequired' => false, + 'example' => '1000011', + ], + ], + [ + 'name' => 'ProjectIdentifier', + 'in' => 'formData', + 'schema' => [ + 'description' => 'DataWorks工作空间的唯一标识符，即数据开发页面顶部切换工作空间处的英文标识。'."\n" + ."\n" + .'该参数与ProjectId参数二者必须设置其一，以确定本次API调用操作的DataWorks工作空间。', + 'type' => 'string', + 'required' => false, + 'example' => 'dw_project', + ], + ], + [ + 'name' => 'FileVersion', + 'in' => 'formData', + 'schema' => [ + 'description' => '需要查询的文件版本。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'docRequired' => true, + 'example' => '2', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => [ + 'description' => 'HTTP状态码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'ErrorMessage' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'The connection does not exist.', + ], + 'RequestId' => [ + 'description' => '本次调用的唯一ID。出现错误后，您可以根据该ID排查问题。', + 'type' => 'string', + 'example' => '0000-ABCD-EFG****', + ], + 'ErrorCode' => [ + 'description' => '错误码。', + 'type' => 'string', + 'example' => 'Invalid.Tenant.ConnectionNotExists', + ], + 'Success' => [ + 'description' => '调用是否成功。'."\n" + .'- true：成功。'."\n" + .'- false：失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Data' => [ + 'description' => '文件的版本详情。', + 'type' => 'object', + 'properties' => [ + 'FileContent' => [ + 'description' => '生成本次文件版本的文件代码。', + 'type' => 'string', + 'example' => 'SHOW TABLES;', + ], + 'IsCurrentProd' => [ + 'description' => '本次文件版本是否为当前生产环境的最新版本。'."\n" + .'- true：是最新版本。'."\n" + .'- false：不是最新版本。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Status' => [ + 'description' => '文件版本当前的状态，取值如下：'."\n" + .'- COMMITTING（提交中）'."\n" + .'- COMMITTED或CHECK_OK（已提交）'."\n" + .'- PACKAGED（准备发布）'."\n" + .'- DEPLOYING（发布中）'."\n" + .'- DEPLOYED（已发布）'."\n" + .'- CANCELLED（取消发布）', + 'type' => 'string', + 'example' => 'COMMITTED', + ], + 'NodeContent' => [ + 'description' => '本次文件版本生成时的调度配置。', + 'type' => 'string', + 'example' => '{"cycleType":0,"cronExpress":"00 05 00 * * ?"}', + ], + 'CommitUser' => [ + 'description' => '生成本次文件版本的阿里云用户ID。', + 'type' => 'string', + 'example' => ' '."\n" + .'7384234****'."\n", + ], + 'Comment' => [ + 'description' => '本次文件版本的说明。', + 'type' => 'string', + 'example' => 'Second version submission', + ], + 'FilePropertyContent' => [ + 'description' => '生成本次文件版本的文件基本信息。', + 'type' => 'string', + 'example' => '{"fileName":"ods_user_info_d","fileType":10}', + ], + 'FileName' => [ + 'description' => '生成本次文件版本的文件名。', + 'type' => 'string', + 'example' => 'ods_user_info_d', + ], + 'UseType' => [ + 'description' => '文件所属的功能模块，取值如下：'."\n" + .'- 0：NORMAL（数据开发）'."\n" + .'- 1：MANUAL（手动任务）'."\n" + .'- 2：MANUAL_BIZ（手动工作流）'."\n" + .'- 3：SKIP（数据开发的空跑调度）'."\n" + .'- 10：ADHOCQUERY（临时查询）'."\n" + .'- 30：COMPONENT（组件管理）'."\n", + 'type' => 'string', + 'example' => '0', + ], + 'ChangeType' => [ + 'description' => '本次文件版本的变更类型，包括CREATE、UPDATE和DELETE。', + 'type' => 'string', + 'example' => 'UPDATE', + ], + 'FileVersion' => [ + 'description' => '文件的版本。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'CommitTime' => [ + 'description' => '文件版本生成的毫秒时间戳。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1593881265000', + ], + 'NodeId' => [ + 'description' => '文件版本生成时对应的调度任务ID。', + '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' => '[{"errorExample":"","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\\": \\"\\\\t\\\\n7384234****\\\\n\\",\\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}","type":"json"}]', + 'title' => '获取文件的版本详情', + 'summary' => '调用GetFileVersion获取文件的版本详情。', + ], + 'ListFileVersions' => [ + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '269312', + 'abilityTreeNodes' => [ + 'FEATUREdide8FM783', + ], + ], + 'parameters' => [ + [ + 'name' => 'FileId', + 'in' => 'formData', + 'schema' => [ + 'description' => '文件的ID，'."\n" + .'您可以通过[ListFiles](~~173942~~)查询对应文件的ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + 'example' => '100000001', + ], + ], + [ + 'name' => 'ProjectId', + 'in' => 'formData', + 'schema' => [ + 'description' => 'DataWorks工作空间的ID，'."\n" + .'您可以单击页面右上角的小扳手图标，进入工作空间管理页面查看。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'docRequired' => false, + 'example' => '100001', + ], + ], + [ + 'name' => 'ProjectIdentifier', + 'in' => 'formData', + 'schema' => [ + 'description' => 'DataWorks工作空间的唯一标识符，即数据开发页面顶部切换工作空间处的英文标识。'."\n" + ."\n\n" + .'该参数与ProjectId参数二者必须设置其一，以确定本次API调用操作的DataWorks工作空间。', + 'type' => 'string', + 'required' => false, + 'example' => 'dw_project', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'formData', + 'schema' => [ + 'description' => '请求的数据页数，'."\n" + .'用于翻页。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'minimum' => '1', + 'example' => '1', + 'default' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'formData', + 'schema' => [ + 'description' => '每页显示的条数，默认为10条，'."\n" + .'最大100条。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'docRequired' => false, + 'maximum' => '100', + 'minimum' => '0', + 'example' => '10', + 'default' => '10', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回结果'."\n" + .'。', + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => [ + 'description' => 'HTTP状态码'."\n" + .'。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'ErrorMessage' => [ + 'description' => '错误信息'."\n" + .'。', + 'type' => 'string', + 'example' => 'The connection does not exist.', + ], + 'RequestId' => [ + 'description' => '请求ID'."\n" + .'。', + 'type' => 'string', + 'example' => '0000-ABCD-EFG****', + ], + 'ErrorCode' => [ + 'description' => '错误码'."\n" + .'。', + 'type' => 'string', + 'example' => 'Invalid.Tenant.ConnectionNotExists', + ], + 'Success' => [ + 'description' => '调用是否成功。取值如下：'."\n" + ."\n" + .'- true：调用成功。'."\n" + .'- false：调用失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Data' => [ + 'description' => '文件的版本列表'."\n" + .'。', + 'type' => 'object', + 'properties' => [ + 'PageNumber' => [ + 'description' => '当前数据页的页码'."\n" + .'。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '当前数据页的大小'."\n" + .'。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'TotalCount' => [ + 'description' => '满足查询条件的数据总条数'."\n" + .'。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '13', + ], + 'FileVersions' => [ + 'description' => '文件的版本详情列表'."\n" + .'。', + 'type' => 'array', + 'items' => [ + 'description' => '文件的版本详情'."\n" + .'。', + 'type' => 'object', + 'properties' => [ + 'FileContent' => [ + 'description' => '生成本次文件版本的文件代码'."\n" + .'。', + 'type' => 'string', + 'example' => 'SHOW TABLES;', + ], + 'Status' => [ + 'description' => '文件版本当前的状态，'."\n" + .'包括COMMITTING（提交中）、COMMITTED或CHECK_OK（已提交）、PACKAGED（准备发布）、DEPLOYING（发布中）、DEPLOYED（已发布）和CANCELLED（取消发布）。', + 'type' => 'string', + 'example' => 'COMMITTED', + ], + 'IsCurrentProd' => [ + 'description' => '本次文件版本是否为当前生产环境的最新版本。'."\n" + ."\n" + .'- true：是最新版本。'."\n" + .'- false：不是最新版本。', + 'type' => 'boolean', + 'example' => 'false', + ], + 'CommitUser' => [ + 'description' => '生成本次文件版本的阿里云用户ID'."\n" + .'。', + 'type' => 'string', + 'example' => '73842342****'."\n", + ], + 'NodeContent' => [ + 'description' => '生成本次文件版本的调度配置'."\n" + .'。', + 'type' => 'string', + 'example' => '{"cycleType":0,"cronExpress":"00 05 00 * * ?"}', + ], + 'Comment' => [ + 'description' => '本次文件版本的说明'."\n" + .'。', + 'type' => 'string', + 'example' => 'Second version submission', + ], + 'FilePropertyContent' => [ + 'description' => '生成本次文件版本的文本基本信息'."\n" + .'。', + 'type' => 'string', + 'example' => '{"fileName":"ods_user_info_d","fileType":10}', + ], + 'FileName' => [ + 'description' => '生成本次文件版本的文件名'."\n" + .'。', + 'type' => 'string', + 'example' => 'ods_user_info_d', + ], + 'UseType' => [ + 'description' => '文件所属的功能模块，'."\n" + .'包括NORMAL（数据开发）、MANUAL（手动任务）、MANUAL_BIZ（手动工作流）、SKIP（数据开发的空跑调度）、ADHOCQUERY（临时查询）和COMPONENT（组件管理）。', + 'type' => 'string', + 'example' => 'NORMAL', + ], + 'ChangeType' => [ + 'description' => '本次文件版本的变更类型，包括CREATE、UPDATE和DELETE'."\n" + .'。', + 'type' => 'string', + 'example' => 'UPDATE', + ], + 'FileVersion' => [ + 'description' => '文件的版本'."\n" + .'。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'CommitTime' => [ + 'description' => '生成文件版本的毫秒时间戳'."\n" + .'。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1593881265000', + ], + 'NodeId' => [ + 'description' => '生成文件版本时对应的调度任务ID'."\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.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 \\"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\\",\\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}","type":"json"}]', + 'title' => '查询文件的版本列表', + 'summary' => '调用ListFileVersions查询文件的版本列表。', + ], + 'UpdateIDEEventResult' => [ + 'summary' => '回调扩展点消息的检查结果。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '269315', + 'abilityTreeNodes' => [ + 'FEATUREdide6ZPSGN', + ], + ], + 'parameters' => [ + [ + 'name' => 'MessageId', + 'in' => 'formData', + 'schema' => [ + 'title' => '消息UUID', + 'description' => 'DataWorks开放消息的消息ID。当触发扩展点事件后，您可以从接收到的事件消息中获取消息ID。'."\n" + ."\n\n" + .'<props="china">消息格式，可参考[消息格式](~~215367~~)。</props>', + 'type' => 'string', + 'required' => false, + 'example' => '8abcb91f-d266-4073-b907-2ed670378ed1', + ], + ], + [ + 'name' => 'ExtensionCode', + 'in' => 'formData', + 'schema' => [ + 'description' => '扩展程序的唯一标识。'."\n" + .'您可以登录[DataWorks控制台](https://workbench.data.aliyun.com/console)，进入开放平台的Extensions页签查看标识。', + 'type' => 'string', + 'required' => false, + 'example' => '8abcb91f-d266-4073-b907-2ed670378ed1', + ], + ], + [ + 'name' => 'CheckResult', + 'in' => 'formData', + 'schema' => [ + 'description' => '扩展程序对本次扩展点事件的检查状态。取值如下：'."\n" + ."\n" + .'- OK：扩展程序对本次扩展点事件检查通过。'."\n" + .'- FAIL：扩展程序对本次扩展点事件检查不通过。您需要查看并及时处理报错，以免影响后续程序的正常执行。'."\n" + .'- WARN：扩展程序对本次扩展点事件检查通过，但存在警告。', + 'type' => 'string', + 'required' => false, + 'example' => 'OK', + ], + ], + [ + 'name' => 'CheckResultTip', + 'in' => 'formData', + 'schema' => [ + 'description' => '扩展程序对本次扩展点事件进行检查的摘要信息。'."\n" + .'该信息会显示在您当前的开发页面上，当本次检查存在警告或者检查不通过时，您可以通过该摘要信息快速定位原因。', + 'type' => 'string', + 'required' => false, + 'example' => 'Succeeded', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求的唯一标识，'."\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' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"8abcb91f-d266-4073-b907-2ed670378ed1\\"\\n}","type":"json"}]', + 'title' => '更新扩展点事件的检查结果', + ], + 'GetIDEEventDetail' => [ + 'summary' => '根据DataWorks开放消息的消息ID，查询触发扩展点事件时的扩展点数据快照。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '269311', + 'abilityTreeNodes' => [ + 'FEATUREdide8FM783', + ], + ], + 'parameters' => [ + [ + 'name' => 'MessageId', + 'in' => 'formData', + 'schema' => [ + 'description' => 'DataWorks开放消息的消息ID。当触发扩展点事件后，您可以从接收到的事件消息中获取消息ID。'."\n" + ."\n" + .'<props="china">消息格式，可参考[消息格式](~~215367~~)。</props>'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '8abcb91f-d266-4073-b907-2ed67****1', + ], + ], + [ + 'name' => 'ProjectId', + 'in' => 'formData', + 'schema' => [ + 'description' => 'DataWorks工作空间的ID，您可以通过解析DataWorks开放消息获取空间ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '10000', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求的唯一标识，用于后续错误排查使用。', + 'type' => 'string', + 'example' => '8abcb91f-d266-4073-b907-2ed670378ed1', + ], + 'EventDetail' => [ + 'description' => '触发扩展点事件时的数据快照。'."\n" + ."\n" + .'不同类型的消息事件，数据快照的有效字段存在差异，具体请参考各消息事件的字段说明。', + 'type' => 'object', + 'properties' => [ + 'FileExecutionCommand' => [ + 'description' => '文件代码执行时的快照，当Message类型为IDE_FILE_EXECUTE_BEFORE时有效。', + 'type' => 'object', + 'properties' => [ + 'FileId' => [ + 'description' => '文件的ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1234123', + ], + 'DataSourceName' => [ + 'description' => '文件关联的数据源唯一标识。', + 'type' => 'string', + 'example' => 'odps_source', + ], + 'Content' => [ + 'description' => '生成本次文件版本的文件代码。', + 'type' => 'string', + 'example' => 'SHOW TABLES;', + ], + 'FileType' => [ + 'description' => '文件类型。不同文件类型其代码不同，详情请参见[DataWorks节点合集](~~600169~~)。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10', + ], + ], + ], + 'DeletedFile' => [ + 'description' => '删除文件时的快照信息，当Message类型为IDE_FILE_DELETE_BEFORE时有效。', + 'type' => 'object', + 'properties' => [ + 'Owner' => [ + 'description' => '文件责任人。', + 'type' => 'string', + 'example' => '7384234****', + ], + 'FileType' => [ + 'description' => '文件类型。不同文件类型其代码不同，详情请参见[DataWorks节点合集](~~600169~~)。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10', + ], + 'CurrentVersion' => [ + 'description' => '当前文件的最新版本。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'BusinessId' => [ + 'description' => '文件所属的业务流程ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '74328', + ], + 'FileName' => [ + 'description' => '文件名称。', + 'type' => 'string', + 'example' => 'hello_dataworks.sql', + ], + 'DataSourceName' => [ + 'description' => '文件关联的数据源唯一标识。', + 'type' => 'string', + 'example' => 'odps_source', + ], + 'UseType' => [ + 'description' => '文件所属的功能模块。取值如下：'."\n" + .'- NORMAL：数据开发'."\n" + .'- MANUAL：手动任务'."\n" + .'- MANUAL_BIZ：手动业务流程'."\n" + .'- SKIP：数据开发的空跑调度'."\n" + .'- ADHOCQUERY：临时查询'."\n" + .'- COMPONENT：组件管理', + 'type' => 'string', + 'example' => 'NORMAL', + ], + 'FolderId' => [ + 'description' => '文件所属的文件夹ID，您可以调用[GetFolder](~~173952~~)接口，通过文件夹ID查询文件详情。', + 'type' => 'string', + 'example' => 'aldurie78l2falure', + ], + 'ParentFileId' => [ + 'description' => '文件所属的循环节点或遍历节点的节点ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1234122', + ], + 'Content' => [ + 'description' => '生成本次文件版本的文件代码。', + 'type' => 'string', + 'example' => 'SHOW TABLES;', + ], + 'NodeId' => [ + 'description' => '调度节点的ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '421429', + ], + 'FileId' => [ + 'description' => '文件的ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1234123', + ], + ], + ], + 'CommittedFile' => [ + 'description' => '文件提交和发布时的快照。'."\n" + ."\n" + .'仅当Message类型为IDE_FILE_SUBMIT_BEFORE或IDE_FILE_DEPLOY_BEFORE时有效。', + 'type' => 'object', + 'properties' => [ + 'FileId' => [ + 'description' => '文件的ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1234123', + ], + 'Content' => [ + 'description' => '生成本次文件版本的文件代码。', + 'type' => 'string', + 'example' => 'SHOW TABLES;', + ], + 'Committor' => [ + 'description' => '生成本次文件版本的阿里云用户ID。', + 'type' => 'string', + 'example' => '7384234****', + ], + 'FileType' => [ + 'description' => '文件类型。不同文件类型其代码不同，详情请参见[DataWorks节点合集](~~600169~~)。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10', + ], + 'ChangeType' => [ + 'description' => '本次文件版本的变更类型，包括CREATE、UPDATE和DELETE。', + 'type' => 'string', + 'example' => 'UPDATE', + ], + 'FileName' => [ + 'description' => '文件名称。', + 'type' => 'string', + 'example' => 'hello_dataworks.sql', + ], + 'NodeId' => [ + 'description' => '调度节点的ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '421429', + ], + 'Comment' => [ + 'description' => '本次文件版本的说明。', + 'type' => 'string', + 'example' => 'Second version submission', + ], + 'UseType' => [ + 'description' => '文件所属的功能模块。取值如下：'."\n" + .'- NORMAL：数据开发'."\n" + .'- MANUAL：手动任务'."\n" + .'- MANUAL_BIZ：手动业务流程'."\n" + .'- SKIP：数据开发的空跑调度'."\n" + .'- ADHOCQUERY：临时查询'."\n" + .'- COMPONENT：组件管理', + 'type' => 'string', + 'example' => 'NORMAL', + ], + 'FilePropertyContent' => [ + 'description' => '文件的更多属性。', + 'type' => 'object', + 'properties' => [ + 'DataSourceName' => [ + 'description' => '文件关联的数据源唯一标识。', + 'type' => 'string', + 'example' => 'odps_source', + ], + 'ParentFileId' => [ + 'description' => '文件所属的循环节点或遍历节点的节点ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1234122', + ], + 'BusinessId' => [ + 'description' => '文件所属的业务流程ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '74328', + ], + 'CurrentVersion' => [ + 'description' => '当前文件的最新版本。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'Owner' => [ + 'description' => '文件责任人。', + 'type' => 'string', + 'example' => '7384234****', + ], + 'FolderId' => [ + 'description' => '文件所属的文件夹ID，您可以调用[GetFolder](~~173952~~)接口，通过文件夹ID查询文件详情。', + 'type' => 'string', + 'example' => 'aldurie78l2falure', + ], + ], + ], + 'NodeConfiguration' => [ + 'description' => '文件的调度属性配置。', + 'type' => 'object', + 'properties' => [ + 'RerunMode' => [ + 'description' => '重跑属性。取值如下：'."\n" + .'- ALL_ALLOWED：运行成功或失败后皆可重跑。'."\n" + .'- FAILURE_ALLOWED：运行成功后不可重跑，运行失败后可以重跑。'."\n" + .'- ALL_DENIED：运行成功或失败皆不可重跑。'."\n" + ."\n" + .'该参数与[DataWorks控制台](https://workbench.data.aliyun.com/console)中，数据开发任务的“调度配置>时间属性>重跑属性”配置内容对应。', + 'type' => 'string', + 'example' => 'ALL_ALLOWED', + ], + 'SchedulerType' => [ + 'description' => '调度的类型，取值如下：'."\n" + .'- NORMAL：正常调度任务。'."\n" + .'- MANUAL：手动任务，不会被日常调度，对应手动业务流程下的节点。'."\n" + .'- PAUSE：暂停任务。'."\n" + .'- SKIP：空跑任务，被日常调度，但启动调度时直接被置为成功。', + 'type' => 'string', + 'example' => 'NORMAL', + ], + 'ParaValue' => [ + 'description' => '调度参数。'."\n" + ."\n" + .'该参数与[DataWorks控制台](https://workbench.data.aliyun.com/console)中，数据开发任务的“调度配置>参数”对应。您可以参考[调度参数](~~137548~~)配置。', + 'type' => 'string', + 'example' => 'a=x b=y', + ], + 'CycleType' => [ + 'description' => '调度周期的类型，包括NOT_DAY（分钟、小时）和DAY（日、周、月）。'."\n" + ."\n" + .'该参数与[DataWorks控制台](https://workbench.data.aliyun.com/console)中，数据开发任务的“调度配置>时间属性>调度周期”对应。', + 'type' => 'string', + 'example' => 'DAY', + ], + 'DependentNodeIdList' => [ + 'description' => '当DependentType参数配置为USER_DEFINE时，用于设置当前文件具体依赖的节点ID。依赖多个节点时，使用英文逗号（,）分隔。'."\n" + ."\n" + .'该参数与[DataWorks控制台](https://workbench.data.aliyun.com/console)中，数据开发任务的“调度配置>调度依赖>跨周期依赖（原上一周期）”，依赖项选择”其他节点“时配置的内容对应。', + 'type' => 'string', + 'example' => '5,10,15,20', + ], + 'ResourceGroupId' => [ + 'description' => '文件发布成任务后，任务执行时使用的资源组。您可以调用[ListResourceGroups](~~173913~~)获取工作空间可用的资源组列表。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '375827434852437', + ], + 'AutoRerunTimes' => [ + 'description' => '自动重跑次数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '3', + ], + 'AutoRerunIntervalMillis' => [ + 'description' => '自动重跑间隔毫秒数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '120000', + ], + 'CronExpress' => [ + 'description' => '调度Cron表达式。', + 'type' => 'string', + 'example' => '00 05 00 * * ?', + ], + 'InputList' => [ + 'description' => '依赖的上游文件输出信息。', + 'type' => 'array', + 'items' => [ + 'description' => '依赖的上游文件输出信息。', + 'type' => 'object', + 'properties' => [ + 'Input' => [ + 'description' => '文件依赖的上游文件的输出名称。'."\n" + ."\n" + .'该参数与[DataWorks控制台](https://workbench.data.aliyun.com/console)中，数据开发任务的“调度配置>调度依赖>依赖上游节点“的”上游节点输出名”对应。', + 'type' => 'string', + 'example' => 'dw_project_root', + ], + 'ParseType' => [ + 'description' => '配置文件依赖的方式，取值如下：'."\n" + .'- MANUAL：手动配置。'."\n" + .'- AUTO：自动解析。', + 'type' => 'string', + 'example' => 'MANUAL', + ], + ], + ], + ], + 'OutputList' => [ + 'description' => '文件的输出信息。', + 'type' => 'array', + 'items' => [ + 'description' => '文件的输出信息。', + 'type' => 'object', + 'properties' => [ + 'RefTableName' => [ + 'description' => '文件的输出表名。'."\n" + ."\n" + .'该参数与[DataWorks控制台](https://workbench.data.aliyun.com/console)中，数据开发任务的“调度配置>调度依赖>本节点输出名称“的“输出表名”对应。', + 'type' => 'string', + 'example' => 'ods_user_info_d', + ], + 'Output' => [ + 'description' => '文件的输出名称。'."\n" + ."\n" + .'该参数与[DataWorks控制台](https://workbench.data.aliyun.com/console)中，数据开发任务的“调度配置>调度依赖>本节点输出名称“的“输出名”对应。', + 'type' => 'string', + 'example' => 'dw_project.002_out', + ], + ], + ], + ], + 'DependentType' => [ + 'description' => '依赖上一周期的方式。取值如下：'."\n" + .'- SELF：依赖项选择本节点。'."\n" + .'- CHILD：依赖项选择一级子节点。'."\n" + .'- USER_DEFINE：依赖项选择其他节点。'."\n" + .'- NONE：未选择依赖项，即不会依赖上一周期。'."\n", + 'type' => 'string', + 'example' => 'USER_DEFINE', + ], + ], + ], + ], + ], + 'TableModel' => [ + 'description' => '表提交和发布时的快照，当Message类型为IDE_TABLE_SUBMIT_BEFORE和IDE_TABLE_DEPLOY_BEFORE时有效。', + 'type' => 'object', + 'properties' => [ + 'Env' => [ + 'description' => '表所属环境。取值如下：'."\n" + .'- DEV：开发环境。'."\n" + .'- PROD：生产环境。', + 'type' => 'string', + 'example' => 'DEV', + ], + 'LifeCycle' => [ + 'description' => '表的生命周期。单位为天。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '7', + ], + 'TableName' => [ + 'description' => '表名称。', + 'type' => 'string', + 'example' => 'tb_hello', + ], + 'DataSourceName' => [ + 'description' => '表所属数据源的唯一标识。', + 'type' => 'string', + 'example' => 'odps_source', + ], + 'Columns' => [ + 'description' => '字段信息。', + 'type' => 'array', + 'items' => [ + 'description' => '字段信息。', + 'type' => 'object', + 'properties' => [ + 'ColumnName' => [ + 'description' => '字段名称。', + 'type' => 'string', + 'example' => 'ID', + ], + 'ColumnType' => [ + 'description' => '字段类型。', + 'type' => 'string', + 'example' => 'BIGINT', + ], + 'IsPartitionColumn' => [ + 'description' => '是否为分区字段，取值如下：'."\n" + .'- true：是分区字段。'."\n" + .'- false：非分区字段。', + 'type' => 'boolean', + 'example' => 'false', + ], + 'Comment' => [ + 'description' => '字段备注。', + 'type' => 'string', + 'example' => 'ID', + ], + ], + ], + ], + 'Comment' => [ + 'description' => '表的备注信息。', + 'type' => 'string', + 'example' => 'A new table', + ], + 'Location' => [ + 'description' => '外部表的Location信息。', + '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' => '[{"errorExample":"","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}","type":"json"}]', + 'title' => '查询触发扩展点事件时的数据快照', + ], + 'EstablishRelationTableToBusiness' => [ + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '269310', + 'abilityTreeNodes' => [ + 'FEATUREdideEPPSOE', + ], + ], + 'parameters' => [ + [ + 'name' => 'ProjectId', + 'in' => 'formData', + 'schema' => [ + 'description' => 'DataWorks工作空间的ID，'."\n" + .'您可以单击页面右上角的小扳手图标，进入工作空间管理页面查看。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'docRequired' => false, + 'example' => '10000', + ], + ], + [ + 'name' => 'ProjectIdentifier', + 'in' => 'formData', + 'schema' => [ + 'description' => 'DataWorks工作空间的唯一标识符，即数据开发页面顶部切换工作空间处的英文标识。'."\n" + ."\n\n" + .'该参数与ProjectId参数二者必须设置其一，以确定本次API调用操作的DataWorks工作空间。', + 'type' => 'string', + 'required' => false, + 'example' => 'dw', + ], + ], + [ + 'name' => 'BusinessId', + 'in' => 'formData', + 'schema' => [ + 'description' => '业务流程的ID，'."\n" + .'您可以使用[ListBusiness](~~173945~~)获取对应业务流程的ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '1000001', + ], + ], + [ + 'name' => 'TableGuid', + 'in' => 'formData', + 'schema' => [ + 'description' => '表的UUID，'."\n" + .'您可以通过[SearchMetaTables](~~173919~~)获取对应表的UUID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'odps.dw_project.tb1', + ], + ], + [ + 'name' => 'FolderId', + 'in' => 'formData', + 'schema' => [ + 'description' => '文件夹的ID，'."\n" + .'您可以使用[GetFolder](~~173952~~)或者[ListFolders](~~173955~~)获取对应文件夹的ID。', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => '2eb6f9****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => [ + 'description' => 'HTTP状态码'."\n" + .'。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'ErrorMessage' => [ + 'description' => '错误信息'."\n" + .'。', + 'type' => 'string', + 'example' => 'The connection does not exist.', + ], + 'RequestId' => [ + 'description' => '本次调用的唯一ID。出现错误后，您可以根据该ID排查问题'."\n" + .'。', + 'type' => 'string', + 'example' => '0000-ABCD-EFG', + ], + 'ErrorCode' => [ + 'description' => '错误码'."\n" + .'。', + 'type' => 'string', + 'example' => 'Invalid.Tenant.ConnectionNotExists', + ], + 'Success' => [ + 'description' => '请求是否成功。取值如下：'."\n" + ."\n" + .'- true：成功。'."\n" + .'- false：失败。', + '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' => '[{"errorExample":"","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}","type":"json"}]', + 'title' => '导入表至业务流程', + 'summary' => '相当于在数据开发页面右键单击业务流程，选择导入表的操作。', + ], + 'CreateDIJob' => [ + 'summary' => '创建数据集成新版任务。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'paid', + 'abilityTreeCode' => '234097', + 'abilityTreeNodes' => [ + 'FEATUREdideBP0OJZ', + ], + ], + 'parameters' => [ + [ + 'name' => 'DestinationDataSourceType', + 'in' => 'query', + 'schema' => [ + 'description' => '目标端数据源类型，枚举值：Hologres，OSS-HDFS，OSS，MaxCompute，LogHub，StarRocks，DataHub，AnalyticDB_For_MySQL，Kafka，Hive。', + 'type' => 'string', + 'required' => true, + 'example' => 'Hologres', + ], + ], + [ + 'name' => 'Description', + 'in' => 'formData', + 'schema' => [ + 'description' => '任务的描述', + 'type' => 'string', + 'required' => false, + 'example' => 'DI Job Demo', + ], + ], + [ + 'name' => 'SourceDataSourceType', + 'in' => 'query', + 'schema' => [ + 'description' => '源端数据源类型，枚举值： PolarDB，MySQL，Kafka，LogHub，Hologres，Oracle，OceanBase，MongoDB，RedShift，Hive，SQLServer，Doris，ClickHouse。', + 'type' => 'string', + 'required' => true, + 'example' => 'MySQL', + ], + ], + [ + 'name' => 'ProjectId', + 'in' => 'query', + 'schema' => [ + 'description' => 'DataWorks工作空间的ID。您可以登录[DataWorks控制台](https://workbench.data.aliyun.com/console)，进入工作空间管理页面获取ID。'."\n" + ."\n" + .'该参数用来确定本次API调用操作使用的DataWorks工作空间。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '10000', + ], + ], + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => [ + 'description' => '任务名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'mysql_to_holo_sync_8772', + ], + ], + [ + 'name' => 'MigrationType', + 'in' => 'query', + 'schema' => [ + 'description' => '同步类型，可选的枚举值有：'."\n" + .'- FullAndRealtimeIncremental（全量和实时增量，整库实时）'."\n" + .'- RealtimeIncremental（实时增量，单表实时）'."\n" + .'- Full（全量，整库离线）'."\n" + .'- OfflineIncremental（离线增量，整库离线）'."\n" + .'- FullAndOfflineIncremental（全量+离线增量，整库离线）', + 'type' => 'string', + 'required' => true, + 'example' => 'FullAndRealtimeIncremental', + ], + ], + [ + 'name' => 'JobType', + 'in' => 'query', + 'schema' => [ + 'description' => '任务类型，可选'."\n" + ."\n" + .' - DatabaseRealtimeMigration(整库实时):将源端多个库的多个表进行流同步，支持仅全量，仅增量，或全量+增量。'."\n" + ."\n" + .' - DatabaseOfflineMigration(整库离线):将源端多个库的多个表进行批同步，支持仅全量，仅增量，或全量+增量。'."\n" + ."\n" + .' - SingleTableRealtimeMigration(单表实时):将源端单个表进行流同步', + 'type' => 'string', + 'required' => false, + 'example' => 'DatabaseRealtimeMigration', + ], + ], + [ + 'name' => 'SourceDataSourceSettings', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'description' => '源端数据源设置列表', + 'type' => 'array', + 'items' => [ + 'description' => '单个源端数据源设置', + 'type' => 'object', + 'properties' => [ + 'DataSourceName' => [ + 'description' => '数据源名称', + 'type' => 'string', + 'required' => false, + 'example' => 'mysql_datasource_1', + ], + 'DataSourceProperties' => [ + 'description' => '数据源属性', + 'type' => 'object', + 'properties' => [ + 'Encoding' => [ + 'description' => '数据库编码', + 'type' => 'string', + 'required' => false, + 'example' => 'UTF-8', + ], + 'Timezone' => [ + 'description' => '时区', + 'type' => 'string', + 'required' => false, + 'example' => 'Asia/Shanghai', + ], + ], + 'required' => false, + ], + ], + 'required' => false, + ], + 'required' => true, + ], + ], + [ + 'name' => 'DestinationDataSourceSettings', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'description' => '目标端数据源设置列表', + 'type' => 'array', + 'items' => [ + 'description' => '单个目标端数据源设置', + 'type' => 'object', + 'properties' => [ + 'DataSourceName' => [ + 'description' => '数据源名称', + 'type' => 'string', + 'required' => false, + 'example' => 'holo_datasource_1', + ], + ], + 'required' => false, + ], + 'required' => true, + ], + ], + [ + 'name' => 'ResourceSettings', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'description' => '资源设置', + 'type' => 'object', + 'properties' => [ + 'OfflineResourceSettings' => [ + 'description' => '离线同步资源', + 'type' => 'object', + 'properties' => [ + 'RequestedCu' => [ + 'description' => '离线同步使用的数据集成资源组cu', + 'type' => 'number', + 'format' => 'double', + 'required' => false, + 'example' => '2', + ], + 'ResourceGroupIdentifier' => [ + 'description' => '离线同步使用的数据集成资源组名称', + 'type' => 'string', + 'required' => false, + 'example' => 'S_res_group_111_222', + ], + ], + 'required' => false, + ], + 'RealtimeResourceSettings' => [ + 'description' => '实时同步资源', + 'type' => 'object', + 'properties' => [ + 'RequestedCu' => [ + 'description' => '实时同步使用的数据集成资源组cu', + 'type' => 'number', + 'format' => 'double', + 'required' => false, + 'example' => '2', + ], + 'ResourceGroupIdentifier' => [ + 'description' => '实时同步使用的数据集成资源组名称', + 'type' => 'string', + 'required' => false, + 'example' => 'S_res_group_111_222', + ], + ], + 'required' => false, + ], + 'ScheduleResourceSettings' => [ + 'description' => '调度资源', + 'type' => 'object', + 'properties' => [ + 'RequestedCu' => [ + 'description' => '离线同步任务使用的调度资源组cu', + 'type' => 'number', + 'format' => 'double', + 'required' => false, + 'example' => '2', + ], + 'ResourceGroupIdentifier' => [ + 'description' => '离线同步任务使用的调度资源组名称', + 'type' => 'string', + 'required' => false, + 'example' => 'S_res_group_222_333', + ], + ], + 'required' => false, + ], + ], + 'required' => true, + ], + ], + [ + 'name' => 'TransformationRules', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'description' => '同步对象转换规则定义列表'."\n" + .'>[ { "RuleName":"my_database_rename_rule", "RuleActionType":"Rename", "RuleTargetType":"Schema", "RuleExpression":"{"expression":"${srcDatasoureName}_${srcDatabaseName}"}" } ]', + 'type' => 'array', + 'items' => [ + 'description' => '单个同步对象转换规则定义，每个元素为一条转换规则定义', + 'type' => 'object', + 'properties' => [ + 'RuleActionType' => [ + 'description' => '动作类型，可选的枚举值：'."\n" + ."\n" + .'- DefinePrimaryKey（定义主键）'."\n" + .'- Rename（重命名）'."\n" + .'- AddColumn（增加列）'."\n" + .'- HandleDml（DML处理）'."\n" + .'- DefineIncrementalCondition（定义增量条件）'."\n" + .'- DefineCycleScheduleSettings（定义周期调度设置）'."\n" + .'- DefinePartitionKey（定义分区列）', + 'type' => 'string', + 'required' => false, + 'example' => 'Rename', + ], + 'RuleExpression' => [ + 'description' => '规则表达式，json string格式。'."\n" + ."\n" + .'1. 重命名规则（Rename）'."\n" + .'- 示例：{"expression":"${srcDatasourceName}_${srcDatabaseName}_0922" }'."\n" + .'- expression：为重命名转换规则表达式，表达式内支持变量包括：${srcDatasourceName}（源端数据源名）、${srcDatabaseName}（源端库名）、${srcTableName}（源端表名）。'."\n" + .'2. 加列规则（AddColumn)'."\n" + .'- 示例：{"columns":[{"columnName":"my_add_column","columnValueType":"Constant","columnValue":"123"}]}'."\n" + .'- 如不指定，默认规则为不加列不复制。'."\n" + .'- columnName：附加的列名称。'."\n" + .'- columnValueType：附加的列取值类型，包括Constant（常量）、Variable（变量）。'."\n" + .'- columnValue：附加的列取值。当columnValueType=Constant时，value为自定义常量，String类型。当columnValueType=Variable时，value为内置变量。内置变量可选值包括：EXECUTE_TIME（执行时间，Long类型）、DB_NAME_SRC（源端数据库名称，String类型）、DATASOURCE_NAME_SRC（源端数据源名称，String类型）、TABLE_NAME_SRC（源端表名，String类型）、DB_NAME_DEST（目标端数据库名称，String类型）、DATASOURCE_NAME_DEST（目标端数据源名称，String类型）、TABLE_NAME_DEST（目标端表名，String类型）、DB_NAME_SRC_TRANSED（转换后的数据库名称，String类型）。'."\n" + .'3. 指定目标端表的主键列列名（DefinePrimaryKey）'."\n" + .'- 示例：{"columns":["ukcolumn1","ukcolumn2"]}'."\n" + .'- 如不指定默认使用源端主键列。'."\n" + .'- 当目标端为已有表：数据集成系统不会修改目标端表结构，如果指定的主键列不在目标端的列集合中，任务启动会报错提示。'."\n" + .'- 当目标端为自动建表：数据集成系统会自动创建目标端表结构，表结构包含定义的主键列。当指定的主键列不在目标端的列集合中时，任务启动会报错提示。'."\n" + .'4. DML处理规则（HandleDml）'."\n" + .'- 示例： {"dmlPolicies":[{"dmlType":"Delete","dmlAction":"Filter","filterCondition":"id > 1"}]}'."\n" + .'- 如不指定，默认规则为Insert、Update、Delete均为Normal'."\n" + .'- dmlType：DML操作类型，Insert（插入）、Update（更新）、Delete（删除）'."\n" + .'- dmlAction：DML处理策略，Normal（正常处理）、Ignore（忽略）、Filter（有条件的正常处理，当dmlType=Update/Delete时使用）、LogicalDelete（逻辑删除）'."\n" + .'- filterCondition：DML过滤条件，当dmlAction=Filter时使用'."\n" + .'5. 增量条件（DefineIncrementalCondition）'."\n" + .'- 示例： {"where":"id > 0"}'."\n" + .'- 指定增量过滤条件'."\n" + .'6. 周期调度参数（DefineCycleScheduleSettings）'."\n" + .'- 示例： {"cronExpress":" * * * * * *", "cycleType":"1"}'."\n" + .'- 指定周期任务调度参数'."\n" + .'7. 指定分区键（DefinePartitionKey）'."\n" + .'- 示例： {"columns":["id"]}'."\n" + .'- 指定分区键', + 'type' => 'string', + 'required' => false, + 'example' => '{'."\n" + .' "expression": "${srcDatasoureName}_${srcDatabaseName}"'."\n" + .'}', + ], + 'RuleName' => [ + 'description' => '规则名称，当动作类型和动作作用的目标类型相同时，规则名称需保证唯一性，长度不能超过50个字符', + 'type' => 'string', + 'required' => false, + 'example' => 'rename_rule_1', + ], + 'RuleTargetType' => [ + 'description' => '动作作用的目标类型，可选的枚举值：'."\n" + ."\n" + .'- Table（表）'."\n" + .'- Schema（schema）'."\n" + .'- Database（数据库）', + 'type' => 'string', + 'required' => false, + 'example' => 'Table', + ], + ], + 'required' => false, + ], + 'required' => false, + ], + ], + [ + 'name' => 'TableMappings', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'description' => '同步对象转换映射列表，列表中每个元素描述了一组源端同步对象选择规则列表和在该组同步对象上应用的同步对象转换规则列表'."\n" + ."\n" + .'> [ { "SourceObjectSelectionRules":[ { "ObjectType":"Database", "Action":"Include", "ExpressionType":"Exact", "Expression":"biz_db" }, { "ObjectType":"Schema", "Action":"Include", "ExpressionType":"Exact", "Expression":"s1" }, { "ObjectType":"Table", "Action":"Include", "ExpressionType":"Exact", "Expression":"table1" } ], "TransformationRuleNames":[ { "RuleName":"my_database_rename_rule", "RuleActionType":"Rename", "RuleTargetType":"Schema" } ] } ]', + 'type' => 'array', + 'items' => [ + 'description' => '每条规则代表选择需要同步的一个表', + 'type' => 'object', + 'properties' => [ + 'SourceObjectSelectionRules' => [ + 'description' => '每条规则可选择待同步源端对象的集合，多条规则组成选一个表', + 'type' => 'array', + 'items' => [ + 'description' => '每条规则可选择待同步源端对象的不同对象类型，如选择源端数据库、源端数据表', + 'type' => 'object', + 'properties' => [ + 'Action' => [ + 'description' => '选择动作，取值范围：Include/Exclude', + 'type' => 'string', + 'required' => false, + 'example' => 'Include', + ], + 'Expression' => [ + 'description' => '表达式', + 'type' => 'string', + 'required' => false, + 'example' => 'mysql_table_1', + ], + 'ExpressionType' => [ + 'description' => '表达式类型，取值范围：Exact/Regex', + 'type' => 'string', + 'required' => false, + 'example' => 'Exact', + ], + 'ObjectType' => [ + 'description' => '对象类型，可选的枚举值：'."\n" + ."\n" + .'- Table（表）'."\n" + .'- Schema（schema）'."\n" + .'- Database（数据库）', + 'type' => 'string', + 'required' => false, + 'example' => 'Table', + ], + ], + 'required' => false, + ], + 'required' => false, + ], + 'TransformationRules' => [ + 'description' => '同步对象转换规则定义列表，列表中每个元素为一条转换规则定义', + 'type' => 'array', + 'items' => [ + 'description' => '源端对象上应用的转换规则', + 'type' => 'object', + 'properties' => [ + 'RuleName' => [ + 'description' => '规则名称，在一种动作类型+动作作用的目标类型下规则名称唯一，长度不能超过50个字符', + 'type' => 'string', + 'required' => false, + 'example' => 'rename_rule_1', + ], + 'RuleActionType' => [ + 'description' => '动作类型，可选的枚举值：'."\n" + ."\n" + .'- DefinePrimaryKey（定义主键）'."\n" + .'- Rename（重命名）'."\n" + .'- AddColumn（增加列）'."\n" + .'- HandleDml（DML处理）'."\n" + .'- DefineIncrementalCondition（定义增量条件）'."\n" + .'- DefineCycleScheduleSettings（定义周期调度设置）'."\n" + .'- DefinePartitionKey（定义分区列）', + 'type' => 'string', + 'required' => false, + 'example' => 'Rename', + ], + 'RuleTargetType' => [ + 'description' => '动作作用的目标类型，可选的枚举值：'."\n" + ."\n" + .'- Table（表）'."\n" + .'- Schema（schema）'."\n" + .'- Database（数据库）', + 'type' => 'string', + 'required' => false, + 'example' => 'Table', + ], + ], + 'required' => false, + ], + 'required' => false, + ], + ], + 'required' => false, + ], + 'required' => true, + ], + ], + [ + 'name' => 'JobSettings', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'description' => '同步任务维度的设置，含DDL处理策略、源端和目标端列数据类型映射策略、任务运行时参数等', + 'type' => 'object', + 'properties' => [ + 'ChannelSettings' => [ + 'description' => '通道相关任务设置，可以对一些特定通道进行特殊配置，目前支持Holo2Holo（从holo同步到holo），Holo2Kafka（从Holo同步到Kafka）'."\n" + ."\n" + .'1. Holo2Kafka'."\n" + .'- 示例：{"destinationChannelSettings":{"kafkaClientProperties":[{"key":"linger.ms","value":"100"}],"keyColumns":["col3"],"writeMode":"canal"}}'."\n" + .'kafkaClientProperties：kafka producer参数，写入kafka时使用'."\n" + .'- keyColumns， 需要写入的kafka列取值'."\n" + .'- writeMode，kafka写入格式，目前支持json/canal'."\n" + .'2. Holo2Holo'."\n" + .'- 示例： {"destinationChannelSettings":{"conflictMode":"replace","dynamicColumnAction":"replay","writeMode":"replay"}}'."\n" + ."\n" + .'- conflictMode: 写入holo冲突处理策略，replace-覆盖、ignore-忽略'."\n" + ."\n" + .'- writeMode: 写入holo方式，replay-重放、insert-插入'."\n" + ."\n" + .'- dynamicColumnAction：写入holo 动态列方式replay-重放、insert-插入，ignore-忽略', + 'type' => 'string', + 'required' => false, + 'example' => '{'."\n" + .' "structInfo": "MANAGED",'."\n" + .' "storageType": "TEXTFILE",'."\n" + .' "writeMode": "APPEND",'."\n" + .' "partitionColumns": ['."\n" + .' {'."\n" + .' "columnName": "pt",'."\n" + .' "columnType": "STRING",'."\n" + .' "comment": ""'."\n" + .' }'."\n" + .' ],'."\n" + .' "fieldDelimiter": ""'."\n" + .'}', + ], + 'ColumnDataTypeSettings' => [ + 'description' => '列类型映射数组'."\n" + ."\n" + .'> ["ColumnDataTypeSettings":[ { "SourceDataType":"Bigint", "DestinationDataType":"Text" } ]', + 'type' => 'array', + 'items' => [ + 'description' => '单条列类型映射', + 'type' => 'object', + 'properties' => [ + 'DestinationDataType' => [ + 'description' => '目标端类型。如bigint，boolean，string，text，datetime，timestamp，decimal，binary，不同数据源类型会有类型差异', + 'type' => 'string', + 'required' => false, + 'example' => 'text', + ], + 'SourceDataType' => [ + 'description' => '源端类型。如bigint，boolean，string，text，datetime，timestamp，decimal，binary，不同数据源类型会有类型差异', + 'type' => 'string', + 'required' => false, + 'example' => 'bigint', + ], + ], + 'required' => false, + ], + 'required' => false, + ], + 'CycleScheduleSettings' => [ + 'description' => '周期调度设置', + 'type' => 'object', + 'properties' => [ + 'CycleMigrationType' => [ + 'description' => '需要周期调度的同步类型。取值范围：'."\n" + ."\n" + .'- Full：全量'."\n" + .'- OfflineIncremental：离线增量', + 'type' => 'string', + 'required' => false, + 'example' => 'Full', + ], + 'ScheduleParameters' => [ + 'description' => '调度参数', + 'type' => 'string', + 'required' => false, + 'example' => 'bizdate=$bizdate', + ], + ], + 'required' => false, + ], + 'DdlHandlingSettings' => [ + 'description' => 'DDL处理设置数组。'."\n" + ."\n\n" + .'> ["DDLHandlingSettings":[ { "Type":"Insert", "Action":"Normal" } ]', + 'type' => 'array', + 'items' => [ + 'description' => '单条DDL处理设置', + 'type' => 'object', + 'properties' => [ + 'Action' => [ + 'description' => '处理动作，可选的枚举值：'."\n" + ."\n" + .'- Ignore（忽略）'."\n" + .'- Critical（报错）'."\n" + .'- Normal（正常处理）', + 'type' => 'string', + 'required' => false, + 'example' => 'Critical', + ], + 'Type' => [ + 'description' => 'DDL类型，可选的枚举值：'."\n" + ."\n" + .'- RenameColumn（重命名列）'."\n" + .'- ModifyColumn（重命名列）'."\n" + .'- CreateTable（重命名列）'."\n" + .'- TruncateTable（清空表）'."\n" + .'- DropTable（删除表）'."\n" + .'- DropColumn（删除列）'."\n" + .'- AddColumn（新增列）', + 'type' => 'string', + 'required' => false, + 'example' => 'AddColumn', + ], + ], + 'required' => false, + ], + 'required' => false, + ], + 'RuntimeSettings' => [ + 'description' => '运行时设置', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'description' => '设置名称，可选的枚举值：'."\n" + ."\n" + .'- src.offline.datasource.max.connection（离线批量任务源端最大连接数）'."\n" + .'- dst.offline.truncate (是否清空目标表）'."\n" + .'- runtime.offline.speed.limit.enable（离线批量任务是否开启限流）'."\n" + .'- runtime.offline.concurrent（离线批量同步任务并发度）'."\n" + .'- runtime.enable.auto.create.schema（是否自动在目标端创建schema）'."\n" + .'- runtime.realtime.concurrent（实时任务并发度）'."\n" + .'- runtime.realtime.failover.minute.dataxcdc (failover失败重启等待时间单位分钟)'."\n" + .'- runtime.realtime.failover.times.dataxcdc (failover失败重启次数）', + 'type' => 'string', + 'required' => false, + 'example' => 'runtime.offline.concurrent'."\n", + ], + 'Value' => [ + 'description' => '设置取值', + 'type' => 'string', + 'required' => false, + 'example' => '1', + ], + ], + 'required' => false, + ], + 'required' => false, + ], + ], + 'required' => false, + ], + ], + [ + 'name' => 'JobName', + 'in' => 'query', + 'schema' => [ + 'description' => '该字段已废弃，请使用Name字段。', + 'type' => 'string', + 'deprecated' => true, + 'required' => false, + 'example' => 'mysql_to_holo_sync_8772', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'Id' => [ + 'description' => '数据集成任务ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '11792', + ], + 'RequestId' => [ + 'description' => '请求的ID。用于定位日志，排查问题。', + 'type' => 'string', + 'example' => '4F6AB6B3-41FB-5EBB-AFB2-0C98D49DA2BB', + ], + 'DIJobId' => [ + 'description' => '该字段已废弃，请使用Id字段。', + 'type' => 'integer', + 'format' => 'int64', + 'deprecated' => true, + 'example' => '11792', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Id\\": 11792,\\n \\"RequestId\\": \\"4F6AB6B3-41FB-5EBB-AFB2-0C98D49DA2BB\\",\\n \\"DIJobId\\": 11792\\n}","type":"json"}]', + 'title' => '创建数据集成同步任务', + 'description' => '- 需要购买DataWorks基础版及以上版本才能使用。'."\n" + .'- 该接口创建了数据集成同步任务，'."\n" + .'参数包括同步任务的源端配置SourceDataSourceSettings和目的端配置DestinationDataSourceSettings，以及支持的同步类型MigrationType，同时通过TransformationRules定义了对同步表做的如加列，表名替换等映射rule，在TableMappings中定义了要同步的具体表以及表需要使用的映射rule，在JobSettings中定义了任务的列映射和周期设置等。', + ], + 'UpdateDIJob' => [ + 'summary' => '更新数据集成任务。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '234099', + 'abilityTreeNodes' => [ + 'FEATUREdideBP0OJZ', + ], + ], + 'parameters' => [ + [ + 'name' => 'Id', + 'in' => 'query', + 'schema' => [ + 'description' => '任务ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '11588', + ], + ], + [ + 'name' => 'Description', + 'in' => 'formData', + 'schema' => [ + 'description' => '任务的描述', + 'type' => 'string', + 'required' => false, + 'example' => 'DI Job Demo', + ], + ], + [ + 'name' => 'TableMappings', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'description' => '同步对象转换映射列表，列表中每个元素描述了一组源端同步对象选择规则列表和在该组同步对象上应用的同步对象转换规则列表'."\n" + ."\n\n" + .'> [ { "SourceObjectSelectionRules":[ { "ObjectType":"Database", "Action":"Include", "ExpressionType":"Exact", "Expression":"biz_db" }, { "ObjectType":"Schema", "Action":"Include", "ExpressionType":"Exact", "Expression":"s1" }, { "ObjectType":"Table", "Action":"Include", "ExpressionType":"Exact", "Expression":"table1" } ], "TransformationRuleNames":[ { "RuleName":"my_database_rename_rule", "RuleActionType":"Rename", "RuleTargetType":"Schema" } ] } ]', + 'type' => 'array', + 'items' => [ + 'description' => '同步对象转换映射列表，列表中每个元素描述了一组源端同步对象选择规则列表和在该组同步对象上应用的同步对象转换规则列表', + 'type' => 'object', + 'properties' => [ + 'SourceObjectSelectionRules' => [ + 'description' => '每条规则可选择待同步源端对象的不同对象类型，如选择源端数据库、源端数据表', + 'type' => 'array', + 'items' => [ + 'description' => '每条规则可选择待同步源端对象的不同对象类型，如选择源端数据库、源端数据表', + 'type' => 'object', + 'properties' => [ + 'Action' => [ + 'description' => '选择动作，取值范围：Include/Exclude', + 'type' => 'string', + 'required' => false, + 'example' => 'Include', + ], + 'Expression' => [ + 'description' => '表达式', + 'type' => 'string', + 'required' => false, + 'example' => 'mysql_table_1', + ], + 'ExpressionType' => [ + 'description' => '表达式类型，取值范围：Exact/Regex', + 'type' => 'string', + 'required' => false, + 'example' => 'Exact', + ], + 'ObjectType' => [ + 'description' => '对象类型，可选的枚举值：'."\n" + ."\n" + .'- Table（表）'."\n" + .'- Schema（schema）'."\n" + .'- Database（数据库）', + 'type' => 'string', + 'required' => false, + 'example' => 'Table', + ], + ], + 'required' => false, + ], + 'required' => false, + ], + 'TransformationRules' => [ + 'description' => '源端对象上应用的转换规则', + 'type' => 'array', + 'items' => [ + 'description' => '源端对象上应用的转换规则', + 'type' => 'object', + 'properties' => [ + 'RuleName' => [ + 'description' => '规则名称，在一种动作类型+动作作用的目标类型下规则名称唯一，长度不能超过50个字符', + 'type' => 'string', + 'required' => false, + 'example' => 'rename_rule_1', + ], + 'RuleActionType' => [ + 'description' => '动作类型，可选的枚举值：'."\n" + ."\n" + .'- DefinePrimaryKey（定义主键）'."\n" + .'- Rename（重命名）'."\n" + .'- AddColumn（增加列）'."\n" + .'- HandleDml（DML处理）', + 'type' => 'string', + 'required' => false, + 'example' => 'Rename', + ], + 'RuleTargetType' => [ + 'description' => '动作作用的目标类型，可选的枚举值：'."\n" + ."\n" + .'- Table（表）'."\n" + .'- Schema（schema）'."\n" + .'- Database（数据库）', + 'type' => 'string', + 'required' => false, + 'example' => 'Table', + ], + ], + 'required' => false, + ], + 'required' => false, + ], + ], + 'required' => false, + ], + 'required' => false, + ], + ], + [ + 'name' => 'JobSettings', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'description' => '同步任务维度的设置，含DDL处理策略、源端和目标端列数据类型映射策略、任务运行时参数等', + 'type' => 'object', + 'properties' => [ + 'ChannelSettings' => [ + 'description' => '通道相关任务设置，可以对一些特定通道进行特殊配置，目前支持Holo2Holo（从holo同步到holo），Holo2Kafka（从Holo同步到Kafka）'."\n" + ."\n" + .'1. Holo2Kafka'."\n" + .'- 示例：{"destinationChannelSettings":{"kafkaClientProperties":[{"key":"linger.ms","value":"100"}],"keyColumns":["col3"],"writeMode":"canal"}}'."\n" + .'kafkaClientProperties：kafka producer参数，写入kafka时使用'."\n" + .'- keyColumns， 需要写入的kafka列取值'."\n" + .'- writeMode，kafka写入格式，目前支持json/canal'."\n" + .'2. Holo2Holo'."\n" + .'- 示例： {"destinationChannelSettings":{"conflictMode":"replace","dynamicColumnAction":"replay","writeMode":"replay"}}'."\n" + ."\n" + .'- conflictMode: 写入holo冲突处理策略，replace-覆盖、ignore-忽略'."\n" + ."\n" + .'- writeMode: 写入holo方式，replay-重放、insert-插入'."\n" + ."\n" + .'- dynamicColumnAction：写入holo 动态列方式replay-重放、insert-插入，ignore-忽略', + 'type' => 'string', + 'required' => false, + 'example' => '{'."\n" + .' "structInfo": "MANAGED",'."\n" + .' "storageType": "TEXTFILE",'."\n" + .' "writeMode": "APPEND",'."\n" + .' "partitionColumns": ['."\n" + .' {'."\n" + .' "columnName": "pt",'."\n" + .' "columnType": "STRING",'."\n" + .' "comment": ""'."\n" + .' }'."\n" + .' ],'."\n" + .' "fieldDelimiter": ""'."\n" + .'}', + ], + 'ColumnDataTypeSettings' => [ + 'description' => '列类型映射数组'."\n" + ."\n" + .'> ["ColumnDataTypeSettings":[ { "SourceDataType":"Bigint", "DestinationDataType":"Text" } ]', + 'type' => 'array', + 'items' => [ + 'description' => '单条列类型映射', + 'type' => 'object', + 'properties' => [ + 'DestinationDataType' => [ + 'description' => '目标端类型。如bigint，boolean，string，text，datetime，timestamp，decimal，binary，不同数据源类型会有类型差异', + 'type' => 'string', + 'required' => false, + 'example' => 'text', + ], + 'SourceDataType' => [ + 'description' => '源端类型。如bigint，boolean，string，text，datetime，timestamp，decimal，binary，不同数据源类型会有类型差异', + 'type' => 'string', + 'required' => false, + 'example' => 'bigint', + ], + ], + 'required' => false, + ], + 'required' => false, + ], + 'CycleScheduleSettings' => [ + 'description' => '周期调度设置', + 'type' => 'object', + 'properties' => [ + 'ScheduleParameters' => [ + 'description' => '调度参数', + 'type' => 'string', + 'required' => false, + 'example' => 'bizdate=$bizdate'."\n", + ], + ], + 'required' => false, + ], + 'DdlHandlingSettings' => [ + 'description' => 'DDL处理设置数组。'."\n" + ."\n\n" + .'> ["DDLHandlingSettings":[ { "Type":"Insert", "Action":"Normal" } ]', + 'type' => 'array', + 'items' => [ + 'description' => '单条DDL处理设置', + 'type' => 'object', + 'properties' => [ + 'Action' => [ + 'description' => '处理动作，可选的枚举值：'."\n" + ."\n" + .'- Ignore（忽略）'."\n" + .'- Critical（报错）'."\n" + .'- Normal（正常处理）', + 'type' => 'string', + 'required' => false, + 'example' => 'Critical', + ], + 'Type' => [ + 'description' => 'DDL类型，可选的枚举值：'."\n" + ."\n" + .'- RenameColumn（重命名列）'."\n" + .'- ModifyColumn（更新列）'."\n" + .'- CreateTable（新建表）'."\n" + .'- TruncateTable（清空表）'."\n" + .'- DropTable（删除表）'."\n" + .'- DropColumn（删除列）'."\n" + .'- AddColumn（新增列）', + 'type' => 'string', + 'required' => false, + 'example' => 'AddColumn', + ], + ], + 'required' => false, + ], + 'required' => false, + ], + 'RuntimeSettings' => [ + 'description' => '运行时设置', + 'type' => 'array', + 'items' => [ + 'description' => '运行时设置', + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'description' => '设置名称，可选的枚举值：'."\n" + ."\n" + .'- src.offline.datasource.max.connection（离线批量任务源端最大连接数）'."\n" + .'- dst.offline.truncate (是否清空目标表）'."\n" + .'- runtime.offline.speed.limit.enable（离线批量任务是否开启限流）'."\n" + .'- runtime.offline.concurrent（离线批量同步任务并发度）'."\n" + .'- runtime.enable.auto.create.schema（是否自动在目标端创建schema）'."\n" + .'- runtime.realtime.concurrent（实时任务并发度）'."\n" + .'- runtime.realtime.failover.minute.dataxcdc (failover失败重启等待时间单位分钟)'."\n" + .'- runtime.realtime.failover.times.dataxcdc (failover失败重启次数）', + 'type' => 'string', + 'required' => false, + 'example' => 'src.offline.datasource.max.connection', + ], + 'Value' => [ + 'description' => '设置取值', + 'type' => 'string', + 'required' => false, + 'example' => '1', + ], + ], + 'required' => false, + ], + 'required' => false, + ], + ], + 'required' => false, + ], + ], + [ + 'name' => 'ResourceSettings', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'description' => '资源设置', + 'type' => 'object', + 'properties' => [ + 'OfflineResourceSettings' => [ + 'description' => '离线同步资源', + 'type' => 'object', + 'properties' => [ + 'RequestedCu' => [ + 'description' => '离线同步使用的数据集成资源组cu', + 'type' => 'number', + 'format' => 'double', + 'required' => false, + 'example' => '2', + ], + 'ResourceGroupIdentifier' => [ + 'description' => '离线同步使用的数据集成资源组名称', + 'type' => 'string', + 'required' => false, + 'example' => 'S_res_group_111_222', + ], + ], + 'required' => false, + ], + 'RealtimeResourceSettings' => [ + 'description' => '实时同步资源', + 'type' => 'object', + 'properties' => [ + 'RequestedCu' => [ + 'description' => '实时同步使用的数据集成资源组cu', + 'type' => 'number', + 'format' => 'double', + 'required' => false, + 'example' => '2', + ], + 'ResourceGroupIdentifier' => [ + 'description' => '实时同步使用的数据集成资源组名称', + 'type' => 'string', + 'required' => false, + 'example' => 'S_res_group_111_222', + ], + ], + 'required' => false, + ], + 'ScheduleResourceSettings' => [ + 'description' => '调度资源', + 'type' => 'object', + 'properties' => [ + 'RequestedCu' => [ + 'description' => '离线同步任务使用的调度资源组cu', + 'type' => 'number', + 'format' => 'double', + 'required' => false, + 'example' => '2', + ], + 'ResourceGroupIdentifier' => [ + 'description' => '离线同步任务使用的调度资源组名称', + 'type' => 'string', + 'required' => false, + 'example' => 'S_res_group_222_333', + ], + ], + 'required' => false, + ], + ], + 'required' => false, + ], + ], + [ + 'name' => 'TransformationRules', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'description' => '同步对象转换规则定义列表'."\n" + .'>[ { "RuleName":"my_database_rename_rule", "RuleActionType":"Rename", "RuleTargetType":"Schema", "RuleExpression":"{"expression":"${srcDatasoureName}_${srcDatabaseName}"}" } ]', + 'type' => 'array', + 'items' => [ + 'description' => '单个同步对象转换规则定义，每个元素为一条转换规则定义', + 'type' => 'object', + 'properties' => [ + 'RuleActionType' => [ + 'description' => '动作类型，可选的枚举值：'."\n" + ."\n" + .'- DefinePrimaryKey（定义主键）'."\n" + .'- Rename（重命名）'."\n" + .'- AddColumn（增加列）'."\n" + .'- HandleDml（DML处理）'."\n" + .'- DefineIncrementalCondition（定义增量条件）'."\n" + .'- DefineCycleScheduleSettings（定义周期调度设置）'."\n" + .'- DefinePartitionKey（定义分区列）', + 'type' => 'string', + 'required' => false, + 'example' => 'Rename', + ], + 'RuleExpression' => [ + 'description' => '规则表达式，json string格式。'."\n" + ."\n" + .'1. 重命名规则（Rename）'."\n" + .'- 示例：{"expression":"${srcDatasourceName}_${srcDatabaseName}_0922" }'."\n" + .'- expression：为重命名转换规则表达式，表达式内支持变量包括：${srcDatasourceName}（源端数据源名）、${srcDatabaseName}（源端库名）、${srcTableName}（源端表名）。'."\n" + .'2. 加列规则（AddColumn)'."\n" + .'- 示例：{"columns":[{"columnName":"my_add_column","columnValueType":"Constant","columnValue":"123"}]}'."\n" + .'- 如不指定，默认规则为不加列不复制。'."\n" + .'- columnName：附加的列名称。'."\n" + .'- columnValueType：附加的列取值类型，包括Constant（常量）、Variable（变量）。'."\n" + .'- columnValue：附加的列取值。当columnValueType=Constant时，value为自定义常量，String类型。当columnValueType=Variable时，value为内置变量。内置变量可选值包括：EXECUTE_TIME（执行时间，Long类型）、DB_NAME_SRC（源端数据库名称，String类型）、DATASOURCE_NAME_SRC（源端数据源名称，String类型）、TABLE_NAME_SRC（源端表名，String类型）、DB_NAME_DEST（目标端数据库名称，String类型）、DATASOURCE_NAME_DEST（目标端数据源名称，String类型）、TABLE_NAME_DEST（目标端表名，String类型）、DB_NAME_SRC_TRANSED（转换后的数据库名称，String类型）。'."\n" + .'3. 指定目标端表的主键列列名（DefinePrimaryKey）'."\n" + .'- 示例：{"columns":["ukcolumn1","ukcolumn2"]}'."\n" + .'- 如不指定默认使用源端主键列。'."\n" + .'- 当目标端为已有表：数据集成系统不会修改目标端表结构，如果指定的主键列不在目标端的列集合中，任务启动会报错提示。'."\n" + .'- 当目标端为自动建表：数据集成系统会自动创建目标端表结构，表结构包含定义的主键列。当指定的主键列不在目标端的列集合中时，任务启动会报错提示。'."\n" + .'4. DML处理规则（HandleDml）'."\n" + .'- 示例： {"dmlPolicies":[{"dmlType":"Delete","dmlAction":"Filter","filterCondition":"id > 1"}]}'."\n" + .'- 如不指定，默认规则为Insert、Update、Delete均为Normal'."\n" + .'- dmlType：DML操作类型，Insert（插入）、Update（更新）、Delete（删除）'."\n" + .'- dmlAction：DML处理策略，Normal（正常处理）、Ignore（忽略）、Filter（有条件的正常处理，当dmlType=Update/Delete时使用）、LogicalDelete（逻辑删除）'."\n" + .'- filterCondition：DML过滤条件，当dmlAction=Filter时使用'."\n" + .'5. 增量条件（DefineIncrementalCondition）'."\n" + .'- 示例： {"where":"id > 0"}'."\n" + .'- 指定增量过滤条件'."\n" + .'6. 周期调度参数（DefineCycleScheduleSettings）'."\n" + .'- 示例： {"cronExpress":" * * * * * *", "cycleType":"1"}'."\n" + .'- 指定周期任务调度参数'."\n" + .'7. 指定分区键（DefinePartitionKey）'."\n" + .'- 示例： {"columns":["id"]}'."\n" + .'- 指定分区键', + 'type' => 'string', + 'required' => false, + 'example' => '{"expression":"${srcDatasoureName}_${srcDatabaseName}"}', + ], + 'RuleName' => [ + 'description' => '规则名称，当动作类型和动作作用的目标类型相同时，规则名称需保证唯一性，长度不能超过50个字符', + 'type' => 'string', + 'required' => false, + 'example' => 'rename_rule_1', + ], + 'RuleTargetType' => [ + 'description' => '动作作用的目标类型，可选的枚举值：'."\n" + ."\n" + .'- Table（表）'."\n" + .'- Schema（schema）'."\n" + .'- Database（数据库）', + 'type' => 'string', + 'required' => false, + 'example' => 'Table', + ], + ], + 'required' => false, + ], + 'required' => false, + ], + ], + [ + 'name' => 'ProjectId', + 'in' => 'query', + 'schema' => [ + 'description' => 'DataWorks工作空间ID。您可以通过[ListProjects](~~178393~~)接口获取工作空间ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '10000', + ], + ], + [ + 'name' => 'DIJobId', + 'in' => 'query', + 'schema' => [ + 'description' => '该字段已废弃，请使用Id字段。', + 'type' => 'integer', + 'format' => 'int64', + 'deprecated' => true, + 'required' => false, + 'example' => '11588', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'Success' => [ + 'description' => '调用是否成功。取值如下：'."\n" + .'- true：调用成功。'."\n" + .'- false：调用失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'RequestId' => [ + 'description' => '请求的ID。用于定位日志，排查问题。', + 'type' => 'string', + 'example' => 'AAC30B35-820D-5F3E-A42C-E96BB****', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"AAC30B35-820D-5F3E-A42C-E96BB****\\"\\n}","type":"json"}]', + 'title' => '更新数据集成同步任务', + 'description' => '需要购买DataWorks基础版及以上版本才能使用。', + ], + 'DeleteDIJob' => [ + 'summary' => '删除数据集成新版任务。', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'abilityTreeCode' => '234098', + 'abilityTreeNodes' => [ + 'FEATUREdideBP0OJZ', + ], + ], + 'parameters' => [ + [ + 'name' => 'Id', + 'in' => 'query', + 'schema' => [ + 'description' => '任务ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '11126', + ], + ], + [ + 'name' => 'ProjectId', + 'in' => 'query', + 'schema' => [ + 'description' => 'DataWorks工作空间ID', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '108864', + ], + ], + [ + 'name' => 'DIJobId', + 'in' => 'query', + 'schema' => [ + 'description' => '该字段已废弃，请使用Id字段。', + 'type' => 'integer', + 'format' => 'int64', + 'deprecated' => true, + 'required' => false, + 'example' => '11126', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'Success' => [ + 'description' => '调用是否成功。取值如下：'."\n" + .'- true：调用成功。'."\n" + .'- false：调用失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'RequestId' => [ + 'description' => '请求的唯一标识，用于后续错误排查使用。', + 'type' => 'string', + 'example' => 'D33D4A51-5845-579A-B4BA-FAADD0F****', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"D33D4A51-5845-579A-B4BA-FAADD0F****\\"\\n}","type":"json"}]', + 'title' => '删除数据集成同步任务', + 'description' => '需要购买DataWorks基础版及以上版本才能使用。', + ], + 'StopDIJob' => [ + 'summary' => '中止数据集成任务。', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '235119', + 'abilityTreeNodes' => [ + 'FEATUREdideBP0OJZ', + ], + ], + 'parameters' => [ + [ + 'name' => 'Id', + 'in' => 'query', + 'schema' => [ + 'description' => '同步任务ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '11668', + ], + ], + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '实例的ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1234', + ], + ], + [ + 'name' => 'DIJobId', + 'in' => 'query', + 'schema' => [ + 'description' => '该字段已废弃，请使用Id字段。', + 'type' => 'integer', + 'format' => 'int64', + 'deprecated' => true, + 'required' => false, + 'example' => '11668', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'Success' => [ + 'description' => '请求是否成功。取值如下：'."\n" + ."\n" + .'- True：成功。'."\n" + .'- False：失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求的ID。用于定位日志，排查问题。', + 'type' => 'string', + 'example' => '92F778C7-8F00-53B1-AE1A-B3B17101247D', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"92F778C7-8F00-53B1-AE1A-B3B17101247D\\"\\n}","type":"json"}]', + 'title' => '停止数据集成同步任务', + 'description' => '需要购买DataWorks基础版及以上版本才能使用。', + ], + 'StartDIJob' => [ + 'summary' => '启动数据集成新版任务。', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '235100', + 'abilityTreeNodes' => [ + 'FEATUREdideBP0OJZ', + ], + ], + 'parameters' => [ + [ + 'name' => 'Id', + 'in' => 'query', + 'schema' => [ + 'description' => '实例 ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '10000', + ], + ], + [ + 'name' => 'ForceToRerun', + 'in' => 'query', + 'schema' => [ + 'description' => '是否强制重跑全部同步步骤。不填默认为不强制重跑。'."\n" + ."\n" + .'- 不强制重跑，只会从未运行的步骤开始启动，已经运行过的步骤不会再运行。'."\n" + .'- 强制重跑，整个任务步骤全部重新运行', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + [ + 'name' => 'RealtimeStartSettings', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '实时同步启动设置'."\n" + ."\n" + .'```'."\n" + .'{'."\n" + .' "StartTime":1663765058'."\n" + .'}'."\n" + .'```', + 'type' => 'object', + 'properties' => [ + 'StartTime' => [ + 'description' => '起始时间。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1671516776', + ], + 'FailoverSettings' => [ + 'description' => '该字段已废弃，请在创建任务时使用高级参数进行Failover设置', + 'type' => 'object', + 'properties' => [ + 'Interval' => [ + 'description' => '该字段已废弃，请在创建任务时使用高级参数进行Failover设置', + 'type' => 'integer', + 'format' => 'int64', + 'deprecated' => true, + 'required' => false, + 'example' => '10', + ], + 'UpperLimit' => [ + 'description' => '该字段已废弃，请在创建任务时使用高级参数进行Failover设置', + 'type' => 'integer', + 'format' => 'int64', + 'deprecated' => true, + 'required' => false, + 'example' => '30', + ], + ], + 'deprecated' => true, + 'required' => false, + ], + ], + 'required' => false, + ], + ], + [ + 'name' => 'DIJobId', + 'in' => 'query', + 'schema' => [ + 'description' => '该字段已废弃，请使用Id字段。', + 'type' => 'integer', + 'format' => 'int64', + 'deprecated' => true, + 'required' => false, + 'example' => '10000', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'Success' => [ + 'description' => '请求是否成功。取值如下：'."\n" + .'- true：成功。'."\n" + .'- false：失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求的ID。用于定位日志，排查问题。', + 'type' => 'string', + 'example' => '999431B2-6013-577F-B684-36F7433C753B', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"999431B2-6013-577F-B684-36F7433C753B\\"\\n}","type":"json"}]', + 'title' => '启动数据集成同步任务', + 'description' => '需要购买DataWorks基础版及以上版本才能使用。', + ], + 'GetDIJob' => [ + 'summary' => '查看数据集成任务。', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '234096', + 'abilityTreeNodes' => [ + 'FEATUREdideBP0OJZ', + ], + ], + 'parameters' => [ + [ + 'name' => 'Id', + 'in' => 'query', + 'schema' => [ + 'description' => '实例 ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '11588', + ], + ], + [ + 'name' => 'WithDetails', + 'in' => 'query', + 'schema' => [ + 'description' => '是否返回详细配置信息，详细配置信息包括TransformationRules、TableMappings、JobSettings。默认返回。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'ProjectId', + 'in' => 'query', + 'schema' => [ + 'description' => 'DataWorks工作空间ID。您可以通过ListProjects接口获取工作空间ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '10000', + ], + ], + [ + 'name' => 'DIJobId', + 'in' => 'query', + 'schema' => [ + 'description' => '该字段已废弃，请使用Id字段。', + 'type' => 'integer', + 'format' => 'int64', + 'deprecated' => true, + 'required' => false, + 'example' => '11588', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '创建时间', + 'description' => '请求的ID。用于定位日志，排查问题。', + 'type' => 'string', + 'example' => 'C99E2BE6-9DEA-5C2E-8F51-1DDCFEADE490', + ], + 'PagingInfo' => [ + 'description' => '分页信息', + 'type' => 'object', + 'properties' => [ + 'Id' => [ + 'description' => '任务ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '32601', + ], + 'Description' => [ + 'description' => '描述。', + 'type' => 'string', + 'example' => 'description', + ], + 'DestinationDataSourceSettings' => [ + 'description' => '目的端数据源属性列表。', + 'type' => 'array', + 'items' => [ + 'description' => '单个目的端数据源属性。', + 'type' => 'object', + 'properties' => [ + 'DataSourceName' => [ + 'description' => '目的端数据源名称。', + 'type' => 'string', + 'example' => 'dw_mysql', + ], + ], + ], + ], + 'DestinationDataSourceType' => [ + 'description' => '目标端数据源类型，枚举值：Hologres，OSS-HDFS，OSS，MaxCompute，LogHub，StarRocks，DataHub，AnalyticDB_For_MySQL，Kafka，Hive。', + 'type' => 'string', + 'example' => 'Hologres', + ], + 'JobName' => [ + 'description' => '任务名称。', + 'type' => 'string', + 'example' => 'imp_ods_dms_det_dealer_info_df', + ], + 'JobSettings' => [ + 'description' => '运行时设置。', + 'type' => 'object', + 'properties' => [ + 'ChannelSettings' => [ + 'description' => '通道相关任务设置，可以对一些特定通道进行特殊配置，目前支持Holo2Holo（从holo同步到holo），Holo2Kafka（从Holo同步到Kafka）'."\n" + .' 1. Holo2Kafka'."\n" + .' - 示例：{"destinationChannelSettings":{"kafkaClientProperties":[{"key":"linger.ms","value":"100"}],"keyColumns":["col3"],"writeMode":"canal"}}'."\n" + .'- kafkaClientProperties：kafka producer参数，写入kafka时使用'."\n" + .'- keyColumns， 需要写入的kafka列取值'."\n" + .'- writeMode，kafka写入格式，目前支持json/canal'."\n" + ."\n" + .' 2. Holo2Holo '."\n" + ."\n" + .' - 示例： {"destinationChannelSettings":{"conflictMode":"replace","dynamicColumnAction":"replay","writeMode":"replay"}}'."\n" + ."\n" + .'- conflictMode: 写入holo冲突处理策略，replace-覆盖、ignore-忽略'."\n" + .'- writeMode: 写入holo方式，replay-重放、insert-插入'."\n" + .'- dynamicColumnAction：写入holo 动态列方式replay-重放、insert-插入，ignore-忽略', + 'type' => 'string', + 'example' => '{"structInfo":"MANAGED","storageType":"TEXTFILE","writeMode":"APPEND","partitionColumns":[{"columnName":"pt","columnType":"STRING","comment":""}],"fieldDelimiter":""}', + ], + 'ColumnDataTypeSettings' => [ + 'description' => '列类型映射。', + 'type' => 'array', + 'items' => [ + 'description' => '列类型映射。', + 'type' => 'object', + 'properties' => [ + 'DestinationDataType' => [ + 'description' => '目标端类型。如bigint，boolean，string，text，datetime，timestamp，decimal，binary，不同数据源类型会有类型差异', + 'type' => 'string', + 'example' => 'text', + ], + 'SourceDataType' => [ + 'description' => '源端类型。如bigint，boolean，string，text，datetime，timestamp，decimal，binary，不同数据源类型会有类型差异', + 'type' => 'string', + 'example' => 'bigint', + ], + ], + ], + ], + 'CycleScheduleSettings' => [ + 'description' => '周期调度设置。', + 'type' => 'object', + 'properties' => [ + 'CycleMigrationType' => [ + 'description' => '需要周期调度的同步类型。取值范围：'."\n" + .'- Full：全量'."\n" + .'- OfflineIncremental：离线增量', + 'type' => 'string', + 'example' => 'Full', + ], + 'ScheduleParameters' => [ + 'description' => '调度参数。', + 'type' => 'string', + 'example' => 'bizdate=$bizdate'."\n", + ], + ], + ], + 'DdlHandlingSettings' => [ + 'description' => 'DDL类型处理数组，包含一系列需要处理的DDL类型以及对应规则。', + 'type' => 'array', + 'items' => [ + 'description' => '单条DDL类型处理规则。', + 'type' => 'object', + 'properties' => [ + 'Action' => [ + 'description' => '处理动作，可选的枚举值：'."\n" + ."\n" + .'- Ignore（忽略）'."\n" + .'- Critical（报错）'."\n" + .'- Normal（正常处理）', + 'type' => 'string', + 'example' => 'Ignore', + ], + 'Type' => [ + 'description' => 'DDL类型，可选的枚举值：'."\n" + ."\n" + .'- RenameColumn（重命名列）'."\n" + .'- ModifyColumn（重命名列）'."\n" + .'- CreateTable（重命名列）'."\n" + .'- TruncateTable（清空表）'."\n" + .'- DropTable（删除表）', + 'type' => 'string', + 'example' => 'CreateTable', + ], + ], + ], + ], + 'RuntimeSettings' => [ + 'description' => '运行时设置。', + 'type' => 'array', + 'items' => [ + 'description' => '运行时设置。', + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'description' => '设置名称，可选的枚举值：'."\n" + .'- src.offline.datasource.max.connection（离线批量任务源端最大连接数）'."\n" + .'- dst.offline.truncate (是否清空目标表）'."\n" + .'- runtime.offline.speed.limit.enable（离线批量任务是否开启限流）'."\n" + .'- runtime.offline.concurrent（离线批量同步任务并发度）'."\n" + .'- runtime.enable.auto.create.schema（是否自动在目标端创建schema）'."\n" + .'- runtime.realtime.concurrent（实时任务并发度）'."\n" + .'- runtime.realtime.failover.minute.dataxcdc (failover失败重启等待时间单位分钟)'."\n" + .'- runtime.realtime.failover.times.dataxcdc (failover失败重启次数）', + 'type' => 'string', + 'example' => 'runtime.offline.concurrent'."\n", + ], + 'Value' => [ + 'description' => '设置取值。', + 'type' => 'string', + 'example' => '1', + ], + ], + ], + ], + ], + ], + 'MigrationType' => [ + 'description' => '同步类型，枚举值有：'."\n" + .'- FullAndRealtimeIncremental（全量和实时增量，整库实时）'."\n" + .'- RealtimeIncremental（实时增量，单表实时）'."\n" + .'- Full（全量，整库离线）'."\n" + .'- OfflineIncremental（离线增量，整库离线）'."\n" + .'- FullAndOfflineIncremental（全量+离线增量，整库离线）', + 'type' => 'string', + 'example' => 'FullAndRealtimeIncremental', + ], + 'JobType' => [ + 'description' => '任务类型'."\n" + ."\n" + .'- DatabaseRealtimeMigration(整库实时):将源端多个库的多个表进行流同步，支持仅全量，仅增量，或全量+增量。'."\n" + ."\n" + .'- DatabaseOfflineMigration(整库离线):将源端多个库的多个表进行批同步，支持仅全量，仅增量，或全量+增量。'."\n" + ."\n" + .'- SingleTableRealtimeMigration(单表实时):将源端单个表进行流同步。', + 'type' => 'string', + 'example' => 'DatabaseRealtimeMigration', + ], + 'ProjectId' => [ + 'description' => 'DataWorks工作空间的ID。您可以登录[DataWorks控制台](https://workbench.data.aliyun.com/console)，进入工作空间配置页面获取工作空间ID。'."\n" + ."\n" + .'该参数用来确定本次API调用操作使用的DataWorks工作空间。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '98330', + ], + 'ResourceSettings' => [ + 'description' => '资源设置。', + 'type' => 'object', + 'properties' => [ + 'OfflineResourceSettings' => [ + 'description' => '离线同步资源。', + 'type' => 'object', + 'properties' => [ + 'RequestedCu' => [ + 'description' => '离线同步任务使用的调度资源组cu。', + 'type' => 'number', + 'format' => 'double', + 'example' => '2.0', + ], + 'ResourceGroupIdentifier' => [ + 'description' => '离线同步使用的数据集成资源组名称。', + 'type' => 'string', + 'example' => 'di_resourcegroup_v1', + ], + ], + ], + 'RealtimeResourceSettings' => [ + 'description' => '实时同步资源。', + 'type' => 'object', + 'properties' => [ + 'RequestedCu' => [ + 'description' => '实时同步使用的数据集成资源组cu', + 'type' => 'number', + 'format' => 'double', + 'example' => '2.0', + ], + 'ResourceGroupIdentifier' => [ + 'description' => '实时任务使用的数据集成资源组名称。', + 'type' => 'string', + 'example' => 'di_resourcegroup_v1', + ], + ], + ], + 'ScheduleResourceSettings' => [ + 'description' => '调度资源', + 'type' => 'object', + 'properties' => [ + 'RequestedCu' => [ + 'description' => '离线调度任务使用的数据集成资源组cu', + 'type' => 'number', + 'format' => 'double', + 'example' => '2.0', + ], + 'ResourceGroupIdentifier' => [ + 'description' => '离线调度任务使用的调度资源组名称。', + 'type' => 'string', + 'example' => 'schedual_resourcegroup_v1', + ], + ], + ], + ], + ], + 'SourceDataSourceSettings' => [ + 'description' => '源端数据源设置数组列表。', + 'type' => 'array', + 'items' => [ + 'description' => '单个源端数据源设置。', + 'type' => 'object', + 'properties' => [ + 'DataSourceName' => [ + 'description' => '数据源名称。', + 'type' => 'string', + 'example' => 'dw_mysql', + ], + 'DataSourceProperties' => [ + 'description' => '数据源属性。', + 'type' => 'object', + 'properties' => [ + 'Encoding' => [ + 'description' => '数据库编码。', + 'type' => 'string', + 'example' => 'UTF-8'."\n", + ], + 'Timezone' => [ + 'description' => '时区', + 'type' => 'string', + 'example' => 'GMT+8'."\n", + ], + ], + ], + ], + ], + ], + 'SourceDataSourceType' => [ + 'description' => '源端数据源类型，枚举值： PolarDB，MySQL，Kafka，LogHub，Hologres，Oracle，OceanBase，MongoDB，RedShift，Hive，SQLServer，Doris，ClickHouse。', + 'type' => 'string', + 'example' => 'Mysql', + ], + 'TableMappings' => [ + 'description' => '同步对象转换映射列表，列表中每个元素描述了一组源端同步对象选择规则列表和在该组同步对象上应用的同步对象转换规则列表。'."\n" + ."\n" + .'> ['."\n" + .' {'."\n" + .' "SourceObjectSelectionRules":['."\n" + .' {'."\n" + .' "ObjectType":"Database",'."\n" + .' "Action":"Include",'."\n" + .' "ExpressionType":"Exact",'."\n" + .' "Expression":"biz_db"'."\n" + .' },'."\n" + .' {'."\n" + .' "ObjectType":"Schema",'."\n" + .' "Action":"Include",'."\n" + .' "ExpressionType":"Exact",'."\n" + .' "Expression":"s1"'."\n" + .' }, '."\n" + .' {'."\n" + .' "ObjectType":"Table",'."\n" + .' "Action":"Include",'."\n" + .' "ExpressionType":"Exact",'."\n" + .' "Expression":"table1"'."\n" + .' }'."\n" + .' ],'."\n" + .' "TransformationRuleNames":['."\n" + .' {'."\n" + .' "RuleName":"my_database_rename_rule",'."\n" + .' "RuleActionType":"Rename",'."\n" + .' "RuleTargetType":"Schema"'."\n" + .' }'."\n" + .' ]'."\n" + .' }'."\n" + .']', + 'type' => 'array', + 'items' => [ + 'description' => '每条规则代表选择需要同步的一个表。', + 'type' => 'object', + 'properties' => [ + 'SourceObjectSelectionRules' => [ + 'description' => '每条规则可选择待同步源端对象的集合，多条规则组成选一个表。', + 'type' => 'array', + 'items' => [ + 'description' => '每条规则可选择待同步源端对象的不同对象类型，如选择源端数据库、源端数据表。', + 'type' => 'object', + 'properties' => [ + 'Action' => [ + 'description' => '选择动作，取值范围：Include/Exclude', + 'type' => 'string', + 'example' => 'Include', + ], + 'Expression' => [ + 'description' => '表达式。', + 'type' => 'string', + 'example' => 'mysql_table_1', + ], + 'ExpressionType' => [ + 'description' => '表达式类型，取值范围：Exact/Regex', + 'type' => 'string', + 'example' => 'Exact', + ], + 'ObjectType' => [ + 'description' => '对象类型，可选的枚举值：'."\n" + .'- Table（表）'."\n" + .'- Schema（schema）'."\n" + .'- Database（数据库）', + 'type' => 'string', + 'example' => 'Table', + ], + ], + ], + ], + 'TransformationRules' => [ + 'description' => '同步对象转换规则定义列表，列表中每个元素为一条转换规则定义。', + 'type' => 'array', + 'items' => [ + 'description' => '源端对象上应用的转换规则。', + 'type' => 'object', + 'properties' => [ + 'RuleName' => [ + 'description' => '规则名称，当动作类型和动作作用的目标类型相同时，规则名称需保证唯一性。', + 'type' => 'string', + 'example' => 'rename_rule_1', + ], + 'RuleActionType' => [ + 'description' => '动作类型，可选的枚举值：'."\n" + .'- DefinePrimaryKey（定义主键）'."\n" + .'- Rename（重命名）'."\n" + .'- AddColumn（增加列）'."\n" + .'- HandleDml（DML处理）', + 'type' => 'string', + 'example' => 'AddColumn', + ], + 'RuleTargetType' => [ + 'description' => '动作作用的目标类型，可选的枚举值：'."\n" + .'- Table（表）'."\n" + .'- Schema（schema）'."\n" + .'- Database（数据库）', + 'type' => 'string', + 'example' => 'Table', + ], + ], + ], + ], + ], + ], + ], + 'TransformationRules' => [ + 'description' => '同步对象转换规则定义列表。'."\n" + ."\n" + .'> ['."\n" + .' {'."\n" + .' "RuleName":"my_database_rename_rule",'."\n" + .' "RuleActionType":"Rename",'."\n" + .' "RuleTargetType":"Schema",'."\n" + .' "RuleExpression":"{\\"expression\\":\\"${srcDatasoureName}_${srcDatabaseName}\\"}"'."\n" + .' }'."\n" + .']', + 'type' => 'array', + 'items' => [ + 'description' => '同步对象转换规则定义列表，列表中每个元素为一条转换规则定义。', + 'type' => 'object', + 'properties' => [ + 'RuleActionType' => [ + 'description' => '动作类型，可选的枚举值：'."\n" + .'- DefinePrimaryKey（定义主键）'."\n" + .'- Rename（重命名）'."\n" + .'- AddColumn（增加列）'."\n" + .'- HandleDml（DML处理）'."\n" + .'- DefineIncrementalCondition（定义增量条件）'."\n" + .'- DefineCycleScheduleSettings（定义周期调度设置）'."\n" + .'- DefinePartitionKey（定义分区列）', + 'type' => 'string', + 'example' => 'Rename', + ], + 'RuleExpression' => [ + 'description' => '规则表达式，json string格式。'."\n" + ."\n" + .'1. 重命名规则（Rename）'."\n" + .' - 示例：{"expression":"${srcDatasourceName}_${srcDatabaseName}_0922" }'."\n" + .' - expression：为重命名转换规则表达式，表达式内支持变量包括：${srcDatasourceName}（源端数据源名）、${srcDatabaseName}（源端库名）、${srcTableName}（源端表名）。'."\n" + ."\n" + .'2. 加列规则（AddColumn) '."\n" + .'- 示例：{"columns":[{"columnName":"my_add_column","columnValueType":"Constant","columnValue":"123"}]}'."\n" + .'- 如不指定，默认规则为不加列不复制。'."\n" + .'- columnName：附加的列名称。'."\n" + .'- columnValueType：附加的列取值类型，包括Constant（常量）、Variable（变量）。'."\n" + .'- columnValue：附加的列取值。当columnValueType=Constant时，value为自定义常量，String类型。当columnValueType=Variable时，value为内置变量。内置变量可选值包括：EXECUTE_TIME（执行时间，Long类型）、DB_NAME_SRC（源端数据库名称，String类型）、DATASOURCE_NAME_SRC（源端数据源名称，String类型）、TABLE_NAME_SRC（源端表名，String类型）、DB_NAME_DEST（目标端数据库名称，String类型）、DATASOURCE_NAME_DEST（目标端数据源名称，String类型）、TABLE_NAME_DEST（目标端表名，String类型）、DB_NAME_SRC_TRANSED（转换后的数据库名称，String类型）。'."\n" + ."\n" + .'3. 指定目标端表的主键列列名（DefinePrimaryKey）'."\n" + .'- 示例：{"columns":\\["ukcolumn1","ukcolumn2"\\]}'."\n" + .'- 如不指定默认使用源端主键列。'."\n" + .'- 当目标端为已有表：数据集成系统不会修改目标端表结构，如果指定的主键列不在目标端的列集合中，任务启动会报错提示。'."\n" + .'- 当目标端为自动建表：数据集成系统会自动创建目标端表结构，表结构包含定义的主键列。当指定的主键列不在目标端的列集合中时，任务启动会报错提示。'."\n" + ."\n" + .'4. DML处理规则（HandleDml）'."\n" + .'- 示例：'."\n" + .'{"dmlPolicies":\\[{"dmlType":"Delete","dmlAction":"Filter","filterCondition":"id > 1"}\\]}'."\n" + .'- 如不指定，默认规则为Insert、Update、Delete均为Normal'."\n" + .'- dmlType：DML操作类型，Insert（插入）、Update（更新）、Delete（删除）'."\n" + .'- dmlAction：DML处理策略，Normal（正常处理）、Ignore（忽略）、Filter（有条件的正常处理，当dmlType=Update/Delete时使用）、LogicalDelete（逻辑删除）'."\n" + .'- filterCondition：DML过滤条件，当dmlAction=Filter时使用'."\n" + ."\n\n" + .'5. 增量条件（DefineIncrementalCondition）'."\n" + .'- 示例：'."\n" + .'{"where":"id > 0"} '."\n" + .'- 指定增量过滤条件'."\n" + ."\n" + .'6. 周期调度参数（DefineCycleScheduleSettings）'."\n" + .'- 示例：'."\n" + .'{"cronExpress":" * * * * * *", "cycleType":"1"}'."\n" + .'- 指定周期任务调度参数'."\n" + ."\n" + .'7. 指定分区键（DefinePartitionKey）'."\n" + .'- 示例：'."\n" + .'{"columns":["id"]} '."\n" + .'- 指定分区键', + 'type' => 'string', + 'example' => '{"expression":"${srcDatasoureName}_${srcDatabaseName}"}', + ], + 'RuleName' => [ + 'description' => '规则名称，在一种动作类型+动作作用的目标类型下规则名称唯一。', + 'type' => 'string', + 'example' => 'rename_rule_1', + ], + 'RuleTargetType' => [ + 'description' => '动作作用的目标类型，可选的枚举值：'."\n" + .'- Table（表）'."\n" + .'- Schema（schema）'."\n" + .'- Database（数据库）', + 'type' => 'string', + 'example' => 'Table', + ], + ], + ], + ], + 'JobStatus' => [ + 'description' => '任务状态。'."\n" + .'同步状态，取值范围：'."\n" + .'- Finished：运行成功已结束'."\n" + .'- Failed：运行失败'."\n" + .'- Running：运行中'."\n" + .'- Initialized：初始化完成(未启动）'."\n" + .'- Stopping：停止中'."\n" + .'- Stop：停止', + 'type' => 'string', + 'example' => 'Running', + ], + 'DIJobId' => [ + 'description' => '该字段已废弃，请使用Id字段。', + 'type' => 'string', + 'deprecated' => true, + 'example' => '32601', + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"C99E2BE6-9DEA-5C2E-8F51-1DDCFEADE490\\",\\n \\"PagingInfo\\": {\\n \\"Id\\": 32601,\\n \\"Description\\": \\"description\\",\\n \\"DestinationDataSourceSettings\\": [\\n {\\n \\"DataSourceName\\": \\"dw_mysql\\"\\n }\\n ],\\n \\"DestinationDataSourceType\\": \\"Hologres\\",\\n \\"JobName\\": \\"imp_ods_dms_det_dealer_info_df\\",\\n \\"JobSettings\\": {\\n \\"ChannelSettings\\": \\"{\\\\\\"structInfo\\\\\\":\\\\\\"MANAGED\\\\\\",\\\\\\"storageType\\\\\\":\\\\\\"TEXTFILE\\\\\\",\\\\\\"writeMode\\\\\\":\\\\\\"APPEND\\\\\\",\\\\\\"partitionColumns\\\\\\":[{\\\\\\"columnName\\\\\\":\\\\\\"pt\\\\\\",\\\\\\"columnType\\\\\\":\\\\\\"STRING\\\\\\",\\\\\\"comment\\\\\\":\\\\\\"\\\\\\"}],\\\\\\"fieldDelimiter\\\\\\":\\\\\\"\\\\\\"}\\",\\n \\"ColumnDataTypeSettings\\": [\\n {\\n \\"DestinationDataType\\": \\"text\\",\\n \\"SourceDataType\\": \\"bigint\\"\\n }\\n ],\\n \\"CycleScheduleSettings\\": {\\n \\"CycleMigrationType\\": \\"Full\\",\\n \\"ScheduleParameters\\": \\"bizdate=$bizdate\\\\n\\"\\n },\\n \\"DdlHandlingSettings\\": [\\n {\\n \\"Action\\": \\"Ignore\\",\\n \\"Type\\": \\"CreateTable\\"\\n }\\n ],\\n \\"RuntimeSettings\\": [\\n {\\n \\"Name\\": \\"runtime.offline.concurrent\\\\n\\",\\n \\"Value\\": \\"1\\"\\n }\\n ]\\n },\\n \\"MigrationType\\": \\"FullAndRealtimeIncremental\\",\\n \\"JobType\\": \\"DatabaseRealtimeMigration\\",\\n \\"ProjectId\\": 98330,\\n \\"ResourceSettings\\": {\\n \\"OfflineResourceSettings\\": {\\n \\"RequestedCu\\": 2,\\n \\"ResourceGroupIdentifier\\": \\"di_resourcegroup_v1\\"\\n },\\n \\"RealtimeResourceSettings\\": {\\n \\"RequestedCu\\": 2,\\n \\"ResourceGroupIdentifier\\": \\"di_resourcegroup_v1\\"\\n },\\n \\"ScheduleResourceSettings\\": {\\n \\"RequestedCu\\": 2,\\n \\"ResourceGroupIdentifier\\": \\"schedual_resourcegroup_v1\\"\\n }\\n },\\n \\"SourceDataSourceSettings\\": [\\n {\\n \\"DataSourceName\\": \\"dw_mysql\\",\\n \\"DataSourceProperties\\": {\\n \\"Encoding\\": \\"UTF-8\\\\n\\",\\n \\"Timezone\\": \\"GMT+8\\\\n\\"\\n }\\n }\\n ],\\n \\"SourceDataSourceType\\": \\"Mysql\\",\\n \\"TableMappings\\": [\\n {\\n \\"SourceObjectSelectionRules\\": [\\n {\\n \\"Action\\": \\"Include\\",\\n \\"Expression\\": \\"mysql_table_1\\",\\n \\"ExpressionType\\": \\"Exact\\",\\n \\"ObjectType\\": \\"Table\\"\\n }\\n ],\\n \\"TransformationRules\\": [\\n {\\n \\"RuleName\\": \\"rename_rule_1\\",\\n \\"RuleActionType\\": \\"AddColumn\\",\\n \\"RuleTargetType\\": \\"Table\\"\\n }\\n ]\\n }\\n ],\\n \\"TransformationRules\\": [\\n {\\n \\"RuleActionType\\": \\"Rename\\",\\n \\"RuleExpression\\": \\"{\\\\\\"expression\\\\\\":\\\\\\"${srcDatasoureName}_${srcDatabaseName}\\\\\\"}\\",\\n \\"RuleName\\": \\"rename_rule_1\\",\\n \\"RuleTargetType\\": \\"Table\\"\\n }\\n ],\\n \\"JobStatus\\": \\"Running\\",\\n \\"DIJobId\\": \\"32601\\"\\n }\\n}","type":"json"}]', + 'title' => '查看数据集成同步任务配置详情', + 'description' => '需要购买DataWorks基础版及以上版本才能使用。', + ], + 'GetDIJobLog' => [ + 'summary' => '获取数据集成任务日志。', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '235251', + 'abilityTreeNodes' => [ + 'FEATUREdideBP0OJZ', + ], + 'autoTest' => false, + ], + 'parameters' => [ + [ + 'name' => 'Id', + 'in' => 'query', + 'schema' => [ + 'description' => '任务ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '10000', + ], + ], + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '实例的ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '6153616438', + ], + ], + [ + 'name' => 'FailoverId', + 'in' => 'query', + 'schema' => [ + 'description' => 'Failover的ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'DIJobId', + 'in' => 'query', + 'schema' => [ + 'description' => '该字段已废弃，请使用Id字段。', + 'type' => 'integer', + 'format' => 'int64', + 'deprecated' => true, + 'required' => false, + 'example' => '10000', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'allowEmptyValue' => true, + 'schema' => [ + 'description' => '分页查询的页码。取值为大于等于1的正整数。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'NodeType', + 'in' => 'query', + 'schema' => [ + 'description' => '节点类型，目前在查看资源组2.0任务中才适用：'."\n" + .'* **MASTER**：获取JobManager的日志。'."\n" + .'* **WORKER**：获取TaskManager的日志。', + 'type' => 'string', + 'required' => false, + 'example' => 'MASTER', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '返回的日志内容', + 'type' => 'object', + 'properties' => [ + 'Log' => [ + 'title' => '资源一级ID', + 'description' => '任务日志', + 'type' => 'string', + 'example' => '>>>>>>>> stdout:n++++++++++++++++++executing sql: create database if not exists jindo_test location \'oss://pangbei-hdfs/tmp/hive\' n++n', + ], + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求的ID。用于定位日志，排查问题。', + 'type' => 'string', + 'example' => '1AFAE64E-D1BE-432B-A9****', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Log\\": \\">>>>>>>> stdout:n++++++++++++++++++executing sql: create database if not exists jindo_test location \'oss://pangbei-hdfs/tmp/hive\' n++n\\",\\n \\"RequestId\\": \\"1AFAE64E-D1BE-432B-A9****\\"\\n}","type":"json"}]', + 'title' => '查看数据集成同步任务的运行日志', + 'description' => '需要购买DataWorks基础版及以上版本才能使用。', + ], + 'ListDIJobs' => [ + 'summary' => '查询数据集成新版任务列表，包括整库同步实时任务，整库同步离线任务，单表同步实时任务等数据集成任务。', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '234100', + 'abilityTreeNodes' => [ + 'FEATUREdideBP0OJZ', + ], + ], + 'parameters' => [ + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '页码，从1开始，默认值为1。'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '每页显示的数据条数，默认为10条，最大为100条。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => [ + 'description' => '导出任务的名称。'."\n" + ."\n" + .'名称必须唯一，即当前DataWorks工作空间中不能存在名称重复的导出任务。', + 'type' => 'string', + 'required' => false, + 'example' => 'test_export_01', + ], + ], + [ + 'name' => 'SourceDataSourceType', + 'in' => 'query', + 'schema' => [ + 'description' => '源端数据源类型，不填代表不限制，枚举值：PolarDB，MySQL，Kafka，LogHub，Hologres，Oracle，OceanBase，MongoDB，RedShift，Hive，SQLServer，Doris，ClickHouse。', + 'type' => 'string', + 'required' => false, + 'example' => 'MySQL', + ], + ], + [ + 'name' => 'DestinationDataSourceType', + 'in' => 'query', + 'schema' => [ + 'description' => '目标端数据源类型，不填代表不限制，枚举值：Hologres，OSS-HDFS，OSS，MaxCompute，LogHub，StarRocks，DataHub，AnalyticDB_For_MySQL，Kafka，Hive。', + 'type' => 'string', + 'required' => false, + 'example' => 'Hologres', + ], + ], + [ + 'name' => 'MigrationType', + 'in' => 'query', + 'schema' => [ + 'description' => '同步类型，可选的枚举值有：'."\n" + .'- FullAndRealtimeIncremental（全量和实时增量）'."\n" + .'- RealtimeIncremental（实时增量）'."\n" + .'- Full（全量）'."\n" + .'- OfflineIncremental（离线增量）'."\n" + .'- FullAndOfflineIncremental（全量+离线增量）', + 'type' => 'string', + 'required' => false, + 'example' => 'FullAndRealtimeIncremental', + ], + ], + [ + 'name' => 'ProjectId', + 'in' => 'query', + 'schema' => [ + 'description' => '工作空间的ID。'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1967', + ], + ], + [ + 'name' => 'SpecType', + 'in' => 'query', + 'schema' => [ + 'title' => '任务配置规范类型。可选FILESPEC、CLASSIC、ALL。FILESPEC：基于结构化 filespec 的新版任务；CLASSIC：传统配置模式的任务；', + 'description' => '任务配置规范类型。可选FILESPEC、CLASSIC、ALL。FILESPEC：基于结构化 filespec 的新版任务；CLASSIC：传统配置模式的任务；', + 'type' => 'string', + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request', + 'type' => 'string', + 'example' => '7263E4AC-9D2E-5B29-B8AF-7C5012E92A41', + ], + 'PagingInfo' => [ + 'description' => '分页信息', + 'type' => 'object', + 'properties' => [ + 'TotalCount' => [ + 'description' => '满足条件的数据总条数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '12', + ], + 'PageSize' => [ + 'description' => '每页显示的条数', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10', + ], + 'PageNumber' => [ + 'description' => '请求的数据页数，用于翻页。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'DIJobs' => [ + 'description' => '一组数据集成任务', + 'type' => 'array', + 'items' => [ + 'description' => '一个数据集成任务', + 'type' => 'object', + 'properties' => [ + 'Id' => [ + 'description' => '数据集成任务ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '32599', + ], + 'ProjectId' => [ + 'description' => '任务所在DataWorks空间的ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '26442', + ], + 'JobName' => [ + 'description' => '任务名称。', + 'type' => 'string', + 'example' => 'mysql_to_holo_sync_35197', + ], + 'MigrationType' => [ + 'description' => '同步类型，可选的枚举值有：'."\n" + .'- FullAndRealtimeIncremental（全量和实时增量）'."\n" + .'- RealtimeIncremental（实时增量）'."\n" + .'- Full（全量）'."\n" + .'- OfflineIncremental（离线增量）'."\n" + .'- FullAndOfflineIncremental（全量+离线增量）', + 'type' => 'string', + 'example' => 'FullAndRealtimeIncremental', + ], + 'SourceDataSourceType' => [ + 'description' => '源端数据源类型，枚举值：PolarDB，MySQL，Kafka，Loghub，Hologres，Oracle，OceanBase，MongoDB，RedShift，Hive，SqlServer，Doris，ClickHouse。', + 'type' => 'string', + 'example' => 'Mysql', + ], + 'DestinationDataSourceType' => [ + 'description' => '目标端数据源类型，枚举值：Hologres，OSS-HDFS，OSS，MaxCompute，Loghub，STARROCKS，DataHub，ANALYTICDB_FOR_MYSQL，Kafka，Hive。', + 'type' => 'string', + 'example' => 'Hologres', + ], + 'JobStatus' => [ + 'description' => '同步状态，可选的枚举值：'."\n" + .'- Finished（运行成功已结束）'."\n" + .'- Initialized（初始化完成）'."\n" + .'- Stopped（已停止）'."\n" + .'- Failed（运行失败）'."\n" + .'- Running（运行中）'."\n" + .'- Stopping（停止中）', + 'type' => 'string', + 'example' => 'Running', + ], + 'DIJobId' => [ + 'description' => '该字段已废弃，请使用Id字段。', + 'type' => 'integer', + 'format' => 'int64', + 'deprecated' => true, + 'example' => '32599', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"7263E4AC-9D2E-5B29-B8AF-7C5012E92A41\\",\\n \\"PagingInfo\\": {\\n \\"TotalCount\\": 12,\\n \\"PageSize\\": 10,\\n \\"PageNumber\\": 1,\\n \\"DIJobs\\": [\\n {\\n \\"Id\\": 32599,\\n \\"ProjectId\\": 26442,\\n \\"JobName\\": \\"mysql_to_holo_sync_35197\\",\\n \\"MigrationType\\": \\"FullAndRealtimeIncremental\\",\\n \\"SourceDataSourceType\\": \\"Mysql\\",\\n \\"DestinationDataSourceType\\": \\"Hologres\\",\\n \\"JobStatus\\": \\"Running\\",\\n \\"DIJobId\\": 32599\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => '获取数据集成同步任务配置列表', + 'description' => '需要购买DataWorks基础版及以上版本才能使用。', + ], + 'ListDIJobRunDetails' => [ + 'summary' => '获取数据集成运行信息。', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '235254', + 'abilityTreeNodes' => [ + 'FEATUREdideBP0OJZ', + ], + ], + 'parameters' => [ + [ + 'name' => 'DIJobId', + 'in' => 'query', + 'schema' => [ + 'description' => '任务ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '11265', + ], + ], + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '实例的ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1234', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '请求的数据页数，用于翻页。'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '每页显示的条数，默认为10条，最大100条。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'SourceDataSourceName', + 'in' => 'query', + 'schema' => [ + 'description' => '筛选的源端数据源名。', + 'type' => 'string', + 'required' => false, + 'example' => 'ds_name', + ], + ], + [ + 'name' => 'SourceDatabaseName', + 'in' => 'query', + 'schema' => [ + 'description' => '筛选的源端数据库名。', + 'type' => 'string', + 'required' => false, + 'example' => 'db_name', + ], + ], + [ + 'name' => 'SourceSchemaName', + 'in' => 'query', + 'schema' => [ + 'description' => '筛选的源端schema名。', + 'type' => 'string', + 'required' => false, + 'example' => 'schema_name', + ], + ], + [ + 'name' => 'SourceTableName', + 'in' => 'query', + 'schema' => [ + 'description' => '筛选的源端表名。', + 'type' => 'string', + 'required' => false, + 'example' => 'table_name', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求的ID。用于定位日志，排查问题。', + 'type' => 'string', + 'example' => '691CA452-D37A-4ED0-9441', + ], + 'PagingInfo' => [ + 'description' => '分页信息', + 'type' => 'object', + 'properties' => [ + 'TotalCount' => [ + 'description' => '满足条件的数据总条数。', + 'type' => 'string', + 'example' => '131', + ], + 'PageSize' => [ + 'description' => '每页显示的条数', + 'type' => 'string', + 'example' => '10', + ], + 'PageNumber' => [ + 'description' => '查询分页的页码。', + 'type' => 'string', + 'example' => '1', + ], + 'JobRunInfos' => [ + 'description' => '任务运行信息。', + 'type' => 'array', + 'items' => [ + 'description' => '单个表的任务运行信息。', + 'type' => 'object', + 'properties' => [ + 'SourceDatasourceName' => [ + 'description' => '源端数据源名。', + 'type' => 'string', + 'example' => 'ds_name', + ], + 'SourceDatabaseName' => [ + 'description' => '源端数据库名。', + 'type' => 'string', + 'example' => 'db_name', + ], + 'SourceSchemaName' => [ + 'description' => '源端schema名。', + 'type' => 'string', + 'example' => 'schema_name', + ], + 'SourceTableName' => [ + 'description' => '源表名。', + 'type' => 'string', + 'example' => 'table_name', + ], + 'DestinationDatasourceName' => [ + 'description' => '目的端数据源名。', + 'type' => 'string', + 'example' => 'dst_name', + ], + 'DestinationDatabaseName' => [ + 'description' => '目的端数据库名。', + 'type' => 'string', + 'example' => 'dst_db', + ], + 'DestinationSchemaName' => [ + 'description' => '目的端Schema名。', + 'type' => 'string', + 'example' => 'dst_schema', + ], + 'DestinationTableName' => [ + 'description' => '目的端表名。', + 'type' => 'string', + 'example' => 'dst_name', + ], + 'StructureMigrationStatus' => [ + 'description' => '结构同步状态。', + 'type' => 'string', + 'example' => 'Finished', + ], + 'StructureMigrationErrorMessage' => [ + 'description' => '结构同步报错信息，如不报错则为空。', + 'type' => 'string', + 'example' => 'create table t1 fail.', + ], + 'FullMigrationStatus' => [ + 'description' => '全量离线迁移状态。', + 'type' => 'string', + 'example' => 'Finished', + ], + 'FullMigrationErrorMessage' => [ + 'description' => '全量离线迁移报错信息，如不报错则为空。', + 'type' => 'string', + 'example' => 'sync table t1 fail.', + ], + 'OfflineErrorRecords' => [ + 'description' => '全量同步总错误数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'OfflineTotalBytes' => [ + 'description' => '全量同步总Bytes数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '100', + ], + 'OfflineTotalRecords' => [ + 'description' => '全量同步总条数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10', + ], + 'RealtimeMigrationStatus' => [ + 'description' => '实时同步状态。', + 'type' => 'string', + 'example' => 'Running', + ], + 'RealtimeMigrationErrorMessage' => [ + 'description' => '实时同步错误信息，如不报错则为空', + 'type' => 'string', + 'example' => 'sync table t1 fail.'."\n", + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"691CA452-D37A-4ED0-9441\\",\\n \\"PagingInfo\\": {\\n \\"TotalCount\\": \\"131\\",\\n \\"PageSize\\": \\"10\\",\\n \\"PageNumber\\": \\"1\\",\\n \\"JobRunInfos\\": [\\n {\\n \\"SourceDatasourceName\\": \\"ds_name\\",\\n \\"SourceDatabaseName\\": \\"db_name\\",\\n \\"SourceSchemaName\\": \\"schema_name\\",\\n \\"SourceTableName\\": \\"table_name\\",\\n \\"DestinationDatasourceName\\": \\"dst_name\\",\\n \\"DestinationDatabaseName\\": \\"dst_db\\",\\n \\"DestinationSchemaName\\": \\"dst_schema\\",\\n \\"DestinationTableName\\": \\"dst_name\\",\\n \\"StructureMigrationStatus\\": \\"Finished\\",\\n \\"StructureMigrationErrorMessage\\": \\"create table t1 fail.\\",\\n \\"FullMigrationStatus\\": \\"Finished\\",\\n \\"FullMigrationErrorMessage\\": \\"sync table t1 fail.\\",\\n \\"OfflineErrorRecords\\": 0,\\n \\"OfflineTotalBytes\\": 100,\\n \\"OfflineTotalRecords\\": 10,\\n \\"RealtimeMigrationStatus\\": \\"Running\\",\\n \\"RealtimeMigrationErrorMessage\\": \\"sync table t1 fail.\\\\n\\"\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => '获取数据集成同步任务运行的执行进展', + 'description' => '需要购买DataWorks基础版及以上版本才能使用。', + ], + 'ListDIJobMetrics' => [ + 'summary' => '获取数据集成任务指标。', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '235252', + 'abilityTreeNodes' => [ + 'FEATUREdideBP0OJZ', + ], + 'autoTest' => false, + ], + 'parameters' => [ + [ + 'name' => 'DIJobId', + 'in' => 'query', + 'schema' => [ + 'description' => '实例 ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '11265', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '起始时间。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1586509407', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '结束时间。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1712205941', + ], + ], + [ + 'name' => 'MetricName', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '需要查询的指标列表。', + 'type' => 'array', + 'items' => [ + 'description' => '需要查询的指标名称，目前支持下面6种指标'."\n" + .'- resourceUtilization: 资源组使用率 （只有在serverless资源组上才支持）'."\n" + .'- delayTime: 任务延迟'."\n" + .'- totalRecordsRead:读端同步条数'."\n" + .'- speedRecordsRead: 读端同步速率'."\n" + .'- totalRecordsWrite:写端同步条数'."\n" + .'- speedRecordsWrite:写端同步速率。', + 'type' => 'string', + 'required' => false, + 'example' => 'delayTime', + ], + 'required' => true, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求的ID。用于定位日志，排查问题。', + 'type' => 'string', + 'example' => '691CA452-D37A-4ED0-9441', + ], + 'PagingInfo' => [ + 'description' => '分页信息', + 'type' => 'object', + 'properties' => [ + 'JobMetrics' => [ + 'description' => '任务指标列表。', + 'type' => 'array', + 'items' => [ + 'description' => '单个指标的信息。', + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'description' => '查询的指标名称。', + 'type' => 'string', + 'example' => 'JobDelay', + ], + 'SeriesList' => [ + 'description' => '具体的指标数组，由一系列不同时间的采样时间和采样值组成。', + 'type' => 'array', + 'items' => [ + 'description' => '指标内容。', + 'type' => 'object', + 'properties' => [ + 'Time' => [ + 'description' => '采样时间点。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1716881141', + ], + 'Value' => [ + 'description' => '样本值。', + 'type' => 'number', + 'format' => 'double', + 'example' => '10', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"691CA452-D37A-4ED0-9441\\",\\n \\"PagingInfo\\": {\\n \\"JobMetrics\\": [\\n {\\n \\"Name\\": \\"JobDelay\\",\\n \\"SeriesList\\": [\\n {\\n \\"Time\\": 1716881141,\\n \\"Value\\": 10\\n }\\n ]\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => '查看数据集成同步任务运行指标', + 'description' => '需要购买DataWorks基础版及以上版本才能使用。', + ], + 'ListDIJobEvents' => [ + 'summary' => '获取数据集成任务事件。', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '235253', + 'abilityTreeNodes' => [ + 'FEATUREdideBP0OJZ', + ], + ], + 'parameters' => [ + [ + 'name' => 'DIJobId', + 'in' => 'query', + 'schema' => [ + 'description' => '实例 ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '11588', + ], + ], + [ + 'name' => 'EventType', + 'in' => 'query', + 'schema' => [ + 'description' => '查询的Event类型，目前支持Failover/Alarm/DDL。', + 'type' => 'string', + 'required' => true, + 'example' => 'Alarm', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '起始时间。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1716971005', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '结束时间。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1717971005', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '页码，从1开始，默认值为1。'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '每页显示的条数，默认为10条，最大100条。'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '10', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求的ID。用于定位日志，排查问题。', + 'type' => 'string', + 'example' => '645F6D68-9C29-5961-80B1-BDD4****', + ], + 'PagingInfo' => [ + 'description' => '分页信息', + 'type' => 'object', + 'properties' => [ + 'TotalCount' => [ + 'description' => '满足条件的数据总条数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2524', + ], + 'PageSize' => [ + 'description' => '每页显示的条数', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10', + ], + 'PageNumber' => [ + 'description' => '请求的数据页数，用于翻页。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'DIJobEvent' => [ + 'description' => '事件的数组', + 'type' => 'array', + 'items' => [ + 'description' => '单个事件的详情。', + 'type' => 'object', + 'properties' => [ + 'Id' => [ + 'description' => '事件唯一ID。', + 'type' => 'string', + 'example' => '1', + ], + 'CreateTime' => [ + 'description' => '创建时间。', + 'type' => 'string', + 'example' => '1663573162', + ], + 'FailoverMessage' => [ + 'description' => 'Failover的报错日志。', + 'type' => 'string', + 'example' => '2024-05-29 15:11:31,377 [main] INFO com.*.**.di.core.metrics.:21 [] {****} '."\n" + .'2024-05-29 15:11:31,384 [main] INFO *.aliyun.*.di.*.*.metrics.*:27 [] - Open MarioDiReporter '."\n" + .'2024-05-29 15:11:33,248 [flink-akka.*.*-dispatcher-17] INFO ', + ], + 'Severity' => [ + 'description' => '告警严重程度，取值范围：Warning/Critical。', + 'type' => 'string', + 'example' => 'Warning', + ], + 'Channels' => [ + 'description' => '告警的发送方式，取值范围：Phone/Mail/Sms/Ding/Webhook。', + 'type' => 'string', + 'example' => 'Phone', + ], + 'Status' => [ + 'description' => '告警的发送状态，取值范围：Success/Fail/Silence。', + 'type' => 'string', + 'example' => 'Success', + ], + 'Detail' => [ + 'description' => '告警详情。', + 'type' => 'string', + 'example' => '数据集成同步任务异常: Level: WARNING, DataWorks项目名:** [Region: cn-shanghai], 任务名:**, 报警规则:业务延迟, aggregator:avg [**] for 5 minutes, service maybe abnormal', + ], + 'Type' => [ + 'description' => '告警事件类型'."\n" + .'- Heartbeat: 任务心跳报警'."\n" + .'- Delay: 任务延迟报警'."\n" + .'- FailoverCount: failover次数报警'."\n" + .'- DdlReport: DDL通知'."\n" + .'- ResourceUtilization： 资源组使用率。', + 'type' => 'string', + 'example' => 'Delay', + ], + 'Action' => [ + 'description' => 'DDL事件的处理结果，取值范围：Critical/Ignore/Normal/Warning。', + 'type' => 'string', + 'example' => 'Ignore', + ], + 'SrcTable' => [ + 'description' => '来源表名。', + 'type' => 'string', + 'example' => 'table1', + ], + 'DstTable' => [ + 'description' => '去向表名。', + 'type' => 'string', + 'example' => 'table2', + ], + 'SrcSql' => [ + 'description' => '来源表DDL语句。', + 'type' => 'string', + 'example' => 'alter table table1 ***', + ], + 'DstSql' => [ + 'description' => '去向表DDL语句。', + 'type' => 'string', + 'example' => 'alter table table2 ***', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"645F6D68-9C29-5961-80B1-BDD4****\\",\\n \\"PagingInfo\\": {\\n \\"TotalCount\\": 2524,\\n \\"PageSize\\": 10,\\n \\"PageNumber\\": 1,\\n \\"DIJobEvent\\": [\\n {\\n \\"Id\\": \\"1\\",\\n \\"CreateTime\\": \\"1663573162\\",\\n \\"FailoverMessage\\": \\"2024-05-29 15:11:31,377 [main] INFO com.*.**.di.core.metrics.:21 [] {****} \\\\n2024-05-29 15:11:31,384 [main] INFO *.aliyun.*.di.*.*.metrics.*:27 [] - Open MarioDiReporter \\\\n2024-05-29 15:11:33,248 [flink-akka.*.*-dispatcher-17] INFO \\",\\n \\"Severity\\": \\"Warning\\",\\n \\"Channels\\": \\"Phone\\",\\n \\"Status\\": \\"Success\\",\\n \\"Detail\\": \\"数据集成同步任务异常: Level: WARNING, DataWorks项目名:** [Region: cn-shanghai], 任务名:**, 报警规则:业务延迟, aggregator:avg [**] for 5 minutes, service maybe abnormal\\",\\n \\"Type\\": \\"Delay\\",\\n \\"Action\\": \\"Ignore\\",\\n \\"SrcTable\\": \\"table1\\",\\n \\"DstTable\\": \\"table2\\",\\n \\"SrcSql\\": \\"alter table table1 ***\\",\\n \\"DstSql\\": \\"alter table table2 ***\\"\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => '获取数据集成同步任务的运行事件列表', + 'description' => '需要购买DataWorks基础版及以上版本才能使用。', + ], + 'CreateDIAlarmRule' => [ + 'summary' => '创建数据集成报警规则。', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '234126', + 'abilityTreeNodes' => [ + 'FEATUREdideBP0OJZ', + ], + ], + 'parameters' => [ + [ + 'name' => 'Description', + 'in' => 'query', + 'schema' => [ + 'title' => '描述。', + 'description' => '描述。', + 'type' => 'string', + 'required' => false, + 'example' => '告警描述', + ], + ], + [ + 'name' => 'MetricType', + 'in' => 'query', + 'schema' => [ + 'title' => '告警指标类型，可选的枚举值：'."\n" + .'- Heartbeat（任务状态报警）'."\n" + .'- FailoverCount（failover次数报警）'."\n" + .'- Delay（任务延迟报警）', + 'description' => '告警指标类型，可选的枚举值：'."\n" + .'- Heartbeat（任务状态报警）'."\n" + .'- FailoverCount（failover次数报警）'."\n" + .'- Delay（任务延迟报警）'."\n" + .'- DdlReport（DDL通知）'."\n" + .'- ResourceUtilization（资源组使用率）', + 'type' => 'string', + 'required' => true, + 'example' => 'Heartbeat', + 'enum' => [], + ], + ], + [ + 'name' => 'Enabled', + 'in' => 'query', + 'schema' => [ + 'title' => '告警规则是否启用，默认不开启。', + 'description' => '告警规则是否启用，默认不开启。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + 'default' => 'false', + ], + ], + [ + 'name' => 'DIJobId', + 'in' => 'query', + 'schema' => [ + 'title' => '任务ID，是告警规则关联的任务ID。', + 'description' => '任务ID，是告警规则关联的任务ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1', + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'allowEmptyValue' => false, + 'schema' => [ + 'title' => '幂等参数', + 'description' => '幂等参数', + 'type' => 'string', + 'required' => false, + 'example' => 'ABFUOEUOTRTRJKE', + ], + ], + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => [ + 'description' => '告警规则名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'alartRule', + ], + ], + [ + 'name' => 'TriggerConditions', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '告警触发条件列表，支持多条件。', + 'type' => 'array', + 'items' => [ + 'description' => '告警触发条件列表，支持多条件。', + 'type' => 'object', + 'properties' => [ + 'Severity' => [ + 'description' => '严重程度，可选的枚举值：'."\n" + .'- Warning'."\n" + .'- Critical', + 'type' => 'string', + 'required' => false, + 'example' => 'Warning', + ], + 'Duration' => [ + 'description' => '告警计算时间区间，单位分钟。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '10', + ], + 'Threshold' => [ + 'description' => '告警阈值。'."\n" + .'- 任务状态报警：无需填写阈值。'."\n" + .'- failover次数报警：阈值为failover次数。'."\n" + .'- 任务延迟报警：阈值为延迟时长，单位秒。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '10', + ], + 'DdlTypes' => [ + 'description' => '在DDL通知的时候才生效，需要生效的DDL列表。', + 'type' => 'array', + 'items' => [ + 'description' => '在MetricType配置为DdlReport时才返回需要生效的DDL列表，包括 '."\n" + .'- AlterAddColumn 加列'."\n" + .' - AlterDropColumn 删列'."\n" + .' - AlterRenameColumn 修改列名'."\n" + .' - AlterRenameTable 修改表名'."\n" + .' - AlterTableModify 其他修改表'."\n" + .' - DropTable 删除表'."\n" + .' - TruncateTable 清空表', + 'type' => 'string', + 'required' => false, + 'example' => 'AlterAddColumn', + ], + 'required' => false, + ], + 'DdlReportTags' => [ + 'description' => '该字段已废弃，请使用DdlTypes字段。', + 'type' => 'array', + 'items' => [ + 'description' => '该字段已废弃，请使用DdlTypes字段。', + 'type' => 'string', + 'deprecated' => true, + 'required' => false, + 'example' => 'AlterAddColumn', + ], + 'deprecated' => true, + 'required' => false, + ], + ], + 'required' => false, + ], + 'required' => true, + ], + ], + [ + 'name' => 'NotificationSettings', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '告警通知设置。', + 'type' => 'object', + 'properties' => [ + 'NotificationChannels' => [ + 'description' => '告警通知渠道。', + 'type' => 'array', + 'items' => [ + 'description' => '告警通知渠道。', + 'type' => 'object', + 'properties' => [ + 'Severity' => [ + 'description' => '严重程度，可选的枚举值：'."\n" + .'- Warning'."\n" + .'- Critical', + 'type' => 'string', + 'required' => false, + 'example' => 'Warning', + ], + 'Channels' => [ + 'description' => '通道，可选的枚举值：'."\n" + .'- Mail（邮件）'."\n" + .'- Phone（电话）'."\n" + .'- Sms（短信）'."\n" + .'- Ding（钉钉）', + 'type' => 'array', + 'items' => [ + 'description' => '通道，可选的枚举值：'."\n" + .'- Mail（邮件）'."\n" + .'- Phone（电话）'."\n" + .'- Sms（短信）'."\n" + .'- Ding（钉钉）', + 'type' => 'string', + 'required' => false, + 'example' => 'Ding', + ], + 'required' => false, + ], + ], + 'required' => false, + ], + 'required' => false, + ], + 'NotificationReceivers' => [ + 'description' => '告警通知接收方。', + 'type' => 'array', + 'items' => [ + 'description' => '告警通知接收方。', + 'type' => 'object', + 'properties' => [ + 'ReceiverType' => [ + 'description' => '接收方类型，取值范围：AliyunUid/DingToken/FeishuToken/WebHookUrl', + 'type' => 'string', + 'required' => false, + 'example' => 'DingToken', + ], + 'ReceiverValues' => [ + 'description' => '接收方取值。'."\n" + .'- 当接收方类型为阿里云ID时，接收方取值为具体阿里云用户ID。'."\n" + .'- 当接收方类型为钉钉token时，接收方取值为具体钉钉token值。', + 'type' => 'array', + 'items' => [ + 'description' => '接收方取值。'."\n" + .'- 当接收方类型为阿里云ID时，接收方取值为具体阿里云用户ID。'."\n" + .'- 当接收方类型为钉钉token时，接收方取值为具体钉钉token值。', + 'type' => 'string', + 'required' => false, + 'example' => 'token1', + ], + 'required' => false, + ], + ], + 'required' => false, + ], + 'required' => false, + ], + 'MuteInterval' => [ + 'description' => '告警抑制间隔时长，单位分钟，默认5分钟。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '5', + ], + 'InhibitionInterval' => [ + 'description' => '该字段已废弃，请使用MuteInterval进行配置。', + 'type' => 'integer', + 'format' => 'int32', + 'deprecated' => true, + 'required' => false, + 'example' => '5', + ], + ], + 'required' => true, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'Id' => [ + 'description' => '告警规则ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'RequestId' => [ + 'description' => '请求的ID。用于定位日志，排查问题。', + 'type' => 'string', + 'example' => 'C636A747-7E4E-594D-94CD-2B****', + ], + 'DIAlarmRuleId' => [ + 'title' => '资源一级ID', + 'description' => '该字段已废弃，请使用Id字段。', + 'type' => 'string', + 'deprecated' => true, + 'example' => '1', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Id\\": 1,\\n \\"RequestId\\": \\"C636A747-7E4E-594D-94CD-2B****\\",\\n \\"DIAlarmRuleId\\": \\"1\\"\\n}","type":"json"}]', + 'title' => '创建数据集成同步任务告警规则', + 'description' => '需要购买DataWorks基础版及以上版本才能使用。', + ], + 'UpdateDIAlarmRule' => [ + 'summary' => '更新数据集成报警规则。', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '234128', + 'abilityTreeNodes' => [ + 'FEATUREdideBP0OJZ', + ], + ], + 'parameters' => [ + [ + 'name' => 'Id', + 'in' => 'query', + 'schema' => [ + 'description' => '告警规则ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '34982', + ], + ], + [ + 'name' => 'Description', + 'in' => 'query', + 'schema' => [ + 'description' => '告警规则描述。', + 'type' => 'string', + 'required' => false, + 'example' => '告警规则描述。', + ], + ], + [ + 'name' => 'MetricType', + 'in' => 'query', + 'schema' => [ + 'description' => '告警指标类型，可选的枚举值：'."\n" + .'- Heartbeat（任务状态报警）'."\n" + .'- FailoverCount（failover次数报警）'."\n" + .'- Delay（任务延迟报警）'."\n" + .'- DdlReport: DDL通知'."\n" + .'- ResourceUtilization： 资源组使用率', + 'type' => 'string', + 'required' => false, + 'example' => 'Heartbeat', + ], + ], + [ + 'name' => 'Enabled', + 'in' => 'query', + 'schema' => [ + 'description' => '告警规则是否启用，默认不开启。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'DIJobId', + 'in' => 'query', + 'schema' => [ + 'description' => '任务ID。', + 'type' => 'integer', + 'format' => 'int64', + 'deprecated' => false, + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'TriggerConditions', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '告警触发条件列表，支持多条件。', + 'type' => 'array', + 'items' => [ + 'description' => '告警触发条件列表，支持多条件。', + 'type' => 'object', + 'properties' => [ + 'Severity' => [ + 'description' => '严重程度，可选的枚举值;'."\n" + .'- Warning'."\n" + .'- Critical', + 'type' => 'string', + 'required' => false, + 'example' => 'Warning', + ], + 'Duration' => [ + 'description' => '告警计算时间区间，单位分钟。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '15', + ], + 'Threshold' => [ + 'description' => '告警阈值。'."\n" + ."\n" + .'- 任务状态报警：无需填写阈值。'."\n" + .'- failover次数报警：阈值为failover次数。'."\n" + .'- 任务延迟报警：阈值为延迟时长，单位秒。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '5', + ], + 'DdlTypes' => [ + 'description' => '在DDL通知的时候才生效，需要生效的DDL列表。', + 'type' => 'array', + 'items' => [ + 'description' => '在MetricType配置为DdlReport时才返回需要生效的DDL列表，包括 '."\n" + .'- AlterAddColumn 加列'."\n" + .' - AlterDropColumn 删列'."\n" + .' - AlterRenameColumn 修改列名'."\n" + .' - AlterRenameTable 修改表名'."\n" + .' - AlterTableModify 其他修改表'."\n" + .' - DropTable 删除表'."\n" + .' - TruncateTable 清空表', + 'type' => 'string', + 'required' => false, + 'example' => 'AlterAddColumn', + ], + 'required' => false, + ], + 'DdlReportTags' => [ + 'description' => '该字段已废弃，请使用DdlTypes字段。', + 'type' => 'array', + 'items' => [ + 'description' => '该字段已废弃，请使用DdlTypes字段。', + 'type' => 'string', + 'deprecated' => true, + 'required' => false, + 'example' => 'AlterAddColumn', + ], + 'deprecated' => true, + 'required' => false, + ], + ], + 'required' => false, + ], + 'required' => false, + ], + ], + [ + 'name' => 'NotificationSettings', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '告警通知设置。', + 'type' => 'object', + 'properties' => [ + 'NotificationChannels' => [ + 'description' => '告警通知渠道。', + 'type' => 'array', + 'items' => [ + 'description' => '告警通知渠道。', + 'type' => 'object', + 'properties' => [ + 'Severity' => [ + 'description' => '严重程度，可选的枚举值：'."\n" + .'- Warning'."\n" + .'- Critical', + 'type' => 'string', + 'required' => false, + 'example' => 'Warning', + ], + 'Channels' => [ + 'description' => '通道，可选的枚举值：'."\n" + .'- Mail（邮件）'."\n" + .'- Phone（电话）'."\n" + .'- Sms（短信）'."\n" + .'- Ding（钉钉）', + 'type' => 'array', + 'items' => [ + 'description' => '通道，可选的枚举值：'."\n" + .'- Mail（邮件）'."\n" + .'- Phone（电话）'."\n" + .'- Sms（短信）'."\n" + .'- Ding（钉钉）', + 'type' => 'string', + 'required' => false, + 'example' => 'Ding', + ], + 'required' => false, + ], + ], + 'required' => false, + ], + 'required' => false, + ], + 'NotificationReceivers' => [ + 'description' => '告警通知接收方。', + 'type' => 'array', + 'items' => [ + 'description' => '告警通知接收方。', + 'type' => 'object', + 'properties' => [ + 'ReceiverType' => [ + 'description' => '接收方类型，取值范围：AliyunUid/DingToken/FeishuToken/WebHookUrl', + 'type' => 'string', + 'required' => false, + 'example' => 'DingToken', + ], + 'ReceiverValues' => [ + 'description' => '接收方取值。'."\n" + ."\n" + .'- 当接收方类型为阿里云ID时，接收方取值为具体阿里云用户ID。'."\n" + .'- 当接收方类型为钉钉token时，接收方取值为具体钉钉token值。', + 'type' => 'array', + 'items' => [ + 'description' => '接收方取值。'."\n" + ."\n" + .'- 当接收方类型为阿里云ID时，接收方取值为具体阿里云用户ID。'."\n" + .'- 当接收方类型为钉钉token时，接收方取值为具体钉钉token值。', + 'type' => 'string', + 'required' => false, + 'example' => 'token1', + ], + 'required' => false, + ], + ], + 'required' => false, + ], + 'required' => false, + ], + 'MuteInterval' => [ + 'description' => '告警抑制间隔时长，单位分钟，默认5分钟。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '5', + ], + 'InhibitionInterval' => [ + 'description' => '该字段已废弃，请使用MuteInterval进行配置。', + 'type' => 'integer', + 'format' => 'int64', + 'deprecated' => true, + 'required' => false, + 'example' => '5', + ], + ], + 'required' => false, + ], + ], + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => [ + 'description' => '告警规则的名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'alarm_rule_name', + ], + ], + [ + 'name' => 'DIAlarmRuleId', + 'in' => 'query', + 'schema' => [ + 'description' => '该字段已废弃，请使用Id字段。', + 'type' => 'integer', + 'format' => 'int64', + 'deprecated' => true, + 'required' => false, + 'example' => '34982', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '资源ID，如ECS实例的创建接口CreateInstance应返回InstanceId。', + 'description' => '请求的ID。用于定位日志，排查问题。', + 'type' => 'string', + 'example' => 'A6C6B486-E3A2-5D52-9E76-D9380485D946', + ], + 'Success' => [ + 'description' => '调用是否成功。取值如下：'."\n" + .'- true：调用成功。'."\n" + .'- false：调用失败，您可以根据请求ID定位具体问题。', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A6C6B486-E3A2-5D52-9E76-D9380485D946\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => '更新数据集成同步任务告警规则', + 'description' => '需要购买DataWorks基础版及以上版本才能使用。', + ], + 'DeleteDIAlarmRule' => [ + 'summary' => '删除数据集成报警规则。', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '234127', + 'abilityTreeNodes' => [ + 'FEATUREdideBP0OJZ', + ], + ], + 'parameters' => [ + [ + 'name' => 'Id', + 'in' => 'query', + 'schema' => [ + 'description' => '告警规则ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '2', + ], + ], + [ + 'name' => 'DIJobId', + 'in' => 'query', + 'schema' => [ + 'description' => '任务ID。', + 'type' => 'integer', + 'format' => 'int64', + 'deprecated' => false, + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'DIAlarmRuleId', + 'in' => 'query', + 'schema' => [ + 'description' => '该字段已废弃，请使用Id字段。', + 'type' => 'integer', + 'format' => 'int64', + 'deprecated' => true, + 'required' => false, + 'example' => '2', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '资源一级ID', + 'description' => '请求的ID。用于定位日志，排查问题。', + 'type' => 'string', + 'example' => 'C99E2BE6-9DEA-5C2E-8F51-1DDCFE****', + ], + 'Success' => [ + 'description' => '请求是否成功，取值如下：'."\n" + .'- true, 请求成功'."\n" + .'- false， 请求失败', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"C99E2BE6-9DEA-5C2E-8F51-1DDCFE****\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => '删除数据集成同步任务告警规则', + 'description' => '需要购买DataWorks基础版及以上版本才能使用。', + ], + 'ListDIAlarmRules' => [ + 'summary' => '查看数据集成报警规则。', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '234129', + 'abilityTreeNodes' => [ + 'FEATUREdideBP0OJZ', + ], + ], + 'parameters' => [ + [ + 'name' => 'JobId', + 'in' => 'query', + 'schema' => [ + 'description' => '任务ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1000001', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '请求的数据页数，用于翻页。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '每页显示的条数，默认为10条，最大100条。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'DIAlarmRuleId', + 'in' => 'query', + 'schema' => [ + 'description' => '指定查询特定的告警规则ID，如为空，则查询JobId下的所有告警规则。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '34988', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求的ID。用于定位日志，排查问题。', + 'type' => 'string', + 'example' => '74C2FECD-5B3A-554A-BCF5-351A36DE9815', + ], + 'PagingInfo' => [ + 'description' => '分页信息', + 'type' => 'object', + 'properties' => [ + 'TotalCount' => [ + 'description' => '满足条件的数据总条数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '90', + ], + 'PageNumber' => [ + 'description' => '分页页码，从1开始。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '每页显示的条数', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10', + ], + 'DIJobAlarmRules' => [ + 'description' => '告警规则列表。', + 'type' => 'array', + 'items' => [ + 'description' => '单个告警规则详情。', + 'type' => 'object', + 'properties' => [ + 'Id' => [ + 'description' => '告警规则ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '72402', + ], + 'DIJobId' => [ + 'description' => '任务ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '32594', + ], + 'Description' => [ + 'description' => '告警规则描述。', + 'type' => 'string', + 'example' => 'rule descrition', + ], + 'MetricType' => [ + 'description' => '告警指标类型，可选的枚举值：'."\n" + .'- Heartbeat（任务状态报警）'."\n" + .'- FailoverCount（failover次数报警）'."\n" + .'- Delay（任务延迟报警）'."\n" + .'- DdlReport（DDL通知）'."\n" + .'- ResourceUtilization（资源组使用率）', + 'type' => 'string', + 'example' => 'Heartbeat', + ], + 'Name' => [ + 'description' => '告警规则名称。', + 'type' => 'string', + 'example' => 'rule_name', + ], + 'Enabled' => [ + 'description' => '告警规则是否启用。', + 'type' => 'boolean', + 'example' => 'True', + ], + 'TriggerConditions' => [ + 'description' => '告警触发条件列表，支持多条件。', + 'type' => 'array', + 'items' => [ + 'description' => '告警触发条件。', + 'type' => 'object', + 'properties' => [ + 'Severity' => [ + 'description' => '严重程度，可选的枚举值：'."\n" + .'- Warning'."\n" + .'- Critical', + 'type' => 'string', + 'example' => 'Critical', + ], + 'Duration' => [ + 'description' => '告警计算时间区间，单位分钟。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'Threshold' => [ + 'description' => '告警阈值。'."\n" + ."\n" + .'- 任务状态报警：无阈值。'."\n" + .'- failover次数报警：阈值为failover次数。'."\n" + .'- 任务延迟报警：阈值为延迟时长，单位秒。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '5', + ], + 'DdlTypes' => [ + 'description' => '在MetricType配置为DdlReport时才返回需要生效的DDL列表。', + 'type' => 'array', + 'items' => [ + 'description' => '在MetricType配置为DdlReport时才返回需要生效的DDL列表，包括'."\n" + ."\n" + .'- AlterAddColumn 加列'."\n" + .'- AlterDropColumn 删列'."\n" + .'- AlterRenameColumn 修改列名'."\n" + .'- AlterRenameTable 修改表名'."\n" + .'- AlterTableModify 其他修改表'."\n" + .'- DropTable 删除表'."\n" + .'- TruncateTable 清空表', + 'type' => 'string', + 'example' => 'AlterAddColumn', + ], + ], + 'DdlReportTags' => [ + 'description' => '该字段已废弃，请使用DdlTypes字段', + 'type' => 'array', + 'items' => [ + 'description' => '该字段已废弃，请使用DdlTypes字段', + 'type' => 'string', + 'deprecated' => true, + 'example' => 'ALTERADDCOLUMN', + ], + 'deprecated' => true, + ], + ], + ], + ], + 'NotificationSettings' => [ + 'description' => '告警通知渠道和接收人设置。', + 'type' => 'object', + 'properties' => [ + 'NotificationChannels' => [ + 'description' => '告警通知渠道数组。', + 'type' => 'array', + 'items' => [ + 'description' => '单个告警通知渠道。', + 'type' => 'object', + 'properties' => [ + 'Severity' => [ + 'description' => '严重程度，可选的枚举值：'."\n" + .'- Warning'."\n" + .'- Critical', + 'type' => 'string', + 'example' => 'Critical', + ], + 'Channels' => [ + 'description' => '告警通道设置数组。', + 'type' => 'array', + 'items' => [ + 'description' => '通道，可选的枚举值;'."\n" + .'- Mail（邮件）'."\n" + .'- Phone（电话）'."\n" + .'- Sms（短信）'."\n" + .'- Ding（钉钉）', + 'type' => 'string', + 'example' => 'Ding', + ], + ], + ], + ], + ], + 'NotificationReceivers' => [ + 'description' => '告警通知接收方。', + 'type' => 'array', + 'items' => [ + 'description' => '告警通知接收方。', + 'type' => 'object', + 'properties' => [ + 'ReceiverType' => [ + 'description' => '接收方类型，取值范围：AliyunUid/DingToken/FeishuToken/WebHookUrl', + 'type' => 'string', + 'example' => 'DingToken', + ], + 'ReceiverValues' => [ + 'description' => '接收方取值。'."\n" + .'- 当接收方类型为阿里云ID时，接收方取值为具体阿里云用户ID。'."\n" + .'- 当接收方类型为钉钉token时，接收方取值为具体钉钉token值。', + 'type' => 'array', + 'items' => [ + 'description' => '接收方取值。'."\n" + ."\n" + .'- 当接收方类型为阿里云ID时，接收方取值为具体阿里云用户ID。'."\n" + .'- 当接收方类型为钉钉token时，接收方取值为具体钉钉token值。', + 'type' => 'string', + 'example' => 'token1', + ], + ], + ], + ], + ], + 'MuteInterval' => [ + 'description' => '告警抑制间隔时长，单位分钟。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '5', + ], + 'InhibitionInterval' => [ + 'description' => '该字段已废弃，请使用MuteInterval字段', + 'type' => 'integer', + 'format' => 'int64', + 'deprecated' => true, + 'example' => '5', + ], + ], + ], + 'DIAlarmRuleId' => [ + 'description' => '该字段已废弃，请使用Id字段。', + 'type' => 'integer', + 'format' => 'int64', + 'deprecated' => true, + 'example' => '72402', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"74C2FECD-5B3A-554A-BCF5-351A36DE9815\\",\\n \\"PagingInfo\\": {\\n \\"TotalCount\\": 90,\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"DIJobAlarmRules\\": [\\n {\\n \\"Id\\": 72402,\\n \\"DIJobId\\": 32594,\\n \\"Description\\": \\"rule descrition\\",\\n \\"MetricType\\": \\"Heartbeat\\",\\n \\"Name\\": \\"rule_name\\",\\n \\"Enabled\\": true,\\n \\"TriggerConditions\\": [\\n {\\n \\"Severity\\": \\"Critical\\",\\n \\"Duration\\": 1,\\n \\"Threshold\\": 5,\\n \\"DdlTypes\\": [\\n \\"AlterAddColumn\\"\\n ],\\n \\"DdlReportTags\\": [\\n \\"ALTERADDCOLUMN\\"\\n ]\\n }\\n ],\\n \\"NotificationSettings\\": {\\n \\"NotificationChannels\\": [\\n {\\n \\"Severity\\": \\"Critical\\",\\n \\"Channels\\": [\\n \\"Ding\\"\\n ]\\n }\\n ],\\n \\"NotificationReceivers\\": [\\n {\\n \\"ReceiverType\\": \\"DingToken\\",\\n \\"ReceiverValues\\": [\\n \\"token1\\"\\n ]\\n }\\n ],\\n \\"MuteInterval\\": 5,\\n \\"InhibitionInterval\\": 5\\n },\\n \\"DIAlarmRuleId\\": 72402\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => '获取数据集成同步任务告警规则列表', + 'description' => '需要购买DataWorks基础版及以上版本才能使用。', + ], + 'ListCrawlerTypes' => [ + 'summary' => '查询数据地图支持的元数据采集器类型列表，其中包含元数据采集器类型，及给定类型支持的子类型和子类型之间的层级关系信息。', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'abilityTreeCode' => '268429', + 'abilityTreeNodes' => [ + 'FEATUREdideE9XYA6', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '0000-ABCD-EFG****', + ], + 'Success' => [ + 'title' => '是否请求成功', + 'description' => '是否请求成功。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'CrawlerTypes' => [ + 'title' => '元数据采集器类型列表', + 'description' => '元数据采集器类型列表。', + 'type' => 'array', + 'items' => [ + 'description' => '支持的元数据采集器类型信息。', + '$ref' => '#/components/schemas/CrawlerType', + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0000-ABCD-EFG****\\",\\n \\"Success\\": true,\\n \\"CrawlerTypes\\": [\\n {\\n \\"Type\\": \\"dlf\\",\\n \\"DisplayName\\": \\"Data Lake Formation\\",\\n \\"SupportedEntityTypes\\": [\\n {\\n \\"Type\\": \\"dlf-table\\",\\n \\"SubType\\": \\"table\\",\\n \\"Optional\\": true,\\n \\"ParentSubType\\": \\"database\\"\\n }\\n ]\\n }\\n ]\\n}","type":"json"}]', + 'title' => '获取数据地图元数据采集器类型列表', + 'description' => '1. 需要购买DataWorks基础版及以上版本才能使用。', + ], + 'ListCatalogs' => [ + 'summary' => '查询数据地图下的数据目录列表，当前支持dlf与starrocks类型。'."\n" + .'dlf类型返回支持的所有数据目录列表，starrocks类型返回特定实例下的数据目录列表。', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'abilityTreeCode' => '267928', + 'abilityTreeNodes' => [ + 'FEATUREdideE9XYA6', + ], + ], + 'parameters' => [ + [ + 'name' => 'ParentMetaEntityId', + 'in' => 'query', + 'allowEmptyValue' => true, + 'schema' => [ + 'title' => '父层级实体ID', + 'description' => '父层级实体ID，可参考[元数据实体相关概念说明](~~2880092~~)。'."\n" + ."\n\n" + .'当前支持dlf与starrocks类型。'."\n" + ."\n" + .'- 对于dlf类型，支持查询所有目录列表，`ParentMetaEntityId`格式为 `dlf`'."\n" + ."\n" + .'- 对于starrocks类型，支持查询特定实例下的数据目录列表，`ParentMetaEntityId`格式为 `starrocks:(instance_id|encoded_jdbc_url)`'."\n" + ."\n" + .'>其中 '."\n" + .'`instance_id`: 实例ID，对应数据源以实例模式注册时需要提供 '."\n" + .'`encoded_jdbc_url`: JDBC连接串的URLEncode编码,对应数据源以连接串方式注册时需要提供', + 'type' => 'string', + 'required' => true, + 'example' => 'dlf', + ], + ], + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => [ + 'title' => '名称，模糊匹配', + 'description' => '名称，模糊匹配。', + 'type' => 'string', + 'required' => false, + 'example' => 'abc', + ], + ], + [ + 'name' => 'Comment', + 'in' => 'query', + 'schema' => [ + 'title' => '注释，模糊匹配', + 'description' => '注释，分词匹配。', + 'type' => 'string', + 'required' => false, + 'example' => 'this is a comment', + ], + ], + [ + 'name' => 'Types', + 'in' => 'query', + 'style' => 'simple', + 'schema' => [ + 'title' => '类型，精确匹配，支持多项，按照逻辑或的关系查询', + 'description' => '类型，精确匹配，为空时查询所有类型。', + 'type' => 'array', + 'items' => [ + 'description' => '数据目录类型。', + 'type' => 'string', + 'required' => false, + 'example' => 'HIVE', + ], + 'required' => false, + ], + ], + [ + 'name' => 'SortBy', + 'in' => 'query', + 'schema' => [ + 'title' => '排序字段，默认为CreateTime', + 'description' => '排序字段，默认为CreateTime，枚举值，当前支持'."\n" + ."\n\n" + .'- CreateTime 创建时间'."\n" + .'- ModifyTime 修改时间'."\n" + .'- Name 名称'."\n" + .'- Type 类型', + 'type' => 'string', + 'required' => false, + 'example' => 'CreateTime', + 'pattern' => '^[\\w.,;/@-]+$', + 'default' => 'CreateTime', + 'enum' => [ + 'CreateTime', + 'ModifyTime', + 'Name', + 'Type', + ], + ], + ], + [ + 'name' => 'Order', + 'in' => 'query', + 'schema' => [ + 'title' => '排序方向，默认为Asc', + 'description' => '排序方向，默认为Asc，枚举值，当前支持'."\n" + ."\n\n" + .'- Asc 升序'."\n" + .'- Desc 降序', + 'type' => 'string', + 'required' => false, + 'example' => 'Asc', + 'default' => 'Asc', + 'enum' => [ + 'Asc', + 'Desc', + ], + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'title' => '分页页码，默认为1', + 'description' => '分页页码，默认为1。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'minimum' => '1', + 'example' => '1', + 'default' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'title' => '分页大小，默认为10，最大为100', + 'description' => '分页大小，默认为10，最大为100。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '100', + 'minimum' => '1', + 'example' => '10', + 'default' => '10', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '317CD7D0-AB36-XXXXXX', + ], + 'Success' => [ + 'title' => '请求是否成功', + 'description' => '请求是否成功。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'PagingInfo' => [ + 'title' => '分页结果', + 'description' => '分页结果。', + 'type' => 'object', + 'properties' => [ + 'TotalCount' => [ + 'description' => '总条数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'PageNumber' => [ + 'description' => '页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '分页大小。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'Catalogs' => [ + 'description' => '数据目录列表。', + 'type' => 'array', + 'items' => [ + 'description' => '数据目录详情。', + '$ref' => '#/components/schemas/Catalog', + ], + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"317CD7D0-AB36-XXXXXX\\",\\n \\"Success\\": true,\\n \\"PagingInfo\\": {\\n \\"TotalCount\\": 1,\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"Catalogs\\": [\\n {\\n \\"Id\\": \\"\\",\\n \\"Name\\": \\"\\",\\n \\"Comment\\": \\"\\",\\n \\"Type\\": \\"\\",\\n \\"CreateTime\\": 0,\\n \\"ModifyTime\\": 0,\\n \\"ParentMetaEntityId\\": \\"\\"\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => '查询数据地图数据目录列表', + 'description' => '1. 需要购买DataWorks基础版及以上版本才能使用。', + ], + 'GetCatalog' => [ + 'summary' => '获取数据地图中给定数据目录的详情信息，当前支持dlf与starrocks类型。', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'abilityTreeCode' => '267969', + 'abilityTreeNodes' => [ + 'FEATUREdideE9XYA6', + ], + ], + 'parameters' => [ + [ + 'name' => 'Id', + 'in' => 'query', + 'schema' => [ + 'title' => 'ID', + 'description' => '数据目录实体ID，当前支持dlf与starrocks类型，可参考ListCatalogs接口返回结果，以及[元数据实体相关概念说明](~~2880092~~)。'."\n" + ."\n\n" + .'- 对于dlf类型，格式为 `dlf-catalog::catalog_id`'."\n" + ."\n" + .'- 对于starrocks类型，格式为`starrocks-catalog:(instance_id|encoded_jdbc_url):catalog_name`'."\n" + ."\n" + .'> 其中 '."\n" + .'`catalog_id`: dlf目录id '."\n" + .'`instance_id`: 实例ID，对应数据源以实例模式注册时需要提供 '."\n" + .'`encoded_jdbc_url`: JDBC连接串的URLEncode编码,对应数据源以连接串方式注册时需要提供 '."\n" + .'`catalog_name`: starrocks目录名称', + 'type' => 'string', + 'required' => true, + 'example' => 'dlf-catalog::catalog_id', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '1AFAE64E-D1BE-432B-A9****', + ], + 'Success' => [ + 'title' => '请求是否成功', + 'description' => '请求是否成功。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Catalog' => [ + 'description' => '数据目录信息。', + '$ref' => '#/components/schemas/Catalog', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1AFAE64E-D1BE-432B-A9****\\",\\n \\"Success\\": true,\\n \\"Catalog\\": {\\n \\"Id\\": \\"\\",\\n \\"Name\\": \\"\\",\\n \\"Comment\\": \\"\\",\\n \\"Type\\": \\"\\",\\n \\"CreateTime\\": 0,\\n \\"ModifyTime\\": 0,\\n \\"ParentMetaEntityId\\": \\"\\"\\n }\\n}","type":"json"}]', + 'title' => '获取数据地图数据目录详情', + 'description' => '1. 需要购买DataWorks基础版及以上版本才能使用。', + ], + 'ListDatabases' => [ + 'summary' => '查询数据地图中给定实例/集群/数据目录下的数据库列表。'."\n" + .'对于dlf/starrocks类型，查询给定数据目录下的数据库列表，其中starocks类型仅支持查询Internal Catalog；'."\n" + .'对于其他类型，查询给定实例/集群下的数据库列表。', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'abilityTreeCode' => '267985', + 'abilityTreeNodes' => [ + 'FEATUREdideE9XYA6', + ], + ], + 'parameters' => [ + [ + 'name' => 'ParentMetaEntityId', + 'in' => 'query', + 'allowEmptyValue' => true, + 'schema' => [ + 'title' => '父层级实体ID', + 'description' => '父层级实体ID，可参考[元数据实体相关概念说明](~~2880092~~)。'."\n" + ."\n" + .'父层级实体类型参考ListCrawlerTypes接口'."\n" + ."\n" + .'- 若父层级实体为数据目录，`ParentMetaEntityId`格式参考ListCatalogs接口返回结果。'."\n" + ."\n" + .'- 如果父层级实体为元数据采集器，`ParentMetaEntityId`格式为`${CrawlerType}:${实例ID或转义后的URL}`。'."\n" + ."\n" + .'几种常用类型的ParentMetaEntityId格式参考如下：'."\n" + ."\n" + .'- `dlf-catalog::catalog_id`'."\n" + ."\n" + .'- `holo:instance_id`'."\n" + ."\n" + .'- `mysql:(instance_id|encoded_jdbc_url)`'."\n" + ."\n" + .'> 其中 '."\n" + .'- `catalog_id`: dlf目录id。'."\n" + .'- `instance_id`: 实例ID，对应数据源以实例模式注册时需要提供。'."\n" + .'- `encoded_jdbc_url`: JDBC连接串的URLEncode编码,对应数据源以连接串方式注册时需要提供。', + 'type' => 'string', + 'required' => true, + 'example' => 'holo:instance_id', + ], + ], + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => [ + 'title' => '名称，模糊匹配', + 'description' => '名称，模糊匹配。', + 'type' => 'string', + 'required' => false, + 'example' => 'test_tbl', + ], + ], + [ + 'name' => 'Comment', + 'in' => 'query', + 'schema' => [ + 'title' => '注释，模糊匹配', + 'description' => '注释，模糊匹配。', + 'type' => 'string', + 'required' => false, + 'example' => 'test comment', + ], + ], + [ + 'name' => 'SortBy', + 'in' => 'query', + 'schema' => [ + 'title' => '排序字段，默认为CreateTime', + 'description' => '排序字段，默认为CreateTime，枚举值，当前支持：'."\n" + ."\n" + .'- CreateTime：创建时间'."\n" + .'- ModifyTime：修改时间'."\n" + .'- Name：名称', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [], + 'example' => 'CreateTime', + 'pattern' => '^[\\w.,;/@-]+$', + 'default' => 'CreateTime', + 'enum' => [ + 'CreateTime', + 'ModifyTime', + 'Name', + ], + ], + ], + [ + 'name' => 'Order', + 'in' => 'query', + 'schema' => [ + 'title' => '排序方向，默认为Asc', + 'description' => '排序方向，默认为Asc，枚举值，当前支持：'."\n" + ."\n" + .'- Asc：升序'."\n" + .'- Desc：降序', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [], + 'example' => 'Asc', + 'default' => 'Asc', + 'enum' => [ + 'Asc', + 'Desc', + ], + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'title' => '分页页码，默认为1', + 'description' => '分页页码，默认为1。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'minimum' => '1', + 'example' => '1', + 'default' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'title' => '分页大小，默认为10，最大为100', + 'description' => '分页大小，默认为10，最大为100。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '100', + 'minimum' => '1', + 'example' => '10', + 'default' => '10', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '9DD08926-38B9-XXXXXXX', + ], + 'Success' => [ + 'title' => '请求是否成功', + 'description' => '请求是否成功。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'PagingInfo' => [ + 'title' => '分页结果', + 'description' => '分页结果。', + 'type' => 'object', + 'properties' => [ + 'TotalCount' => [ + 'description' => '总条数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'PageNumber' => [ + 'description' => '页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '分页大小。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'Databases' => [ + 'description' => '数据库列表。', + 'type' => 'array', + 'items' => [ + 'description' => '数据库信息。', + '$ref' => '#/components/schemas/Database', + ], + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"9DD08926-38B9-XXXXXXX\\",\\n \\"Success\\": true,\\n \\"PagingInfo\\": {\\n \\"TotalCount\\": 1,\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"Databases\\": [\\n {\\n \\"Id\\": \\"holo-database:h-xxxx::test_db\\",\\n \\"Name\\": \\"test_db\\",\\n \\"Comment\\": \\"test comment\\",\\n \\"LocationUri\\": \\"oss://test-bucket/test_db\\",\\n \\"ParentMetaEntityId\\": \\"holo:h-xxxx\\",\\n \\"CreateTime\\": 1736852168000,\\n \\"ModifyTime\\": 1736852168000\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => '查询数据地图数据库列表', + 'description' => '1. 需要购买DataWorks基础版及以上版本才能使用。'."\n" + .'2. 对于starrocks类型，当前仅支持查询Internal catalog', + ], + 'GetDatabase' => [ + 'summary' => '获取数据地图给定数据库的详情信息。', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'abilityTreeCode' => '267986', + 'abilityTreeNodes' => [ + 'FEATUREdideE9XYA6', + ], + ], + 'parameters' => [ + [ + 'name' => 'Id', + 'in' => 'query', + 'schema' => [ + 'title' => 'ID', + 'description' => '数据库实体ID，可参考ListDatabases接口返回结果，以及[元数据实体相关概念说明](~~2880092~~)。'."\n" + ."\n" + .'格式为`${EntityType}:${实例ID或转义后的URL}:${数据目录标识}:${数据库名称}`，对于不存在的层级使用空字符占位。'."\n" + ."\n" + .'> starrocks类型的数据目录标识为目录名称，dlf类型的数据目录标识为目录ID, 其他类型不支持目录层级，可用空字符占位。'."\n" + ."\n" + .'几种常用类型ID格式参考如下'."\n" + ."\n" + .'- `dlf-database::catalog_id:database_name`'."\n" + ."\n" + .'- `holo-database:instance_id::database_name`'."\n" + ."\n" + .'- `mysql-database:(instance_id|encoded_jdbc_url)::database_name`'."\n" + ."\n" + .'> 其中 '."\n" + .'> - `catalog_id`: dlf目录id。'."\n" + .'> - `instance_id`: 实例ID，对应数据源以实例模式注册时需要提供。'."\n" + .'> - `encoded_jdbc_url`: JDBC连接串的URLEncode编码,对应数据源以连接串方式注册时需要提供。'."\n" + .'> - `database_name`: 数据库名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'dlf-database::catalog_id:database_name', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '1AFAE64E-D1BE-432B-A9****', + ], + 'Success' => [ + 'title' => '请求是否成功', + 'description' => '请求是否成功。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Database' => [ + 'description' => '数据库详情。', + '$ref' => '#/components/schemas/Database', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1AFAE64E-D1BE-432B-A9****\\",\\n \\"Success\\": true,\\n \\"Database\\": {\\n \\"Id\\": \\"holo-database:h-xxxx::test_db\\",\\n \\"Name\\": \\"test_db\\",\\n \\"Comment\\": \\"test comment\\",\\n \\"LocationUri\\": \\"oss://test-bucket/test_db\\",\\n \\"ParentMetaEntityId\\": \\"holo:h-xxxx\\",\\n \\"CreateTime\\": 1736852168000,\\n \\"ModifyTime\\": 1736852168000\\n }\\n}","type":"json"}]', + 'title' => '获取数据地图数据库详情', + 'description' => '1. 需要购买DataWorks基础版及以上版本才能使用。', + ], + 'ListSchemas' => [ + 'summary' => '查询数据地图中给定数据库或maxcompute项目下的模式列表，当前支持maxcompute和holo类型。', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'abilityTreeCode' => '267987', + 'abilityTreeNodes' => [ + 'FEATUREdideE9XYA6', + ], + ], + 'parameters' => [ + [ + 'name' => 'ParentMetaEntityId', + 'in' => 'query', + 'allowEmptyValue' => true, + 'schema' => [ + 'title' => '父层级实体ID', + 'description' => '父层级实体ID，可参考[元数据实体相关概念说明](~~2880092~~)，其中holo类型的`ParentMetaEntityId`可参考ListDatabases接口返回结果。'."\n" + ."\n" + .'`ParentMetaEntityId`格式为`${EntityType}:${实例ID或转义后的URL}:${数据目录标识}:${数据库名称}`，对于不存在的层级空字符占位。'."\n" + ."\n" + .'> 对于maxcompute类型，实例id层级使用空字符占位，数据库名称为maxcompute项目名称，要求该项目已开启三层模型。'."\n" + ."\n" + .'几种常用类型ParentMetaEntityId格式参考如下'."\n" + .' '."\n" + .'`maxcompute-project:::project_name` （要求该项目已开启三层模型）'."\n" + ."\n" + .'`holo-database:instance_id::database_name`'."\n" + ."\n" + .'> 其中 '."\n" + .'`instance_id`: holo实例ID '."\n" + .'`database_name`: 数据库名称 '."\n" + .'`project_name`: maxcompute项目名', + 'type' => 'string', + 'required' => true, + 'example' => 'maxcompute-project:::project_name', + ], + ], + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => [ + 'title' => '名称，模糊匹配', + 'description' => '名称，模糊匹配。', + 'type' => 'string', + 'required' => false, + 'example' => 'abc', + ], + ], + [ + 'name' => 'Comment', + 'in' => 'query', + 'schema' => [ + 'title' => '注释，模糊匹配', + 'description' => '注释，模糊匹配。', + 'type' => 'string', + 'required' => false, + 'example' => 'test comment', + ], + ], + [ + 'name' => 'Types', + 'in' => 'query', + 'style' => 'simple', + 'schema' => [ + 'title' => '类型，精确匹配，支持多项，按照逻辑或的关系查询', + 'description' => '类型，精确匹配，为空时查询所有类型。', + 'type' => 'array', + 'items' => [ + 'description' => '模式类型。', + 'type' => 'string', + 'required' => false, + 'example' => 'MANAGED', + ], + 'required' => false, + ], + ], + [ + 'name' => 'SortBy', + 'in' => 'query', + 'schema' => [ + 'title' => '排序字段，默认为CreateTime', + 'description' => '排序字段，默认为CreateTime，枚举值，当前支持：'."\n" + ."\n" + .'- CreateTime：创建时间。'."\n" + .'- ModifyTime：修改时间。'."\n" + .'- Name：名称。'."\n" + .'- Type：类型。', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [], + 'example' => 'CreateTime', + 'pattern' => '^[\\w.,;/@-]+$', + 'default' => 'CreateTime', + 'enum' => [ + 'CreateTime', + 'ModifyTime', + 'Name', + 'Type', + ], + ], + ], + [ + 'name' => 'Order', + 'in' => 'query', + 'schema' => [ + 'title' => '排序方向，默认为Asc', + 'description' => '排序方向，默认为Asc，枚举值，当前支持：'."\n" + ."\n" + .'- Asc：升序。'."\n" + .'- Desc：降序。', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [], + 'example' => 'Asc', + 'default' => 'Asc', + 'enum' => [ + 'Asc', + 'Desc', + ], + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'title' => '分页页码，默认为1', + 'description' => '分页页码，默认为1。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'minimum' => '1', + 'example' => '1', + 'default' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'title' => '分页大小，默认为10，最大为100', + 'description' => '分页大小，默认为10，最大为100。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '100', + 'minimum' => '1', + 'example' => '10', + 'default' => '10', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '235BBA5E-3428-XXXXXX', + ], + 'Success' => [ + 'title' => '请求是否成功', + 'description' => '请求是否成功。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'PagingInfo' => [ + 'description' => '分页信息。', + 'type' => 'object', + 'properties' => [ + 'TotalCount' => [ + 'description' => '总条数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'PageNumber' => [ + 'description' => '页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '分页大小。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'Schemas' => [ + 'description' => '数据库schema列表。', + 'type' => 'array', + 'items' => [ + 'description' => '数据库schema。', + '$ref' => '#/components/schemas/Schema', + ], + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"235BBA5E-3428-XXXXXX\\",\\n \\"Success\\": true,\\n \\"PagingInfo\\": {\\n \\"TotalCount\\": 1,\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"Schemas\\": [\\n {\\n \\"Id\\": \\"maxcompute-schema:123456::test_project:default\\",\\n \\"Name\\": \\"test_db\\",\\n \\"Comment\\": \\"test comment\\",\\n \\"Type\\": \\"MANAGED\\",\\n \\"ParentMetaEntityId\\": \\"maxcompute-project:123456::test_project\\",\\n \\"CreateTime\\": 1736852168000,\\n \\"ModifyTime\\": 1736852168000\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => '查询数据地图数据库模式列表', + 'description' => '1. 需要购买DataWorks基础版及以上版本才能使用。', + ], + 'GetSchema' => [ + 'summary' => '获取数据地图中给定模式的详细信息，当前支持MaxCompute和Hologres类型。', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'abilityTreeCode' => '267988', + 'abilityTreeNodes' => [ + 'FEATUREdideE9XYA6', + ], + ], + 'parameters' => [ + [ + 'name' => 'Id', + 'in' => 'query', + 'schema' => [ + 'title' => 'ID', + 'description' => 'ID，可参考ListSchemas接口返回结果，以及[元数据实体相关概念说明](~~2880092~~)。'."\n" + ."\n" + .'格式为`${EntityType}:${实例ID或转义后的URL}:${数据目录标识}:${数据库名称}:${模式名称}`，对于不存在的层级空字符占位。'."\n" + ."\n" + .'> 对于MaxCompute类型，实例ID层级使用空字符占位，数据库名称为MaxCompute项目名称，且要求该项目已开启三层模型。'."\n" + ."\n" + .'几种常用类型ID格式参考如下'."\n" + ."\n" + .'`maxcompute-schema:::project_name:schema_name` （要求该项目已开启三层模型）'."\n" + ."\n" + .'`holo-schema:instance_id::database_name:schema_name`'."\n" + ."\n" + .'> 其中 '."\n" + .'`instance_id`: holo实例ID '."\n" + .'`database_name`: 数据库名称 '."\n" + .'`project_name`: MaxCompute项目名 '."\n" + .'`schema_name`: schema名称', + 'type' => 'string', + 'required' => true, + 'example' => 'maxcompute-schema:::project_name:schema_name', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'A89B5D9D-74EA-XXXXXX', + ], + 'Success' => [ + 'title' => '请求是否成功', + 'description' => '请求是否成功。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Schema' => [ + 'description' => 'schema信息。', + '$ref' => '#/components/schemas/Schema', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A89B5D9D-74EA-XXXXXX\\",\\n \\"Success\\": true,\\n \\"Schema\\": {\\n \\"Id\\": \\"maxcompute-schema:123456::test_project:default\\",\\n \\"Name\\": \\"test_db\\",\\n \\"Comment\\": \\"test comment\\",\\n \\"Type\\": \\"MANAGED\\",\\n \\"ParentMetaEntityId\\": \\"maxcompute-project:123456::test_project\\",\\n \\"CreateTime\\": 1736852168000,\\n \\"ModifyTime\\": 1736852168000\\n }\\n}","type":"json"}]', + 'title' => '获取数据地图数据库模式信息', + 'description' => '1. 需要购买DataWorks基础版及以上版本才能使用。'."\n" + .'2. 当前支持MaxCompute和Hologres类型。', + ], + 'ListTables' => [ + 'summary' => '查询数据地图中的数据表列表。'."\n" + .'对于不支持schema级别的类型，支持查询给定数据库下的数据表列表；'."\n" + .'对于支持schema级别的类型，支持查询给定数据库/maxcompute项目/模式下的数据表列表。'."\n" + .'返回结果中仅包含数据表基础信息，不包含技术元数据与业务元数据信息。', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'abilityTreeCode' => '266735', + 'abilityTreeNodes' => [ + 'FEATUREdideE9OA4H', + ], + ], + 'parameters' => [ + [ + 'name' => 'ParentMetaEntityId', + 'in' => 'query', + 'schema' => [ + 'title' => '父层级实体ID', + 'description' => '父层级元数据实体ID，可参考ListDatabases/ListSchemas接口返回结果，以及[元数据实体相关概念说明](~~2880092~~)。'."\n" + ."\n" + .'- 可为表所属数据库，`ParentMetaEntityId`格式为`${EntityType}:${实例ID或转义后的URL}:${数据目录标识}:${数据库名称}`，对于不存在的层级空字符占位。'."\n" + ."\n" + .'- 也可为表所属数据库模式，`ParentMetaEntityId`格式为`${EntityType}:${实例ID或转义后的URL}:${数据目录标识}:${数据库名称}:${模式名称}`，对于不存在的层级空字符占位'."\n" + ."\n" + .'> - 只有数据库类型支持schema（`maxcompute/holo/postgresql/sqlserver/hybriddb_for_postgresql/oracle`，其中maxcompute类型需要开启三层模型)时, `ParentMetaEntityId`才可使用数据库模式，否则只能使用数据库。'."\n" + .'> - 对于maxcompute和dlf类型，实例ID使用空字符占位。对于maxcompute类型，数据库名称即为maxcompute项目名称。'."\n" + .'> - starrocks类型的数据目录标识为目录名称，dlf类型的数据目录标识为目录ID, 其他类型不支持目录层级，可用空字符占位。'."\n" + ."\n" + .'几种常用类型ParentMetaEntityId格式参考如下'."\n" + ."\n" + .'- `maxcompute-project:::project_name`'."\n" + ."\n" + .'- `maxcompute-schema:::project_name:schema_name` (仅项目开启三层模型时)'."\n" + ."\n" + .'- `dlf-database::catalog_id:database_name`'."\n" + ."\n" + .'- `hms-database:instance_id::database_name`'."\n" + ."\n" + .'- `holo-schema:instance_id::database_name:schema_name`'."\n" + ."\n" + .'- `mysql-database:(instance_id|encoded_jdbc_url)::database_name`'."\n" + ."\n" + .'> 其中 '."\n" + .'> - `instance_id`: 实例ID，对应数据源以实例模式注册时需要提供。'."\n" + .'> - `encoded_jdbc_url`: JDBC连接串的URLEncode编码,对应数据源以连接串方式注册时需要提供。'."\n" + .'> - `catalog_id`: dlf目录ID。'."\n" + .'> - `project_name`: maxcompute项目名称。'."\n" + .'> - `database_name`: 数据库名称。'."\n" + .'> - `schema_name`: schema名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'maxcompute-project:::project_name', + ], + ], + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => [ + 'title' => '名称', + 'description' => '名称，模糊匹配。', + 'type' => 'string', + 'required' => false, + 'example' => 'abc', + ], + ], + [ + 'name' => 'Comment', + 'in' => 'query', + 'schema' => [ + 'title' => '注释', + 'description' => '注释，模糊匹配。', + 'type' => 'string', + 'required' => false, + 'example' => 'this is a comment'."\n", + ], + ], + [ + 'name' => 'TableTypes', + 'in' => 'query', + 'style' => 'simple', + 'schema' => [ + 'title' => '表类型', + 'description' => '查询的表类型列表，为空时查询所有类型。', + 'type' => 'array', + 'items' => [ + 'description' => '表类型，取值与数据库类型相关。', + 'type' => 'string', + 'required' => false, + 'example' => 'TABLE', + ], + 'required' => false, + ], + ], + [ + 'name' => 'SortBy', + 'in' => 'query', + 'schema' => [ + 'title' => '排序字段，默认为CreateTime', + 'description' => '排序字段，默认为CreateTime，枚举值，当前支持'."\n" + .'- CreateTime 创建时间'."\n" + .'- ModifyTime 修改时间'."\n" + .'- Name 名称'."\n" + .'- TableType 表类型', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [], + 'example' => 'CreateTime', + 'default' => 'CreateTime', + 'enum' => [ + 'CreateTime', + 'ModifyTime', + 'Name', + 'TableType', + ], + ], + ], + [ + 'name' => 'Order', + 'in' => 'query', + 'schema' => [ + 'title' => '排序方向，默认为Asc', + 'description' => '排序方向，默认为Asc，枚举值，当前支持'."\n" + .'- Asc 升序'."\n" + .'- Desc 降序', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [], + 'example' => 'Asc', + 'default' => 'Asc', + 'enum' => [ + 'Asc', + 'Desc', + ], + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'title' => '分页页码，默认为1', + 'description' => '分页页码，默认为1。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'minimum' => '1', + 'example' => '1', + 'default' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'title' => '分页大小，默认为10，最大为100', + 'description' => '分页大小，默认为10，最大为100。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '100', + 'minimum' => '1', + 'example' => '10', + 'default' => '10', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'E25887B7-579C-54A5-9C4F-83A****', + ], + 'Success' => [ + 'title' => '请求是否成功', + 'description' => '请求是否成功。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'PagingInfo' => [ + 'title' => '分页结果', + 'description' => '分页结果。', + 'type' => 'object', + 'properties' => [ + 'TotalCount' => [ + 'description' => '总条数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '100', + ], + 'PageNumber' => [ + 'description' => '分页页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '分页大小。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'Tables' => [ + 'title' => '数据表列表', + 'description' => '数据表列表。', + 'type' => 'array', + 'items' => [ + 'title' => '数据表详情', + 'description' => '数据表详情。', + '$ref' => '#/components/schemas/Table', + ], + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"E25887B7-579C-54A5-9C4F-83A****\\",\\n \\"Success\\": true,\\n \\"PagingInfo\\": {\\n \\"TotalCount\\": 100,\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"Tables\\": [\\n {\\n \\"Id\\": \\"maxcompute-table:123456::test_project::test_tbl\\",\\n \\"Name\\": \\"test_tbl\\",\\n \\"Comment\\": \\"测试表\\",\\n \\"TableType\\": \\"TABLE\\",\\n \\"PartitionKeys\\": [\\n \\"ds\\"\\n ],\\n \\"ParentMetaEntityId\\": \\"maxcompute-project:123456::test_project\\",\\n \\"CreateTime\\": 1736852168000,\\n \\"ModifyTime\\": 1736852168000,\\n \\"TechnicalMetadata\\": {\\n \\"Owner\\": \\"123456789\\",\\n \\"Location\\": \\"oss://test-bucket/test_tbl\\",\\n \\"Compressed\\": false,\\n \\"InputFormat\\": \\"org.apache.hadoop.hive.ql.io.parquet.MapredParquetInputFormat\\",\\n \\"OutputFormat\\": \\"org.apache.hadoop.hive.ql.io.parquet.MapredParquetOutputFormat\\",\\n \\"SerializationLibrary\\": \\"org.apache.hadoop.hive.ql.io.parquet.serde.ParquetHiveSerDe\\",\\n \\"Parameters\\": {\\n \\"key\\": \\"\\"\\n }\\n },\\n \\"BusinessMetadata\\": {\\n \\"Readme\\": \\"## 使用说明\\",\\n \\"Tags\\": [\\n {\\n \\"Key\\": \\"tag_key\\",\\n \\"Value\\": \\"tag_value\\"\\n }\\n ],\\n \\"Categories\\": [\\n [\\n {\\n \\"Id\\": \\"CATEGORY.456\\",\\n \\"Name\\": \\"测试类目\\",\\n \\"ParentId\\": \\"CATEGORY.123\\"\\n }\\n ]\\n ],\\n \\"UpstreamTasks\\": [\\n {\\n \\"Id\\": 123456,\\n \\"Name\\": \\"test_task\\"\\n }\\n ],\\n \\"Extension\\": {\\n \\"ProjectId\\": 234,\\n \\"EnvType\\": \\"Dev\\",\\n \\"ViewCount\\": 0,\\n \\"ReadCount\\": 0,\\n \\"FavorCount\\": 0\\n }\\n }\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => '查询数据地图数据表列表', + 'description' => '1. 需要购买DataWorks基础版及以上版本才能使用。', + ], + 'GetTable' => [ + 'summary' => '获取数据地图中给定数据表详情。是否返回业务元数据可选。', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'abilityTreeCode' => '267394', + 'abilityTreeNodes' => [ + 'FEATUREdideE9XYA6', + ], + ], + 'parameters' => [ + [ + 'name' => 'Id', + 'in' => 'query', + 'schema' => [ + 'description' => 'ID，可参考ListTables接口返回结果，以及[元数据实体相关概念说明](~~2880092~~)。'."\n" + ."\n\n" + .'格式为`${EntityType}:${实例ID或转义后的URL}:${数据目录标识}:${数据库名称}:${模式名称}:${数据表名称}`，对于不存在的层级使用空字符占位'."\n" + ."\n" + .'> 对于maxcompute和dlf类型，实例ID使用空字符占位。'."\n" + ."\n" + .'> starrocks类型的数据目录标识为目录名称，dlf类型的数据目录标识为目录ID, 其他类型不支持目录层级，可用空字符占位。'."\n" + ."\n" + .'> 对于maxcompute类型，数据库名称即为maxcompute项目名称，开启三层模型的项目需要提供模式名称，未开启的项目模式名称处使用空字符占位。'."\n" + ."\n" + .'几种常用类型ID格式参考如下'."\n" + ."\n" + .'`maxcompute-table:::project_name:[schema_name]:table_name`'."\n" + ."\n" + .'`dlf-table::catalog_id:database_name::table_name`'."\n" + ."\n" + .'`hms-table:instance_id::database_name::table_name`'."\n" + ."\n" + .'`holo-table:instance_id::database_name:schema_name:table_name`'."\n" + ."\n" + .'`mysql-table:(instance_id|encoded_jdbc_url)::database_name::table_name`'."\n" + ."\n" + .'> 其中 '."\n" + .'`instance_id`: 实例ID，对应数据源以实例模式注册时需要提供 '."\n" + .'`encoded_jdbc_url`: JDBC连接串的URLEncode编码,对应数据源以连接串方式注册时需要提供 '."\n" + .'`catalog_id`: dlf目录ID '."\n" + .'`project_name`: maxcompute项目名称 '."\n" + .'`database_name`: 数据库名称 '."\n" + .'`schema_name`: schema名称，对于maxcompute类型，仅所属项目开启三层模型后需要提供。若未开启则使用空字符占位 '."\n" + .'`table_name`: 表名称', + 'type' => 'string', + 'required' => true, + 'example' => 'maxcompute-table:::project_name:[schema_name]:table_name', + ], + ], + [ + 'name' => 'IncludeBusinessMetadata', + 'in' => 'query', + 'schema' => [ + 'description' => '是否包含业务元数据，默认为false。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '7B3435F4-2D91-XXX', + ], + 'Success' => [ + 'title' => '请求是否成功', + 'description' => '请求是否成功。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Table' => [ + 'description' => '数据表的详细信息。', + '$ref' => '#/components/schemas/Table', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"7B3435F4-2D91-XXX\\",\\n \\"Success\\": true,\\n \\"Table\\": {\\n \\"Id\\": \\"maxcompute-table:123456::test_project::test_tbl\\",\\n \\"Name\\": \\"test_tbl\\",\\n \\"Comment\\": \\"测试表\\",\\n \\"TableType\\": \\"TABLE\\",\\n \\"PartitionKeys\\": [\\n \\"ds\\"\\n ],\\n \\"ParentMetaEntityId\\": \\"maxcompute-project:123456::test_project\\",\\n \\"CreateTime\\": 1736852168000,\\n \\"ModifyTime\\": 1736852168000,\\n \\"TechnicalMetadata\\": {\\n \\"Owner\\": \\"123456789\\",\\n \\"Location\\": \\"oss://test-bucket/test_tbl\\",\\n \\"Compressed\\": false,\\n \\"InputFormat\\": \\"org.apache.hadoop.hive.ql.io.parquet.MapredParquetInputFormat\\",\\n \\"OutputFormat\\": \\"org.apache.hadoop.hive.ql.io.parquet.MapredParquetOutputFormat\\",\\n \\"SerializationLibrary\\": \\"org.apache.hadoop.hive.ql.io.parquet.serde.ParquetHiveSerDe\\",\\n \\"Parameters\\": {\\n \\"key\\": \\"\\"\\n }\\n },\\n \\"BusinessMetadata\\": {\\n \\"Readme\\": \\"## 使用说明\\",\\n \\"Tags\\": [\\n {\\n \\"Key\\": \\"tag_key\\",\\n \\"Value\\": \\"tag_value\\"\\n }\\n ],\\n \\"Categories\\": [\\n [\\n {\\n \\"Id\\": \\"CATEGORY.456\\",\\n \\"Name\\": \\"测试类目\\",\\n \\"ParentId\\": \\"CATEGORY.123\\"\\n }\\n ]\\n ],\\n \\"UpstreamTasks\\": [\\n {\\n \\"Id\\": 123456,\\n \\"Name\\": \\"test_task\\"\\n }\\n ],\\n \\"Extension\\": {\\n \\"ProjectId\\": 234,\\n \\"EnvType\\": \\"Dev\\",\\n \\"ViewCount\\": 0,\\n \\"ReadCount\\": 0,\\n \\"FavorCount\\": 0\\n }\\n }\\n }\\n}","type":"json"}]', + 'title' => '获取数据地图数据表详情', + 'description' => '1. 需要购买DataWorks基础版及以上版本才能使用。', + ], + 'UpdateTableBusinessMetadata' => [ + 'summary' => '更新数据地图数据表的业务元数据，当前仅支持更新表的使用说明。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'abilityTreeCode' => '267996', + 'abilityTreeNodes' => [ + 'FEATUREdideE9XYA6', + ], + ], + 'parameters' => [ + [ + 'name' => 'Id', + 'in' => 'formData', + 'schema' => [ + 'title' => '数据表ID', + 'description' => '数据表ID，格式可参考ListTables接口返回结果。', + 'type' => 'string', + 'required' => true, + 'example' => 'maxcompute-table:::project_name:[schema_name]:table_name', + ], + ], + [ + 'name' => 'Readme', + 'in' => 'formData', + 'schema' => [ + 'title' => '使用说明', + 'description' => '使用说明，支持富文本格式。', + 'type' => 'string', + 'required' => false, + 'example' => '## introduction', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '7C352CB7-CD88-XXXXXXX', + ], + 'Success' => [ + 'title' => '请求是否成功', + 'description' => '请求是否成功。', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"7C352CB7-CD88-XXXXXXX\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => '更新数据地图数据表的业务元数据', + 'description' => '1. 需要购买DataWorks基础版及以上版本才能使用。', + ], + 'ListColumns' => [ + 'summary' => '查询数据地图给定数据表的字段列表。', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'abilityTreeCode' => '267999', + 'abilityTreeNodes' => [ + 'FEATUREdideE9XYA6', + ], + ], + 'parameters' => [ + [ + 'name' => 'TableId', + 'in' => 'query', + 'allowEmptyValue' => true, + 'schema' => [ + 'title' => '数据表ID', + 'description' => '数据表ID，可参考ListTables接口返回结果，'."\n" + .'以及[元数据实体相关概念说明](~~2880092~~)。', + 'type' => 'string', + 'required' => true, + 'example' => 'maxcompute-table:::project_name:[schema_name]:table_name', + ], + ], + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => [ + 'title' => '名称，模糊匹配', + 'description' => '名称，模糊匹配。', + 'type' => 'string', + 'required' => false, + 'example' => 'test_table', + ], + ], + [ + 'name' => 'Comment', + 'in' => 'query', + 'schema' => [ + 'title' => '注释，模糊匹配', + 'description' => '注释，模糊匹配。', + 'type' => 'string', + 'required' => false, + 'example' => 'test comment', + ], + ], + [ + 'name' => 'SortBy', + 'in' => 'query', + 'schema' => [ + 'title' => '排序字段，默认为CreateTime', + 'description' => '排序字段，默认为Position，枚举值，当前支持'."\n" + .'- Name 名称'."\n" + .'- Position 位置', + 'type' => 'string', + 'required' => false, + 'example' => 'Position', + 'default' => 'Position', + 'enum' => [ + 'Name', + 'Position', + ], + ], + ], + [ + 'name' => 'Order', + 'in' => 'query', + 'schema' => [ + 'title' => '排序方向，默认为Asc', + 'description' => '排序方向，默认为Asc，枚举值，当前支持'."\n" + .'- Asc 升序'."\n" + .'- Desc 降序', + 'type' => 'string', + 'required' => false, + 'example' => 'Asc', + 'default' => 'Asc', + 'enum' => [ + 'Asc', + 'Desc', + ], + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'title' => '分页页码，默认为1', + 'description' => '分页页码，默认为1。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'minimum' => '1', + 'example' => '1', + 'default' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'title' => '分页大小，默认为10，最大为100', + 'description' => '分页大小，默认为10，最大为100。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '100', + 'minimum' => '1', + 'example' => '10', + 'default' => '10', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'D1E2E5BC-xxxx-xxxx-xxxx-xxxxxx', + ], + 'Success' => [ + 'title' => '请求是否成功', + 'description' => '请求是否成功。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'PagingInfo' => [ + 'title' => '分页结果', + 'description' => '分页结果。', + 'type' => 'object', + 'properties' => [ + 'TotalCount' => [ + 'description' => '总记录数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'PageNumber' => [ + 'description' => '分页页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '分页大小。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'Columns' => [ + 'description' => '字段列表。', + 'type' => 'array', + 'items' => [ + 'description' => '字段信息。', + '$ref' => '#/components/schemas/Column', + ], + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D1E2E5BC-xxxx-xxxx-xxxx-xxxxxx\\",\\n \\"Success\\": true,\\n \\"PagingInfo\\": {\\n \\"TotalCount\\": 1,\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"Columns\\": [\\n {\\n \\"Id\\": \\"maxcompute-column:123456::test_project:default:test_tbl:col1\\",\\n \\"Name\\": \\"col1\\",\\n \\"Comment\\": \\"字段1\\",\\n \\"TableId\\": \\"maxcompute-table:123456::test_project:default:test_tbl\\",\\n \\"Position\\": 1,\\n \\"Type\\": \\"bigint\\",\\n \\"PrimaryKey\\": false,\\n \\"PartitionKey\\": false,\\n \\"ForeignKey\\": false,\\n \\"BusinessMetadata\\": {\\n \\"Description\\": \\"字段1的业务描述\\"\\n }\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => '查询数据地图数据表字段列表', + 'description' => '1. 需要购买DataWorks基础版及以上版本才能使用。', + ], + 'GetColumn' => [ + 'summary' => '获取数据地图数据表给定字段的详细信息。', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'abilityTreeCode' => '268005', + 'abilityTreeNodes' => [ + 'FEATUREdideE9XYA6', + ], + ], + 'parameters' => [ + [ + 'name' => 'Id', + 'in' => 'query', + 'schema' => [ + 'title' => 'ID', + 'description' => 'ID，可参考ListColumns接口返回结果，以及[元数据实体相关概念说明](~~2880092~~)。'."\n" + ."\n" + .'格式为`${EntityType}:${实例ID或转义后的URL}:${数据目录标识}:${数据库名称}:${模式名称}:${数据表名称}:${字段名称}`，不存在的层级使用空字符占位。'."\n" + ."\n" + .'> 对于maxcompute和dlf类型，实例ID使用空字符占位。对于maxcompute类型，数据库名称即为maxcompute项目名称，开启三层模型的项目需要提供模式名称，未开启的项目模式名称处使用空字符占位。'."\n" + ."\n" + .'> starrocks类型的数据目录标识为目录名称，dlf类型的数据目录标识为目录ID, 其他类型不支持目录层级，可用空字符占位。'."\n" + ."\n" + .'几种常用类型ID格式参考如下'."\n" + ."\n" + .'`maxcompute-column:::project_name:[schema_name]:table_name:column_name`'."\n" + ."\n" + .'`dlf-column::catalog_id:database_name::table_name:column_name`'."\n" + ."\n" + .'`hms-column:instance_id::database_name::table_name:column_name`'."\n" + ."\n" + .'`holo-column:instance_id::database_name:schema_name:table_name:column_name`'."\n" + ."\n" + .'`mysql-column:(instance_id|encoded_jdbc_url)::database_name::table_name:column_name`'."\n" + ."\n" + .'> 其他 '."\n" + .'`instance_id`: 实例ID，对应数据源以实例模式注册时需要提供 '."\n" + .'`encoded_jdbc_url`: JDBC连接串的URLEncode编码,对应数据源以连接串方式注册时需要提供 '."\n" + .'`catalog_id`: dlf目录ID '."\n" + .'`project_name`: maxcompute项目名称 '."\n" + .'`database_name`: 数据库名称 '."\n" + .'`schema_name`: schema名称，对于maxcompute类型，仅所属项目开启三层模型后需要提供，若未开启则使用空字符占位。 '."\n" + .'`table_name`: 表名称 '."\n" + .'`column_name`: 字段名称', + 'type' => 'string', + 'required' => true, + 'example' => 'maxcompute-column:::project_name:[schema_name]:table_name:column_name', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'D1E2E5BC-xxxx-xxxx-xxxx-xxxxxx', + ], + 'Success' => [ + 'title' => '请求是否成功', + 'description' => '请求是否成功。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Column' => [ + 'description' => '字段列表。', + '$ref' => '#/components/schemas/Column', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D1E2E5BC-xxxx-xxxx-xxxx-xxxxxx\\",\\n \\"Success\\": true,\\n \\"Column\\": {\\n \\"Id\\": \\"maxcompute-column:123456::test_project:default:test_tbl:col1\\",\\n \\"Name\\": \\"col1\\",\\n \\"Comment\\": \\"字段1\\",\\n \\"TableId\\": \\"maxcompute-table:123456::test_project:default:test_tbl\\",\\n \\"Position\\": 1,\\n \\"Type\\": \\"bigint\\",\\n \\"PrimaryKey\\": false,\\n \\"PartitionKey\\": false,\\n \\"ForeignKey\\": false,\\n \\"BusinessMetadata\\": {\\n \\"Description\\": \\"字段1的业务描述\\"\\n }\\n }\\n}","type":"json"}]', + 'title' => '获取数据地图数据表字段信息', + 'description' => '1. 需要购买DataWorks基础版及以上版本才能使用。', + ], + 'UpdateColumnBusinessMetadata' => [ + 'summary' => '更新数据地图数据表给定字段的业务元数据，当前仅支持更新字段的业务描述。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'abilityTreeCode' => '268008', + 'abilityTreeNodes' => [ + 'FEATUREdideE9XYA6', + ], + ], + 'parameters' => [ + [ + 'name' => 'Id', + 'in' => 'formData', + 'schema' => [ + 'title' => 'ID', + 'description' => '字段ID，可参考ListColumns接口返回结果，'."\n" + .'以及[元数据实体相关概念说明](~~2880092~~)。', + 'type' => 'string', + 'required' => true, + 'example' => 'maxcompute-column:::project_name:[schema_name]:table_name:column_name', + ], + ], + [ + 'name' => 'Description', + 'in' => 'formData', + 'schema' => [ + 'title' => '字段业务描述', + 'description' => '字段业务描述。', + 'type' => 'string', + 'required' => false, + 'example' => 'test description', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'D1E2E5BC-xxxx-xxxx-xxxx-xxxxxx', + ], + 'Success' => [ + 'title' => '请求是否成功', + 'description' => '请求是否成功。', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D1E2E5BC-xxxx-xxxx-xxxx-xxxxxx\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => '更新数据地图数据表字段的业务元数据', + 'description' => '1. 需要购买DataWorks基础版及以上版本才能使用。'."\n" + .'2. 仅maxcompute, hms, dlf 类型支持', + ], + 'ListDatasets' => [ + 'summary' => '查询数据集列表，当前支持DataWorks数据集与PAI数据集。', + 'path' => '', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREdideXGTG91', + ], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'ProjectId', + 'in' => 'formData', + 'schema' => [ + 'title' => 'DataWorks工作空间ID', + 'description' => 'DataWorks工作空间ID', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '251363', + ], + ], + [ + 'name' => 'Origin', + 'in' => 'formData', + 'schema' => [ + 'title' => '数据集来源，取值有'."\n" + .'- DataWorks'."\n" + .'- PAI', + 'description' => '数据集来源，取值有'."\n" + .'- DataWorks'."\n" + .'- PAI', + 'type' => 'string', + 'required' => false, + 'example' => 'DataWorks', + ], + ], + [ + 'name' => 'Name', + 'in' => 'formData', + 'schema' => [ + 'title' => '数据集名称，支持模糊搜索', + 'description' => '数据集名称，支持模糊搜索', + 'type' => 'string', + 'required' => false, + 'example' => 'test_dataset', + ], + ], + [ + 'name' => 'DataTypeList', + 'in' => 'formData', + 'style' => 'simple', + 'schema' => [ + 'title' => '数据类型，可多选，当前支持'."\n" + .'- COMMON 通用'."\n" + .'- PIC 图片'."\n" + .'- TEXT 文本'."\n" + .'- TABLE 表格'."\n" + .'- VIDEO 视频'."\n" + .'- AUDIO 音频'."\n" + .'- INDEX 索引', + 'description' => '数据类型，可多选，当前支持'."\n" + .'- COMMON 通用'."\n" + .'- PIC 图片'."\n" + .'- TEXT 文本'."\n" + .'- TABLE 表格'."\n" + .'- VIDEO 视频'."\n" + .'- AUDIO 音频'."\n" + .'- INDEX 索引', + 'type' => 'array', + 'items' => [ + 'description' => '数据类型', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'TABLE' => '表格', + 'VIDEO' => '视频', + 'COMMON' => '通用', + 'TEXT' => '文本', + 'PIC' => '图片', + 'INDEX' => '索引', + 'AUDIO' => '音频', + ], + 'example' => 'COMMON', + ], + 'required' => false, + 'maxItems' => 10, + 'minItems' => 0, + ], + ], + [ + 'name' => 'StorageTypeList', + 'in' => 'formData', + 'style' => 'simple', + 'schema' => [ + 'title' => '存储类型，可多选，当前支持'."\n" + .'- OSS 对象存储'."\n" + .'- NAS 通用型NAS文件存储'."\n" + .'- EXTREMENAS 极速型NAS文件存储'."\n" + .'- DLF_LANCE 数据湖构建'."\n" + .'- CPFS CPFS文件存储'."\n" + .'- BMCPFS 智算CPFS文件存储'."\n" + .'- MAXCOMPUTE MaxCompute表', + 'description' => '存储类型，可多选，当前支持'."\n" + .'- OSS 对象存储'."\n" + .'- NAS 通用型NAS文件存储'."\n" + .'- EXTREMENAS 极速型NAS文件存储'."\n" + .'- DLF_LANCE 数据湖构建'."\n" + .'- CPFS CPFS文件存储'."\n" + .'- BMCPFS 智算CPFS文件存储'."\n" + .'- MAXCOMPUTE MaxCompute表', + 'type' => 'array', + 'items' => [ + 'description' => '存储类型', + 'type' => 'string', + 'required' => false, + 'example' => 'NAS', + ], + 'required' => false, + 'enumValueTitles' => [ + 'NAS' => '通用型NAS文件存储', + 'MAXCOMPUTE' => 'MaxCompute表', + 'CPFS' => 'CPFS文件存储', + 'BMCPFS' => '智算CPFS文件存储', + 'EXTREMENAS' => '极速型NAS文件存储', + 'OSS' => '对象存储', + 'DLF_LANCE' => '数据湖构建', + ], + 'maxItems' => 10, + 'minItems' => 0, + ], + ], + [ + 'name' => 'CreatorId', + 'in' => 'formData', + 'schema' => [ + 'title' => '创建者ID', + 'description' => '创建者ID', + 'type' => 'string', + 'required' => false, + 'example' => '12103XXX46492139', + ], + ], + [ + 'name' => 'SortBy', + 'in' => 'formData', + 'schema' => [ + 'title' => '排序字段', + 'description' => '排序字段，默认为 CreateTime(创建时间)', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'ModifyTime' => '修改时间', + 'CreateTime' => '创建时间', + 'Name' => '名称', + ], + 'example' => 'CreateTime', + 'default' => 'CreateTime', + 'enum' => [ + 'Name', + 'CreateTime', + 'ModifyTime', + ], + ], + ], + [ + 'name' => 'Order', + 'in' => 'formData', + 'schema' => [ + 'title' => '排序方向', + 'description' => '排序方向，默认为Desc（降序）', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'Asc' => '升序', + 'Desc' => '降序', + ], + 'example' => 'Asc', + 'default' => 'Desc', + 'enum' => [ + 'Asc', + 'Desc', + ], + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'formData', + 'schema' => [ + 'title' => '分页页码，默认为1', + 'description' => '分页页码，默认为1', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'minimum' => '1', + 'example' => '1', + 'default' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'formData', + 'schema' => [ + 'title' => '分页大小，默认为10，最大100', + 'description' => '分页大小，默认为10，最大100', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '100', + 'minimum' => '1', + 'example' => '10', + 'default' => '10', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'RequestId', + 'description' => 'RequestId', + 'type' => 'string', + 'example' => '6A6CBE87-9F91-1323-B680-E7A7065XXXXX'."\n", + ], + 'Success' => [ + 'title' => '请求是否成功', + 'description' => '请求是否成功', + 'type' => 'boolean', + 'example' => 'true', + ], + 'PagingInfo' => [ + 'title' => '分页信息', + 'description' => '分页信息', + 'type' => 'object', + 'properties' => [ + 'TotalCount' => [ + 'title' => '总数', + 'description' => '总数', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '100', + ], + 'PageNumber' => [ + 'title' => '分页页码', + 'description' => '分页页码', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'title' => '分页大小', + 'description' => '分页大小', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'Datasets' => [ + 'title' => '数据集列表', + 'description' => '数据集列表', + 'type' => 'array', + 'items' => [ + 'title' => '数据集对象', + 'description' => '数据集对象', + '$ref' => '#/components/schemas/Dataset', + ], + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"6A6CBE87-9F91-1323-B680-E7A7065XXXXX\\\\n\\",\\n \\"Success\\": true,\\n \\"PagingInfo\\": {\\n \\"TotalCount\\": 100,\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"Datasets\\": [\\n {\\n \\"Id\\": \\"\\",\\n \\"Name\\": \\"\\",\\n \\"Comment\\": \\"\\",\\n \\"ProjectId\\": 0,\\n \\"Origin\\": \\"\\",\\n \\"DataType\\": \\"\\",\\n \\"StorageType\\": \\"\\",\\n \\"CreatorId\\": \\"\\",\\n \\"Readme\\": \\"\\",\\n \\"LatestVersion\\": {\\n \\"Id\\": \\"\\",\\n \\"DatasetId\\": \\"\\",\\n \\"Comment\\": \\"\\",\\n \\"CreatorId\\": \\"\\",\\n \\"VersionNumber\\": 0,\\n \\"StorageType\\": \\"\\",\\n \\"Url\\": \\"\\",\\n \\"MountPath\\": \\"\\",\\n \\"CreateTime\\": 0,\\n \\"ModifyTime\\": 0,\\n \\"Labels\\": [\\n {\\n \\"Key\\": \\"\\",\\n \\"Value\\": \\"\\"\\n }\\n ],\\n \\"ImportInfo\\": {\\n \\"key\\": \\"\\"\\n }\\n },\\n \\"CreateTime\\": 0,\\n \\"ModifyTime\\": 0,\\n \\"Labels\\": [\\n {\\n \\"Key\\": \\"\\",\\n \\"Value\\": \\"\\"\\n }\\n ]\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => '查询数据集列表', + ], + 'GetDataset' => [ + 'summary' => '获取数据集的详细信息。', + 'path' => '', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREdideXGTG91', + ], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'Id', + 'in' => 'query', + 'schema' => [ + 'title' => '数据集ID', + 'description' => '数据集ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'dataworks-dataset:3pXXXb8o0ngr07njhps1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request。', + 'type' => 'string', + 'example' => '204EAF68-CCE3-5112-8DA0-E7A60F02XXXX', + ], + 'Success' => [ + 'title' => '请求是否成功', + 'description' => '请求是否成功。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Dataset' => [ + 'description' => '数据集信息。', + '$ref' => '#/components/schemas/Dataset', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"204EAF68-CCE3-5112-8DA0-E7A60F02XXXX\\",\\n \\"Success\\": true,\\n \\"Dataset\\": {\\n \\"Id\\": \\"\\",\\n \\"Name\\": \\"\\",\\n \\"Comment\\": \\"\\",\\n \\"ProjectId\\": 0,\\n \\"Origin\\": \\"\\",\\n \\"DataType\\": \\"\\",\\n \\"StorageType\\": \\"\\",\\n \\"CreatorId\\": \\"\\",\\n \\"Readme\\": \\"\\",\\n \\"LatestVersion\\": {\\n \\"Id\\": \\"\\",\\n \\"DatasetId\\": \\"\\",\\n \\"Comment\\": \\"\\",\\n \\"CreatorId\\": \\"\\",\\n \\"VersionNumber\\": 0,\\n \\"StorageType\\": \\"\\",\\n \\"Url\\": \\"\\",\\n \\"MountPath\\": \\"\\",\\n \\"CreateTime\\": 0,\\n \\"ModifyTime\\": 0,\\n \\"Labels\\": [\\n {\\n \\"Key\\": \\"\\",\\n \\"Value\\": \\"\\"\\n }\\n ],\\n \\"ImportInfo\\": {\\n \\"key\\": \\"\\"\\n }\\n },\\n \\"CreateTime\\": 0,\\n \\"ModifyTime\\": 0,\\n \\"Labels\\": [\\n {\\n \\"Key\\": \\"\\",\\n \\"Value\\": \\"\\"\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => '获取数据集详情', + ], + 'CreateDataset' => [ + 'summary' => '创建数据集，仅支持在用户已加入的工作空间创建数据集'."\n" + .'且当前仅支持创建DataWorks数据集，单租户下限制数据集最大数量为2000。', + 'path' => '', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREdideXGTG91', + ], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'ProjectId', + 'in' => 'formData', + 'schema' => [ + 'title' => 'DataWorks工作空间ID', + 'description' => 'DataWorks工作空间ID', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '12345', + ], + ], + [ + 'name' => 'Origin', + 'in' => 'formData', + 'schema' => [ + 'title' => '数据集来源，当前仅支持DataWorks', + 'description' => '数据集来源，当前仅支持DataWorks', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'DataWorks' => 'DataWorks', + ], + 'example' => 'DataWorks', + 'default' => 'DataWorks', + ], + ], + [ + 'name' => 'Name', + 'in' => 'formData', + 'schema' => [ + 'title' => '数据集名称，非空字符串，长度不超过128', + 'description' => '数据集名称，非空字符串，长度不超过128', + 'type' => 'string', + 'required' => true, + 'example' => 'test_oss_dataset', + ], + ], + [ + 'name' => 'Comment', + 'in' => 'formData', + 'schema' => [ + 'title' => '数据集描述,长度不超过1024', + 'description' => '数据集描述,长度不超过1024', + 'type' => 'string', + 'required' => false, + 'example' => 'this is a comment', + ], + ], + [ + 'name' => 'DataType', + 'in' => 'formData', + 'schema' => [ + 'title' => '数据类型，取值有'."\n" + .'- COMMON 通用（默认）'."\n" + .'- PIC 图片'."\n" + .'- TEXT 文本'."\n" + .'- TABLE 表格'."\n" + .'- VIDEO 视频'."\n" + .'- AUDIO 音频'."\n" + .'- INDEX 索引', + 'description' => '数据类型，取值有'."\n" + .'- COMMON 通用（默认）'."\n" + .'- PIC 图片'."\n" + .'- TEXT 文本'."\n" + .'- TABLE 表格'."\n" + .'- VIDEO 视频'."\n" + .'- AUDIO 音频'."\n" + .'- INDEX 索引', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'TABLE' => '表格', + 'VIDEO' => '视频', + 'COMMON' => '通用', + 'TEXT' => '文本', + 'PIC' => '图片', + 'INDEX' => '索引', + 'AUDIO' => '音频', + ], + 'example' => 'COMMON', + 'default' => 'COMMON', + ], + ], + [ + 'name' => 'StorageType', + 'in' => 'formData', + 'schema' => [ + 'title' => '存储类型，当前支持的取值有'."\n" + .'- OSS 对象存储'."\n" + .'- NAS 通用型NAS文件存储'."\n" + .'- EXTREMENAS 极速型NAS文件存储'."\n" + .'- DLF_LANCE 数据湖构建', + 'description' => '存储类型，当前支持的取值有'."\n" + .'- OSS 对象存储'."\n" + .'- NAS 通用型NAS文件存储'."\n" + .'- EXTREMENAS 极速型NAS文件存储'."\n" + .'- DLF_LANCE 数据湖构建', + 'type' => 'string', + 'required' => true, + 'enumValueTitles' => [ + 'NAS' => '通用型NAS文件存储', + 'EXTREMENAS' => '极速型NAS文件存储', + 'OSS' => '对象存储', + 'DLF_LANCE' => '数据湖构建', + ], + 'example' => 'OSS', + ], + ], + [ + 'name' => 'InitVersion', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'title' => '数据集初始版本', + 'description' => '数据集初始版本', + 'type' => 'object', + 'properties' => [ + 'Comment' => [ + 'title' => '描述，长度不超过1024', + 'description' => '描述，长度不超过1024', + 'type' => 'string', + 'required' => false, + 'example' => 'Initial Version', + ], + 'Url' => [ + 'title' => 'URL地址', + 'description' => 'URL地址', + 'type' => 'string', + 'required' => true, + 'example' => 'oss://test-oss-bucket/test_dir/', + ], + 'ImportInfo' => [ + 'title' => '数据集的存储导入配置'."\n" + .'对于NAS类型，需要提供以下属性，取值可参考DescribeFileSystems接口的返回信息'."\n" + .'- fileSystemId 文件系统ID'."\n" + .'- fileSystemStorageType 文件系统的存储规格'."\n" + .'- vpcId 挂载点的 VPC ID', + 'description' => '数据集的存储导入配置, 对于不同存储类型，需要的配置信息不同'."\n" + .'<details>'."\n" + .'<summary>NAS</summary>'."\n" + .'取值可参考文件存储 API DescribeFileSystems 的返回信息'."\n" + ."\n" + .'```JSON'."\n" + .'{'."\n" + .' "fileSystemId": "3b6XXX89c9", // 文件系统ID'."\n" + .' "fileSystemStorageType": "Performance", // 文件系统的存储规格'."\n" + .' "vpcId": "vpc-uf66oxxxrqge1t2gson7s" // 挂载点的VPC ID'."\n" + .'}'."\n" + .'```'."\n" + ."\n" + .'</details>', + 'type' => 'object', + 'required' => false, + 'additionalProperties' => [ + 'type' => 'string', + 'example' => 'None', + 'description' => '数据集的存储导入配置信息', + ], + ], + 'MountPath' => [ + 'title' => '挂载路径，需要以/mnt/开头，默认为/mnt/data', + 'description' => '挂载路径，需要以/mnt/开头，默认为/mnt/data', + 'type' => 'string', + 'required' => false, + 'example' => '/mnt/data', + ], + ], + 'required' => true, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request', + 'type' => 'string', + 'example' => '99EBE7CF-69C0-5089-BE3E-79563C31XXXX', + ], + 'Success' => [ + 'title' => '是否创建成功', + 'description' => '是否创建成功', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Id' => [ + 'title' => 'ID', + 'description' => 'ID', + 'type' => 'string', + 'example' => 'dataworks-dataset:3pXXXb8o0ngr07njhps1', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"99EBE7CF-69C0-5089-BE3E-79563C31XXXX\\",\\n \\"Success\\": true,\\n \\"Id\\": \\"dataworks-dataset:3pXXXb8o0ngr07njhps1\\"\\n}","type":"json"}]', + 'title' => '创建数据集', + ], + 'UpdateDataset' => [ + 'summary' => '更新数据集信息，仅支持DataWorks数据集，要求操作者为数据集的创建者或数据集所在工作空间的管理员。', + 'path' => '', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREdideXGTG91', + ], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'Id', + 'in' => 'formData', + 'schema' => [ + 'title' => '数据集ID,仅支持更新DataWorks数据集', + 'description' => '数据集ID,仅支持更新DataWorks数据集', + 'type' => 'string', + 'required' => true, + 'example' => 'dataworks-dataset:3pXXXb8o0ngr07njhps1', + ], + ], + [ + 'name' => 'Name', + 'in' => 'formData', + 'schema' => [ + 'title' => '数据集名称，非空字符串，长度不超过128', + 'description' => '数据集名称，非空字符串，长度不超过128', + 'type' => 'string', + 'required' => false, + 'example' => 'test_oss_dataset_new', + ], + ], + [ + 'name' => 'Comment', + 'in' => 'formData', + 'schema' => [ + 'title' => '数据集描述,长度不超过1024', + 'description' => '数据集描述,长度不超过1024', + 'type' => 'string', + 'required' => false, + 'example' => 'new comment', + ], + ], + [ + 'name' => 'Readme', + 'in' => 'formData', + 'schema' => [ + 'title' => '使用说明，支持Markdown格式富文本', + 'description' => '使用说明，支持Markdown格式富文本', + 'type' => 'string', + 'required' => false, + 'example' => '## introduction', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request', + 'type' => 'string', + 'example' => '22C97E95-F023-56B5-8852-B1A77A17XXXX'."\n", + ], + 'Success' => [ + 'title' => '是否更新成功', + 'description' => '是否更新成功', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"22C97E95-F023-56B5-8852-B1A77A17XXXX\\\\n\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => '更新数据集', + ], + 'DeleteDataset' => [ + 'summary' => '删除数据集，仅支持删除DataWorks数据集，级联删除对应的数据集版本，要求操作者为数据集的创建者或数据集所在工作空间的管理员。', + 'path' => '', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREdideXGTG91', + ], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'Id', + 'in' => 'query', + 'schema' => [ + 'title' => '数据集ID，仅支持DataWorks数据集', + 'description' => '数据集ID，仅支持DataWorks数据集', + 'type' => 'string', + 'required' => true, + 'example' => 'dataworks-dataset:3pXXXb8o0ngr07njhps1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request', + 'type' => 'string', + 'example' => 'AAC30B35-820D-5F3E-A42C-E96BB****', + ], + 'Success' => [ + 'title' => '是否删除成功', + 'description' => '是否删除成功', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"AAC30B35-820D-5F3E-A42C-E96BB****\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => '删除数据集', + ], + 'ListDatasetVersions' => [ + 'summary' => '查询给定数据集的版本列表。', + 'path' => '', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREdideXGTG91', + ], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'DatasetId', + 'in' => 'formData', + 'schema' => [ + 'title' => '数据集ID', + 'description' => '数据集ID', + 'type' => 'string', + 'required' => true, + 'example' => 'dataworks-dataset:3pXXXb8o0ngr07njhps1', + ], + ], + [ + 'name' => 'CreatorId', + 'in' => 'formData', + 'schema' => [ + 'title' => '创建者ID', + 'description' => '创建者ID', + 'type' => 'string', + 'required' => false, + 'example' => '12103XXX46492139', + ], + ], + [ + 'name' => 'SortBy', + 'in' => 'formData', + 'schema' => [ + 'title' => '排序字段', + 'description' => '排序字段，默认为VersionNumber（版本号）', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'ModifyTime' => '修改时间', + 'CreateTime' => '创建时间', + 'VersionNumber' => '版本号', + ], + 'example' => 'CreateTime', + 'default' => 'VersionNumber', + 'enum' => [ + 'CreateTime', + 'ModifyTime', + 'VersionNumber', + ], + ], + ], + [ + 'name' => 'Order', + 'in' => 'formData', + 'schema' => [ + 'title' => '排序方向', + 'description' => '排序方向，默认为Desc（降序）', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'Asc' => '升序', + 'Desc' => '降序', + ], + 'example' => 'Desc', + 'default' => 'Desc', + 'enum' => [ + 'Asc', + 'Desc', + ], + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'formData', + 'schema' => [ + 'title' => '分页页码，默认为1', + 'description' => '分页页码，默认为1', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'minimum' => '1', + 'example' => '1', + 'default' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'formData', + 'schema' => [ + 'title' => '分页大小，默认为10，最大100', + 'description' => '分页大小，默认为10，最大100', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '100', + 'minimum' => '1', + 'example' => '10', + 'default' => '10', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'RequestId', + 'description' => 'RequestId', + 'type' => 'string', + 'example' => 'E25887B7-579C-54A5-9C4F-83A0DE367XXX', + ], + 'Success' => [ + 'title' => '请求是否成功', + 'description' => '请求是否成功', + 'type' => 'boolean', + 'example' => 'true', + ], + 'PagingInfo' => [ + 'title' => '分页信息', + 'description' => '分页信息', + 'type' => 'object', + 'properties' => [ + 'TotalCount' => [ + 'title' => '总数', + 'description' => '总数', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '100', + ], + 'PageNumber' => [ + 'title' => '分页页码', + 'description' => '分页页码', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'title' => '分页大小', + 'description' => '分页大小', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'DatasetVersions' => [ + 'title' => '数据集版本列表', + 'description' => '数据集版本列表', + 'type' => 'array', + 'items' => [ + 'title' => '数据集版本', + 'description' => '数据集版本', + '$ref' => '#/components/schemas/DatasetVersion', + ], + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"E25887B7-579C-54A5-9C4F-83A0DE367XXX\\",\\n \\"Success\\": true,\\n \\"PagingInfo\\": {\\n \\"TotalCount\\": 100,\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"DatasetVersions\\": [\\n {\\n \\"Id\\": \\"\\",\\n \\"DatasetId\\": \\"\\",\\n \\"Comment\\": \\"\\",\\n \\"CreatorId\\": \\"\\",\\n \\"VersionNumber\\": 0,\\n \\"StorageType\\": \\"\\",\\n \\"Url\\": \\"\\",\\n \\"MountPath\\": \\"\\",\\n \\"CreateTime\\": 0,\\n \\"ModifyTime\\": 0,\\n \\"Labels\\": [\\n {\\n \\"Key\\": \\"\\",\\n \\"Value\\": \\"\\"\\n }\\n ],\\n \\"ImportInfo\\": {\\n \\"key\\": \\"\\"\\n }\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => '获取数据集版本列表', + ], + 'GetDatasetVersion' => [ + 'summary' => '获取给定数据集版本信息。', + 'path' => '', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREdideXGTG91', + ], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'Id', + 'in' => 'query', + 'schema' => [ + 'title' => '数据集版本ID', + 'description' => '数据集版本ID', + 'type' => 'string', + 'required' => true, + 'example' => ' '."\n" + .'dataworks-datasetVersion:3pXXXb8o0ngr07njhps1'."\n" + .':2', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request', + 'type' => 'string', + 'example' => '4CDF7B72-020B-542A-8465-21CFFA8XXXXX', + ], + 'Success' => [ + 'title' => '请求是否成功', + 'description' => '请求是否成功', + 'type' => 'boolean', + 'example' => 'true', + ], + 'DatasetVersion' => [ + 'title' => '数据集版本', + 'description' => '数据集版本', + '$ref' => '#/components/schemas/DatasetVersion', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"4CDF7B72-020B-542A-8465-21CFFA8XXXXX\\",\\n \\"Success\\": true,\\n \\"DatasetVersion\\": {\\n \\"Id\\": \\"\\",\\n \\"DatasetId\\": \\"\\",\\n \\"Comment\\": \\"\\",\\n \\"CreatorId\\": \\"\\",\\n \\"VersionNumber\\": 0,\\n \\"StorageType\\": \\"\\",\\n \\"Url\\": \\"\\",\\n \\"MountPath\\": \\"\\",\\n \\"CreateTime\\": 0,\\n \\"ModifyTime\\": 0,\\n \\"Labels\\": [\\n {\\n \\"Key\\": \\"\\",\\n \\"Value\\": \\"\\"\\n }\\n ],\\n \\"ImportInfo\\": {\\n \\"key\\": \\"\\"\\n }\\n }\\n}","type":"json"}]', + 'title' => '获取数据集版本信息', + ], + 'CreateDatasetVersion' => [ + 'summary' => '创建数据集版本，当前仅支持DataWorks数据集，支持最大版本数为20。', + 'path' => '', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREdideXGTG91', + ], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'DatasetId', + 'in' => 'formData', + 'schema' => [ + 'title' => '数据集ID，当前仅支持DataWorks数据集', + 'description' => '数据集ID，当前仅支持DataWorks数据集', + 'type' => 'string', + 'required' => true, + 'example' => 'dataworks-dataset:3pXXXb8o0ngr07njhps1', + ], + ], + [ + 'name' => 'Comment', + 'in' => 'formData', + 'schema' => [ + 'title' => '数据集版本描述,长度不超过1024', + 'description' => '数据集版本描述,长度不超过1024', + 'type' => 'string', + 'required' => false, + 'example' => 'this is a comment'."\n", + ], + ], + [ + 'name' => 'Url', + 'in' => 'formData', + 'schema' => [ + 'title' => 'URL地址', + 'description' => 'URL地址', + 'type' => 'string', + 'required' => true, + 'example' => 'oss://test-oss-bucket/test_dir/', + ], + ], + [ + 'name' => 'MountPath', + 'in' => 'formData', + 'schema' => [ + 'title' => '挂载路径，需要以/mnt/开头，默认为/mnt/data', + 'description' => '挂载路径，需要以/mnt/开头，默认为/mnt/data', + 'type' => 'string', + 'required' => false, + 'example' => '/mnt/data', + ], + ], + [ + 'name' => 'ImportInfo', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'title' => '数据集的存储导入配置'."\n" + .'对于NAS类型，需要提供以下属性，取值可参考DescribeFileSystems接口的返回信息'."\n" + .'- fileSystemId 文件系统ID'."\n" + .'- fileSystemStorageType 文件系统的存储规格'."\n" + .'- vpcId 挂载点的 VPC ID', + 'description' => '数据集的存储导入配置, 对于不同存储类型，需要的配置信息不同'."\n" + .'<details>'."\n" + .'<summary>NAS</summary>'."\n" + .'取值可参考文件存储 API DescribeFileSystems 的返回信息'."\n" + ."\n" + .'```JSON'."\n" + .'{'."\n" + .' "fileSystemId": "3b6XXX89c9", // 文件系统ID'."\n" + .' "fileSystemStorageType": "Performance", // 文件系统的存储规格'."\n" + .' "vpcId": "vpc-uf66oxxxrqge1t2gson7s" // 挂载点的VPC ID'."\n" + .'}'."\n" + .'```'."\n" + ."\n" + .'</details>', + 'type' => 'object', + 'required' => false, + 'additionalProperties' => [ + 'type' => 'string', + 'example' => 'None', + 'description' => '数据集存储导入配置', + ], + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request', + 'type' => 'string', + 'example' => '22C97E95-F023-56B5-8852-B1A77A17XXXX'."\n", + ], + 'Success' => [ + 'title' => '是否创建成功', + 'description' => '是否创建成功', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Id' => [ + 'title' => 'ID', + 'description' => 'ID', + 'type' => 'string', + 'example' => 'dataworks-datasetVersion:3pXXXb8o0ngr07njhps1'."\n" + .':2', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"22C97E95-F023-56B5-8852-B1A77A17XXXX\\\\n\\",\\n \\"Success\\": true,\\n \\"Id\\": \\"dataworks-datasetVersion:3pXXXb8o0ngr07njhps1\\\\n:2\\"\\n}","type":"json"}]', + 'title' => '创建数据集版本', + ], + 'UpdateDatasetVersion' => [ + 'summary' => '更新数据集版本信息，仅支持DataWorks数据集，要求操作者为数据集的创建者或数据集所在工作空间的管理员。', + 'path' => '', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREdideXGTG91', + ], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'Id', + 'in' => 'formData', + 'schema' => [ + 'title' => '数据集版本ID,仅支持更新DataWorks数据集', + 'description' => '数据集版本ID,仅支持更新DataWorks数据集', + 'type' => 'string', + 'required' => true, + 'example' => ' '."\n" + .'dataworks-datasetVersion:3pXXXb8o0ngr07njhps1'."\n" + .':2', + ], + ], + [ + 'name' => 'Comment', + 'in' => 'formData', + 'schema' => [ + 'title' => '数据集版本描述,长度不超过1024', + 'description' => '数据集版本描述,长度不超过1024', + 'type' => 'string', + 'required' => false, + 'example' => 'this is a comment', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request', + 'type' => 'string', + 'example' => 'A090666C-74FB-5629-ABFC-2FE99DD55XXX', + ], + 'Success' => [ + 'title' => '是否更新成功', + 'description' => '是否更新成功', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A090666C-74FB-5629-ABFC-2FE99DD55XXX\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => '更新数据集版本信息', + ], + 'DeleteDatasetVersion' => [ + 'summary' => '删除数据集版本，仅支持删除DataWorks非v1版本数据集，v1版本数据集需要通过DeleteDataset接口完成删除'."\n" + .'要求操作者为数据集的创建者或数据集所在工作空间的管理员。', + 'path' => '', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREdideXGTG91', + ], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'Id', + 'in' => 'query', + 'schema' => [ + 'title' => '数据集版本ID，仅支持DataWorks数据集', + 'description' => '数据集版本ID，仅支持DataWorks数据集', + 'type' => 'string', + 'required' => true, + 'example' => ' '."\n" + .'dataworks-datasetVersion:3pXXXb8o0ngr07njhps1'."\n" + .':2', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request', + 'type' => 'string', + 'example' => '6AABBBD3-F2E4-5860-8CF7-2E9CEE3BDXXX', + ], + 'Success' => [ + 'title' => '是否删除成功', + 'description' => '是否删除成功', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"6AABBBD3-F2E4-5860-8CF7-2E9CEE3BDXXX\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => '删除数据集版本', + ], + 'PreviewDatasetVersion' => [ + 'summary' => '预览指定版本数据集内容，当前仅支持OSS类型数据集下文本文件预览'."\n" + .'当前支持的MIME类型有'."\n" + .'1. application/json'."\n" + .'2. application/xml'."\n" + .'3. text/html'."\n" + .'4. text/plain'."\n" + .'5. application/octet-stream。', + 'path' => '', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREdideXGTG91', + ], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'Id', + 'in' => 'query', + 'schema' => [ + 'title' => '数据集版本ID', + 'description' => '数据集版本ID', + 'type' => 'string', + 'required' => true, + 'example' => ' '."\n" + .'dataworks-datasetVersion:3pXXXb8o0ngr07njhps1'."\n" + .':2', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request', + 'type' => 'string', + 'example' => 'A6C6B486-E3A2-5D52-9E76-D9380485DXXX', + ], + 'Success' => [ + 'title' => '请求是否成功', + 'description' => '请求是否成功', + 'type' => 'boolean', + 'example' => 'true', + ], + 'PreviewResult' => [ + 'title' => '预览结果', + 'description' => '预览结果', + 'type' => 'object', + 'properties' => [ + 'SupportPreview' => [ + 'title' => '是否支持预览', + 'description' => '是否支持预览', + 'type' => 'boolean', + 'example' => 'true', + ], + 'MimeType' => [ + 'title' => 'MIME多媒体类型', + 'description' => 'MIME多媒体类型', + 'type' => 'string', + 'example' => 'text/plain', + ], + 'FileName' => [ + 'title' => '预览文件名称', + 'description' => '预览文件名称', + 'type' => 'string', + 'example' => 'parth/data.csv', + ], + 'Content' => [ + 'title' => '预览内容', + 'description' => '预览内容', + 'type' => 'string', + 'example' => 'this is content', + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A6C6B486-E3A2-5D52-9E76-D9380485DXXX\\",\\n \\"Success\\": true,\\n \\"PreviewResult\\": {\\n \\"SupportPreview\\": true,\\n \\"MimeType\\": \\"text/plain\\",\\n \\"FileName\\": \\"parth/data.csv\\",\\n \\"Content\\": \\"this is content\\"\\n }\\n}","type":"json"}]', + 'title' => '预览数据集版本内容', + ], + 'ListPartitions' => [ + 'summary' => '查询数据地图给定数据表的分区列表，当前支持maxcompute和hms（EMR集群）类型。', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'abilityTreeCode' => '268132', + 'abilityTreeNodes' => [ + 'FEATUREdideE9OA4H', + ], + ], + 'parameters' => [ + [ + 'name' => 'TableId', + 'in' => 'query', + 'schema' => [ + 'title' => '所属数据表的资源标识', + 'description' => '所属数据表ID，可参考ListTables接口返回结果，'."\n" + .'以及[元数据实体相关概念说明](~~2880092~~)。', + 'type' => 'string', + 'required' => true, + 'example' => 'maxcompute-table:::project_name:[schema_name]:table_name', + ], + ], + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => [ + 'title' => '分区名称', + 'description' => '分区名称，模糊匹配，该参数仅对maxcompute类型有效', + 'type' => 'string', + 'required' => false, + 'example' => 'ds=20250101', + ], + ], + [ + 'name' => 'SortBy', + 'in' => 'query', + 'schema' => [ + 'title' => '排序字段，默认为CreateTime', + 'description' => '排序字段，默认为CreateTime，枚举值，当前支持'."\n" + ."\n\n" + .'- CreateTime：创建时间，仅MaxCompute类型支持。'."\n" + .'- ModifyTime：修改时间，仅MaxCompute类型支持。'."\n" + .'- Name：名称，HMS类型使用的排序方式。'."\n" + .'- RecordCount：记录数，仅MaxCompute类型支持。'."\n" + .'- DataSize：存储量，仅MaxCompute类型支持。', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [], + 'example' => 'CreateTime', + 'default' => 'CreateTime', + 'enum' => [ + 'CreateTime', + 'ModifyTime', + 'Name', + 'RecordCount', + 'DataSize', + ], + ], + ], + [ + 'name' => 'Order', + 'in' => 'query', + 'schema' => [ + 'title' => '排序方向，默认为Asc', + 'description' => '排序方向，默认为Asc，枚举值，当前支持'."\n" + ."\n\n" + .'- Asc：升序。'."\n" + .'- Desc：降序。', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [], + 'example' => 'Asc', + 'default' => 'Asc', + 'enum' => [ + 'Asc', + 'Desc', + ], + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'title' => '分页页码，默认为1', + 'description' => '分页页码，默认为1'."\n" + .'。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'minimum' => '1', + 'example' => '1', + 'default' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'title' => '分页大小，默认为10，最大为100', + 'description' => '分页大小，默认为10，最大为100'."\n" + .'。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '100', + 'minimum' => '1', + 'example' => '10', + 'default' => '10', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '返回结果'."\n" + .'。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID'."\n" + .'。', + 'type' => 'string', + 'example' => 'D1E2E5BC-xxxx-xxxx-xxxx-xxxxxx', + ], + 'Success' => [ + 'title' => '请求是否成功', + 'description' => '请求是否成功'."\n" + .'。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'PagingInfo' => [ + 'title' => '分页结果', + 'description' => '分页结果'."\n" + .'。', + 'type' => 'object', + 'properties' => [ + 'TotalCount' => [ + 'description' => '总记录数'."\n" + .'。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'PageNumber' => [ + 'description' => '分页页码'."\n" + .'。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '分页大小'."\n" + .'。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'PartitionList' => [ + 'title' => '数据表的分区列表', + 'description' => '数据表的分区列表'."\n" + .'。', + 'type' => 'array', + 'items' => [ + 'title' => '数据表的分区', + 'description' => '数据表的分区'."\n" + .'。', + '$ref' => '#/components/schemas/Partition', + ], + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D1E2E5BC-xxxx-xxxx-xxxx-xxxxxx\\",\\n \\"Success\\": true,\\n \\"PagingInfo\\": {\\n \\"TotalCount\\": 1,\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"PartitionList\\": [\\n {\\n \\"TableId\\": \\"maxcompute-table:accountId::project::table\\",\\n \\"Name\\": \\"ds=20250101\\",\\n \\"CreateTime\\": 1700192563000,\\n \\"ModifyTime\\": 1700192563000,\\n \\"RecordCount\\": 1000000,\\n \\"DataSize\\": 4096\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => '查询数据地图数据表的分区列表', + 'description' => '1. 需要购买DataWorks基础版及以上版本才能使用。'."\n" + .'2. 目前只支持 maxcompute、hms （EMR集群）类型的表。', + ], + 'GetPartition' => [ + 'summary' => '获取数据地图数据表的分区详情，当前仅支持MaxCompute和hms（EMR集群）类型。', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'abilityTreeCode' => '268141', + 'abilityTreeNodes' => [ + 'FEATUREdideE9XYA6', + ], + ], + 'parameters' => [ + [ + 'name' => 'TableId', + 'in' => 'query', + 'schema' => [ + 'description' => '数据表ID，可参考ListTables接口返回结果，'."\n" + .'以及[元数据实体相关概念说明](~~2880092~~)。', + 'type' => 'string', + 'required' => true, + 'example' => 'maxcompute-table:::project_name:[schema_name]:table_name', + ], + ], + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => [ + 'title' => '分区名称', + 'description' => '分区名称'."\n" + .'。', + 'type' => 'string', + 'required' => true, + 'example' => 'ds=20250101', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求'."\n" + .'ID。', + 'type' => 'string', + 'example' => 'D1E2E5BC-xxxx-xxxx-xxxx-xxxxxx', + ], + 'Success' => [ + 'title' => '请求是否成功', + 'description' => '请求是否成功'."\n" + .'。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Partition' => [ + 'description' => '分区详情'."\n" + .'。', + '$ref' => '#/components/schemas/Partition', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D1E2E5BC-xxxx-xxxx-xxxx-xxxxxx\\",\\n \\"Success\\": true,\\n \\"Partition\\": {\\n \\"TableId\\": \\"maxcompute-table:accountId::project::table\\",\\n \\"Name\\": \\"ds=20250101\\",\\n \\"CreateTime\\": 1700192563000,\\n \\"ModifyTime\\": 1700192563000,\\n \\"RecordCount\\": 1000000,\\n \\"DataSize\\": 4096\\n }\\n}","type":"json"}]', + 'title' => '获取数据地图数据表的分区详情', + 'description' => '1. 需要购买DataWorks基础版及以上版本才能使用。'."\n" + .'2. 目前只支持 MaxCompute、hms（EMR集群） 类型的表。', + ], + 'ListLineageRelationships' => [ + 'summary' => '查询数据地图给定两实体（表、字段、oss文件等）之间的血缘关系信息列表。', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'abilityTreeCode' => '268106', + 'abilityTreeNodes' => [ + 'FEATUREdideE9OA4H', + ], + ], + 'parameters' => [ + [ + 'name' => 'SrcEntityId', + 'in' => 'query', + 'schema' => [ + 'title' => '父层级实体ID', + 'description' => '源实体ID，可参考ListTables / ListColumns 接口返回的表/字段ID，以及自定义实体ID', + 'type' => 'string', + 'required' => true, + 'example' => 'maxcompute-table:::project_name:[schema_name]:table_name', + ], + ], + [ + 'name' => 'DstEntityId', + 'in' => 'query', + 'schema' => [ + 'description' => '目标实体ID，可参考ListTables / ListColumns 接口返回的表/字段ID，以及自定义实体ID', + 'type' => 'string', + 'required' => true, + 'example' => 'dlf-table::catalog_id:database_name::table_name', + ], + ], + [ + 'name' => 'SrcEntityName', + 'in' => 'query', + 'schema' => [ + 'title' => '名称', + 'description' => '源实体名称，模糊匹配。', + 'type' => 'string', + 'required' => false, + 'example' => 'srcName', + ], + ], + [ + 'name' => 'DstEntityName', + 'in' => 'query', + 'schema' => [ + 'description' => '目标实体名称，模糊匹配。', + 'type' => 'string', + 'required' => false, + 'example' => 'dstName', + ], + ], + [ + 'name' => 'SortBy', + 'in' => 'query', + 'schema' => [ + 'title' => '排序字段，默认为Name', + 'description' => '排序字段，默认为Name。', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [], + 'example' => 'Name', + 'default' => 'Name', + 'enum' => [ + 'Name', + ], + ], + ], + [ + 'name' => 'Order', + 'in' => 'query', + 'schema' => [ + 'title' => '排序方向，默认为Asc', + 'description' => '排序方向，默认为Asc，枚举值，当前支持：'."\n" + ."\n" + .'- Asc：升序'."\n" + .'- Desc：降序', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [], + 'example' => 'Asc', + 'default' => 'Asc', + 'enum' => [ + 'Asc', + 'Desc', + ], + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'title' => '分页页码，默认为1', + 'description' => '分页页码，默认为1。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'minimum' => '1', + 'example' => '1', + 'default' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'title' => '分页大小，默认为10，最大为100', + 'description' => '分页大小，默认为10，最大为100。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '100', + 'minimum' => '1', + 'example' => '10', + 'default' => '10', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求的ID。用于定位排查问题。', + 'type' => 'string', + 'example' => 'SDFSDFSDF-SDFSDF-SDFDSF-SDFSDF', + ], + 'Success' => [ + 'title' => '请求是否成功', + 'description' => '请求是否成功。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'PagingInfo' => [ + 'title' => '分页结果', + 'description' => '分页结果。', + 'type' => 'object', + 'properties' => [ + 'TotalCount' => [ + 'description' => '总数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '123', + ], + 'PageNumber' => [ + 'description' => '页数，用于翻页。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '分页大小。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'LineageRelationships' => [ + 'title' => '数据表列表', + 'description' => '数据表列表。', + 'type' => 'array', + 'items' => [ + 'description' => '血缘关系结构体。', + '$ref' => '#/components/schemas/LineageRelationship', + ], + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"SDFSDFSDF-SDFSDF-SDFDSF-SDFSDF\\",\\n \\"Success\\": true,\\n \\"PagingInfo\\": {\\n \\"TotalCount\\": 123,\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"LineageRelationships\\": [\\n {\\n \\"SrcEntity\\": {\\n \\"Id\\": \\"maxcompute-table:123456::test_project::test_tbl\\",\\n \\"Name\\": \\"test_tbl\\",\\n \\"Attributes\\": {\\n \\"key\\": \\"key1:value1\\"\\n }\\n },\\n \\"DstEntity\\": {\\n \\"Id\\": \\"maxcompute-table:123456::test_project::test_tbl\\",\\n \\"Name\\": \\"test_tbl\\",\\n \\"Attributes\\": {\\n \\"key\\": \\"key1:value1\\"\\n }\\n },\\n \\"Task\\": {\\n \\"Id\\": \\"12345\\",\\n \\"Type\\": \\"custom-sql\\",\\n \\"Attributes\\": {\\n \\"key\\": \\"key1:value21\\"\\n }\\n },\\n \\"Id\\": \\"maxcompute-table.p.table:custom-table.xxx:custom-sql.123\\",\\n \\"CreateTime\\": 1743040581000\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => '查询数据地图血缘关系列表', + 'description' => '1. 需要购买DataWorks基础版及以上版本才能使用。', + ], + 'GetLineageRelationship' => [ + 'summary' => '获取数据地图中给定的血缘关系详情信息。', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'abilityTreeCode' => '268092', + 'abilityTreeNodes' => [ + 'FEATUREdideE9XYA6', + ], + ], + 'parameters' => [ + [ + 'name' => 'Id', + 'in' => 'query', + 'schema' => [ + 'description' => '血缘关系ID，参考ListLineageRelationships接口返回结果。', + 'type' => 'string', + 'required' => true, + 'example' => '4as3dasf654a', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '58D5334A-B013-430E', + ], + 'LineageRelationship' => [ + 'description' => '血缘关系结构体。', + '$ref' => '#/components/schemas/LineageRelationship', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"58D5334A-B013-430E\\",\\n \\"LineageRelationship\\": {\\n \\"SrcEntity\\": {\\n \\"Id\\": \\"maxcompute-table:123456::test_project::test_tbl\\",\\n \\"Name\\": \\"test_tbl\\",\\n \\"Attributes\\": {\\n \\"key\\": \\"key1:value1\\"\\n }\\n },\\n \\"DstEntity\\": {\\n \\"Id\\": \\"maxcompute-table:123456::test_project::test_tbl\\",\\n \\"Name\\": \\"test_tbl\\",\\n \\"Attributes\\": {\\n \\"key\\": \\"key1:value1\\"\\n }\\n },\\n \\"Task\\": {\\n \\"Id\\": \\"12345\\",\\n \\"Type\\": \\"custom-sql\\",\\n \\"Attributes\\": {\\n \\"key\\": \\"key1:value21\\"\\n }\\n },\\n \\"Id\\": \\"maxcompute-table.p.table:custom-table.xxx:custom-sql.123\\",\\n \\"CreateTime\\": 1743040581000\\n }\\n}","type":"json"}]', + 'title' => '获取数据地图血缘关系', + 'description' => '1. 需要购买DataWorks基础版及以上版本才能使用。', + ], + 'DeleteLineageRelationship' => [ + 'summary' => '删除给定的数据地图血缘关系。', + 'methods' => [ + 'delete', + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'abilityTreeCode' => '268096', + 'abilityTreeNodes' => [ + 'FEATUREdideE9XYA6', + ], + ], + 'parameters' => [ + [ + 'name' => 'Id', + 'in' => 'formData', + 'schema' => [ + 'description' => '血缘关系ID，参考ListLineageRelationships接口返回结果。', + 'type' => 'string', + 'required' => true, + 'example' => '4as3dasf654a', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求'."\n" + .'ID。', + 'type' => 'string', + 'example' => '952795279527ab****', + ], + 'Success' => [ + 'description' => '请求是否成功，取值如下：'."\n" + ."\n" + .'- true, 请求成功'."\n" + .'- false， 请求失败', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"952795279527ab****\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => '删除数据地图血缘关系', + 'description' => '1. 需要购买DataWorks专业版及以上版本才能使用。', + ], + 'CreateLineageRelationship' => [ + 'summary' => '注册数据地图的血缘关系，要求至少其中一方为自定义对象。通过此接口，可以将自定义对象（如外部报表、第三方系统表等）与 DataWorks 纳管元数据实体建立连接。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'abilityTreeCode' => '268107', + 'abilityTreeNodes' => [ + 'FEATUREdideE9OA4H', + ], + ], + 'parameters' => [ + [ + 'name' => 'SrcEntity', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '源实体'."\n" + .'。', + 'required' => false, + '$ref' => '#/components/schemas/LineageEntity', + ], + ], + [ + 'name' => 'DstEntity', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '目标实体'."\n" + .'。', + 'required' => false, + '$ref' => '#/components/schemas/LineageEntity', + ], + ], + [ + 'name' => 'Task', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '任务信息'."\n" + .'。', + 'required' => false, + '$ref' => '#/components/schemas/LineageTask', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID，'."\n" + .'一次请求的唯一标识。', + 'type' => 'string', + 'example' => 'C99E2BE6-9DEA-5C2E-8F51-1DDCFEADE490', + ], + 'Success' => [ + 'title' => '请求是否成功', + 'description' => '请求是否成功。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Id' => [ + 'description' => '血缘关系ID。', + 'type' => 'string', + 'example' => '4as3dasf654a', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"C99E2BE6-9DEA-5C2E-8F51-1DDCFEADE490\\",\\n \\"Success\\": true,\\n \\"Id\\": \\"4as3dasf654a\\"\\n}","type":"json"}]', + 'title' => '注册数据地图血缘关系', + 'description' => '1. 需要购买DataWorks专业版及以上版本才能使用。', + 'requestParamsDescription' => '实体对象 (SrcEntity / DstEntity)'."\n" + ."\n" + .'用于定义血缘关系的起点和终点。当作为自定义对象注册时，参数要求如下：'."\n" + ."\n" + .'| 参数名称 | 类型 | 必填 | 描述 |'."\n" + .'| :--- | :--- | :--- | :--- |'."\n" + .'| **Id** | String | 是 | **自定义对象标识**，租户内唯一。格式为 `custom-{Type}:{Identifier}`。<br>• `Type`: 对象类型（字母/数字/下划线，≤64字符）<br>• `Identifier`: 对象标识（字母/数字/下划线，≤64字符） |'."\n" + .'| **Name** | String | 是 | **对象名称**（字母/数字/下划线，≤64字符）。 |'."\n" + .'| **Attributes** | Map | 否 | **自定义属性**。最多支持 20 个属性。<br>• Key: 属性名（字母/数字/下划线，≤64字符）<br>• Value: 属性值（≤128字符） |'."\n" + ."\n" + .'**自定义对象示例：**'."\n" + .'```json'."\n" + .'{'."\n" + .' "Id": "custom-report:report_001",'."\n" + .' "Name": "report_001",'."\n" + .' "Attributes": {'."\n" + .' "Owner": "zhangsan",'."\n" + .' "Department": "Sales"'."\n" + .' }'."\n" + .'}'."\n" + .'```'."\n" + ."\n" + .'---'."\n" + ."\n" + .'任务信息 (Task)'."\n" + ."\n" + .'用于描述产生该血缘关系的作业或任务信息。'."\n" + ."\n" + .'| 参数名称 | 类型 | 必填 | 描述 |'."\n" + .'| :--- | :--- | :--- | :--- |'."\n" + .'| **Id** | String | 是 | **任务唯一标识**。由字母、数字、下划线组成，长度不超过 64 个字符。 |'."\n" + .'| **Type** | String | 是 | **任务类型**。格式为 `custom-{RawType}`。<br>• `RawType`: 任务定义的类型（字母/数字/下划线，≤64字符） |'."\n" + .'| **Attributes** | Map | 否 | **任务自定义属性**。最多支持 20 个属性。<br>• Key: 属性名（字母/数字/下划线，≤64字符）<br>• Value: 属性值（≤128字符） |'."\n" + ."\n" + .'**任务信息示例：**'."\n" + .'```json'."\n" + .'{'."\n" + .' "Id": "task_handler_89a6sda",'."\n" + .' "Type": "custom-hive_sql",'."\n" + .' "Attributes": {'."\n" + .' "Cluster": "Production_Cluster",'."\n" + .' "RetryTimes": "3"'."\n" + .' }'."\n" + .'}'."\n" + .'```', + ], + 'ListLineages' => [ + 'summary' => '查询数据地图中给定实体的上下游血缘实体列表，是否包含具体的血缘关系信息可选。', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'abilityTreeCode' => '268105', + 'abilityTreeNodes' => [ + 'FEATUREdideE9OA4H', + ], + ], + 'parameters' => [ + [ + 'name' => 'SrcEntityId', + 'in' => 'query', + 'schema' => [ + 'title' => '父层级实体ID', + 'description' => '源实体ID，可参考ListTables / ListColumns 接口返回的表/字段ID，以及自定义实体ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'maxcompute-table:::project_name:[schema_name]:table_name', + ], + ], + [ + 'name' => 'DstEntityId', + 'in' => 'query', + 'schema' => [ + 'description' => '目标实体ID，可参考ListTables / ListColumns 接口返回的表/字段ID，以及自定义实体ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'dlf-table::catalog_id:database_name::table_name', + ], + ], + [ + 'name' => 'SrcEntityName', + 'in' => 'query', + 'schema' => [ + 'title' => '名称', + 'description' => '源实体名称，模糊匹配。', + 'type' => 'string', + 'required' => false, + 'example' => 'srcName1', + ], + ], + [ + 'name' => 'DstEntityName', + 'in' => 'query', + 'schema' => [ + 'description' => '目标实体名称，模糊匹配。', + 'type' => 'string', + 'required' => false, + 'example' => 'dstName1', + ], + ], + [ + 'name' => 'NeedAttachRelationship', + 'in' => 'query', + 'schema' => [ + 'description' => '是否返回血缘关系信息，默认为false。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + 'default' => 'false', + ], + ], + [ + 'name' => 'SortBy', + 'in' => 'query', + 'schema' => [ + 'title' => '排序字段，默认为Name', + 'description' => '排序字段，默认为Name，按照血缘实体名称排序。', + 'type' => 'string', + 'required' => false, + 'example' => 'Name', + 'default' => 'Name', + 'enum' => [ + 'Name', + ], + ], + ], + [ + 'name' => 'Order', + 'in' => 'query', + 'schema' => [ + 'title' => '排序方向，默认为Asc', + 'description' => '排序方向，默认为Asc，枚举值，当前支持'."\n" + .'- Asc 升序'."\n" + .'- Desc 降序', + 'type' => 'string', + 'required' => false, + 'example' => 'Asc', + 'default' => 'Asc', + 'enum' => [ + 'Asc', + 'Desc', + ], + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'title' => '分页页码，默认为1', + 'description' => '分页页码，默认为1。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'minimum' => '1', + 'example' => '1', + 'default' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'title' => '分页大小，默认为10，最大为100', + 'description' => '分页大小，默认为10，最大为100。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '100', + 'minimum' => '1', + 'example' => '10', + 'default' => '10', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求'."\n" + .'ID。', + 'type' => 'string', + 'example' => '0000-ABCD-EFG****', + ], + 'Success' => [ + 'title' => '请求是否成功', + 'description' => '请求是否成功。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'PagingInfo' => [ + 'title' => '分页结果', + 'description' => '分页结果。', + 'type' => 'object', + 'properties' => [ + 'TotalCount' => [ + 'description' => '总条'."\n" + .'数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '12', + ], + 'PageNumber' => [ + 'description' => '请求的数据页数，'."\n" + .'用于翻页。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '分页大小，'."\n" + .'默认为10。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'Lineages' => [ + 'title' => '数据表列表', + 'description' => '血缘信息列表。', + 'type' => 'array', + 'items' => [ + 'description' => '血缘信息。', + 'type' => 'object', + 'properties' => [ + 'SrcEntity' => [ + 'description' => '源实体。', + '$ref' => '#/components/schemas/LineageEntity', + ], + 'DstEntity' => [ + 'description' => '目标实体。', + '$ref' => '#/components/schemas/LineageEntity', + ], + 'Relationships' => [ + 'description' => '血缘关系信息。', + 'type' => 'array', + 'items' => [ + 'description' => '血缘关系信息。', + '$ref' => '#/components/schemas/LineageRelationship', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0000-ABCD-EFG****\\",\\n \\"Success\\": true,\\n \\"PagingInfo\\": {\\n \\"TotalCount\\": 12,\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"Lineages\\": [\\n {\\n \\"SrcEntity\\": {\\n \\"Id\\": \\"maxcompute-table:123456::test_project::test_tbl\\",\\n \\"Name\\": \\"test_tbl\\",\\n \\"Attributes\\": {\\n \\"key\\": \\"key1:value1\\"\\n }\\n },\\n \\"DstEntity\\": {\\n \\"Id\\": \\"maxcompute-table:123456::test_project::test_tbl\\",\\n \\"Name\\": \\"test_tbl\\",\\n \\"Attributes\\": {\\n \\"key\\": \\"key1:value1\\"\\n }\\n },\\n \\"Relationships\\": [\\n {\\n \\"SrcEntity\\": {\\n \\"Id\\": \\"maxcompute-table:123456::test_project::test_tbl\\",\\n \\"Name\\": \\"test_tbl\\",\\n \\"Attributes\\": {\\n \\"key\\": \\"key1:value1\\"\\n }\\n },\\n \\"Task\\": {\\n \\"Id\\": \\"12345\\",\\n \\"Type\\": \\"custom-sql\\",\\n \\"Attributes\\": {\\n \\"key\\": \\"key1:value21\\"\\n }\\n },\\n \\"Id\\": \\"maxcompute-table.p.table:custom-table.xxx:custom-sql.123\\",\\n \\"CreateTime\\": 1743040581000\\n }\\n ]\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => '查询数据地图实体血缘列表', + 'description' => '1. 需要购买DataWorks基础版及以上版本才能使用。'."\n" + .'2. 本接口主要查询当前实体有哪些上/下游实体，以及实体间的血缘关系', + ], + 'ListMetaCollections' => [ + 'summary' => '查询数据地图集合列表，支持查询数据地图类目以及数据专辑两种类型。', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '266685', + 'abilityTreeNodes' => [ + 'FEATUREdideE9XYA6', + ], + 'autoTest' => true, + ], + 'parameters' => [ + [ + 'name' => 'Type', + 'in' => 'query', + 'schema' => [ + 'description' => '集合类型，可枚举，取值为'."\n" + ."\n" + .' - Category 类目'."\n" + .' - Album 数据专辑'."\n" + .' - AlbumCategory 专辑子类目', + 'type' => 'string', + 'required' => true, + 'example' => 'Category', + 'enum' => [ + 'Category', + 'Album', + 'AlbumCategory', + ], + ], + ], + [ + 'name' => 'ParentId', + 'in' => 'query', + 'schema' => [ + 'description' => '父节点集合对象ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'as78d756asd', + ], + ], + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => [ + 'description' => '集合名称，模糊匹配。', + 'type' => 'string', + 'required' => false, + 'example' => 'test', + ], + ], + [ + 'name' => 'Description', + 'in' => 'query', + 'schema' => [ + 'description' => '集合描述，模糊匹配。', + 'type' => 'string', + 'required' => false, + 'example' => '测试集合', + ], + ], + [ + 'name' => 'CreateUser', + 'in' => 'query', + 'schema' => [ + 'description' => '创建者用户ID，专辑类型有效，默认为当前用户ID。', + 'type' => 'string', + 'required' => false, + 'example' => '123456', + ], + ], + [ + 'name' => 'Administrator', + 'in' => 'query', + 'schema' => [ + 'description' => '集合管理员ID，专辑类型有效，默认为当前用户ID。', + 'type' => 'string', + 'required' => false, + 'example' => '12345', + ], + ], + [ + 'name' => 'SortBy', + 'in' => 'query', + 'schema' => [ + 'description' => '排序字段, 支持'."\n" + ."\n" + .' - Id（默认）'."\n" + .' - Name 名称'."\n" + .' - CreateUser 创建者ID'."\n" + .' - CreateTime 创建时间'."\n" + .' - ModifyTime 修改时间', + 'type' => 'string', + 'required' => false, + 'example' => 'Name', + ], + ], + [ + 'name' => 'Order', + 'in' => 'query', + 'schema' => [ + 'description' => '排序方向，支持'."\n" + ."\n" + .' - Asc（默认）'."\n" + .' - Desc', + 'type' => 'string', + 'required' => false, + 'example' => 'Asc', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '分页页码，默认为1。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '分页大小，默认为10，最大为100。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'E25887B7-XXXX-54A5-9C4F-83A0DE367DDE', + ], + 'Data' => [ + 'title' => '分页结果', + 'description' => '分页结果对象。', + 'type' => 'object', + 'properties' => [ + 'TotalCount' => [ + 'description' => '总记录数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'PageNumber' => [ + 'description' => '页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '页大小。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'MetaCollections' => [ + 'description' => '集合列表。', + 'type' => 'array', + 'items' => [ + 'description' => '集合对象。', + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'description' => '集合对象名称。', + 'type' => 'string', + 'example' => 'test_category', + ], + 'Id' => [ + 'description' => '集合对象名称。', + 'type' => 'string', + 'example' => '7a65sd7aasd', + ], + 'ParentId' => [ + 'description' => '父节点集合对象Id，可为空。', + 'type' => 'string', + 'example' => 'as78d756asd', + ], + 'Description' => [ + 'description' => '集合对象描述。', + 'type' => 'string', + 'example' => '测试类目', + ], + 'Type' => [ + 'description' => '集合类型，可枚举，取值为'."\n" + ."\n" + .' - Category 类目'."\n" + .' - Album 数据专辑'."\n" + .' - AlbumCategory 专辑子类目', + 'type' => 'string', + 'example' => 'Category', + ], + 'CreateUser' => [ + 'description' => '创建者用户ID。', + 'type' => 'string', + 'example' => '456789', + ], + 'CreateTime' => [ + 'description' => '创建时间毫秒级时间戳。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1668568601000', + ], + 'ModifyTime' => [ + 'description' => '修改时间毫秒级时间戳。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1668568601000', + ], + 'Administrators' => [ + 'description' => '管理员用户ID列表，仅专辑类型支持，'."\n" + .'需要为同租户下用户，可设置多个。', + 'type' => 'array', + 'items' => [ + 'description' => '管理员用户ID。', + 'type' => 'string', + 'example' => '765432', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"E25887B7-XXXX-54A5-9C4F-83A0DE367DDE\\",\\n \\"Data\\": {\\n \\"TotalCount\\": 10,\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"MetaCollections\\": [\\n {\\n \\"Name\\": \\"test_category\\",\\n \\"Id\\": \\"7a65sd7aasd\\",\\n \\"ParentId\\": \\"as78d756asd\\",\\n \\"Description\\": \\"测试类目\\",\\n \\"Type\\": \\"Category\\",\\n \\"CreateUser\\": \\"456789\\",\\n \\"CreateTime\\": 1668568601000,\\n \\"ModifyTime\\": 1668568601000,\\n \\"Administrators\\": [\\n \\"765432\\"\\n ]\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => '查询数据地图集合列表', + 'description' => '1. 需要购买DataWorks专业版及以上版本才能使用。', + ], + 'CreateMetaCollection' => [ + 'summary' => '创建数据地图集合对象，支持创建数据地图类目（包括多级子类目）、数据专辑（专辑子类目）两种类型的集合对象。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'abilityTreeCode' => '266523', + 'abilityTreeNodes' => [ + 'FEATUREdideE9XYA6', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'ParentId', + 'in' => 'query', + 'schema' => [ + 'description' => '父节点集合对象Id。', + 'type' => 'string', + 'required' => false, + 'example' => 'as78d756asd', + ], + ], + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => [ + 'description' => '集合对象名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'test_album', + ], + ], + [ + 'name' => 'Type', + 'in' => 'query', + 'schema' => [ + 'description' => '集合类型，可枚举，取值为'."\n" + ."\n" + .' - Category 类目'."\n" + .' - Album 数据专辑'."\n" + .' - AlbumCategory 专辑子类目', + 'type' => 'string', + 'required' => true, + 'enumValueTitles' => [], + 'example' => 'Category', + 'enum' => [ + 'Category', + 'Album', + 'AlbumCategory', + ], + ], + ], + [ + 'name' => 'Description', + 'in' => 'query', + 'schema' => [ + 'description' => '集合对象描述。', + 'type' => 'string', + 'required' => false, + 'example' => 'test comment', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'E6F0DBDD-5AD****', + ], + 'Id' => [ + 'description' => '创建成功后集合对象的ID。', + 'type' => 'string', + 'example' => '4as3dasf654a', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"E6F0DBDD-5AD****\\",\\n \\"Id\\": \\"4as3dasf654a\\"\\n}","type":"json"}]', + 'title' => '创建数据地图集合对象', + 'description' => '1. 需要购买DataWorks专业版及以上版本才能使用。', + ], + 'GetMetaCollection' => [ + 'summary' => '获取数据地图给定集合的详细信息，支持查询数据地图类目和数据专辑两种类型。', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '266716', + 'abilityTreeNodes' => [ + 'FEATUREdideE9XYA6', + ], + ], + 'parameters' => [ + [ + 'name' => 'Id', + 'in' => 'query', + 'schema' => [ + 'description' => '集合对象Id。', + 'type' => 'string', + 'required' => true, + 'example' => 'as78d756asd', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '1AFAE64E-D1BE-432B-A9****', + ], + 'MetaCollection' => [ + 'description' => '集合信息。', + 'type' => 'object', + 'properties' => [ + 'Id' => [ + 'description' => '集合ID。', + 'type' => 'string', + 'example' => 'as78d756asd', + ], + 'Type' => [ + 'description' => '集合类型，可枚举，取值为'."\n" + ."\n" + .' - Category 类目'."\n" + .' - Album 数据专辑'."\n" + .' - AlbumCategory 专辑子类目', + 'type' => 'string', + 'example' => 'Category', + ], + 'ParentId' => [ + 'description' => '父节点集合对象Id，可为空。', + 'type' => 'string', + 'example' => '4as3dasf654a', + ], + 'Name' => [ + 'description' => '集合对象名称。', + 'type' => 'string', + 'example' => 'test_category', + ], + 'Description' => [ + 'description' => '集合对象描述。', + 'type' => 'string', + 'example' => 'test', + ], + 'CreateTime' => [ + 'description' => '创建时间毫秒级时间戳。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1668568601000', + ], + 'ModifyTime' => [ + 'description' => '修改时间毫秒级时间戳。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1668568601000', + ], + 'CreateUser' => [ + 'description' => '创建者用户ID。', + 'type' => 'string', + 'example' => '456789', + ], + 'Administrators' => [ + 'description' => '管理员用户ID列表，仅专辑类型支持，'."\n" + .'需要为同租户下用户，可设置多个。', + 'type' => 'array', + 'items' => [ + 'description' => '管理员用户ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '765432', + ], + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1AFAE64E-D1BE-432B-A9****\\",\\n \\"MetaCollection\\": {\\n \\"Id\\": \\"as78d756asd\\",\\n \\"Type\\": \\"Category\\",\\n \\"ParentId\\": \\"4as3dasf654a\\",\\n \\"Name\\": \\"test_category\\",\\n \\"Description\\": \\"test\\",\\n \\"CreateTime\\": 1668568601000,\\n \\"ModifyTime\\": 1668568601000,\\n \\"CreateUser\\": \\"456789\\",\\n \\"Administrators\\": [\\n 765432\\n ]\\n }\\n}","type":"json"}]', + 'title' => '获取数据地图集合信息', + 'description' => '1. 需要购买DataWorks专业版及以上版本才能使用。', + ], + 'UpdateMetaCollection' => [ + 'summary' => '更新数据地图集合对象，包括数据地图类目和数据专辑，支持更新集合名称，描述和管理员信息。'."\n" + .'更新数据专辑时，要求调用者具有AliyunDataWorksFullAccess 权限，或者为专辑的创建者或管理员。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'abilityTreeCode' => '266814', + 'abilityTreeNodes' => [ + 'FEATUREdideE9XYA6', + ], + ], + 'parameters' => [ + [ + 'name' => 'Id', + 'in' => 'query', + 'schema' => [ + 'description' => '集合对象ID', + 'type' => 'string', + 'required' => true, + 'example' => 'as78d756asd', + ], + ], + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => [ + 'description' => '更新后的集合名称', + 'type' => 'string', + 'required' => false, + 'example' => 'new_name', + ], + ], + [ + 'name' => 'Description', + 'in' => 'query', + 'schema' => [ + 'description' => '更新后的集合描述', + 'type' => 'string', + 'required' => false, + 'example' => 'new comment', + ], + ], + [ + 'name' => 'Administrators', + 'in' => 'query', + 'style' => 'simple', + 'schema' => [ + 'description' => '集合管理员ID列表，仅专辑类型支持，要求管理员为同租户下账号', + 'type' => 'array', + 'items' => [ + 'description' => '集合管理员ID', + 'type' => 'string', + 'required' => false, + 'example' => '123434', + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request', + 'type' => 'string', + 'example' => '0E1C0122-F79F-5C26-B546-47A321691868', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0E1C0122-F79F-5C26-B546-47A321691868\\"\\n}","type":"json"}]', + 'title' => '更新数据地图集合对象', + 'description' => '1. 需要购买DataWorks专业版及以上版本才能使用。', + ], + 'DeleteMetaCollection' => [ + 'summary' => '删除给定数据地图中的集合对象，包括数据地图类目和数据专辑。'."\n" + .'删除数据专辑时，要求调用者具有AliyunDataWorksFullAccess 权限，或者为专辑的创建者或管理员。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'abilityTreeCode' => '266820', + 'abilityTreeNodes' => [ + 'FEATUREdideE9XYA6', + ], + ], + 'parameters' => [ + [ + 'name' => 'Id', + 'in' => 'query', + 'schema' => [ + 'description' => '集合对象Id', + 'type' => 'string', + 'required' => true, + 'example' => 'as78d756asd', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request', + 'type' => 'string', + 'example' => '45D14A7A-7C28-5547-AB0A-35FBCD9DE7B5', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"45D14A7A-7C28-5547-AB0A-35FBCD9DE7B5\\"\\n}","type":"json"}]', + 'title' => '删除数据地图集合对象', + 'description' => '1. 需要购买DataWorks专业版及以上版本才能使用。', + ], + 'ListEntitiesInMetaCollection' => [ + 'summary' => '查询数据地图集合中的实体列表，集合支持数据地图类目和数据专辑，实体当前仅支持数据表类型。', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'abilityTreeCode' => '267198', + 'abilityTreeNodes' => [ + 'FEATUREdideE9XYA6', + ], + ], + 'parameters' => [ + [ + 'name' => 'Id', + 'in' => 'query', + 'schema' => [ + 'description' => '集合对象Id。', + 'type' => 'string', + 'required' => true, + 'example' => 'as78d756asd', + ], + ], + [ + 'name' => 'EntityType', + 'in' => 'query', + 'schema' => [ + 'description' => '实体类型。', + 'type' => 'string', + 'required' => false, + 'example' => 'dlf-table', + ], + ], + [ + 'name' => 'EntityName', + 'in' => 'query', + 'schema' => [ + 'description' => '实体名称，模糊匹配。', + 'type' => 'string', + 'required' => false, + 'example' => 'test1', + ], + ], + [ + 'name' => 'EntityDescription', + 'in' => 'query', + 'schema' => [ + 'description' => '添加实体到集合时的描述，模糊匹配，目前仅专辑类型支持。', + 'type' => 'string', + 'required' => false, + 'example' => 'test', + ], + ], + [ + 'name' => 'SortBy', + 'in' => 'query', + 'schema' => [ + 'description' => '排序字段, 支持'."\n" + ."\n" + .' - Name 名称（默认）'."\n" + .' - CreateTime 实体创建时间', + 'type' => 'string', + 'required' => false, + 'example' => 'Name', + ], + ], + [ + 'name' => 'Order', + 'in' => 'query', + 'schema' => [ + 'description' => '排序方向，支持'."\n" + ."\n" + .' - Asc（默认）'."\n" + .' - Desc', + 'type' => 'string', + 'required' => false, + 'example' => 'Asc', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '分页页码，默认为1。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '分页大小，默认为10，最大为100。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'F05080B0-CCE6-5D22-B284-34A51C5D4E28', + ], + 'PagingInfo' => [ + 'description' => '分页结果对象。', + 'type' => 'object', + 'properties' => [ + 'TotalCount' => [ + 'description' => '总记录数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '100', + ], + 'PageNumber' => [ + 'description' => '页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '页大小。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Entities' => [ + 'description' => '集合实体列表。', + 'type' => 'array', + 'items' => [ + 'description' => '集合实体。', + 'type' => 'object', + 'properties' => [ + 'Id' => [ + 'description' => '实体对象的Id，目前仅支持Table资源类型'."\n" + .'如果实体已删除，此处返回空。', + 'type' => 'string', + 'example' => 'maxcompute-table:::project_name:[schema_name]:table_name', + ], + 'Type' => [ + 'description' => '实体类型。', + 'type' => 'string', + 'example' => 'maxcompute-table', + ], + 'Name' => [ + 'description' => '实体名称。', + 'type' => 'string', + 'example' => 'test_table', + ], + 'Comment' => [ + 'description' => '实体注释。', + 'type' => 'string', + 'example' => 'test', + ], + 'CreateTime' => [ + 'description' => '创建时间毫秒级时间戳。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1737078994080', + ], + 'ModifyTime' => [ + 'description' => '修改时间毫秒级时间戳。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1737078994080', + ], + 'Description' => [ + 'description' => '添加到集合时的描述信息，目前仅对专辑有效。', + 'type' => 'string', + 'example' => 'test', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F05080B0-CCE6-5D22-B284-34A51C5D4E28\\",\\n \\"PagingInfo\\": {\\n \\"TotalCount\\": 100,\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 1,\\n \\"Entities\\": [\\n {\\n \\"Id\\": \\"maxcompute-table:::project_name:[schema_name]:table_name\\",\\n \\"Type\\": \\"maxcompute-table\\",\\n \\"Name\\": \\"test_table\\",\\n \\"Comment\\": \\"test\\",\\n \\"CreateTime\\": 1737078994080,\\n \\"ModifyTime\\": 1737078994080,\\n \\"Description\\": \\"test\\"\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => '查询数据地图集合中的实体列表', + 'description' => '1. 需要购买DataWorks专业版及以上版本才能使用。', + ], + 'AddEntityIntoMetaCollection' => [ + 'summary' => '向数据地图集合中添加给定实体对象，集合对象支持数据地图类目和数据专辑两种，实体对象当前仅支持数据表类型。'."\n" + .'向数据专辑添加实体时，要求调用者具有AliyunDataWorksFullAccess 权限，或者为专辑的创建者或管理员。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'abilityTreeCode' => '267213', + 'abilityTreeNodes' => [ + 'FEATUREdideE9XYA6', + ], + ], + 'parameters' => [ + [ + 'name' => 'MetaCollectionId', + 'in' => 'query', + 'schema' => [ + 'description' => '集合对象Id，可参考ListMetaCollections接口返回结果。', + 'type' => 'string', + 'required' => true, + 'example' => 'as78d756asd', + ], + ], + [ + 'name' => 'Id', + 'in' => 'query', + 'schema' => [ + 'description' => '实体Id，目前仅支持表类型，可参考ListTables接口返回结果。', + 'type' => 'string', + 'required' => true, + 'enumValueTitles' => [], + 'example' => 'maxcompute-table:::project_name:[schema_name]:table_name', + ], + ], + [ + 'name' => 'Remark', + 'in' => 'query', + 'schema' => [ + 'description' => '添加到集合时的备注信息，'."\n" + .'目前仅对专辑类型生效。', + 'type' => 'string', + 'required' => false, + 'example' => 'test', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'C99E2BE6-9DEA-5C2E-8F51-1DDCFEADE490', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"C99E2BE6-9DEA-5C2E-8F51-1DDCFEADE490\\"\\n}","type":"json"}]', + 'title' => '向数据地图集合中添加实体对象', + 'description' => '1. 需要购买DataWorks专业版及以上版本才能使用。', + ], + 'RemoveEntityFromMetaCollection' => [ + 'summary' => '从数据地图集合中移除实体对象，集合支持数据地图类目和数据专辑，实体当前仅支持数据表类型。'."\n" + .'从数据专辑移除实体时，要求调用者具有AliyunDataWorksFullAccess 权限，或者为专辑的创建者或管理员。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'abilityTreeCode' => '267220', + 'abilityTreeNodes' => [ + 'FEATUREdideE9XYA6', + ], + ], + 'parameters' => [ + [ + 'name' => 'MetaCollectionId', + 'in' => 'query', + 'schema' => [ + 'description' => '集合对象Id，可参考ListMetaCollections接口返回结果', + 'type' => 'string', + 'required' => false, + 'example' => 'as78d756asd', + ], + ], + [ + 'name' => 'Id', + 'in' => 'query', + 'schema' => [ + 'description' => '实体Id，目前仅支持表类型，可参考ListTables接口返回结果', + 'type' => 'string', + 'required' => false, + 'example' => 'maxcompute-table:::project_name:[schema_name]:table_name', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request', + 'type' => 'string', + 'example' => '6D6CD444-DFA0-5180-9763-4A8730F2B382', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"6D6CD444-DFA0-5180-9763-4A8730F2B382\\"\\n}","type":"json"}]', + 'title' => '从数据地图集合中移除实体对象', + 'description' => '1. 需要购买DataWorks专业版及以上版本才能使用。', + ], + 'ListAlertRules' => [ + 'summary' => '分页获取自定义监控告警规则。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '249251', + 'abilityTreeNodes' => [ + 'FEATUREdideRJGWWC', + ], + ], + 'parameters' => [ + [ + 'name' => 'Owner', + 'in' => 'query', + 'schema' => [ + 'description' => '自定义规则的责任人阿里云UID。', + 'type' => 'string', + 'required' => false, + 'example' => '1933790683****', + ], + ], + [ + 'name' => 'TaskIds', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '调度任务ID列表', + 'type' => 'array', + 'items' => [ + 'description' => '调度任务ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1234', + ], + 'required' => false, + ], + ], + [ + 'name' => 'Types', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '触发告警的类型列表。', + 'type' => 'array', + 'items' => [ + 'description' => '触发告警的类型，枚举值：'."\n" + .'- Finished: 实例完成'."\n" + .'- UnFinished: 实例未完成'."\n" + .'- Error: 实例出错'."\n" + .'- CycleUnfinished: 实例周期未完成'."\n" + .'- Timeout: 实例超时'."\n" + .'- InstanceTransferComplete: 任务转实例完成'."\n" + .'- InstanceTransferFluctuate: 实例数量波动'."\n" + .'- ExhaustedError: 自动重跑后仍出错'."\n" + .'- InstanceKeyword: 出错实例包含关键词'."\n" + .'- InstanceErrorCount: 出错实例数量'."\n" + .'- InstanceErrorPercentage: 出错实例占比 '."\n" + .'- ResourceGroupPercentage: 资源组利用率'."\n" + .'- ResourceGroupWaitCount: 资源组等资源实例数', + 'type' => 'string', + 'required' => false, + 'example' => 'Error', + ], + 'required' => false, + ], + ], + [ + 'name' => 'Receiver', + 'in' => 'query', + 'schema' => [ + 'description' => '告警接收人阿里云UID。', + 'type' => 'string', + 'required' => false, + 'example' => '1933790683****', + ], + ], + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => [ + 'description' => '自定义规则名', + 'type' => 'string', + 'required' => false, + 'example' => 'error_rule', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '页码数，用于翻页，最小值为1。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'minimum' => '1', + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '每页显示的条数，最大100条。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'maximum' => '100', + 'example' => '10', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求的 ID，用于定位日志，排查问题。', + 'type' => 'string', + 'example' => 'A6C6B486-E3A2-5D52-9E76-D938048****', + ], + 'PagingInfo' => [ + 'description' => '分页信息。', + 'type' => 'object', + 'properties' => [ + 'TotalCount' => [ + 'description' => '满足条件的数据总条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '5', + ], + 'PageNumber' => [ + 'description' => '请求的数据页数，用于翻页。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '每页显示的条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'AlertRules' => [ + 'description' => '一组自定义规则。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Id' => [ + 'description' => '自定义规则ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '22125', + ], + 'Name' => [ + 'description' => '自定义规则名。', + 'type' => 'string', + 'example' => 'error_test', + ], + 'Owner' => [ + 'description' => '自定义规则的责任人阿里云UID。', + 'type' => 'string', + 'example' => '1933790683****', + ], + 'Enabled' => [ + 'description' => '告警规则是否启用。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'TriggerCondition' => [ + 'description' => '触发告警的条件。', + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'description' => '触发告警的类型，枚举值：'."\n" + .'- Finished: 实例完成'."\n" + .'- UnFinished: 实例未完成'."\n" + .'- Error: 实例出错'."\n" + .'- CycleUnfinished: 实例周期未完成'."\n" + .'- Timeout: 实例超时'."\n" + .'- InstanceTransferComplete: 任务转实例完成'."\n" + .'- InstanceTransferFluctuate: 实例数量波动'."\n" + .'- ExhaustedError: 自动重跑后仍出错'."\n" + .'- InstanceKeyword: 出错实例包含关键词'."\n" + .'- InstanceErrorCount: 出错实例数量'."\n" + .'- InstanceErrorPercentage: 出错实例占比 '."\n" + .'- ResourceGroupPercentage: 资源组利用率'."\n" + .'- ResourceGroupWaitCount: 资源组等资源实例数', + 'type' => 'string', + 'example' => 'Error', + ], + 'Extension' => [ + 'description' => '扩展信息，部分触发条件需要配置。', + 'type' => 'object', + 'properties' => [ + 'Error' => [ + 'description' => '出错告警配置。', + 'type' => 'object', + 'properties' => [ + 'StreamTaskIds' => [ + 'description' => '实时计算任务监控时填入对应的任务ID', + 'type' => 'array', + 'items' => [ + 'description' => '实时计算任务ID', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '123', + ], + ], + 'AutoRerunAlertEnabled' => [ + 'description' => '离线任务由于失败自动重跑，是否产生告警。', + 'type' => 'boolean', + 'example' => 'false', + ], + ], + ], + 'Timeout' => [ + 'description' => '超时告警配置', + 'type' => 'object', + 'properties' => [ + 'TimeoutInMinutes' => [ + 'description' => '超时时间，单位为分钟。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + ], + ], + 'UnFinished' => [ + 'description' => '未完成告警配置。', + 'type' => 'object', + 'properties' => [ + 'UnFinishedTime' => [ + 'description' => '未完成时间，格式为 hh:mm，hh的取值范围为[0,47]，mm的取值范围为[0,59]。', + 'type' => 'string', + 'example' => '12:00', + ], + ], + ], + 'CycleUnfinished' => [ + 'description' => '周期未完成告警配置。', + 'type' => 'object', + 'properties' => [ + 'CycleAndTime' => [ + 'description' => '周期和时间配置列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'CycleId' => [ + 'description' => '周期ID，取值范围为[1,288]。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Time' => [ + 'description' => '未完成时间，格式为 hh:mm，hh的取值范围为[0,47]，mm的取值范围为[0,59]。', + 'type' => 'string', + 'example' => '01:00', + ], + ], + ], + ], + ], + ], + 'InstanceErrorCount' => [ + 'description' => '任务实例出错数量告警配置。', + 'type' => 'object', + 'properties' => [ + 'Count' => [ + 'description' => '出错的任务实例数，取值范围为[1,10000]。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + ], + ], + 'InstanceErrorPercentage' => [ + 'description' => '任务实例出错比例告警配置。', + 'type' => 'object', + 'properties' => [ + 'Percentage' => [ + 'description' => '出错实例占比，取值范围 [1-100]。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + ], + ], + 'InstanceTransferFluctuate' => [ + 'description' => '转实例数量波动告警配置。', + 'type' => 'object', + 'properties' => [ + 'Trend' => [ + 'description' => '转实例波动类型，枚举值：'."\n" + .'- abs: 绝对值'."\n" + .'- increase: 增长'."\n" + .'- decrease: 下降', + 'type' => 'string', + 'example' => 'abs', + ], + 'Percentage' => [ + 'description' => '转实例波动百分比，取值范围[1-100]。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + ], + ], + ], + ], + 'Target' => [ + 'description' => '监控对象。', + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'description' => '监控对象类型，枚举值：'."\n" + .'- Task: 任务节点'."\n" + .'- Baseline: 基线'."\n" + .'- Project: 工作空间'."\n" + .'- BizProcess - 业务流程', + 'type' => 'string', + 'example' => 'Task', + ], + 'Ids' => [ + 'description' => '监控对象ID列表。', + 'type' => 'array', + 'items' => [ + 'description' => '监控对象ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '32567', + ], + ], + 'AllowTasks' => [ + 'description' => '监控任务白名单列表。', + 'type' => 'array', + 'items' => [ + 'description' => '监控任务白名单ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '123123', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A6C6B486-E3A2-5D52-9E76-D938048****\\",\\n \\"PagingInfo\\": {\\n \\"TotalCount\\": 5,\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"AlertRules\\": [\\n {\\n \\"Id\\": 22125,\\n \\"Name\\": \\"error_test\\",\\n \\"Owner\\": \\"1933790683****\\",\\n \\"Enabled\\": true,\\n \\"TriggerCondition\\": {\\n \\"Type\\": \\"Error\\",\\n \\"Extension\\": {\\n \\"Error\\": {\\n \\"StreamTaskIds\\": [\\n 123\\n ],\\n \\"AutoRerunAlertEnabled\\": false\\n },\\n \\"Timeout\\": {\\n \\"TimeoutInMinutes\\": 10\\n },\\n \\"UnFinished\\": {\\n \\"UnFinishedTime\\": \\"12:00\\"\\n },\\n \\"CycleUnfinished\\": {\\n \\"CycleAndTime\\": [\\n {\\n \\"CycleId\\": 1,\\n \\"Time\\": \\"01:00\\"\\n }\\n ]\\n },\\n \\"InstanceErrorCount\\": {\\n \\"Count\\": 10\\n },\\n \\"InstanceErrorPercentage\\": {\\n \\"Percentage\\": 10\\n },\\n \\"InstanceTransferFluctuate\\": {\\n \\"Trend\\": \\"abs\\",\\n \\"Percentage\\": 10\\n }\\n },\\n \\"Target\\": {\\n \\"Type\\": \\"Task\\",\\n \\"Ids\\": [\\n 32567\\n ],\\n \\"AllowTasks\\": [\\n 123123\\n ]\\n }\\n }\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => '获取自定义规则列表', + ], + 'GetAlertRule' => [ + 'summary' => '获取自定义监控告警规则。', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '249232', + 'abilityTreeNodes' => [ + 'FEATUREdideRJGWWC', + ], + ], + 'parameters' => [ + [ + 'name' => 'Id', + 'in' => 'query', + 'schema' => [ + 'description' => '自定义告警规则ID。', + 'type' => 'string', + 'required' => false, + 'example' => '28547072', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求的 ID，用于定位日志、排查问题。', + 'type' => 'string', + 'example' => '8abcb91f-d266-4073-b907-2ed****', + ], + 'AlertRule' => [ + 'description' => '自定义规则详情。', + 'type' => 'object', + 'properties' => [ + 'Id' => [ + 'description' => '自定义规则ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '16035', + ], + 'Name' => [ + 'description' => '自定义规则名。', + 'type' => 'string', + 'example' => 'error_rule', + ], + 'Owner' => [ + 'description' => '自定义规则的责任人阿里云UID。', + 'type' => 'string', + 'example' => '279961421580845157', + ], + 'Enabled' => [ + 'description' => '告警规则是否启用。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Notification' => [ + 'description' => '告警通知配置。', + 'type' => 'object', + 'properties' => [ + 'SilenceStartTime' => [ + 'description' => '静默开始时间，格式为 HH:mm:ss 。', + 'type' => 'string', + 'example' => '00:00:00', + ], + 'SilenceEndTime' => [ + 'description' => '静默结束时间，格式为 HH:mm:ss 。', + 'type' => 'string', + 'example' => '00:00:00', + ], + 'IntervalInMinutes' => [ + 'description' => '告警间隔，单位为分钟，取值范围[5,10000]。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '30', + ], + 'Maximum' => [ + 'description' => '一个自然日内的告警最大次数，取值范围[1, 10000]。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '3', + ], + 'Channels' => [ + 'description' => '告警通道列表。', + 'type' => 'array', + 'items' => [ + 'description' => '告警通道，枚举值：'."\n" + .'- Mail: 邮件'."\n" + .'- Phone: 电话'."\n" + .'- Sms: 短信'."\n" + .'- Dingding: 钉钉webhook'."\n" + .'- Feishu: 飞书webhook'."\n" + .'- Weixin: 企业微信webhook'."\n" + .'- Webhook: 自定义Webhook', + 'type' => 'string', + 'example' => 'Sms', + ], + ], + 'Receivers' => [ + 'description' => '告警接收对象。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ReceiverType' => [ + 'description' => '告警接收对象类型，枚举值：'."\n" + .'- AliUid: 阿里云UID'."\n" + .'- ShiftSchedule: 值班表'."\n" + .'- TaskOwner: 任务责任人，适用于自定义告警和事件告警'."\n" + .'- Owner: 责任人，适用于基线告警'."\n" + .'- WebhookUrl: 自定义webhookUrl'."\n" + .'- DingdingUrl: 钉钉webhookUrl'."\n" + .'- FeishuUrl: 飞书webhookUrl'."\n" + .'- WeixinUrl: 企业微信webhookUrl', + 'type' => 'string', + 'example' => 'WebhookUrl', + ], + 'ReceiverValues' => [ + 'description' => '告警接收对象值。', + 'type' => 'array', + 'items' => [ + 'description' => '告警接收对象值。当 ReceiverType 为 AliUid 时填阿里云UID，为 ShiftSchedule 时填值班表ID，为 WebhookUrl / DingdingUrl / FeishuUrl / WeixinUrl 时填入对应的 URL。', + 'type' => 'string', + 'example' => '123123123', + ], + ], + 'Extension' => [ + 'description' => '告警对象需要的额外配置，当 ReceiverType 为 DingdingUrl，支持设置 {"atAll":true} @所有人。', + 'type' => 'string', + 'example' => '{"atAll":true}', + ], + ], + ], + ], + ], + ], + 'TriggerCondition' => [ + 'description' => '触发告警的条件。', + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'description' => '触发报警的类型，枚举值：'."\n" + .'- Finished: 实例完成'."\n" + .'- UnFinished: 实例未完成'."\n" + .'- Error: 实例出错'."\n" + .'- CycleUnfinished: 实例周期未完成'."\n" + .'- Timeout: 实例超时'."\n" + .'- InstanceTransferComplete: 任务转实例完成'."\n" + .'- InstanceTransferFluctuate: 实例数量波动'."\n" + .'- ExhaustedError: 自动重跑后仍出错'."\n" + .'- InstanceKeyword: 出错实例包含关键词'."\n" + .'- InstanceErrorCount: 出错实例数量'."\n" + .'- InstanceErrorPercentage: 出错实例占比 '."\n" + .'- ResourceGroupPercentage: 资源组利用率'."\n" + .'- ResourceGroupWaitCount: 资源组等资源实例数', + 'type' => 'string', + 'example' => 'Error', + ], + 'Extension' => [ + 'description' => '扩展信息，部分触发条件需要配置。', + 'type' => 'object', + 'properties' => [ + 'Error' => [ + 'description' => '出错告警配置。', + 'type' => 'object', + 'properties' => [ + 'StreamTaskIds' => [ + 'description' => '监控实时计算任务时，填入对应的任务ID。', + 'type' => 'array', + 'items' => [ + 'description' => '实时计算任务ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '123123', + ], + ], + 'AutoRerunAlertEnabled' => [ + 'description' => '离线任务由于失败自动重跑，是否产生告警。', + 'type' => 'boolean', + 'example' => 'false', + ], + ], + ], + 'Timeout' => [ + 'description' => '超时告警配置。', + 'type' => 'object', + 'properties' => [ + 'TimeoutInMinutes' => [ + 'description' => '超时时间，单位为分钟。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + ], + ], + 'UnFinished' => [ + 'description' => '未完成告警配置。', + 'type' => 'object', + 'properties' => [ + 'UnFinishedTime' => [ + 'description' => '未完成时间，格式为 hh:mm，hh的取值范围为[0,47]，mm的取值范围为[0,59]。', + 'type' => 'string', + 'example' => '12:00', + ], + ], + ], + 'CycleUnfinished' => [ + 'description' => '周期未完成告警配置。', + 'type' => 'object', + 'properties' => [ + 'CycleAndTime' => [ + 'description' => '周期和时间配置列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'CycleId' => [ + 'description' => '周期ID，取值范围为[1,288]。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Time' => [ + 'description' => '超时时间，格式为 hh:mm，hh的取值范围为[0,47]，mm的取值范围为[0,59]。', + 'type' => 'string', + 'example' => '12:00', + ], + ], + ], + ], + ], + ], + 'InstanceErrorCount' => [ + 'description' => '实例出错数量告警配置。', + 'type' => 'object', + 'properties' => [ + 'Count' => [ + 'description' => '出错的实例数，取值范围为[1,10000]。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + ], + ], + 'InstanceErrorPercentage' => [ + 'description' => '实例出错比例告警配置。', + 'type' => 'object', + 'properties' => [ + 'Percentage' => [ + 'description' => '出错实例占比，取值范围 [1-100]。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + ], + ], + 'InstanceTransferFluctuate' => [ + 'description' => '转实例数量波动告警配置。', + 'type' => 'object', + 'properties' => [ + 'Trend' => [ + 'description' => '转实例波动类型，枚举值：'."\n" + .'- abs: 绝对值'."\n" + .'- increase: 增长'."\n" + .'- decrease: 下降', + 'type' => 'string', + 'example' => '10', + ], + 'Percentage' => [ + 'description' => '转实例波动百分比，取值范围[1-100]。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + ], + ], + ], + ], + 'Target' => [ + 'description' => '监控对象。', + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'description' => '监控对象类型，枚举值：'."\n" + .'- Task: 任务节点'."\n" + .'- Baseline: 基线'."\n" + .'- Project: 工作空间'."\n" + .'- BizProcess - 业务流程', + 'type' => 'string', + 'example' => 'Task', + ], + 'Ids' => [ + 'description' => '监控对象ID列表。', + 'type' => 'array', + 'items' => [ + 'description' => '监控对象ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '32570', + ], + ], + 'AllowTasks' => [ + 'description' => '监控任务白名单列表。', + 'type' => 'array', + 'items' => [ + 'description' => '监控任务白名单ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '123123', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"8abcb91f-d266-4073-b907-2ed****\\",\\n \\"AlertRule\\": {\\n \\"Id\\": 16035,\\n \\"Name\\": \\"error_rule\\",\\n \\"Owner\\": \\"279961421580845157\\",\\n \\"Enabled\\": true,\\n \\"Notification\\": {\\n \\"SilenceStartTime\\": \\"00:00:00\\",\\n \\"SilenceEndTime\\": \\"00:00:00\\",\\n \\"IntervalInMinutes\\": 30,\\n \\"Maximum\\": 3,\\n \\"Channels\\": [\\n \\"Sms\\"\\n ],\\n \\"Receivers\\": [\\n {\\n \\"ReceiverType\\": \\"WebhookUrl\\",\\n \\"ReceiverValues\\": [\\n \\"123123123\\"\\n ],\\n \\"Extension\\": \\"{\\\\\\"atAll\\\\\\":true}\\"\\n }\\n ]\\n },\\n \\"TriggerCondition\\": {\\n \\"Type\\": \\"Error\\",\\n \\"Extension\\": {\\n \\"Error\\": {\\n \\"StreamTaskIds\\": [\\n 123123\\n ],\\n \\"AutoRerunAlertEnabled\\": false\\n },\\n \\"Timeout\\": {\\n \\"TimeoutInMinutes\\": 10\\n },\\n \\"UnFinished\\": {\\n \\"UnFinishedTime\\": \\"12:00\\"\\n },\\n \\"CycleUnfinished\\": {\\n \\"CycleAndTime\\": [\\n {\\n \\"CycleId\\": 1,\\n \\"Time\\": \\"12:00\\"\\n }\\n ]\\n },\\n \\"InstanceErrorCount\\": {\\n \\"Count\\": 10\\n },\\n \\"InstanceErrorPercentage\\": {\\n \\"Percentage\\": 10\\n },\\n \\"InstanceTransferFluctuate\\": {\\n \\"Trend\\": \\"10\\",\\n \\"Percentage\\": 10\\n }\\n },\\n \\"Target\\": {\\n \\"Type\\": \\"Task\\",\\n \\"Ids\\": [\\n 32570\\n ],\\n \\"AllowTasks\\": [\\n 123123\\n ]\\n }\\n }\\n }\\n}","type":"json"}]', + 'title' => '获取自定义监控告警规则', + ], + 'UpdateAlertRule' => [ + 'summary' => '更新自定义监控告警规则。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '249192', + 'abilityTreeNodes' => [ + 'FEATUREdideRJGWWC', + ], + ], + 'parameters' => [ + [ + 'name' => 'Id', + 'in' => 'query', + 'schema' => [ + 'description' => '自定义规则ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '105412', + ], + ], + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => [ + 'description' => '自定义规则名。', + 'type' => 'string', + 'required' => false, + 'example' => 'collection_name', + ], + ], + [ + 'name' => 'Owner', + 'in' => 'query', + 'schema' => [ + 'description' => '自定义规则的责任人阿里云UID。', + 'type' => 'string', + 'required' => false, + 'example' => '193379****', + ], + ], + [ + 'name' => 'Enabled', + 'in' => 'query', + 'schema' => [ + 'description' => '告警规则是否启用。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'TriggerCondition', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '触发告警的条件。', + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'description' => '触发告警的类型，枚举值：'."\n" + ."\n" + .'- Finished: 实例完成'."\n" + .'- UnFinished: 实例未完成'."\n" + .'- Error: 实例出错'."\n" + .'- CycleUnfinished: 实例周期未完成'."\n" + .'- Timeout: 实例超时'."\n" + .'- InstanceTransferComplete: 任务转实例完成'."\n" + .'- InstanceTransferFluctuate: 实例数量波动'."\n" + .'- ExhaustedError: 自动重跑后仍出错'."\n" + .'- InstanceKeyword: 出错实例包含关键词'."\n" + .'- InstanceErrorCount: 出错实例数量'."\n" + .'- InstanceErrorPercentage: 出错实例占比'."\n" + .'- ResourceGroupPercentage: 资源组利用率'."\n" + .'- ResourceGroupWaitCount: 资源组等资源实例数', + 'type' => 'string', + 'required' => false, + 'example' => 'ERROR', + ], + 'Extension' => [ + 'description' => '扩展信息，部分触发条件需要配置。', + 'type' => 'object', + 'properties' => [ + 'Error' => [ + 'description' => '出错告警配置。', + 'type' => 'object', + 'properties' => [ + 'StreamTaskIds' => [ + 'description' => '实时计算任务监控时填入对应的任务ID。', + 'type' => 'array', + 'items' => [ + 'description' => '实时计算任务ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '123123', + ], + 'required' => false, + ], + 'AutoRerunAlertEnabled' => [ + 'description' => '离线任务由于失败自动重跑，是否产生告警。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + 'required' => false, + ], + 'Timeout' => [ + 'description' => '超时告警配置。', + 'type' => 'object', + 'properties' => [ + 'TimeoutInMinutes' => [ + 'description' => '超时时间，单位为分钟。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + ], + ], + 'required' => false, + ], + 'UnFinished' => [ + 'description' => '未完成告警配置。', + 'type' => 'object', + 'properties' => [ + 'UnFinishedTime' => [ + 'description' => '未完成时间，格式为 hh:mm，hh的取值范围为[0,47]，mm的取值范围为[0,59]。', + 'type' => 'string', + 'required' => false, + 'example' => '12:00', + ], + ], + 'required' => false, + ], + 'CycleUnfinished' => [ + 'description' => '周期未完成告警配置。', + 'type' => 'object', + 'properties' => [ + 'CycleAndTime' => [ + 'description' => '周期和时间配置列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'CycleId' => [ + 'description' => '周期ID，取值范围为[1,288]。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + 'Time' => [ + 'description' => '未完成时间，格式为 hh:mm，hh的取值范围为[0,47]，mm的取值范围为[0,59]。', + 'type' => 'string', + 'required' => false, + 'example' => '01:00'."\n", + ], + ], + 'required' => false, + ], + 'required' => false, + ], + ], + 'required' => false, + ], + 'InstanceErrorCount' => [ + 'description' => '任务实例出错数量告警配置。', + 'type' => 'object', + 'properties' => [ + 'Count' => [ + 'description' => '出错的任务实例数，取值范围为[1,10000]。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + ], + ], + 'required' => false, + ], + 'InstanceErrorPercentage' => [ + 'description' => '任务实例出错比例告警配置。', + 'type' => 'object', + 'properties' => [ + 'Percentage' => [ + 'description' => '出错实例占比，取值范围 [1-100]。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + ], + ], + 'required' => false, + ], + 'InstanceTransferFluctuate' => [ + 'description' => '转实例数量波动告警配置。', + 'type' => 'object', + 'properties' => [ + 'Trend' => [ + 'description' => '转实例波动类型，枚举值：'."\n" + ."\n" + .'- abs: 绝对值'."\n" + .'- increase: 增长'."\n" + .'- decrease: 下降', + 'type' => 'string', + 'required' => false, + 'example' => 'abs', + ], + 'Percentage' => [ + 'description' => '转实例波动百分比，取值范围[1-100]。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + ], + ], + 'required' => false, + ], + ], + 'required' => false, + ], + 'Target' => [ + 'description' => '监控对象。', + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'description' => '监控对象类型，枚举值：'."\n" + ."\n" + .'- Task: 任务节点'."\n" + .'- Baseline: 基线'."\n" + .'- Project: 工作空间'."\n" + .'- BizProcess: 业务流程', + 'type' => 'string', + 'required' => false, + 'example' => 'Task', + ], + 'Ids' => [ + 'description' => '监控对象ID列表。', + 'type' => 'array', + 'items' => [ + 'description' => '监控对象ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1894580', + ], + 'required' => false, + ], + 'AllowTasks' => [ + 'description' => '监控任务白名单列表。', + 'type' => 'array', + 'items' => [ + 'description' => '监控任务白名单ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1111', + ], + 'required' => false, + ], + ], + 'required' => false, + ], + ], + 'required' => false, + ], + ], + [ + 'name' => 'Notification', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '告警通知配置。', + 'type' => 'object', + 'properties' => [ + 'SilenceStartTime' => [ + 'description' => '静默开始时间，格式为 HH:mm:ss 。', + 'type' => 'string', + 'required' => false, + 'example' => '00:00:00'."\n", + ], + 'SilenceEndTime' => [ + 'description' => '静默结束时间，格式为 HH:mm:ss 。', + 'type' => 'string', + 'required' => false, + 'example' => '00:00:00'."\n", + ], + 'IntervalInMinutes' => [ + 'description' => '告警间隔，单位为分钟，取值范围[5,10000]。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '30', + ], + 'Maximum' => [ + 'description' => '一个自然日内的告警最大次数，取值范围[1, 10000]。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '3', + ], + 'Channels' => [ + 'description' => '告警通道列表。', + 'type' => 'array', + 'items' => [ + 'description' => '告警通道，枚举值：'."\n" + ."\n" + .'- Mail: 邮件'."\n" + .'- Phone: 电话'."\n" + .'- Sms: 短信'."\n" + .'- Dingding: 钉钉webhook'."\n" + .'- Feishu: 飞书webhook'."\n" + .'- Weixin: 企业微信webhook'."\n" + .'- Webhook: 自定义Webhook', + 'type' => 'string', + 'required' => false, + 'example' => 'Sms', + ], + 'required' => false, + ], + 'Receivers' => [ + 'description' => '告警接收对象。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ReceiverType' => [ + 'description' => '告警接收对象类型，枚举值：'."\n" + ."\n" + .'- AliUid: 阿里云UID'."\n" + .'- ShiftSchedule: 值班表'."\n" + .'- TaskOwner: 任务责任人，适用于自定义告警和事件告警'."\n" + .'- Owner: 责任人，适用于基线告警'."\n" + .'- WebhookUrl: 自定义webhookUrl'."\n" + .'- DingdingUrl: 钉钉webhookUrl'."\n" + .'- FeishuUrl: 飞书webhookUrl'."\n" + .'- WeixinUrl: 企业微信webhookUrl', + 'type' => 'string', + 'required' => false, + 'example' => 'TaskOwner', + ], + 'ReceiverValues' => [ + 'description' => '告警接收对象值。', + 'type' => 'array', + 'items' => [ + 'description' => '告警接收对象值。当 ReceiverType 为 AliUid 时填阿里云UID，为 ShiftSchedule 时填值班表ID，为 WebhookUrl / DingdingUrl / FeishuUrl / WeixinUrl 时填入对应的 URL。', + 'type' => 'string', + 'required' => false, + 'example' => '123123', + ], + 'required' => false, + ], + 'Extension' => [ + 'description' => '告警对象需要的额外配置，当 ReceiverType 为 DingdingUrl，支持设置 {"atAll":true} @所有人。', + 'type' => 'string', + 'required' => false, + 'example' => '{"atAll":true}'."\n", + ], + ], + 'required' => false, + ], + 'required' => false, + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求的ID。用于定位日志，排查问题。'."\n" + ."\n", + 'type' => 'string', + 'example' => 'D85FEE2B-6174-5817-AF9E-FDD02FEDA5BC', + ], + 'Success' => [ + 'description' => '调用是否成功。'."\n" + ."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D85FEE2B-6174-5817-AF9E-FDD02FEDA5BC\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => '更新自定义监控告警规则', + ], + 'DeleteAlertRule' => [ + 'summary' => '删除自定义监控报警规则。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'abilityTreeCode' => '249142', + 'abilityTreeNodes' => [ + 'FEATUREdideRJGWWC', + ], + ], + 'parameters' => [ + [ + 'name' => 'Id', + 'in' => 'formData', + 'schema' => [ + 'description' => '自定义规则的ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '105412', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求的 ID，用于定位日志，排查问题。', + 'type' => 'string', + 'example' => '8754EE08-4AA2-5F77-ADD7-754DBBDA9F75', + ], + 'Success' => [ + 'description' => '操作是否成功。', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"8754EE08-4AA2-5F77-ADD7-754DBBDA9F75\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => '删除自定义规则', + ], + 'CreateAlertRule' => [ + 'summary' => '创建自定义监控告警规则。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'abilityTreeCode' => '249177', + 'abilityTreeNodes' => [ + 'FEATUREdideRJGWWC', + ], + ], + 'parameters' => [ + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => [ + 'description' => '自定义规则名。', + 'type' => 'string', + 'required' => true, + 'example' => 'xm_create_test', + ], + ], + [ + 'name' => 'Owner', + 'in' => 'query', + 'schema' => [ + 'description' => '自定义规则的责任人阿里云UID。', + 'type' => 'string', + 'required' => true, + 'example' => '279114181****', + ], + ], + [ + 'name' => 'Enabled', + 'in' => 'query', + 'schema' => [ + 'description' => '告警规则是否启用。', + 'type' => 'boolean', + 'required' => true, + 'example' => 'true', + ], + ], + [ + 'name' => 'TriggerCondition', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '触发告警的条件。', + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'description' => '触发报警的类型，枚举值：'."\n" + .'- Finished: 实例完成'."\n" + .'- UnFinished: 实例未完成'."\n" + .'- Error: 实例出错'."\n" + .'- CycleUnfinished: 实例周期未完成'."\n" + .'- Timeout: 实例超时'."\n" + .'- InstanceTransferComplete: 任务转实例完成'."\n" + .'- InstanceTransferFluctuate: 实例数量波动'."\n" + .'- ExhaustedError: 自动重跑后仍出错'."\n" + .'- InstanceKeyword: 出错实例包含关键词'."\n" + .'- InstanceErrorCount: 出错实例数量'."\n" + .'- InstanceErrorPercentage: 出错实例占比'."\n" + .'- ResourceGroupPercentage: 资源组利用率'."\n" + .'- ResourceGroupWaitCount: 资源组等资源实例数', + 'type' => 'string', + 'required' => false, + 'example' => 'Error', + ], + 'Extension' => [ + 'description' => '扩展信息，部分触发条件需要配置。', + 'type' => 'object', + 'properties' => [ + 'Error' => [ + 'description' => '出错告警配置。', + 'type' => 'object', + 'properties' => [ + 'StreamTaskIds' => [ + 'description' => '监控实时计算任务时，填入对应的任务ID。', + 'type' => 'array', + 'items' => [ + 'description' => '实时计算任务ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '123', + ], + 'required' => false, + ], + 'AutoRerunAlertEnabled' => [ + 'description' => '离线任务由于失败自动重跑，是否产生告警。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + 'required' => false, + ], + 'Timeout' => [ + 'description' => '超时告警配置。', + 'type' => 'object', + 'properties' => [ + 'TimeoutInMinutes' => [ + 'description' => '超时时间，单位为分钟，取值范围[1, 21600]。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + ], + ], + 'required' => false, + ], + 'UnFinished' => [ + 'description' => '未完成告警配置。', + 'type' => 'object', + 'properties' => [ + 'UnFinishedTime' => [ + 'description' => '未完成时间，格式为 hh:mm，hh的取值范围为[0,47]，mm的取值范围为[0,59]。', + 'type' => 'string', + 'required' => false, + 'example' => '30:00', + ], + ], + 'required' => false, + ], + 'CycleUnfinished' => [ + 'description' => '周期未完成告警配置。', + 'type' => 'object', + 'properties' => [ + 'CycleAndTime' => [ + 'description' => '周期和时间配置列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'CycleId' => [ + 'description' => '周期ID，取值范围为[1,288]。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + 'Time' => [ + 'description' => '超时时间，格式为 hh:mm，hh的取值范围为[0,47]，mm的取值范围为[0,59]。', + 'type' => 'string', + 'required' => false, + 'example' => '12:00', + ], + ], + 'required' => false, + ], + 'required' => false, + ], + ], + 'required' => false, + ], + 'InstanceErrorCount' => [ + 'description' => '实例出错数量告警配置。', + 'type' => 'object', + 'properties' => [ + 'Count' => [ + 'description' => '出错的实例数，取值范围为[1,10000]。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '5', + ], + ], + 'required' => false, + ], + 'InstanceErrorPercentage' => [ + 'description' => '实例出错比例告警配置。', + 'type' => 'object', + 'properties' => [ + 'Percentage' => [ + 'description' => '出错实例百分比，取值范围 [1-100]。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '5', + ], + ], + 'required' => false, + ], + 'InstanceTransferFluctuate' => [ + 'description' => '转实例数量波动告警配置。', + 'type' => 'object', + 'properties' => [ + 'Trend' => [ + 'description' => '转实例波动类型，枚举值：'."\n" + .'- abs: 绝对值'."\n" + .'- increase: 增长'."\n" + .'- decrease: 下降', + 'type' => 'string', + 'required' => false, + 'example' => 'abs', + ], + 'Percentage' => [ + 'description' => '转实例波动百分比，取值范围[1-100]。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + ], + ], + 'required' => false, + ], + ], + 'required' => false, + ], + 'Target' => [ + 'description' => '监控对象。', + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'description' => '监控对象类型，枚举值：'."\n" + .'- Task: 任务节点'."\n" + .'- Baseline: 基线'."\n" + .'- Project: 工作空间'."\n" + .'- BizProcess - 业务流程', + 'type' => 'string', + 'required' => false, + 'example' => 'Task', + ], + 'Ids' => [ + 'description' => '监控对象ID列表。', + 'type' => 'array', + 'items' => [ + 'description' => '监控对象ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '123123', + ], + 'required' => false, + ], + 'AllowTasks' => [ + 'description' => '监控任务白名单列表。', + 'type' => 'array', + 'items' => [ + 'description' => '监控任务白名单ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '123', + ], + 'required' => false, + ], + ], + 'required' => false, + ], + ], + 'required' => true, + ], + ], + [ + 'name' => 'Notification', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '告警通知配置。', + 'type' => 'object', + 'properties' => [ + 'SilenceStartTime' => [ + 'description' => '静默告警开始时间，格式为 HH:mm。', + 'type' => 'string', + 'required' => false, + 'example' => '00:00'."\n", + ], + 'SilenceEndTime' => [ + 'description' => '静默告警结束时间，格式为 HH:mm', + 'type' => 'string', + 'required' => false, + 'example' => '00:00'."\n", + ], + 'IntervalInMinutes' => [ + 'description' => '告警间隔，单位为分钟，取值范围[5,10000]。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '30', + ], + 'Maximum' => [ + 'description' => '一个自然日内的告警最大次数，取值范围[1, 10000]。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '3', + ], + 'Channels' => [ + 'description' => '告警通道列表。', + 'type' => 'array', + 'items' => [ + 'description' => '告警通道，枚举值：'."\n" + .'- Mail: 邮件'."\n" + .'- Phone: 电话'."\n" + .'- Sms: 短信'."\n" + .'- Dingding: 钉钉webhook'."\n" + .'- Feishu: 飞书webhook'."\n" + .'- Weixin: 企业微信webhook'."\n" + .'- Webhook: 自定义Webhook', + 'type' => 'string', + 'required' => false, + 'example' => 'Sms', + ], + 'required' => true, + ], + 'Receivers' => [ + 'description' => '告警接收对象。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ReceiverType' => [ + 'description' => '告警接收对象类型，枚举值：'."\n" + .'- AliUid: 阿里云UID'."\n" + .'- ShiftSchedule: 值班表'."\n" + .'- TaskOwner: 任务责任人，适用于自定义告警和事件告警'."\n" + .'- Owner: 责任人，适用于基线告警'."\n" + .'- WebhookUrl: 自定义webhookUrl'."\n" + .'- DingdingUrl: 钉钉webhookUrl'."\n" + .'- FeishuUrl: 飞书webhookUrl'."\n" + .'- WeixinUrl: 企业微信webhookUrl', + 'type' => 'string', + 'required' => false, + 'example' => 'TaskOwner', + ], + 'ReceiverValues' => [ + 'description' => '告警接收对象值。', + 'type' => 'array', + 'items' => [ + 'description' => '告警接收对象值。当 ReceiverType 为 AliUid 时填阿里云UID，为 ShiftSchedule 时填值班表ID，为 WebhookUrl / DingdingUrl / FeishuUrl / WeixinUrl 时填入对应的 URL。', + 'type' => 'string', + 'required' => false, + 'example' => '123123123', + ], + 'required' => false, + ], + 'Extension' => [ + 'description' => '告警对象需要的额外配置，当 ReceiverType 为 DingdingUrl，支持设置 {"atAll":true} @所有人。', + 'type' => 'string', + 'required' => false, + 'example' => '{"atAll":true}'."\n", + ], + ], + 'required' => false, + ], + 'required' => true, + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求的 ID，用于定位日志，排查问题。', + 'type' => 'string', + 'example' => 'A6C6B486-E3A2-5D52-9E76-D9380485D946'."\n", + ], + 'Id' => [ + 'description' => '自定义规则。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '123123', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A6C6B486-E3A2-5D52-9E76-D9380485D946\\\\n\\",\\n \\"Id\\": 123123\\n}","type":"json"}]', + 'title' => '创建自定义监控告警规则', + ], + 'DeleteTask' => [ + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'abilityTreeCode' => '247745', + 'abilityTreeNodes' => [ + 'FEATUREdide7WF1GB', + ], + ], + 'parameters' => [ + [ + 'name' => 'Id', + 'in' => 'query', + 'schema' => [ + 'description' => '任务ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1234', + ], + ], + [ + 'name' => 'ProjectEnv', + 'in' => 'query', + 'schema' => [ + 'description' => '项目环境。', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'Prod' => '生产', + 'Dev' => '开发', + ], + 'example' => 'Prod', + 'default' => 'Prod', + 'enum' => [ + 'Prod', + 'Dev', + ], + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求的ID，用于定位日志，排查问题。', + 'type' => 'string', + 'example' => '22C97E95-F023-56B5-8852-B1A77A17XXXX'."\n", + ], + 'Success' => [ + 'description' => '操作是否成功。', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"22C97E95-F023-56B5-8852-B1A77A17XXXX\\\\n\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => '删除任务', + 'summary' => '删除指定的任务。', + 'description' => '需要购买DataWorks基础版及以上版本才能使用。', + ], + 'UpdateTask' => [ + 'summary' => '更新指定任务。修改的内容会同步到数据开发，数据开发将新增一个保存版本。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '247744', + 'abilityTreeNodes' => [ + 'FEATUREdide7WF1GB', + 'FEATUREdideD0YY7B', + 'FEATUREdideVFMENL', + ], + ], + 'parameters' => [ + [ + 'name' => 'Id', + 'in' => 'formData', + 'schema' => [ + 'description' => '任务ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1234', + ], + ], + [ + 'name' => 'ClientUniqueCode', + 'in' => 'formData', + 'schema' => [ + 'description' => '任务的客户端唯一码，用来唯一标识一个任务。用于实现异步和幂等，创建时如果不指定，系统将自动生成，该代码将与资源ID进行唯一绑定。更新、删除资源时如果指定该参数，应与创建时的客户端唯一码保持统一。', + 'type' => 'string', + 'required' => false, + 'example' => 'Task_0bc5213917368545132902xxxxxxxx', + ], + ], + [ + 'name' => 'EnvType', + 'in' => 'formData', + 'schema' => [ + 'description' => '项目环境。'."\n" + .'- Prod：生产'."\n" + .'- Dev：开发', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [], + 'example' => 'Prod', + 'default' => 'Prod', + 'enum' => [ + 'Prod', + 'Dev', + ], + ], + ], + [ + 'name' => 'Name', + 'in' => 'formData', + 'schema' => [ + 'description' => '名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'SQL node', + ], + ], + [ + 'name' => 'Description', + 'in' => 'formData', + 'schema' => [ + 'description' => '描述信息。', + 'type' => 'string', + 'required' => false, + 'example' => 'test', + ], + ], + [ + 'name' => 'Owner', + 'in' => 'formData', + 'schema' => [ + 'description' => '任务的责任人的账号ID。', + 'type' => 'string', + 'required' => false, + 'example' => '1000', + ], + ], + [ + 'name' => 'InstanceMode', + 'in' => 'formData', + 'schema' => [ + 'description' => '实例生成模式。'."\n" + .'- T+1（第二天生成）'."\n" + .'- Immediately（立即生成）。注意：节点定时时间在节点发布时间点十分钟后的周期实例才会正常生成。全量转实例期间（23:30~24:00点期间）不能进行实时转实例，可以提交发布节点，但新增节点不会自动转出实例。', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [], + 'example' => 'T+1', + 'default' => 'T+1', + 'enum' => [ + 'T+1', + 'Immediately', + ], + ], + ], + [ + 'name' => 'Timeout', + 'in' => 'formData', + 'schema' => [ + 'description' => '任务执行超时时间，单位秒。取值应大于3600。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '3600', + ], + ], + [ + 'name' => 'RerunMode', + 'in' => 'formData', + 'schema' => [ + 'description' => '任务是否允许重跑的配置。'."\n" + .'- AllDenied：失败或成功都不可重跑'."\n" + .'- FailureAllowed：只有失败可重跑'."\n" + .'- AllAllowed：失败或成功均可重跑', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [], + 'example' => 'AllAllowed', + 'enum' => [ + 'AllAllowed', + 'FailureAllowed', + 'AllDenied', + ], + ], + ], + [ + 'name' => 'RerunTimes', + 'in' => 'formData', + 'schema' => [ + 'description' => '重试次数，当任务设置为可重跑时生效。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '3', + ], + ], + [ + 'name' => 'RerunInterval', + 'in' => 'formData', + 'schema' => [ + 'description' => '重试时间间隔，单位毫秒。（不得超过1800000）', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '60000', + ], + ], + [ + 'name' => 'Script', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'description' => '运行脚本信息。', + 'type' => 'object', + 'properties' => [ + 'Content' => [ + 'description' => '脚本内容。', + 'type' => 'string', + 'deprecated' => true, + 'required' => false, + 'example' => 'echo "helloWorld"', + ], + 'Parameters' => [ + 'description' => '脚本参数列表。', + 'type' => 'string', + 'required' => false, + 'example' => 'para1=$bizdate', + ], + ], + 'required' => false, + ], + ], + [ + 'name' => 'Trigger', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'description' => '任务触发方式。', + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'title' => '`Scheduler` 周期触发', + 'description' => '触发方式类型。'."\n" + .'- Scheduler：调度周期触发'."\n" + .'- Manual：手动触发', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [], + 'example' => 'Scheduler', + 'enum' => [ + 'Scheduler', + 'Manual', + ], + ], + 'Recurrence' => [ + 'description' => '触发时的运行模式，type=Scheduler时生效。'."\n" + .'- Pause：暂停'."\n" + .'- Skip：空跑'."\n" + .'- Normal：正常运行', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [], + 'example' => 'Normal', + 'enum' => [ + 'Normal', + 'Skip', + 'Pause', + ], + ], + 'Cron' => [ + 'description' => 'Cron表达式，type=Scheduler时生效。', + 'type' => 'string', + 'required' => false, + 'example' => '00 00 00 * * ?', + ], + 'StartTime' => [ + 'description' => '周期触发生效时间，type=Scheduler时生效。格式为`yyyy-mm-dd hh:mm:ss`', + 'type' => 'string', + 'required' => false, + 'example' => '1970-01-01 00:00:00', + ], + 'EndTime' => [ + 'description' => '周期触发失效时间，type=Scheduler时生效。格式为`yyyy-mm-dd hh:mm:ss`', + 'type' => 'string', + 'required' => false, + 'example' => '9999-01-01 00:00:00', + ], + 'CycleType' => [ + 'description' => '周期类型，Type=Scheduler 且 Cron表达式为指定某小时定时调度时生效。默认为Daily。'."\n" + .'- Daily：指定为天调度'."\n" + .'- NotDaily：指定为小时调度', + 'type' => 'string', + 'required' => false, + 'example' => 'Daily', + 'enum' => [ + 'Daily', + 'NotDaily', + ], + ], + ], + 'required' => false, + ], + ], + [ + 'name' => 'RuntimeResource', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'description' => '运行环境配置，如资源组信息。', + 'type' => 'object', + 'properties' => [ + 'ResourceGroupId' => [ + 'description' => '任务运行配置的调度资源组标识符。', + 'type' => 'string', + 'required' => false, + 'example' => 'S_res_group_524258031846018_1684XXXXXXXXX', + ], + 'Image' => [ + 'description' => '任务运行配置的镜像ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'i-xxxxxx', + ], + 'Cu' => [ + 'description' => '任务运行配置CU消耗。', + 'type' => 'string', + 'required' => false, + 'example' => '0.25', + ], + ], + 'required' => false, + ], + ], + [ + 'name' => 'DataSource', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'description' => '关联数据源信息。', + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'description' => '数据源名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'odps_test', + ], + ], + 'required' => false, + ], + ], + [ + 'name' => 'Inputs', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'description' => '输入信息。', + 'type' => 'object', + 'properties' => [ + 'Variables' => [ + 'description' => '变量定义列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'title' => '类型', + 'description' => '类型。'."\n" + .'- Constant：常量'."\n" + .'- PassThrough：参数节点输出'."\n" + .'- System：变量'."\n" + .'- NodeOutput：脚本输出', + 'type' => 'string', + 'required' => true, + 'enumValueTitles' => [], + 'example' => 'Constant', + 'enum' => [ + 'System', + 'Constant', + 'NodeOutput', + 'PassThrough', + ], + ], + 'Value' => [ + 'description' => '变量值。', + 'type' => 'string', + 'required' => false, + 'example' => 'value1', + ], + 'Name' => [ + 'description' => '变量名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'key1', + ], + ], + 'required' => false, + ], + 'required' => false, + ], + ], + 'required' => false, + ], + ], + [ + 'name' => 'Outputs', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'description' => '输出信息。', + 'type' => 'object', + 'properties' => [ + 'TaskOutputs' => [ + 'description' => '任务输出定义列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Output' => [ + 'title' => '输出标识符，示例：pre.odps_sql_demo_0', + 'description' => '输出标识符。', + 'type' => 'string', + 'required' => false, + 'example' => 'pre.odps_sql_demo_0', + ], + ], + 'required' => false, + ], + 'required' => false, + ], + 'Variables' => [ + 'description' => '变量定义列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'title' => '类型', + 'description' => '类型。'."\n" + .'- Constant：常量'."\n" + .'- PassThrough：参数节点输出'."\n" + .'- System：变量'."\n" + .'- NodeOutput：脚本输出', + 'type' => 'string', + 'required' => true, + 'enumValueTitles' => [], + 'example' => 'Constant', + 'enum' => [ + 'System', + 'Constant', + 'NodeOutput', + 'PassThrough', + ], + ], + 'Value' => [ + 'description' => '变量值。', + 'type' => 'string', + 'required' => false, + 'example' => 'value1', + ], + 'Name' => [ + 'description' => '变量名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'key1', + ], + ], + 'required' => false, + ], + 'required' => false, + ], + ], + 'required' => false, + ], + ], + [ + 'name' => 'Dependencies', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'description' => '依赖信息。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'title' => '依赖类型', + 'description' => '依赖类型。'."\n" + .'- CrossCycleDependsOnChildren：跨周期依赖一级子节点'."\n" + .'- CrossCycleDependsOnSelf：跨周期依赖自己'."\n" + .'- CrossCycleDependsOnOtherNode：跨周期依赖其他节点'."\n" + .'- Normal：同周期依赖', + 'type' => 'string', + 'required' => true, + 'enumValueTitles' => [], + 'example' => 'Normal', + 'enum' => [ + 'Normal', + 'CrossCycleDependsOnSelf', + 'CrossCycleDependsOnChildren', + 'CrossCycleDependsOnOtherNode', + ], + ], + 'UpstreamOutput' => [ + 'title' => '依赖任务的输出标识符,或者任务ID', + 'description' => '上游任务的输出标识符。（`同周期依赖`且设置input内容时，返回此字段）', + 'type' => 'string', + 'required' => false, + 'example' => 'pre.odps_sql_demo_0', + ], + 'UpstreamTaskId' => [ + 'description' => '上游任务的Id。（`跨周期依赖其他节点`与`同周期依赖`未设置input内容时，返回此字段，其他情况不返回）', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1234', + ], + ], + 'required' => false, + ], + 'required' => false, + ], + ], + [ + 'name' => 'Tags', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'description' => '任务标签列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Value' => [ + 'description' => '标签值。', + 'type' => 'string', + 'required' => false, + 'example' => 'value1', + ], + 'Key' => [ + 'description' => '标签键。', + 'type' => 'string', + 'required' => true, + 'example' => 'key1', + ], + ], + 'required' => false, + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求的ID，用于定位日志，排查问题。', + 'type' => 'string', + 'example' => '22C97E95-F023-56B5-8852-B1A77A17XXXX', + ], + 'Success' => [ + 'description' => '操作是否成功。', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"22C97E95-F023-56B5-8852-B1A77A17XXXX\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => '更新任务', + ], + 'BatchUpdateTasks' => [ + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '250636', + 'abilityTreeNodes' => [ + 'FEATUREdide7WF1GB', + 'FEATUREdideD0YY7B', + 'FEATUREdideVFMENL', + ], + ], + 'parameters' => [ + [ + 'name' => 'Tasks', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'description' => '任务列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Id' => [ + 'description' => '任务ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1234', + ], + 'EnvType' => [ + 'description' => '项目环境。'."\n" + .'- Prod：生产'."\n" + .'- Dev：开发', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [], + 'example' => 'Prod', + 'default' => 'Prod', + 'enum' => [ + 'Prod', + 'Dev', + ], + ], + 'Name' => [ + 'description' => '名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'SQL node', + ], + 'Description' => [ + 'description' => '描述信息。', + 'type' => 'string', + 'required' => false, + 'example' => 'test', + ], + 'Owner' => [ + 'description' => '任务的责任人的账号ID。', + 'type' => 'string', + 'required' => false, + 'example' => '1000', + ], + 'Timeout' => [ + 'description' => '任务执行超时时间，单位秒。取值应大于3600。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '3600', + ], + 'RerunMode' => [ + 'description' => '任务是否允许重跑的配置。'."\n" + .'- AllDenied：失败或成功都不可重跑'."\n" + .'- FailureAllowed：只有失败可重跑'."\n" + .'- AllAllowed：失败或成功均可重跑', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [], + 'example' => 'AllAllowed', + 'enum' => [ + 'AllAllowed', + 'FailureAllowed', + 'AllDenied', + ], + ], + 'RerunTimes' => [ + 'description' => '重试次数，当任务设置为可重跑时生效。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '3', + ], + 'RerunInterval' => [ + 'description' => '重试时间间隔，单位秒。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '60', + ], + 'Trigger' => [ + 'description' => '任务触发方式。', + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'description' => '触发方式类型。'."\n" + .'- Scheduler：调度周期触发'."\n" + .'- Manual：手动触发', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [], + 'example' => 'Scheduler', + 'enum' => [ + 'Scheduler', + 'Manual', + ], + ], + 'Recurrence' => [ + 'description' => '触发时的运行模式，type=Scheduler时生效。'."\n" + .'- Pause：暂停'."\n" + .'- Skip：空跑'."\n" + .'- Normal：正常运行', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [], + 'example' => 'Normal', + 'enum' => [ + 'Normal', + 'Skip', + 'Pause', + ], + ], + 'Cron' => [ + 'description' => 'Cron表达式，type=Scheduler时生效。', + 'type' => 'string', + 'required' => false, + 'example' => '00 00 00 * * ?', + ], + 'StartTime' => [ + 'description' => '周期触发生效时间，type=Scheduler时生效。格式为`yyyy-mm-dd hh:mm:ss`', + 'type' => 'string', + 'required' => false, + 'example' => '1970-01-01 00:00:00', + ], + 'EndTime' => [ + 'description' => '周期触发失效时间，type=Scheduler时生效。格式为`yyyy-mm-dd hh:mm:ss`', + 'type' => 'string', + 'required' => false, + 'example' => '9999-01-01 00:00:00', + ], + ], + 'required' => false, + ], + 'RuntimeResource' => [ + 'description' => '运行环境配置，如资源组信息。', + 'type' => 'object', + 'properties' => [ + 'ResourceGroupId' => [ + 'description' => '任务运行配置的调度资源组标识符。', + 'type' => 'string', + 'required' => false, + 'example' => 'S_res_group_524258031846018_1684XXXXXXXXX', + ], + 'Image' => [ + 'description' => '任务运行配置的镜像ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'i-xxxxxx', + ], + 'Cu' => [ + 'description' => '任务运行配置CU消耗。', + 'type' => 'string', + 'required' => false, + 'example' => '0.25', + ], + ], + 'required' => false, + ], + 'DataSource' => [ + 'description' => '关联数据源信息。', + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'description' => '数据源名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'odps_test', + ], + ], + 'required' => false, + ], + 'Tags' => [ + 'description' => '任务标签列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => '标签键。', + 'type' => 'string', + 'required' => true, + 'example' => 'key1', + ], + 'Value' => [ + 'description' => '标签值。', + 'type' => 'string', + 'required' => false, + 'example' => 'value1', + ], + ], + 'required' => false, + ], + 'required' => false, + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 50, + ], + ], + [ + 'name' => 'Comment', + 'in' => 'formData', + 'schema' => [ + 'description' => '备注信息。', + 'type' => 'string', + 'required' => false, + 'example' => 'this is a comment'."\n", + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求的ID。用于定位日志，排查问题。', + 'type' => 'string', + 'example' => '22C97E95-F023-56B5-8852-B1A77A17XXXX', + ], + 'SuccessInfo' => [ + 'description' => '批量操作的结果信息。结构为Map，以任务ID为键，以结果信息为Value。', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'object', + 'properties' => [ + 'Success' => [ + 'type' => 'boolean', + 'description' => '操作是否成功。', + 'example' => 'true', + ], + 'Message' => [ + 'type' => 'string', + 'example' => 'The task does not exist.', + 'description' => '错误信息。', + ], + ], + 'description' => '结果信息。', + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"22C97E95-F023-56B5-8852-B1A77A17XXXX\\",\\n \\"SuccessInfo\\": {\\n \\"key\\": {\\n \\"Success\\": true,\\n \\"Message\\": \\"The task does not exist.\\"\\n }\\n }\\n}","type":"json"}]', + 'title' => '批量更新任务', + 'summary' => '以增量更新的方式，批量更新多个任务。', + 'description' => '需要购买DataWorks基础版及以上版本才能使用。', + ], + 'GetTask' => [ + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '221964', + 'abilityTreeNodes' => [ + 'FEATUREdide7WF1GB', + 'FEATUREdideD0YY7B', + 'FEATUREdideVFMENL', + ], + ], + 'parameters' => [ + [ + 'name' => 'Id', + 'in' => 'query', + 'schema' => [ + 'description' => '任务的唯一标识符。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1234', + ], + ], + [ + 'name' => 'ProjectEnv', + 'in' => 'query', + 'schema' => [ + 'description' => '项目环境。'."\n" + .'- Prod：生产'."\n" + .'- Dev：开发', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [], + 'example' => 'Prod', + 'default' => 'Prod', + 'enum' => [ + 'Prod', + 'Dev', + ], + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求的ID，用于定位日志，排查问题。', + 'type' => 'string', + 'example' => '22C97E95-F023-56B5-8852-B1A77A17XXXX', + ], + 'Task' => [ + 'description' => '任务的详细信息。', + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'description' => '名称。', + 'type' => 'string', + 'example' => 'SQL node', + ], + 'Description' => [ + 'description' => '描述信息。', + 'type' => 'string', + 'example' => 'test', + ], + 'WorkflowId' => [ + 'description' => '工作流ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1234', + ], + 'InstanceMode' => [ + 'description' => '实例生成模式。'."\n" + ."\n" + .'- T+1（第二天生成）'."\n" + .'- Immediately（立即生成）', + 'type' => 'string', + 'example' => 'T+1', + ], + 'Type' => [ + 'title' => '任务类型', + 'description' => '任务类型。', + 'type' => 'string', + 'example' => 'ODPS_SQL', + ], + 'BaselineId' => [ + 'title' => '基线ID', + 'description' => '基线ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1234', + ], + 'Priority' => [ + 'title' => '任务优先级，最大值8，最小值1', + 'description' => '任务优先级，最小值1，最大值8。取值越大，优先级越高。默认优先级为1。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Timeout' => [ + 'title' => '任务执行超时时间，单位秒', + 'description' => '任务执行超时时间，单位秒。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '3600', + ], + 'RerunMode' => [ + 'title' => '任务是否允许重跑的配置', + 'description' => '任务是否允许重跑的配置。'."\n" + .'- AllDenied：失败或成功都不可重跑'."\n" + .'- FailureAllowed：只有失败可重跑'."\n" + .'- AllAllowed：失败或成功均可重跑', + 'type' => 'string', + 'enumValueTitles' => [], + 'example' => 'AllAllowed', + ], + 'RerunTimes' => [ + 'title' => '重试次数', + 'description' => '重试次数，当任务设置为可重跑时生效。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '3', + ], + 'RerunInterval' => [ + 'title' => '重试时间间隔，单位秒', + 'description' => '重试时间间隔，单位秒。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '60', + ], + 'Script' => [ + 'title' => '运行脚本信息', + 'description' => '运行脚本信息。', + 'type' => 'object', + 'properties' => [ + 'Content' => [ + 'description' => '脚本内容。', + 'type' => 'string', + 'example' => 'echo "helloWorld"', + ], + 'Parameters' => [ + 'description' => '脚本参数列表。', + 'type' => 'string', + 'example' => 'para1=$bizdate', + ], + ], + ], + 'Trigger' => [ + 'title' => '任务触发方式', + 'description' => '任务触发方式。', + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'description' => '触发方式类型。'."\n" + .'- Scheduler：调度周期触发'."\n" + .'- Manual：手动触发', + 'type' => 'string', + 'enumValueTitles' => [], + 'example' => 'Scheduler', + ], + 'Recurrence' => [ + 'description' => '触发时的运行模式，type=Scheduler时生效。'."\n" + .'- Pause：暂停'."\n" + .'- Skip：空跑'."\n" + .'- Normal：正常运行', + 'type' => 'string', + 'enumValueTitles' => [], + 'example' => 'Normal', + ], + 'Cron' => [ + 'description' => 'Cron表达式，type=Scheduler时生效。', + 'type' => 'string', + 'example' => '00 00 00 * * ?', + ], + 'StartTime' => [ + 'description' => '周期触发生效时间，type=Scheduler时生效。', + 'type' => 'string', + 'example' => '1970-01-01 00:00:00', + ], + 'EndTime' => [ + 'description' => '周期触发失效时间，type=Scheduler时生效。', + 'type' => 'string', + 'example' => '9999-01-01 00:00:00', + ], + ], + ], + 'RuntimeResource' => [ + 'title' => '运行环境配置，如资源组信息', + 'description' => '运行环境配置，如资源组信息。', + 'type' => 'object', + 'properties' => [ + 'ResourceGroupId' => [ + 'description' => '任务运行配置的调度资源组标识符。', + 'type' => 'string', + 'example' => 'S_res_group_524258031846018_1684XXXXXXXXX', + ], + 'Image' => [ + 'description' => '任务运行配置的镜像ID。', + 'type' => 'string', + 'example' => 'i-xxxxxx'."\n", + ], + 'Cu' => [ + 'description' => '任务运行配置CU消耗。', + 'type' => 'string', + 'example' => '0.25', + ], + ], + ], + 'DataSource' => [ + 'title' => '数据源', + 'description' => '关联数据源信息。', + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'description' => '数据源名称。', + 'type' => 'string', + 'example' => 'mysql_test', + ], + ], + ], + 'Inputs' => [ + 'title' => '输入信息', + 'description' => '输入信息。', + 'type' => 'object', + 'properties' => [ + 'Variables' => [ + 'description' => '变量定义列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'description' => '变量名称。', + 'type' => 'string', + 'example' => 'key1', + ], + 'Type' => [ + 'title' => '类型', + 'description' => '类型。'."\n" + .'- Constant：常量'."\n" + .'- PassThrough：参数节点输出'."\n" + .'- System：变量'."\n" + .'- NodeOutput：脚本输出', + 'type' => 'string', + 'enumValueTitles' => [], + 'example' => 'Constant'."\n", + ], + 'Value' => [ + 'description' => '变量值。', + 'type' => 'string', + 'example' => 'Value1'."\n", + ], + ], + ], + ], + ], + 'required' => false, + ], + 'Outputs' => [ + 'title' => '输出信息', + 'description' => '输出信息。', + 'type' => 'object', + 'properties' => [ + 'TaskOutputs' => [ + 'description' => '任务输出定义列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Output' => [ + 'title' => '输出标识符，示例：pre.odps_sql_demo_0', + 'description' => '输出标识符。', + 'type' => 'string', + 'example' => 'pre.odps_sql_demo_0', + ], + ], + ], + ], + 'Variables' => [ + 'description' => '变量定义列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'description' => '变量名称。', + 'type' => 'string', + 'example' => 'key1', + ], + 'Type' => [ + 'title' => '类型', + 'description' => '类型。'."\n" + .'- Constant：常量'."\n" + .'- PassThrough：参数节点输出'."\n" + .'- System：变量'."\n" + .'- NodeOutput：脚本输出', + 'type' => 'string', + 'enumValueTitles' => [], + 'example' => 'Constant'."\n", + ], + 'Value' => [ + 'description' => '变量值。', + 'type' => 'string', + 'example' => 'value1', + ], + ], + ], + ], + ], + 'required' => false, + ], + 'Dependencies' => [ + 'title' => '依赖信息', + 'description' => '依赖信息。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'title' => '依赖类型', + 'description' => '依赖类型。'."\n" + .'- CrossCycleDependsOnChildren：跨周期依赖一级子节点'."\n" + .'- CrossCycleDependsOnSelf：跨周期依赖自己'."\n" + .'- CrossCycleDependsOnOtherNode：跨周期依赖其他节点'."\n" + .'- Normal：同周期依赖', + 'type' => 'string', + 'enumValueTitles' => [], + 'example' => 'Normal', + ], + 'UpstreamOutput' => [ + 'title' => '依赖任务的输出标识符,或者任务ID', + 'description' => '上游任务的输出标识符。（`同周期依赖`且设置input内容时，返回此字段）。', + 'type' => 'string', + 'example' => 'pre.odps_sql_demo_0', + ], + 'UpstreamTaskId' => [ + 'description' => '上游任务的Id。（`跨周期依赖其他节点`与`同周期依赖`未设置input内容时，返回此字段，其他情况不返回）。', + 'type' => 'string', + 'example' => '1234', + ], + ], + ], + ], + 'SubTasks' => [ + 'title' => '复杂任务嵌套配置，如循环节点', + 'description' => '复杂任务嵌套配置，如循环节点等。', + 'type' => 'object', + 'properties' => [ + 'SubTasks' => [ + 'description' => '子任务列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'description' => '任务的名称。', + 'type' => 'string', + 'example' => 'SQL node'."\n", + ], + 'Description' => [ + 'description' => '描述信息。', + 'type' => 'string', + 'example' => 'test', + ], + 'WorkflowId' => [ + 'description' => '所属工作流的ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1234', + ], + 'Type' => [ + 'title' => '任务类型', + 'description' => '任务类型。', + 'type' => 'string', + 'example' => 'ODPS_SQL'."\n", + ], + 'BaselineId' => [ + 'title' => '基线ID', + 'description' => '基线ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => 'The baseline ID.'."\n" + ."\n", + ], + 'Priority' => [ + 'title' => '任务优先级，最大值8，最小值1', + 'description' => '任务优先级，最小值1，最大值8。取值越大，优先级越高。默认优先级为1。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Timeout' => [ + 'title' => '任务执行超时时间，单位秒', + 'description' => '任务执行超时时间，单位秒。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '3600', + ], + 'RerunMode' => [ + 'title' => '任务是否允许重跑的配置', + 'description' => '任务是否允许重跑的配置。'."\n" + .'- AllDenied：失败或成功都不可重跑'."\n" + .'- FailureAllowed：只有失败可重跑'."\n" + .'- AllAllowed：失败或成功均可重跑', + 'type' => 'string', + 'enumValueTitles' => [], + 'example' => 'AllAllowed', + ], + 'RerunTimes' => [ + 'title' => '重试次数', + 'description' => '重试次数，当任务设置为可重跑时生效。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '3', + ], + 'RerunInterval' => [ + 'title' => '重试时间间隔，单位秒', + 'description' => '重试时间间隔，单位秒。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '180', + ], + 'Trigger' => [ + 'title' => '任务触发方式', + 'description' => '任务触发方式。', + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'description' => '触发方式类型。'."\n" + .'- Scheduler：调度周期触发'."\n" + .'- Manual：手动触发', + 'type' => 'string', + 'enumValueTitles' => [], + 'example' => 'Scheduler', + ], + 'Recurrence' => [ + 'description' => '触发时的运行模式，type=Scheduler时生效。'."\n" + .'- Pause：暂停'."\n" + .'- Skip：空跑'."\n" + .'- Normal：正常运行', + 'type' => 'string', + 'enumValueTitles' => [], + 'example' => 'Normal'."\n", + ], + 'Cron' => [ + 'description' => 'Cron表达式，type=Scheduler时生效。', + 'type' => 'string', + 'example' => '00 00 00 * * ?'."\n", + ], + 'StartTime' => [ + 'description' => '周期触发生效时间，type=Scheduler时生效。', + 'type' => 'string', + 'example' => '1970-01-01 00:00:00'."\n", + ], + 'EndTime' => [ + 'description' => '周期触发失效时间，type=Scheduler时生效。', + 'type' => 'string', + 'example' => '9999-01-01 00:00:00'."\n", + ], + ], + ], + 'RuntimeResource' => [ + 'title' => '运行环境配置，如资源组信息', + 'description' => '运行环境配置，如资源组信息。', + 'type' => 'object', + 'properties' => [ + 'ResourceGroupId' => [ + 'description' => '任务运行配置的调度资源组标识符。', + 'type' => 'string', + 'example' => 'S_res_group_524258031846018_1684XXXXXXXXX', + ], + 'Image' => [ + 'description' => '任务运行配置的镜像ID。', + 'type' => 'string', + 'example' => 'i-xxxxxx', + ], + 'Cu' => [ + 'description' => '任务运行配置CU消耗。', + 'type' => 'string', + 'example' => '0.25', + ], + ], + ], + 'DataSource' => [ + 'title' => '数据源', + 'description' => '关联数据源信息。', + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'description' => '数据源名称。', + 'type' => 'string', + 'example' => 'mysql_test'."\n", + ], + ], + ], + 'Id' => [ + 'description' => '任务的唯一标识符。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1234', + ], + 'ProjectId' => [ + 'description' => '项目ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '100', + ], + 'ProjectEnv' => [ + 'description' => '项目环境。该字段已废弃，请使用EnvType。'."\n" + .'- Prod：生产'."\n" + .'- Dev：开发', + 'type' => 'string', + 'deprecated' => true, + 'enumValueTitles' => [], + 'example' => 'Prod', + ], + 'EnvType' => [ + 'description' => '项目环境。'."\n" + ."\n" + .'- Prod：生产'."\n" + .'- Dev：开发', + 'type' => 'string', + 'example' => 'Prod', + ], + 'Owner' => [ + 'description' => '任务的责任人的账号ID。', + 'type' => 'string', + 'example' => '1000'."\n", + ], + 'CreateTime' => [ + 'description' => '创建时间。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1710239005403'."\n", + ], + 'ModifyTime' => [ + 'description' => '修改时间。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1710239005403'."\n", + ], + 'CreateUser' => [ + 'description' => '创建用户的账号ID。', + 'type' => 'string', + 'example' => '1000'."\n", + ], + 'ModifyUser' => [ + 'description' => '修改用户的账号ID。', + 'type' => 'string', + 'example' => '1000'."\n", + ], + ], + ], + ], + 'Type' => [ + 'title' => '子任务类型', + 'description' => '子任务类型。'."\n" + .'- DoWhile：do-while节点'."\n" + .'- Combined：组合节点'."\n" + .'- ForEach：for-each节点', + 'type' => 'string', + 'enumValueTitles' => [], + 'example' => 'Combined', + ], + ], + ], + 'Tags' => [ + 'title' => '任务标签', + 'description' => '任务标签列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => '标签键。', + 'type' => 'string', + 'example' => 'key1', + ], + 'Value' => [ + 'description' => '标签值。', + 'type' => 'string', + 'example' => 'value1', + ], + ], + ], + ], + 'Id' => [ + 'description' => '任务的唯一标识符。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1234', + ], + 'ProjectId' => [ + 'description' => '项目ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '100', + ], + 'ProjectEnv' => [ + 'description' => '项目环境。项目环境。该字段已废弃，请使用EnvType。'."\n" + .'- Prod：生产'."\n" + .'- Dev：开发', + 'type' => 'string', + 'deprecated' => true, + 'enumValueTitles' => [], + 'example' => 'Prod', + ], + 'EnvType' => [ + 'description' => '项目环境。'."\n" + .'- Prod：生产'."\n" + .'- Dev：开发', + 'type' => 'string', + 'example' => 'Prod', + ], + 'Owner' => [ + 'description' => '任务的责任人的账号ID。', + 'type' => 'string', + 'example' => '1000', + ], + 'CreateTime' => [ + 'description' => '创建时间。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1710239005403'."\n", + ], + 'ModifyTime' => [ + 'description' => '修改时间。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1710239005403'."\n", + ], + 'CreateUser' => [ + 'description' => '创建用户的账号ID。', + 'type' => 'string', + 'example' => '1000'."\n", + ], + 'ModifyUser' => [ + 'description' => '修改用户的账号ID。', + 'type' => 'string', + 'example' => '1000', + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"22C97E95-F023-56B5-8852-B1A77A17XXXX\\",\\n \\"Task\\": {\\n \\"Name\\": \\"SQL node\\",\\n \\"Description\\": \\"test\\",\\n \\"WorkflowId\\": 1234,\\n \\"InstanceMode\\": \\"T+1\\",\\n \\"Type\\": \\"ODPS_SQL\\",\\n \\"BaselineId\\": 1234,\\n \\"Priority\\": 1,\\n \\"Timeout\\": 3600,\\n \\"RerunMode\\": \\"AllAllowed\\",\\n \\"RerunTimes\\": 3,\\n \\"RerunInterval\\": 60,\\n \\"Script\\": {\\n \\"Content\\": \\"echo \\\\\\"helloWorld\\\\\\"\\",\\n \\"Parameters\\": \\"para1=$bizdate\\"\\n },\\n \\"Trigger\\": {\\n \\"Type\\": \\"Scheduler\\",\\n \\"Recurrence\\": \\"Normal\\",\\n \\"Cron\\": \\"00 00 00 * * ?\\",\\n \\"StartTime\\": \\"1970-01-01 00:00:00\\",\\n \\"EndTime\\": \\"9999-01-01 00:00:00\\"\\n },\\n \\"RuntimeResource\\": {\\n \\"ResourceGroupId\\": \\"S_res_group_524258031846018_1684XXXXXXXXX\\",\\n \\"Image\\": \\"i-xxxxxx\\\\n\\",\\n \\"Cu\\": \\"0.25\\"\\n },\\n \\"DataSource\\": {\\n \\"Name\\": \\"mysql_test\\"\\n },\\n \\"Inputs\\": {\\n \\"Variables\\": [\\n {\\n \\"Name\\": \\"key1\\",\\n \\"Type\\": \\"Constant\\\\n\\",\\n \\"Value\\": \\"Value1\\\\n\\"\\n }\\n ]\\n },\\n \\"Outputs\\": {\\n \\"TaskOutputs\\": [\\n {\\n \\"Output\\": \\"pre.odps_sql_demo_0\\"\\n }\\n ],\\n \\"Variables\\": [\\n {\\n \\"Name\\": \\"key1\\",\\n \\"Type\\": \\"Constant\\\\n\\",\\n \\"Value\\": \\"value1\\"\\n }\\n ]\\n },\\n \\"Dependencies\\": [\\n {\\n \\"Type\\": \\"Normal\\",\\n \\"UpstreamOutput\\": \\"pre.odps_sql_demo_0\\",\\n \\"UpstreamTaskId\\": \\"1234\\"\\n }\\n ],\\n \\"SubTasks\\": {\\n \\"SubTasks\\": [\\n {\\n \\"Name\\": \\"SQL node\\\\n\\",\\n \\"Description\\": \\"test\\",\\n \\"WorkflowId\\": 1234,\\n \\"Type\\": \\"ODPS_SQL\\\\n\\",\\n \\"BaselineId\\": 0,\\n \\"Priority\\": 1,\\n \\"Timeout\\": 3600,\\n \\"RerunMode\\": \\"AllAllowed\\",\\n \\"RerunTimes\\": 3,\\n \\"RerunInterval\\": 180,\\n \\"Trigger\\": {\\n \\"Type\\": \\"Scheduler\\",\\n \\"Recurrence\\": \\"Normal\\\\n\\",\\n \\"Cron\\": \\"00 00 00 * * ?\\\\n\\",\\n \\"StartTime\\": \\"1970-01-01 00:00:00\\\\n\\",\\n \\"EndTime\\": \\"9999-01-01 00:00:00\\\\n\\"\\n },\\n \\"RuntimeResource\\": {\\n \\"ResourceGroupId\\": \\"S_res_group_524258031846018_1684XXXXXXXXX\\",\\n \\"Image\\": \\"i-xxxxxx\\",\\n \\"Cu\\": \\"0.25\\"\\n },\\n \\"DataSource\\": {\\n \\"Name\\": \\"mysql_test\\\\n\\"\\n },\\n \\"Id\\": 1234,\\n \\"ProjectId\\": 100,\\n \\"ProjectEnv\\": \\"Prod\\",\\n \\"EnvType\\": \\"Prod\\",\\n \\"Owner\\": \\"1000\\\\n\\",\\n \\"CreateTime\\": 1710239005403,\\n \\"ModifyTime\\": 1710239005403,\\n \\"CreateUser\\": \\"1000\\\\n\\",\\n \\"ModifyUser\\": \\"1000\\\\n\\"\\n }\\n ],\\n \\"Type\\": \\"Combined\\"\\n },\\n \\"Tags\\": [\\n {\\n \\"Key\\": \\"key1\\",\\n \\"Value\\": \\"value1\\"\\n }\\n ],\\n \\"Id\\": 1234,\\n \\"ProjectId\\": 100,\\n \\"ProjectEnv\\": \\"Prod\\",\\n \\"EnvType\\": \\"Prod\\",\\n \\"Owner\\": \\"1000\\",\\n \\"CreateTime\\": 1710239005403,\\n \\"ModifyTime\\": 1710239005403,\\n \\"CreateUser\\": \\"1000\\\\n\\",\\n \\"ModifyUser\\": \\"1000\\"\\n }\\n}","type":"json"}]', + 'title' => '获取任务的详情', + 'summary' => '获取指定的任务的详细信息。', + 'description' => '需要购买DataWorks基础版及以上版本才能使用。', + ], + 'ListTasks' => [ + 'summary' => '分页获取任务列表，也可以通过条件进行筛选查询。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '238059', + 'abilityTreeNodes' => [ + 'FEATUREdide7WF1GB', + 'FEATUREdideD0YY7B', + 'FEATUREdideVFMENL', + ], + ], + 'parameters' => [ + [ + 'name' => 'ProjectEnv', + 'in' => 'formData', + 'schema' => [ + 'description' => '项目环境。', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'Prod' => '生产', + 'Dev' => '开发', + ], + 'example' => 'Prod', + 'default' => 'Prod', + 'enum' => [ + 'Prod', + 'Dev', + ], + ], + ], + [ + 'name' => 'ProjectId', + 'in' => 'formData', + 'schema' => [ + 'description' => '项目ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '100', + ], + ], + [ + 'name' => 'Name', + 'in' => 'formData', + 'schema' => [ + 'description' => '名称，支持模糊查询。', + 'type' => 'string', + 'required' => false, + 'example' => 'SQL node'."\n", + ], + ], + [ + 'name' => 'Ids', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'description' => '任务的ID列表，可根据任务Id批量查询任务。', + 'type' => 'array', + 'items' => [ + 'description' => '任务ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1234', + ], + 'required' => false, + ], + ], + [ + 'name' => 'Owner', + 'in' => 'formData', + 'schema' => [ + 'description' => '任务的责任人的账号ID。', + 'type' => 'string', + 'required' => false, + 'example' => '1000', + ], + ], + [ + 'name' => 'TaskType', + 'in' => 'formData', + 'schema' => [ + 'description' => '任务类型。例如：'."\n" + ."\n" + .'- ODPS_SQL'."\n" + .'- SPARK'."\n" + .'- PY_ODPS'."\n" + .'- PY_ODPS3'."\n" + .'- ODPS_SCRIPT'."\n" + .'- ODPS_MR'."\n" + .'- COMPONENT_SQL'."\n" + .'- EMR_HIVE'."\n" + .'- EMR_MR'."\n" + .'- EMR_SPARK_SQL'."\n" + .'- EMR_SPARK'."\n" + .'- EMR_SHELL'."\n" + .'- EMR_PRESTO'."\n" + .'- EMR_IMPALA'."\n" + .'- SPARK_STREAMING'."\n" + .'- EMR_KYUUBI'."\n" + .'- EMR_TRINO'."\n" + .'- HOLOGRES_SQL'."\n" + .'- HOLOGRES_SYNC_DDL'."\n" + .'- HOLOGRES_SYNC_DATA', + 'type' => 'string', + 'required' => false, + 'example' => 'ODPS_SQL'."\n", + ], + ], + [ + 'name' => 'RuntimeResource', + 'in' => 'formData', + 'schema' => [ + 'description' => '资源组信息，这里请填入调度资源组标识符。', + 'type' => 'string', + 'required' => false, + 'example' => 'S_res_group_524258031846018_1684XXXXXXXXX', + ], + ], + [ + 'name' => 'WorkflowId', + 'in' => 'formData', + 'schema' => [ + 'description' => '所属工作流的ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1234', + ], + ], + [ + 'name' => 'TriggerType', + 'in' => 'formData', + 'schema' => [ + 'description' => '触发方式类型。', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'Scheduler' => '调度周期触发', + 'Manual' => '手动触发', + ], + 'example' => 'Scheduler'."\n", + 'enum' => [ + 'Scheduler', + 'Manual', + ], + ], + ], + [ + 'name' => 'TriggerRecurrence', + 'in' => 'formData', + 'schema' => [ + 'description' => '触发时的运行模式，TriggerType=Scheduler时生效。', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'Pause' => '暂停', + 'Skip' => '空跑', + 'Normal' => '正常运行', + ], + 'example' => 'Normal'."\n", + 'enum' => [ + 'Normal', + 'Skip', + 'Pause', + ], + ], + ], + [ + 'name' => 'SortBy', + 'in' => 'formData', + 'schema' => [ + 'description' => '排序字段。支持修改时间、创建时间等字段，格式为"排序字段+排序方式(Desc/Asc)"（Asc可以缺省）。排序字段的枚举值如下：'."\n" + ."\n" + .'- `ModifyTime (Desc/Asc)`'."\n" + .'- `CreateTime (Desc/Asc)`'."\n" + .'- `Id (Desc/Asc)`'."\n" + ."\n" + .' 默认值：`Id Desc`', + 'type' => 'string', + 'required' => false, + 'example' => 'Id Desc', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'formData', + 'schema' => [ + 'description' => '每页的条目数，默认为10，最大为1000。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'formData', + 'schema' => [ + 'description' => '页码，从1开始，默认为1。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'ResultModel<TaskListModel>', + 'description' => 'ResultModel<TaskListModel>', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求的ID，用于定位日志，排查问题。', + 'type' => 'string', + 'example' => '22C97E95-F023-56B5-8852-B1A77A17XXXX'."\n", + ], + 'PagingInfo' => [ + 'description' => '分页信息。', + 'type' => 'object', + 'properties' => [ + 'TotalCount' => [ + 'description' => '数据总条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '100', + ], + 'PageSize' => [ + 'description' => '每页的条目数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'PageNumber' => [ + 'description' => '页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Tasks' => [ + 'description' => '任务列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'description' => '名称。', + 'type' => 'string', + 'example' => 'SQL node'."\n", + ], + 'Description' => [ + 'description' => '描述信息。', + 'type' => 'string', + 'example' => 'test'."\n", + ], + 'WorkflowId' => [ + 'description' => '所属工作流的ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1234', + ], + 'InstanceMode' => [ + 'description' => '实例生成模式。'."\n" + ."\n" + .'- T+1（第二天生成）'."\n" + .'- Immediately（立即生成）', + 'type' => 'string', + 'example' => 'T+1', + ], + 'Type' => [ + 'title' => '任务类型', + 'description' => '任务类型。', + 'type' => 'string', + 'example' => 'ODPS_SQL', + ], + 'BaselineId' => [ + 'title' => '基线ID', + 'description' => '基线ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1234', + ], + 'Priority' => [ + 'title' => '任务优先级，最大值8，最小值1', + 'description' => '任务优先级，最小值1，最大值8。取值越大，优先级越高。默认优先级为1。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Timeout' => [ + 'title' => '任务执行超时时间，单位秒', + 'description' => '任务执行超时时间，单位秒。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '3600', + ], + 'RerunMode' => [ + 'title' => '任务是否允许重跑的配置', + 'description' => '任务是否允许重跑的配置。', + 'type' => 'string', + 'enumValueTitles' => [ + 'AllDenied' => '失败或成功都不可重跑', + 'FailureAllowed' => '只有失败可重跑', + 'AllAllowed' => '失败或成功均可重跑', + ], + 'example' => 'AllAllowed'."\n", + ], + 'RerunTimes' => [ + 'title' => '重试次数', + 'description' => '重试次数，当任务设置为可重跑时生效。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '3', + ], + 'RerunInterval' => [ + 'title' => '重试时间间隔，单位秒', + 'description' => '重试时间间隔，单位秒。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '60', + ], + 'Trigger' => [ + 'title' => '任务触发方式', + 'description' => '任务触发方式。', + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'description' => '触发方式类型。', + 'type' => 'string', + 'enumValueTitles' => [ + 'Scheduler' => '调度周期触发', + 'Manual' => '手动触发', + ], + 'example' => 'Scheduler'."\n", + ], + 'Recurrence' => [ + 'description' => '触发时的运行模式，type=Scheduler时生效。', + 'type' => 'string', + 'enumValueTitles' => [ + 'Pause' => '暂停', + 'Skip' => '空跑', + 'Normal' => '正常运行', + ], + 'example' => 'Normal'."\n", + ], + 'Cron' => [ + 'description' => 'Cron表达式，type=Scheduler时生效。', + 'type' => 'string', + 'example' => '00 00 00 * * ?', + ], + 'StartTime' => [ + 'description' => '周期触发生效时间，type=Scheduler时生效。', + 'type' => 'string', + 'example' => '1970-01-01 00:00:00'."\n", + ], + 'EndTime' => [ + 'description' => '周期触发失效时间，type=Scheduler时生效。', + 'type' => 'string', + 'example' => '9999-01-01 00:00:00'."\n", + ], + ], + ], + 'RuntimeResource' => [ + 'title' => '运行环境配置，如资源组信息', + 'description' => '运行环境配置，如资源组信息。', + 'type' => 'object', + 'properties' => [ + 'ResourceGroupId' => [ + 'description' => '任务运行配置的调度资源组标识符。', + 'type' => 'string', + 'example' => 'S_res_group_524258031846018_1684XXXXXXXXX', + ], + 'Image' => [ + 'description' => '任务运行配置的镜像ID。', + 'type' => 'string', + 'example' => 'i-xxxxxx'."\n", + ], + 'Cu' => [ + 'description' => '任务运行配置CU消耗。', + 'type' => 'string', + 'example' => '0.25', + ], + ], + ], + 'DataSource' => [ + 'title' => '数据源', + 'description' => '关联数据源信息。', + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'description' => '数据源名称。', + 'type' => 'string', + 'example' => 'mysql_test'."\n", + ], + ], + ], + 'Id' => [ + 'description' => '任务的唯一标识符。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1234', + ], + 'ProjectId' => [ + 'description' => '项目ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '100', + ], + 'ProjectEnv' => [ + 'description' => '项目环境。', + 'type' => 'string', + 'enumValueTitles' => [ + 'Prod' => '生产', + 'Dev' => '开发', + ], + 'example' => 'Prod', + ], + 'Owner' => [ + 'description' => '任务的责任人的账号ID。', + 'type' => 'string', + 'example' => '1000', + ], + 'CreateTime' => [ + 'description' => '创建时间。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1710239005403', + ], + 'ModifyTime' => [ + 'description' => '修改时间。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1710239005403', + ], + 'CreateUser' => [ + 'description' => '创建用户的账号ID。', + 'type' => 'string', + 'example' => '1000', + ], + 'ModifyUser' => [ + 'description' => '修改用户的账号ID。', + 'type' => 'string', + 'example' => '1000', + ], + 'ScriptParameters' => [ + 'description' => '脚本参数列表。', + 'type' => 'string', + 'example' => 'para1=$bizdate para2=$[yyyymmdd] ', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"22C97E95-F023-56B5-8852-B1A77A17XXXX\\\\n\\",\\n \\"PagingInfo\\": {\\n \\"TotalCount\\": 100,\\n \\"PageSize\\": 10,\\n \\"PageNumber\\": 1,\\n \\"Tasks\\": [\\n {\\n \\"Name\\": \\"SQL node\\\\n\\",\\n \\"Description\\": \\"test\\\\n\\",\\n \\"WorkflowId\\": 1234,\\n \\"InstanceMode\\": \\"T+1\\",\\n \\"Type\\": \\"ODPS_SQL\\",\\n \\"BaselineId\\": 1234,\\n \\"Priority\\": 1,\\n \\"Timeout\\": 3600,\\n \\"RerunMode\\": \\"AllAllowed\\\\n\\",\\n \\"RerunTimes\\": 3,\\n \\"RerunInterval\\": 60,\\n \\"Trigger\\": {\\n \\"Type\\": \\"Scheduler\\\\n\\",\\n \\"Recurrence\\": \\"Normal\\\\n\\",\\n \\"Cron\\": \\"00 00 00 * * ?\\",\\n \\"StartTime\\": \\"1970-01-01 00:00:00\\\\n\\",\\n \\"EndTime\\": \\"9999-01-01 00:00:00\\\\n\\"\\n },\\n \\"RuntimeResource\\": {\\n \\"ResourceGroupId\\": \\"S_res_group_524258031846018_1684XXXXXXXXX\\",\\n \\"Image\\": \\"i-xxxxxx\\\\n\\",\\n \\"Cu\\": \\"0.25\\"\\n },\\n \\"DataSource\\": {\\n \\"Name\\": \\"mysql_test\\\\n\\"\\n },\\n \\"Id\\": 1234,\\n \\"ProjectId\\": 100,\\n \\"ProjectEnv\\": \\"Prod\\",\\n \\"Owner\\": \\"1000\\",\\n \\"CreateTime\\": 1710239005403,\\n \\"ModifyTime\\": 1710239005403,\\n \\"CreateUser\\": \\"1000\\",\\n \\"ModifyUser\\": \\"1000\\",\\n \\"ScriptParameters\\": \\"para1=$bizdate para2=$[yyyymmdd] \\"\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => '获取任务列表', + 'description' => '需要购买DataWorks基础版及以上版本才能使用。', + ], + 'ListUpstreamTasks' => [ + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '240488', + 'abilityTreeNodes' => [ + 'FEATUREdide7WF1GB', + 'FEATUREdideD0YY7B', + 'FEATUREdideVFMENL', + ], + ], + 'parameters' => [ + [ + 'name' => 'ProjectEnv', + 'in' => 'query', + 'schema' => [ + 'description' => '项目环境。'."\n" + .'- Prod：生产'."\n" + .'- Dev：开发', + 'type' => 'string', + 'deprecated' => false, + 'required' => false, + 'enumValueTitles' => [], + 'example' => 'Prod', + 'default' => 'Prod', + 'enum' => [ + 'Prod', + 'Dev', + ], + ], + ], + [ + 'name' => 'Id', + 'in' => 'query', + 'schema' => [ + 'description' => '任务ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1234', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '每页的条目数，默认为10。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '页码，从1开始，默认为1。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求的ID，用于定位日志，排查问题。', + 'type' => 'string', + 'example' => '22C97E95-F023-56B5-8852-B1A77A17XXXX'."\n", + ], + 'PagingInfo' => [ + 'description' => '分页信息。', + 'type' => 'object', + 'properties' => [ + 'Tasks' => [ + 'description' => '任务列表。该字段已废弃，请使用UpstreamTasks。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'description' => '名称。', + 'type' => 'string', + 'example' => 'SQL node'."\n", + ], + 'Description' => [ + 'description' => '描述信息。', + 'type' => 'string', + 'example' => 'test', + ], + 'WorkflowId' => [ + 'description' => '所属工作流的ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1234', + ], + 'InstanceMode' => [ + 'description' => '实例生成模式。'."\n" + .'- T+1：第二天生成'."\n" + .'- Immediately：立即生成', + 'type' => 'string', + 'example' => 'T+1', + ], + 'Type' => [ + 'title' => '任务类型', + 'description' => '任务类型。', + 'type' => 'string', + 'example' => 'ODPS_SQL'."\n", + ], + 'BaselineId' => [ + 'title' => '基线ID', + 'description' => '基线ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1234', + ], + 'Priority' => [ + 'title' => '任务优先级，最大值8，最小值1', + 'description' => '任务优先级，最小值1，最大值8。取值越大，优先级越高。默认优先级为1。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Timeout' => [ + 'title' => '任务执行超时时间，单位秒', + 'description' => '任务执行超时时间，单位秒。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '3600', + ], + 'RerunMode' => [ + 'title' => '任务是否允许重跑的配置', + 'description' => '任务是否允许重跑的配置。', + 'type' => 'string', + 'enumValueTitles' => [ + 'AllDenied' => '失败或成功都不可重跑', + 'FailureAllowed' => '只有失败可重跑', + 'AllAllowed' => '失败或成功均可重跑', + ], + 'example' => 'AllAllowed', + ], + 'RerunTimes' => [ + 'title' => '重试次数', + 'description' => '重试次数，当任务设置为可重跑时生效。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '3', + ], + 'RerunInterval' => [ + 'title' => '重试时间间隔，单位秒', + 'description' => '重试时间间隔，单位秒。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '60', + ], + 'Trigger' => [ + 'title' => '任务触发方式', + 'description' => '任务触发方式。', + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'description' => '触发方式类型。', + 'type' => 'string', + 'enumValueTitles' => [ + 'Scheduler' => '调度周期触发', + 'Manual' => '手动触发', + ], + 'example' => 'Scheduler', + ], + 'Recurrence' => [ + 'description' => '触发时的运行模式，type=Scheduler时生效。', + 'type' => 'string', + 'enumValueTitles' => [ + 'Pause' => '暂停', + 'Skip' => '空跑', + 'Normal' => '正常运行', + ], + 'example' => 'Normal', + ], + 'Cron' => [ + 'description' => 'Cron表达式，type=Scheduler时生效。', + 'type' => 'string', + 'example' => '00 00 00 * * ?'."\n", + ], + 'StartTime' => [ + 'description' => '周期触发生效时间，type=Scheduler时生效。', + 'type' => 'string', + 'example' => '1970-01-01 00:00:00'."\n", + ], + 'EndTime' => [ + 'description' => '周期触发失效时间，type=Scheduler时生效。', + 'type' => 'string', + 'example' => '9999-01-01 00:00:00'."\n", + ], + 'Timezone' => [ + 'description' => '时区。', + 'type' => 'string', + 'example' => 'Asia/Shanghai', + ], + ], + ], + 'RuntimeResource' => [ + 'title' => '运行环境配置，如资源组信息', + 'description' => '运行环境配置，如资源组信息。', + 'type' => 'object', + 'properties' => [ + 'ResourceGroupId' => [ + 'description' => '任务运行配置的调度资源组标识符。', + 'type' => 'string', + 'example' => 'S_res_group_524258031846018_1684XXXXXXXXX', + ], + 'Image' => [ + 'description' => '任务运行配置的镜像ID。', + 'type' => 'string', + 'example' => 'i-xxxxxx', + ], + 'Cu' => [ + 'description' => '任务运行配置CU消耗。', + 'type' => 'string', + 'example' => '0.25', + ], + ], + ], + 'DataSource' => [ + 'title' => '数据源', + 'description' => '关联数据源信息。', + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'description' => '数据源名称。', + 'type' => 'string', + 'example' => 'mysql_test'."\n", + ], + ], + ], + 'Id' => [ + 'description' => '任务的唯一标识符。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1234'."\n", + ], + 'ProjectId' => [ + 'description' => '项目ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '100', + ], + 'ProjectEnv' => [ + 'description' => '项目环境。该字段已废弃，请使用EnvType。', + 'type' => 'string', + 'deprecated' => true, + 'enumValueTitles' => [ + 'Prod' => '生产', + 'Dev' => '开发', + ], + 'example' => 'Prod', + ], + 'EnvType' => [ + 'description' => '项目环境。'."\n" + .'- Prod：生产'."\n" + .'- Dev：开发', + 'type' => 'string', + 'example' => 'Prod', + ], + 'Owner' => [ + 'description' => '任务的责任人的账号ID。', + 'type' => 'string', + 'example' => '1000', + ], + 'StepType' => [ + 'description' => '依赖类型。'."\n" + .'- Normal：同周期依赖'."\n" + .'- CrossCycle：跨周期依赖', + 'type' => 'string', + 'example' => 'Normal', + ], + 'CreateTime' => [ + 'description' => '创建时间。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1710239005403'."\n", + ], + 'ModifyTime' => [ + 'description' => '修改时间', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1710239005403'."\n", + ], + 'CreateUser' => [ + 'description' => '创建用户的账号ID。', + 'type' => 'string', + 'example' => '1000', + ], + 'ModifyUser' => [ + 'description' => '修改用户的账号ID。', + 'type' => 'string', + 'example' => '1000', + ], + ], + ], + ], + 'UpstreamTasks' => [ + 'description' => '上游任务列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'DependencyType' => [ + 'title' => '依赖类型', + 'description' => '依赖类型。'."\n" + ."\n" + .'- Normal：同周期依赖'."\n" + .'- CrossCycle：跨周期依赖', + 'type' => 'string', + 'example' => 'Normal', + ], + 'Task' => [ + 'description' => '任务的详细信息。', + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'description' => '名称。', + 'type' => 'string', + 'example' => 'SQL node', + ], + 'Description' => [ + 'description' => '描述信息。', + 'type' => 'string', + 'example' => 'test', + ], + 'WorkflowId' => [ + 'description' => '所属工作流的ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1234', + ], + 'InstanceMode' => [ + 'description' => '生成实例的模式'."\n" + .'- T+1'."\n" + .'- Immediately', + 'type' => 'string', + 'example' => 'T+1', + ], + 'Type' => [ + 'title' => '任务类型', + 'description' => '任务类型', + 'type' => 'string', + 'example' => 'ODPS_SQL', + ], + 'BaselineId' => [ + 'title' => '基线ID', + 'description' => '基线ID', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1234', + ], + 'Priority' => [ + 'title' => '任务优先级，最大值8，最小值1', + 'description' => '任务优先级，最大值8，最小值1', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Timeout' => [ + 'title' => '任务执行超时时间，单位秒', + 'description' => '任务执行超时时间，单位秒', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '3600', + ], + 'RerunMode' => [ + 'title' => '任务是否允许重跑的配置', + 'description' => '任务是否允许重跑的配置。'."\n" + .'- AllDenied：失败或成功都不可重跑'."\n" + .'- FailureAllowed：只有失败可重跑'."\n" + .'- AllAllowed：失败或成功均可重跑', + 'type' => 'string', + 'example' => 'AllAllowed'."\n", + ], + 'RerunTimes' => [ + 'title' => '重试次数', + 'description' => '重试次数，当任务设置为可重跑时生效。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '3', + ], + 'RerunInterval' => [ + 'title' => '重试时间间隔，单位秒', + 'description' => '重试时间间隔，单位秒。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '60', + ], + 'Trigger' => [ + 'title' => '任务触发方式', + 'description' => '任务触发方式。', + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'description' => '触发方式类型。'."\n" + .'- Scheduler：调度周期触发'."\n" + .'- Manual：手动触发', + 'type' => 'string', + 'example' => 'Scheduler', + ], + 'Recurrence' => [ + 'description' => '触发时的运行模式，type=Scheduler时生效。'."\n" + .'- Pause：暂停'."\n" + .'- Skip：空跑'."\n" + .'- Normal：正常运行', + 'type' => 'string', + 'example' => 'Normal'."\n", + ], + 'Cron' => [ + 'description' => 'Cron表达式，type=Scheduler时生效。', + 'type' => 'string', + 'example' => '00 00 00 * * ?', + ], + 'StartTime' => [ + 'description' => '周期触发生效时间，type=Scheduler时生效。', + 'type' => 'string', + 'example' => '1970-01-01 00:00:00', + ], + 'EndTime' => [ + 'description' => '周期触发失效时间，type=Scheduler时生效。', + 'type' => 'string', + 'example' => '9999-01-01 00:00:00', + ], + 'Timezone' => [ + 'description' => '时区。', + 'type' => 'string', + 'example' => 'Asia/Shanghai', + ], + ], + ], + 'RuntimeResource' => [ + 'title' => '运行环境配置，如资源组信息', + 'description' => '运行环境配置，如资源组信息。', + 'type' => 'object', + 'properties' => [ + 'ResourceGroupId' => [ + 'description' => '任务运行配置的调度资源组标识符。', + 'type' => 'string', + 'example' => 'S_res_group_524258031846018_1684XXXXXXXXX', + ], + 'Image' => [ + 'description' => '任务运行配置的镜像ID。', + 'type' => 'string', + 'example' => 'i-xxxxxx', + ], + 'Cu' => [ + 'description' => '任务运行配置CU消耗。', + 'type' => 'string', + 'example' => '0.25', + ], + ], + ], + 'DataSource' => [ + 'title' => '数据源', + 'description' => '关联数据源信息。', + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'description' => '数据源名称。', + 'type' => 'string', + 'example' => 'mysql_test', + ], + ], + ], + 'Id' => [ + 'description' => '任务的唯一标识符。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1234', + ], + 'ProjectId' => [ + 'description' => '项目ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '100', + ], + 'EnvType' => [ + 'description' => '项目环境。'."\n" + .'- Prod：生产'."\n" + .'- Dev：开发', + 'type' => 'string', + 'example' => 'Prod', + ], + 'Owner' => [ + 'description' => '任务的责任人的账号ID。', + 'type' => 'string', + 'example' => '1000', + ], + 'CreateTime' => [ + 'description' => '创建时间。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1710239005403', + ], + 'ModifyTime' => [ + 'description' => '修改时间。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1710239005403', + ], + 'CreateUser' => [ + 'description' => '创建用户的账号ID。', + 'type' => 'string', + 'example' => '1000', + ], + 'ModifyUser' => [ + 'description' => '修改用户的账号ID。', + 'type' => 'string', + 'example' => '1000', + ], + ], + ], + ], + ], + ], + 'TotalCount' => [ + 'description' => '数据总条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '100', + ], + 'PageSize' => [ + 'description' => '每页的条目数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'PageNumber' => [ + 'description' => '页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"22C97E95-F023-56B5-8852-B1A77A17XXXX\\\\n\\",\\n \\"PagingInfo\\": {\\n \\"Tasks\\": [\\n {\\n \\"Name\\": \\"SQL node\\\\n\\",\\n \\"Description\\": \\"test\\",\\n \\"WorkflowId\\": 1234,\\n \\"InstanceMode\\": \\"T+1\\",\\n \\"Type\\": \\"ODPS_SQL\\\\n\\",\\n \\"BaselineId\\": 1234,\\n \\"Priority\\": 1,\\n \\"Timeout\\": 3600,\\n \\"RerunMode\\": \\"AllAllowed\\",\\n \\"RerunTimes\\": 3,\\n \\"RerunInterval\\": 60,\\n \\"Trigger\\": {\\n \\"Type\\": \\"Scheduler\\",\\n \\"Recurrence\\": \\"Normal\\",\\n \\"Cron\\": \\"00 00 00 * * ?\\\\n\\",\\n \\"StartTime\\": \\"1970-01-01 00:00:00\\\\n\\",\\n \\"EndTime\\": \\"9999-01-01 00:00:00\\\\n\\",\\n \\"Timezone\\": \\"Asia/Shanghai\\"\\n },\\n \\"RuntimeResource\\": {\\n \\"ResourceGroupId\\": \\"S_res_group_524258031846018_1684XXXXXXXXX\\",\\n \\"Image\\": \\"i-xxxxxx\\",\\n \\"Cu\\": \\"0.25\\"\\n },\\n \\"DataSource\\": {\\n \\"Name\\": \\"mysql_test\\\\n\\"\\n },\\n \\"Id\\": 1234,\\n \\"ProjectId\\": 100,\\n \\"ProjectEnv\\": \\"Prod\\",\\n \\"EnvType\\": \\"Prod\\",\\n \\"Owner\\": \\"1000\\",\\n \\"StepType\\": \\"Normal\\",\\n \\"CreateTime\\": 1710239005403,\\n \\"ModifyTime\\": 1710239005403,\\n \\"CreateUser\\": \\"1000\\",\\n \\"ModifyUser\\": \\"1000\\"\\n }\\n ],\\n \\"UpstreamTasks\\": [\\n {\\n \\"DependencyType\\": \\"Normal\\",\\n \\"Task\\": {\\n \\"Name\\": \\"SQL node\\",\\n \\"Description\\": \\"test\\",\\n \\"WorkflowId\\": 1234,\\n \\"InstanceMode\\": \\"T+1\\",\\n \\"Type\\": \\"ODPS_SQL\\",\\n \\"BaselineId\\": 1234,\\n \\"Priority\\": 1,\\n \\"Timeout\\": 3600,\\n \\"RerunMode\\": \\"AllAllowed\\\\n\\",\\n \\"RerunTimes\\": 3,\\n \\"RerunInterval\\": 60,\\n \\"Trigger\\": {\\n \\"Type\\": \\"Scheduler\\",\\n \\"Recurrence\\": \\"Normal\\\\n\\",\\n \\"Cron\\": \\"00 00 00 * * ?\\",\\n \\"StartTime\\": \\"1970-01-01 00:00:00\\",\\n \\"EndTime\\": \\"9999-01-01 00:00:00\\",\\n \\"Timezone\\": \\"Asia/Shanghai\\"\\n },\\n \\"RuntimeResource\\": {\\n \\"ResourceGroupId\\": \\"S_res_group_524258031846018_1684XXXXXXXXX\\",\\n \\"Image\\": \\"i-xxxxxx\\",\\n \\"Cu\\": \\"0.25\\"\\n },\\n \\"DataSource\\": {\\n \\"Name\\": \\"mysql_test\\"\\n },\\n \\"Id\\": 1234,\\n \\"ProjectId\\": 100,\\n \\"EnvType\\": \\"Prod\\",\\n \\"Owner\\": \\"1000\\",\\n \\"CreateTime\\": 1710239005403,\\n \\"ModifyTime\\": 1710239005403,\\n \\"CreateUser\\": \\"1000\\",\\n \\"ModifyUser\\": \\"1000\\"\\n }\\n }\\n ],\\n \\"TotalCount\\": 100,\\n \\"PageSize\\": 10,\\n \\"PageNumber\\": 1\\n }\\n}","type":"json"}]', + 'title' => '获取上游任务列表', + 'summary' => '分页获取指定任务的上游任务列表。', + 'description' => '需要购买DataWorks基础版及以上版本才能使用。', + ], + 'ListDownstreamTasks' => [ + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '240489', + 'abilityTreeNodes' => [ + 'FEATUREdide7WF1GB', + 'FEATUREdideD0YY7B', + 'FEATUREdideVFMENL', + ], + ], + 'parameters' => [ + [ + 'name' => 'Id', + 'in' => 'query', + 'schema' => [ + 'description' => '任务ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1234', + ], + ], + [ + 'name' => 'ProjectEnv', + 'in' => 'query', + 'schema' => [ + 'description' => '项目环境。', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'Prod' => '生产', + 'Dev' => '开发', + ], + 'example' => 'Prod', + 'default' => 'Prod', + 'enum' => [ + 'Prod', + 'Dev', + ], + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '每页的条目数，默认为10。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '页码，从1开始，默认为1。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求的ID，用于定位日志，排查问题。', + 'type' => 'string', + 'example' => '22C97E95-F023-56B5-8852-B1A77A17XXXX', + ], + 'PagingInfo' => [ + 'description' => '分页信息。', + 'type' => 'object', + 'properties' => [ + 'Tasks' => [ + 'description' => '任务列表。该字段已废弃，请使用DownstreamTasks。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'description' => '名称。', + 'type' => 'string', + 'example' => 'SQL node'."\n", + ], + 'Description' => [ + 'description' => '描述信息。', + 'type' => 'string', + 'example' => 'test', + ], + 'WorkflowId' => [ + 'description' => '所属工作流的ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1234', + ], + 'InstanceMode' => [ + 'description' => '实例生成模式。'."\n" + ."\n" + .'- T+1（第二天生成）'."\n" + .'- Immediately（立即生成）', + 'type' => 'string', + 'example' => 'T+1', + ], + 'Type' => [ + 'title' => '任务类型', + 'description' => '任务类型。', + 'type' => 'string', + 'example' => 'ODPS_SQL', + ], + 'BaselineId' => [ + 'title' => '基线ID', + 'description' => '基线ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1234', + ], + 'Priority' => [ + 'title' => '任务优先级，最大值8，最小值1', + 'description' => '任务优先级，最小值1，最大值8。取值越大，优先级越高。默认优先级为1。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Timeout' => [ + 'title' => '任务执行超时时间，单位秒', + 'description' => '任务执行超时时间，单位秒。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '3600', + ], + 'RerunMode' => [ + 'title' => '任务是否允许重跑的配置', + 'description' => '任务是否允许重跑的配置。', + 'type' => 'string', + 'enumValueTitles' => [ + 'AllDenied' => '失败或成功都不可重跑', + 'FailureAllowed' => '只有失败可重跑', + 'AllAllowed' => '失败或成功均可重跑', + ], + 'example' => 'AllAllowed', + ], + 'RerunTimes' => [ + 'title' => '重试次数', + 'description' => '重试次数，当任务设置为可重跑时生效。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '3', + ], + 'RerunInterval' => [ + 'title' => '重试时间间隔，单位秒', + 'description' => '重试时间间隔，单位秒。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '60', + ], + 'Trigger' => [ + 'title' => '任务触发方式', + 'description' => '任务触发方式。', + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'description' => '触发方式类型。', + 'type' => 'string', + 'enumValueTitles' => [ + 'Scheduler' => '调度周期触发', + 'Manual' => '手动触发', + ], + 'example' => 'Scheduler', + ], + 'Recurrence' => [ + 'description' => '触发时的运行模式，type=Scheduler时生效。', + 'type' => 'string', + 'enumValueTitles' => [ + 'Pause' => '暂停', + 'Skip' => '空跑', + 'Normal' => '正常运行', + ], + 'example' => 'Normal'."\n", + ], + 'Cron' => [ + 'description' => 'Cron表达式，type=Scheduler时生效。', + 'type' => 'string', + 'example' => '00 00 00 * * ?', + ], + 'StartTime' => [ + 'description' => '周期触发生效时间，type=Scheduler时生效。', + 'type' => 'string', + 'example' => '1970-01-01 00:00:00', + ], + 'EndTime' => [ + 'description' => '周期触发失效时间，type=Scheduler时生效。', + 'type' => 'string', + 'example' => '9999-01-01 00:00:00', + ], + 'Timezone' => [ + 'description' => '时区。', + 'type' => 'string', + 'example' => 'Asia/Shanghai', + ], + ], + ], + 'RuntimeResource' => [ + 'title' => '运行环境配置，如资源组信息', + 'description' => '运行环境配置，如资源组信息。', + 'type' => 'object', + 'properties' => [ + 'ResourceGroupId' => [ + 'description' => '任务运行配置的调度资源组标识符。', + 'type' => 'string', + 'example' => 'S_res_group_524258031846018_1684XXXXXXXXX'."\n", + ], + 'Image' => [ + 'description' => '任务运行配置的镜像ID。', + 'type' => 'string', + 'example' => 'i-xxxxxx', + ], + 'Cu' => [ + 'description' => '任务运行配置CU消耗。', + 'type' => 'string', + 'example' => '0.25', + ], + ], + ], + 'DataSource' => [ + 'title' => '数据源', + 'description' => '关联数据源信息。', + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'description' => '数据源名称。', + 'type' => 'string', + 'example' => 'mysql_test'."\n", + ], + ], + ], + 'Id' => [ + 'description' => '任务的唯一标识符。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1234', + ], + 'ProjectId' => [ + 'description' => '项目ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '100', + ], + 'ProjectEnv' => [ + 'description' => '项目环境。该字段已废弃，请使用EnvType。', + 'type' => 'string', + 'deprecated' => true, + 'enumValueTitles' => [ + 'Prod' => '生产', + 'Dev' => '开发', + ], + 'example' => 'Prod', + ], + 'EnvType' => [ + 'description' => '项目环境。'."\n" + .'- Prod：生产'."\n" + .'- Dev：开发', + 'type' => 'string', + 'example' => 'Prod', + ], + 'Owner' => [ + 'description' => '任务的责任人的账号ID。', + 'type' => 'string', + 'example' => '1000', + ], + 'StepType' => [ + 'description' => '依赖类型。'."\n" + ."\n" + .'- Normal：同周期依赖'."\n" + .'- CrossCycle：跨周期依赖', + 'type' => 'string', + 'example' => 'Normal', + ], + 'CreateTime' => [ + 'description' => '创建时间。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1710239005403', + ], + 'ModifyTime' => [ + 'description' => '修改时间。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1710239005403', + ], + 'CreateUser' => [ + 'description' => '创建用户的账号ID。', + 'type' => 'string', + 'example' => '1000', + ], + 'ModifyUser' => [ + 'description' => '修改用户的账号ID。', + 'type' => 'string', + 'example' => '1000', + ], + ], + ], + ], + 'DownstreamTasks' => [ + 'description' => '下游任务列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'DependencyType' => [ + 'title' => '依赖类型', + 'description' => '依赖类型。'."\n" + .'- Normal：同周期依赖'."\n" + .'- CrossCycle：跨周期依赖', + 'type' => 'string', + 'example' => 'Normal', + ], + 'Task' => [ + 'description' => '任务的详细信息。', + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'description' => '名称。', + 'type' => 'string', + 'example' => 'SQL node', + ], + 'Description' => [ + 'description' => '描述信息。', + 'type' => 'string', + 'example' => 'test', + ], + 'WorkflowId' => [ + 'description' => '所属工作流的ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1234', + ], + 'InstanceMode' => [ + 'description' => '实例生成模式。'."\n" + .'- T+1：第二天生成'."\n" + .'- Immediately：立即生成', + 'type' => 'string', + 'example' => 'T+1', + ], + 'Type' => [ + 'title' => '任务类型', + 'description' => '任务类型。', + 'type' => 'string', + 'example' => 'ODPS_SQL', + ], + 'BaselineId' => [ + 'title' => '基线ID', + 'description' => '基线ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1234', + ], + 'Priority' => [ + 'title' => '任务优先级，最大值8，最小值1', + 'description' => '任务优先级，最大值8，最小值1。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Timeout' => [ + 'title' => '任务执行超时时间，单位秒', + 'description' => '任务执行超时时间，单位秒。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '3600', + ], + 'RerunMode' => [ + 'title' => '任务是否允许重跑的配置', + 'description' => '任务是否允许重跑的配置。'."\n" + .'- AllDenied：失败或成功都不可重跑'."\n" + .'- FailureAllowed：只有失败可重跑'."\n" + .'- AllAllowed：失败或成功均可重跑', + 'type' => 'string', + 'example' => 'AllAllowed', + ], + 'RerunTimes' => [ + 'title' => '重试次数', + 'description' => '重试次数，当任务设置为可重跑时生效。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '3', + ], + 'RerunInterval' => [ + 'title' => '重试时间间隔，单位秒', + 'description' => '重试时间间隔，单位秒。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '60', + ], + 'Trigger' => [ + 'title' => '任务触发方式', + 'description' => '任务触发方式。', + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'description' => '触发方式类型。'."\n" + .'- Scheduler：调度周期触发'."\n" + .'- Manual：手动触发', + 'type' => 'string', + 'example' => 'Scheduler', + ], + 'Recurrence' => [ + 'description' => '触发时的运行模式，type=Scheduler时生效。'."\n" + .'- Pause：暂停'."\n" + .'- Skip：空跑'."\n" + .'- Normal：正常运行', + 'type' => 'string', + 'example' => 'Normal', + ], + 'Cron' => [ + 'description' => 'Cron表达式，type=Scheduler时生效。', + 'type' => 'string', + 'example' => '00 00 00 * * ?', + ], + 'StartTime' => [ + 'description' => '周期触发生效时间，type=Scheduler时生效。', + 'type' => 'string', + 'example' => '1970-01-01 00:00:00', + ], + 'EndTime' => [ + 'description' => '周期触发失效时间，type=Scheduler时生效。', + 'type' => 'string', + 'example' => '9999-01-01 00:00:00', + ], + 'Timezone' => [ + 'description' => '时区。', + 'type' => 'string', + 'example' => 'Asia/Shanghai', + ], + ], + ], + 'RuntimeResource' => [ + 'title' => '运行环境配置，如资源组信息', + 'description' => '运行环境配置，如资源组信息。', + 'type' => 'object', + 'properties' => [ + 'ResourceGroupId' => [ + 'description' => '任务运行配置的调度资源组标识符。', + 'type' => 'string', + 'example' => 'S_res_group_524258031846018_1684XXXXXXXXX', + ], + 'Image' => [ + 'description' => '任务运行配置的镜像ID。', + 'type' => 'string', + 'example' => 'i-xxxxxx', + ], + 'Cu' => [ + 'description' => '任务运行配置CU消耗。', + 'type' => 'string', + 'example' => '0.25', + ], + ], + ], + 'DataSource' => [ + 'title' => '数据源', + 'description' => '关联数据源信息。', + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'description' => '数据源名称。', + 'type' => 'string', + 'example' => 'mysql_test', + ], + ], + ], + 'Id' => [ + 'description' => '任务的唯一标识符。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1234', + ], + 'ProjectId' => [ + 'description' => '项目ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '100', + ], + 'EnvType' => [ + 'description' => '项目环境。'."\n" + .'- Prod：生产'."\n" + .'- Dev：开发', + 'type' => 'string', + 'example' => 'Prod', + ], + 'Owner' => [ + 'description' => '任务的责任人的账号ID。', + 'type' => 'string', + 'example' => '1000', + ], + 'CreateTime' => [ + 'description' => '创建时间。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1710239005403', + ], + 'ModifyTime' => [ + 'description' => '修改时间。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1710239005403', + ], + 'CreateUser' => [ + 'description' => '创建用户的账号ID。', + 'type' => 'string', + 'example' => '1000', + ], + 'ModifyUser' => [ + 'description' => '修改用户的账号ID。', + 'type' => 'string', + 'example' => '1000', + ], + ], + ], + ], + ], + ], + 'TotalCount' => [ + 'description' => '数据总条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '100', + ], + 'PageSize' => [ + 'description' => '每页的条目数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'PageNumber' => [ + 'description' => '页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"22C97E95-F023-56B5-8852-B1A77A17XXXX\\",\\n \\"PagingInfo\\": {\\n \\"Tasks\\": [\\n {\\n \\"Name\\": \\"SQL node\\\\n\\",\\n \\"Description\\": \\"test\\",\\n \\"WorkflowId\\": 1234,\\n \\"InstanceMode\\": \\"T+1\\",\\n \\"Type\\": \\"ODPS_SQL\\",\\n \\"BaselineId\\": 1234,\\n \\"Priority\\": 1,\\n \\"Timeout\\": 3600,\\n \\"RerunMode\\": \\"AllAllowed\\",\\n \\"RerunTimes\\": 3,\\n \\"RerunInterval\\": 60,\\n \\"Trigger\\": {\\n \\"Type\\": \\"Scheduler\\",\\n \\"Recurrence\\": \\"Normal\\\\n\\",\\n \\"Cron\\": \\"00 00 00 * * ?\\",\\n \\"StartTime\\": \\"1970-01-01 00:00:00\\",\\n \\"EndTime\\": \\"9999-01-01 00:00:00\\",\\n \\"Timezone\\": \\"Asia/Shanghai\\"\\n },\\n \\"RuntimeResource\\": {\\n \\"ResourceGroupId\\": \\"S_res_group_524258031846018_1684XXXXXXXXX\\\\n\\",\\n \\"Image\\": \\"i-xxxxxx\\",\\n \\"Cu\\": \\"0.25\\"\\n },\\n \\"DataSource\\": {\\n \\"Name\\": \\"mysql_test\\\\n\\"\\n },\\n \\"Id\\": 1234,\\n \\"ProjectId\\": 100,\\n \\"ProjectEnv\\": \\"Prod\\",\\n \\"EnvType\\": \\"Prod\\",\\n \\"Owner\\": \\"1000\\",\\n \\"StepType\\": \\"Normal\\",\\n \\"CreateTime\\": 1710239005403,\\n \\"ModifyTime\\": 1710239005403,\\n \\"CreateUser\\": \\"1000\\",\\n \\"ModifyUser\\": \\"1000\\"\\n }\\n ],\\n \\"DownstreamTasks\\": [\\n {\\n \\"DependencyType\\": \\"Normal\\",\\n \\"Task\\": {\\n \\"Name\\": \\"SQL node\\",\\n \\"Description\\": \\"test\\",\\n \\"WorkflowId\\": 1234,\\n \\"InstanceMode\\": \\"T+1\\",\\n \\"Type\\": \\"ODPS_SQL\\",\\n \\"BaselineId\\": 1234,\\n \\"Priority\\": 1,\\n \\"Timeout\\": 3600,\\n \\"RerunMode\\": \\"AllAllowed\\",\\n \\"RerunTimes\\": 3,\\n \\"RerunInterval\\": 60,\\n \\"Trigger\\": {\\n \\"Type\\": \\"Scheduler\\",\\n \\"Recurrence\\": \\"Normal\\",\\n \\"Cron\\": \\"00 00 00 * * ?\\",\\n \\"StartTime\\": \\"1970-01-01 00:00:00\\",\\n \\"EndTime\\": \\"9999-01-01 00:00:00\\",\\n \\"Timezone\\": \\"Asia/Shanghai\\"\\n },\\n \\"RuntimeResource\\": {\\n \\"ResourceGroupId\\": \\"S_res_group_524258031846018_1684XXXXXXXXX\\",\\n \\"Image\\": \\"i-xxxxxx\\",\\n \\"Cu\\": \\"0.25\\"\\n },\\n \\"DataSource\\": {\\n \\"Name\\": \\"mysql_test\\"\\n },\\n \\"Id\\": 1234,\\n \\"ProjectId\\": 100,\\n \\"EnvType\\": \\"Prod\\",\\n \\"Owner\\": \\"1000\\",\\n \\"CreateTime\\": 1710239005403,\\n \\"ModifyTime\\": 1710239005403,\\n \\"CreateUser\\": \\"1000\\",\\n \\"ModifyUser\\": \\"1000\\"\\n }\\n }\\n ],\\n \\"TotalCount\\": 100,\\n \\"PageSize\\": 10,\\n \\"PageNumber\\": 1\\n }\\n}","type":"json"}]', + 'title' => '获取下游任务列表', + 'summary' => '分页获取指定任务的下游任务列表。', + 'description' => '需要购买DataWorks基础版及以上版本才能使用。', + ], + 'ListTaskOperationLogs' => [ + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '240490', + 'abilityTreeNodes' => [ + 'FEATUREdide7WF1GB', + ], + ], + 'parameters' => [ + [ + 'name' => 'Id', + 'in' => 'query', + 'schema' => [ + 'description' => '任务ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1234', + ], + ], + [ + 'name' => 'Date', + 'in' => 'query', + 'schema' => [ + 'description' => '操作日期（精确到天），默认查询当天。支持查询过去31天内的操作日志。格式为时间戳。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1710239005403'."\n", + ], + ], + [ + 'name' => 'ProjectEnv', + 'in' => 'query', + 'schema' => [ + 'description' => '项目环境。'."\n" + .'- Prod：生产'."\n" + .'- Dev：开发', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [], + 'example' => 'Prod', + 'default' => 'Prod', + 'enum' => [ + 'Prod', + 'Dev', + ], + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '每页的条目数，默认为10。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '页码，从1开始，默认为1。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求的ID，用于定位日志，排查问题。', + 'type' => 'string', + 'example' => '22C97E95-F023-56B5-8852-B1A77A17XXXX'."\n", + ], + 'PagingInfo' => [ + 'description' => '分页信息。', + 'type' => 'object', + 'properties' => [ + 'OperationLogs' => [ + 'description' => '操作日志列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'User' => [ + 'description' => '操作人的账号ID。', + 'type' => 'string', + 'example' => '1000', + ], + 'CreateTime' => [ + 'description' => '操作日志生成时间。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1710239005403'."\n", + ], + 'OperationSeq' => [ + 'description' => '操作序列号。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1111', + ], + 'OperationContent' => [ + 'description' => '操作内容。', + 'type' => 'string', + 'example' => 'Freeze tasks', + ], + 'TaskId' => [ + 'description' => '所操作的任务Id。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1234', + ], + ], + ], + ], + 'TotalCount' => [ + 'description' => '数据总条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '100', + ], + 'PageSize' => [ + 'description' => '每页的条目数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'PageNumber' => [ + 'description' => '页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"22C97E95-F023-56B5-8852-B1A77A17XXXX\\\\n\\",\\n \\"PagingInfo\\": {\\n \\"OperationLogs\\": [\\n {\\n \\"User\\": \\"1000\\",\\n \\"CreateTime\\": 1710239005403,\\n \\"OperationSeq\\": 1111,\\n \\"OperationContent\\": \\"Freeze tasks\\",\\n \\"TaskId\\": 1234\\n }\\n ],\\n \\"TotalCount\\": 100,\\n \\"PageSize\\": 10,\\n \\"PageNumber\\": 1\\n }\\n}","type":"json"}]', + 'title' => '获取任务的操作日志列表', + 'summary' => '分页获取指定任务的操作日志列表。', + 'description' => '需要购买DataWorks基础版及以上版本才能使用。'."\n" + ."\n" + .'仅支持查询过去31天内的操作日志。', + ], + 'UpdateTaskInstances' => [ + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '245367', + 'abilityTreeNodes' => [ + 'FEATUREdide7WF1GB', + ], + ], + 'parameters' => [ + [ + 'name' => 'TaskInstances', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'description' => '任务实例列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Id' => [ + 'description' => '任务实例ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1234', + ], + 'Priority' => [ + 'description' => '实例运行优先级，取值分为1、3、5、7和8。'."\n" + ."\n" + .'取值越大，优先级越高。默认优先级为1。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'enumValueTitles' => [ + 1 => '1', + 3 => '3', + 5 => '5', + 7 => '7', + '8', + ], + 'example' => '1', + 'enum' => [ + '1', + '3', + '5', + '7', + '8', + ], + ], + 'RuntimeResource' => [ + 'description' => '资源组信息，这里请填入调度资源组标识符。', + 'type' => 'string', + 'required' => false, + 'example' => 'S_res_group_524258031846018_1684XXXXXXXXX', + ], + 'DataSource' => [ + 'description' => '关联数据源信息。', + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'description' => '数据源名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'mysql_test'."\n", + ], + ], + 'required' => false, + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 50, + ], + ], + [ + 'name' => 'Comment', + 'in' => 'formData', + 'schema' => [ + 'description' => '备注信息。', + 'type' => 'string', + 'required' => false, + 'example' => 'this is a comment', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求的ID，用于定位日志，排查问题。', + 'type' => 'string', + 'example' => '22C97E95-F023-56B5-8852-B1A77A17XXXX'."\n", + ], + 'SuccessInfo' => [ + 'description' => '批量操作的结果信息。结构为Map，以任务实例ID为键，以结果信息为Value。', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'object', + 'properties' => [ + 'Success' => [ + 'type' => 'boolean', + 'description' => '操作是否成功。', + 'example' => 'true', + ], + 'Message' => [ + 'type' => 'string', + 'example' => '该实例不存在。', + 'description' => '错误信息。', + ], + ], + 'description' => '结果信息。', + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"22C97E95-F023-56B5-8852-B1A77A17XXXX\\\\n\\",\\n \\"SuccessInfo\\": {\\n \\"key\\": {\\n \\"Success\\": true,\\n \\"Message\\": \\"该实例不存在。\\"\\n }\\n }\\n}","type":"json"}]', + 'title' => '修改任务实例属性', + 'summary' => '批量修改多个任务实例的属性，包括优先级、调度资源组、数据源等。', + 'description' => '需要购买DataWorks基础版及以上版本才能使用。', + ], + 'GetTaskInstance' => [ + 'summary' => '获取指定的任务实例的详细信息。', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '240659', + 'abilityTreeNodes' => [ + 'FEATUREdide7WF1GB', + 'FEATUREdideD0YY7B', + 'FEATUREdideVFMENL', + ], + ], + 'parameters' => [ + [ + 'name' => 'Id', + 'in' => 'query', + 'schema' => [ + 'description' => '任务实例的唯一标识符', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1234', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回值', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求的ID，用于定位日志，排查问题。', + 'type' => 'string', + 'example' => '22C97E95-F023-56B5-8852-B1A77****', + ], + 'TaskInstance' => [ + 'description' => '任务实例的详细信息。', + 'type' => 'object', + 'properties' => [ + 'TaskId' => [ + 'description' => '对应任务的ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1234', + ], + 'TaskType' => [ + 'title' => '任务类型', + 'description' => '对应任务的类型。', + 'type' => 'string', + 'example' => 'ODPS_SQL', + ], + 'TaskName' => [ + 'description' => '对应任务的名称。', + 'type' => 'string', + 'example' => 'SQL node'."\n", + ], + 'Description' => [ + 'description' => '描述信息。', + 'type' => 'string', + 'example' => 'test', + ], + 'WorkflowId' => [ + 'description' => '所属工作流的ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1234', + ], + 'WorkflowName' => [ + 'description' => '所属工作流的名称。', + 'type' => 'string', + 'example' => 'Test workflow', + ], + 'TriggerType' => [ + 'description' => '触发方式类型。可通过调用GetTask接口的返回参数Trigger.Type获取触发方式类型。'."\n" + .'- Scheduler：调度周期触发'."\n" + .'- Manual：手动触发', + 'type' => 'string', + 'enumValueTitles' => [], + 'example' => 'Scheduler', + ], + 'TriggerRecurrence' => [ + 'description' => '触发时的运行模式。TriggerType=Scheduler时生效。'."\n" + .'- Pause：暂停'."\n" + .'- Skip：空跑'."\n" + .'- Normal：正常运行', + 'type' => 'string', + 'enumValueTitles' => [], + 'example' => 'Normal', + ], + 'WorkflowInstanceId' => [ + 'description' => '所属工作流实例的ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1234', + ], + 'WorkflowInstanceType' => [ + 'description' => '所属工作流实例的类型。'."\n" + .'- SmokeTest：测试'."\n" + .'- SupplementData：补数据'."\n" + .'- Manual：手动任务'."\n" + .'- ManualWorkflow：手动工作流'."\n" + .'- Normal：周期调度'."\n" + .'- ManualFlow：手动执行的业务流程', + 'type' => 'string', + 'enumValueTitles' => [], + 'example' => 'Normal', + ], + 'UnifiedWorkflowInstanceId' => [ + 'description' => '统一工作流实例Id，某次触发下某业务日期内的所有任务实例的该字段值相等。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1234', + ], + 'Timeout' => [ + 'description' => '任务执行超时时间，单位为秒。'."\n" + ."\n" + .'注意：调度系统会对任务的设定值按小时取整。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '3600', + ], + 'RerunMode' => [ + 'title' => '任务是否允许重跑的配置', + 'description' => '任务是否允许重跑的配置。'."\n" + .'- AllDenied：失败或成功都不可重跑'."\n" + .'- AllAllowed：失败或成功均可重跑'."\n" + .'- FailureAllowed：只有失败可重跑', + 'type' => 'string', + 'enumValueTitles' => [], + 'example' => 'AllAllowed', + ], + 'RunNumber' => [ + 'description' => '当前运行的次数，默认从1开始。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PeriodNumber' => [ + 'description' => '周期序号。表示任务实例处于当天的第几轮周期。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'BaselineId' => [ + 'description' => '基线ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1234', + ], + 'Priority' => [ + 'description' => '任务运行优先级，最小值1，最大值8。取值越大，优先级越高。默认优先级为1。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Script' => [ + 'description' => '运行脚本信息。', + 'type' => 'object', + 'properties' => [ + 'Content' => [ + 'description' => '脚本内容。', + 'type' => 'string', + 'example' => 'echo "helloWorld"', + ], + 'Parameters' => [ + 'description' => '脚本参数列表。', + 'type' => 'string', + 'example' => 'para1=$bizdate', + ], + ], + ], + 'RuntimeResource' => [ + 'description' => '实例关联资源组信息。', + 'type' => 'object', + 'properties' => [ + 'ResourceGroupId' => [ + 'description' => '任务运行配置的调度资源组标识符。', + 'type' => 'string', + 'example' => 'S_res_group_524258031846018_1684XXXXXXXXX', + ], + 'Image' => [ + 'description' => '任务运行配置的镜像ID。', + 'type' => 'string', + 'example' => 'i-xxxxxx', + ], + 'Cu' => [ + 'description' => '任务运行配置CU消耗。', + 'type' => 'string', + 'example' => '0.25', + ], + ], + ], + 'Runtime' => [ + 'description' => '实例运行时信息。', + 'type' => 'object', + 'properties' => [ + 'ProcessId' => [ + 'description' => '运行唯一ID。', + 'type' => 'string', + 'example' => 'T3_123', + ], + 'Gateway' => [ + 'description' => '运行机器。', + 'type' => 'string', + 'example' => 'cn-shanghai.1.2', + ], + ], + ], + 'DataSource' => [ + 'description' => '实例关联数据源信息。', + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'description' => '数据源名称。', + 'type' => 'string', + 'example' => 'mysql_test', + ], + ], + ], + 'Inputs' => [ + 'description' => '输入信息。', + 'type' => 'object', + 'properties' => [ + 'Variables' => [ + 'description' => '变量定义列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'description' => '变量名称。', + 'type' => 'string', + 'enumValueTitles' => [], + 'example' => 'Key1', + ], + 'Type' => [ + 'title' => '类型', + 'description' => '类型。'."\n" + .'- Constant：常量'."\n" + .'- PassThrough：参数节点输出'."\n" + .'- System：变量'."\n" + .'- NodeOutput：脚本输出', + 'type' => 'string', + 'enumValueTitles' => [], + 'example' => 'Constant', + ], + 'Value' => [ + 'description' => '变量值。', + 'type' => 'string', + 'example' => 'Value1', + ], + ], + ], + ], + ], + ], + 'Outputs' => [ + 'description' => '输出信息。', + 'type' => 'object', + 'properties' => [ + 'TaskOutputs' => [ + 'description' => '任务输出定义列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Output' => [ + 'title' => '输出标识符，示例：pre.odps_sql_demo_0', + 'description' => '输出标识符。', + 'type' => 'string', + 'example' => 'pre.odps_sql_demo_0', + ], + ], + ], + ], + 'Variables' => [ + 'description' => '变量定义列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'description' => '变量名称。', + 'type' => 'string', + 'example' => 'key1', + ], + 'Type' => [ + 'title' => '类型', + 'description' => '类型。'."\n" + .'- Constant：常量'."\n" + .'- PassThrough：参数节点输出'."\n" + .'- System：变量'."\n" + .'- NodeOutput：脚本输出', + 'type' => 'string', + 'enumValueTitles' => [], + 'example' => 'Constant', + ], + 'Value' => [ + 'description' => '变量值。', + 'type' => 'string', + 'example' => 'value1', + ], + ], + ], + ], + ], + ], + 'Tags' => [ + 'title' => '任务标签', + 'description' => '任务标签列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => '标签键。', + 'type' => 'string', + 'example' => 'key1', + ], + 'Value' => [ + 'description' => '标签值。', + 'type' => 'string', + 'example' => 'value1', + ], + ], + ], + ], + 'Status' => [ + 'title' => '实例运行状态', + 'description' => '实例运行状态。'."\n" + .'- NotRun：未运行'."\n" + .'- Running：运行中'."\n" + .'- WaitTime：等待TriggerTime到来'."\n" + .'- CheckingCondition：分支条件校检'."\n" + .'- WaitResource：等待资源'."\n" + .'- Failure：执行失败'."\n" + .'- Success：执行成功'."\n" + .'- Checking：下发给数据质量校检'."\n" + .'- WaitTrigger（等待外部触发，触发式节点会在等待时间后变成等待触发）', + 'type' => 'string', + 'enumValueTitles' => [], + 'example' => 'Success', + ], + 'TriggerTime' => [ + 'description' => '定时触发时间。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1710239005403', + ], + 'Bizdate' => [ + 'description' => '业务日期。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1710239005403', + ], + 'StartedTime' => [ + 'description' => '开始运行时间。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1710239005403', + ], + 'FinishedTime' => [ + 'description' => '完成时间。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1710239005403', + ], + 'Id' => [ + 'description' => '任务实例的唯一标识符。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1234', + ], + 'ProjectId' => [ + 'description' => '项目ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '100', + ], + 'ProjectEnv' => [ + 'description' => '项目环境。'."\n" + .'- Prod：生产'."\n" + .'- Dev：开发', + 'type' => 'string', + 'enumValueTitles' => [], + 'example' => 'Prod', + ], + 'Owner' => [ + 'description' => '任务的责任人的账号ID。', + 'type' => 'string', + 'example' => '1000', + ], + 'CreateTime' => [ + 'description' => '创建时间。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1710239005403', + ], + 'ModifyTime' => [ + 'description' => '修改时间。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1710239005403', + ], + 'CreateUser' => [ + 'description' => '创建用户的账号ID。', + 'type' => 'string', + 'example' => '1000', + ], + 'ModifyUser' => [ + 'description' => '修改用户的账号ID。', + 'type' => 'string', + 'example' => '1000', + ], + 'WaitingResourceTime' => [ + 'description' => '进入等资源的时刻。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1710239005403', + ], + 'WaitingTriggerTime' => [ + 'description' => '进入等定时时间的时刻。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1710239005403', + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"22C97E95-F023-56B5-8852-B1A77****\\",\\n \\"TaskInstance\\": {\\n \\"TaskId\\": 1234,\\n \\"TaskType\\": \\"ODPS_SQL\\",\\n \\"TaskName\\": \\"SQL node\\\\n\\",\\n \\"Description\\": \\"test\\",\\n \\"WorkflowId\\": 1234,\\n \\"WorkflowName\\": \\"Test workflow\\",\\n \\"TriggerType\\": \\"Scheduler\\",\\n \\"TriggerRecurrence\\": \\"Normal\\",\\n \\"WorkflowInstanceId\\": 1234,\\n \\"WorkflowInstanceType\\": \\"Normal\\",\\n \\"UnifiedWorkflowInstanceId\\": 1234,\\n \\"Timeout\\": 3600,\\n \\"RerunMode\\": \\"AllAllowed\\",\\n \\"RunNumber\\": 1,\\n \\"PeriodNumber\\": 1,\\n \\"BaselineId\\": 1234,\\n \\"Priority\\": 1,\\n \\"Script\\": {\\n \\"Content\\": \\"echo \\\\\\"helloWorld\\\\\\"\\",\\n \\"Parameters\\": \\"para1=$bizdate\\"\\n },\\n \\"RuntimeResource\\": {\\n \\"ResourceGroupId\\": \\"S_res_group_524258031846018_1684XXXXXXXXX\\",\\n \\"Image\\": \\"i-xxxxxx\\",\\n \\"Cu\\": \\"0.25\\"\\n },\\n \\"Runtime\\": {\\n \\"ProcessId\\": \\"T3_123\\",\\n \\"Gateway\\": \\"cn-shanghai.1.2\\"\\n },\\n \\"DataSource\\": {\\n \\"Name\\": \\"mysql_test\\"\\n },\\n \\"Inputs\\": {\\n \\"Variables\\": [\\n {\\n \\"Name\\": \\"Key1\\",\\n \\"Type\\": \\"Constant\\",\\n \\"Value\\": \\"Value1\\"\\n }\\n ]\\n },\\n \\"Outputs\\": {\\n \\"TaskOutputs\\": [\\n {\\n \\"Output\\": \\"pre.odps_sql_demo_0\\"\\n }\\n ],\\n \\"Variables\\": [\\n {\\n \\"Name\\": \\"key1\\",\\n \\"Type\\": \\"Constant\\",\\n \\"Value\\": \\"value1\\"\\n }\\n ]\\n },\\n \\"Tags\\": [\\n {\\n \\"Key\\": \\"key1\\",\\n \\"Value\\": \\"value1\\"\\n }\\n ],\\n \\"Status\\": \\"Success\\",\\n \\"TriggerTime\\": 1710239005403,\\n \\"Bizdate\\": 1710239005403,\\n \\"StartedTime\\": 1710239005403,\\n \\"FinishedTime\\": 1710239005403,\\n \\"Id\\": 1234,\\n \\"ProjectId\\": 100,\\n \\"ProjectEnv\\": \\"Prod\\",\\n \\"Owner\\": \\"1000\\",\\n \\"CreateTime\\": 1710239005403,\\n \\"ModifyTime\\": 1710239005403,\\n \\"CreateUser\\": \\"1000\\",\\n \\"ModifyUser\\": \\"1000\\",\\n \\"WaitingResourceTime\\": 1710239005403,\\n \\"WaitingTriggerTime\\": 1710239005403\\n }\\n}","type":"json"}]', + 'title' => '获取任务实例的详情', + 'description' => '需要购买DataWorks基础版及以上版本才能使用。', + ], + 'GetTaskInstanceLog' => [ + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '240663', + 'abilityTreeNodes' => [ + 'FEATUREdide7WF1GB', + ], + ], + 'parameters' => [ + [ + 'name' => 'Id', + 'in' => 'query', + 'schema' => [ + 'description' => '任务实例ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1234', + ], + ], + [ + 'name' => 'RunNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '任务实例的运行次数，最小值为1，默认取最新的一次。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求的ID，用于定位日志，排查问题。', + 'type' => 'string', + 'example' => '22C97E95-F023-56B5-8852-B1A77A17XXXX'."\n", + ], + 'TaskInstanceLog' => [ + 'description' => '任务实例运行日志。', + 'type' => 'string', + 'example' => 'This is running log', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"22C97E95-F023-56B5-8852-B1A77A17XXXX\\\\n\\",\\n \\"TaskInstanceLog\\": \\"This is running log\\"\\n}","type":"json"}]', + 'title' => '获取任务实例的运行日志', + 'summary' => '获取指定任务实例某一次运行的运行日志。', + 'description' => '需要购买DataWorks基础版及以上版本才能使用。', + ], + 'ListTaskInstances' => [ + 'summary' => '分页获取任务实例列表，也可以通过条件进行筛选查询。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '240660', + 'abilityTreeNodes' => [ + 'FEATUREdide7WF1GB', + 'FEATUREdideD0YY7B', + 'FEATUREdideVFMENL', + ], + ], + 'parameters' => [ + [ + 'name' => 'ProjectId', + 'in' => 'formData', + 'schema' => [ + 'description' => '项目ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '100'."\n", + ], + ], + [ + 'name' => 'Bizdate', + 'in' => 'formData', + 'schema' => [ + 'description' => '业务日期。一般是周期实例定时时间的前一天的0点0分0秒，格式为毫秒级时间戳，如1743350400000。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1710239005403', + ], + ], + [ + 'name' => 'TaskId', + 'in' => 'formData', + 'schema' => [ + 'description' => '对应任务的ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1234', + ], + ], + [ + 'name' => 'TaskIds', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'description' => '对应任务的ID列表，可根据任务Id批量查询任务实例。', + 'type' => 'array', + 'items' => [ + 'description' => '任务ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1234', + ], + 'required' => false, + ], + ], + [ + 'name' => 'TaskName', + 'in' => 'formData', + 'schema' => [ + 'description' => '对应任务的名称，支持模糊查询。', + 'type' => 'string', + 'required' => false, + 'example' => 'SQL node', + ], + ], + [ + 'name' => 'Owner', + 'in' => 'formData', + 'schema' => [ + 'description' => '任务的责任人的账号ID。', + 'type' => 'string', + 'required' => false, + 'example' => '1000', + ], + ], + [ + 'name' => 'TaskType', + 'in' => 'formData', + 'schema' => [ + 'description' => '任务类型。各节点的TaskType取值，请参见[DataWorks节点合集](~~600169~~)。', + 'type' => 'string', + 'required' => false, + 'example' => 'ODPS_SQL', + ], + ], + [ + 'name' => 'RuntimeResource', + 'in' => 'formData', + 'schema' => [ + 'description' => '资源组信息，这里请填入调度资源组标识符。', + 'type' => 'string', + 'required' => false, + 'example' => 'S_res_group_524258031846018_1684XXXXXXXXX'."\n", + ], + ], + [ + 'name' => 'WorkflowId', + 'in' => 'formData', + 'schema' => [ + 'description' => '所属工作流的ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1234'."\n", + ], + ], + [ + 'name' => 'UnifiedWorkflowInstanceId', + 'in' => 'formData', + 'schema' => [ + 'description' => '统一工作流实例Id，某次触发下某业务日期内的所有任务实例的该字段值相等。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1234', + ], + ], + [ + 'name' => 'WorkflowInstanceType', + 'in' => 'formData', + 'schema' => [ + 'title' => '工作流实例类型', + 'description' => '所属工作流实例的类型。'."\n" + .'- SmokeTest：测试'."\n" + .'- Manual：手动任务'."\n" + .'- SupplementData：补数据'."\n" + .'- ManualWorkflow：手动工作流'."\n" + .'- Normal：周期调度'."\n" + .'- TriggerWorkflow：触发式工作流', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [], + 'example' => 'Normal'."\n", + 'enum' => [ + 'Normal', + 'ManualWorkflow', + 'Manual', + 'SupplementData', + 'SmokeTest', + 'TriggerWorkflow', + ], + ], + ], + [ + 'name' => 'WorkflowInstanceId', + 'in' => 'formData', + 'schema' => [ + 'description' => '所属工作流实例的ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1234', + ], + ], + [ + 'name' => 'ProjectEnv', + 'in' => 'formData', + 'schema' => [ + 'description' => '项目环境。'."\n" + .'- Prod：生产'."\n" + .'- Dev：开发', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [], + 'example' => 'Prod', + 'default' => 'Prod', + 'enum' => [ + 'Prod', + 'Dev', + ], + ], + ], + [ + 'name' => 'Id', + 'in' => 'formData', + 'schema' => [ + 'description' => '任务实例ID。任务实例存在重跑的情况，假如设置该参数，则返回包含重跑的历史信息，通过RunNumber区分每个历史信息。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1234', + ], + ], + [ + 'name' => 'Ids', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'description' => '任务实例ID列表，可根据任务实例Id批量查询多个任务实例信息。', + 'type' => 'array', + 'items' => [ + 'description' => '任务实例ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1234', + ], + 'required' => false, + ], + ], + [ + 'name' => 'TriggerType', + 'in' => 'formData', + 'schema' => [ + 'description' => '触发方式类型。'."\n" + .'- Scheduler：周期调度触发'."\n" + .'- Manual：手动触发', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [], + 'example' => 'Normal'."\n", + 'enum' => [ + 'Scheduler', + 'Manual', + ], + ], + ], + [ + 'name' => 'TriggerRecurrence', + 'in' => 'formData', + 'schema' => [ + 'description' => '触发时的运行模式，TriggerType=Scheduler时生效。'."\n" + .'- Pause：暂停'."\n" + .'- Skip：空跑'."\n" + .'- Normal：正常运行', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [], + 'example' => 'Normal', + 'enum' => [ + 'Normal', + 'Skip', + 'Pause', + ], + ], + ], + [ + 'name' => 'SortBy', + 'in' => 'formData', + 'schema' => [ + 'description' => '排序字段。支持定时时间、开始时间等字段，格式为"排序字段+排序方式(Desc/Asc)"（Asc可以缺省）。排序字段的枚举值如下：'."\n" + ."\n" + .'- `TriggerTime (Desc/Asc)`'."\n" + ."\n" + .'- `StartedTime (Desc/Asc)`'."\n" + ."\n" + .'- `FinishedTime (Desc/Asc)`'."\n" + ."\n" + .'- `CreateTime (Desc/Asc)`'."\n" + ."\n" + .'- `Id (Desc/Asc)`'."\n" + ."\n" + .' 默认值：`Id Desc`', + 'type' => 'string', + 'required' => false, + 'example' => 'Id Desc', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'formData', + 'schema' => [ + 'description' => '每页的条目数，默认为10，最大为500。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'formData', + 'schema' => [ + 'description' => '页码，从1开始，默认为1。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'Status', + 'in' => 'formData', + 'schema' => [ + 'description' => '任务实例的状态：'."\n" + .'- `NotRun`：未运行'."\n" + .'- `Running`：运行中'."\n" + .'- `Failure`：运行失败'."\n" + .'- `Success`：运行成功'."\n" + .'- `WaitTime`：等待时间'."\n" + .'- `WaitResource`：等待资源', + 'type' => 'string', + 'required' => false, + 'example' => 'Success', + 'enum' => [ + 'NotRun', + 'Running', + 'Failure', + 'Success', + 'WaitTime', + 'WaitResource', + ], + ], + ], + [ + 'name' => 'Filter', + 'in' => 'formData', + 'schema' => [ + 'description' => '过滤器。JSON格式，多个过滤条件之间是"且"的关系。目前支持的字段有：`startedTimeStart, startedTimeEnd, finishedTimeStart, finishedTimeEnd, createTimeStart, createTimeEnd`', + 'type' => 'string', + 'required' => false, + 'example' => '{'."\n" + .' "startedTimeStart": "1763481600000",'."\n" + .' "startedTimeEnd": "1763481600000",'."\n" + .' "finishedTimeStart": "1763481600000",'."\n" + .' "finishedTimeEnd": "1763481600000",'."\n" + .' "createTimeStart": "1763481600000",'."\n" + .' "createTimeEnd": "1763481600000"'."\n" + .'}'."\n", + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求的ID，用于定位日志，排查问题。', + 'type' => 'string', + 'example' => '22C97E95-F023-56B5-8852-B1A77A17XXXX', + ], + 'PagingInfo' => [ + 'description' => '分页信息。', + 'type' => 'object', + 'properties' => [ + 'TaskInstances' => [ + 'description' => '任务实例列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'TaskId' => [ + 'description' => '对应任务的ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1234'."\n", + ], + 'TaskType' => [ + 'title' => '任务类型', + 'description' => '对应任务的类型。', + 'type' => 'string', + 'example' => 'ODPS_SQL'."\n", + ], + 'TaskName' => [ + 'description' => '对应任务的名称。', + 'type' => 'string', + 'example' => 'SQL node'."\n", + ], + 'Description' => [ + 'description' => '描述信息。', + 'type' => 'string', + 'example' => 'test'."\n", + ], + 'WorkflowId' => [ + 'description' => '所属工作流的ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1234'."\n", + ], + 'WorkflowName' => [ + 'description' => '所属工作流的名称。', + 'type' => 'string', + 'example' => 'Test workflow'."\n", + ], + 'TriggerType' => [ + 'description' => '触发方式类型。'."\n" + .'- Scheduler：调度周期触发'."\n" + .'- Manual：手动触发', + 'type' => 'string', + 'enumValueTitles' => [], + 'example' => 'Scheduler'."\n", + ], + 'TriggerRecurrence' => [ + 'description' => '触发时的运行模式。TriggerType=Scheduler时生效。'."\n" + .'- Pause：暂停'."\n" + .'- Skip：空跑'."\n" + .'- Normal：正常运行', + 'type' => 'string', + 'enumValueTitles' => [], + 'example' => 'Normal'."\n", + ], + 'WorkflowInstanceId' => [ + 'description' => '所属工作流实例的ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1234', + ], + 'UnifiedWorkflowInstanceId' => [ + 'description' => '统一工作流实例Id，某次触发下某业务日期内的所有任务实例的该字段值相等。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1234', + ], + 'WorkflowInstanceType' => [ + 'description' => '所属工作流实例的类型。'."\n" + .'- SmokeTest：测试'."\n" + .'- SupplementData：补数据'."\n" + .'- Manual：手动'."\n" + .'- ManualWorkflow：手动工作流'."\n" + .'- Normal：周期调度'."\n" + .'- ManualFlow：手动执行的业务流程', + 'type' => 'string', + 'enumValueTitles' => [], + 'example' => 'Normal', + ], + 'Timeout' => [ + 'description' => '任务执行超时时间，单位为秒。'."\n" + ."\n" + .'注意：调度系统会对任务的设定值按小时取整。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '3600', + ], + 'RerunMode' => [ + 'title' => '任务是否允许重跑的配置', + 'description' => '任务是否允许重跑的配置。'."\n" + .'- AllDenied：失败或成功都不可重跑'."\n" + .'- FailureAllowed：只有失败可重跑'."\n" + .'- AllAllowed：失败或成功均可重跑', + 'type' => 'string', + 'enumValueTitles' => [], + 'example' => 'AllAllowed'."\n", + ], + 'RunNumber' => [ + 'description' => '当前运行的次数，默认从1开始。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PeriodNumber' => [ + 'description' => '周期序号。表示任务实例处于当天的第几轮周期。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'BaselineId' => [ + 'description' => '基线ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1234', + ], + 'Priority' => [ + 'description' => '任务运行优先级，最小值1，最大值8。取值越大，优先级越高。默认优先级为1。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'RuntimeResource' => [ + 'description' => '实例关联资源组信息。', + 'type' => 'object', + 'properties' => [ + 'ResourceGroupId' => [ + 'description' => '任务运行配置的调度资源组标识符。', + 'type' => 'string', + 'example' => 'S_res_group_524258031846018_1684XXXXXXXXX', + ], + 'Image' => [ + 'description' => '任务运行配置的镜像ID。', + 'type' => 'string', + 'example' => 'i-xxxxxx'."\n", + ], + 'Cu' => [ + 'description' => '任务运行配置CU消耗。', + 'type' => 'string', + 'example' => '0.25'."\n", + ], + ], + ], + 'Runtime' => [ + 'description' => '实例运行时信息。', + 'type' => 'object', + 'properties' => [ + 'ProcessId' => [ + 'description' => '运行唯一ID。', + 'type' => 'string', + 'example' => 'T3_123'."\n", + ], + 'Gateway' => [ + 'description' => '运行机器。', + 'type' => 'string', + 'example' => 'cn-shanghai.1.2'."\n", + ], + ], + ], + 'DataSource' => [ + 'description' => '实例关联数据源信息。', + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'description' => '数据源名称。', + 'type' => 'string', + 'example' => 'mysql_test'."\n", + ], + ], + ], + 'Status' => [ + 'title' => '实例运行状态', + 'description' => '实例运行状态。'."\n" + .'- NotRun：未运行'."\n" + .'- Running：运行中'."\n" + .'- WaitTime：等待TriggerTime到来'."\n" + .'- CheckingCondition：分支条件检验'."\n" + .'- WaitResource：等待资源'."\n" + .'- Failure：执行失败'."\n" + .'- Success：执行成功'."\n" + .'- Checking：下发给数据质量校检'."\n" + .'- WaitTrigger（等待外部触发，触发式节点会在等待时间后变成等待触发）', + 'type' => 'string', + 'enumValueTitles' => [], + 'example' => 'Success', + ], + 'TriggerTime' => [ + 'description' => '定时触发时间。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1710239005403'."\n", + ], + 'Bizdate' => [ + 'description' => '业务日期。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1710239005403'."\n", + ], + 'StartedTime' => [ + 'description' => '开始运行时间。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1710239005403'."\n", + ], + 'FinishedTime' => [ + 'description' => '完成时间。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1710239005403'."\n", + ], + 'Id' => [ + 'description' => '任务实例的唯一标识符。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1234'."\n", + ], + 'ProjectId' => [ + 'description' => '项目ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '100', + ], + 'ProjectEnv' => [ + 'description' => '项目环境。'."\n" + .'- Prod：生产'."\n" + .'- Dev：开发', + 'type' => 'string', + 'enumValueTitles' => [], + 'example' => 'Prod', + ], + 'Owner' => [ + 'description' => '任务的责任人的账号ID。', + 'type' => 'string', + 'example' => '1000', + ], + 'CreateTime' => [ + 'description' => '创建时间。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1710239005403'."\n", + ], + 'ModifyTime' => [ + 'description' => '修改时间。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1710239005403'."\n", + ], + 'CreateUser' => [ + 'description' => '创建用户的账号ID。', + 'type' => 'string', + 'example' => '1000', + ], + 'ModifyUser' => [ + 'description' => '修改用户的账号ID。', + 'type' => 'string', + 'example' => '1000', + ], + 'ScriptParameters' => [ + 'description' => '脚本参数列表。', + 'type' => 'string', + 'example' => 'para1=val1 para2=val2', + ], + 'WaitingResourceTime' => [ + 'description' => '进入等资源的时刻。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1710239005403', + ], + 'WaitingTriggerTime' => [ + 'description' => '进入等定时时间的时刻。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1710239005403', + ], + ], + ], + ], + 'TotalCount' => [ + 'description' => '数据总条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '100', + ], + 'PageSize' => [ + 'description' => '每页的条目数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'PageNumber' => [ + 'description' => '页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"22C97E95-F023-56B5-8852-B1A77A17XXXX\\",\\n \\"PagingInfo\\": {\\n \\"TaskInstances\\": [\\n {\\n \\"TaskId\\": 1234,\\n \\"TaskType\\": \\"ODPS_SQL\\\\n\\",\\n \\"TaskName\\": \\"SQL node\\\\n\\",\\n \\"Description\\": \\"test\\\\n\\",\\n \\"WorkflowId\\": 1234,\\n \\"WorkflowName\\": \\"Test workflow\\\\n\\",\\n \\"TriggerType\\": \\"Scheduler\\\\n\\",\\n \\"TriggerRecurrence\\": \\"Normal\\\\n\\",\\n \\"WorkflowInstanceId\\": 1234,\\n \\"UnifiedWorkflowInstanceId\\": 1234,\\n \\"WorkflowInstanceType\\": \\"Normal\\",\\n \\"Timeout\\": 3600,\\n \\"RerunMode\\": \\"AllAllowed\\\\n\\",\\n \\"RunNumber\\": 1,\\n \\"PeriodNumber\\": 1,\\n \\"BaselineId\\": 1234,\\n \\"Priority\\": 1,\\n \\"RuntimeResource\\": {\\n \\"ResourceGroupId\\": \\"S_res_group_524258031846018_1684XXXXXXXXX\\",\\n \\"Image\\": \\"i-xxxxxx\\\\n\\",\\n \\"Cu\\": \\"0.25\\\\n\\"\\n },\\n \\"Runtime\\": {\\n \\"ProcessId\\": \\"T3_123\\\\n\\",\\n \\"Gateway\\": \\"cn-shanghai.1.2\\\\n\\"\\n },\\n \\"DataSource\\": {\\n \\"Name\\": \\"mysql_test\\\\n\\"\\n },\\n \\"Status\\": \\"Success\\",\\n \\"TriggerTime\\": 1710239005403,\\n \\"Bizdate\\": 1710239005403,\\n \\"StartedTime\\": 1710239005403,\\n \\"FinishedTime\\": 1710239005403,\\n \\"Id\\": 1234,\\n \\"ProjectId\\": 100,\\n \\"ProjectEnv\\": \\"Prod\\",\\n \\"Owner\\": \\"1000\\",\\n \\"CreateTime\\": 1710239005403,\\n \\"ModifyTime\\": 1710239005403,\\n \\"CreateUser\\": \\"1000\\",\\n \\"ModifyUser\\": \\"1000\\",\\n \\"ScriptParameters\\": \\"para1=val1 para2=val2\\",\\n \\"WaitingResourceTime\\": 1710239005403,\\n \\"WaitingTriggerTime\\": 1710239005403\\n }\\n ],\\n \\"TotalCount\\": 100,\\n \\"PageSize\\": 10,\\n \\"PageNumber\\": 1\\n }\\n}","type":"json"}]', + 'title' => '获取任务实例列表', + 'description' => '需要购买DataWorks基础版及以上版本才能使用。', + ], + 'ListUpstreamTaskInstances' => [ + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '240661', + 'abilityTreeNodes' => [ + 'FEATUREdide7WF1GB', + 'FEATUREdideD0YY7B', + 'FEATUREdideVFMENL', + ], + ], + 'parameters' => [ + [ + 'name' => 'Id', + 'in' => 'query', + 'schema' => [ + 'description' => '任务实例ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1234', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '每页的条目数，默认为10。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '页码，从1开始，默认为1。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求的ID，用于定位日志，排查问题。', + 'type' => 'string', + 'example' => '22C97E95-F023-56B5-8852-B1A77A17XXXX'."\n", + ], + 'PagingInfo' => [ + 'description' => '分页信息。', + 'type' => 'object', + 'properties' => [ + 'TaskInstances' => [ + 'description' => '任务实例列表。该字段已废弃，请使用UpstreamTaskInstances。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'StepType' => [ + 'title' => '依赖类型', + 'description' => '依赖类型。'."\n" + .'- Normal：同周期依赖'."\n" + .'- CrossCycle：跨周期依赖', + 'type' => 'string', + 'example' => 'Normal', + ], + 'TaskId' => [ + 'description' => '对应任务的ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1234', + ], + 'TaskType' => [ + 'title' => '任务类型', + 'description' => '对应任务的类型。', + 'type' => 'string', + 'example' => 'ODPS_SQL'."\n", + ], + 'TaskName' => [ + 'description' => '对应任务的名称。', + 'type' => 'string', + 'example' => 'SQL node'."\n", + ], + 'Description' => [ + 'description' => '描述信息。', + 'type' => 'string', + 'example' => 'test', + ], + 'WorkflowId' => [ + 'description' => '所属工作流的ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1234', + ], + 'WorkflowName' => [ + 'description' => '所属工作流的名称。', + 'type' => 'string', + 'example' => 'Test workflow', + ], + 'TriggerType' => [ + 'description' => '触发方式类型。'."\n" + .'- Scheduler：调度周期触发'."\n" + .'- Manual：手动触发', + 'type' => 'string', + 'enumValueTitles' => [], + 'example' => 'Scheduler', + ], + 'TriggerRecurrence' => [ + 'description' => '触发时的运行模式。TriggerType=Scheduler时生效。'."\n" + .'- Pause：暂停'."\n" + .'- Skip：空跑'."\n" + .'- Normal：正常运行', + 'type' => 'string', + 'enumValueTitles' => [], + 'example' => 'Normal'."\n", + ], + 'WorkflowInstanceId' => [ + 'description' => '所属工作流实例的ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1234', + ], + 'WorkflowInstanceType' => [ + 'description' => '所属工作流实例的类型。'."\n" + .'- SmokeTest：测试'."\n" + .'- SupplementData：补数据'."\n" + .'- Manual：手动'."\n" + .'- ManualWorkflow：手动工作流'."\n" + .'- Normal：周期调度'."\n" + .'- ManualFlow：手动执行的业务流程', + 'type' => 'string', + 'enumValueTitles' => [], + 'example' => 'Normal'."\n", + ], + 'Timeout' => [ + 'description' => '任务执行超时时间，单位为秒。'."\n" + ."\n" + .'注意：调度系统会对任务的设定值按小时取整。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '3600', + ], + 'RerunMode' => [ + 'title' => '任务是否允许重跑的配置', + 'description' => '任务是否允许重跑的配置。'."\n" + .'- AllDenied：失败或成功都不可重跑'."\n" + .'- FailureAllowed：只有失败可重跑'."\n" + .'- AllAllowed：失败或成功均可重跑', + 'type' => 'string', + 'enumValueTitles' => [], + 'example' => 'AllAllowed'."\n", + ], + 'RunNumber' => [ + 'description' => '当前运行的次数，默认从1开始。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PeriodNumber' => [ + 'description' => '周期序号。表示任务实例处于当天的第几轮周期。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'BaselineId' => [ + 'description' => '基线ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1234', + ], + 'Priority' => [ + 'description' => '任务运行优先级，最小值1，最大值8。取值越大，优先级越高。默认优先级为1。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'RuntimeResource' => [ + 'description' => '运行环境配置，如资源组信息。', + 'type' => 'object', + 'properties' => [ + 'ResourceGroupId' => [ + 'description' => '任务运行配置的调度资源组标识符。', + 'type' => 'string', + 'example' => 'S_res_group_524258031846018_1684XXXXXXXXX'."\n", + ], + 'Image' => [ + 'description' => '任务运行配置的镜像ID。', + 'type' => 'string', + 'example' => 'i-xxxxxx'."\n", + ], + 'Cu' => [ + 'description' => '任务运行配置CU消耗。', + 'type' => 'string', + 'example' => '0.25', + ], + ], + ], + 'Runtime' => [ + 'description' => '实例运行时信息。', + 'type' => 'object', + 'properties' => [ + 'ProcessId' => [ + 'description' => '运行唯一ID。', + 'type' => 'string', + 'example' => 'T3_123', + ], + 'Gateway' => [ + 'description' => '运行机器。', + 'type' => 'string', + 'example' => 'cn-shanghai.1.2', + ], + ], + ], + 'DataSource' => [ + 'description' => '实例关联数据源信息。', + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'description' => '数据源名称。', + 'type' => 'string', + 'example' => 'mysql_test', + ], + ], + ], + 'Status' => [ + 'title' => '实例运行状态', + 'description' => '实例运行状态。'."\n" + .'- NotRun：未运行'."\n" + .'- Running：运行中'."\n" + .'- WaitTime：等待TriggerTime到来'."\n" + .'- CheckingCondition：分支条件检验'."\n" + .'- WaitResource：等待资源'."\n" + .'- Failure：执行失败'."\n" + .'- Success：执行成功'."\n" + .'- Checking：下发给数据质量校检', + 'type' => 'string', + 'enumValueTitles' => [], + 'example' => 'Success'."\n", + ], + 'TriggerTime' => [ + 'description' => '定时触发时间。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1710239005403', + ], + 'Bizdate' => [ + 'description' => '业务日期。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1710239005403', + ], + 'StartedTime' => [ + 'description' => '开始运行时间。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1710239005403', + ], + 'FinishedTime' => [ + 'description' => '完成时间。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1710239005403', + ], + 'Id' => [ + 'description' => '任务实例的唯一标识符。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1234', + ], + 'ProjectId' => [ + 'description' => '项目ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '100', + ], + 'ProjectEnv' => [ + 'description' => '项目环境。'."\n" + .'- Prod：生产'."\n" + .'- Dev：开发', + 'type' => 'string', + 'deprecated' => true, + 'enumValueTitles' => [], + 'example' => 'Prod'."\n", + ], + 'EnvType' => [ + 'description' => '项目环境。'."\n" + .'- Prod：生产'."\n" + .'- Dev：开发', + 'type' => 'string', + 'example' => 'Prod', + ], + 'Owner' => [ + 'description' => '任务的责任人的账号ID。', + 'type' => 'string', + 'example' => '1000', + ], + 'CreateTime' => [ + 'description' => '创建时间。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1710239005403', + ], + 'ModifyTime' => [ + 'description' => '修改时间。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1710239005403', + ], + 'CreateUser' => [ + 'description' => '创建用户的账号ID。', + 'type' => 'string', + 'example' => '1000', + ], + 'ModifyUser' => [ + 'description' => '修改用户的账号ID。', + 'type' => 'string', + 'example' => '1000', + ], + ], + ], + ], + 'UpstreamTaskInstances' => [ + 'description' => '上游任务实例列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'DependencyType' => [ + 'title' => '依赖类型', + 'description' => '依赖类型。'."\n" + .'- Normal：同周期依赖'."\n" + .'- CrossCycle：跨周期依赖', + 'type' => 'string', + 'example' => 'Normal', + ], + 'TaskInstance' => [ + 'title' => '任务实例', + 'description' => '任务实例的详细信息。', + 'type' => 'object', + 'properties' => [ + 'TaskId' => [ + 'description' => '对应任务的ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1234', + ], + 'TaskType' => [ + 'title' => '任务类型', + 'description' => '对应任务的类型。', + 'type' => 'string', + 'example' => 'ODPS_SQL', + ], + 'TaskName' => [ + 'description' => '对应任务的名称。', + 'type' => 'string', + 'example' => 'SQL node', + ], + 'Description' => [ + 'description' => '描述信息。', + 'type' => 'string', + 'example' => 'test', + ], + 'WorkflowId' => [ + 'description' => '所属工作流的ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1234', + ], + 'WorkflowName' => [ + 'description' => '所属工作流的名称。', + 'type' => 'string', + 'example' => 'Test workflow', + ], + 'TriggerType' => [ + 'description' => '触发方式类型。'."\n" + .'- Scheduler：调度周期触发'."\n" + .'- Manual：手动触发', + 'type' => 'string', + 'example' => 'Scheduler', + ], + 'TriggerRecurrence' => [ + 'description' => '触发时的运行模式。TriggerType=Scheduler时生效。'."\n" + .'- Pause：暂停'."\n" + .'- Skip：空跑'."\n" + .'- Normal：正常运行', + 'type' => 'string', + 'example' => 'Normal', + ], + 'WorkflowInstanceId' => [ + 'description' => '所属工作流实例的ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1234', + ], + 'WorkflowInstanceType' => [ + 'description' => '所属工作流实例的类型。'."\n" + .'- Normal：周期调度'."\n" + .'- Manual：手动任务'."\n" + .'- SmokeTest：测试'."\n" + .'- SupplementData：补数据'."\n" + .'- ManualWorkflow：手动工作流', + 'type' => 'string', + 'example' => 'Normal', + ], + 'Timeout' => [ + 'description' => '任务执行超时时间，单位为秒。'."\n" + ."\n" + .'注意：调度系统会对任务的设定值按小时取整。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '3600', + ], + 'RerunMode' => [ + 'title' => '任务是否允许重跑的配置', + 'description' => '任务是否允许重跑的配置。', + 'type' => 'string', + 'example' => 'AllAllowed', + ], + 'RunNumber' => [ + 'description' => '当前运行的次数，默认从1开始。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PeriodNumber' => [ + 'description' => '周期序号。表示任务实例处于当天的第几轮周期。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'BaselineId' => [ + 'description' => '基线ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1234', + ], + 'Priority' => [ + 'description' => '任务运行优先级，最小值1，最大值8。取值越大，优先级越高。默认优先级为1。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'RuntimeResource' => [ + 'description' => '运行环境配置，如资源组信息。', + 'type' => 'object', + 'properties' => [ + 'ResourceGroupId' => [ + 'description' => '任务运行配置的调度资源组标识符。', + 'type' => 'string', + 'example' => 'S_res_group_524258031846018_1684XXXXXXXXX', + ], + 'Image' => [ + 'description' => '任务运行配置的镜像ID。', + 'type' => 'string', + 'example' => 'i-xxxxxx', + ], + 'Cu' => [ + 'description' => '任务运行配置CU消耗。', + 'type' => 'string', + 'example' => '0.25', + ], + ], + ], + 'Runtime' => [ + 'description' => '实例运行时信息。', + 'type' => 'object', + 'properties' => [ + 'ProcessId' => [ + 'description' => '运行唯一ID。', + 'type' => 'string', + 'example' => 'T3_123', + ], + 'Gateway' => [ + 'description' => '运行机器。', + 'type' => 'string', + 'example' => 'cn-shanghai.1.2', + ], + ], + ], + 'DataSource' => [ + 'description' => '实例关联数据源信息。', + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'description' => '数据源名称。', + 'type' => 'string', + 'example' => 'mysql_test', + ], + ], + ], + 'Status' => [ + 'title' => '实例运行状态', + 'description' => '实例运行状态。'."\n" + .'- NotRun：未运行'."\n" + .'- Running：运行中'."\n" + .'- WaitTime：等待TriggerTime到来'."\n" + .'- CheckingCondition：分支条件检验'."\n" + .'- WaitResource：等待资源'."\n" + .'- Failure：执行失败'."\n" + .'- Success：执行成功'."\n" + .'- Checking：下发给数据质量校检'."\n" + .'- WaitTrigger：等待外部触发，触发式节点会在等待时间后变成等待触发', + 'type' => 'string', + 'example' => 'Success', + ], + 'TriggerTime' => [ + 'description' => '定时触发时间。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1710239005403', + ], + 'Bizdate' => [ + 'description' => '业务日期。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1710239005403', + ], + 'StartedTime' => [ + 'description' => '开始运行时间。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1710239005403', + ], + 'FinishedTime' => [ + 'description' => '完成时间。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1710239005403', + ], + 'Id' => [ + 'description' => '任务实例的唯一标识符。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1234', + ], + 'ProjectId' => [ + 'description' => '项目ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '100', + ], + 'EnvType' => [ + 'description' => '目标数据源所属的环境。取值如下：'."\n" + .'- Dev：开发环境。'."\n" + .'- Prod：生产环境。', + 'type' => 'string', + 'example' => 'Prod', + ], + 'Owner' => [ + 'description' => '任务的责任人的账号ID。', + 'type' => 'string', + 'example' => '1000', + ], + 'CreateTime' => [ + 'description' => '创建时间。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1710239005403', + ], + 'ModifyTime' => [ + 'description' => '修改时间。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1710239005403', + ], + 'CreateUser' => [ + 'description' => '创建用户的账号ID。', + 'type' => 'string', + 'example' => '1000', + ], + 'ModifyUser' => [ + 'description' => '修改用户的账号ID。', + 'type' => 'string', + 'example' => '1000', + ], + ], + ], + ], + ], + ], + 'TotalCount' => [ + 'description' => '数据总条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '100', + ], + 'PageSize' => [ + 'description' => '每页的条目数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'PageNumber' => [ + 'description' => '页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"22C97E95-F023-56B5-8852-B1A77A17XXXX\\\\n\\",\\n \\"PagingInfo\\": {\\n \\"TaskInstances\\": [\\n {\\n \\"StepType\\": \\"Normal\\",\\n \\"TaskId\\": 1234,\\n \\"TaskType\\": \\"ODPS_SQL\\\\n\\",\\n \\"TaskName\\": \\"SQL node\\\\n\\",\\n \\"Description\\": \\"test\\",\\n \\"WorkflowId\\": 1234,\\n \\"WorkflowName\\": \\"Test workflow\\",\\n \\"TriggerType\\": \\"Scheduler\\",\\n \\"TriggerRecurrence\\": \\"Normal\\\\n\\",\\n \\"WorkflowInstanceId\\": 1234,\\n \\"WorkflowInstanceType\\": \\"Normal\\\\n\\",\\n \\"Timeout\\": 3600,\\n \\"RerunMode\\": \\"AllAllowed\\\\n\\",\\n \\"RunNumber\\": 1,\\n \\"PeriodNumber\\": 1,\\n \\"BaselineId\\": 1234,\\n \\"Priority\\": 1,\\n \\"RuntimeResource\\": {\\n \\"ResourceGroupId\\": \\"S_res_group_524258031846018_1684XXXXXXXXX\\\\n\\",\\n \\"Image\\": \\"i-xxxxxx\\\\n\\",\\n \\"Cu\\": \\"0.25\\"\\n },\\n \\"Runtime\\": {\\n \\"ProcessId\\": \\"T3_123\\",\\n \\"Gateway\\": \\"cn-shanghai.1.2\\"\\n },\\n \\"DataSource\\": {\\n \\"Name\\": \\"mysql_test\\"\\n },\\n \\"Status\\": \\"Success\\\\n\\",\\n \\"TriggerTime\\": 1710239005403,\\n \\"Bizdate\\": 1710239005403,\\n \\"StartedTime\\": 1710239005403,\\n \\"FinishedTime\\": 1710239005403,\\n \\"Id\\": 1234,\\n \\"ProjectId\\": 100,\\n \\"ProjectEnv\\": \\"Prod\\\\n\\",\\n \\"EnvType\\": \\"Prod\\",\\n \\"Owner\\": \\"1000\\",\\n \\"CreateTime\\": 1710239005403,\\n \\"ModifyTime\\": 1710239005403,\\n \\"CreateUser\\": \\"1000\\",\\n \\"ModifyUser\\": \\"1000\\"\\n }\\n ],\\n \\"UpstreamTaskInstances\\": [\\n {\\n \\"DependencyType\\": \\"Normal\\",\\n \\"TaskInstance\\": {\\n \\"TaskId\\": 1234,\\n \\"TaskType\\": \\"ODPS_SQL\\",\\n \\"TaskName\\": \\"SQL node\\",\\n \\"Description\\": \\"test\\",\\n \\"WorkflowId\\": 1234,\\n \\"WorkflowName\\": \\"Test workflow\\",\\n \\"TriggerType\\": \\"Scheduler\\",\\n \\"TriggerRecurrence\\": \\"Normal\\",\\n \\"WorkflowInstanceId\\": 1234,\\n \\"WorkflowInstanceType\\": \\"Normal\\",\\n \\"Timeout\\": 3600,\\n \\"RerunMode\\": \\"AllAllowed\\",\\n \\"RunNumber\\": 1,\\n \\"PeriodNumber\\": 1,\\n \\"BaselineId\\": 1234,\\n \\"Priority\\": 1,\\n \\"RuntimeResource\\": {\\n \\"ResourceGroupId\\": \\"S_res_group_524258031846018_1684XXXXXXXXX\\",\\n \\"Image\\": \\"i-xxxxxx\\",\\n \\"Cu\\": \\"0.25\\"\\n },\\n \\"Runtime\\": {\\n \\"ProcessId\\": \\"T3_123\\",\\n \\"Gateway\\": \\"cn-shanghai.1.2\\"\\n },\\n \\"DataSource\\": {\\n \\"Name\\": \\"mysql_test\\"\\n },\\n \\"Status\\": \\"Success\\",\\n \\"TriggerTime\\": 1710239005403,\\n \\"Bizdate\\": 1710239005403,\\n \\"StartedTime\\": 1710239005403,\\n \\"FinishedTime\\": 1710239005403,\\n \\"Id\\": 1234,\\n \\"ProjectId\\": 100,\\n \\"EnvType\\": \\"Prod\\",\\n \\"Owner\\": \\"1000\\",\\n \\"CreateTime\\": 1710239005403,\\n \\"ModifyTime\\": 1710239005403,\\n \\"CreateUser\\": \\"1000\\",\\n \\"ModifyUser\\": \\"1000\\"\\n }\\n }\\n ],\\n \\"TotalCount\\": 100,\\n \\"PageSize\\": 10,\\n \\"PageNumber\\": 1\\n }\\n}","type":"json"}]', + 'title' => '获取上游任务实例列表', + 'summary' => '分页获取指定任务实例的上游任务实例列表。', + 'description' => '需要购买DataWorks基础版及以上版本才能使用。', + ], + 'ListTaskInstanceOperationLogs' => [ + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '240664', + 'abilityTreeNodes' => [ + 'FEATUREdide7WF1GB', + ], + ], + 'parameters' => [ + [ + 'name' => 'Id', + 'in' => 'query', + 'schema' => [ + 'description' => '任务实例ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1234', + ], + ], + [ + 'name' => 'Date', + 'in' => 'query', + 'schema' => [ + 'description' => '操作日期（精确到天），默认查询当天。支持查询过去31天内的操作日志。格式为时间戳。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1710239005403'."\n", + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '每页的条目数，默认为10。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '页码，从1开始，默认为1。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求的ID，用于定位日志，排查问题。', + 'type' => 'string', + 'example' => '22C97E95-F023-56B5-8852-B1A77A1****'."\n", + ], + 'PagingInfo' => [ + 'description' => '分页信息。', + 'type' => 'object', + 'properties' => [ + 'OperationLogs' => [ + 'description' => '操作日志列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'User' => [ + 'description' => '操作人的账号ID。', + 'type' => 'string', + 'example' => '1000'."\n", + ], + 'CreateTime' => [ + 'description' => '操作日志生成时间。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1710239005403'."\n", + ], + 'OperationSeq' => [ + 'description' => '操作序列号。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1111', + ], + 'OperationContent' => [ + 'description' => '操作内容。', + 'type' => 'string', + 'example' => 'Freeze tasks', + ], + 'TaskInstanceId' => [ + 'description' => '所操作的任务实例Id。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1234', + ], + ], + ], + ], + 'TotalCount' => [ + 'description' => '数据总条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '100'."\n", + ], + 'PageSize' => [ + 'description' => '每页的条目数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10'."\n", + ], + 'PageNumber' => [ + 'description' => '页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"22C97E95-F023-56B5-8852-B1A77A1****\\\\n\\",\\n \\"PagingInfo\\": {\\n \\"OperationLogs\\": [\\n {\\n \\"User\\": \\"1000\\\\n\\",\\n \\"CreateTime\\": 1710239005403,\\n \\"OperationSeq\\": 1111,\\n \\"OperationContent\\": \\"Freeze tasks\\",\\n \\"TaskInstanceId\\": 1234\\n }\\n ],\\n \\"TotalCount\\": 100,\\n \\"PageSize\\": 10,\\n \\"PageNumber\\": 1\\n }\\n}","type":"json"}]', + 'title' => '获取任务实例的操作日志列表', + 'summary' => '分页获取指定任务实例的操作日志列表。', + 'description' => '需要购买DataWorks基础版及以上版本才能使用。'."\n" + ."\n" + .'仅支持查询过去31天内的操作日志。', + ], + 'ListDownstreamTaskInstances' => [ + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '240662', + 'abilityTreeNodes' => [ + 'FEATUREdide7WF1GB', + 'FEATUREdideD0YY7B', + 'FEATUREdideVFMENL', + ], + ], + 'parameters' => [ + [ + 'name' => 'Id', + 'in' => 'query', + 'schema' => [ + 'description' => '任务实例ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1234', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '每页的条目数，默认为10。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '页码，从1开始，默认为1。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求的ID，用于定位日志，排查问题。', + 'type' => 'string', + 'example' => '22C97E95-F023-56B5-8852-B1A77A17XXXX', + ], + 'PagingInfo' => [ + 'description' => '分页信息。', + 'type' => 'object', + 'properties' => [ + 'TaskInstances' => [ + 'description' => '任务实例列表。该字段已废弃，请使用DownstreamTaskInstances。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'StepType' => [ + 'title' => '依赖类型', + 'description' => '依赖类型。'."\n" + .'- Normal：同周期依赖'."\n" + .'- CrossCycle：跨周期依赖', + 'type' => 'string', + 'example' => 'Normal', + ], + 'TaskId' => [ + 'description' => '对应任务的ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1234', + ], + 'TaskType' => [ + 'title' => '任务类型', + 'description' => '对应任务的类型。', + 'type' => 'string', + 'example' => 'ODPS_SQL', + ], + 'TaskName' => [ + 'description' => '对应任务的名称。', + 'type' => 'string', + 'example' => 'SQL node'."\n", + ], + 'Description' => [ + 'description' => '描述信息。', + 'type' => 'string', + 'example' => 'test', + ], + 'WorkflowId' => [ + 'description' => '所属工作流的ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1234', + ], + 'WorkflowName' => [ + 'description' => '所属工作流的名称。', + 'type' => 'string', + 'example' => 'Test workflow', + ], + 'TriggerType' => [ + 'description' => '触发方式类型。', + 'type' => 'string', + 'enumValueTitles' => [ + 'Scheduler' => '调度周期触发', + 'Manual' => '手动触发', + ], + 'example' => 'Scheduler', + ], + 'TriggerRecurrence' => [ + 'description' => '触发时的运行模式。TriggerType=Scheduler时生效。', + 'type' => 'string', + 'enumValueTitles' => [ + 'Pause' => '暂停', + 'Skip' => '空跑', + 'Normal' => '正常运行', + ], + 'example' => 'Normal', + ], + 'WorkflowInstanceId' => [ + 'description' => '所属工作流实例的ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1234', + ], + 'WorkflowInstanceType' => [ + 'description' => '所属工作流实例的类型。', + 'type' => 'string', + 'enumValueTitles' => [ + 'SmokeTest' => '测试', + 'SupplementData' => '补数据', + 'Manual' => '手动', + 'ManualWorkflow' => '手动工作流', + 'Normal' => '周期调度', + 'ManualFlow' => '手动执行的业务流程', + ], + 'example' => 'Normal', + ], + 'Timeout' => [ + 'description' => '任务执行超时时间，单位为秒。'."\n" + ."\n" + .'注意：调度系统会对任务的设定值按小时取整。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '3600', + ], + 'RerunMode' => [ + 'title' => '任务是否允许重跑的配置', + 'description' => '任务是否允许重跑的配置。', + 'type' => 'string', + 'enumValueTitles' => [ + 'AllDenied' => '失败或成功都不可重跑', + 'FailureAllowed' => '只有失败可重跑', + 'AllAllowed' => '失败或成功均可重跑', + ], + 'example' => 'AllAllowed', + ], + 'RunNumber' => [ + 'description' => '当前运行的次数，默认从1开始。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PeriodNumber' => [ + 'description' => '周期序号。表示任务实例处于当天的第几轮周期。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'BaselineId' => [ + 'description' => '基线ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1234', + ], + 'Priority' => [ + 'description' => '任务运行优先级，最小值1，最大值8。取值越大，优先级越高。默认优先级为1。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'RuntimeResource' => [ + 'description' => '实例关联资源组信息。', + 'type' => 'object', + 'properties' => [ + 'ResourceGroupId' => [ + 'description' => '任务运行配置的调度资源组标识符。', + 'type' => 'string', + 'example' => 'S_res_group_524258031846018_1684XXXXXXXXX', + ], + 'Image' => [ + 'description' => '任务运行配置的镜像ID。', + 'type' => 'string', + 'example' => 'i-xxxxxx', + ], + 'Cu' => [ + 'description' => '任务运行配置CU消耗。', + 'type' => 'string', + 'example' => '0.25', + ], + ], + ], + 'Runtime' => [ + 'description' => '实例运行时信息。', + 'type' => 'object', + 'properties' => [ + 'ProcessId' => [ + 'description' => '运行唯一ID。', + 'type' => 'string', + 'example' => 'T3_123'."\n", + ], + 'Gateway' => [ + 'description' => '运行机器。', + 'type' => 'string', + 'example' => 'cn-shanghai.1.2', + ], + ], + ], + 'DataSource' => [ + 'description' => '实例关联数据源信息。', + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'description' => '数据源名称。', + 'type' => 'string', + 'example' => 'mysql_test'."\n", + ], + ], + ], + 'Status' => [ + 'title' => '实例运行状态', + 'description' => '实例运行状态。'."\n" + .'- NotRun：未运行'."\n" + .'- Running：运行中'."\n" + .'- WaitTime：等待TriggerTime到来'."\n" + .'- CheckingCondition：分支条件检验'."\n" + .'- WaitResource：等待资源'."\n" + .'- Failure：执行失败'."\n" + .'- Success：执行成功'."\n" + .'- Checking：下发给数据质量校检'."\n" + .'- WaitTrigger：等待外部触发，触发式节点会在等待时间后变成等待触发', + 'type' => 'string', + 'enumValueTitles' => [], + 'example' => 'Success', + ], + 'TriggerTime' => [ + 'description' => '定时触发时间。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1710239005403'."\n", + ], + 'Bizdate' => [ + 'description' => '业务日期。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1710239005403'."\n", + ], + 'StartedTime' => [ + 'description' => '开始运行时间。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1710239005403'."\n", + ], + 'FinishedTime' => [ + 'description' => '完成时间。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1710239005403'."\n", + ], + 'Id' => [ + 'description' => '任务实例的唯一标识符。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1234', + ], + 'ProjectId' => [ + 'description' => '项目ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '100', + ], + 'ProjectEnv' => [ + 'description' => '项目环境。该字段已废弃，请使用EnvType。', + 'type' => 'string', + 'deprecated' => true, + 'enumValueTitles' => [], + 'example' => 'Prod', + ], + 'EnvType' => [ + 'description' => '目标数据源所属的环境。取值如下：'."\n" + .'- Dev：开发环境。'."\n" + .'- Prod：生产环境。', + 'type' => 'string', + 'example' => 'Prod', + ], + 'Owner' => [ + 'description' => '任务的责任人的账号ID。', + 'type' => 'string', + 'example' => '100', + ], + 'CreateTime' => [ + 'description' => '创建时间。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1710239005403'."\n", + ], + 'ModifyTime' => [ + 'description' => '修改时间。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1710239005403'."\n", + ], + 'CreateUser' => [ + 'description' => '创建用户的账号ID。', + 'type' => 'string', + 'example' => '1000'."\n", + ], + 'ModifyUser' => [ + 'description' => '修改用户的账号ID。', + 'type' => 'string', + 'example' => '1000'."\n", + ], + ], + ], + ], + 'DownstreamTaskInstances' => [ + 'description' => '下游任务实例列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'DependencyType' => [ + 'title' => '依赖类型', + 'description' => '依赖类型。'."\n" + .'- Normal：同周期依赖'."\n" + .'- CrossCycle：跨周期依赖', + 'type' => 'string', + 'example' => 'Normal', + ], + 'TaskInstance' => [ + 'title' => '任务实例', + 'description' => '任务实例', + 'type' => 'object', + 'properties' => [ + 'TaskId' => [ + 'description' => '对应任务的ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1234', + ], + 'TaskType' => [ + 'title' => '任务类型', + 'description' => '对应任务的类型。', + 'type' => 'string', + 'example' => 'ODPS_SQL', + ], + 'TaskName' => [ + 'description' => '对应任务的名称。', + 'type' => 'string', + 'example' => 'SQL node', + ], + 'Description' => [ + 'description' => '描述信息。', + 'type' => 'string', + 'example' => 'test', + ], + 'WorkflowId' => [ + 'description' => '所属工作流的ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1234', + ], + 'WorkflowName' => [ + 'description' => '所属工作流的名称。', + 'type' => 'string', + 'example' => 'Test workflow', + ], + 'TriggerType' => [ + 'description' => '触发方式类型。'."\n" + .'- Scheduler：调度周期触发'."\n" + .'- Manual：手动触发', + 'type' => 'string', + 'example' => 'Scheduler', + ], + 'TriggerRecurrence' => [ + 'description' => '触发时的运行模式，TriggerType=Scheduler时生效。'."\n" + .'- Pause：暂停'."\n" + .'- Skip：空跑'."\n" + .'- Normal：正常运行', + 'type' => 'string', + 'example' => 'Normal', + ], + 'WorkflowInstanceId' => [ + 'description' => '所属工作流实例的ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1234', + ], + 'WorkflowInstanceType' => [ + 'description' => '所属工作流实例的类型。'."\n" + .'- Normal：周期调度'."\n" + .'- Manual：手动任务'."\n" + .'- SmokeTest：测试'."\n" + .'- SupplementData：补数据'."\n" + .'- ManualWorkflow：手动工作流', + 'type' => 'string', + 'example' => 'Normal', + ], + 'Timeout' => [ + 'description' => '任务执行超时时间，单位为秒。'."\n" + ."\n" + .'注意：调度系统会对任务的设定值按小时取整。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '3600', + ], + 'RerunMode' => [ + 'title' => '任务是否允许重跑的配置', + 'description' => '任务是否允许重跑的配置。', + 'type' => 'string', + 'example' => 'AllAllowed', + ], + 'RunNumber' => [ + 'description' => '当前运行的次数，默认从1开始。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PeriodNumber' => [ + 'description' => '周期序号。表示任务实例处于当天的第几轮周期。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'BaselineId' => [ + 'description' => '基线ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1234', + ], + 'Priority' => [ + 'description' => '任务运行优先级，最小值1，最大值8。取值越大，优先级越高。默认优先级为1。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'RuntimeResource' => [ + 'description' => '运行环境配置，如资源组信息。', + 'type' => 'object', + 'properties' => [ + 'ResourceGroupId' => [ + 'description' => '任务运行配置的调度资源组标识符。', + 'type' => 'string', + 'example' => 'S_res_group_524258031846018_1684XXXXXXXXX', + ], + 'Image' => [ + 'description' => '任务运行配置的镜像ID。', + 'type' => 'string', + 'example' => 'i-xxxxxx', + ], + 'Cu' => [ + 'description' => '任务运行配置CU消耗。', + 'type' => 'string', + 'example' => '0.25', + ], + ], + ], + 'Runtime' => [ + 'description' => '实例运行时信息。', + 'type' => 'object', + 'properties' => [ + 'ProcessId' => [ + 'description' => '运行唯一ID。', + 'type' => 'string', + 'example' => 'T3_123', + ], + 'Gateway' => [ + 'description' => '运行机器。', + 'type' => 'string', + 'example' => 'cn-shanghai.1.2', + ], + ], + ], + 'DataSource' => [ + 'description' => '实例关联数据源信息。', + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'description' => '数据源名称。', + 'type' => 'string', + 'example' => 'mysql_test', + ], + ], + ], + 'Status' => [ + 'title' => '实例运行状态', + 'description' => '实例运行状态。'."\n" + .'- NotRun：未运行'."\n" + .'- Running：运行中'."\n" + .'- WaitTime：等待TriggerTime到来'."\n" + .'- CheckingCondition：分支条件检验'."\n" + .'- WaitResource：等待资源'."\n" + .'- Failure：执行失败'."\n" + .'- Success：执行成功'."\n" + .'- Checking：下发给数据质量校检'."\n" + .'- WaitTrigger：等待外部触发，触发式节点会在等待时间后变成等待触发', + 'type' => 'string', + 'example' => 'Success', + ], + 'TriggerTime' => [ + 'description' => '定时触发时间。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1710239005403', + ], + 'Bizdate' => [ + 'description' => '业务日期。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1710239005403', + ], + 'StartedTime' => [ + 'description' => '开始运行时间。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1710239005403', + ], + 'FinishedTime' => [ + 'description' => '完成时间。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1710239005403', + ], + 'Id' => [ + 'description' => '任务实例的唯一标识符。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1234', + ], + 'ProjectId' => [ + 'description' => '项目ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '100', + ], + 'EnvType' => [ + 'description' => '目标数据源所属的环境。取值如下：'."\n" + .'- Dev：开发环境。'."\n" + .'- Prod：生产环境。', + 'type' => 'string', + 'example' => 'Prod', + ], + 'Owner' => [ + 'description' => '任务的责任人的账号ID。', + 'type' => 'string', + 'example' => '1000', + ], + 'CreateTime' => [ + 'description' => '创建时间。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1710239005403', + ], + 'ModifyTime' => [ + 'description' => '修改时间。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1710239005403', + ], + 'CreateUser' => [ + 'description' => '创建用户的账号ID。', + 'type' => 'string', + 'example' => '1000', + ], + 'ModifyUser' => [ + 'description' => '修改用户的账号ID。', + 'type' => 'string', + 'example' => '1000', + ], + ], + ], + ], + ], + ], + 'TotalCount' => [ + 'description' => '数据总条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '100', + ], + 'PageSize' => [ + 'description' => '每页的条目数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'PageNumber' => [ + 'description' => '页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"22C97E95-F023-56B5-8852-B1A77A17XXXX\\",\\n \\"PagingInfo\\": {\\n \\"TaskInstances\\": [\\n {\\n \\"StepType\\": \\"Normal\\",\\n \\"TaskId\\": 1234,\\n \\"TaskType\\": \\"ODPS_SQL\\",\\n \\"TaskName\\": \\"SQL node\\\\n\\",\\n \\"Description\\": \\"test\\",\\n \\"WorkflowId\\": 1234,\\n \\"WorkflowName\\": \\"Test workflow\\",\\n \\"TriggerType\\": \\"Scheduler\\",\\n \\"TriggerRecurrence\\": \\"Normal\\",\\n \\"WorkflowInstanceId\\": 1234,\\n \\"WorkflowInstanceType\\": \\"Normal\\",\\n \\"Timeout\\": 3600,\\n \\"RerunMode\\": \\"AllAllowed\\",\\n \\"RunNumber\\": 1,\\n \\"PeriodNumber\\": 1,\\n \\"BaselineId\\": 1234,\\n \\"Priority\\": 1,\\n \\"RuntimeResource\\": {\\n \\"ResourceGroupId\\": \\"S_res_group_524258031846018_1684XXXXXXXXX\\",\\n \\"Image\\": \\"i-xxxxxx\\",\\n \\"Cu\\": \\"0.25\\"\\n },\\n \\"Runtime\\": {\\n \\"ProcessId\\": \\"T3_123\\\\n\\",\\n \\"Gateway\\": \\"cn-shanghai.1.2\\"\\n },\\n \\"DataSource\\": {\\n \\"Name\\": \\"mysql_test\\\\n\\"\\n },\\n \\"Status\\": \\"Success\\",\\n \\"TriggerTime\\": 1710239005403,\\n \\"Bizdate\\": 1710239005403,\\n \\"StartedTime\\": 1710239005403,\\n \\"FinishedTime\\": 1710239005403,\\n \\"Id\\": 1234,\\n \\"ProjectId\\": 100,\\n \\"ProjectEnv\\": \\"Prod\\",\\n \\"EnvType\\": \\"Prod\\",\\n \\"Owner\\": \\"100\\",\\n \\"CreateTime\\": 1710239005403,\\n \\"ModifyTime\\": 1710239005403,\\n \\"CreateUser\\": \\"1000\\\\n\\",\\n \\"ModifyUser\\": \\"1000\\\\n\\"\\n }\\n ],\\n \\"DownstreamTaskInstances\\": [\\n {\\n \\"DependencyType\\": \\"Normal\\",\\n \\"TaskInstance\\": {\\n \\"TaskId\\": 1234,\\n \\"TaskType\\": \\"ODPS_SQL\\",\\n \\"TaskName\\": \\"SQL node\\",\\n \\"Description\\": \\"test\\",\\n \\"WorkflowId\\": 1234,\\n \\"WorkflowName\\": \\"Test workflow\\",\\n \\"TriggerType\\": \\"Scheduler\\",\\n \\"TriggerRecurrence\\": \\"Normal\\",\\n \\"WorkflowInstanceId\\": 1234,\\n \\"WorkflowInstanceType\\": \\"Normal\\",\\n \\"Timeout\\": 3600,\\n \\"RerunMode\\": \\"AllAllowed\\",\\n \\"RunNumber\\": 1,\\n \\"PeriodNumber\\": 1,\\n \\"BaselineId\\": 1234,\\n \\"Priority\\": 1,\\n \\"RuntimeResource\\": {\\n \\"ResourceGroupId\\": \\"S_res_group_524258031846018_1684XXXXXXXXX\\",\\n \\"Image\\": \\"i-xxxxxx\\",\\n \\"Cu\\": \\"0.25\\"\\n },\\n \\"Runtime\\": {\\n \\"ProcessId\\": \\"T3_123\\",\\n \\"Gateway\\": \\"cn-shanghai.1.2\\"\\n },\\n \\"DataSource\\": {\\n \\"Name\\": \\"mysql_test\\"\\n },\\n \\"Status\\": \\"Success\\",\\n \\"TriggerTime\\": 1710239005403,\\n \\"Bizdate\\": 1710239005403,\\n \\"StartedTime\\": 1710239005403,\\n \\"FinishedTime\\": 1710239005403,\\n \\"Id\\": 1234,\\n \\"ProjectId\\": 100,\\n \\"EnvType\\": \\"Prod\\",\\n \\"Owner\\": \\"1000\\",\\n \\"CreateTime\\": 1710239005403,\\n \\"ModifyTime\\": 1710239005403,\\n \\"CreateUser\\": \\"1000\\",\\n \\"ModifyUser\\": \\"1000\\"\\n }\\n }\\n ],\\n \\"TotalCount\\": 100,\\n \\"PageSize\\": 10,\\n \\"PageNumber\\": 1\\n }\\n}","type":"json"}]', + 'title' => '获取下游任务实例列表', + 'summary' => '分页获取指定任务实例的下游任务实例列表。', + 'description' => '需要购买DataWorks基础版及以上版本才能使用。', + ], + 'SuspendTaskInstances' => [ + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '244303', + 'abilityTreeNodes' => [ + 'FEATUREdide7WF1GB', + ], + ], + 'parameters' => [ + [ + 'name' => 'Ids', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'description' => '任务实例ID列表。', + 'type' => 'array', + 'items' => [ + 'description' => '任务实例ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1234', + ], + 'required' => false, + 'maxItems' => 100, + ], + ], + [ + 'name' => 'Comment', + 'in' => 'formData', + 'schema' => [ + 'description' => '备注信息。', + 'type' => 'string', + 'required' => false, + 'example' => 'this is a comment', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求的ID，用于定位日志，排查问题。', + 'type' => 'string', + 'example' => '22C97E95-F023-56B5-8852-B1A77A17****'."\n", + ], + 'SuccessInfo' => [ + 'description' => '批量操作的结果信息。结构为Map，以任务实例ID为键，以结果信息为Value。', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'object', + 'properties' => [ + 'Success' => [ + 'type' => 'boolean', + 'description' => '操作是否成功。', + 'example' => 'true', + ], + 'Message' => [ + 'type' => 'string', + 'example' => 'The instance does not exist.', + 'description' => '错误信息。', + ], + ], + 'description' => '结果信息。', + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"22C97E95-F023-56B5-8852-B1A77A17****\\\\n\\",\\n \\"SuccessInfo\\": {\\n \\"key\\": {\\n \\"Success\\": true,\\n \\"Message\\": \\"The instance does not exist.\\"\\n }\\n }\\n}","type":"json"}]', + 'title' => '暂停任务实例', + 'summary' => '批量暂停多个任务实例。', + 'description' => '需要购买DataWorks基础版及以上版本才能使用。', + ], + 'ResumeTaskInstances' => [ + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '244302', + 'abilityTreeNodes' => [ + 'FEATUREdide7WF1GB', + ], + ], + 'parameters' => [ + [ + 'name' => 'Ids', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'description' => '任务实例ID列表。', + 'type' => 'array', + 'items' => [ + 'description' => '任务实例ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1234', + ], + 'required' => false, + 'maxItems' => 100, + ], + ], + [ + 'name' => 'Comment', + 'in' => 'formData', + 'schema' => [ + 'description' => '备注信息。', + 'type' => 'string', + 'required' => false, + 'example' => 'this is a comment'."\n", + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求的ID，用于定位日志，排查问题。', + 'type' => 'string', + 'example' => '22C97E95-F023-56B5-8852-B1A77A17****', + ], + 'SuccessInfo' => [ + 'description' => '批量操作的结果信息。结构为Map，以任务实例ID为键，以结果信息为Value。', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'object', + 'properties' => [ + 'Success' => [ + 'type' => 'boolean', + 'description' => '操作是否成功。', + 'example' => 'true', + ], + 'Message' => [ + 'type' => 'string', + 'example' => 'The instance does not exist.'."\n", + 'description' => '错误信息。', + ], + ], + 'description' => '结果信息。', + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"22C97E95-F023-56B5-8852-B1A77A17****\\",\\n \\"SuccessInfo\\": {\\n \\"key\\": {\\n \\"Success\\": true,\\n \\"Message\\": \\"The instance does not exist.\\\\n\\"\\n }\\n }\\n}","type":"json"}]', + 'title' => '恢复任务实例', + 'summary' => '批量恢复多个已暂停的任务实例。', + 'description' => '需要购买DataWorks基础版及以上版本才能使用。', + ], + 'StopTaskInstances' => [ + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '244301', + 'abilityTreeNodes' => [ + 'FEATUREdide7WF1GB', + ], + ], + 'parameters' => [ + [ + 'name' => 'Ids', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'description' => '任务实例ID列表。', + 'type' => 'array', + 'items' => [ + 'description' => '任务实例ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1234', + ], + 'required' => false, + 'maxItems' => 100, + ], + ], + [ + 'name' => 'Comment', + 'in' => 'formData', + 'schema' => [ + 'description' => '备注信息。', + 'type' => 'string', + 'required' => false, + 'example' => 'this is a comment'."\n", + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求的ID，用于定位日志，排查问题。', + 'type' => 'string', + 'example' => '22C97E95-F023-56B5-8852-B1A77A17****', + ], + 'SuccessInfo' => [ + 'description' => '批量操作的结果信息。结构为Map，以任务实例ID为键，以结果信息为Value。', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'object', + 'properties' => [ + 'Success' => [ + 'type' => 'boolean', + 'description' => '操作是否成功。', + 'example' => 'true', + ], + 'Message' => [ + 'type' => 'string', + 'example' => 'The instance does not exist.', + 'description' => '错误信息。', + ], + ], + 'description' => '结果信息。', + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"22C97E95-F023-56B5-8852-B1A77A17****\\",\\n \\"SuccessInfo\\": {\\n \\"key\\": {\\n \\"Success\\": true,\\n \\"Message\\": \\"The instance does not exist.\\"\\n }\\n }\\n}","type":"json"}]', + 'title' => '终止任务实例', + 'summary' => '批量终止多个任务实例。', + 'description' => '需要购买DataWorks基础版及以上版本才能使用。', + ], + 'SetSuccessTaskInstances' => [ + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '244304', + 'abilityTreeNodes' => [ + 'FEATUREdide7WF1GB', + ], + ], + 'parameters' => [ + [ + 'name' => 'Ids', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'description' => '任务实例ID列表。', + 'type' => 'array', + 'items' => [ + 'description' => '任务实例ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1234', + ], + 'required' => false, + 'maxItems' => 100, + ], + ], + [ + 'name' => 'Comment', + 'in' => 'formData', + 'schema' => [ + 'description' => '备注信息。', + 'type' => 'string', + 'required' => false, + 'example' => 'this is a comment'."\n", + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求的ID，用于定位日志，排查问题。', + 'type' => 'string', + 'example' => '22C97E95-F023-56B5-8852-B1A77A17****', + ], + 'SuccessInfo' => [ + 'description' => '批量操作的结果信息。结构为Map，以任务实例ID为键，以结果信息为Value。', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'object', + 'properties' => [ + 'Success' => [ + 'type' => 'boolean', + 'description' => '操作是否成功。', + 'example' => 'true', + ], + 'Message' => [ + 'type' => 'string', + 'example' => 'The instance does not exist.', + 'description' => '错误信息。', + ], + ], + 'description' => '结果信息。', + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"22C97E95-F023-56B5-8852-B1A77A17****\\",\\n \\"SuccessInfo\\": {\\n \\"key\\": {\\n \\"Success\\": true,\\n \\"Message\\": \\"The instance does not exist.\\"\\n }\\n }\\n}","type":"json"}]', + 'title' => '置成功任务实例', + 'summary' => '批量置成功多个任务实例。', + 'description' => '需要购买DataWorks基础版及以上版本才能使用。', + ], + 'RerunTaskInstances' => [ + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '244270', + 'abilityTreeNodes' => [ + 'FEATUREdide7WF1GB', + ], + ], + 'parameters' => [ + [ + 'name' => 'Ids', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'description' => '任务实例ID列表。', + 'type' => 'array', + 'items' => [ + 'description' => '任务实例ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1234', + ], + 'required' => false, + 'maxItems' => 100, + ], + ], + [ + 'name' => 'Comment', + 'in' => 'formData', + 'schema' => [ + 'description' => '备注信息。', + 'type' => 'string', + 'required' => false, + 'example' => 'this is a comment'."\n", + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求的ID，用于定位日志，排查问题。', + 'type' => 'string', + 'example' => '22C97E95-F023-56B5-8852-B1A77A1****', + ], + 'SuccessInfo' => [ + 'description' => '批量操作的结果信息。结构为Map，以任务实例ID为键，以结果信息为Value。', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'object', + 'properties' => [ + 'Success' => [ + 'type' => 'boolean', + 'description' => '操作是否成功。', + 'example' => 'true', + ], + 'Message' => [ + 'type' => 'string', + 'example' => 'The instance does not exist.', + 'description' => '错误信息。', + ], + ], + 'description' => '结果信息。', + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"22C97E95-F023-56B5-8852-B1A77A1****\\",\\n \\"SuccessInfo\\": {\\n \\"key\\": {\\n \\"Success\\": true,\\n \\"Message\\": \\"The instance does not exist.\\"\\n }\\n }\\n}","type":"json"}]', + 'title' => '重跑任务实例', + 'summary' => '批量重跑多个任务实例。', + 'description' => '需要购买DataWorks基础版及以上版本才能使用。', + ], + 'RemoveTaskInstanceDependencies' => [ + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '245921', + 'abilityTreeNodes' => [ + 'FEATUREdide7WF1GB', + ], + ], + 'parameters' => [ + [ + 'name' => 'Id', + 'in' => 'query', + 'schema' => [ + 'description' => '任务实例ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1234', + ], + ], + [ + 'name' => 'UpstreamTaskInstanceIds', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'description' => '上游任务实例ID列表。', + 'type' => 'array', + 'items' => [ + 'description' => '任务实例ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1234', + ], + 'required' => false, + 'maxItems' => 100, + ], + ], + [ + 'name' => 'Comment', + 'in' => 'formData', + 'schema' => [ + 'description' => '备注信息。', + 'type' => 'string', + 'required' => false, + 'example' => 'this is a comment'."\n", + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求的ID，用于定位日志，排查问题。', + 'type' => 'string', + 'example' => '22C97E95-F023-56B5-8852-B1A77A17XXXX'."\n", + ], + 'Success' => [ + 'description' => '操作是否成功。', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"22C97E95-F023-56B5-8852-B1A77A17XXXX\\\\n\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => '移除任务实例的依赖关系', + 'summary' => '批量移除某任务实例的多个上游依赖关系。', + 'description' => '需要购买DataWorks基础版及以上版本才能使用。', + ], + 'TriggerSchedulerTaskInstance' => [ + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '244928', + 'abilityTreeNodes' => [ + 'FEATUREdide7WF1GB', + 'FEATUREdideD0YY7B', + 'FEATUREdideVFMENL', + ], + ], + 'parameters' => [ + [ + 'name' => 'TaskId', + 'in' => 'formData', + 'schema' => [ + 'description' => '任务ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1234', + ], + ], + [ + 'name' => 'EnvType', + 'in' => 'query', + 'schema' => [ + 'description' => '项目环境。'."\n" + .'- Prod(生产)'."\n" + .'- Dev(开发)', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [], + 'example' => 'Prod', + 'default' => 'Prod', + 'enum' => [ + 'Prod', + 'Dev', + ], + ], + ], + [ + 'name' => 'TriggerTime', + 'in' => 'formData', + 'schema' => [ + 'description' => '定时触发时间。格式为时间戳。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1710239005403'."\n", + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求的ID，用于定位日志，排查问题。', + 'type' => 'string', + 'example' => '22C97E95-F023-56B5-8852-B1A77A17XXXX'."\n", + ], + 'Success' => [ + 'description' => '操作是否成功。', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"22C97E95-F023-56B5-8852-B1A77A17XXXX\\\\n\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => '触发调度任务实例', + 'summary' => '在某个定时时间，触发指定HTTP触发器调度任务运行。', + 'description' => '需要购买DataWorks基础版及以上版本才能使用。', + ], + 'DeleteWorkflow' => [ + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'abilityTreeCode' => '253458', + 'abilityTreeNodes' => [ + 'FEATUREdide7WF1GB', + 'FEATUREdideD0YY7B', + 'FEATUREdideVFMENL', + ], + ], + 'parameters' => [ + [ + 'name' => 'Id', + 'in' => 'query', + 'schema' => [ + 'description' => '工作流的唯一标识符。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1234', + ], + ], + [ + 'name' => 'EnvType', + 'in' => 'formData', + 'schema' => [ + 'description' => '项目环境。'."\n" + .'- Prod：生产'."\n" + .'- Dev：开发', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [], + 'example' => 'Prod', + 'default' => 'Prod', + 'enum' => [ + 'Prod', + 'Dev', + ], + ], + ], + [ + 'name' => 'ClientUniqueCode', + 'in' => 'formData', + 'schema' => [ + 'description' => '工作流的客户端唯一码，用于实现异步和幂等。创建时如果不指定，系统将自动生成，该代码将与资源ID进行唯一绑定。更新、删除资源时如果指定该参数，应与创建时的客户端唯一码保持统一。', + 'type' => 'string', + 'required' => false, + 'example' => 'Workflow_0bc5213917368545132902xxxxxxxx', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求的ID。用于定位日志，排查问题。', + 'type' => 'string', + 'example' => '22C97E95-F023-56B5-8852-B1A77A17XXXX', + ], + 'Success' => [ + 'description' => '操作是否成功。', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"22C97E95-F023-56B5-8852-B1A77A17XXXX\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => '删除工作流', + 'summary' => '删除指定的工作流。', + 'description' => '需要购买DataWorks基础版及以上版本才能使用。', + ], + 'UpdateWorkflow' => [ + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '253479', + 'abilityTreeNodes' => [ + 'FEATUREdide7WF1GB', + 'FEATUREdideD0YY7B', + 'FEATUREdideVFMENL', + ], + ], + 'parameters' => [ + [ + 'name' => 'Id', + 'in' => 'formData', + 'schema' => [ + 'description' => '工作流ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1234', + ], + ], + [ + 'name' => 'EnvType', + 'in' => 'formData', + 'schema' => [ + 'description' => '项目环境。'."\n" + .'- Prod：生产'."\n" + .'- Dev：开发', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [], + 'example' => 'Prod', + 'default' => 'Prod', + 'enum' => [ + 'Prod', + ], + ], + ], + [ + 'name' => 'Name', + 'in' => 'formData', + 'schema' => [ + 'description' => '名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'My Workflow', + ], + ], + [ + 'name' => 'Owner', + 'in' => 'formData', + 'schema' => [ + 'description' => '责任人的账号ID。', + 'type' => 'string', + 'required' => true, + 'example' => '1000', + ], + ], + [ + 'name' => 'Trigger', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'description' => '触发方式。', + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'description' => '触发方式类型。'."\n" + .'- Scheduler：调度周期触发'."\n" + .'- Manual：手动触发', + 'type' => 'string', + 'required' => true, + 'enumValueTitles' => [], + 'example' => 'Scheduler', + 'enum' => [ + 'Scheduler', + 'Manual', + ], + ], + 'Cron' => [ + 'description' => 'Cron表达式，type=Scheduler时生效。', + 'type' => 'string', + 'required' => false, + 'example' => '00 00 00 * * ?', + ], + 'StartTime' => [ + 'description' => '周期触发生效时间，type=Scheduler时生效。格式为`yyyy-mm-dd hh:mm:ss`', + 'type' => 'string', + 'required' => false, + 'example' => '1970-01-01 00:00:00', + ], + 'EndTime' => [ + 'description' => '周期触发失效时间，type=Scheduler时生效。格式为`yyyy-mm-dd hh:mm:ss`', + 'type' => 'string', + 'required' => false, + 'example' => '9999-01-01 00:00:00', + ], + ], + 'required' => true, + ], + ], + [ + 'name' => 'Description', + 'in' => 'formData', + 'schema' => [ + 'description' => '描述信息。', + 'type' => 'string', + 'required' => false, + 'example' => 'test', + ], + ], + [ + 'name' => 'Dependencies', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'description' => '依赖信息。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'title' => '依赖类型', + 'description' => '依赖类型。'."\n" + .'- CrossCycleDependsOnChildren：跨周期依赖一级子节点'."\n" + .'- CrossCycleDependsOnSelf：跨周期依赖自己'."\n" + .'- CrossCycleDependsOnOtherNode：跨周期依赖其他节点'."\n" + .'- Normal：同周期依赖', + 'type' => 'string', + 'required' => true, + 'enumValueTitles' => [], + 'example' => 'Normal', + 'enum' => [ + 'Normal', + 'CrossCycleDependsOnSelf', + 'CrossCycleDependsOnChildren', + 'CrossCycleDependsOnOtherNode', + ], + ], + 'UpstreamOutput' => [ + 'title' => '依赖任务的输出标识符,或者任务ID', + 'description' => '上游任务的输出标识符。（`同周期依赖`且设置input内容时，返回此字段）', + 'type' => 'string', + 'required' => false, + 'example' => 'pre.odps_sql_demo_0', + ], + 'UpstreamTaskId' => [ + 'description' => '上游任务的Id。（`跨周期依赖其他节点`与`同周期依赖`未设置input内容时，返回此字段，其他情况不返回）', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1234', + ], + ], + 'required' => false, + ], + 'required' => false, + ], + ], + [ + 'name' => 'Parameters', + 'in' => 'formData', + 'schema' => [ + 'description' => '参数列表。', + 'type' => 'string', + 'required' => false, + 'example' => 'para1=$bizdate para2=$[yyyymmdd] ', + ], + ], + [ + 'name' => 'Tasks', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'description' => '任务列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Id' => [ + 'description' => '任务ID。填写此字段会对相应任务执行全量更新，未填写此字段则会创建新任务。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1234', + ], + 'Name' => [ + 'description' => '任务的名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'SQL node', + ], + 'Description' => [ + 'description' => '描述信息。', + 'type' => 'string', + 'required' => false, + 'example' => 'Test', + ], + 'Type' => [ + 'description' => '任务类型。', + 'type' => 'string', + 'required' => true, + 'example' => 'ODPS_SQL', + ], + 'Owner' => [ + 'description' => '责任人的账号ID。', + 'type' => 'string', + 'required' => true, + 'example' => '1000', + ], + 'BaseLineId' => [ + 'description' => '基线ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1234', + ], + 'Timeout' => [ + 'description' => '任务执行超时时间，单位秒。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '3600', + ], + 'RerunMode' => [ + 'description' => '任务是否允许重跑的配置。'."\n" + .'- AllDenied：失败或成功都不可重跑'."\n" + .'- FailureAllowed：只有失败可重跑'."\n" + .'- AllAllowed：失败或成功均可重跑', + 'type' => 'string', + 'required' => true, + 'enumValueTitles' => [], + 'example' => 'AllAllowed', + 'enum' => [ + 'AllAllowed', + 'FailureAllowed', + 'AllDenied', + ], + ], + 'RerunTimes' => [ + 'description' => '重试次数，当任务设置为可重跑时生效。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '3', + ], + 'RerunInterval' => [ + 'description' => '重试时间间隔，单位秒。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '60', + ], + 'Script' => [ + 'description' => '运行脚本信息。', + 'type' => 'object', + 'properties' => [ + 'Content' => [ + 'description' => '脚本内容。', + 'type' => 'string', + 'required' => false, + 'example' => 'echo "helloWorld"', + ], + 'Parameters' => [ + 'description' => '脚本参数列表。', + 'type' => 'string', + 'required' => false, + 'example' => 'para1=$bizdate', + ], + ], + 'required' => false, + ], + 'Trigger' => [ + 'description' => '任务触发方式。', + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'description' => '触发方式类型。'."\n" + .'- Scheduler：调度周期触发'."\n" + .'- Manual：手动触发', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [], + 'example' => 'Scheduler', + 'default' => 'Scheduler', + 'enum' => [ + 'Scheduler', + 'Manual', + ], + ], + 'Recurrence' => [ + 'description' => '触发时的运行模式，type=Scheduler时生效。'."\n" + .'- Pause：暂停'."\n" + .'- Skip：空跑'."\n" + .'- Normal：正常运行', + 'type' => 'string', + 'required' => true, + 'enumValueTitles' => [], + 'example' => 'Normal', + 'enum' => [ + 'Normal', + 'Skip', + 'Pause', + ], + ], + ], + 'required' => true, + ], + 'RuntimeResource' => [ + 'description' => '运行环境配置，如资源组信息。', + 'type' => 'object', + 'properties' => [ + 'ResourceGroupId' => [ + 'description' => '任务运行配置的调度资源组标识符。', + 'type' => 'string', + 'required' => true, + 'example' => 'S_res_group_524258031846018_1684XXXXXXXXX', + ], + 'Image' => [ + 'description' => '任务运行配置的镜像ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'i-xxxxxx', + ], + 'Cu' => [ + 'description' => '任务运行配置CU消耗。', + 'type' => 'string', + 'required' => false, + 'example' => '0.25', + ], + ], + 'required' => true, + ], + 'DataSource' => [ + 'description' => '关联数据源信息。', + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'description' => '数据源名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'odps_test', + ], + ], + 'required' => false, + ], + 'Inputs' => [ + 'description' => '输入信息。注意，此字段为空时将默认删除所有Inputs配置。', + 'type' => 'object', + 'properties' => [ + 'Variables' => [ + 'description' => '变量定义列表。注意，此字段未填或为空数组时将默认删除所有Inputs.Variables配置。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'description' => '变量名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'key1', + ], + 'Type' => [ + 'title' => '类型', + 'description' => '类型。'."\n" + .'- Constant：常量'."\n" + .'- PassThrough：参数节点输出'."\n" + .'- System：变量'."\n" + .'- NodeOutput：脚本输出', + 'type' => 'string', + 'required' => true, + 'enumValueTitles' => [], + 'example' => 'Constant', + 'enum' => [ + 'System', + 'Constant', + 'NodeOutput', + 'PassThrough', + ], + ], + 'Value' => [ + 'description' => '变量值。', + 'type' => 'string', + 'required' => false, + 'example' => 'value1', + ], + ], + 'required' => false, + ], + 'required' => false, + ], + ], + 'required' => false, + ], + 'Outputs' => [ + 'description' => '输出信息。注意，此字段为空时将默认删除所有Outputs配置。', + 'type' => 'object', + 'properties' => [ + 'TaskOutputs' => [ + 'description' => '任务输出定义列表。注意，此字段未填或为空数组时将默认删除所有TaskOutputs配置。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Output' => [ + 'title' => '输出标识符，示例：pre.odps_sql_demo_0', + 'description' => '输出标识符。', + 'type' => 'string', + 'required' => false, + 'example' => 'pre.odps_sql_demo_0', + ], + ], + 'required' => false, + ], + 'required' => false, + ], + 'Variables' => [ + 'description' => '变量定义列表。注意，此字段未填或为空数组时将默认删除所有Outputs.Variables配置。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'description' => '变量名。', + 'type' => 'string', + 'required' => false, + 'example' => 'key1', + ], + 'Type' => [ + 'title' => '类型', + 'description' => '类型。'."\n" + .'- Constant：常量'."\n" + .'- PassThrough：参数节点输出'."\n" + .'- System：变量'."\n" + .'- NodeOutput：脚本输出', + 'type' => 'string', + 'required' => true, + 'enumValueTitles' => [], + 'example' => 'Constant', + 'enum' => [ + 'System', + 'Constant', + 'NodeOutput', + 'PassThrough', + ], + ], + 'Value' => [ + 'description' => '变量值。', + 'type' => 'string', + 'required' => false, + 'example' => 'value1', + ], + ], + 'required' => false, + ], + 'required' => false, + ], + ], + 'required' => false, + ], + 'Dependencies' => [ + 'description' => '依赖信息。注意，此字段未填或为空数组时将默认删除所有Dependencies配置。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'title' => '依赖类型', + 'description' => '依赖类型。'."\n" + .'- CrossCycleDependsOnChildren：跨周期依赖一级子节点'."\n" + .'- CrossCycleDependsOnSelf：跨周期依赖自己'."\n" + .'- CrossCycleDependsOnOtherNode：跨周期依赖其他节点'."\n" + .'- Normal：同周期依赖', + 'type' => 'string', + 'required' => true, + 'enumValueTitles' => [], + 'example' => 'Normal', + 'enum' => [ + 'Normal', + 'CrossCycleDependsOnSelf', + 'CrossCycleDependsOnChildren', + 'CrossCycleDependsOnOtherNode', + ], + ], + 'UpstreamOutput' => [ + 'title' => '依赖任务的输出标识符, DependencyType=Normal时 需要填此值', + 'description' => '上游任务的输出标识符。（`同周期依赖`且设置input内容时，返回此字段）', + 'type' => 'string', + 'required' => false, + 'example' => 'pre.odps_sql_demo_0', + ], + 'UpstreamTaskId' => [ + 'title' => '依赖任务的任务ID, DependencyType=CrossCycleDependsOnOtherNode时 需要填此值', + 'description' => '上游任务的Id。（`跨周期依赖其他节点`与`同周期依赖`未设置input内容时，返回此字段，其他情况不返回）', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1234', + ], + ], + 'required' => false, + ], + 'required' => false, + ], + 'Tags' => [ + 'description' => '任务标签列表。注意，此字段未填或为空数组时将默认删除所有Tags配置。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => '标签键。', + 'type' => 'string', + 'required' => true, + 'example' => 'key1', + ], + 'Value' => [ + 'description' => '标签值。', + 'type' => 'string', + 'required' => false, + 'example' => 'value1', + ], + ], + 'required' => false, + ], + 'required' => false, + ], + 'ClientUniqueCode' => [ + 'description' => '任务的客户端唯一码，用于实现异步和幂等。创建时如果不指定，系统将自动生成，该代码将与资源ID进行唯一绑定。更新、删除资源时如果指定该参数，应与创建时的客户端唯一码保持统一。', + 'type' => 'string', + 'required' => false, + 'example' => 'Task_0bc5213917368545132902xxxxxxxx', + ], + 'EnvType' => [ + 'description' => '项目环境。'."\n" + .'- Prod：生产'."\n" + .'- Dev：开发', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [], + 'example' => 'Prod', + 'default' => 'Prod', + 'enum' => [ + 'Prod', + 'Dev', + ], + ], + ], + 'required' => false, + ], + 'required' => false, + ], + ], + [ + 'name' => 'Outputs', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'description' => '输出信息。', + 'type' => 'object', + 'properties' => [ + 'TaskOutputs' => [ + 'description' => '工作流任务输出定义列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Output' => [ + 'title' => '输出标识符，示例：pre.odps_sql_demo_0', + 'description' => '输出标识符。', + 'type' => 'string', + 'required' => false, + 'example' => 'pre.odps_sql_demo_0', + ], + ], + 'required' => false, + ], + 'required' => false, + ], + ], + 'required' => false, + ], + ], + [ + 'name' => 'Tags', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'description' => '工作流标签列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => '标签键。', + 'type' => 'string', + 'required' => true, + 'example' => 'key1', + ], + 'Value' => [ + 'description' => '标签值。', + 'type' => 'string', + 'required' => false, + 'example' => 'value1', + ], + ], + 'required' => false, + ], + 'required' => false, + ], + ], + [ + 'name' => 'ClientUniqueCode', + 'in' => 'formData', + 'schema' => [ + 'description' => '工作流的客户端唯一码，用于实现异步和幂等。创建时如果不指定，系统将自动生成，该代码将与资源ID进行唯一绑定。更新、删除资源时如果指定该参数，应与创建时的客户端唯一码保持统一。', + 'type' => 'string', + 'required' => false, + 'example' => 'Workflow_0bc5213917368545132902xxxxxxxx', + ], + ], + [ + 'name' => 'InstanceMode', + 'in' => 'formData', + 'schema' => [ + 'description' => '实例生成模式。'."\n" + ."\n" + .'- T+1（第二天生成）'."\n" + .'- Immediately（立即生成）。注意：工作流定时时间在工作流发布时间点十分钟后的周期实例才会正常生成。全量转实例期间（23:30~24:00点期间）不能进行实时转实例，可以提交发布工作流，但提交后不会重新生成实例。', + 'type' => 'string', + 'required' => false, + 'example' => 'T+1', + 'default' => 'T+1', + 'enum' => [ + 'T+1', + 'Immediately', + ], + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求的ID，用于定位日志，排查问题。', + 'type' => 'string', + 'example' => '22C97E95-F023-56B5-8852-B1A77A17XXXX', + ], + 'Success' => [ + 'description' => '操作是否成功。', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"22C97E95-F023-56B5-8852-B1A77A17XXXX\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => '更新工作流', + 'summary' => '以全量更新的方式，更新指定工作流。支持同步更新到数据开发的字段：责任人、数据源、调度资源组、描述信息、触发运行模式（正常、空跑、暂停）。', + 'description' => '需要购买DataWorks基础版及以上版本才能使用。', + ], + 'GetWorkflow' => [ + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '250954', + 'abilityTreeNodes' => [ + 'FEATUREdide7WF1GB', + 'FEATUREdideD0YY7B', + 'FEATUREdideVFMENL', + ], + ], + 'parameters' => [ + [ + 'name' => 'Id', + 'in' => 'query', + 'schema' => [ + 'description' => '工作流的唯一标识符。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1234', + ], + ], + [ + 'name' => 'EnvType', + 'in' => 'query', + 'schema' => [ + 'description' => '项目环境。'."\n" + .'- Prod：生产'."\n" + .'- Dev：开发', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [], + 'example' => 'Prod', + 'default' => 'Prod', + 'enum' => [ + 'Prod', + 'Dev', + ], + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求的ID。用于定位日志，排查问题。', + 'type' => 'string', + 'example' => '22C97E95-F023-56B5-8852-B1A77A17XXXX', + ], + 'Workflow' => [ + 'description' => '工作流的详细信息。', + 'type' => 'object', + 'properties' => [ + 'Id' => [ + 'description' => '工作流的唯一标识符。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1234', + ], + 'ProjectId' => [ + 'description' => '项目ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '100', + ], + 'EnvType' => [ + 'description' => '项目环境。'."\n" + .'- Prod：生产'."\n" + .'- Dev：开发', + 'type' => 'string', + 'example' => 'Prod', + ], + 'Owner' => [ + 'description' => '责任人的账号ID。', + 'type' => 'string', + 'example' => '1000', + ], + 'Name' => [ + 'description' => '名称。', + 'type' => 'string', + 'example' => 'Workflow', + ], + 'Description' => [ + 'description' => '描述信息。', + 'type' => 'string', + 'example' => 'Test workflow', + ], + 'Trigger' => [ + 'description' => '触发方式。', + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'title' => '`Scheduler` 周期触发', + 'description' => '触发方式类型。'."\n" + .'- Scheduler：调度周期触发'."\n" + .'- Manual：手动触发', + 'type' => 'string', + 'example' => 'Scheduler', + ], + 'Recurrence' => [ + 'description' => '触发时的运行模式，type=Scheduler时生效。'."\n" + .'- Pause：暂停'."\n" + .'- Skip：空跑'."\n" + .'- Normal：正常运行', + 'type' => 'string', + 'example' => 'Normal', + ], + 'Cron' => [ + 'description' => 'Cron表达式，type=Scheduler时生效。', + 'type' => 'string', + 'example' => '00 00 00 * * ?', + ], + 'StartTime' => [ + 'description' => '周期触发生效时间，type=Scheduler时生效。', + 'type' => 'string', + 'example' => '1970-01-01 00:00:00', + ], + 'EndTime' => [ + 'description' => '周期触发失效时间，type=Scheduler时生效。', + 'type' => 'string', + 'example' => '1970-01-01 00:00:00', + ], + ], + ], + 'Dependencies' => [ + 'description' => '依赖信息。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'title' => '依赖类型', + 'description' => '依赖类型。'."\n" + .'- CrossCycleDependsOnChildren：跨周期依赖一级子节点'."\n" + .'- CrossCycleDependsOnSelf：跨周期依赖自己'."\n" + .'- CrossCycleDependsOnOtherNode：跨周期依赖其他节点'."\n" + .'- Normal：同周期依赖', + 'type' => 'string', + 'example' => 'Normal', + ], + 'UpstreamOutput' => [ + 'title' => '依赖任务的输出标识符, DependencyType=Normal时 需要填此值', + 'description' => '上游任务的输出标识符。（`同周期依赖`且设置input内容时，返回此字段）', + 'type' => 'string', + 'example' => 'pre.odps_sql_demo_0', + ], + 'UpstreamTaskId' => [ + 'title' => '依赖任务的任务ID, DependencyType=CrossCycleDependsOnOtherNode时 需要填此值', + 'description' => '上游任务的Id。（`跨周期依赖其他节点`与`同周期依赖`未设置input内容时，返回此字段，其他情况不返回）', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1234', + ], + ], + ], + ], + 'Parameters' => [ + 'description' => '参数列表。', + 'type' => 'string', + 'example' => 'para1=$bizdate para2=$[yyyymmdd] ', + ], + 'Tasks' => [ + 'description' => '任务列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Id' => [ + 'description' => '任务ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1234', + ], + 'ProjectId' => [ + 'description' => '项目ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '100', + ], + 'EnvType' => [ + 'description' => '项目环境。'."\n" + .'- Prod：生产'."\n" + .'- Dev：开发', + 'type' => 'string', + 'example' => 'Prod', + ], + 'Owner' => [ + 'description' => '任务的责任人的账号ID。', + 'type' => 'string', + 'example' => '1000', + ], + 'Name' => [ + 'description' => '任务的名称。', + 'type' => 'string', + 'example' => 'SQL node', + ], + 'Description' => [ + 'description' => '描述信息。', + 'type' => 'string', + 'example' => 'Test', + ], + 'WorkflowId' => [ + 'description' => '所属工作流的ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1234', + ], + 'Type' => [ + 'title' => '任务类型', + 'description' => '任务类型。', + 'type' => 'string', + 'example' => 'ODPS_SQL', + ], + 'BaselineId' => [ + 'title' => '基线ID', + 'description' => '基线ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1234', + ], + 'Priority' => [ + 'title' => '任务优先级，最大值8，最小值1', + 'description' => '任务优先级，最小值1，最大值8。取值越大，优先级越高。默认优先级为1。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Timeout' => [ + 'title' => '任务执行超时时间，单位为秒', + 'description' => '任务执行超时时间，单位为秒。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '3600', + ], + 'RerunMode' => [ + 'title' => '任务是否允许重跑的配置', + 'description' => '任务是否允许重跑的配置。'."\n" + .'- AllDenied：失败或成功都不可重跑'."\n" + .'- FailureAllowed：只有失败可重跑'."\n" + .'- AllAllowed：失败或成功均可重跑', + 'type' => 'string', + 'example' => 'AllAllowed', + ], + 'RerunTimes' => [ + 'title' => '重试次数', + 'description' => '重试次数，当任务设置为可重跑时生效。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '3', + ], + 'RerunInterval' => [ + 'title' => '重试时间间隔，单位秒', + 'description' => '重试时间间隔，单位秒。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '60', + ], + 'RuntimeResource' => [ + 'title' => '运行环境配置，如资源组信息', + 'description' => '运行环境配置，如资源组信息。', + 'type' => 'object', + 'properties' => [ + 'ResourceGroupId' => [ + 'description' => '任务运行配置的调度资源组标识符。', + 'type' => 'string', + 'example' => 'S_res_group_524258031846018_1684XXXXXXXXX', + ], + 'Image' => [ + 'description' => '任务运行配置的镜像ID。', + 'type' => 'string', + 'example' => 'i-xxxxxx', + ], + 'Cu' => [ + 'description' => '任务运行配置CU消耗。', + 'type' => 'string', + 'example' => '0.25', + ], + ], + ], + 'DataSource' => [ + 'title' => '数据源', + 'description' => '关联数据源信息。', + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'description' => '数据源名称。', + 'type' => 'string', + 'example' => 'mysql_test', + ], + ], + ], + 'CreateTime' => [ + 'description' => '创建时间。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1710239005403', + ], + 'ModifyTime' => [ + 'description' => '修改时间。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1710239005403', + ], + 'CreateUser' => [ + 'description' => '创建用户的账号ID。', + 'type' => 'string', + 'example' => '1000', + ], + 'ModifyUser' => [ + 'description' => '修改用户的账号ID。', + 'type' => 'string', + 'example' => '1000', + ], + 'TriggerRecurrence' => [ + 'description' => '触发时的运行模式。'."\n" + .'- Pause：暂停'."\n" + .'- Skip：空跑'."\n" + .'- Normal：正常运行', + 'type' => 'string', + 'example' => 'Normal', + ], + 'ClientUniqueCode' => [ + 'description' => '任务的客户端唯一码，用于实现异步和幂等。创建时如果不指定，系统将自动生成，该代码将与资源ID进行唯一绑定。更新、删除资源时如果指定该参数，应与创建时的客户端唯一码保持统一。', + 'type' => 'string', + 'example' => 'Task_0bc5213917368545132902xxxxxxxx', + ], + ], + ], + ], + 'Outputs' => [ + 'title' => '输出信息', + 'description' => '输出信息。', + 'type' => 'object', + 'properties' => [ + 'TaskOutputs' => [ + 'description' => '任务输出定义列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Output' => [ + 'title' => '输出标识符，示例：pre.odps_sql_demo_0', + 'description' => '输出标识符。', + 'type' => 'string', + 'example' => 'pre.odps_sql_demo_0', + ], + ], + ], + ], + ], + ], + 'Tags' => [ + 'title' => '任务标签', + 'description' => '标签列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => '标签键。', + 'type' => 'string', + 'example' => 'key1', + ], + 'Value' => [ + 'description' => '标签值。', + 'type' => 'string', + 'example' => 'value1', + ], + ], + ], + ], + 'CreateTime' => [ + 'description' => '创建时间。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1710239005403', + ], + 'ModifyTime' => [ + 'description' => '修改时间。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1710239005403', + ], + 'CreateUser' => [ + 'description' => '创建用户的账号ID。', + 'type' => 'string', + 'example' => '1000', + ], + 'ModifyUser' => [ + 'description' => '修改用户的账号ID。', + 'type' => 'string', + 'example' => '1000', + ], + 'ClientUniqueCode' => [ + 'description' => '工作流的客户端唯一码，用于实现异步和幂等。创建时如果不指定，系统将自动生成，该代码将与资源ID进行唯一绑定。更新、删除资源时如果指定该参数，应与创建时的客户端唯一码保持统一。', + 'type' => 'string', + 'example' => 'Workflow_0bc5213917368545132902xxxxxxxx', + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"22C97E95-F023-56B5-8852-B1A77A17XXXX\\",\\n \\"Workflow\\": {\\n \\"Id\\": 1234,\\n \\"ProjectId\\": 100,\\n \\"EnvType\\": \\"Prod\\",\\n \\"Owner\\": \\"1000\\",\\n \\"Name\\": \\"Workflow\\",\\n \\"Description\\": \\"Test workflow\\",\\n \\"Trigger\\": {\\n \\"Type\\": \\"Scheduler\\",\\n \\"Recurrence\\": \\"Normal\\",\\n \\"Cron\\": \\"00 00 00 * * ?\\",\\n \\"StartTime\\": \\"1970-01-01 00:00:00\\",\\n \\"EndTime\\": \\"1970-01-01 00:00:00\\"\\n },\\n \\"Dependencies\\": [\\n {\\n \\"Type\\": \\"Normal\\",\\n \\"UpstreamOutput\\": \\"pre.odps_sql_demo_0\\",\\n \\"UpstreamTaskId\\": 1234\\n }\\n ],\\n \\"Parameters\\": \\"para1=$bizdate para2=$[yyyymmdd] \\",\\n \\"Tasks\\": [\\n {\\n \\"Id\\": 1234,\\n \\"ProjectId\\": 100,\\n \\"EnvType\\": \\"Prod\\",\\n \\"Owner\\": \\"1000\\",\\n \\"Name\\": \\"SQL node\\",\\n \\"Description\\": \\"Test\\",\\n \\"WorkflowId\\": 1234,\\n \\"Type\\": \\"ODPS_SQL\\",\\n \\"BaselineId\\": 1234,\\n \\"Priority\\": 1,\\n \\"Timeout\\": 3600,\\n \\"RerunMode\\": \\"AllAllowed\\",\\n \\"RerunTimes\\": 3,\\n \\"RerunInterval\\": 60,\\n \\"RuntimeResource\\": {\\n \\"ResourceGroupId\\": \\"S_res_group_524258031846018_1684XXXXXXXXX\\",\\n \\"Image\\": \\"i-xxxxxx\\",\\n \\"Cu\\": \\"0.25\\"\\n },\\n \\"DataSource\\": {\\n \\"Name\\": \\"mysql_test\\"\\n },\\n \\"CreateTime\\": 1710239005403,\\n \\"ModifyTime\\": 1710239005403,\\n \\"CreateUser\\": \\"1000\\",\\n \\"ModifyUser\\": \\"1000\\",\\n \\"TriggerRecurrence\\": \\"Normal\\",\\n \\"ClientUniqueCode\\": \\"Task_0bc5213917368545132902xxxxxxxx\\"\\n }\\n ],\\n \\"Outputs\\": {\\n \\"TaskOutputs\\": [\\n {\\n \\"Output\\": \\"pre.odps_sql_demo_0\\"\\n }\\n ]\\n },\\n \\"Tags\\": [\\n {\\n \\"Key\\": \\"key1\\",\\n \\"Value\\": \\"value1\\"\\n }\\n ],\\n \\"CreateTime\\": 1710239005403,\\n \\"ModifyTime\\": 1710239005403,\\n \\"CreateUser\\": \\"1000\\",\\n \\"ModifyUser\\": \\"1000\\",\\n \\"ClientUniqueCode\\": \\"Workflow_0bc5213917368545132902xxxxxxxx\\"\\n }\\n}","type":"json"}]', + 'title' => '获取工作流的详情', + 'summary' => '获取指定的工作流的详细信息。', + 'description' => '需要购买DataWorks基础版及以上版本才能使用。', + ], + 'ListWorkflows' => [ + 'summary' => '分页获取工作流列表，也可以通过条件进行筛选查询。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '253457', + 'abilityTreeNodes' => [ + 'FEATUREdide7WF1GB', + 'FEATUREdideD0YY7B', + 'FEATUREdideVFMENL', + ], + ], + 'parameters' => [ + [ + 'name' => 'ProjectId', + 'in' => 'formData', + 'schema' => [ + 'description' => '项目ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '100', + ], + ], + [ + 'name' => 'EnvType', + 'in' => 'formData', + 'schema' => [ + 'description' => '项目环境。'."\n" + .'- Prod：生产'."\n" + .'- Dev：开发', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [], + 'example' => 'Prod', + 'default' => 'Prod', + 'enum' => [ + 'Prod', + 'Dev', + ], + ], + ], + [ + 'name' => 'Ids', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'description' => '工作流ID列表，可根据工作流Id批量查询多个工作流信息。', + 'type' => 'array', + 'items' => [ + 'description' => '工作流ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1234', + ], + 'required' => false, + ], + ], + [ + 'name' => 'Name', + 'in' => 'formData', + 'schema' => [ + 'description' => '名称。支持模糊查询。', + 'type' => 'string', + 'required' => false, + 'example' => 'Workflow1', + ], + ], + [ + 'name' => 'Owner', + 'in' => 'formData', + 'schema' => [ + 'description' => '责任人的账号ID。', + 'type' => 'string', + 'required' => false, + 'example' => '1000', + ], + ], + [ + 'name' => 'TriggerType', + 'in' => 'formData', + 'schema' => [ + 'description' => '触发方式类型。'."\n" + .'- Scheduler'."\n" + .'- Manual'."\n" + .'- TriggerWorkflow', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [], + 'example' => 'Scheduler', + 'default' => 'Scheduler', + 'enum' => [ + 'Scheduler', + 'Manual', + 'TriggerWorkflow', + ], + ], + ], + [ + 'name' => 'SortBy', + 'in' => 'formData', + 'schema' => [ + 'description' => '排序字段。支持修改时间、创建时间等字段，格式为"排序字段+排序方式(Desc/Asc)"（Asc可以缺省）。排序字段的枚举值如下：'."\n" + .'- ModifyTime (Desc/Asc)'."\n" + .'- CreateTime (Desc/Asc)'."\n" + .'- Id (Desc/Asc)'."\n" + ."\n" + .'默认值：Id Desc', + 'type' => 'string', + 'required' => false, + 'example' => 'Id Desc', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'formData', + 'schema' => [ + 'description' => '每页的条目数，默认为10。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'formData', + 'schema' => [ + 'description' => '页码，从1开始，默认为1。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'Tags', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'description' => '标签列表，多个标签中满足一个即会返回结果。', + 'type' => 'array', + 'items' => [ + 'description' => '标签。格式为：`key:value`。value为空时格式为：`key:`', + 'type' => 'string', + 'required' => false, + 'example' => 'key:value', + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求的ID，用于定位日志，排查问题。', + 'type' => 'string', + 'example' => '22C97E95-F023-56B5-8852-B1A77A17XXXX', + ], + 'PagingInfo' => [ + 'description' => '分页信息。', + 'type' => 'object', + 'properties' => [ + 'Workflows' => [ + 'description' => '工作流列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Id' => [ + 'description' => '工作流的唯一标识符。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1234', + ], + 'Name' => [ + 'description' => '名称。', + 'type' => 'string', + 'example' => 'Workflow1', + ], + 'Description' => [ + 'description' => '描述信息。', + 'type' => 'string', + 'example' => 'test', + ], + 'Trigger' => [ + 'description' => '触发方式。', + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'title' => '`Scheduler` 周期触发', + 'description' => '触发方式类型。'."\n" + .'- Scheduler：调度周期触发'."\n" + .'- Manual：手动触发', + 'type' => 'string', + 'example' => 'Scheduler', + ], + 'Recurrence' => [ + 'description' => '触发时的运行模式，type=Scheduler时生效。'."\n" + .'- Pause：暂停'."\n" + .'- Skip：空跑'."\n" + .'- Normal：正常运行', + 'type' => 'string', + 'example' => 'Normal', + ], + 'Cron' => [ + 'description' => 'Cron表达式，type=Scheduler时生效。', + 'type' => 'string', + 'example' => '00 00 00 * * ?', + ], + 'StartTime' => [ + 'description' => '周期触发生效时间，type=Scheduler时生效。', + 'type' => 'string', + 'example' => '1970-01-01 00:00:00', + ], + 'EndTime' => [ + 'description' => '周期触发失效时间，type=Scheduler时生效。', + 'type' => 'string', + 'example' => '9999-01-01 00:00:00', + ], + ], + ], + 'Parameters' => [ + 'description' => '参数列表。', + 'type' => 'string', + 'example' => 'para1=$bizdate para2=$[yyyymmdd] ', + ], + 'ClientUniqueCode' => [ + 'description' => '工作流的客户端唯一码，用于实现异步和幂等。创建时如果不指定，系统将自动生成，该代码将与资源ID进行唯一绑定。更新、删除资源时如果指定该参数，应与创建时的客户端唯一码保持统一。', + 'type' => 'string', + 'example' => 'Workflow_0bc5213917368545132902xxxxxxxx', + ], + 'ProjectId' => [ + 'description' => '项目ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '100', + ], + 'EnvType' => [ + 'description' => '项目环境。'."\n" + .'- Prod：生产'."\n" + .'- Dev：开发', + 'type' => 'string', + 'example' => 'Prod', + ], + 'Owner' => [ + 'description' => '责任人的账号ID。', + 'type' => 'string', + 'example' => '1000', + ], + 'CreateTime' => [ + 'description' => '创建时间。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1710239005403', + ], + 'ModifyTime' => [ + 'description' => '修改时间。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1710239005403', + ], + 'CreateUser' => [ + 'description' => '创建用户的账号ID。', + 'type' => 'string', + 'example' => '1000', + ], + 'ModifyUser' => [ + 'description' => '修改用户的账号ID。', + 'type' => 'string', + 'example' => '1000', + ], + 'Tags' => [ + 'title' => '任务标签', + 'description' => '任务标签', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => '标签键。', + 'type' => 'string', + 'example' => 'key1', + ], + 'Value' => [ + 'description' => '标签值。', + 'type' => 'string', + 'example' => 'value1', + ], + ], + ], + ], + ], + ], + ], + 'TotalCount' => [ + 'description' => '数据总条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '100', + ], + 'PageSize' => [ + 'description' => '每页的条目数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'PageNumber' => [ + 'description' => '页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"22C97E95-F023-56B5-8852-B1A77A17XXXX\\",\\n \\"PagingInfo\\": {\\n \\"Workflows\\": [\\n {\\n \\"Id\\": 1234,\\n \\"Name\\": \\"Workflow1\\",\\n \\"Description\\": \\"test\\",\\n \\"Trigger\\": {\\n \\"Type\\": \\"Scheduler\\",\\n \\"Recurrence\\": \\"Normal\\",\\n \\"Cron\\": \\"00 00 00 * * ?\\",\\n \\"StartTime\\": \\"1970-01-01 00:00:00\\",\\n \\"EndTime\\": \\"9999-01-01 00:00:00\\"\\n },\\n \\"Parameters\\": \\"para1=$bizdate para2=$[yyyymmdd] \\",\\n \\"ClientUniqueCode\\": \\"Workflow_0bc5213917368545132902xxxxxxxx\\",\\n \\"ProjectId\\": 100,\\n \\"EnvType\\": \\"Prod\\",\\n \\"Owner\\": \\"1000\\",\\n \\"CreateTime\\": 1710239005403,\\n \\"ModifyTime\\": 1710239005403,\\n \\"CreateUser\\": \\"1000\\",\\n \\"ModifyUser\\": \\"1000\\",\\n \\"Tags\\": [\\n {\\n \\"Key\\": \\"key1\\",\\n \\"Value\\": \\"value1\\"\\n }\\n ]\\n }\\n ],\\n \\"TotalCount\\": 100,\\n \\"PageSize\\": 10,\\n \\"PageNumber\\": 1\\n }\\n}","type":"json"}]', + 'title' => '获取工作流列表', + 'description' => '需要购买DataWorks基础版及以上版本才能使用。', + ], + 'GetRerunWorkflowInstancesResult' => [ + 'summary' => '查询异步重跑工作流实例的结果', + 'path' => '', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREdideVFMENL', + ], + ], + 'parameters' => [ + [ + 'name' => 'OperationId', + 'in' => 'query', + 'schema' => [ + 'description' => '操作ID，用于异步查询创建工作流实例的结果，可通过RerunWorkflowInstances接口获得。', + 'type' => 'string', + 'required' => true, + 'example' => 'e15ad21c-b0e9-4792-8f55-b037xxxxxxxx'."\n", + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求的ID，用于定位日志，排查问题。', + 'type' => 'string', + 'example' => '22C97E95-F023-56B5-8852-B1A77A17XXXX'."\n", + ], + 'Result' => [ + 'description' => '工作流实例重跑结果。', + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => '状态。'."\n" + .'NotRun'."\n" + .'Success'."\n" + .'Failure', + 'type' => 'string', + 'example' => 'Success', + ], + 'FailureMessage' => [ + 'description' => '失败消息。重跑失败后，返回该字段。', + 'type' => 'string', + 'example' => 'Invalid Param xxx'."\n", + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'IdempotentParameterMismatch', + 'errorMessage' => 'The request uses the same client token as a previous, but non-identical request. Do not reuse a client token with different requests, unless the requests are identical.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"22C97E95-F023-56B5-8852-B1A77A17XXXX\\\\n\\",\\n \\"Result\\": {\\n \\"Status\\": \\"Success\\",\\n \\"FailureMessage\\": \\"Invalid Param xxx\\\\n\\"\\n }\\n}","type":"json"}]', + 'title' => '获取重跑工作流实例结果', + ], + 'RerunWorkflowInstances' => [ + 'summary' => '重跑工作流实例', + 'path' => '', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREdideVFMENL', + ], + ], + 'parameters' => [ + [ + 'name' => 'ProjectId', + 'in' => 'formData', + 'schema' => [ + 'description' => '项目ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '123', + ], + ], + [ + 'name' => 'EnvType', + 'in' => 'formData', + 'schema' => [ + 'description' => '项目环境。'."\n" + ."\n" + .'Prod：生产'."\n" + .'Dev：开发', + 'type' => 'string', + 'required' => false, + 'example' => 'Prod', + 'default' => 'Prod', + 'enum' => [ + 'Prod', + 'Dev', + ], + ], + ], + [ + 'name' => 'WorkflowId', + 'in' => 'formData', + 'schema' => [ + 'description' => '所属工作流的ID', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '123', + ], + ], + [ + 'name' => 'Type', + 'in' => 'formData', + 'schema' => [ + 'description' => '工作流实例的类型。'."\n" + ."\n" + .'ManualWorkflow：手动工作流。', + 'type' => 'string', + 'required' => true, + 'example' => 'ManualWorkflow', + 'enum' => [ + 'ManualWorkflow', + ], + ], + ], + [ + 'name' => 'Name', + 'in' => 'formData', + 'schema' => [ + 'description' => '根据手动工作流名称进行模糊匹配', + 'type' => 'string', + 'required' => false, + 'example' => 'test', + ], + ], + [ + 'name' => 'StartTriggerTime', + 'in' => 'formData', + 'schema' => [ + 'description' => '根据手动工作流实例开始触发时间（创建时间）进行匹配，需要和EndTriggerTime配合使用', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1710239005403', + ], + ], + [ + 'name' => 'EndTriggerTime', + 'in' => 'formData', + 'schema' => [ + 'description' => '根据手动工作流实例结束触发时间（创建时间）进行匹配，需要和StartTriggerTime配合使用', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1710239005403', + ], + ], + [ + 'name' => 'Bizdate', + 'in' => 'formData', + 'schema' => [ + 'description' => '根据手动工作流实例运行指定的业务时间进行匹配', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1710239005403', + ], + ], + [ + 'name' => 'Status', + 'in' => 'formData', + 'schema' => [ + 'description' => '根据手动工作流实例运行的状态进行匹配', + 'type' => 'string', + 'required' => false, + 'example' => 'Failure', + 'enum' => [ + 'Success', + 'Failure', + ], + ], + ], + [ + 'name' => 'Ids', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'description' => '根据手动工作流实例ID列表进行匹配', + 'type' => 'array', + 'items' => [ + 'description' => '手动工作流实例ID', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '12345', + ], + 'required' => false, + ], + ], + [ + 'name' => 'Filter', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'description' => '设置手动工作流实例的内部实例的匹配条件', + 'type' => 'object', + 'properties' => [ + 'RerunDownstreamEnabled' => [ + 'description' => '是否重跑符合条件的实例以及所有下游', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + 'TaskIds' => [ + 'description' => '根据手动工作流内部任务的taskId进行匹配', + 'type' => 'array', + 'items' => [ + 'description' => '内容任务的taskId', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '12345', + ], + 'required' => false, + ], + 'TaskName' => [ + 'description' => '根据手动工作流内部任务的名称进行匹配', + 'type' => 'string', + 'required' => false, + 'example' => 'test', + ], + 'TaskInstanceStatuses' => [ + 'description' => '根据手动工作流实例的内部实例的运行状态进行匹配', + 'type' => 'array', + 'items' => [ + 'description' => '内部实例的运行状态', + 'type' => 'string', + 'required' => false, + 'example' => 'Failure', + 'enum' => [ + 'NotRun', + 'Failure', + 'Success', + ], + ], + 'required' => false, + ], + 'TaskTypes' => [ + 'description' => '根据手动工作流内部任务的类型进行匹配', + 'type' => 'array', + 'items' => [ + 'description' => '内部任务的类型。各节点的TaskType取值，请参见DataWorks节点合集。', + 'type' => 'string', + 'required' => false, + 'example' => 'ODPS_SQL'."\n", + ], + 'required' => false, + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求的ID，用于定位日志，排查问题。', + 'type' => 'string', + 'example' => '22C97E95-F023-56B5-8852-B1A77A17XXXX'."\n", + ], + 'OperationId' => [ + 'description' => '操作ID。您可以凭借此字段通过GetRerunWorkflowInstancesResult接口来查询创建操作的结果。', + 'type' => 'string', + 'example' => 'e15ad21c-b0e9-4792-8f55-b037xxxxxxxx'."\n", + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"22C97E95-F023-56B5-8852-B1A77A17XXXX\\\\n\\",\\n \\"OperationId\\": \\"e15ad21c-b0e9-4792-8f55-b037xxxxxxxx\\\\n\\"\\n}","type":"json"}]', + 'title' => '重跑工作流实例', + ], + 'CreateWorkflowInstances' => [ + 'summary' => '根据配置创建工作流实例，如补数据工作流实例。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '259200', + 'abilityTreeNodes' => [ + 'FEATUREdide7WF1GB', + 'FEATUREdideD0YY7B', + 'FEATUREdideVFMENL', + ], + ], + 'parameters' => [ + [ + 'name' => 'ProjectId', + 'in' => 'formData', + 'schema' => [ + 'description' => '项目ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '100', + ], + ], + [ + 'name' => 'EnvType', + 'in' => 'formData', + 'schema' => [ + 'description' => '项目环境。'."\n" + .'- Prod：生产'."\n" + .'- Dev：开发', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [], + 'example' => 'Prod', + 'default' => 'Prod', + 'enum' => [ + 'Prod', + 'Dev', + ], + ], + ], + [ + 'name' => 'WorkflowId', + 'in' => 'formData', + 'schema' => [ + 'description' => '所属工作流的ID。周期任务的WorkflowId均为1。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1', + ], + ], + [ + 'name' => 'Name', + 'in' => 'formData', + 'schema' => [ + 'description' => '名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'WorkflowInstance1', + ], + ], + [ + 'name' => 'Periods', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'description' => '补数据周期设置。', + 'type' => 'object', + 'properties' => [ + 'BizDates' => [ + 'description' => '业务日期列表。可指定多段业务日期（最多7段）。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'StartBizDate' => [ + 'description' => '起始业务日期。格式为`yyyy-mm-dd`。', + 'type' => 'string', + 'required' => true, + 'example' => '2024-11-20', + ], + 'EndBizDate' => [ + 'description' => '结束业务日期。格式为`yyyy-mm-dd`。', + 'type' => 'string', + 'required' => true, + 'example' => '2024-11-24', + ], + ], + 'required' => false, + ], + 'required' => true, + ], + 'StartTime' => [ + 'description' => '指定开始周期时间，格式为`hh:mm:ss`，24小时制，默认00:00:00。'."\n" + ."\n" + .'如果填写此字段需要StartTime与EndTime需要同时填写。', + 'type' => 'string', + 'required' => false, + 'example' => '00:00:00', + ], + 'EndTime' => [ + 'description' => '指定结束周期时间，格式为`hh:mm:ss`，24小时制，默认23:59:59。'."\n" + ."\n" + .'如果填写此字段需要StartTime与EndTime需要同时填写。', + 'type' => 'string', + 'required' => false, + 'example' => '23:59:59', + ], + ], + 'required' => false, + ], + ], + [ + 'name' => 'Type', + 'in' => 'formData', + 'schema' => [ + 'description' => '工作流实例的类型。'."\n" + ."\n" + .'- SupplementData：补数据。RootTaskIds与IncludeTaskIds的填写方法随补数据模式而变化，见DefaultRunProperties.Mode参数说明'."\n" + .'- ManualWorkflow：手动业务流程。WorkflowId需要填手动业务流程的WorkflowId，RootTaskIds选填，不填则会使用手动业务流程默认的根节点列表。'."\n" + .'- Manual：手动任务。仅需填RootTaskIds，即为要运行的手动任务列表。'."\n" + .'- SmokeTest：冒烟测试。仅需填RootTaskIds，即为要运行的测试任务列表。'."\n" + .'- TriggerWorkflow：触发式工作流。WorkflowId需要填触发式工作流的WorkflowId，IncludeTaskIds选填，不填则会运行整个工作流。', + 'type' => 'string', + 'required' => true, + 'enumValueTitles' => [], + 'example' => 'SupplementData', + 'enum' => [ + 'ManualWorkflow', + 'SupplementData', + 'Manual', + 'SmokeTest', + 'TriggerWorkflow', + ], + ], + ], + [ + 'name' => 'WorkflowParameters', + 'in' => 'formData', + 'schema' => [ + 'description' => '工作流参数，当指定唯一工作流（`WorkflowId != 1`）时生效。若为周期工作流、触发式工作流，格式为key=value，优先级低于任务参数；若为手动业务流程，格式为JSON，优先级高于任务参数。', + 'type' => 'string', + 'required' => false, + 'example' => '"key=value" format:'."\n" + .'key1=value1 key2=value2'."\n" + .'JSON format:'."\n" + .'{"key1":"value1", "key2": "value2"}', + ], + ], + [ + 'name' => 'TaskParameters', + 'in' => 'formData', + 'schema' => [ + 'description' => '任务参数，为特定任务设置参数。JSON格式，key为任务ID，value的格式参考任务脚本参数（GetTask接口的结果Task.Script.Parameter）。', + 'type' => 'string', + 'required' => false, + 'example' => '{'."\n" + .' "1001": "key1=val2 key2=val2", '."\n" + .' "1002": "key1=val2 key2=val2"'."\n" + .'}', + ], + ], + [ + 'name' => 'AutoStartEnabled', + 'in' => 'formData', + 'schema' => [ + 'description' => '创建后是否直接运行，默认为true。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'DefaultRunProperties', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'description' => '运行时配置。', + 'type' => 'object', + 'properties' => [ + 'RootTaskIds' => [ + 'description' => '根任务ID列表。'."\n" + ."\n" + .'- Type=SupplementData时。除Mode=Chain的情况外，RootTaskIds均必填。'."\n" + .'- Type=ManualWorkflow时。RootTaskIds选填，不填则会使用手动业务流程默认的根节点列表。'."\n" + .'- Type=Manual时。RootTaskIds必填，即为要运行的手动任务列表。'."\n" + .'- Type=SmokeTest时：RootTaskIds必填，即为要运行的测试任务列表。', + 'type' => 'array', + 'items' => [ + 'description' => '任务ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1234', + ], + 'required' => false, + ], + 'IncludeTaskIds' => [ + 'description' => '需要运行的任务ID列表。', + 'type' => 'array', + 'items' => [ + 'description' => '任务ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1234', + ], + 'required' => false, + ], + 'ExcludeTaskIds' => [ + 'description' => '不要运行的任务ID列表。', + 'type' => 'array', + 'items' => [ + 'description' => '任务ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '4321', + ], + 'required' => false, + ], + 'IncludeProjectIds' => [ + 'description' => '需要运行的项目ID列表。', + 'type' => 'array', + 'items' => [ + 'description' => '项目ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '100', + ], + 'required' => false, + ], + 'ExcludeProjectIds' => [ + 'description' => '不需要运行的项目ID列表。', + 'type' => 'array', + 'items' => [ + 'description' => '项目ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '200', + ], + 'required' => false, + ], + 'Mode' => [ + 'description' => '补数据模式，默认为ManualSelection。Type=SupplementData时必填。'."\n" + .'- General：普通模式，`RootTaskIds`仅能填一个，`IncludeTaskIds`选填，不填会默认包含`RootTaskIds`中的内容'."\n" + .'- ManualSelection：手动选择，`RootTaskIds`能填多个，`IncludeTaskIds`选填，不填会默认包含`RootTaskIds`中的内容'."\n" + .'- Chain：链路，`RootTaskIds`为空，`IncludeTaskIds`填两个id，分别是起始和结束任务'."\n" + .'- AllDownstream：所有下游，`RootTaskIds`仅能填一个', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [], + 'example' => 'ManualSelection', + 'default' => 'ManualSelection', + 'enum' => [ + 'General', + 'ManualSelection', + 'Chain', + 'AllDownstream', + 'Huge', + ], + ], + 'Analysis' => [ + 'description' => '分析配置。Type=SupplementData时必填。', + 'type' => 'object', + 'properties' => [ + 'Enabled' => [ + 'description' => '是否开启分析。Type=SupplementData时必填。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + 'Blocked' => [ + 'description' => '分析不通过的情况下是否阻塞运行。Type=SupplementData时必填。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + 'required' => false, + ], + 'RunPolicy' => [ + 'description' => '运行策略。该字段为空则跟随任务配置。', + 'type' => 'object', + 'properties' => [ + 'StartTime' => [ + 'description' => '开始运行时间，格式为`hh:mm:ss`，24小时制。若设置运行策略，此字段必填。', + 'type' => 'string', + 'required' => false, + 'example' => '00:00:00', + ], + 'EndTime' => [ + 'description' => '结束运行时间，格式为`hh:mm:ss`，24小时制。若设置运行策略，此字段必填。', + 'type' => 'string', + 'required' => false, + 'example' => '23:59:59', + ], + 'Type' => [ + 'title' => 'Daily 每天', + 'description' => '时段类型。若设置运行策略，此字段必填。'."\n" + .'- Daily：每天'."\n" + .'- Weekend：仅周末', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [], + 'example' => 'Daily', + 'enum' => [ + 'Daily', + 'Weekend', + ], + ], + 'Immediately' => [ + 'description' => '运行时间在未来是否可以立即运行起来，默认为false。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + 'required' => false, + ], + 'Alert' => [ + 'description' => '报警配置。', + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'title' => '报警策略', + 'description' => '报警策略。'."\n" + .'- Success 成功告警'."\n" + .'- Failure 失败告警'."\n" + .'- SuccessFailure 成功和失败都告警', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [], + 'example' => 'Succes', + 'enum' => [ + 'Success', + 'Failure', + 'SuccessFailure', + ], + ], + 'NoticeType' => [ + 'title' => '通知方式', + 'description' => '通知方式。'."\n" + .'- Sms：仅短信'."\n" + .'- Mail：仅邮件'."\n" + .'- SmsMail：短信加邮件。', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [], + 'example' => 'Sms', + 'enum' => [ + 'Sms', + 'Mail', + 'SmsMail', + ], + ], + ], + 'required' => false, + ], + 'Parallelism' => [ + 'title' => '并行度', + 'description' => '任务并行数。取值2~10时为并行度， 取值1时为串行。Type=SupplementData时必填。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '2', + ], + 'Order' => [ + 'title' => '运行顺序', + 'description' => '运行顺序，默认为Asc。'."\n" + .'- Asc：按业务日期升序。'."\n" + .'- Desc：按业务日期降序。', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [], + 'example' => 'Asc', + 'default' => 'Asc', + 'enum' => [ + 'Asc', + 'Desc', + ], + ], + 'RuntimeResource' => [ + 'title' => '自定义资源组Identifier', + 'description' => '自定义调度资源组标识符，该字段为空则跟随任务配置。', + 'type' => 'string', + 'required' => false, + 'example' => 'S_res_group_524258031846018_1684XXXXXXXXX', + ], + 'Priority' => [ + 'title' => '自定义优先级', + 'description' => '运行优先级，取值范围为1~11。取值越大，优先级越高。（该参数配置只支持手动业务流程与触发式工作流）', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + 'PriorityWeightStrategy' => [ + 'description' => '优先级权重策略。（该参数配置只支持手动业务流程与触发式工作流）'."\n" + .'- `Disable`：不启用（默认）'."\n" + .'- `Upstream`：当前节点计算上游的权重总和。即层次越深，权重越高。', + 'type' => 'string', + 'required' => false, + 'example' => 'Upstream', + 'enum' => [ + 'Disable', + 'Upstream', + ], + ], + ], + 'required' => false, + ], + ], + [ + 'name' => 'Comment', + 'in' => 'formData', + 'schema' => [ + 'description' => '创建的原因说明。', + 'type' => 'string', + 'required' => false, + 'example' => 'create for test', + ], + ], + [ + 'name' => 'Tags', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'description' => '任务标签列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Value' => [ + 'description' => '标签值。', + 'type' => 'string', + 'required' => false, + 'example' => 'tagValue', + ], + 'Key' => [ + 'description' => '标签键。', + 'type' => 'string', + 'required' => false, + 'example' => 'tagKey', + ], + ], + 'required' => false, + ], + 'required' => false, + ], + ], + [ + 'name' => 'TagCreationPolicy', + 'in' => 'formData', + 'schema' => [ + 'description' => '标签创建策略。'."\n" + .'- Append：追加模式，在继承手动业务流程已有标签的基础上追加新的标签。'."\n" + .'- Overwrite：覆盖模式，不继承手动业务流程已有标签，直接创建标签。', + 'type' => 'string', + 'required' => false, + 'example' => 'Append', + 'enum' => [ + 'Append', + 'Overwrite', + ], + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求的ID，用于定位日志，排查问题。', + 'type' => 'string', + 'example' => '22C97E95-F023-56B5-8852-B1A77A17XXXX', + ], + 'OperationId' => [ + 'description' => '操作ID。您可以凭借此字段通过GetCreateWorkflowInstancesResult接口来查询创建操作的结果。', + 'type' => 'string', + 'example' => 'e15ad21c-b0e9-4792-8f55-b037xxxxxxxx', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"22C97E95-F023-56B5-8852-B1A77A17XXXX\\",\\n \\"OperationId\\": \\"e15ad21c-b0e9-4792-8f55-b037xxxxxxxx\\"\\n}","type":"json"}]', + 'title' => '创建工作流实例', + 'description' => '需要购买DataWorks基础版及以上版本才能使用。', + ], + 'GetCreateWorkflowInstancesResult' => [ + 'summary' => '查询异步创建工作流实例的结果。', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '259199', + 'abilityTreeNodes' => [ + 'FEATUREdide7WF1GB', + 'FEATUREdideD0YY7B', + 'FEATUREdideVFMENL', + ], + ], + 'parameters' => [ + [ + 'name' => 'OperationId', + 'in' => 'query', + 'schema' => [ + 'description' => '操作ID，用于异步查询创建工作流实例的结果，可通过CreateWorkflowInstances接口获得。', + 'type' => 'string', + 'required' => true, + 'example' => 'e15ad21c-b0e9-4792-8f55-b037xxxxxxxx', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求的ID，用于定位日志，排查问题。', + 'type' => 'string', + 'example' => '22C97E95-F023-56B5-8852-B1A77A17XXXX', + ], + 'Result' => [ + 'description' => '工作流实例创建结果。', + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => '创建状态。'."\n" + .'- Creating，创建中'."\n" + .'- Created，创建成功'."\n" + .'- CreateFailure，创建失败', + 'type' => 'string', + 'example' => 'Created', + ], + 'FailureMessage' => [ + 'description' => '失败消息。创建失败后，返回该字段。', + 'type' => 'string', + 'example' => 'Invalid Param xxx', + ], + 'WorkflowInstanceIds' => [ + 'description' => '工作流实例ID列表。创建成功后，返回该字段。', + 'type' => 'array', + 'items' => [ + 'description' => '工作流实例ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1234', + ], + ], + 'WorkflowTaskInstanceIds' => [ + 'description' => '工作流实例对应的任务实例ID列表。创建成功后，返回该字段。', + 'type' => 'array', + 'items' => [ + 'description' => '工作流实例对应的任务实例ID', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1234', + ], + ], + 'UnifiedWorkflowInstanceIds' => [ + 'description' => '统一工作流实例Id，某次触发下某业务日期内的所有任务实例的该字段值相等。创建成功后，返回该字段。', + 'type' => 'array', + 'items' => [ + 'description' => '统一工作流实例Id。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1234', + ], + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"22C97E95-F023-56B5-8852-B1A77A17XXXX\\",\\n \\"Result\\": {\\n \\"Status\\": \\"Created\\",\\n \\"FailureMessage\\": \\"Invalid Param xxx\\",\\n \\"WorkflowInstanceIds\\": [\\n 1234\\n ],\\n \\"WorkflowTaskInstanceIds\\": [\\n 1234\\n ],\\n \\"UnifiedWorkflowInstanceIds\\": [\\n 1234\\n ]\\n }\\n}","type":"json"}]', + 'title' => '获取创建工作流实例结果', + 'description' => '需要购买DataWorks基础版及以上版本才能使用。', + ], + 'GetWorkflowInstance' => [ + 'summary' => '获取指定的工作流实例的详细信息。', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '260634', + 'abilityTreeNodes' => [ + 'FEATUREdide7WF1GB', + 'FEATUREdideD0YY7B', + 'FEATUREdideVFMENL', + ], + ], + 'parameters' => [ + [ + 'name' => 'Id', + 'in' => 'query', + 'schema' => [ + 'description' => '工作流实例的唯一标识符。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1234', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求的ID。用于定位日志，排查问题。', + 'type' => 'string', + 'example' => '22C97E95-F023-56B5-8852-B1A77A17XXXX', + ], + 'WorkflowInstance' => [ + 'description' => '工作流实例的详细信息。', + 'type' => 'object', + 'properties' => [ + 'Id' => [ + 'description' => '工作流实例的唯一标识符。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1234', + ], + 'WorkflowId' => [ + 'description' => '所属工作流的ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1234', + ], + 'WorkflowTaskInstanceId' => [ + 'description' => '工作流实例对应的任务实例ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1234', + ], + 'UnifiedWorkflowInstanceId' => [ + 'description' => '统一工作流实例Id，某次触发下某业务日期内的所有工作流实例的该字段值相等。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1234', + ], + 'Name' => [ + 'description' => '名称。', + 'type' => 'string', + 'example' => 'WorkInstance1', + ], + 'Type' => [ + 'title' => '工作流类型', + 'description' => '工作流实例的类型。'."\n" + .'- Normal：周期调度'."\n" + .'- Manual：手动任务'."\n" + .'- SmokeTest：测试'."\n" + .'- SupplementData：补数据'."\n" + .'- ManualWorkflow：手动工作流'."\n" + .'- TriggerWorkflow：触发式工作流', + 'type' => 'string', + 'example' => 'Normal', + ], + 'Status' => [ + 'description' => '工作流实例运行状态。'."\n" + .'- NotRun：未运行'."\n" + .'- Running：运行中'."\n" + .'- WaitTime：等待TriggerTime到来'."\n" + .'- CheckingCondition：分支条件检验'."\n" + .'- WaitResource：等待资源'."\n" + .'- Failure：执行失败'."\n" + .'- Success：执行成功'."\n" + .'- Checking：下发给数据质量校检', + 'type' => 'string', + 'example' => 'Success', + ], + 'BizDate' => [ + 'description' => '业务日期。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1710239005403', + ], + 'StartedTime' => [ + 'description' => '开始运行时间。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1710239005403', + ], + 'FinishedTime' => [ + 'description' => '完成时间。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1710239005403', + ], + 'ProjectId' => [ + 'description' => '项目ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '100', + ], + 'EnvType' => [ + 'description' => '项目环境。'."\n" + .'- Prod：生产'."\n" + .'- Dev：开发', + 'type' => 'string', + 'example' => 'Prod', + ], + 'Owner' => [ + 'description' => '工作流的责任人的账号ID。', + 'type' => 'string', + 'example' => '1000', + ], + 'CreateTime' => [ + 'description' => '创建时间。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1710239005403', + ], + 'ModifyTime' => [ + 'description' => '修改时间。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1710239005403', + ], + 'CreateUser' => [ + 'description' => '创建用户的账号ID。', + 'type' => 'string', + 'example' => '1000', + ], + 'ModifyUser' => [ + 'description' => '修改用户的账号ID。', + 'type' => 'string', + 'example' => '1000', + ], + 'WorkflowParameters' => [ + 'description' => '工作流参数。', + 'type' => 'string', + 'example' => '周期工作流：'."\n" + .'key1=value1 key2=value2'."\n" + .'手动业务流程：'."\n" + .'{"key1":"value1", "key2": "value2"}', + ], + 'Tags' => [ + 'title' => '任务标签', + 'description' => '任务标签', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => '标签键。', + 'type' => 'string', + 'example' => 'key1', + ], + 'Value' => [ + 'description' => '标签值。', + 'type' => 'string', + 'example' => 'value1', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"22C97E95-F023-56B5-8852-B1A77A17XXXX\\",\\n \\"WorkflowInstance\\": {\\n \\"Id\\": 1234,\\n \\"WorkflowId\\": 1234,\\n \\"WorkflowTaskInstanceId\\": 1234,\\n \\"UnifiedWorkflowInstanceId\\": 1234,\\n \\"Name\\": \\"WorkInstance1\\",\\n \\"Type\\": \\"Normal\\",\\n \\"Status\\": \\"Success\\",\\n \\"BizDate\\": 1710239005403,\\n \\"StartedTime\\": 1710239005403,\\n \\"FinishedTime\\": 1710239005403,\\n \\"ProjectId\\": 100,\\n \\"EnvType\\": \\"Prod\\",\\n \\"Owner\\": \\"1000\\",\\n \\"CreateTime\\": 1710239005403,\\n \\"ModifyTime\\": 1710239005403,\\n \\"CreateUser\\": \\"1000\\",\\n \\"ModifyUser\\": \\"1000\\",\\n \\"WorkflowParameters\\": \\"周期工作流：\\\\nkey1=value1 key2=value2\\\\n手动业务流程：\\\\n{\\\\\\"key1\\\\\\":\\\\\\"value1\\\\\\", \\\\\\"key2\\\\\\": \\\\\\"value2\\\\\\"}\\",\\n \\"Tags\\": [\\n {\\n \\"Key\\": \\"key1\\",\\n \\"Value\\": \\"value1\\"\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => '获取工作流实例的详情', + 'description' => '需要购买DataWorks基础版及以上版本才能使用。', + ], + 'ListWorkflowInstances' => [ + 'summary' => '分页获取工作流实例列表，也可以通过条件进行筛选查询。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '260653', + 'abilityTreeNodes' => [ + 'FEATUREdide7WF1GB', + 'FEATUREdideD0YY7B', + 'FEATUREdideVFMENL', + ], + ], + 'parameters' => [ + [ + 'name' => 'ProjectId', + 'in' => 'formData', + 'schema' => [ + 'description' => '项目ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '100', + ], + ], + [ + 'name' => 'BizDate', + 'in' => 'formData', + 'schema' => [ + 'description' => '业务日期。一般是周期实例定时时间的前一天的0点0分0秒，格式为毫秒级时间戳，如1743350400000。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1710239005403', + ], + ], + [ + 'name' => 'Type', + 'in' => 'formData', + 'schema' => [ + 'title' => '工作流实例类型', + 'description' => '工作流实例的类型。'."\n" + .'- Normal：周期调度'."\n" + .'- Manual：手动任务'."\n" + .'- SmokeTest：测试'."\n" + .'- SupplementData：补数据'."\n" + .'- ManualWorkflow：手动工作流'."\n" + .'- TriggerWorkflow：触发式工作流', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [], + 'example' => 'Normal', + 'default' => 'Normal', + 'enum' => [ + 'Normal', + 'ManualWorkflow', + 'Manual', + 'SupplementData', + 'SmokeTest', + 'TriggerWorkflow', + ], + ], + ], + [ + 'name' => 'WorkflowId', + 'in' => 'formData', + 'schema' => [ + 'description' => '所属工作流的ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1234', + ], + ], + [ + 'name' => 'UnifiedWorkflowInstanceId', + 'in' => 'formData', + 'schema' => [ + 'description' => '统一工作流实例Id，某次触发下某业务日期内的所有工作流实例的该字段值相等。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1234', + ], + ], + [ + 'name' => 'Name', + 'in' => 'formData', + 'schema' => [ + 'description' => '名称。支持模糊查询。', + 'type' => 'string', + 'required' => false, + 'example' => 'WorkflowInstance1', + ], + ], + [ + 'name' => 'Ids', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'description' => '工作流实例ID列表，可根据工作流实例Id批量查询多个工作流实例信息。', + 'type' => 'array', + 'items' => [ + 'description' => '工作流实例ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1234', + ], + 'required' => false, + ], + ], + [ + 'name' => 'Owner', + 'in' => 'formData', + 'schema' => [ + 'description' => '责任人的账号ID。', + 'type' => 'string', + 'required' => false, + 'example' => '1000', + ], + ], + [ + 'name' => 'SortBy', + 'in' => 'formData', + 'schema' => [ + 'description' => '排序字段列表，支持定时时间、开始时间等字段。格式为"排序字段+排序方式(Desc/Asc)"（Asc可以缺省）。排序字段的枚举值如下：'."\n" + .'- TriggerTime (Desc/Asc)'."\n" + .'- StartedTime (Desc/Asc)'."\n" + .'- FinishedTime (Desc/Asc)'."\n" + .'- CreateTime (Desc/Asc)'."\n" + .'- Id (Desc/Asc)'."\n" + ."\n" + .'默认值：Id Desc', + 'type' => 'string', + 'required' => false, + 'example' => 'Id Desc', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'formData', + 'schema' => [ + 'description' => '每页的条目数，默认为10。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'formData', + 'schema' => [ + 'description' => '页码，从1开始，默认为1。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'Tags', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'description' => '标签列表，多个标签中满足一个即会返回结果。', + 'type' => 'array', + 'items' => [ + 'description' => '标签。格式为：`key:value`。value为空时格式为：`key:`', + 'type' => 'string', + 'required' => false, + 'example' => 'key:value', + ], + 'required' => false, + ], + ], + [ + 'name' => 'Filter', + 'in' => 'formData', + 'schema' => [ + 'description' => '过滤器。JSON格式，多个过滤条件之间是"且"的关系。目前支持的字段有：`status, executionDate`。', + 'type' => 'string', + 'required' => false, + 'example' => '{ '."\n" + .' "status": "Success",'."\n" + .' "executionDate": "1763481600000"'."\n" + .'}', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求的ID。用于定位日志，排查问题。', + 'type' => 'string', + 'example' => '22C97E95-F023-56B5-8852-B1A77A17XXXX', + ], + 'PagingInfo' => [ + 'description' => '分页信息。', + 'type' => 'object', + 'properties' => [ + 'WorkflowInstances' => [ + 'description' => '工作流实例列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Id' => [ + 'description' => '工作流实例的唯一标识符。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1234', + ], + 'WorkflowTaskInstanceId' => [ + 'description' => '工作流实例对应的任务实例ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1234', + ], + 'UnifiedWorkflowInstanceId' => [ + 'description' => '统一工作流实例Id，某次触发下某业务日期内的所有工作流实例的该字段值相等。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1234', + ], + 'Name' => [ + 'description' => '名称。', + 'type' => 'string', + 'example' => 'WorkflowInstance1', + ], + 'Type' => [ + 'title' => '工作流类型', + 'description' => '工作流实例的类型。'."\n" + .'- Normal：周期调度'."\n" + .'- Manual：手动任务'."\n" + .'- SmokeTest：测试'."\n" + .'- SupplementData：补数据'."\n" + .'- ManualWorkflow：手动工作流'."\n" + .'- TriggerWorkflow：触发式工作流', + 'type' => 'string', + 'example' => 'Normal', + ], + 'Status' => [ + 'description' => '工作流实例运行状态。'."\n" + .'- NotRun：未运行'."\n" + .'- Running：运行中'."\n" + .'- WaitTime：等待TriggerTime到来'."\n" + .'- CheckingCondition：分支条件检验'."\n" + .'- WaitResource：等待资源'."\n" + .'- Failure：执行失败'."\n" + .'- Success：执行成功'."\n" + .'- Checking：下发给数据质量校检', + 'type' => 'string', + 'example' => 'Success', + ], + 'BizDate' => [ + 'description' => '业务日期。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1710239005403', + ], + 'StartedTime' => [ + 'description' => '开始运行时间。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1710239005403', + ], + 'FinishedTime' => [ + 'description' => '完成时间。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1710239005403', + ], + 'ProjectId' => [ + 'description' => '项目ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '100', + ], + 'EnvType' => [ + 'description' => '项目环境。'."\n" + .'- Prod(生产)'."\n" + .'- Dev(开发)', + 'type' => 'string', + 'example' => 'Prod', + ], + 'Owner' => [ + 'description' => '工作流的责任人的账号ID。', + 'type' => 'string', + 'example' => '1000', + ], + 'CreateTime' => [ + 'description' => '创建时间。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1710239005403', + ], + 'ModifyTime' => [ + 'description' => '修改时间。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1710239005403', + ], + 'CreateUser' => [ + 'description' => '创建用户的账号ID。', + 'type' => 'string', + 'example' => '100', + ], + 'ModifyUser' => [ + 'description' => '修改用户的账号ID。', + 'type' => 'string', + 'example' => '100', + ], + 'WorkflowParameters' => [ + 'description' => '工作流参数。', + 'type' => 'string', + 'example' => '周期工作流：'."\n" + .'key1=value1 key2=value2'."\n" + .'手动业务流程：'."\n" + .'{"key1":"value1", "key2": "value2"}', + ], + 'WorkflowId' => [ + 'description' => '所属工作流的ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1234', + ], + 'Tags' => [ + 'title' => '任务标签', + 'description' => '任务标签', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => '标签键。', + 'type' => 'string', + 'example' => 'key1', + ], + 'Value' => [ + 'description' => '标签值。', + 'type' => 'string', + 'example' => 'value1', + ], + ], + ], + ], + ], + ], + ], + 'TotalCount' => [ + 'description' => '数据总条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '100', + ], + 'PageSize' => [ + 'description' => '每页的条目数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'PageNumber' => [ + 'description' => '页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"22C97E95-F023-56B5-8852-B1A77A17XXXX\\",\\n \\"PagingInfo\\": {\\n \\"WorkflowInstances\\": [\\n {\\n \\"Id\\": 1234,\\n \\"WorkflowTaskInstanceId\\": 1234,\\n \\"UnifiedWorkflowInstanceId\\": 1234,\\n \\"Name\\": \\"WorkflowInstance1\\",\\n \\"Type\\": \\"Normal\\",\\n \\"Status\\": \\"Success\\",\\n \\"BizDate\\": 1710239005403,\\n \\"StartedTime\\": 1710239005403,\\n \\"FinishedTime\\": 1710239005403,\\n \\"ProjectId\\": 100,\\n \\"EnvType\\": \\"Prod\\",\\n \\"Owner\\": \\"1000\\",\\n \\"CreateTime\\": 1710239005403,\\n \\"ModifyTime\\": 1710239005403,\\n \\"CreateUser\\": \\"100\\",\\n \\"ModifyUser\\": \\"100\\",\\n \\"WorkflowParameters\\": \\"周期工作流：\\\\nkey1=value1 key2=value2\\\\n手动业务流程：\\\\n{\\\\\\"key1\\\\\\":\\\\\\"value1\\\\\\", \\\\\\"key2\\\\\\": \\\\\\"value2\\\\\\"}\\",\\n \\"WorkflowId\\": 1234,\\n \\"Tags\\": [\\n {\\n \\"Key\\": \\"key1\\",\\n \\"Value\\": \\"value1\\"\\n }\\n ]\\n }\\n ],\\n \\"TotalCount\\": 100,\\n \\"PageSize\\": 10,\\n \\"PageNumber\\": 1\\n }\\n}","type":"json"}]', + 'title' => '获取工作流实例列表', + 'description' => '需要购买DataWorks基础版及以上版本才能使用。', + ], + 'StartWorkflowInstances' => [ + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + [ + 'BearerToken' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '260768', + 'abilityTreeNodes' => [ + 'FEATUREdide7WF1GB', + ], + ], + 'parameters' => [ + [ + 'name' => 'Ids', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'description' => '工作流实例ID列表。', + 'type' => 'array', + 'items' => [ + 'description' => '工作流实例ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1234', + ], + 'required' => true, + ], + ], + [ + 'name' => 'Comment', + 'in' => 'formData', + 'schema' => [ + 'description' => '备注信息。', + 'type' => 'string', + 'required' => false, + 'example' => 'this is a comment', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求的ID，用于定位日志，排查问题。', + 'type' => 'string', + 'example' => '22C97E95-F023-56B5-8852-B1A77A17****', + ], + 'SuccessInfo' => [ + 'description' => '批量操作的结果信息。结构为Map，以工作流实例ID为键，以结果信息为Value。', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'object', + 'properties' => [ + 'Success' => [ + 'type' => 'boolean', + 'description' => '操作是否成功。', + 'example' => 'true', + ], + 'Message' => [ + 'type' => 'string', + 'example' => '该实例不存在。', + 'description' => '错误信息。', + ], + ], + 'description' => '结果信息。', + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"22C97E95-F023-56B5-8852-B1A77A17****\\",\\n \\"SuccessInfo\\": {\\n \\"key\\": {\\n \\"Success\\": true,\\n \\"Message\\": \\"该实例不存在。\\"\\n }\\n }\\n}","type":"json"}]', + 'title' => '启动工作流实例', + 'summary' => '批量启动多个工作流实例。', + 'description' => '需要购买DataWorks基础版及以上版本才能使用。', + ], + 'StopWorkflowInstances' => [ + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '260769', + 'abilityTreeNodes' => [ + 'FEATUREdide7WF1GB', + ], + ], + 'parameters' => [ + [ + 'name' => 'Ids', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'description' => '工作流实例ID列表。', + 'type' => 'array', + 'items' => [ + 'description' => '工作流实例ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1234', + ], + 'required' => true, + ], + ], + [ + 'name' => 'Comment', + 'in' => 'formData', + 'schema' => [ + 'description' => '备注信息。', + 'type' => 'string', + 'required' => false, + 'example' => 'this is a comment', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求的ID，用于定位日志，排查问题。', + 'type' => 'string', + 'example' => '22C97E95-F023-56B5-8852-B1A77A17****', + ], + 'SuccessInfo' => [ + 'description' => '批量操作的结果信息。结构为Map，以工作流实例ID为键，以结果信息为Value。', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'object', + 'properties' => [ + 'Success' => [ + 'type' => 'boolean', + 'description' => '操作是否成功。', + 'example' => 'true', + ], + 'Message' => [ + 'type' => 'string', + 'example' => 'The instance does not exist.', + 'description' => '错误信息。', + ], + ], + 'description' => '结果信息。', + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"22C97E95-F023-56B5-8852-B1A77A17****\\",\\n \\"SuccessInfo\\": {\\n \\"key\\": {\\n \\"Success\\": true,\\n \\"Message\\": \\"The instance does not exist.\\"\\n }\\n }\\n}","type":"json"}]', + 'title' => '终止工作流实例', + 'summary' => '批量终止多个工作流实例。', + 'description' => '需要购买DataWorks基础版及以上版本才能使用。', + ], + 'ExecuteAdhocWorkflowInstance' => [ + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'abilityTreeCode' => '259719', + 'abilityTreeNodes' => [ + 'FEATUREdide7WF1GB', + 'FEATUREdideD0YY7B', + 'FEATUREdideVFMENL', + ], + ], + 'parameters' => [ + [ + 'name' => 'EnvType', + 'in' => 'formData', + 'schema' => [ + 'description' => '项目环境。'."\n" + .'- Prod：生产'."\n" + .'- Dev：开发', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [], + 'example' => 'Prod', + 'default' => 'Prod', + 'enum' => [ + 'Prod', + 'Dev', + ], + ], + ], + [ + 'name' => 'Name', + 'in' => 'formData', + 'schema' => [ + 'description' => '名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'WorkflowInstance1', + ], + ], + [ + 'name' => 'ProjectId', + 'in' => 'formData', + 'schema' => [ + 'description' => '项目ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '100', + ], + ], + [ + 'name' => 'Owner', + 'in' => 'formData', + 'schema' => [ + 'description' => '责任人的账号ID。', + 'type' => 'string', + 'required' => true, + 'example' => '1000', + ], + ], + [ + 'name' => 'BizDate', + 'in' => 'formData', + 'schema' => [ + 'description' => '业务日期。格式为时间戳。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1710239005403', + ], + ], + [ + 'name' => 'Tasks', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'description' => '任务列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'description' => '任务的名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'SQL node.', + ], + 'Type' => [ + 'description' => '任务类型。', + 'type' => 'string', + 'required' => true, + 'example' => 'ODPS_SQL', + ], + 'Owner' => [ + 'description' => '责任人的账号ID。', + 'type' => 'string', + 'required' => true, + 'example' => '1000', + ], + 'Timeout' => [ + 'description' => '任务执行超时时间，单位为秒。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '3600', + ], + 'Script' => [ + 'description' => '运行脚本信息。', + 'type' => 'object', + 'properties' => [ + 'Content' => [ + 'description' => '脚本内容。', + 'type' => 'string', + 'required' => false, + 'example' => 'echo "helloWorld"', + ], + 'Parameters' => [ + 'description' => '脚本参数列表。', + 'type' => 'string', + 'required' => false, + 'example' => 'para1=$bizdate', + ], + ], + 'required' => false, + ], + 'RuntimeResource' => [ + 'description' => '运行环境配置，如资源组信息。', + 'type' => 'object', + 'properties' => [ + 'ResourceGroupId' => [ + 'description' => '任务运行配置的调度资源组标识符。', + 'type' => 'string', + 'required' => true, + 'example' => 'S_res_group_524258031846018_1684XXXXXXXXX', + ], + 'Image' => [ + 'description' => '任务运行配置的镜像ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'i-xxxxxx', + ], + 'Cu' => [ + 'description' => '任务运行配置CU消耗。', + 'type' => 'string', + 'required' => false, + 'example' => '0.25', + ], + ], + 'required' => true, + ], + 'DataSource' => [ + 'description' => '关联数据源信息。', + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'description' => '数据源名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'mysql_test', + ], + ], + 'required' => false, + ], + 'Inputs' => [ + 'description' => '输入信息。', + 'type' => 'object', + 'properties' => [ + 'Variables' => [ + 'description' => '变量定义列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'description' => '变量名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'key1', + ], + 'Value' => [ + 'description' => '变量值。请以`上游任务Output:上游任务输出变量名`的格式来填写。', + 'type' => 'string', + 'required' => false, + 'example' => 'upstream_task_output:key1', + ], + ], + 'required' => false, + ], + 'required' => false, + ], + ], + 'required' => false, + ], + 'Outputs' => [ + 'description' => '输出信息。', + 'type' => 'object', + 'properties' => [ + 'TaskOutputs' => [ + 'description' => '任务输出定义列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Output' => [ + 'title' => '输出标识符，示例：pre.odps_sql_demo_0', + 'description' => '输出标识符。', + 'type' => 'string', + 'required' => false, + 'example' => 'pre.odps_sql_demo_0', + ], + ], + 'required' => false, + ], + 'required' => false, + ], + 'Variables' => [ + 'description' => '变量定义列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'description' => '变量名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'key1', + ], + 'Type' => [ + 'title' => '类型', + 'description' => '类型。'."\n" + .'- System'."\n" + .'- Constant'."\n" + .'- NodeOutput'."\n" + .'- PassThrough', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [], + 'example' => 'Constant', + 'enum' => [ + 'System', + 'Constant', + 'NodeOutput', + 'PassThrough', + ], + ], + 'Value' => [ + 'description' => '变量值。', + 'type' => 'string', + 'required' => false, + 'example' => 'value1', + ], + ], + 'required' => false, + ], + 'required' => false, + ], + ], + 'required' => false, + ], + 'Dependencies' => [ + 'description' => '依赖信息。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'UpstreamOutput' => [ + 'title' => '依赖任务的输出标识符, DependencyType=Normal时 需要填此值', + 'description' => '依赖任务的输出标识符。', + 'type' => 'string', + 'required' => false, + 'example' => 'pre.odps_sql_demo_0', + ], + ], + 'required' => false, + ], + 'required' => false, + ], + 'ClientUniqueCode' => [ + 'description' => '任务的客户端唯一码，用来唯一标识一个任务。', + 'type' => 'string', + 'required' => true, + 'example' => 'Task_0bc5213917368545132902xxxxxxxx', + ], + ], + 'required' => false, + ], + 'required' => true, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求的ID，用于定位日志，排查问题。', + 'type' => 'string', + 'example' => '22C97E95-F023-56B5-8852-B1A77A17XXXX', + ], + 'WorkflowInstanceId' => [ + 'description' => '工作流实例ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1234', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"22C97E95-F023-56B5-8852-B1A77A17XXXX\\",\\n \\"WorkflowInstanceId\\": 1234\\n}","type":"json"}]', + 'title' => '执行临时工作流实例', + 'summary' => '根据配置创建一个临时工作流实例。', + 'description' => '需要购买DataWorks基础版及以上版本才能使用。', + ], + 'CreateDataQualityTemplate' => [ + 'summary' => '创建数据质量模板。', + 'path' => '', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREdide3WJOKE', + ], + ], + 'parameters' => [ + [ + 'name' => 'ProjectId', + 'in' => 'formData', + 'schema' => [ + 'description' => '项目ID'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '10000', + ], + ], + [ + 'name' => 'Spec', + 'in' => 'formData', + 'schema' => [ + 'description' => '规则模板详细配置Spec代码，详情请参见[数据质量Spec配置说明](~~2963394~~)。', + 'type' => 'string', + 'required' => false, + 'example' => '{'."\n" + .' "assertion": "anomaly detection fro id_not_null_cnt",'."\n" + .' "id_not_null_cnt": {'."\n" + .' "query": "SELECT COUNT(*) AS cnt FROM ${tableName} WHERE dt = \'$[yyyymmdd-1]\';"'."\n" + .' },'."\n" + .' "identity": "819cf1f8-29be-4f94-a9d0-c5c06c0c3d2a"'."\n" + .'}', + ], + ], + [ + 'name' => 'Owner', + 'in' => 'formData', + 'schema' => [ + 'description' => '负责人的ID。', + 'type' => 'string', + 'required' => false, + 'example' => '1000000000001', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '0bc14115***159376359', + ], + 'Id' => [ + 'description' => '新建的规则模板的唯一标识。', + 'type' => 'string', + 'example' => 'USER-DEFINED:2001', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0bc14115***159376359\\",\\n \\"Id\\": \\"USER-DEFINED:2001\\"\\n}","type":"json"}]', + 'title' => '创建数据质量规则模板', + 'description' => '需要购买DataWorks基础版及以上版本才能使用。', + ], + 'UpdateDataQualityTemplate' => [ + 'summary' => '用于更新指定项目下的数据质量规则模板配置。', + 'path' => '', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREdide3WJOKE', + ], + ], + 'parameters' => [ + [ + 'name' => 'Id', + 'in' => 'formData', + 'schema' => [ + 'description' => '自定义规则模板ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'USER_DEFINED:2001', + ], + ], + [ + 'name' => 'ProjectId', + 'in' => 'formData', + 'schema' => [ + 'description' => '项目ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '100001', + ], + ], + [ + 'name' => 'Spec', + 'in' => 'formData', + 'schema' => [ + 'description' => '规则模板详细配置 Spec 代码，详情请参见[数据质量Spec配置说明](~~2963394~~)。', + 'type' => 'string', + 'required' => false, + 'example' => '{'."\n" + .' "assertion": "anomaly detection fro id_not_null_cnt",'."\n" + .' "id_not_null_cnt": {'."\n" + .' "query": "SELECT COUNT(*) AS cnt FROM ${tableName} WHERE dt = \'$[yyyymmdd-1]\';"'."\n" + .' },'."\n" + .' "identity": "819cf1f8-29be-4f94-a9d0-c5c06c0c3d2a"'."\n" + .'}', + ], + ], + [ + 'name' => 'Owner', + 'in' => 'query', + 'schema' => [ + 'description' => '责任人的账号ID。', + 'type' => 'string', + 'required' => false, + 'example' => '95279527****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '0bc14115***159376359', + ], + 'Success' => [ + 'description' => '规则模板是否更新成功。', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0bc14115***159376359\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => '更新数据质量规则模板', + 'description' => '需要购买DataWorks基础版及以上版本才能使用。', + ], + 'ListDataQualityTemplates' => [ + 'summary' => '查询指定项目下的数据质量规则模板列表。', + 'path' => '', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREdide3WJOKE', + ], + ], + 'parameters' => [ + [ + 'name' => 'Catalog', + 'in' => 'query', + 'schema' => [ + 'description' => '数据质量模板所属的目录路径。', + 'type' => 'string', + 'required' => false, + 'example' => '/timeliness/ods_layer', + ], + ], + [ + 'name' => 'ProjectId', + 'in' => 'query', + 'schema' => [ + 'description' => '项目ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '10000', + ], + ], + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => [ + 'description' => '模板规则名称模糊匹配。', + 'type' => 'string', + 'required' => false, + 'example' => 'table_rows', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '结果分页大小，默认为10。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '结果分页页码，默认为1。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '0bc14115***159376359', + ], + 'PageInfo' => [ + 'description' => '数据质量规则模板分页查询结果。', + 'type' => 'object', + 'properties' => [ + 'TotalCount' => [ + 'description' => '总条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'PageSize' => [ + 'description' => '页数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + 'PageNumber' => [ + 'description' => '页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'DataQualityTemplates' => [ + 'description' => '规则模板列表。', + 'type' => 'array', + 'items' => [ + 'description' => '规则模板。', + 'type' => 'object', + 'properties' => [ + 'ModifyTime' => [ + 'description' => '数据质量规则模板更新时间。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1729816478147', + ], + 'Owner' => [ + 'description' => '数据质量规则模板责任人。', + 'type' => 'string', + 'example' => '205250754596036836', + ], + 'ModifyUser' => [ + 'description' => '数据质量规则模板最近更新人。', + 'type' => 'string', + 'example' => '205250754596036836', + ], + 'CreateTime' => [ + 'description' => '数据质量规则模板创建时间。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1729816478147', + ], + 'ProjectId' => [ + 'description' => '项目ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '7635', + ], + 'CreateUser' => [ + 'description' => '数据质量规则模板创建人。', + 'type' => 'string', + 'example' => '7892346529452', + ], + 'Id' => [ + 'description' => '数据质量规则模板ID。', + 'type' => 'string', + 'example' => '819cf1f8-29be-4f94-a9d0-c5c06c0c3d2a', + ], + 'Spec' => [ + 'description' => '数据质量规则模板的具体配置。具体含义，请参见[数据质量Spec配置说明](~~2963394~~)', + 'type' => 'string', + 'example' => '{'."\n" + .' "assertion": "anomaly detection fro id_not_null_cnt",'."\n" + .' "id_not_null_cnt": {'."\n" + .' "query": "SELECT COUNT(*) AS cnt FROM ${tableName} WHERE dt = \'$[yyyymmdd-1]\';"'."\n" + .' },'."\n" + .' "identity": "819cf1f8-29be-4f94-a9d0-c5c06c0c3d2a"'."\n" + .'}', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0bc14115***159376359\\",\\n \\"PageInfo\\": {\\n \\"TotalCount\\": 10,\\n \\"PageSize\\": 20,\\n \\"PageNumber\\": 1,\\n \\"DataQualityTemplates\\": [\\n {\\n \\"ModifyTime\\": 1729816478147,\\n \\"Owner\\": \\"205250754596036836\\",\\n \\"ModifyUser\\": \\"205250754596036836\\",\\n \\"CreateTime\\": 1729816478147,\\n \\"ProjectId\\": 7635,\\n \\"CreateUser\\": \\"7892346529452\\",\\n \\"Id\\": \\"819cf1f8-29be-4f94-a9d0-c5c06c0c3d2a\\",\\n \\"Spec\\": \\"{\\\\n \\\\\\"assertion\\\\\\": \\\\\\"anomaly detection fro id_not_null_cnt\\\\\\",\\\\n \\\\\\"id_not_null_cnt\\\\\\": {\\\\n \\\\\\"query\\\\\\": \\\\\\"SELECT COUNT(*) AS cnt FROM ${tableName} WHERE dt = \'$[yyyymmdd-1]\';\\\\\\"\\\\n },\\\\n \\\\\\"identity\\\\\\": \\\\\\"819cf1f8-29be-4f94-a9d0-c5c06c0c3d2a\\\\\\"\\\\n}\\"\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => '数据质量规则模板列表查询', + 'description' => '需要购买DataWorks基础版及以上版本才能使用。', + ], + 'GetDataQualityTemplate' => [ + 'summary' => '根据ID查询指定的数据质量规则模板详情。', + 'path' => '', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREdide3WJOKE', + ], + ], + 'parameters' => [ + [ + 'name' => 'Id', + 'in' => 'query', + 'schema' => [ + 'description' => '数据质量规则模板ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'a7ef0634-20ec-4a7c-a214-54020f91XXXX', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '0bc14115***159376359', + ], + 'DataQualityTemplate' => [ + 'description' => '数据质量规则模板。', + 'type' => 'object', + 'properties' => [ + 'Id' => [ + 'description' => '数据质量规则模板ID。', + 'type' => 'string', + 'example' => '10001', + ], + 'ProjectId' => [ + 'description' => '项目ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '97535', + ], + 'CreateTime' => [ + 'description' => '数据质量规则模板创建时间。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1606724043000', + ], + 'ModifyTime' => [ + 'description' => '数据质量规则模板更新时间。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1606724043000', + ], + 'CreateUser' => [ + 'description' => '数据质量规则模板创建人。', + 'type' => 'string', + 'example' => '238428342865', + ], + 'ModifyUser' => [ + 'description' => '数据质量规则模板最近更新人。', + 'type' => 'string', + 'example' => '238428342865', + ], + 'Spec' => [ + 'description' => '数据质量规则模板的具体配置，具体含义，请参见[数据质量Spec配置说明](~~2963394~~)。', + 'type' => 'string', + 'example' => '{'."\n" + .' "assertion": "anomaly detection fro id_not_null_cnt",'."\n" + .' "id_not_null_cnt": {'."\n" + .' "query": "SELECT COUNT(*) AS cnt FROM ${tableName} WHERE dt = \'$[yyyymmdd-1]\';"'."\n" + .' },'."\n" + .' "identity": "819cf1f8-29be-4f94-a9d0-c5c06c0c3d2a"'."\n" + .'}', + ], + 'Owner' => [ + 'description' => '数据质量规则模板负责人。', + 'type' => 'string', + 'example' => '238428342865', + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0bc14115***159376359\\",\\n \\"DataQualityTemplate\\": {\\n \\"Id\\": \\"10001\\",\\n \\"ProjectId\\": 97535,\\n \\"CreateTime\\": 1606724043000,\\n \\"ModifyTime\\": 1606724043000,\\n \\"CreateUser\\": \\"238428342865\\",\\n \\"ModifyUser\\": \\"238428342865\\",\\n \\"Spec\\": \\"{\\\\n \\\\\\"assertion\\\\\\": \\\\\\"anomaly detection fro id_not_null_cnt\\\\\\",\\\\n \\\\\\"id_not_null_cnt\\\\\\": {\\\\n \\\\\\"query\\\\\\": \\\\\\"SELECT COUNT(*) AS cnt FROM ${tableName} WHERE dt = \'$[yyyymmdd-1]\';\\\\\\"\\\\n },\\\\n \\\\\\"identity\\\\\\": \\\\\\"819cf1f8-29be-4f94-a9d0-c5c06c0c3d2a\\\\\\"\\\\n}\\",\\n \\"Owner\\": \\"238428342865\\"\\n }\\n}","type":"json"}]', + 'title' => '获取数据质量规则模板', + 'description' => '需要购买DataWorks基础版及以上版本才能使用。', + ], + 'DeleteDataQualityTemplate' => [ + 'summary' => '根据指定ID删除数据质量规则模板。', + 'path' => '', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREdide3WJOKE', + ], + ], + 'parameters' => [ + [ + 'name' => 'Id', + 'in' => 'formData', + 'schema' => [ + 'description' => '自定义规则模板ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'USER_DEFINED:2001', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '0bc14115****159376359', + ], + 'Success' => [ + 'description' => '删除成功。', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0bc14115****159376359\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => '删除数据质量规则模板', + 'description' => '## 请求说明'."\n" + ."\n" + .'- **Id**: 自定义规则模板的唯一标识符，格式为`USER_DEFINED:<template_id>`。'."\n" + .'- **ProjectId**: 规则模板所属的DataWorks项目ID。'."\n" + ."\n" + .'该API用于从系统中移除不再需要的数据质量规则模板。调用时需确保提供的`Id`和`ProjectId`准确无误，否则可能无法成功执行删除操作或导致非预期的数据丢失。请谨慎使用此功能，并在操作前确认相关模板的确切信息。'."\n", + ], + 'CreateDataQualityScan' => [ + 'summary' => '创建数据质量监控。', + 'path' => '', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREdide3WJOKE', + ], + ], + 'parameters' => [ + [ + 'name' => 'Description', + 'in' => 'formData', + 'schema' => [ + 'description' => '数据质量监控描述信息。', + 'type' => 'string', + 'required' => false, + 'example' => 'Daily data quality scanning of ods tables.', + ], + ], + [ + 'name' => 'ProjectId', + 'in' => 'formData', + 'schema' => [ + 'description' => 'DataWorks工作空间的ID。您可以登录[DataWorks控制台](https://dataworks.console.aliyun.com/overview)，进入工作空间配置页面获取工作空间ID。需要用该参数来确定本次API调用操作的DataWorks工作空间。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '101', + ], + ], + [ + 'name' => 'Owner', + 'in' => 'formData', + 'schema' => [ + 'description' => '数据质量监控负责人用户ID。', + 'type' => 'string', + 'required' => false, + 'example' => '95279527****', + ], + ], + [ + 'name' => 'Spec', + 'in' => 'formData', + 'schema' => [ + 'description' => '数据质量监控的内容的Spec代码，详情请参见[数据质量Spec配置说明](~~2963394~~)。', + 'type' => 'string', + 'required' => false, + 'example' => '{'."\n" + .' "datasets": ['."\n" + .' {'."\n" + .' "type": "Table",'."\n" + .' "dataSource": {'."\n" + .' "name": "odps_first",'."\n" + .' "envType": "Prod"'."\n" + .' },'."\n" + .' "tables": ['."\n" + .' "ods_d_user_info"'."\n" + .' ],'."\n" + .' "filter": "pt = $[yyyymmdd-1]"'."\n" + .' }'."\n" + .' ],'."\n" + .' "rules": ['."\n" + .' {'."\n" + .' "assertion": "row_count > 0"'."\n" + .' }, {'."\n" + .' "templateId": "SYSTEM:field:null_value:fixed",'."\n" + .' "pass": "when = 0",'."\n" + .' "name": "The id cannot be empty.",'."\n" + .' "severity": "High",'."\n" + .' "identity": "a-customized-data-quality-rule-uuid"'."\n" + .' }'."\n" + .' ]'."\n" + .'}', + ], + ], + [ + 'name' => 'Parameters', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'description' => '数据质量监控执行参数定义。', + 'type' => 'array', + 'items' => [ + 'description' => '数据质量监控执行参数定义。', + 'type' => 'object', + 'properties' => [ + 'Value' => [ + 'description' => '参数值。', + 'type' => 'string', + 'required' => false, + 'example' => '$[yyyymmdd-1]', + ], + 'Name' => [ + 'description' => '参数名。', + 'type' => 'string', + 'required' => false, + 'example' => 'triggerTime', + ], + ], + 'required' => false, + ], + 'required' => false, + ], + ], + [ + 'name' => 'RuntimeResource', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'description' => '数据质量监控运行时，使用的资源组。', + 'type' => 'object', + 'properties' => [ + 'Id' => [ + 'description' => '资源组ID。', + 'type' => 'string', + 'required' => false, + 'example' => '0525242e-d0ee-4bda-bc73-765d82f6a34a', + ], + 'Cu' => [ + 'description' => '运行配置CU消耗。', + 'type' => 'number', + 'format' => 'float', + 'required' => false, + 'example' => '0.25', + ], + 'Image' => [ + 'description' => '运行配置的镜像ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'i-xxxxxx', + ], + ], + 'required' => false, + ], + ], + [ + 'name' => 'ComputeResource', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'description' => '数据质量监控在运行时使用的计算引擎，可空，如果没有指定，则使用Spec中所指定的数据源连接。', + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'description' => '计算引擎名字，唯一标识。', + 'type' => 'string', + 'required' => false, + 'example' => 'emr_first', + ], + 'Runtime' => [ + 'description' => '数据质量监控在运行时的更多设置。', + 'type' => 'object', + 'properties' => [ + 'Engine' => [ + 'description' => '使用的引擎类型，只有EMR计算引擎支持设置这部分内容。'."\n" + .'取值范围：'."\n" + .'- Hive：Hive SQL'."\n" + .'- Spark：Spark SQL'."\n" + .'- Kyuubi', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [], + 'example' => 'Hive', + ], + 'SparkConf' => [ + 'description' => '使用Spark引擎时，更多的参数设置，目前只支持通过spark.yarn.queue设置队列。', + 'type' => 'object', + 'required' => false, + 'example' => 'spark.yarn.queue=dq_queue', + ], + 'HiveConf' => [ + 'description' => '使用Hive引擎时，更多的参数设置，目前只支持通过mapreduce.job.queuename设置队列。', + 'type' => 'object', + 'required' => false, + 'example' => 'mapreduce.job.queuename=dq_queue', + ], + ], + 'required' => false, + ], + 'EnvType' => [ + 'description' => '计算引擎所属的工作空间环境。取值范围：'."\n" + .'- Prod：生产环境'."\n" + .'- Dev：开发环境', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [], + 'example' => 'Dev', + 'enum' => [ + 'Prod', + 'Dev', + ], + ], + ], + 'required' => false, + ], + ], + [ + 'name' => 'Trigger', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'description' => '数据质量监控触发设置。', + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'description' => '数据质量监控触发方式。取值范围：'."\n" + .'- ByManual：手动触发，默认设置'."\n" + .'- BySchedule：调度任务实例触发', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [], + 'example' => 'BySchedule', + ], + 'TaskIds' => [ + 'description' => '当触发方式为BySchedule时，需要配置触发质量监控的调度任务ID。', + 'type' => 'array', + 'items' => [ + 'description' => '调度任务ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1004979033', + ], + 'required' => false, + ], + ], + 'required' => false, + ], + ], + [ + 'name' => 'Hooks', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'description' => '数据质量监控运行结束后的Hook配置。', + 'type' => 'array', + 'items' => [ + 'description' => '数据质量监控运行结束后的Hook配置。', + 'type' => 'object', + 'properties' => [ + 'Condition' => [ + 'description' => 'Hook触发条件，当满足这个条件时，会触发Hook运行。目前只支持一种表达式写法：'."\n" + ."\n" + .'指定多组规则严重类型和规则校验状态，如`results.any { r -> r.status == \'Fail\' && r.rule.severity == \'Normal\' || r.status == \'Error\' && r.rule.severity == \'High\' || r.status == \'Warn\' && r.rule.severity == \'High\' }`，代表执行的规则中，如果有severity为Normal的规则校验结果是Fail、或者severity为High的规则校验结果是Error、或者severity为High的规则校验结果是Warn，则满足条件。条件表达式中severity的枚举与Spec中severity的枚举一致、status的枚举与DataQualityResult中的status一致。', + 'type' => 'string', + 'required' => false, + 'example' => 'results.any { r -> r.status == \'Fail\' && r.rule.severity == \'Normal\' || r.status == \'Error\' && r.rule.severity == \'High\' || r.status == \'Warn\' && r.rule.severity == \'High\' }', + ], + 'Type' => [ + 'description' => 'Hook类型。取值范围：'."\n" + .'- BlockTaskInstance：阻塞任务实例调度', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [], + 'example' => 'BlockTaskInstance', + ], + ], + 'required' => false, + ], + 'required' => false, + ], + ], + [ + 'name' => 'Name', + 'in' => 'formData', + 'schema' => [ + 'description' => '数据质量监控名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'data_quality_scan_001', + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'formData', + 'schema' => [ + 'description' => '幂等参数。', + 'type' => 'string', + 'required' => true, + 'example' => 'a-customized-uuid', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求 ID。', + 'type' => 'string', + 'example' => '0000-ABCD-EFG****', + ], + 'Id' => [ + 'description' => '返回创建的数据源分享规则ID，数据源分享规则的唯一标识符。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '676303114031776', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0000-ABCD-EFG****\\",\\n \\"Id\\": 676303114031776\\n}","type":"json"}]', + 'title' => '创建数据质量监控', + 'description' => '需要购买DataWorks基础版及以上版本才能使用', + ], + 'UpdateDataQualityScan' => [ + 'summary' => '更新数据质量监控。', + 'path' => '', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREdide3WJOKE', + ], + ], + 'parameters' => [ + [ + 'name' => 'Description', + 'in' => 'formData', + 'schema' => [ + 'description' => '数据质量监控描述信息。', + 'type' => 'string', + 'required' => false, + 'example' => 'Daily data quality scanning of ods tables.', + ], + ], + [ + 'name' => 'ProjectId', + 'in' => 'formData', + 'schema' => [ + 'description' => '数据质量监控所在的DataWorks工作空间ID。您可以通过[ListProjects](~~2852607~~)接口获取工作空间ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '101', + ], + ], + [ + 'name' => 'Id', + 'in' => 'formData', + 'schema' => [ + 'description' => '数据质量监控ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '10001', + ], + ], + [ + 'name' => 'Owner', + 'in' => 'formData', + 'schema' => [ + 'description' => '数据质量监控负责人用户ID。', + 'type' => 'string', + 'required' => false, + 'example' => '231263586109857423', + ], + ], + [ + 'name' => 'Spec', + 'in' => 'formData', + 'schema' => [ + 'description' => '数据质量监控的内容的Spec代码，详情请参见[数据质量Spec配置说明](~~2963394~~)。', + 'type' => 'string', + 'required' => false, + 'example' => '{'."\n" + .' "datasets": ['."\n" + .' {'."\n" + .' "type": "Table",'."\n" + .' "dataSource": {'."\n" + .' "name": "odps_first",'."\n" + .' "envType": "Prod"'."\n" + .' },'."\n" + .' "tables": ['."\n" + .' "ods_d_user_info"'."\n" + .' ],'."\n" + .' "filter": "pt = $[yyyymmdd-1]"'."\n" + .' }'."\n" + .' ],'."\n" + .' "rules": ['."\n" + .' {'."\n" + .' "assertion": "row_count > 0"'."\n" + .' }, {'."\n" + .' "templateId": "SYSTEM:field:null_value:fixed",'."\n" + .' "pass": "when = 0",'."\n" + .' "name": "The id cannot be empty.",'."\n" + .' "severity": "High",'."\n" + .' "identity": "a-customized-data-quality-rule-uuid"'."\n" + .' }'."\n" + .' ]'."\n" + .'}', + ], + ], + [ + 'name' => 'Parameters', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'description' => '数据质量监控执行参数定义。', + 'type' => 'array', + 'items' => [ + 'description' => '参数信息。', + 'type' => 'object', + 'properties' => [ + 'Value' => [ + 'description' => '参数值。', + 'type' => 'string', + 'required' => false, + 'example' => 'smtp.qiye.aliyun.com', + ], + 'Name' => [ + 'description' => '参数名。', + 'type' => 'string', + 'required' => false, + 'example' => 'temp_237669.zip_byBwm_1734661241752', + ], + ], + 'required' => false, + ], + 'required' => false, + ], + ], + [ + 'name' => 'RuntimeResource', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'description' => '数据质量监控运行时，使用的资源组。', + 'type' => 'object', + 'properties' => [ + 'Id' => [ + 'description' => '资源组ID。', + 'type' => 'string', + 'required' => false, + 'example' => '20315', + ], + 'Cu' => [ + 'description' => '运行配置CU消耗。', + 'type' => 'number', + 'format' => 'float', + 'required' => false, + 'example' => '0.25', + ], + 'Image' => [ + 'description' => '任务运行配置的镜像ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'i-xxxxxx', + ], + ], + 'required' => false, + ], + ], + [ + 'name' => 'ComputeResource', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'description' => '数据质量监控在运行时使用的计算引擎，可空，如果没有指定，则使用Spec中所指定的数据源连接。', + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'description' => '计算引擎名称，唯一标识。', + 'type' => 'string', + 'required' => false, + 'example' => 'auto_createAlertRule_Finished_1kUTk6', + ], + 'Runtime' => [ + 'description' => '使用计算引擎时的更多设置。', + 'type' => 'object', + 'properties' => [ + 'Engine' => [ + 'description' => '使用的引擎类型，只有EMR计算引擎支持设置这部分内容。 取值范围：'."\n" + .'- Hive：Hive SQL'."\n" + .'- Spark：Spark SQL'."\n" + .'- Kyuubi', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [], + 'example' => 'Hive', + ], + 'SparkConf' => [ + 'description' => '使用Spark引擎时，更多的参数设置，目前只支持通过spark.yarn.queue设置队列。', + 'type' => 'object', + 'required' => false, + 'example' => 'spark.yarn.queue=dq_queue', + ], + 'HiveConf' => [ + 'description' => '使用Hive引擎时，更多的参数设置，目前只支持通过mapreduce.job.queuename设置队列。', + 'type' => 'object', + 'required' => false, + 'example' => 'mapreduce.job.queuename=dq_queue', + ], + ], + 'required' => false, + ], + 'EnvType' => [ + 'description' => '计算引擎所属的项目环境。取值范围：'."\n" + .'- Prod：生产环境'."\n" + .'- Dev：开发环境', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [], + 'example' => 'Prod', + 'enum' => [ + 'Prod', + 'Dev', + ], + ], + ], + 'required' => false, + ], + ], + [ + 'name' => 'Trigger', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'description' => '数据质量监控触发设置。', + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'description' => '数据质量监控触发方式。取值范围：'."\n" + .'- ByManual：手动触发，默认设置'."\n" + .'- BySchedule：调度任务实例触发', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [], + 'example' => 'BySchedule', + ], + 'TaskIds' => [ + 'description' => '当触发方式为BySchedule时，需要配置触发质量监控的调度任务ID。', + 'type' => 'array', + 'items' => [ + 'description' => '调度任务Id。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '30001', + ], + 'required' => false, + ], + ], + 'required' => false, + ], + ], + [ + 'name' => 'Hooks', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'description' => '数据质量监控运行结束后的Hook配置。', + 'type' => 'array', + 'items' => [ + 'description' => '数据质量监控运行结束后的Hook配置。', + 'type' => 'object', + 'properties' => [ + 'Condition' => [ + 'description' => 'Hook触发条件，当满足这个条件时，会触发Hook运行。目前只支持一种表达式写法：'."\n" + ."\n" + .'指定多组规则严重类型和规则校验状态，如`results.any { r -> r.status == \'Fail\' && r.rule.severity == \'Normal\' || r.status == \'Error\' && r.rule.severity == \'High\' || r.status == \'Warn\' && r.rule.severity == \'High\' }`，代表执行的规则中，如果有severity为Normal的规则校验结果是Fail、或者severity为High的规则校验结果是Error、或者severity为High的规则校验结果是Warn，则满足条件。条件表达式中severity的枚举与Spec中severity的枚举一致、status的枚举与DataQualityResult中的status一致。', + 'type' => 'string', + 'required' => false, + 'example' => 'results.any { r -> r.status == \'Fail\' && r.rule.severity == \'Normal\' || r.status == \'Error\' && r.rule.severity == \'High\' || r.status == \'Warn\' && r.rule.severity == \'High\' }', + ], + 'Type' => [ + 'description' => 'Hook类型。取值范围：'."\n" + .'- BlockTaskInstance：阻塞任务实例调度', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [], + 'example' => 'BlockTaskInstance', + 'enum' => [ + 'BlockTaskInstance', + ], + ], + ], + 'required' => false, + ], + 'required' => false, + ], + ], + [ + 'name' => 'Name', + 'in' => 'formData', + 'schema' => [ + 'description' => '数据质量监控名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'data_quality_scan_001', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求 ID。', + 'type' => 'string', + 'example' => '22C97E95-F023-56B5-8852-B1A77A1****', + ], + 'Success' => [ + 'description' => '调用是否成功。', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"22C97E95-F023-56B5-8852-B1A77A1****\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => '更新数据质量监控', + 'description' => '需要购买DataWorks基础版及以上版本才能使用', + ], + 'ListDataQualityScans' => [ + 'summary' => '查询指定项目下的数据质量校验任务列表。', + 'path' => '', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREdide3WJOKE', + ], + ], + 'parameters' => [ + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => [ + 'description' => '模糊匹配数据质量校验任务名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'test', + ], + ], + [ + 'name' => 'SortBy', + 'in' => 'query', + 'schema' => [ + 'description' => '排序字段列表，支持修改时间、创建时间等字段，格式为"排序字段+排序方式(Desc/Asc)"（默认Asc，可以省略）。排序字段的枚举值如下：'."\n" + ."\n" + .'- ModifyTime (Desc/Asc)'."\n" + .'- CreateTime (Desc/Asc)'."\n" + .'- Id (Desc/Asc)', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [], + 'example' => 'ModifyTime Desc', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '列表翻页大小，默认为10。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '10', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '列表翻页页码，默认为1。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'maximum' => '200', + 'minimum' => '1', + 'example' => '1', + ], + ], + [ + 'name' => 'ProjectId', + 'in' => 'query', + 'schema' => [ + 'description' => '项目ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '10000', + ], + ], + [ + 'name' => 'Table', + 'in' => 'query', + 'schema' => [ + 'description' => '模糊匹配监控的表名。', + 'type' => 'string', + 'required' => false, + 'example' => 'video_album', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '0bc14115***159376359', + ], + 'PageInfo' => [ + 'description' => '分页信息。', + 'type' => 'object', + 'properties' => [ + 'PageNumber' => [ + 'description' => '页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '列表翻页大小，默认为10。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'TotalCount' => [ + 'description' => '总条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'DataQualityScans' => [ + 'description' => '数据质量监控列表。', + 'type' => 'array', + 'items' => [ + 'description' => '数据质量监控信息。', + 'type' => 'object', + 'properties' => [ + 'ModifyTime' => [ + 'description' => '数据质量监控更新时间。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '17236236472', + ], + 'Owner' => [ + 'description' => '数据质量监控责任人用户ID。', + 'type' => 'string', + 'example' => '23782382795249', + ], + 'Description' => [ + 'description' => '数据质量校验任务描述，最长65535个字符。'."\n", + 'type' => 'string', + 'example' => 'This is a hourly run data quality evaluation plan.', + ], + 'ModifyUser' => [ + 'description' => '数据质量监控最近更新人用户ID。', + 'type' => 'string', + 'example' => '23782382795249', + ], + 'Parameters' => [ + 'description' => '数据质量监控执行参数定义。', + 'type' => 'array', + 'items' => [ + 'description' => '数据质量监控执行参数定义。', + 'type' => 'object', + 'properties' => [ + 'Value' => [ + 'description' => '参数值。', + 'type' => 'string', + 'example' => '$[yyyy-mm-dd-1]', + ], + 'Name' => [ + 'description' => '参数名。', + 'type' => 'string', + 'example' => 'dt', + ], + ], + ], + ], + 'CreateTime' => [ + 'description' => '数据质量监控创建时间。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1694512304000', + ], + 'ProjectId' => [ + 'description' => '项目ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '59094', + ], + 'CreateUser' => [ + 'description' => '数据质量监控创建人。', + 'type' => 'string', + 'example' => '7892346529452', + ], + 'ComputeResource' => [ + 'description' => '数据质量监控在运行时使用的计算引擎，可空，如果没有指定，则使用Spec中所指定的数据源连接。', + 'type' => 'object', + 'properties' => [ + 'Runtime' => [ + 'description' => '数据质量监控在运行时的更多设置。', + 'type' => 'object', + 'properties' => [ + 'HiveConf' => [ + 'description' => '使用Hive引擎时，更多的参数设置，目前只支持通过mapreduce.job.queuename设置队列。', + 'type' => 'string', + 'example' => 'mapreduce.job.queuename=dq_queue', + ], + 'SparkConf' => [ + 'description' => '使用Spark引擎时，更多的参数设置，目前只支持通过spark.yarn.queue设置队列。', + 'type' => 'string', + 'example' => 'spark.yarn.queue=dq_queue', + ], + 'Engine' => [ + 'description' => '使用的引擎类型，只有EMR计算引擎支持设置这部分内容。取值范围：'."\n" + ."\n" + .'- Hive：Hive SQL'."\n" + .'- Spark：Spark SQL'."\n" + .'- Kyuubi', + 'type' => 'string', + 'enumValueTitles' => [], + 'example' => 'Hive', + ], + ], + ], + 'EnvType' => [ + 'description' => '计算引擎所属的工作空间环境。取值范围：'."\n" + ."\n" + .'- Prod：生产环境'."\n" + .'- Dev：开发环境', + 'type' => 'string', + 'enumValueTitles' => [], + 'example' => 'Prod', + ], + 'Name' => [ + 'description' => '计算引擎名字，唯一标识。', + 'type' => 'string', + 'example' => 'emr_cluster_001', + ], + ], + ], + 'Name' => [ + 'description' => '数据质量校验任务名称，数字、英文字母、汉字、半角全角标点符号组合，最长255个字符。'."\n", + 'type' => 'string', + 'example' => 'Hourly partition quality monitoring', + ], + 'RuntimeResource' => [ + 'description' => '数据质量监控运行时，使用的资源组。', + 'type' => 'object', + 'properties' => [ + 'Cu' => [ + 'description' => '任务运行配置CU消耗。', + 'type' => 'number', + 'format' => 'float', + 'example' => '0.25', + ], + 'Id' => [ + 'description' => '资源组ID。', + 'type' => 'string', + 'example' => 'Serverless_resource_group_xxxxx', + ], + 'Image' => [ + 'description' => '任务运行配置的镜像ID。', + 'type' => 'string', + 'example' => 'i-xxxxx', + ], + ], + ], + 'Trigger' => [ + 'description' => '数据质量监控触发设置。', + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'description' => '数据质量监控触发方式。取值范围：'."\n" + ."\n" + .'- ByManual：手动触发，默认设置'."\n" + .'- BySchedule：调度任务实例触发', + 'type' => 'string', + 'enumValueTitles' => [], + 'example' => 'BySchedule', + ], + 'TaskIds' => [ + 'description' => '当触发方式为BySchedule时，需要配置触发质量监控的调度任务ID。', + 'type' => 'array', + 'items' => [ + 'description' => '调度任务ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1023777390', + ], + ], + ], + ], + 'Hooks' => [ + 'description' => '数据质量监控运行结束后的Hook配置。', + 'type' => 'array', + 'items' => [ + 'description' => '数据质量监控运行结束后的Hook配置。', + 'type' => 'object', + 'properties' => [ + 'Condition' => [ + 'description' => 'Hook触发条件，当满足这个条件时，会触发Hook运行。目前只支持一种表达式写法：'."\n" + ."\n" + .'指定多组规则严重类型和规则校验状态，如`results.any { r -> r.status == \'Fail\' && r.rule.severity == \'Normal\' || r.status == \'Error\' && r.rule.severity == \'High\' || r.status == \'Warn\' && r.rule.severity == \'High\' }`，代表执行的规则中，如果有severity为Normal的规则校验结果是Fail、或者severity为High的规则校验结果是Error、或者severity为High的规则校验结果是Warn，则满足条件。条件表达式中severity的枚举与Spec中severity的枚举一致、status的枚举与DataQualityResult中的status一致。', + 'type' => 'string', + 'example' => 'results.any { r -> r.status == \'Fail\' && r.rule.severity == \'Normal\' || r.status == \'Error\' && r.rule.severity == \'High\' || r.status == \'Warn\' && r.rule.severity == \'High\' }', + ], + 'Type' => [ + 'description' => 'Hook类型。取值范围：'."\n" + ."\n" + .'- BlockTaskInstance：阻塞任务实例调度', + 'type' => 'string', + 'enumValueTitles' => [], + 'example' => 'BlockTaskInstance', + ], + ], + ], + ], + 'Id' => [ + 'description' => '数据质量监控ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '26433', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0bc14115***159376359\\",\\n \\"PageInfo\\": {\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 1,\\n \\"DataQualityScans\\": [\\n {\\n \\"ModifyTime\\": 17236236472,\\n \\"Owner\\": \\"23782382795249\\",\\n \\"Description\\": \\"This is a hourly run data quality evaluation plan.\\",\\n \\"ModifyUser\\": \\"23782382795249\\",\\n \\"Parameters\\": [\\n {\\n \\"Value\\": \\"$[yyyy-mm-dd-1]\\",\\n \\"Name\\": \\"dt\\"\\n }\\n ],\\n \\"CreateTime\\": 1694512304000,\\n \\"ProjectId\\": 59094,\\n \\"CreateUser\\": \\"7892346529452\\",\\n \\"ComputeResource\\": {\\n \\"Runtime\\": {\\n \\"HiveConf\\": \\"mapreduce.job.queuename=dq_queue\\",\\n \\"SparkConf\\": \\"spark.yarn.queue=dq_queue\\",\\n \\"Engine\\": \\"Hive\\"\\n },\\n \\"EnvType\\": \\"Prod\\",\\n \\"Name\\": \\"emr_cluster_001\\"\\n },\\n \\"Name\\": \\"Hourly partition quality monitoring\\",\\n \\"RuntimeResource\\": {\\n \\"Cu\\": 0.25,\\n \\"Id\\": \\"Serverless_resource_group_xxxxx\\",\\n \\"Image\\": \\"i-xxxxx\\"\\n },\\n \\"Trigger\\": {\\n \\"Type\\": \\"BySchedule\\",\\n \\"TaskIds\\": [\\n 1023777390\\n ]\\n },\\n \\"Hooks\\": [\\n {\\n \\"Condition\\": \\"results.any { r -> r.status == \'Fail\' && r.rule.severity == \'Normal\' || r.status == \'Error\' && r.rule.severity == \'High\' || r.status == \'Warn\' && r.rule.severity == \'High\' }\\",\\n \\"Type\\": \\"BlockTaskInstance\\"\\n }\\n ],\\n \\"Id\\": 26433\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => '数据质量校验任务列表查询', + 'description' => '需要购买DataWorks基础版及以上版本才能使用。', + ], + 'GetDataQualityScan' => [ + 'summary' => '获取数据质量监控详情。', + 'path' => '', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREdide3WJOKE', + ], + ], + 'parameters' => [ + [ + 'name' => 'Id', + 'in' => 'query', + 'schema' => [ + 'description' => '数据质量监控ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '10001', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '204EAF68-CCE3-5112-8DA0-E7A60F02XXXX', + ], + 'DataQualityScan' => [ + 'description' => '数据质量监控详情。', + 'type' => 'object', + 'properties' => [ + 'Id' => [ + 'description' => '数据质量监控ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10001', + ], + 'Name' => [ + 'description' => '数据质量监控名称。', + 'type' => 'string', + 'example' => 'data_quality_scan_001', + ], + 'Description' => [ + 'description' => '数据质量监控描述信息。', + 'type' => 'string', + 'example' => 'aily data quality scanning of ods tables.', + ], + 'ProjectId' => [ + 'description' => '数据质量监控所在的DataWorks工作空间ID。您可以通过[ListProjects](~~2780068~~)接口获取工作空间ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '101', + ], + 'CreateTime' => [ + 'description' => '数据质量监控创建时间。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1731550150000', + ], + 'ModifyTime' => [ + 'description' => '数据质量监控最近修改时间。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1731550150000', + ], + 'CreateUser' => [ + 'description' => '数据质量监控创建人用户ID。', + 'type' => 'string', + 'example' => '2374924198591250', + ], + 'ModifyUser' => [ + 'description' => '数据质量监控最近修改人用户ID。', + 'type' => 'string', + 'example' => '23482597582479', + ], + 'Owner' => [ + 'description' => '数据质量监控负责人用户ID。', + 'type' => 'string', + 'example' => '231263586109857423', + ], + 'Spec' => [ + 'description' => '数据质量监控的内容的Spec代码，详情请参见[数据质量Spec配置说明](~~2963394~~)。', + 'type' => 'string', + 'example' => '{'."\n" + .' "datasets": ['."\n" + .' {'."\n" + .' "type": "Table",'."\n" + .' "dataSource": {'."\n" + .' "name": "odps_first",'."\n" + .' "envType": "Prod"'."\n" + .' },'."\n" + .' "tables": ['."\n" + .' "ods_d_user_info"'."\n" + .' ],'."\n" + .' "filter": "pt = $[yyyymmdd-1]"'."\n" + .' }'."\n" + .' ],'."\n" + .' "rules": ['."\n" + .' {'."\n" + .' "assertion": "row_count > 0"'."\n" + .' }, {'."\n" + .' "templateId": "SYSTEM:field:null_value:fixed",'."\n" + .' "pass": "when = 0",'."\n" + .' "name": "The id cannot be empty.",'."\n" + .' "severity": "High",'."\n" + .' "identity": "a-customized-data-quality-rule-uuid"'."\n" + .' }'."\n" + .' ]'."\n" + .'}', + ], + 'Parameters' => [ + 'description' => '数据质量监控执行参数定义。', + 'type' => 'array', + 'items' => [ + 'description' => '参数信息。', + 'type' => 'object', + 'properties' => [ + 'Value' => [ + 'description' => '参数名。', + 'type' => 'string', + 'example' => '10', + ], + 'Name' => [ + 'description' => '参数值。', + 'type' => 'string', + 'example' => 'e2e_autolabel', + ], + ], + ], + ], + 'ComputeResource' => [ + 'description' => '数据质量监控在运行时使用的计算引擎，可空，如果没有指定，则使用Spec中所指定的数据源连接。', + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'description' => '计算引擎名字，唯一标识。', + 'type' => 'string', + 'example' => 'polardb_to_holo', + ], + 'Runtime' => [ + 'description' => '数据质量监控在运行时的更多设置。', + 'type' => 'object', + 'properties' => [ + 'Engine' => [ + 'description' => '使用的引擎类型，只有EMR计算引擎支持设置这部分内容。取值范围：'."\n" + ."\n" + .'- Hive：Hive SQL'."\n" + .'- Spark：Spark SQL'."\n" + .'- Kyuubi', + 'type' => 'string', + 'enumValueTitles' => [], + 'example' => 'Hive', + ], + 'HiveConf' => [ + 'description' => '使用Hive引擎时，更多的参数设置，目前只支持通过mapreduce.job.queuename设置队列。', + 'type' => 'object', + 'example' => 'mapreduce.job.queuename=dq_queue', + ], + 'SparkConf' => [ + 'description' => '使用Spark引擎时，更多的参数设置，目前只支持通过spark.yarn.queue设置队列。', + 'type' => 'object', + 'example' => 'spark.yarn.queue=dq_queue'."\n", + ], + ], + ], + 'EnvType' => [ + 'description' => '计算引擎所属的工作空间环境。取值范围：'."\n" + ."\n" + .'- Prod：生产环境'."\n" + .'- Dev：开发环境', + 'type' => 'string', + 'enumValueTitles' => [], + 'example' => 'Prod', + ], + ], + ], + 'RuntimeResource' => [ + 'description' => '数据质量监控运行时，使用的资源组。', + 'type' => 'object', + 'properties' => [ + 'Id' => [ + 'description' => '资源组ID。', + 'type' => 'string', + 'example' => '122878', + ], + 'Cu' => [ + 'description' => '资源组预留CU。', + 'type' => 'number', + 'format' => 'float', + 'example' => '10', + ], + 'Image' => [ + 'description' => '运行配置的镜像ID。', + 'type' => 'string', + 'example' => 'hp-tlp-e2e-repo-registry-vpc.cn-heyuan-acdr-1.cr.aliyuncs.com/hp-service/worker:9b28b6d-202506091008', + ], + ], + ], + 'Trigger' => [ + 'description' => '数据质量监控触发配置。', + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'description' => '数据质量监控触发方式。取值范围：'."\n" + ."\n" + .'- ByManual：手动触发，默认设置'."\n" + .'- BySchedule：调度任务实例触发', + 'type' => 'string', + 'enumValueTitles' => [], + 'example' => 'BySchedule', + ], + 'TaskIds' => [ + 'description' => '当触发方式为BySchedule时，需要配置触发质量监控的调度任务ID。', + 'type' => 'array', + 'items' => [ + 'description' => '调度任务ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1023777390', + ], + ], + ], + ], + 'Hooks' => [ + 'description' => '数据质量监控运行结束后的Hook配置。', + 'type' => 'array', + 'items' => [ + 'description' => '数据质量监控运行结束后的Hook配置。', + 'type' => 'object', + 'properties' => [ + 'Condition' => [ + 'description' => 'Hook触发条件，当满足这个条件时，会触发Hook运行。目前只支持一种表达式写法：'."\n" + ."\n" + .'- 指定多组规则严重类型和规则校验状态，如`results.any { r -> r.status == \'Fail\' && r.rule.severity == \'Normal\' || r.status == \'Error\' && r.rule.severity == \'High\' || r.status == \'Warn\' && r.rule.severity == \'High\' }`，代表执行的规则中，如果有severity为Normal的规则校验结果是Fail、或者severity为High的规则校验结果是Error、或者severity为High的规则校验结果是Warn，则满足条件。条件表达式中severity的枚举与Spec中severity的枚举一致、status的枚举与DataQualityResult中的status一致。', + 'type' => 'string', + 'example' => 'results.any { r -> r.status == \'Fail\' && r.rule.severity == \'Normal\' || r.status == \'Error\' && r.rule.severity == \'High\' || r.status == \'Warn\' && r.rule.severity == \'High\' }', + ], + 'Type' => [ + 'description' => 'Hook类型。取值范围：'."\n" + ."\n" + .'- BlockTaskInstance：阻塞任务实例调度', + 'type' => 'string', + 'enumValueTitles' => [], + 'example' => 'BlockTaskInstance', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"204EAF68-CCE3-5112-8DA0-E7A60F02XXXX\\",\\n \\"DataQualityScan\\": {\\n \\"Id\\": 10001,\\n \\"Name\\": \\"data_quality_scan_001\\",\\n \\"Description\\": \\"aily data quality scanning of ods tables.\\",\\n \\"ProjectId\\": 101,\\n \\"CreateTime\\": 1731550150000,\\n \\"ModifyTime\\": 1731550150000,\\n \\"CreateUser\\": \\"2374924198591250\\",\\n \\"ModifyUser\\": \\"23482597582479\\",\\n \\"Owner\\": \\"231263586109857423\\",\\n \\"Spec\\": \\"{\\\\n \\\\\\"datasets\\\\\\": [\\\\n {\\\\n \\\\\\"type\\\\\\": \\\\\\"Table\\\\\\",\\\\n \\\\\\"dataSource\\\\\\": {\\\\n \\\\\\"name\\\\\\": \\\\\\"odps_first\\\\\\",\\\\n \\\\\\"envType\\\\\\": \\\\\\"Prod\\\\\\"\\\\n },\\\\n \\\\\\"tables\\\\\\": [\\\\n \\\\\\"ods_d_user_info\\\\\\"\\\\n ],\\\\n \\\\\\"filter\\\\\\": \\\\\\"pt = $[yyyymmdd-1]\\\\\\"\\\\n }\\\\n ],\\\\n \\\\\\"rules\\\\\\": [\\\\n {\\\\n \\\\\\"assertion\\\\\\": \\\\\\"row_count > 0\\\\\\"\\\\n }, {\\\\n \\\\\\"templateId\\\\\\": \\\\\\"SYSTEM:field:null_value:fixed\\\\\\",\\\\n \\\\\\"pass\\\\\\": \\\\\\"when = 0\\\\\\",\\\\n \\\\\\"name\\\\\\": \\\\\\"The id cannot be empty.\\\\\\",\\\\n \\\\\\"severity\\\\\\": \\\\\\"High\\\\\\",\\\\n \\\\\\"identity\\\\\\": \\\\\\"a-customized-data-quality-rule-uuid\\\\\\"\\\\n }\\\\n ]\\\\n}\\",\\n \\"Parameters\\": [\\n {\\n \\"Value\\": \\"10\\",\\n \\"Name\\": \\"e2e_autolabel\\"\\n }\\n ],\\n \\"ComputeResource\\": {\\n \\"Name\\": \\"polardb_to_holo\\",\\n \\"Runtime\\": {\\n \\"Engine\\": \\"Hive\\",\\n \\"HiveConf\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"SparkConf\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n }\\n },\\n \\"EnvType\\": \\"Prod\\"\\n },\\n \\"RuntimeResource\\": {\\n \\"Id\\": \\"122878\\",\\n \\"Cu\\": 10,\\n \\"Image\\": \\"hp-tlp-e2e-repo-registry-vpc.cn-heyuan-acdr-1.cr.aliyuncs.com/hp-service/worker:9b28b6d-202506091008\\"\\n },\\n \\"Trigger\\": {\\n \\"Type\\": \\"BySchedule\\",\\n \\"TaskIds\\": [\\n 1023777390\\n ]\\n },\\n \\"Hooks\\": [\\n {\\n \\"Condition\\": \\"results.any { r -> r.status == \'Fail\' && r.rule.severity == \'Normal\' || r.status == \'Error\' && r.rule.severity == \'High\' || r.status == \'Warn\' && r.rule.severity == \'High\' }\\",\\n \\"Type\\": \\"BlockTaskInstance\\"\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => '获取数据质量监控详情', + 'description' => '需要购买DataWorks基础版及以上版本才能使用', + ], + 'DeleteDataQualityScan' => [ + 'summary' => '删除数据质量监控。', + 'path' => '', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREdide3WJOKE', + ], + ], + 'parameters' => [ + [ + 'name' => 'Description', + 'in' => 'formData', + 'schema' => [ + 'description' => '废弃参数，无需配置。', + 'type' => 'string', + 'required' => false, + 'example' => 'null', + ], + ], + [ + 'name' => 'Id', + 'in' => 'formData', + 'schema' => [ + 'description' => '数据质量监控ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '123123', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '2197B9C4-39CE-55EA-8EEA-FDBAE52DXXXX', + ], + 'Success' => [ + 'description' => '调用是否成功。'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"2197B9C4-39CE-55EA-8EEA-FDBAE52DXXXX\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => '删除数据质量监控', + 'description' => '需要购买DataWorks基础版及以上版本才能使用。', + ], + 'CreateDataQualityAlertRule' => [ + 'summary' => '用于在指定项目中创建数据质量监控告警规则。', + 'path' => '', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREdide3WJOKE', + ], + ], + 'parameters' => [ + [ + 'name' => 'ProjectId', + 'in' => 'formData', + 'schema' => [ + 'description' => '项目ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '10001', + ], + ], + [ + 'name' => 'Condition', + 'in' => 'formData', + 'schema' => [ + 'description' => '数据质量监控告警规则告警条件。', + 'type' => 'string', + 'required' => true, + 'example' => 'results.any { r -> r.status == \'fail\' && r.rule.severity == \'High\' }', + ], + ], + [ + 'name' => 'Target', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'description' => '数据质量监控告警规则关注目标。', + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'description' => '监控对象的类型，只支持 DataQualityScan。', + 'type' => 'string', + 'required' => true, + 'enumValueTitles' => [], + 'example' => 'DataQualityScan', + ], + 'Ids' => [ + 'description' => '监控目标ID列表，目前只支持设置一个。', + 'type' => 'array', + 'items' => [ + 'description' => '监控目标ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '113646', + ], + 'required' => true, + ], + ], + 'required' => true, + ], + ], + [ + 'name' => 'Notification', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'description' => '告警渠道列表。', + 'type' => 'object', + 'properties' => [ + 'Channels' => [ + 'description' => '渠道列表，除了可以同时设置 `Email` 和 `Sms` 外，其他的情况都只能设置一种渠道。'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '告警通道。'."\n" + .'- Dingding'."\n" + .'- Weixin'."\n" + .'- Mail'."\n" + .'- Sms'."\n" + .'- Phone'."\n" + .'- Webhook'."\n" + .'- Feishu', + 'type' => 'string', + 'required' => true, + 'enumValueTitles' => [], + 'example' => 'Sms', + 'enum' => [ + 'Dingding', + 'Weixin', + 'Mail', + 'Sms', + 'Phone', + 'Webhook', + 'Feishu', + ], + ], + 'required' => true, + ], + 'Receivers' => [ + 'description' => '告警接收对象。', + 'type' => 'array', + 'items' => [ + 'description' => '告警接收对象。', + 'type' => 'object', + 'properties' => [ + 'Extension' => [ + 'description' => '告警对象需要的额外配置，当 ReceiverType 为 DingdingUrl，支持设置`{"atAll":true}`@所有人。', + 'type' => 'string', + 'required' => false, + 'example' => '{"atAll":true}'."\n", + ], + 'ReceiverType' => [ + 'description' => '告警接收对象类型。'."\n" + .'- AliUid'."\n" + .'- WebhookUrl'."\n" + .'- DingdingUrl'."\n" + .'- WeixinUrl'."\n" + .'- FeishuUrl'."\n" + .'- TaskOwner'."\n" + .'- DataQualityScanOwner'."\n" + .'- ShiftSchedule', + 'type' => 'string', + 'required' => true, + 'enumValueTitles' => [], + 'example' => 'TaskOwner', + 'enum' => [ + 'AliUid', + 'WebhookUrl', + 'DingdingUrl', + 'WeixinUrl', + 'FeishuUrl', + 'TaskOwner', + 'DataQualityScanOwner', + 'ShiftSchedule', + ], + ], + 'ReceiverValues' => [ + 'description' => '告警接收对象值。', + 'type' => 'array', + 'items' => [ + 'description' => '告警接收对象值。'."\n" + .'- 当 ReceiverType 为 AliUid 时填阿里云UID'."\n" + .'- 当 ReceiverType 为 ShiftSchedule 时填值班表ID'."\n" + .'- 当 ReceiverType 为 WebhookUrl / DingdingUrl / FeishuUrl / WeixinUrl 时填入对应的 URL。', + 'type' => 'string', + 'required' => false, + 'example' => 'https://oapi.dingtalk.com/robot/send?access_token=a30bae7******'."\n", + ], + 'required' => false, + ], + ], + 'required' => true, + ], + 'required' => true, + ], + ], + 'required' => true, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '0bc14115***159376359', + ], + 'Id' => [ + 'description' => '创建自定义监控规则成功后，返回的自定义规则 ID。'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1010543619', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0bc14115***159376359\\",\\n \\"Id\\": 1010543619\\n}","type":"json"}]', + 'title' => '创建数据质量告警规则', + 'description' => '需要购买DataWorks基础版及以上版本才能使用。', + ], + 'UpdateDataQualityAlertRule' => [ + 'summary' => '用于更新指定的数据质量监控告警规则。', + 'path' => '', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREdide3WJOKE', + ], + ], + 'parameters' => [ + [ + 'name' => 'Id', + 'in' => 'formData', + 'schema' => [ + 'description' => '告警规则ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '105412', + ], + ], + [ + 'name' => 'ProjectId', + 'in' => 'formData', + 'schema' => [ + 'description' => '项目ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1000', + ], + ], + [ + 'name' => 'Condition', + 'in' => 'formData', + 'schema' => [ + 'description' => '数据质量监控告警规则告警条件。', + 'type' => 'string', + 'required' => false, + 'example' => 'results.any { r -> r.status == \'fail\' && r.rule.severity == \'High\' }', + ], + ], + [ + 'name' => 'Target', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'description' => '数据质量监控告警规则关注目标。', + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'description' => '监控对象的类型，只支持 DataQualityScan。', + 'type' => 'string', + 'required' => false, + 'example' => 'DataQualityScan', + ], + 'Ids' => [ + 'description' => '监控目标ID列表，目前只支持设置一个。', + 'type' => 'array', + 'items' => [ + 'description' => '监控目标ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '7638999336', + ], + 'required' => false, + ], + ], + 'required' => false, + ], + ], + [ + 'name' => 'Notification', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'description' => '告警通知配置。', + 'type' => 'object', + 'properties' => [ + 'Channels' => [ + 'description' => '渠道列表，除了可以同时设置 Email 和 Sms 外，其他的情况都只能设置一种渠道。', + 'type' => 'array', + 'items' => [ + 'description' => '告警通道。'."\n" + .'- Dingding'."\n" + .'- Weixin'."\n" + .'- Mail'."\n" + .'- Sms'."\n" + .'- Phone'."\n" + .'- Webhook'."\n" + .'- Feishu', + 'type' => 'string', + 'required' => true, + 'enumValueTitles' => [], + 'example' => 'Sms', + 'enum' => [ + 'Dingding', + 'Weixin', + 'Mail', + 'Sms', + 'Phone', + 'Webhook', + 'Feishu', + ], + ], + 'required' => true, + ], + 'Receivers' => [ + 'description' => '告警接收对象。', + 'type' => 'array', + 'items' => [ + 'description' => '告警接收对象。', + 'type' => 'object', + 'properties' => [ + 'Extension' => [ + 'description' => '告警对象需要的额外配置，当 ReceiverType 为 DingdingUrl，支持设置 `{"atAll":true}` @所有人。', + 'type' => 'string', + 'required' => false, + 'example' => '{"atAll":true}'."\n", + ], + 'ReceiverType' => [ + 'description' => '告警接收对象类型。'."\n" + .'- AliUid'."\n" + .'- WebhookUrl'."\n" + .'- DingdingUrl'."\n" + .'- WeixinUrl'."\n" + .'- FeishuUrl'."\n" + .'- TaskOwner'."\n" + .'- DataQualityScanOwner'."\n" + .'- ShiftSchedule', + 'type' => 'string', + 'required' => true, + 'enumValueTitles' => [], + 'example' => 'TaskOwner', + 'enum' => [ + 'AliUid', + 'WebhookUrl', + 'DingdingUrl', + 'WeixinUrl', + 'FeishuUrl', + 'TaskOwner', + 'DataQualityScanOwner', + 'ShiftSchedule', + ], + ], + 'ReceiverValues' => [ + 'description' => '告警接收对象值。', + 'type' => 'array', + 'items' => [ + 'description' => '告警接收对象值。'."\n" + .'- 当 ReceiverType 为 AliUid 时填阿里云UID'."\n" + .'- 当 ReceiverType 为 ShiftSchedule 时填值班表ID'."\n" + .'- 当 ReceiverType 为 WebhookUrl / DingdingUrl / FeishuUrl / WeixinUrl 时填入对应的 URL。', + 'type' => 'string', + 'required' => false, + 'example' => 'https://oapi.dingtalk.com/robot/send?access_token=a30bae7******', + ], + 'required' => false, + ], + ], + 'required' => false, + ], + 'required' => false, + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '0bc14115***159376359', + ], + 'Success' => [ + 'description' => '告警规则是否更新成功。'."\n", + 'type' => 'boolean', + 'example' => 'True', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0bc14115***159376359\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => '更新数据质量告警规则', + 'description' => '需要购买DataWorks基础版及以上版本才能使用。', + ], + 'ListDataQualityAlertRules' => [ + 'summary' => '查询指定项目下的数据质量告警规则列表。', + 'path' => '', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREdide3WJOKE', + ], + ], + 'parameters' => [ + [ + 'name' => 'ProjectId', + 'in' => 'query', + 'schema' => [ + 'description' => '项目ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '10001', + ], + ], + [ + 'name' => 'DataQualityScanId', + 'in' => 'query', + 'schema' => [ + 'description' => '数据质量告警规则关注的数据质量监控ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '10001', + ], + ], + [ + 'name' => 'SortBy', + 'in' => 'query', + 'schema' => [ + 'description' => '排序字段列表，支持修改时间、创建时间等字段，格式为"排序字段+排序方式(Desc/Asc)"（默认Asc，可以省略）。排序字段的枚举值如下：'."\n" + ."\n" + .'- CreateTime (Desc/Asc)'."\n" + .'- Id (Desc/Asc)', + 'type' => 'string', + 'required' => false, + 'example' => 'CreateTime Desc', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '结果分页页码。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'minimum' => '1', + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '结果分页大小。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'maximum' => '200', + 'minimum' => '1', + 'example' => '10', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '0bc14115***159376359', + ], + 'PageInfo' => [ + 'description' => '告警规则配置。', + 'type' => 'object', + 'properties' => [ + 'TotalCount' => [ + 'description' => '满足条件的数据总条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '335', + ], + 'PageNumber' => [ + 'description' => '页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '数据分页大小。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'DataQualityAlertRules' => [ + 'description' => '告警规则配置列表。', + 'type' => 'array', + 'items' => [ + 'description' => '告警规则配置。', + 'type' => 'object', + 'properties' => [ + 'Condition' => [ + 'description' => '数据质量监控告警规则告警条件。', + 'type' => 'string', + 'example' => 'results.any { r -> r.status == \'fail\' && r.rule.severity == \'High\' }', + ], + 'Target' => [ + 'description' => '数据质量监控告警规则关注目标。', + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'description' => '监控对象的类型，只支持 DataQualityScan。', + 'type' => 'string', + 'example' => 'DataQualityScan', + ], + 'Ids' => [ + 'description' => '监控目标ID列表。', + 'type' => 'array', + 'items' => [ + 'description' => '监控目标ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '7638999336', + ], + ], + ], + ], + 'ProjectId' => [ + 'description' => '项目ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '59094', + ], + 'Id' => [ + 'description' => '数据质量监控告警规则ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '26433', + ], + 'Notification' => [ + 'description' => '告警通知配置。', + 'type' => 'object', + 'properties' => [ + 'Receivers' => [ + 'description' => '告警接收对象。', + 'type' => 'array', + 'items' => [ + 'description' => '告警接收对象。', + 'type' => 'object', + 'properties' => [ + 'Extension' => [ + 'description' => '告警对象需要的额外配置，当 ReceiverType 为 DingdingUrl，支持设置 `{"atAll":true}` @所有人。', + 'type' => 'string', + 'example' => '{"atAll":true}', + ], + 'ReceiverType' => [ + 'description' => '告警接收对象类型。'."\n" + .'- ShiftSchedule'."\n" + .'- WebhookUrl'."\n" + .'- FeishuUrl'."\n" + .'- TaskOwner'."\n" + .'- WeixinUrl'."\n" + .'- DingdingUrl'."\n" + .'- DataQualityScanOwner'."\n" + .'- AliUid', + 'type' => 'string', + 'enumValueTitles' => [], + 'example' => 'AliUid', + ], + 'ReceiverValues' => [ + 'description' => '告警接收对象值。', + 'type' => 'array', + 'items' => [ + 'description' => '告警接收对象值。'."\n" + .'- 当 ReceiverType 为 AliUid 时填阿里云UID'."\n" + .'- 当 ReceiverType 为 ShiftSchedule 时填值班表ID'."\n" + .'- 当 ReceiverType 为 WebhookUrl / DingdingUrl / FeishuUrl / WeixinUrl 时填入对应的 URL。', + 'type' => 'string', + 'example' => 'https://oapi.dingtalk.com/robot/send?access_token=a30bae7******', + ], + ], + ], + ], + ], + 'Channels' => [ + 'description' => 'Channels中，除可以同时设置Email和Sms外，其他的情况都只能设置一种渠道。', + 'type' => 'array', + 'items' => [ + 'description' => '告警通道。'."\n" + .'- Mail'."\n" + .'- Weixin'."\n" + .'- Feishu'."\n" + .'- Phone'."\n" + .'- Sms'."\n" + .'- Webhook', + 'type' => 'string', + 'enumValueTitles' => [], + 'example' => 'Sms', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0bc14115***159376359\\",\\n \\"PageInfo\\": {\\n \\"TotalCount\\": 335,\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"DataQualityAlertRules\\": [\\n {\\n \\"Condition\\": \\"results.any { r -> r.status == \'fail\' && r.rule.severity == \'High\' }\\",\\n \\"Target\\": {\\n \\"Type\\": \\"DataQualityScan\\",\\n \\"Ids\\": [\\n 7638999336\\n ]\\n },\\n \\"ProjectId\\": 59094,\\n \\"Id\\": 26433,\\n \\"Notification\\": {\\n \\"Receivers\\": [\\n {\\n \\"Extension\\": \\"{\\\\\\"atAll\\\\\\":true}\\",\\n \\"ReceiverType\\": \\"AliUid\\",\\n \\"ReceiverValues\\": [\\n \\"https://oapi.dingtalk.com/robot/send?access_token=a30bae7******\\"\\n ]\\n }\\n ],\\n \\"Channels\\": [\\n \\"Sms\\"\\n ]\\n }\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => '数据质量告警规则列表查询', + 'description' => '需要购买DataWorks基础版及以上版本才能使用。', + ], + 'GetDataQualityAlertRule' => [ + 'summary' => '根据告警规则ID查询对应的数据质量监控告警规则详情。', + 'path' => '', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREdide3WJOKE', + ], + ], + 'parameters' => [ + [ + 'name' => 'Id', + 'in' => 'query', + 'schema' => [ + 'description' => '数据质量监控告警规则ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '113642', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '0bc14115****159376359', + ], + 'DataQualityAlertRule' => [ + 'description' => '数据质量监控告警规则。', + 'type' => 'object', + 'properties' => [ + 'Id' => [ + 'description' => '数据质量监控告警规则ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '21045', + ], + 'Condition' => [ + 'description' => '数据质量监控告警规则告警条件。', + 'type' => 'string', + 'example' => 'results.any { r -> r.status == \'fail\' && r.rule.severity == \'High\' }', + ], + 'ProjectId' => [ + 'description' => '项目ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '90912', + ], + 'Target' => [ + 'description' => '数据质量监控告警规则关注目标。', + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'description' => '监控对象的类型，只支持 `DataQualityScan`。', + 'type' => 'string', + 'example' => 'DataQualityScan', + ], + 'Ids' => [ + 'description' => '监控目标ID列表。', + 'type' => 'array', + 'items' => [ + 'description' => '监控对象ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '113647', + ], + ], + ], + ], + 'Notification' => [ + 'description' => '告警通知配置。', + 'type' => 'object', + 'properties' => [ + 'Channels' => [ + 'description' => 'Channels中，除可以同时设置Email和Sms外，其他的情况都只能设置一种渠道。', + 'type' => 'array', + 'items' => [ + 'description' => '告警通道。'."\n" + .'- Dingding'."\n" + .'- Mail'."\n" + .'- Weixin'."\n" + .'- Feishu'."\n" + .'- Phone'."\n" + .'- Sms'."\n" + .'- Webhook', + 'type' => 'string', + 'enumValueTitles' => [], + 'example' => 'Dingding', + ], + ], + 'Receivers' => [ + 'description' => '告警接收对象。', + 'type' => 'array', + 'items' => [ + 'description' => '告警接收对象。', + 'type' => 'object', + 'properties' => [ + 'Extension' => [ + 'description' => '告警对象需要的额外配置，当 ReceiverType 为 DingdingUrl，支持设置 `{"atAll":true}` @所有人。', + 'type' => 'string', + 'example' => '{"atAll":true}', + ], + 'ReceiverType' => [ + 'description' => '告警接收对象类型。'."\n" + .'- ShiftSchedule'."\n" + .'- WebhookUrl'."\n" + .'- FeishuUrl'."\n" + .'- TaskOwner'."\n" + .'- WeixinUrl'."\n" + .'- DingdingUrl'."\n" + .'- DataQualityScanOwner'."\n" + .'- AliUid', + 'type' => 'string', + 'enumValueTitles' => [], + 'example' => 'TaskOwner', + ], + 'ReceiverValues' => [ + 'description' => '告警接收对象值。', + 'type' => 'array', + 'items' => [ + 'description' => '告警接收对象值。'."\n" + .'- 当 ReceiverType 为 AliUid 时填阿里云UID'."\n" + .'- 当 ReceiverType 为 ShiftSchedule 时填值班表ID'."\n" + .'- 当 ReceiverType 为 WebhookUrl / DingdingUrl / FeishuUrl / WeixinUrl 时填入对应的 URL。', + 'type' => 'string', + 'example' => 'https://oapi.dingtalk.com/robot/send?access_token=a30bae7******', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0bc14115****159376359\\",\\n \\"DataQualityAlertRule\\": {\\n \\"Id\\": 21045,\\n \\"Condition\\": \\"results.any { r -> r.status == \'fail\' && r.rule.severity == \'High\' }\\",\\n \\"ProjectId\\": 90912,\\n \\"Target\\": {\\n \\"Type\\": \\"DataQualityScan\\",\\n \\"Ids\\": [\\n 113647\\n ]\\n },\\n \\"Notification\\": {\\n \\"Channels\\": [\\n \\"Dingding\\"\\n ],\\n \\"Receivers\\": [\\n {\\n \\"Extension\\": \\"{\\\\\\"atAll\\\\\\":true}\\",\\n \\"ReceiverType\\": \\"TaskOwner\\",\\n \\"ReceiverValues\\": [\\n \\"https://oapi.dingtalk.com/robot/send?access_token=a30bae7******\\"\\n ]\\n }\\n ]\\n }\\n }\\n}","type":"json"}]', + 'title' => '获取数据质量告警规则', + 'description' => '需要购买DataWorks基础版及以上版本才能使用。', + ], + 'DeleteDataQualityAlertRule' => [ + 'summary' => '根据指定的ID删除数据质量监控告警规则。', + 'path' => '', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREdide3WJOKE', + ], + ], + 'parameters' => [ + [ + 'name' => 'Id', + 'in' => 'formData', + 'schema' => [ + 'description' => '数据质量规则模板ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => 'a7ef0634-20ec-4a7c-a214-54020f91XXXX', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '0bc14115***159376359', + ], + 'Success' => [ + 'description' => '告警规则是否删除成功。'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0bc14115***159376359\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => '删除数据质量告警规则', + 'description' => '需要购买DataWorks基础版及以上版本才能使用。', + ], + 'CreateDataQualityScanRun' => [ + 'summary' => '触发指定数据质量监控任务的执行，并返回运行实例ID。', + 'path' => '', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREdide3WJOKE', + ], + ], + 'parameters' => [ + [ + 'name' => 'DataQualityScanId', + 'in' => 'formData', + 'schema' => [ + 'description' => '数据质量监控ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '20000001', + ], + ], + [ + 'name' => 'ProjectId', + 'in' => 'formData', + 'schema' => [ + 'description' => '项目ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '10000', + ], + ], + [ + 'name' => 'Parameters', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'description' => '实际运行时，使用的参数设置，其中必传参数`triggerTime`。', + 'type' => 'array', + 'items' => [ + 'description' => '实际运行时，使用的参数设置。', + 'type' => 'object', + 'properties' => [ + 'Value' => [ + 'description' => '参数值，可以使用调度时间表达式。', + 'type' => 'string', + 'required' => false, + 'example' => '$[yyyy-mm-dd-1]', + ], + 'Name' => [ + 'description' => '参数名。', + 'type' => 'string', + 'required' => false, + 'example' => 'dt', + ], + ], + 'required' => false, + ], + 'required' => false, + ], + ], + [ + 'name' => 'RuntimeResource', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'description' => '数据质量监控运行时，所使用的调度资源组，与调度API共用相同的数据结构。', + 'type' => 'object', + 'properties' => [ + 'Id' => [ + 'description' => '资源组ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'e9455a13-ff00-4965-833c-337546ba4854', + ], + 'Cu' => [ + 'description' => '资源组运行数据质量监控时预留的CU配置。', + 'type' => 'number', + 'format' => 'float', + 'required' => false, + 'example' => '0.25', + ], + 'Image' => [ + 'description' => '使用资源组运行数据质量监控时的镜像设置。', + 'type' => 'string', + 'required' => false, + 'example' => 'i-xxxxxx', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '0bc14115***159376359', + ], + 'Id' => [ + 'description' => '被触发成功的RunId。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '248840', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0bc14115***159376359\\",\\n \\"Id\\": 248840\\n}","type":"json"}]', + 'title' => '创建数据质量扫描运行', + 'description' => '需要购买DataWorks基础版及以上版本才能使用。', + ], + 'ListDataQualityScanRuns' => [ + 'summary' => '查询指定项目下的数据质量扫描运行记录。', + 'path' => '', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREdide3WJOKE', + ], + ], + 'parameters' => [ + [ + 'name' => 'DataQualityScanId', + 'in' => 'query', + 'schema' => [ + 'description' => '数据质量监控ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '10001', + ], + ], + [ + 'name' => 'CreateTimeFrom', + 'in' => 'query', + 'schema' => [ + 'description' => '数据质量监控运行最早开始时间。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1710239005403', + ], + ], + [ + 'name' => 'CreateTimeTo', + 'in' => 'query', + 'schema' => [ + 'description' => '数据质量监控运行最晚开始时间。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1710239005403', + ], + ], + [ + 'name' => 'Status', + 'in' => 'query', + 'schema' => [ + 'description' => '数据质量校验结果状态。'."\n" + .'- Pass'."\n" + .'- Running'."\n" + .'- Error'."\n" + .'- Fail'."\n" + .'- Warn', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [], + 'example' => 'Fail', + 'enum' => [ + 'Error', + 'Fail', + 'Kill', + 'Pass', + 'Running', + 'Warn', + ], + ], + ], + [ + 'name' => 'SortBy', + 'in' => 'query', + 'schema' => [ + 'description' => '排序字段列表，支持修改时间、创建时间等字段，格式为"排序字段+排序方式(Desc/Asc)"（默认Asc，可以省略）。排序字段的枚举值如下：'."\n" + .'- CreateTime (Desc/Asc)'."\n" + .'- Id (Desc/Asc)', + 'type' => 'string', + 'required' => false, + 'example' => 'CreateTime Desc', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '列表翻页查询页大小，默认为10。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '20', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '列表翻页查询页码，默认为1。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'ProjectId', + 'in' => 'query', + 'schema' => [ + 'description' => '项目ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '12345', + ], + ], + [ + 'name' => 'Filter', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '扩展的查询Filter，目前支持以下过滤参数：'."\n" + .'- TaskInstanceId', + 'type' => 'object', + 'required' => false, + 'example' => '{'."\n" + .' "TaskInstanceId": 111L'."\n" + .'}', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '0bc14115***159376359', + ], + 'PageInfo' => [ + 'description' => '分页信息。', + 'type' => 'object', + 'properties' => [ + 'TotalCount' => [ + 'description' => '总条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '324', + ], + 'PageSize' => [ + 'description' => '列表翻页查询页大小，默认为10。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'PageNumber' => [ + 'description' => '列表翻页查询页码，默认为1。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'DataQualityScanRuns' => [ + 'description' => '数据质量监控运行记录列表。', + 'type' => 'array', + 'items' => [ + 'description' => '数据质量监控运行记录列表。', + 'type' => 'object', + 'properties' => [ + 'Id' => [ + 'description' => '数据质量监控运行记录ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '3155', + ], + 'CreateTime' => [ + 'description' => '数据质量监控运行开始时间。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1710239005403', + ], + 'FinishTime' => [ + 'description' => '数据质量监控运行结束时间。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1710239005403', + ], + 'Status' => [ + 'description' => '当前运行状态。'."\n" + .'- Pass'."\n" + .'- Running'."\n" + .'- Error'."\n" + .'- Warn'."\n" + .'- Fail', + 'type' => 'string', + 'enumValueTitles' => [], + 'example' => 'Fail', + ], + 'Parameters' => [ + 'description' => '实际运行时，使用的参数设置。'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '参数信息。', + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'description' => '参数名。', + 'type' => 'string', + 'example' => 'dt', + ], + 'Value' => [ + 'description' => '参数值，可以使用调度时间表达式。', + 'type' => 'string', + 'example' => '$[yyyy-mm-dd-1]', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0bc14115***159376359\\",\\n \\"PageInfo\\": {\\n \\"TotalCount\\": 324,\\n \\"PageSize\\": 10,\\n \\"PageNumber\\": 1,\\n \\"DataQualityScanRuns\\": [\\n {\\n \\"Id\\": 3155,\\n \\"CreateTime\\": 1710239005403,\\n \\"FinishTime\\": 1710239005403,\\n \\"Status\\": \\"Fail\\",\\n \\"Parameters\\": [\\n {\\n \\"Name\\": \\"dt\\",\\n \\"Value\\": \\"$[yyyy-mm-dd-1]\\"\\n }\\n ]\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => '数据质量扫描运行记录查询', + 'description' => '需要购买DataWorks基础版及以上版本才能使用。', + ], + 'GetDataQualityScanRunLog' => [ + 'summary' => '查询指定数据质量监控任务实例的日志内容。', + 'path' => '', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREdide3WJOKE', + ], + ], + 'parameters' => [ + [ + 'name' => 'Id', + 'in' => 'query', + 'schema' => [ + 'description' => '数据质量监控运行记录ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '10001', + ], + ], + [ + 'name' => 'Offset', + 'in' => 'query', + 'schema' => [ + 'description' => '日志起始位置，相对于文件起始位置的偏移量，单位byte，每次查询至多返回512kb内容。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '200', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '0bc14115***159376359', + ], + 'LogSegment' => [ + 'description' => '任务日志信息。', + 'type' => 'object', + 'properties' => [ + 'Log' => [ + 'description' => '任务日志。', + 'type' => 'string', + 'example' => 'Running on Serverless_resource_group_xxxxx'."\n" + .'Begin to check rule ***', + ], + 'NextOffset' => [ + 'description' => '下一段日志的起始偏移量，-1表示已读取完毕。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '512000', + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0bc14115***159376359\\",\\n \\"LogSegment\\": {\\n \\"Log\\": \\"Running on Serverless_resource_group_xxxxx\\\\nBegin to check rule ***\\",\\n \\"NextOffset\\": 512000\\n }\\n}","type":"json"}]', + 'title' => '获取数据质量扫描运行日志', + 'description' => '需要购买DataWorks基础版及以上版本才能使用。', + ], + 'GetDataQualityScanRun' => [ + 'summary' => '创建数据质量监控运行实例。', + 'path' => '', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREdide3WJOKE', + ], + ], + 'parameters' => [ + [ + 'name' => 'Id', + 'in' => 'query', + 'schema' => [ + 'description' => '数据质量监控运行记录ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1006059507', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '0bc14115****159376359', + ], + 'DataQualityScanRun' => [ + 'description' => '数据质量监控运行记录。', + 'type' => 'object', + 'properties' => [ + 'Id' => [ + 'description' => '运行记录ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1016440997', + ], + 'CreateTime' => [ + 'description' => '数据质量监控开始运行时间。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1706247622000', + ], + 'FinishTime' => [ + 'description' => '数据质量监控运行结束时间。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1706247622000', + ], + 'Status' => [ + 'description' => '当前运行状态。'."\n" + .'- Pass'."\n" + .'- Running'."\n" + .'- Error'."\n" + .'- Warn'."\n" + .'- Fail', + 'type' => 'string', + 'enumValueTitles' => [], + 'example' => 'Fail', + ], + 'Scan' => [ + 'description' => '校验开始时，数据质量监控配置快照。', + 'type' => 'object', + 'properties' => [ + 'Id' => [ + 'description' => '数据质量监控ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '21077', + ], + 'Name' => [ + 'description' => '数据质量校验任务名称，数字、英文字母、汉字、半角全角标点符号组合，最长255个字符。'."\n", + 'type' => 'string', + 'example' => 'Hourly partition quality monitoring', + ], + 'Description' => [ + 'description' => '数据质量校验任务描述，最长65535个字符。'."\n", + 'type' => 'string', + 'example' => 'This is a hourly run data quality evaluation plan.', + ], + 'ProjectId' => [ + 'description' => '项目ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '164024', + ], + 'CreateTime' => [ + 'description' => '数据质量监控创建时间。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1706247622000', + ], + 'ModifyTime' => [ + 'description' => '数据质量监控更新时间。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1706247622000', + ], + 'CreateUser' => [ + 'description' => '数据质量监控创建人。', + 'type' => 'string', + 'example' => '7892346529452', + ], + 'ModifyUser' => [ + 'description' => '数据质量监控最近更新人。', + 'type' => 'string', + 'example' => '7892346529452', + ], + 'Owner' => [ + 'description' => '数据质量监控责任人。', + 'type' => 'string', + 'example' => '7892346529452', + ], + 'Spec' => [ + 'description' => '数据质量监控Spec，详情请参见[数据质量Spec配置说明](~~2963394~~)。', + 'type' => 'string', + 'example' => '{'."\n" + .' "datasets": ['."\n" + .' {'."\n" + .' "type": "Table",'."\n" + .' "dataSource": {'."\n" + .' "name": "odps_first",'."\n" + .' "envType": "Prod"'."\n" + .' },'."\n" + .' "tables": ['."\n" + .' "ods_d_user_info"'."\n" + .' ],'."\n" + .' "filter": "pt = $[yyyymmdd-1]"'."\n" + .' }'."\n" + .' ],'."\n" + .' "rules": ['."\n" + .' {'."\n" + .' "assertion": "row_count > 0"'."\n" + .' }, {'."\n" + .' "templateId": "SYSTEM:field:null_value:fixed",'."\n" + .' "pass": "when = 0",'."\n" + .' "name": "The id cannot be empty.",'."\n" + .' "severity": "High",'."\n" + .' "identity": "a-customized-data-quality-rule-uuid"'."\n" + .' }'."\n" + .' ]'."\n" + .'}', + ], + 'Parameters' => [ + 'description' => '数据质量监控的参数设置。', + 'type' => 'array', + 'items' => [ + 'description' => '数据质量监控的参数设置。', + 'type' => 'object', + 'properties' => [ + 'Value' => [ + 'description' => '参数值。', + 'type' => 'string', + 'example' => '$[yyyy-mm-dd-1]', + ], + 'Name' => [ + 'description' => '参数名。', + 'type' => 'string', + 'example' => 'dt', + ], + ], + ], + ], + 'ComputeResource' => [ + 'description' => '数据质量监控计算资源设置。', + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'description' => '计算资源名称，对应到计算资源API的ComputeResource数据结构中的Name属性。', + 'type' => 'string', + 'example' => 'emr_cluster_001', + ], + 'Runtime' => [ + 'description' => '数据质量监控在运行时的更多设置。', + 'type' => 'object', + 'properties' => [ + 'Engine' => [ + 'description' => '使用的引擎类型，只有EMR计算引擎支持设置这部分内容。'."\n" + .'- Hive'."\n" + .'- Spark'."\n" + .'- Kyuubi', + 'type' => 'string', + 'enumValueTitles' => [], + 'example' => 'Hive', + ], + 'SparkConf' => [ + 'description' => '使用Spark引擎时，更多的参数设置，目前只支持通过spark.yarn.queue设置队列。', + 'type' => 'object', + 'example' => 'spark.yarn.queue=dq_queue'."\n", + ], + 'HiveConf' => [ + 'description' => '使用Hive引擎时，更多的参数设置，目前只支持通过mapreduce.job.queuename设置队列。', + 'type' => 'object', + 'example' => 'mapreduce.job.queuename=dq_queue'."\n", + ], + ], + ], + 'EnvType' => [ + 'description' => '计算引擎所属的工作空间环境。'."\n" + .'- Prod'."\n" + .'- Dev', + 'type' => 'string', + 'enumValueTitles' => [], + 'example' => 'Dev', + ], + ], + ], + 'RuntimeResource' => [ + 'description' => '数据质量监控运行时，使用的资源组。', + 'type' => 'object', + 'properties' => [ + 'Id' => [ + 'description' => '资源组ID。', + 'type' => 'string', + 'example' => '60597', + ], + 'Cu' => [ + 'description' => '资源组预留CU。', + 'type' => 'number', + 'format' => 'float', + 'example' => '1', + ], + 'Image' => [ + 'description' => '运行配置的镜像ID。', + 'type' => 'string', + 'example' => 'i-xxxx', + ], + ], + ], + 'Trigger' => [ + 'description' => '数据质量监控触发配置。', + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'description' => '数据质量监控触发方式。'."\n" + .'- ByManual'."\n" + .'- BySchedule', + 'type' => 'string', + 'enumValueTitles' => [], + 'example' => 'BySchedule', + ], + 'TaskIds' => [ + 'description' => '当触发方式为BySchedule时，需要配置触发质量监控的调度任务ID。', + 'type' => 'array', + 'items' => [ + 'description' => '调度任务ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1014217266', + ], + ], + ], + ], + 'Hooks' => [ + 'description' => '数据质量监控运行结束后的Hook配置。', + 'type' => 'array', + 'items' => [ + 'description' => '数据质量监控运行结束后的Hook配置。', + 'type' => 'object', + 'properties' => [ + 'Condition' => [ + 'description' => 'Hook触发条件，当满足这个条件时，会触发Hook运行。目前只支持一种表达式写法：'."\n" + ."\n" + .'* 指定多组规则严重类型和规则校验状态，如`results.any { r -> r.status == \'Fail\' && r.rule.severity == \'Normal\' || r.status == \'Error\' && r.rule.severity == \'High\' || r.status == \'Warn\' && r.rule.severity == \'High\' }`，代表执行的规则中，如果有severity为Normal的规则校验结果是Fail、或者severity为High的规则校验结果是Error、或者severity为High的规则校验结果是Warn，则满足条件。条件表达式中severity的枚举与Spec中severity的枚举一致、status的枚举与DataQualityResult中的status一致。', + 'type' => 'string', + 'example' => 'results.any { r -> r.status == \'fail\' && r.rule.severity == \'High\' }', + ], + 'Type' => [ + 'description' => 'Hook类型。'."\n" + .'- BlockTaskInstance', + 'type' => 'string', + 'enumValueTitles' => [], + 'example' => 'BlockTaskInstance', + ], + ], + ], + ], + ], + ], + 'Parameters' => [ + 'description' => '实际运行时，使用的参数设置。'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '参数设置。', + 'type' => 'object', + 'properties' => [ + 'Value' => [ + 'description' => '参数值。', + 'type' => 'string', + 'example' => '$[yyyy-mm-dd-1]', + ], + 'Name' => [ + 'description' => '参数名。', + 'type' => 'string', + 'example' => 'dt', + ], + ], + ], + ], + 'Results' => [ + 'description' => '具体每条规则的校验结果。', + 'type' => 'array', + 'items' => [ + 'description' => '规则的校验结果。', + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => '校验结果状态。'."\n" + .'- Pass'."\n" + .'- Running'."\n" + .'- Error'."\n" + .'- Warn'."\n" + .'- Fail', + 'type' => 'string', + 'enumValueTitles' => [], + 'example' => 'Fail', + ], + 'Details' => [ + 'description' => '本次校验的详情。', + 'type' => 'array', + 'items' => [ + 'description' => '本次校验的详情。', + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => '最终的比较结果状态。'."\n" + .'- Pass'."\n" + .'- Error'."\n" + .'- Warn'."\n" + .'- Fail', + 'type' => 'string', + 'enumValueTitles' => [], + 'example' => 'Fail', + ], + 'ReferenceValue' => [ + 'description' => '使用引用的样本，用来参与CheckedValue计算的基准值。', + 'type' => 'string', + 'example' => '0.0', + ], + 'CheckValue' => [ + 'description' => '最终用来与阈值比较的值。', + 'type' => 'string', + 'example' => '100.0', + ], + ], + ], + ], + 'Sample' => [ + 'description' => '本次校验所使用的样本值。', + 'type' => 'string', + 'example' => '{'."\n" + .' "value": "100.0"'."\n" + .'}'."\n", + ], + 'CreateTime' => [ + 'description' => '校验结果生成时间。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1725506795000', + ], + 'Rule' => [ + 'description' => '校验开始时，规则Spec快照。', + 'type' => 'string', + 'example' => '{'."\n" + .' "templateId": "SYSTEM:field:null_value:fixed",'."\n" + .' "pass": "when = 0",'."\n" + .' "name": "The id cannot be empty.",'."\n" + .' "severity": "High",'."\n" + .' "identity": "a-customized-data-quality-rule-uuid"'."\n" + .'}', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0bc14115****159376359\\",\\n \\"DataQualityScanRun\\": {\\n \\"Id\\": 1016440997,\\n \\"CreateTime\\": 1706247622000,\\n \\"FinishTime\\": 1706247622000,\\n \\"Status\\": \\"Fail\\",\\n \\"Scan\\": {\\n \\"Id\\": 21077,\\n \\"Name\\": \\"Hourly partition quality monitoring\\",\\n \\"Description\\": \\"This is a hourly run data quality evaluation plan.\\",\\n \\"ProjectId\\": 164024,\\n \\"CreateTime\\": 1706247622000,\\n \\"ModifyTime\\": 1706247622000,\\n \\"CreateUser\\": \\"7892346529452\\",\\n \\"ModifyUser\\": \\"7892346529452\\",\\n \\"Owner\\": \\"7892346529452\\",\\n \\"Spec\\": \\"{\\\\n \\\\\\"datasets\\\\\\": [\\\\n {\\\\n \\\\\\"type\\\\\\": \\\\\\"Table\\\\\\",\\\\n \\\\\\"dataSource\\\\\\": {\\\\n \\\\\\"name\\\\\\": \\\\\\"odps_first\\\\\\",\\\\n \\\\\\"envType\\\\\\": \\\\\\"Prod\\\\\\"\\\\n },\\\\n \\\\\\"tables\\\\\\": [\\\\n \\\\\\"ods_d_user_info\\\\\\"\\\\n ],\\\\n \\\\\\"filter\\\\\\": \\\\\\"pt = $[yyyymmdd-1]\\\\\\"\\\\n }\\\\n ],\\\\n \\\\\\"rules\\\\\\": [\\\\n {\\\\n \\\\\\"assertion\\\\\\": \\\\\\"row_count > 0\\\\\\"\\\\n }, {\\\\n \\\\\\"templateId\\\\\\": \\\\\\"SYSTEM:field:null_value:fixed\\\\\\",\\\\n \\\\\\"pass\\\\\\": \\\\\\"when = 0\\\\\\",\\\\n \\\\\\"name\\\\\\": \\\\\\"The id cannot be empty.\\\\\\",\\\\n \\\\\\"severity\\\\\\": \\\\\\"High\\\\\\",\\\\n \\\\\\"identity\\\\\\": \\\\\\"a-customized-data-quality-rule-uuid\\\\\\"\\\\n }\\\\n ]\\\\n}\\",\\n \\"Parameters\\": [\\n {\\n \\"Value\\": \\"$[yyyy-mm-dd-1]\\",\\n \\"Name\\": \\"dt\\"\\n }\\n ],\\n \\"ComputeResource\\": {\\n \\"Name\\": \\"emr_cluster_001\\",\\n \\"Runtime\\": {\\n \\"Engine\\": \\"Hive\\",\\n \\"SparkConf\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"HiveConf\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n }\\n },\\n \\"EnvType\\": \\"Dev\\"\\n },\\n \\"RuntimeResource\\": {\\n \\"Id\\": \\"60597\\",\\n \\"Cu\\": 1,\\n \\"Image\\": \\"i-xxxx\\"\\n },\\n \\"Trigger\\": {\\n \\"Type\\": \\"BySchedule\\",\\n \\"TaskIds\\": [\\n 1014217266\\n ]\\n },\\n \\"Hooks\\": [\\n {\\n \\"Condition\\": \\"results.any { r -> r.status == \'fail\' && r.rule.severity == \'High\' }\\",\\n \\"Type\\": \\"BlockTaskInstance\\"\\n }\\n ]\\n },\\n \\"Parameters\\": [\\n {\\n \\"Value\\": \\"$[yyyy-mm-dd-1]\\",\\n \\"Name\\": \\"dt\\"\\n }\\n ],\\n \\"Results\\": [\\n {\\n \\"Status\\": \\"Fail\\",\\n \\"Details\\": [\\n {\\n \\"Status\\": \\"Fail\\",\\n \\"ReferenceValue\\": \\"0.0\\",\\n \\"CheckValue\\": \\"100.0\\"\\n }\\n ],\\n \\"Sample\\": \\"{\\\\n \\\\\\"value\\\\\\": \\\\\\"100.0\\\\\\"\\\\n}\\\\n\\",\\n \\"CreateTime\\": 1725506795000,\\n \\"Rule\\": \\"{\\\\n \\\\\\"templateId\\\\\\": \\\\\\"SYSTEM:field:null_value:fixed\\\\\\",\\\\n \\\\\\"pass\\\\\\": \\\\\\"when = 0\\\\\\",\\\\n \\\\\\"name\\\\\\": \\\\\\"The id cannot be empty.\\\\\\",\\\\n \\\\\\"severity\\\\\\": \\\\\\"High\\\\\\",\\\\n \\\\\\"identity\\\\\\": \\\\\\"a-customized-data-quality-rule-uuid\\\\\\"\\\\n}\\"\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => '获取数据质量扫描运行详情', + 'description' => '需要购买DataWorks基础版及以上版本才能使用。', + ], + 'CreateIdentifyCredential' => [ + 'summary' => '创建身份凭证。', + 'path' => '', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREdide23ZCHK', + ], + ], + 'parameters' => [ + [ + 'name' => 'IdentifyCredential', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'description' => '用户身份凭证对象', + 'required' => false, + 'enumValueTitles' => [], + '$ref' => '#/components/schemas/IdentifyCredential', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request', + 'type' => 'string', + 'example' => '0000-ABCD-EFG****', + ], + 'Data' => [ + 'description' => 'success true or false', + 'type' => 'string', + 'example' => '{ "HttpStatusCode": 200, "Success": true }', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0000-ABCD-EFG****\\",\\n \\"Data\\": \\"{ \\\\\\"HttpStatusCode\\\\\\": 200, \\\\\\"Success\\\\\\": true }\\"\\n}","type":"json"}]', + 'title' => '创建身份凭证', + 'description' => '><notice>该接口目前不支持批量操作，参数中填写多个发布实体时，除第一个以外的部分会被直接忽略。></notice>', + 'requestParamsDescription' => '注意：'."\n" + .'UserType、DataSource.Type、DataSource.Role 都必须传枚举范围内的值', + ], + 'CreateDataAssetTag' => [ + 'summary' => '创建标签。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'abilityTreeCode' => '250989', + 'abilityTreeNodes' => [ + 'FEATUREdideKQ371B', + ], + ], + 'parameters' => [ + [ + 'name' => 'Key', + 'in' => 'query', + 'schema' => [ + 'description' => '标签键。', + 'type' => 'string', + 'required' => true, + 'example' => 'key1', + 'maxLength' => 128, + 'minLength' => 1, + 'pattern' => '^([^\\x00-\\xff]|[\\w.,;/@\\n-])+$', + ], + ], + [ + 'name' => 'Values', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '标签值列表。', + 'type' => 'array', + 'items' => [ + 'description' => '标签值。', + 'type' => 'string', + 'required' => false, + 'example' => 'v1', + 'maxLength' => 128, + 'minLength' => 0, + 'pattern' => '^([^\\x00-\\xff]|[\\w.,;/@\\n-])+$', + ], + 'required' => false, + 'maxItems' => 20, + 'minItems' => 0, + ], + ], + [ + 'name' => 'Description', + 'in' => 'query', + 'schema' => [ + 'description' => '标签描述。', + 'type' => 'string', + 'required' => false, + 'example' => 'This is a description', + 'maxLength' => 1024, + 'minLength' => 0, + ], + ], + [ + 'name' => 'ValueType', + 'in' => 'query', + 'schema' => [ + 'description' => '标签值类型。'."\n" + .'- Boolean'."\n" + .'- Int'."\n" + .'- String'."\n" + .'- Double', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [], + 'example' => 'String', + 'enum' => [ + 'Boolean', + 'Int', + 'String', + 'Double', + ], + ], + ], + [ + 'name' => 'Managers', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '标签管理员列表。', + 'type' => 'array', + 'items' => [ + 'description' => '标签管理员。', + 'type' => 'string', + 'required' => false, + 'example' => '12345', + ], + 'required' => false, + 'maxItems' => 20, + 'minItems' => 0, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request', + 'type' => 'string', + 'example' => '0bc1ec92159376', + ], + 'Success' => [ + 'description' => '调用是否成功。', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'IdempotentParameterMismatch', + 'errorMessage' => 'The request uses the same client token as a previous, but non-identical request. Do not reuse a client token with different requests, unless the requests are identical.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0bc1ec92159376\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => '创建标签', + 'description' => '需要购买DataWorks企业版及以上版本才能使用。', + ], + 'DeleteDataAssetTag' => [ + 'summary' => '删除标签。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'abilityTreeCode' => '250987', + 'abilityTreeNodes' => [ + 'FEATUREdideKQ371B', + ], + ], + 'parameters' => [ + [ + 'name' => 'Key', + 'in' => 'query', + 'schema' => [ + 'description' => '标签键。', + 'type' => 'string', + 'required' => true, + 'example' => 'key1', + 'maxLength' => 128, + 'minLength' => 1, + ], + ], + [ + 'name' => 'Values', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '标签值列表。', + 'type' => 'array', + 'items' => [ + 'description' => '标签值。', + 'type' => 'string', + 'required' => false, + 'example' => 'v1', + 'maxLength' => 128, + 'minLength' => 0, + ], + 'required' => false, + 'maxItems' => 20, + 'minItems' => 0, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request', + 'type' => 'string', + 'example' => '0bc141151593763597*****', + ], + 'Success' => [ + 'description' => '调用是否成功。', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'IdempotentParameterMismatch', + 'errorMessage' => 'The request uses the same client token as a previous, but non-identical request. Do not reuse a client token with different requests, unless the requests are identical.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0bc141151593763597*****\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => '删除标签', + 'description' => '需要购买DataWorks企业版及以上版本才能使用。', + ], + 'UpdateDataAssetTag' => [ + 'summary' => '更新标签。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'abilityTreeCode' => '250867', + 'abilityTreeNodes' => [ + 'FEATUREdideKQ371B', + ], + 'autoTest' => true, + ], + 'parameters' => [ + [ + 'name' => 'Key', + 'in' => 'query', + 'schema' => [ + 'description' => '标签键。', + 'type' => 'string', + 'required' => true, + 'example' => 'key1', + 'maxLength' => 128, + 'minLength' => 1, + ], + ], + [ + 'name' => 'Values', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '标签值列表。', + 'type' => 'array', + 'items' => [ + 'description' => '标签值。', + 'type' => 'string', + 'required' => false, + 'example' => 'v1', + 'maxLength' => 128, + 'minLength' => 0, + 'pattern' => '^([^\\x00-\\xff]|[\\w.,;/@\\n-])+$', + ], + 'required' => false, + 'maxItems' => 20, + 'minItems' => 0, + ], + ], + [ + 'name' => 'Description', + 'in' => 'query', + 'schema' => [ + 'description' => '标签描述。', + 'type' => 'string', + 'required' => false, + 'example' => 'This is a description.', + 'maxLength' => 1024, + 'minLength' => 0, + ], + ], + [ + 'name' => 'Managers', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '标签管理员列表。', + 'type' => 'array', + 'items' => [ + 'description' => '标签管理员。', + 'type' => 'string', + 'required' => false, + 'example' => '12345', + ], + 'required' => false, + 'maxItems' => 20, + 'minItems' => 0, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request', + 'type' => 'string', + 'example' => '0bc1ec921****', + ], + 'Success' => [ + 'description' => '请求是否成功。', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'IdempotentParameterMismatch', + 'errorMessage' => 'The request uses the same client token as a previous, but non-identical request. Do not reuse a client token with different requests, unless the requests are identical.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0bc1ec921****\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => '更新标签', + 'description' => '需要购买DataWorks企业版及以上版本才能使用。', + ], + 'ListDataAssetTags' => [ + 'summary' => '查询标签列表。', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'abilityTreeCode' => '250731', + 'abilityTreeNodes' => [ + 'FEATUREdideKQ371B', + ], + ], + 'parameters' => [ + [ + 'name' => 'Key', + 'in' => 'query', + 'schema' => [ + 'description' => '标签键。', + 'type' => 'string', + 'required' => false, + 'example' => 'key1', + 'maxLength' => 128, + 'minLength' => 1, + ], + ], + [ + 'name' => 'Category', + 'in' => 'query', + 'schema' => [ + 'description' => '标签类型。'."\n" + .'- Normal'."\n" + .'- System', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [], + 'example' => 'Normal', + 'enum' => [ + 'Normal', + 'System', + ], + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '页码，从1开始，默认值为1。'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '200', + 'minimum' => '1', + 'example' => '1', + 'default' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '每页显示的条数，默认为10条，最大为100条。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '100', + 'minimum' => '1', + 'example' => '10', + 'default' => '10', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request', + 'type' => 'string', + 'example' => '0bc1ec92159376****', + ], + 'PagingInfo' => [ + 'description' => '标签列表分查询结果', + 'type' => 'object', + 'properties' => [ + 'TotalCount' => [ + 'description' => '总条数', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2524', + ], + 'PageSize' => [ + 'description' => '每页显示的条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'PageNumber' => [ + 'description' => '页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'DataAssetTags' => [ + 'description' => '标签列表。', + 'type' => 'array', + 'items' => [ + 'description' => '标签schema定义。', + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => '标签键。', + 'type' => 'string', + 'example' => 'key1', + ], + 'Category' => [ + 'description' => '标签类型。'."\n" + .'- Normal'."\n" + .'- System', + 'type' => 'string', + 'enumValueTitles' => [], + 'example' => 'Normal', + ], + 'Description' => [ + 'description' => '描述信息。', + 'type' => 'string', + 'example' => 'This is a description', + ], + 'ValueType' => [ + 'description' => '标签值类型。', + 'type' => 'string', + 'example' => 'String', + ], + 'Values' => [ + 'description' => '标签值列表。', + 'type' => 'array', + 'items' => [ + 'description' => '标签值。', + 'type' => 'string', + 'example' => 'v1', + ], + ], + 'Managers' => [ + 'description' => '标签管理员列表。', + 'type' => 'array', + 'items' => [ + 'description' => '工号', + 'type' => 'string', + 'example' => '12345', + ], + ], + 'ModifyTime' => [ + 'description' => '标签最近的修改时间。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1735890003000', + ], + 'CreateTime' => [ + 'description' => '标签的创建时间', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1735890003000', + ], + 'CreateUser' => [ + 'description' => '标签创建人。', + 'type' => 'string', + 'example' => '12345', + ], + 'ModifyUser' => [ + 'description' => '标签最近的修改人。', + 'type' => 'string', + 'example' => '1234', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0bc1ec92159376****\\",\\n \\"PagingInfo\\": {\\n \\"TotalCount\\": 2524,\\n \\"PageSize\\": 10,\\n \\"PageNumber\\": 1,\\n \\"DataAssetTags\\": [\\n {\\n \\"Key\\": \\"key1\\",\\n \\"Category\\": \\"Normal\\",\\n \\"Description\\": \\"This is a description\\",\\n \\"ValueType\\": \\"String\\",\\n \\"Values\\": [\\n \\"v1\\"\\n ],\\n \\"Managers\\": [\\n \\"12345\\"\\n ],\\n \\"ModifyTime\\": 1735890003000,\\n \\"CreateTime\\": 1735890003000,\\n \\"CreateUser\\": \\"12345\\",\\n \\"ModifyUser\\": \\"1234\\"\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => '查询标签列表', + 'description' => '需要购买DataWorks企业版及以上版本才能使用。', + ], + 'TagDataAssets' => [ + 'summary' => '为资产绑定标签。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '253894', + 'abilityTreeNodes' => [ + 'FEATUREdideKQ371B', + ], + ], + 'parameters' => [ + [ + 'name' => 'Tags', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '待绑定的数据资产标签列表', + 'type' => 'array', + 'items' => [ + 'description' => '标签K:V结构定义。', + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => '标签键。', + 'type' => 'string', + 'required' => true, + 'example' => 'key', + 'maxLength' => 128, + 'minLength' => 1, + 'pattern' => '^[\\u4E00-\\u9FA5A-Za-z0-9_\\-@#*<>|\\[\\]()+=&%$!~]+$', + ], + 'Value' => [ + 'description' => '标签值。', + 'type' => 'string', + 'required' => false, + 'example' => 'value', + 'maxLength' => 128, + 'minLength' => 0, + 'pattern' => '^[\\u4E00-\\u9FA5A-Za-z0-9_\\-@#*<>|\\[\\]()+=&%$.!~]+$', + ], + ], + 'required' => true, + ], + 'required' => true, + 'maxItems' => 20, + 'minItems' => 1, + ], + ], + [ + 'name' => 'DataAssetIds', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '数据资产唯一id列表。', + 'type' => 'array', + 'items' => [ + 'description' => '数据资产唯一id。', + 'type' => 'string', + 'required' => true, + 'example' => '7259557000', + ], + 'required' => true, + 'maxItems' => 100, + 'minItems' => 1, + ], + ], + [ + 'name' => 'DataAssetType', + 'in' => 'query', + 'schema' => [ + 'description' => '数据资产类型'."\n" + ."\n" + .'- 数据表（ACS::DataWorks::Table）'."\n" + ."\n" + .'- 调度任务（ACS::DataWorks::Task）', + 'type' => 'string', + 'required' => true, + 'enumValueTitles' => [], + 'example' => 'ACS::DataWorks::Task', + 'enum' => [ + 'ACS::DataWorks::Task', + 'ACS::DataWorks::Table', + ], + ], + ], + [ + 'name' => 'ProjectId', + 'in' => 'query', + 'schema' => [ + 'description' => '工作空间的ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '10000', + ], + ], + [ + 'name' => 'EnvType', + 'in' => 'query', + 'schema' => [ + 'description' => '数据资产所属的工作空间环境，包括：'."\n" + .'- Dev（开发环境）'."\n" + .'- Prod（生产环境）', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [], + 'example' => 'Prod', + 'enum' => [ + 'Dev', + 'Prod', + ], + ], + ], + [ + 'name' => 'AutoTraceEnabled', + 'in' => 'query', + 'schema' => [ + 'description' => '是否开启血缘自动回溯。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request', + 'type' => 'string', + 'example' => '0bc1ec92159376', + ], + 'Success' => [ + 'description' => '调用是否成功。取值如下：'."\n" + .'- true：调用成功。'."\n" + .'- false：调用失败。', + 'type' => 'string', + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'IdempotentParameterMismatch', + 'errorMessage' => 'The request uses the same client token as a previous, but non-identical request. Do not reuse a client token with different requests, unless the requests are identical.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0bc1ec92159376\\",\\n \\"Success\\": \\"true\\"\\n}","type":"json"}]', + 'title' => '绑定数据资产标签', + 'description' => '需要购买DataWorks企业版及以上版本才能使用。', + ], + 'UnTagDataAssets' => [ + 'summary' => '为数据资产解绑标签关系。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '253905', + 'abilityTreeNodes' => [ + 'FEATUREdideKQ371B', + ], + ], + 'parameters' => [ + [ + 'name' => 'Tags', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '待解绑的标签列表。', + 'type' => 'array', + 'items' => [ + 'description' => '标签K:V结构定义。', + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => '标签键。', + 'type' => 'string', + 'required' => true, + 'example' => 'key', + 'maxLength' => 128, + 'minLength' => 1, + 'pattern' => '^[\\u4E00-\\u9FA5A-Za-z0-9_\\-@#*<>|\\[\\]()+=&%$!~]+$', + ], + 'Value' => [ + 'description' => '标签值。', + 'type' => 'string', + 'required' => false, + 'example' => 'value', + 'maxLength' => 128, + 'minLength' => 0, + 'pattern' => '^[\\u4E00-\\u9FA5A-Za-z0-9_\\-@#*<>|\\[\\]()+=&%$!.~]+$', + ], + ], + 'required' => true, + ], + 'required' => true, + 'maxItems' => 20, + 'minItems' => 1, + ], + ], + [ + 'name' => 'DataAssetIds', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '数据资产唯一id列表。', + 'type' => 'array', + 'items' => [ + 'description' => '数据资产唯一id。', + 'type' => 'string', + 'required' => true, + 'example' => '7259557000', + ], + 'required' => true, + 'maxItems' => 100, + 'minItems' => 1, + ], + ], + [ + 'name' => 'DataAssetType', + 'in' => 'query', + 'schema' => [ + 'description' => '数据资产类型'."\n" + ."\n" + .'- 数据表（ACS::DataWorks::Table）'."\n" + ."\n" + .'- 调度任务（ACS::DataWorks::Task）', + 'type' => 'string', + 'required' => true, + 'enumValueTitles' => [], + 'example' => 'ACS::DataWorks::Task', + 'enum' => [ + 'ACS::DataWorks::Task', + 'ACS::DataWorks::Table', + ], + ], + ], + [ + 'name' => 'ProjectId', + 'in' => 'query', + 'schema' => [ + 'description' => '工作空间的ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '123', + ], + ], + [ + 'name' => 'EnvType', + 'in' => 'query', + 'schema' => [ + 'description' => '数据资产所属的工作空间环境，包括'."\n" + ."\n" + .'- Dev（开发环境）'."\n" + .'- Prod（生产环境）', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [], + 'example' => 'Prod', + 'enum' => [ + 'Prod', + 'Dev', + ], + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request', + 'type' => 'string', + 'example' => '8754EE08-4AA2-5F77-ADD7-754DBBDA9F75', + ], + 'Success' => [ + 'description' => '调用是否成功。取值如下：'."\n" + .'- true：调用成功。'."\n" + .'- false：调用失败。', + 'type' => 'string', + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'IdempotentParameterMismatch', + 'errorMessage' => 'The request uses the same client token as a previous, but non-identical request. Do not reuse a client token with different requests, unless the requests are identical.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"8754EE08-4AA2-5F77-ADD7-754DBBDA9F75\\",\\n \\"Success\\": \\"true\\"\\n}","type":"json"}]', + 'title' => '解绑数据资产标签', + 'description' => '需要购买DataWorks企业版及以上版本才能使用。', + ], + 'ListDataAssets' => [ + 'summary' => '分页查询已关联标签的DataWorks数据资产。', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'abilityTreeCode' => '253908', + 'abilityTreeNodes' => [ + 'FEATUREdideKQ371B', + ], + ], + 'parameters' => [ + [ + 'name' => 'Tags', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '数据资产关联的标签列表，基于标签做查询过滤：'."\n" + .'- 多个值之间是“或”的关系，比如`["key1:v1", "key2:v1", "key3:v1"]`底层查询包含任一一个标签的数据资产。'."\n" + .'- 不传递，或者传递为空表示不作tag过滤。', + 'type' => 'array', + 'items' => [ + 'description' => '标签K:V结构定义。', + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => '用户输入的自定义标签键。'."\n" + ."\n" + .'最多支持64个字符，不能以`dw:`开头，仅支持中英文数字和部分符号`-@#*<>|[]()+=&%$!~`。', + 'type' => 'string', + 'required' => true, + 'example' => 'key', + 'pattern' => '^[\\u4E00-\\u9FA5A-Za-z0-9_\\-@#*<>|\\[\\]()+=&%$!~]+$', + ], + 'Value' => [ + 'description' => '标签值。', + 'type' => 'string', + 'required' => false, + 'example' => 'value', + 'pattern' => '^[\\u4E00-\\u9FA5A-Za-z0-9_\\-@#*<>|\\[\\]()+=&%$!~]+$', + ], + ], + 'required' => true, + ], + 'required' => true, + 'maxItems' => 20, + 'minItems' => 1, + ], + ], + [ + 'name' => 'DataAssetIds', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '数据资产唯一id列表', + 'type' => 'array', + 'items' => [ + 'description' => '数据资产唯一id', + 'type' => 'string', + 'required' => false, + 'example' => '7000069357000', + ], + 'required' => false, + 'maxItems' => 100, + 'minItems' => 0, + ], + ], + [ + 'name' => 'DataAssetType', + 'in' => 'query', + 'schema' => [ + 'description' => '数据资产类型'."\n" + ."\n" + .'- 数据表（ACS::DataWorks::Table）'."\n" + ."\n" + .'- 调度任务（ACS::DataWorks::Task）', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [], + 'example' => 'ACS::DataWorks::Task', + 'enum' => [ + 'ACS::DataWorks::Table', + 'ACS::DataWorks::Task', + ], + ], + ], + [ + 'name' => 'ProjectId', + 'in' => 'query', + 'schema' => [ + 'description' => '工作空间的ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '10000', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '页码，从1开始，默认值为1。'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '200', + 'minimum' => '1', + 'example' => '1', + 'default' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '每页显示的条数，默认为10条，最大为100条。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '100', + 'minimum' => '1', + 'example' => '10', + 'default' => '10', + ], + ], + [ + 'name' => 'EnvType', + 'in' => 'query', + 'schema' => [ + 'description' => '数据资产所属的工作空间环境，包括'."\n" + .'- Dev（开发环境）'."\n" + .'- Prod（生产环境）', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [], + 'example' => 'Prod', + 'enum' => [ + 'Prod', + 'Dev', + ], + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request', + 'type' => 'string', + 'example' => '0bc1ec92159376', + ], + 'PagingInfo' => [ + 'description' => '分页信息。', + 'type' => 'object', + 'properties' => [ + 'TotalCount' => [ + 'description' => '总条数', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '100', + ], + 'PageNumber' => [ + 'description' => '页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '每页显示的条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'DataAssets' => [ + 'description' => '数据资产列表。', + 'type' => 'array', + 'items' => [ + 'description' => '数据资产Schema定义。', + 'type' => 'object', + 'properties' => [ + 'Id' => [ + 'description' => '数据资产id。', + 'type' => 'string', + 'example' => '7259557313', + ], + 'Name' => [ + 'description' => '数据资产的名称。', + 'type' => 'string', + 'example' => 'ali_cn_es_gfn', + ], + 'Type' => [ + 'description' => '数据资产类型'."\n" + ."\n" + .'- 数据表（ACS::DataWorks::Table）'."\n" + ."\n" + .'- 调度任务（ACS::DataWorks::Task）', + 'type' => 'string', + 'enumValueTitles' => [], + 'example' => 'ACS::DataWorks::Task', + ], + 'EnvType' => [ + 'description' => '数据资产所属的工作空间环境，包括'."\n" + .'- Dev（开发环境）'."\n" + .'- Prod（生产环境）', + 'type' => 'string', + 'enumValueTitles' => [], + 'example' => 'Prod', + ], + 'ProjectId' => [ + 'description' => 'Dataworks工作空间的ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '54275', + ], + 'DataAssetTagMappings' => [ + 'description' => '数据资产管理的标签列表。', + 'type' => 'array', + 'items' => [ + 'description' => '数据资产和标签映射关系Schema定义。', + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => '标签键。', + 'type' => 'string', + 'example' => 'key', + ], + 'Value' => [ + 'description' => '标签值。', + 'type' => 'string', + 'example' => 'value', + ], + 'TagSource' => [ + 'description' => '数据资产和标签关系的来源：'."\n" + ."\n" + .'- System：来源于数据资产治理系统的操作'."\n" + .'- UserDefined：来源于用户手动自定义', + 'type' => 'string', + 'enumValueTitles' => [], + 'example' => 'UserDefined', + ], + 'Creator' => [ + 'description' => '数据资产和标签映射关系的创建者。', + 'type' => 'string', + 'example' => '12345', + ], + 'AutoTraceEnabled' => [ + 'description' => '是否开启血缘自动回溯。', + 'type' => 'boolean', + 'example' => 'false', + ], + 'DataAssetId' => [ + 'description' => '数据资产id', + 'type' => 'string', + 'example' => '7259557313', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0bc1ec92159376\\",\\n \\"PagingInfo\\": {\\n \\"TotalCount\\": 100,\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"DataAssets\\": [\\n {\\n \\"Id\\": \\"7259557313\\",\\n \\"Name\\": \\"ali_cn_es_gfn\\",\\n \\"Type\\": \\"ACS::DataWorks::Task\\",\\n \\"EnvType\\": \\"Prod\\",\\n \\"ProjectId\\": 54275,\\n \\"DataAssetTagMappings\\": [\\n {\\n \\"Key\\": \\"key\\",\\n \\"Value\\": \\"value\\",\\n \\"TagSource\\": \\"UserDefined\\",\\n \\"Creator\\": \\"12345\\",\\n \\"AutoTraceEnabled\\": false,\\n \\"DataAssetId\\": \\"7259557313\\"\\n }\\n ]\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => '查询已关联标签的资产列表', + 'description' => '需要购买DataWorks企业版及以上版本才能使用。', + ], + 'GetJobStatus' => [ + 'summary' => '返回异步任务的状态信息，调用异步化API后，通过轮训此API来获取成功状态。', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '248471', + 'abilityTreeNodes' => [ + 'FEATUREdide63BO88', + ], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'JobId', + 'in' => 'query', + 'schema' => [ + 'description' => '调用异步API后返回的任务ID。', + 'type' => 'string', + 'required' => true, + 'example' => '70ecdaec-bf21-4c11-8ecb-4f77453ceea8', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '5E2BFE96-C0E0-5A98-85C8-633EC803198D', + ], + 'JobStatus' => [ + 'description' => '任务状态实时结果。', + 'type' => 'object', + 'properties' => [ + 'JobId' => [ + 'description' => '异步任务ID。', + 'type' => 'string', + 'example' => 'C664CDE3-9C0B-5792-B17F-6C543783BBBC', + ], + 'JobType' => [ + 'description' => '任务类型。'."\n" + ."\n" + .'- **Create**：创建类任务。'."\n" + ."\n" + .'- **Update**：更新类任务。'."\n" + ."\n" + .'- **Cancel**：取消类任务。', + 'type' => 'string', + 'example' => 'Create', + ], + 'Completed' => [ + 'description' => '操作是否完成'."\n" + .'True：当前Job已经执行完成。 False：当前Job还在执行中。', + 'type' => 'string', + 'example' => 'False', + ], + 'Status' => [ + 'description' => '任务状态。取值：'."\n" + .'- **Success**：成功'."\n" + .'- **Fail**：失败'."\n" + .'- **Cancel**：取消'."\n" + .'- **Running**：执行中', + 'type' => 'string', + 'example' => 'Success', + ], + 'Error' => [ + 'description' => '任务失败信息', + 'type' => 'string', + 'example' => 'Not Found', + ], + 'CreateTime' => [ + 'description' => '创建时间。', + 'type' => 'string', + 'example' => '1729063449802', + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"5E2BFE96-C0E0-5A98-85C8-633EC803198D\\",\\n \\"JobStatus\\": {\\n \\"JobId\\": \\"C664CDE3-9C0B-5792-B17F-6C543783BBBC\\",\\n \\"JobType\\": \\"Create\\",\\n \\"Completed\\": \\"False\\",\\n \\"Status\\": \\"Success\\",\\n \\"Error\\": \\"Not Found\\",\\n \\"CreateTime\\": \\"1729063449802\\"\\n }\\n}","type":"json"}]', + 'title' => '获取异步API运行状态', + ], + 'ListDataQualityEvaluationTasks' => [ + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '240369', + 'abilityTreeNodes' => [ + 'FEATUREdideGK4B66', + ], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'ProjectId', + 'in' => 'query', + 'schema' => [ + 'description' => 'DataWorks工作空间ID', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + 'example' => '100', + ], + ], + [ + 'name' => 'TableGuid', + 'in' => 'query', + 'schema' => [ + 'description' => '表在数据地图中的唯一ID', + 'type' => 'string', + 'required' => false, + 'example' => 'odps.unit_test.tb_unit_test', + ], + ], + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => [ + 'description' => '模糊匹配数据质量校验任务名称', + 'type' => 'string', + 'required' => false, + 'example' => 'Test', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '列表分页查询页大小，默认为10', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'docRequired' => true, + 'maximum' => '200', + 'minimum' => '1', + 'example' => '10', + 'default' => '10', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '列表分页查询页码，默认为1', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'docRequired' => true, + 'example' => '1', + 'default' => '1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'PaginatedModel<DataQualityEvaluationTask>', + 'description' => '返回值', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '追踪ID，用于跟踪一次完整调用，出现异常时可以根据这个字符串排查异常链路', + 'description' => 'API请求ID', + 'type' => 'string', + 'example' => '691CA452-D37A-4ED0-****', + ], + 'PagingInfo' => [ + 'description' => '质量校验任务分页查询结果', + 'type' => 'object', + 'properties' => [ + 'TotalCount' => [ + 'description' => '总条数', + 'type' => 'string', + 'example' => '131', + ], + 'PageSize' => [ + 'description' => '页大小', + 'type' => 'string', + 'example' => '10', + 'default' => '10', + ], + 'PageNumber' => [ + 'description' => '页码', + 'type' => 'string', + 'example' => '1', + 'default' => '1', + ], + 'DataQualityEvaluationTasks' => [ + 'description' => '质量校验任务', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Id' => [ + 'description' => '数据质量校验任务ID', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10001', + ], + 'Name' => [ + 'description' => '数据质量校验任务名称，数字、英文字母、汉字、半角全角标点符号组合，最长255个字符。', + 'type' => 'string', + 'example' => 'Data quality verification task', + ], + 'Description' => [ + 'description' => '数据质量校验任务描述，最长65535个字符', + 'type' => 'string', + 'example' => 'This is a daily run data quality evaluation plan', + ], + 'ProjectId' => [ + 'description' => 'DataWorks工作空间ID', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '100', + ], + 'Target' => [ + 'description' => '数据质量校验任务的监控对象', + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'description' => '监控对象类型'."\n" + ."\n" + .'- Table', + 'type' => 'string', + 'example' => 'Table', + ], + 'DatabaseType' => [ + 'description' => '表类型的数据集，表所属的数据库类型'."\n" + .'- maxcompute'."\n" + .'- emr'."\n" + .'- cdh'."\n" + .'- hologres'."\n" + .'- analyticdb_for_postgresql'."\n" + .'- analyticdb_for_mysql'."\n" + .'- starrocks', + 'type' => 'string', + 'example' => 'maxcompute', + ], + 'TableGuid' => [ + 'description' => '表在数据地图中的唯一ID', + 'type' => 'string', + 'example' => 'odps.unit_test.tb_unit_test', + ], + 'PartitionSpec' => [ + 'description' => '分区表的分区设置', + 'type' => 'string', + 'example' => 'ds=$[yyyymmdd-1]', + ], + ], + ], + 'Trigger' => [ + 'description' => '数据质量校验任务的触发配置', + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'description' => '何种事件可以触发质量校验任务执行'."\n" + ."\n" + .'- ByScheduledTaskInstance：调度实例运行成功', + 'type' => 'string', + 'example' => 'ByScheduledTaskInstance', + ], + 'TaskIds' => [ + 'description' => 'type=ByScheduledTaskInstance时生效'."\n" + .',具体指明哪些调度节点的实例执行成功后可以触发', + 'type' => 'array', + 'items' => [ + 'description' => '调度任务节点ID', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10001', + ], + ], + ], + ], + 'RuntimeConf' => [ + 'description' => '使用数据源时的一些设置，目前只支持指定EMR的yarn队列、采集EMR表时SQL引擎指定为SPARK_SQL|KYUUBI|PRESTO_SQL|HIVE_SQL', + 'type' => 'string', + 'example' => '{ "queue": "default", "sqlEngine": "SPARK_SQL" }', + ], + 'Hooks' => [ + 'description' => '数据质量校验任务实例生命周期中的回调设置，目前只支持一个阻塞调度任务的Hook', + 'type' => 'array', + 'items' => [ + 'description' => '回调设置', + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'description' => '后续处理动作类型'."\n" + .'- BlockTaskInstance：阻塞DataWorks任务实例执行', + 'type' => 'string', + 'example' => 'BlockTaskInstance', + ], + 'Condition' => [ + 'description' => 'Hook触发条件', + 'type' => 'string', + 'example' => '${severity} == "High" AND ${status} == "Critical"', + ], + ], + ], + ], + 'Notifications' => [ + 'description' => '告警配置', + 'type' => 'object', + 'properties' => [ + 'Condition' => [ + 'description' => 'Notification触发条件', + 'type' => 'string', + 'example' => '${severity} == "High"', + ], + 'Notifications' => [ + 'description' => '具体的告警设置', + 'type' => 'array', + 'items' => [ + 'description' => '告警设置', + 'type' => 'object', + 'properties' => [ + 'NotificationChannels' => [ + 'description' => '告警方式配置', + 'type' => 'array', + 'items' => [ + 'description' => '告警方式', + 'type' => 'object', + 'properties' => [ + 'Channels' => [ + 'description' => '告警方式', + 'type' => 'array', + 'items' => [ + 'description' => '告警方式'."\n" + .'- Mail - 邮件'."\n" + .'- Sms - 短信'."\n" + .'- Phone - 电话'."\n" + .'- Feishu - 飞书'."\n" + .'- Weixin - 微信'."\n" + .'- Dingding - 钉钉'."\n" + .'- Webhook - 自定义Webhook', + 'type' => 'string', + 'example' => 'Mail', + ], + ], + ], + ], + ], + 'NotificationReceivers' => [ + 'description' => '告警接收人配置', + 'type' => 'array', + 'items' => [ + 'description' => '告警接收人', + 'type' => 'object', + 'properties' => [ + 'ReceiverType' => [ + 'description' => '告警接收人类型'."\n" + .'- AliUid - 阿里云账号Uid'."\n" + .'- WebhookUrl - 自定义 webhook URL'."\n" + .'- DingdingUrl - 钉钉机器人Url'."\n" + .'- FeishuUrl - 飞书机器人Url'."\n" + .'- WeixinUrl - 企微机器人Url', + 'type' => 'string', + 'example' => 'AliUid', + ], + 'ReceiverValues' => [ + 'description' => '告警接收人具体值', + 'type' => 'array', + 'items' => [ + 'description' => '告警接收人具体值', + 'type' => 'string', + 'example' => 'user1', + ], + ], + 'Extension' => [ + 'description' => '扩展信息，格式为 json，例如钉钉机器人支持 at 所有人', + 'type' => 'string', + 'example' => '{"atAll":"true"}', + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'DataSourceId' => [ + 'type' => 'integer', + 'format' => 'int64', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"691CA452-D37A-4ED0-****\\",\\n \\"PagingInfo\\": {\\n \\"TotalCount\\": \\"131\\",\\n \\"PageSize\\": \\"10\\",\\n \\"PageNumber\\": \\"1\\",\\n \\"DataQualityEvaluationTasks\\": [\\n {\\n \\"Id\\": 10001,\\n \\"Name\\": \\"Data quality verification task\\",\\n \\"Description\\": \\"This is a daily run data quality evaluation plan\\",\\n \\"ProjectId\\": 100,\\n \\"Target\\": {\\n \\"Type\\": \\"Table\\",\\n \\"DatabaseType\\": \\"maxcompute\\",\\n \\"TableGuid\\": \\"odps.unit_test.tb_unit_test\\",\\n \\"PartitionSpec\\": \\"ds=$[yyyymmdd-1]\\"\\n },\\n \\"Trigger\\": {\\n \\"Type\\": \\"ByScheduledTaskInstance\\",\\n \\"TaskIds\\": [\\n 10001\\n ]\\n },\\n \\"RuntimeConf\\": \\"{ \\\\\\"queue\\\\\\": \\\\\\"default\\\\\\", \\\\\\"sqlEngine\\\\\\": \\\\\\"SPARK_SQL\\\\\\" }\\",\\n \\"Hooks\\": [\\n {\\n \\"Type\\": \\"BlockTaskInstance\\",\\n \\"Condition\\": \\"${severity} == \\\\\\"High\\\\\\" AND ${status} == \\\\\\"Critical\\\\\\"\\"\\n }\\n ],\\n \\"Notifications\\": {\\n \\"Condition\\": \\"${severity} == \\\\\\"High\\\\\\"\\",\\n \\"Notifications\\": [\\n {\\n \\"NotificationChannels\\": [\\n {\\n \\"Channels\\": [\\n \\"Mail\\"\\n ]\\n }\\n ],\\n \\"NotificationReceivers\\": [\\n {\\n \\"ReceiverType\\": \\"AliUid\\",\\n \\"ReceiverValues\\": [\\n \\"user1\\"\\n ],\\n \\"Extension\\": \\"{\\\\\\"atAll\\\\\\":\\\\\\"true\\\\\\"}\\"\\n }\\n ]\\n }\\n ]\\n },\\n \\"DataSourceId\\": 0\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => '查询质量监控任务列表', + 'summary' => '质量监控任务列表分页查询。', + 'description' => '需要购买DataWorks基础版及以上版本才能使用', + ], + 'ListDataQualityRules' => [ + 'summary' => '质量监控规则分页查询。', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'abilityTreeCode' => '237677', + 'abilityTreeNodes' => [ + 'FEATUREdide3WJOKE', + ], + ], + 'parameters' => [ + [ + 'name' => 'ProjectId', + 'in' => 'query', + 'schema' => [ + 'title' => '项目id', + 'description' => 'DataWorks工作空间ID', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + 'example' => '10002', + ], + ], + [ + 'name' => 'DataQualityEvaluationTaskId', + 'in' => 'query', + 'schema' => [ + 'title' => '关联的质量校验任务ID', + 'description' => '关联的质量校验任务ID', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '10000', + ], + ], + [ + 'name' => 'TableGuid', + 'in' => 'query', + 'schema' => [ + 'title' => '规则所作用的表在数据地图中的唯一标识', + 'description' => '规则所作用的表在数据地图中的唯一标识', + 'type' => 'string', + 'required' => false, + 'example' => 'odps.unit_test.tb_unit_test', + ], + ], + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => [ + 'title' => '模糊匹配规则名称', + 'description' => '模糊匹配规则名称', + 'type' => 'string', + 'required' => false, + 'example' => 'unit_test', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '每页显示的条数，默认为10条，最大为200条', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'docRequired' => true, + 'maximum' => '200', + 'minimum' => '1', + 'example' => '10', + 'default' => '10', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '分页查询页码，默认为1', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'docRequired' => true, + 'example' => '1', + 'default' => '1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'PaginatedModel<DataQualityRule>', + 'description' => '返回值', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '追踪ID，用于跟踪一次完整调用，出现异常时可以根据这个字符串排查异常链路', + 'description' => 'API请求ID', + 'type' => 'string', + 'example' => '691CA452-D37A-4ED0-9441', + ], + 'PagingInfo' => [ + 'description' => '规则列表分查询结果', + 'type' => 'object', + 'properties' => [ + 'PageNumber' => [ + 'description' => '页码', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '页大小', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'TotalCount' => [ + 'description' => '总条数', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '294', + ], + 'DataQualityRules' => [ + 'description' => '具体的规则列表', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Id' => [ + 'description' => '规则ID', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '22130', + ], + 'Name' => [ + 'description' => '规则名称', + 'type' => 'string', + 'example' => '表不能为空', + ], + 'ProjectId' => [ + 'description' => 'DataWorks工作空间ID', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '100001', + ], + 'Enabled' => [ + 'description' => '质量规则是否启用', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Severity' => [ + 'description' => '规则对于业务的等级（对应页面上的强弱规则），可选的枚举值：'."\n" + .'- Normal'."\n" + .'- High', + 'type' => 'string', + 'example' => 'High', + ], + 'Description' => [ + 'description' => '规则描述信息，最长500个字符', + 'type' => 'string', + 'example' => 'this is a odps _sql task', + ], + 'Target' => [ + 'description' => '规则所监控的对象', + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'description' => '监控对象类型'."\n" + ."\n" + .'- Table', + 'type' => 'string', + 'example' => 'Table', + ], + 'DatabaseType' => [ + 'description' => '表类型的数据集，表所属的数据库类型'."\n" + .'- maxcompute'."\n" + .'- emr'."\n" + .'- cdh'."\n" + .'- hologres'."\n" + .'- analyticdb_for_postgresql'."\n" + .'- analyticdb_for_mysql'."\n" + .'- starrocks', + 'type' => 'string', + 'example' => 'maxcompute', + ], + 'TableGuid' => [ + 'description' => '规则所作用的表在数据地图中的唯一ID', + 'type' => 'string', + 'example' => 'odps.unit_test.tb_unit_test', + ], + ], + ], + 'TemplateCode' => [ + 'description' => '规则所引用的规则模板唯一标识', + 'type' => 'string', + 'example' => 'SYSTEM:user_defined_sql', + ], + 'SamplingConfig' => [ + 'description' => '样本采集所需的设置', + 'type' => 'object', + 'properties' => [ + 'Metric' => [ + 'description' => '采样的指标名称'."\n" + .'- Count：表行数'."\n" + .'- Min：字段最小值'."\n" + .'- Max：字段最大值'."\n" + .'- Avg：字段均值'."\n" + .'- DistinctCount：字段唯一值个数'."\n" + .'- DistinctPercent：字段唯一值个数与数据行数占比'."\n" + .'- DuplicatedCount：字段重复值个数'."\n" + .'- DuplicatedPercent：字段重复值个数与数据行数占比'."\n" + .'- TableSize：表大小'."\n" + .'- NullValueCount：字段为空的行数'."\n" + .'- NullValuePercent：字段为空的比例'."\n" + .'- GroupCount：按字段值聚合后每个值与对应的数据行数'."\n" + .'- CountNotIn：枚举值不匹配行数'."\n" + .'- CountDistinctNotIn：枚举值不匹配唯一值个数'."\n" + .'- UserDefinedSql：通过自定义SQL做样本采集', + 'type' => 'string', + 'example' => 'Max', + ], + 'MetricParameters' => [ + 'description' => '样本采集时，所需的参数', + 'type' => 'string', + 'example' => '{ "Columns": [ "id", "name" ] , "SQL": "select count(1) from table;"}', + ], + 'SettingConfig' => [ + 'description' => '具体执行采样语句前，插入执行的一些运行时参数设置语句，最长1000个字符。目前只支持MaxCompute', + 'type' => 'string', + 'example' => 'SET odps.sql.udf.timeout=600s; '."\n" + .'SET odps.sql.python.version=cp27;', + ], + 'SamplingFilter' => [ + 'description' => '采样时，对不关注的数据进行二次过滤的条件，最多16777215个字符', + 'type' => 'string', + 'example' => 'id IS NULL', + ], + ], + ], + 'CheckingConfig' => [ + 'description' => '样本校验设置', + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'description' => '阈值计算方式'."\n" + .'- Fixed'."\n" + .'- Fluctation'."\n" + .'- FluctationDiscreate'."\n" + .'- Auto'."\n" + .'- Average'."\n" + .'- Variance', + 'type' => 'string', + 'example' => 'Fixed', + ], + 'ReferencedSamplesFilter' => [ + 'description' => '有些类型的阈值需要查询出一些参考样本，然后对参考样本的值进行汇总得出进行比较的阈值，这里使用一个表达式来表示参考样本的查询方式', + 'type' => 'string', + 'example' => '{ "bizdate": [ "-1", "-7", "-1m" ] }', + ], + 'Thresholds' => [ + 'description' => '阈值设置', + 'type' => 'object', + 'properties' => [ + 'Expected' => [ + 'description' => '期望的阈值设置', + 'type' => 'object', + 'properties' => [ + 'Operator' => [ + 'description' => '比较符'."\n" + .'- \\>'."\n" + .'- \\>='."\n" + .'- <'."\n" + .'- <='."\n" + .'- !='."\n" + .'- =', + 'type' => 'string', + 'example' => '>', + ], + 'Value' => [ + 'description' => '阈值数值', + 'type' => 'string', + 'example' => '100.0', + ], + 'Expression' => [ + 'description' => '阈值表达式。'."\n" + ."\n" + .'波动率类型规则必须使用表达式方式表示波动阈值。如：'."\n" + ."\n" + .'- 波动上升大于0.01： $checkValue > 0.01 '."\n" + .'- 波动下降大于0.01：$checkValue < -0.01 '."\n" + .'- 波动率绝对值：abs($checkValue) > 0.01'."\n" + ."\n" + .'固定值类型规则也可以使用表达式方式配置阈值，如果同时配置，表达式优先级高于Operator和Value', + 'type' => 'string', + 'example' => '$checkValue > 0.01', + ], + ], + ], + 'Warned' => [ + 'description' => '普通警告的阈值设置', + 'type' => 'object', + 'properties' => [ + 'Operator' => [ + 'description' => '比较符'."\n" + .'- \\>'."\n" + .'- \\>='."\n" + .'- <'."\n" + .'- <='."\n" + .'- !='."\n" + .'- =', + 'type' => 'string', + 'example' => '>', + ], + 'Value' => [ + 'description' => '阈值数值', + 'type' => 'string', + 'example' => '100.0', + ], + 'Expression' => [ + 'description' => '阈值表达式。'."\n" + ."\n" + .'波动率类型规则必须使用表达式方式表示波动阈值。如：'."\n" + ."\n" + .'- 波动上升大于0.01： $checkValue > 0.01 '."\n" + .'- 波动下降大于0.01：$checkValue < -0.01 '."\n" + .'- 波动率绝对值：abs($checkValue) > 0.01'."\n" + ."\n" + .'固定值类型规则也可以使用表达式方式配置阈值，如果同时配置，表达式优先级高于Operator和Value', + 'type' => 'string', + 'example' => '$checkValue > 0.01', + ], + ], + ], + 'Critical' => [ + 'description' => '严重警告的阈值设置', + 'type' => 'object', + 'properties' => [ + 'Operator' => [ + 'description' => '比较符'."\n" + .'- \\>'."\n" + .'- \\>='."\n" + .'- <'."\n" + .'- <='."\n" + .'- !='."\n" + .'- =', + 'type' => 'string', + 'example' => '>', + ], + 'Value' => [ + 'description' => '阈值数值', + 'type' => 'string', + 'example' => '100.0', + ], + 'Expression' => [ + 'description' => '阈值表达式。'."\n" + ."\n" + .'波动率类型规则必须使用表达式方式表示波动阈值。如：'."\n" + ."\n" + .'- 波动上升大于0.01： $checkValue > 0.01 '."\n" + .'- 波动下降大于0.01：$checkValue < -0.01 '."\n" + .'- 波动率绝对值：abs($checkValue) > 0.01'."\n" + ."\n" + .'固定值类型规则也可以使用表达式方式配置阈值，如果同时配置，表达式优先级高于Operator和Value', + 'type' => 'string', + 'example' => '$checkValue > 0.01', + ], + ], + ], + ], + ], + ], + ], + 'ErrorHandlers' => [ + 'description' => '质量规则校验问题处理器列表', + 'type' => 'array', + 'items' => [ + 'description' => '质量规则校验问题处理器', + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'description' => '处理器类型：'."\n" + .'- SaveErrorData', + 'type' => 'string', + 'example' => 'SaveErrorData'."\n", + ], + 'ErrorDataFilter' => [ + 'description' => '如果是自定义SQL规则，需要用户指定SQL来过滤问题数据', + 'type' => 'string', + 'example' => 'SELECT * FROM tb_api_log WHERE id IS NULL', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"691CA452-D37A-4ED0-9441\\",\\n \\"PagingInfo\\": {\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 294,\\n \\"DataQualityRules\\": [\\n {\\n \\"Id\\": 22130,\\n \\"Name\\": \\"表不能为空\\",\\n \\"ProjectId\\": 100001,\\n \\"Enabled\\": true,\\n \\"Severity\\": \\"High\\",\\n \\"Description\\": \\"this is a odps _sql task\\",\\n \\"Target\\": {\\n \\"Type\\": \\"Table\\",\\n \\"DatabaseType\\": \\"maxcompute\\",\\n \\"TableGuid\\": \\"odps.unit_test.tb_unit_test\\"\\n },\\n \\"TemplateCode\\": \\"SYSTEM:user_defined_sql\\",\\n \\"SamplingConfig\\": {\\n \\"Metric\\": \\"Max\\",\\n \\"MetricParameters\\": \\"{ \\\\\\"Columns\\\\\\": [ \\\\\\"id\\\\\\", \\\\\\"name\\\\\\" ] , \\\\\\"SQL\\\\\\": \\\\\\"select count(1) from table;\\\\\\"}\\",\\n \\"SettingConfig\\": \\"SET odps.sql.udf.timeout=600s; \\\\nSET odps.sql.python.version=cp27;\\",\\n \\"SamplingFilter\\": \\"id IS NULL\\"\\n },\\n \\"CheckingConfig\\": {\\n \\"Type\\": \\"Fixed\\",\\n \\"ReferencedSamplesFilter\\": \\"{ \\\\\\"bizdate\\\\\\": [ \\\\\\"-1\\\\\\", \\\\\\"-7\\\\\\", \\\\\\"-1m\\\\\\" ] }\\",\\n \\"Thresholds\\": {\\n \\"Expected\\": {\\n \\"Operator\\": \\">\\",\\n \\"Value\\": \\"100.0\\",\\n \\"Expression\\": \\"$checkValue > 0.01\\"\\n },\\n \\"Warned\\": {\\n \\"Operator\\": \\">\\",\\n \\"Value\\": \\"100.0\\",\\n \\"Expression\\": \\"$checkValue > 0.01\\"\\n },\\n \\"Critical\\": {\\n \\"Operator\\": \\">\\",\\n \\"Value\\": \\"100.0\\",\\n \\"Expression\\": \\"$checkValue > 0.01\\"\\n }\\n }\\n },\\n \\"ErrorHandlers\\": [\\n {\\n \\"Type\\": \\"SaveErrorData\\\\n\\",\\n \\"ErrorDataFilter\\": \\"SELECT * FROM tb_api_log WHERE id IS NULL\\"\\n }\\n ]\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => '查询质量规则列表', + 'description' => '需要购买DataWorks基础版及以上版本才能使用', + 'extraInfo' => '规则模版Code列表：'."\n" + .'- 自定义SQL：SYSTEM:user_defined_sql'."\n" + ."\n" + .'- 表行数大于0：SYSTEM:table:table_count:fixed:0'."\n" + .'- 表行数，固定值：SYSTEM:table:table_count:fixed'."\n" + .'- 表行数，1天差值：SYSTEM:table:table_count_delta:fixed:1_bizdate'."\n" + .'- 表行数，上周期差值：SYSTEM:table:table_count_delta:fixed:latest_bizdate'."\n" + .'- 表行数，上周期波动率：SYSTEM:table:table_count:cycle:latest_bizdate'."\n" + .'- 表行数，7天平均值波动率：SYSTEM:table:table_count:avg:7_bizdate'."\n" + .'- 表行数，30天平均值波动率：SYSTEM:table:table_count:avg:1m_bizdate'."\n" + .'- 表行数，1天波动率：SYSTEM:table:table_count:flux:1_bizdate'."\n" + .'- 表行数，7天波动率：SYSTEM:table:table_count:flux:7_bizdate'."\n" + .'- 表行数，30天波动率：SYSTEM:table:table_count:flux:1m_bizdate'."\n" + .'- 表行数，1，7，30天波动率：SYSTEM:table:table_count:flux:1_7_1m_bizdate'."\n" + .'- 表行数，1，7，30天，本月1号，波动率：SYSTEM:table:table_count:flux:1_7_1m_1st_bizdate'."\n" + .'- 表行数，自定义范围：SYSTEM:table:count'."\n" + .'- 条件匹配占比，自定义范围：SYSTEM:table:count_percent'."\n" + ."\n" + .'- 平均值，1天波动率：SYSTEM:field:avg:cycle:1_bizdate'."\n" + .'- 平均值，1、7、30天波动率：SYSTEM:field:avg:flux:1_7_1m_bizdate'."\n" + .'- 平均值，自定义范围：SYSTEM:field:avg'."\n" + ."\n" + .'- 汇总值，1天波动率：SYSTEM:field:sum:cycle:1_bizdate'."\n" + .'- 汇总值，上周期波动率：SYSTEM:field:sum:cycle:latest_bizdate'."\n" + .'- 汇总值，1、7、30天波动率：SYSTEM:field:sum:flux:1_7_1m_bizdate'."\n" + .'- 汇总值，自定义范围：SYSTEM:field:sum'."\n" + ."\n" + .'- 最小值，1天波动率：SYSTEM:field:min:cycle:1_bizdate'."\n" + .'- 最小值，上周期波动率：SYSTEM:field:min:cycle:latest_bizdate'."\n" + .'- 最小值，1、7、30天波动率：SYSTEM:field:min:flux:1_7_1m_bizdate'."\n" + .'- 最小值，自定义范围：SYSTEM:field:min'."\n" + ."\n" + .'- 最大值，1天波动率：SYSTEM:field:max:cycle:1_bizdate'."\n" + .'- 最大值，上周期波动率：SYSTEM:field:max:cycle:latest_bizdate'."\n" + .'- 最大值，1、7、30天波动率：SYSTEM:field:max:flux:1_7_1m_bizdate'."\n" + .'- 最大值，自定义范围：SYSTEM:field:max'."\n" + ."\n" + .'- 空值记录数为0：SYSTEM:field:null_value:fixed:0'."\n" + .'- 空值个数，固定值：SYSTEM:field:null_value:fixed'."\n" + .'- 空值个数/总行数，固定值：SYSTEM:field:null_value_percent:fixed'."\n" + ."\n" + .'- 字段重复值为0：SYSTEM:field:duplicated_count:fixed:0'."\n" + .'- 重复值个数/总行数，固定值：SYSTEM:field:duplicated_percent:fixed'."\n" + .'- 重复值个数，固定值：YSTEM:field:duplicated_count:fixed'."\n" + .'- 多字段重复值为0：SYSTEM:fields:duplicated_count:fixed:0'."\n" + ."\n" + .'- 离散值（状态值），固定值：SYSTEM:field:all_discrete_count:fixed'."\n" + .'- 离散值（分组个数及状态值），1、7、30天波动率：SYSTEM:field:all_discrete_metrics:fluxdiscrete:1_7_1m_bizdate'."\n" + .'- 离散值（分组个数），固定值：SYSTEM:field:discrete_group_count:fixed'."\n" + .'- 离散值（分组个数），1天波动率：SYSTEM:field:discrete_group_count:cycle:latest_bizdate'."\n" + ."\n" + .'- 表大小，固定值：SYSTEM:table:table_size:fixed'."\n" + .'- 表大小，上周期差值：SYSTEM:table:table_size_delta:fixed:latest_bizdate'."\n" + .'- 表大小，相比1天前差值（字节）：SYSTEM:table:table_size_delta:fixed:1_bizdate'."\n" + .'- 表大小，1天波动率：SYSTEM:table:table_size:flux:1_bizdate'."\n" + .'- 表大小，7天波动率：SYSTEM:table:table_size:flux:7_bizdate'."\n" + .'- 表大小，30天波动率：SYSTEM:table:table_size:flux:1m_bizdate'."\n" + ."\n" + .'- 唯一值个数，固定值：SYSTEM:field:count_distinct:fixed'."\n" + .'- 唯一值个数，1、7、30天波动率：SYSTEM:field:count_distinct:flux:1_7_1m_bizdate'."\n" + .'- 唯一值个数/总行数，固定值：SYSTEM:field:count_distinct_percent:fixed'."\n" + ."\n" + .'- 表行数，动态阈值：SYSTEM:table:table_count:dynamic_threshold'."\n" + .'- 汇总值，动态阈值：SYSTEM:field:sum:dynamic_threshold'."\n" + .'- 平均值，动态阈值：SYSTEM:field:avg:dynamic_threshold'."\n" + .'- 最大值，动态阈值：SYSTEM:field:max:dynamic_threshold'."\n" + .'- 最小值，动态阈值：SYSTEM:field:min:dynamic_threshold'."\n" + .'- 唯一值率动态阈值：SYSTEM:table:table_size:dynamic_threshold'."\n" + .'- 唯一值个数，动态阈值：SYSTEM:table:distinct_count:dynamic_threshold'."\n" + .'- 离散值（分组个数），动态阈值：SYSTEM:field:avg:dynamic_threshold'."\n" + .'- 离散值（状态值），动态阈值：SYSTEM:field:sum:dynamic_threshold'."\n" + .'- 离散值（分组个数），动态阈值：SYSTEM:field:discrete_group_count:dynamic_threshold'."\n" + .'- 离散值（状态值），动态阈值：SYSTEM:field:discrete_value_count:dynamic_threshold', + ], + 'ListDataQualityEvaluationTaskInstances' => [ + 'summary' => '质量监控任务实例列表分页查询。', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '240385', + 'abilityTreeNodes' => [ + 'FEATUREdideGK4B66', + ], + 'autoTest' => true, + ], + 'parameters' => [ + [ + 'name' => 'ProjectId', + 'in' => 'query', + 'schema' => [ + 'description' => 'DataWorks工作空间的ID', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + 'example' => '100', + ], + ], + [ + 'name' => 'DataQualityEvaluationTaskId', + 'in' => 'query', + 'schema' => [ + 'description' => '数据质量校验任务ID', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '10000', + ], + ], + [ + 'name' => 'TableGuid', + 'in' => 'query', + 'schema' => [ + 'description' => '表在数据地图中的唯一ID', + 'type' => 'string', + 'required' => false, + 'example' => 'odps.unit_test.tb_unit_test', + ], + ], + [ + 'name' => 'CreateTimeFrom', + 'in' => 'query', + 'schema' => [ + 'description' => '数据质量校验任务实例最早开始时间', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1710239005403', + ], + ], + [ + 'name' => 'CreateTimeTo', + 'in' => 'query', + 'schema' => [ + 'description' => '数据质量校验任务实例最晚开始时间', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1710239005403', + ], + ], + [ + 'name' => 'BizdateFrom', + 'in' => 'query', + 'schema' => [ + 'description' => '质量校验任务业务起始日期', + 'type' => 'string', + 'required' => false, + 'example' => '2024-04-01', + ], + ], + [ + 'name' => 'BizdateTo', + 'in' => 'query', + 'schema' => [ + 'description' => '质量校验任务业务截止日期', + 'type' => 'string', + 'required' => false, + 'example' => '2024-05-01', + ], + ], + [ + 'name' => 'TriggerClientId', + 'in' => 'query', + 'schema' => [ + 'description' => 'TriggerContext中的TriggerClientId', + 'type' => 'string', + 'required' => false, + 'example' => '1001', + ], + ], + [ + 'name' => 'TriggerClient', + 'in' => 'query', + 'schema' => [ + 'description' => 'TriggerContext中的TriggerClient', + 'type' => 'string', + 'required' => false, + 'example' => 'CWF2', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '列表分页查询页大小，默认为10', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'docRequired' => true, + 'maximum' => '200', + 'minimum' => '1', + 'example' => '10', + 'default' => '10', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '列表分页查询页码，默认为1', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'docRequired' => true, + 'example' => '1', + 'default' => '1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'PaginatedModel<DataQualityEvaluationTaskInstance>', + 'description' => '返回值', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '追踪ID，用于跟踪一次完整调用，出现异常时可以根据这个字符串排查异常链路', + 'description' => 'API请求ID', + 'type' => 'string', + 'example' => '691CA452-D37A-4ED****', + ], + 'PagingInfo' => [ + 'description' => '质量校验任务实例分页查询结果', + 'type' => 'object', + 'properties' => [ + 'PageNumber' => [ + 'description' => '页码', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '页大小', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'TotalCount' => [ + 'description' => '总条数', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '294', + ], + 'DataQualityEvaluationTaskInstances' => [ + 'description' => '被触发成功的TaskInstance', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Id' => [ + 'description' => '质检任务实例ID', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10001', + ], + 'CreateTime' => [ + 'description' => '任务实例创建时间', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1710239005403', + ], + 'FinishTime' => [ + 'description' => '任务实例结束时间', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1710239005403', + ], + 'Status' => [ + 'description' => '当前运行状态'."\n" + .'- Running'."\n" + .'- Error'."\n" + .'- Passed'."\n" + .'- Warned'."\n" + .'- Critical', + 'type' => 'string', + 'example' => 'Critical', + ], + 'Parameters' => [ + 'description' => '实际运行时，使用的参数设置', + 'type' => 'string', + 'example' => '{'."\n" + .' "bizdate": "20240517",'."\n" + .' "triggerTime": "1710239005403"'."\n" + .'}', + ], + 'TriggerContext' => [ + 'description' => '实例触发时的上下文信息', + 'type' => 'string', + 'example' => '{'."\n" + .' "TriggerClientId": 10001,'."\n" + .' "TriggerClient": "CWF2"'."\n" + .'}', + ], + 'ProjectId' => [ + 'description' => 'DataWorks项目空间ID', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '100', + ], + 'Task' => [ + 'description' => '校验开始时，数据质量校验任务的快照', + 'type' => 'object', + 'properties' => [ + 'Id' => [ + 'title' => '资源一级ID', + 'description' => '数据质量校验任务ID', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10001', + ], + 'Description' => [ + 'title' => '质量监控任务描述', + 'description' => '质量监控任务描述', + 'type' => 'string', + 'example' => 'This is a daily run data quality evaluation plan.', + ], + 'ProjectId' => [ + 'title' => '项目空间Id', + 'description' => '项目空间Id', + 'type' => 'integer', + 'format' => 'int64', + 'deprecated' => false, + 'example' => '100', + ], + 'Target' => [ + 'title' => '参看 DataQualityTarget示例 数据质量校验任务的监控对象，参考 DataQualityTarget', + 'description' => '数据质量校验任务的监控对象', + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'title' => '监控对象类型', + 'description' => '监控对象类型'."\n" + .'- Table', + 'type' => 'string', + 'example' => 'Table', + ], + 'DatabaseType' => [ + 'title' => '表所属的数据库类型', + 'description' => '表类型的数据集，表所属的数据库类型'."\n" + .'- maxcompute'."\n" + .'- emr'."\n" + .'- cdh'."\n" + .'- hologres'."\n" + .'- analyticdb_for_postgresql'."\n" + .'- analyticdb_for_mysql'."\n" + .'- starrocks', + 'type' => 'string', + 'example' => 'maxcompute', + ], + 'TableGuid' => [ + 'title' => '表在数据地图中的唯一ID', + 'description' => '表在数据地图中的唯一ID', + 'type' => 'string', + 'example' => 'odps.unit_test.tb_unit_test', + ], + 'PartitionSpec' => [ + 'title' => '分区表的分区设置', + 'description' => '分区表的分区设置', + 'type' => 'string', + 'example' => 'ds=$[yyyymmdd-1]', + ], + ], + ], + 'Trigger' => [ + 'title' => '数据质量校验任务的触发配置', + 'description' => '数据质量校验任务的触发配置', + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'title' => '质量监控任务触发类型', + 'description' => '何种事件可以触发质量校验任务执行'."\n" + .'- ByScheduledTaskInstance：调度实例运行成功', + 'type' => 'string', + 'example' => 'ByScheduledTaskInstance', + ], + 'TaskIds' => [ + 'title' => '调度任务Ids', + 'description' => '调度任务节点IDs', + 'type' => 'array', + 'items' => [ + 'description' => '调度任务节点ID', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10000', + ], + ], + ], + ], + 'RuntimeConf' => [ + 'title' => '扩展配置', + 'description' => '使用数据源时的一些设置，目前只支持指定EMR的yarn队列、采集EMR表时SQL引擎指定为SPARK_SQL|KYUUBI|PRESTO_SQL|HIVE_SQL', + 'type' => 'string', + 'example' => '{ "queue": "default", "sqlEngine": "SPARK_SQL" }', + ], + 'Hooks' => [ + 'title' => '回调设置', + 'description' => '数据质量校验任务实例生命周期中的回调设置，目前只支持一个阻塞调度任务的Hook', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'title' => 'Hook类型', + 'description' => '后续处理动作类型'."\n" + .'- BlockTaskInstance：阻塞DataWorks任务实例执行', + 'type' => 'string', + 'example' => 'BlockTaskInstance', + ], + 'Condition' => [ + 'title' => 'Hook触发条件', + 'description' => 'Hook触发条件', + 'type' => 'string', + 'example' => '${severity} == "High" AND ${status} == "Critical"', + ], + ], + 'description' => 'Hook', + ], + ], + 'Notifications' => [ + 'title' => '通知订阅配置', + 'description' => '通知订阅配置', + 'type' => 'object', + 'properties' => [ + 'Condition' => [ + 'title' => '通知触发条件', + 'description' => '通知触发条件', + 'type' => 'string', + 'example' => '${severity} == "High"', + ], + 'Notifications' => [ + 'title' => '通知设置', + 'description' => '通知设置', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'NofiticationReceivers' => [ + 'title' => '告警接收人设置', + 'description' => '告警接收人设置', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ReceiverType' => [ + 'title' => '告警接收人类型', + 'description' => '告警接收人类型'."\n" + .'- AliUid - 阿里云账号Uid'."\n" + .'- WebhookUrl - 自定义 webhook URL'."\n" + .'- DingdingUrl - 钉钉机器人Url'."\n" + .'- FeishuUrl - 飞书机器人Url'."\n" + .'- WeixinUrl - 企微机器人Url', + 'type' => 'string', + 'example' => 'AliUid', + ], + 'Extension' => [ + 'title' => '扩展信息', + 'description' => '扩展信息，格式为 json，例如钉钉机器人支持 at 所有人', + 'type' => 'string', + 'example' => '{"atAll":"true"}', + ], + 'ReceiverValues' => [ + 'title' => '告警接收人', + 'description' => '告警接收人', + 'type' => 'array', + 'items' => [ + 'description' => '告警接收人具体值', + 'type' => 'string', + 'example' => '10000001', + ], + ], + ], + 'description' => '告警接收人设置', + ], + ], + 'NotificationChannels' => [ + 'title' => '通知方式', + 'description' => '告警方式', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Channels' => [ + 'title' => '通知方式', + 'description' => '告警方式', + 'type' => 'array', + 'items' => [ + 'description' => '- Mail - 邮件'."\n" + .'- Sms - 短信'."\n" + .'- Phone - 电话'."\n" + .'- Feishu - 飞书'."\n" + .'- Weixin - 微信'."\n" + .'- Dingding - 钉钉'."\n" + .'- Webhook - 自定义Webhook', + 'type' => 'string', + 'example' => 'Mail', + ], + ], + ], + 'description' => '通知方式', + ], + 'deprecated' => false, + ], + ], + 'description' => '通知设置', + ], + ], + ], + ], + 'Name' => [ + 'title' => '质量监控任务名称', + 'description' => '质量监控任务名称', + 'type' => 'string', + 'deprecated' => false, + 'required' => true, + 'example' => 'Quality verification task', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"691CA452-D37A-4ED****\\",\\n \\"PagingInfo\\": {\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 294,\\n \\"DataQualityEvaluationTaskInstances\\": [\\n {\\n \\"Id\\": 10001,\\n \\"CreateTime\\": 1710239005403,\\n \\"FinishTime\\": 1710239005403,\\n \\"Status\\": \\"Critical\\",\\n \\"Parameters\\": \\"{\\\\n \\\\\\"bizdate\\\\\\": \\\\\\"20240517\\\\\\",\\\\n \\\\\\"triggerTime\\\\\\": \\\\\\"1710239005403\\\\\\"\\\\n}\\",\\n \\"TriggerContext\\": \\"{\\\\n \\\\\\"TriggerClientId\\\\\\": 10001,\\\\n \\\\\\"TriggerClient\\\\\\": \\\\\\"CWF2\\\\\\"\\\\n}\\",\\n \\"ProjectId\\": 100,\\n \\"Task\\": {\\n \\"Id\\": 10001,\\n \\"Description\\": \\"This is a daily run data quality evaluation plan.\\",\\n \\"ProjectId\\": 100,\\n \\"Target\\": {\\n \\"Type\\": \\"Table\\",\\n \\"DatabaseType\\": \\"maxcompute\\",\\n \\"TableGuid\\": \\"odps.unit_test.tb_unit_test\\",\\n \\"PartitionSpec\\": \\"ds=$[yyyymmdd-1]\\"\\n },\\n \\"Trigger\\": {\\n \\"Type\\": \\"ByScheduledTaskInstance\\",\\n \\"TaskIds\\": [\\n 10000\\n ]\\n },\\n \\"RuntimeConf\\": \\"{ \\\\\\"queue\\\\\\": \\\\\\"default\\\\\\", \\\\\\"sqlEngine\\\\\\": \\\\\\"SPARK_SQL\\\\\\" }\\",\\n \\"Hooks\\": [\\n {\\n \\"Type\\": \\"BlockTaskInstance\\",\\n \\"Condition\\": \\"${severity} == \\\\\\"High\\\\\\" AND ${status} == \\\\\\"Critical\\\\\\"\\"\\n }\\n ],\\n \\"Notifications\\": {\\n \\"Condition\\": \\"${severity} == \\\\\\"High\\\\\\"\\",\\n \\"Notifications\\": [\\n {\\n \\"NofiticationReceivers\\": [\\n {\\n \\"ReceiverType\\": \\"AliUid\\",\\n \\"Extension\\": \\"{\\\\\\"atAll\\\\\\":\\\\\\"true\\\\\\"}\\",\\n \\"ReceiverValues\\": [\\n \\"10000001\\"\\n ]\\n }\\n ],\\n \\"NotificationChannels\\": [\\n {\\n \\"Channels\\": [\\n \\"Mail\\"\\n ]\\n }\\n ]\\n }\\n ]\\n },\\n \\"Name\\": \\"Quality verification task\\"\\n }\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => '查询质量监控任务实例列表', + 'description' => '需要购买DataWorks基础版及以上版本才能使用', + ], + 'ListDataQualityResults' => [ + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '240397', + 'abilityTreeNodes' => [ + 'FEATUREdideGK4B66', + ], + 'autoTest' => true, + ], + 'parameters' => [ + [ + 'name' => 'ProjectId', + 'in' => 'query', + 'schema' => [ + 'description' => 'DataWorks工作空间ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + 'example' => '100', + ], + ], + [ + 'name' => 'DataQualityRuleId', + 'in' => 'query', + 'schema' => [ + 'description' => '数据质量规则ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '100001', + ], + ], + [ + 'name' => 'DataQualityEvaluationTaskId', + 'in' => 'query', + 'schema' => [ + 'description' => '数据质量校验任务ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '200001', + ], + ], + [ + 'name' => 'DataQualityEvaluationTaskInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '数据质量校验任务实例ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '10001', + ], + ], + [ + 'name' => 'CreateTimeFrom', + 'in' => 'query', + 'schema' => [ + 'description' => '数据质量校验结果最早生成时间。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1710239005403', + ], + ], + [ + 'name' => 'CreateTimeTo', + 'in' => 'query', + 'schema' => [ + 'description' => '数据质量校验结果最晚生成时间。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1710239005403', + ], + ], + [ + 'name' => 'BizdateFrom', + 'in' => 'query', + 'schema' => [ + 'description' => '规则实例业务起始日期。', + 'type' => 'string', + 'required' => false, + 'example' => '2024-05-01', + ], + ], + [ + 'name' => 'BizdateTo', + 'in' => 'query', + 'schema' => [ + 'description' => '规则实例业务截止日期。', + 'type' => 'string', + 'required' => false, + 'example' => '2024-05-04', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '列表分页查询页大小，默认为10。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'docRequired' => true, + 'maximum' => '200', + 'minimum' => '1', + 'example' => '10', + 'default' => '10', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '列表分页查询页码，默认为1。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'docRequired' => true, + 'example' => '1', + 'default' => '1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'PaginatedModel<DataQualityResult>', + 'description' => '返回值。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '追踪ID，用于跟踪一次完整调用，出现异常时可以根据这个字符串排查异常链路', + 'description' => 'API请求ID。', + 'type' => 'string', + 'example' => '691CA452-D37A-****', + ], + 'PagingInfo' => [ + 'description' => '数据质量校验结果分页查询结果。', + 'type' => 'object', + 'properties' => [ + 'PageNumber' => [ + 'description' => '页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '页大小。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'TotalCount' => [ + 'description' => '总条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '219', + ], + 'DataQualityResults' => [ + 'description' => '质量校验结果列表。', + 'type' => 'array', + 'items' => [ + 'description' => '质量校验结果。', + 'type' => 'object', + 'properties' => [ + 'Id' => [ + 'description' => '校验结果ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '16033', + ], + 'Status' => [ + 'description' => '校验结果状态：'."\n" + .'- Running'."\n" + .'- Error'."\n" + .'- Passed'."\n" + .'- Warned'."\n" + .'- Critical', + 'type' => 'string', + 'example' => 'Passed', + ], + 'CreateTime' => [ + 'description' => '校验结果生成时间。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1708284916414', + ], + 'TaskInstanceId' => [ + 'description' => '校验任务实例ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '200001', + ], + 'Sample' => [ + 'description' => '本次校验所使用的样本值。', + 'type' => 'string', + 'example' => '['."\n" + .' {'."\n" + .' "gender": "male",'."\n" + .' "_count": 100'."\n" + .' }, {'."\n" + .' "gender": "female",'."\n" + .' "_count": 100'."\n" + .' }'."\n" + .']', + ], + 'Details' => [ + 'description' => '本次校验的详情。', + 'type' => 'array', + 'items' => [ + 'description' => '校验详情。', + 'type' => 'object', + 'properties' => [ + 'ReferencedValue' => [ + 'description' => '使用引用的样本，用来参与CheckedValue计算的基准值。', + 'type' => 'string', + 'example' => '0.0', + ], + 'CheckedValue' => [ + 'description' => '最终用来与阈值比较的值。', + 'type' => 'string', + 'example' => '100.0', + ], + 'Status' => [ + 'description' => '最终的比较结果状态：'."\n" + .'- Error'."\n" + .'- Passed'."\n" + .'- Warned'."\n" + .'- Critical', + 'type' => 'string', + 'example' => 'Passed', + ], + ], + ], + ], + 'Rule' => [ + 'description' => '校验开始时，规则配置快照。', + 'type' => 'object', + 'properties' => [ + 'Id' => [ + 'description' => '规则ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '100001', + ], + 'Name' => [ + 'description' => '规则名称，数字、英文字母、汉字、半角全角标点符号组合，最长255个字符。', + 'type' => 'string', + 'example' => 'The table cannot be empty.', + ], + 'ProjectId' => [ + 'description' => 'DataWorks项目空间ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '100', + ], + 'Enabled' => [ + 'description' => '规则是否启用。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Severity' => [ + 'description' => '规则对于业务的等级（对应页面上的强弱规则）：'."\n" + .'- High'."\n" + .'- Normal', + 'type' => 'string', + 'example' => 'Normal', + ], + 'Description' => [ + 'description' => '规则描述信息，最长500个字符。', + 'type' => 'string', + 'example' => 'this is a odps _sql task', + ], + 'TemplateCode' => [ + 'description' => '创建规则时所引用的规则模板Code。', + 'type' => 'string', + 'example' => 'SYSTEM:user_defined_sql', + ], + 'Target' => [ + 'description' => '规则所监控的对象。', + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'description' => '监控对象类型：'."\n" + .'- Table', + 'type' => 'string', + 'example' => 'Table', + ], + 'DatabaseType' => [ + 'description' => '表类型的数据集，表所属的数据库类型：'."\n" + .'- maxcompute'."\n" + .'- emr'."\n" + .'- cdh'."\n" + .'- hologres'."\n" + .'- analyticdb_for_postgresql'."\n" + .'- analyticdb_for_mysql'."\n" + .'- starrocks', + 'type' => 'string', + 'example' => 'maxcompute', + ], + 'TableGuid' => [ + 'description' => '表在数据地图中的唯一ID。', + 'type' => 'string', + 'example' => 'odps.unit_test.tb_unit_test', + ], + ], + ], + 'SamplingConfig' => [ + 'description' => '样本采集所需的设置。', + 'type' => 'object', + 'properties' => [ + 'Metric' => [ + 'description' => '采样的指标名称：'."\n" + .'- Count：表行数'."\n" + .'- Min：字段最小值'."\n" + .'- Max：字段最大值'."\n" + .'- Avg：字段均值'."\n" + .'- DistinctCount：字段唯一值个数'."\n" + .'- DistinctPercent：字段唯一值个数与数据行数占比'."\n" + .'- DuplicatedCount：字段重复值个数'."\n" + .'- DuplicatedPercent：字段重复值个数与数据行数占比'."\n" + .'- TableSize：表大小'."\n" + .'- NullValueCount：字段为空的行数'."\n" + .'- NullValuePercent：字段为空的比例'."\n" + .'- GroupCount：按字段值聚合后每个值与对应的数据行数'."\n" + .'- CountNotIn：枚举值不匹配行数'."\n" + .'- CountDistinctNotIn：枚举值不匹配唯一值个数'."\n" + .'- UserDefinedSql：通过自定义SQL做样本采集', + 'type' => 'string', + 'example' => 'Count', + ], + 'MetricParameters' => [ + 'description' => '样本采集时，所需的参数。', + 'type' => 'string', + 'example' => '{ "columns": [ "id", "name" ] }', + ], + 'SettingConfig' => [ + 'description' => '具体执行采样语句前，插入执行的一些运行时参数设置语句，最长1000个字符。目前只支持MaxCompute。', + 'type' => 'string', + 'example' => 'SET odps.sql.udf.timeout=600s; ', + ], + 'SamplingFilter' => [ + 'description' => '采样时，对不关注的数据进行二次过滤的条件，最多16777215个字符。', + 'type' => 'string', + 'example' => 'id IS NULL', + ], + ], + ], + 'CheckingConfig' => [ + 'description' => '样本校验设置。', + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'description' => '阈值计算方式：'."\n" + .'- Fixed'."\n" + .'- Fluctation'."\n" + .'- FluctationDiscreate'."\n" + .'- Auto'."\n" + .'- Average'."\n" + .'- Variance', + 'type' => 'string', + 'example' => 'Fixed', + ], + 'ReferencedSamplesFilter' => [ + 'description' => '有些类型的阈值需要查询出一些参考样本，然后对参考样本的值进行汇总得出进行比较的阈值，这里使用一个表达式来表示参考样本的查询方式。', + 'type' => 'string', + 'example' => '{ "bizdate": [ "-1", "-7", "-1m" ] }', + ], + 'Thresholds' => [ + 'description' => '阈值设置。', + 'type' => 'object', + 'properties' => [ + 'Expected' => [ + 'description' => '期望的阈值设置。', + 'type' => 'object', + 'properties' => [ + 'Value' => [ + 'description' => '阈值数值。', + 'type' => 'string', + 'example' => '100.0', + ], + 'Operator' => [ + 'description' => '比较符：'."\n" + .'- \\>'."\n" + .'- \\>='."\n" + .'- \\<'."\n" + .'- \\<='."\n" + .'- !='."\n" + .'- =', + 'type' => 'string', + 'example' => '>', + ], + 'Expression' => [ + 'description' => '阈值表达式。'."\n" + ."\n" + .'波动率类型规则必须使用表达式方式表示波动阈值。如：'."\n" + ."\n" + .'- 波动上升大于0.01： $checkValue > 0.01 '."\n" + .'- 波动下降大于0.01：$checkValue < -0.01 '."\n" + .'- 波动率绝对值：abs($checkValue) > 0.01'."\n" + ."\n" + .'固定值类型规则也可以使用表达式方式配置阈值，如果同时配置，表达式优先级高于Operator和Value。', + 'type' => 'string', + 'example' => '$checkValue > 0.01', + ], + ], + ], + 'Warned' => [ + 'description' => '普通警告的阈值设置。', + 'type' => 'object', + 'properties' => [ + 'Value' => [ + 'description' => '阈值数值。', + 'type' => 'string', + 'example' => '100.0', + ], + 'Operator' => [ + 'description' => '比较符：'."\n" + .'- \\>'."\n" + .'- \\>='."\n" + .'- \\<'."\n" + .'- \\<='."\n" + .'- !='."\n" + .'- =', + 'type' => 'string', + 'example' => '>', + ], + 'Expression' => [ + 'description' => '阈值表达式。'."\n" + ."\n" + .'波动率类型规则必须使用表达式方式表示波动阈值。如：'."\n" + ."\n" + .'- 波动上升大于0.01： $checkValue > 0.01 '."\n" + .'- 波动下降大于0.01：$checkValue < -0.01 '."\n" + .'- 波动率绝对值：abs($checkValue) > 0.01'."\n" + ."\n" + .'固定值类型规则也可以使用表达式方式配置阈值，如果同时配置，表达式优先级高于Operator和Value。', + 'type' => 'string', + 'example' => ' $checkValue > 0.01', + ], + ], + ], + 'Critical' => [ + 'description' => '严重警告的阈值设置。', + 'type' => 'object', + 'properties' => [ + 'Value' => [ + 'description' => '阈值数值。', + 'type' => 'string', + 'example' => '100.0', + ], + 'Operator' => [ + 'description' => '比较符：'."\n" + .'- \\>'."\n" + .'- \\>='."\n" + .'- \\<'."\n" + .'- \\<='."\n" + .'- !='."\n" + .'- =', + 'type' => 'string', + 'example' => '>', + ], + 'Expression' => [ + 'description' => '阈值表达式。'."\n" + ."\n" + .'波动率类型规则必须使用表达式方式表示波动阈值。如：'."\n" + ."\n" + .'- 波动上升大于0.01： $checkValue > 0.01 '."\n" + .'- 波动下降大于0.01：$checkValue < -0.01 '."\n" + .'- 波动率绝对值：abs($checkValue) > 0.01'."\n" + ."\n" + .'固定值类型规则也可以使用表达式方式配置阈值，如果同时配置，表达式优先级高于Operator和Value。', + 'type' => 'string', + 'example' => ' $checkValue > 0.01', + ], + ], + ], + ], + ], + ], + ], + 'ErrorHandlers' => [ + 'description' => '质量规则校验问题处理器。', + 'type' => 'array', + 'items' => [ + 'description' => '质量规则校验问题处理器。', + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'description' => '处理器类型。'."\n" + .'- SaveErrorData', + 'type' => 'string', + 'example' => 'SaveErrorData'."\n", + ], + 'ErrorDataFilter' => [ + 'description' => '如果是自定义SQL规则，需要用户指定SQL来过滤问题数据。', + 'type' => 'string', + 'example' => 'SELECT * FROM tb_api_log WHERE id IS NULL', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"691CA452-D37A-****\\",\\n \\"PagingInfo\\": {\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 219,\\n \\"DataQualityResults\\": [\\n {\\n \\"Id\\": 16033,\\n \\"Status\\": \\"Passed\\",\\n \\"CreateTime\\": 1708284916414,\\n \\"TaskInstanceId\\": 200001,\\n \\"Sample\\": \\"[\\\\n {\\\\n \\\\\\"gender\\\\\\": \\\\\\"male\\\\\\",\\\\n \\\\\\"_count\\\\\\": 100\\\\n }, {\\\\n \\\\\\"gender\\\\\\": \\\\\\"female\\\\\\",\\\\n \\\\\\"_count\\\\\\": 100\\\\n }\\\\n]\\",\\n \\"Details\\": [\\n {\\n \\"ReferencedValue\\": \\"0.0\\",\\n \\"CheckedValue\\": \\"100.0\\",\\n \\"Status\\": \\"Passed\\"\\n }\\n ],\\n \\"Rule\\": {\\n \\"Id\\": 100001,\\n \\"Name\\": \\"The table cannot be empty.\\",\\n \\"ProjectId\\": 100,\\n \\"Enabled\\": true,\\n \\"Severity\\": \\"Normal\\",\\n \\"Description\\": \\"this is a odps _sql task\\",\\n \\"TemplateCode\\": \\"SYSTEM:user_defined_sql\\",\\n \\"Target\\": {\\n \\"Type\\": \\"Table\\",\\n \\"DatabaseType\\": \\"maxcompute\\",\\n \\"TableGuid\\": \\"odps.unit_test.tb_unit_test\\"\\n },\\n \\"SamplingConfig\\": {\\n \\"Metric\\": \\"Count\\",\\n \\"MetricParameters\\": \\"{ \\\\\\"columns\\\\\\": [ \\\\\\"id\\\\\\", \\\\\\"name\\\\\\" ] }\\",\\n \\"SettingConfig\\": \\"SET odps.sql.udf.timeout=600s; \\",\\n \\"SamplingFilter\\": \\"id IS NULL\\"\\n },\\n \\"CheckingConfig\\": {\\n \\"Type\\": \\"Fixed\\",\\n \\"ReferencedSamplesFilter\\": \\"{ \\\\\\"bizdate\\\\\\": [ \\\\\\"-1\\\\\\", \\\\\\"-7\\\\\\", \\\\\\"-1m\\\\\\" ] }\\",\\n \\"Thresholds\\": {\\n \\"Expected\\": {\\n \\"Value\\": \\"100.0\\",\\n \\"Operator\\": \\">\\",\\n \\"Expression\\": \\"$checkValue > 0.01\\"\\n },\\n \\"Warned\\": {\\n \\"Value\\": \\"100.0\\",\\n \\"Operator\\": \\">\\",\\n \\"Expression\\": \\" $checkValue > 0.01\\"\\n },\\n \\"Critical\\": {\\n \\"Value\\": \\"100.0\\",\\n \\"Operator\\": \\">\\",\\n \\"Expression\\": \\" $checkValue > 0.01\\"\\n }\\n }\\n },\\n \\"ErrorHandlers\\": [\\n {\\n \\"Type\\": \\"SaveErrorData\\\\n\\",\\n \\"ErrorDataFilter\\": \\"SELECT * FROM tb_api_log WHERE id IS NULL\\"\\n }\\n ]\\n }\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => '查询质量结果列表', + 'summary' => '质量结果列表分页查询。', + 'description' => '需要购买DataWorks基础版及以上版本才能使用', + ], + 'DetachDataQualityRulesFromEvaluationTask' => [ + 'summary' => '取消数据质量规则和数据质量校验任务的关联。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '250890', + 'abilityTreeNodes' => [ + 'FEATUREdide3WJOKE', + ], + ], + 'parameters' => [ + [ + 'name' => 'ProjectId', + 'in' => 'formData', + 'schema' => [ + 'description' => 'DataWorks工作空间的ID。您可以登录[DataWorks控制台](https://workbench.data.aliyun.com/console)，进入工作空间配置页面获取工作空间ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + 'example' => '10002', + ], + ], + [ + 'name' => 'DataQualityEvaluationTaskId', + 'in' => 'formData', + 'schema' => [ + 'description' => '关联的质量校验任务ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + 'example' => '10000', + ], + ], + [ + 'name' => 'DataQualityRuleIds', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'description' => '数据质量规则ID列表。', + 'type' => 'array', + 'items' => [ + 'description' => '数据质量规则ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + 'example' => '200001', + ], + 'required' => true, + 'docRequired' => true, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request', + 'type' => 'string', + 'example' => '8abcb91f-d266-4073-b907-2ed6****', + ], + 'Success' => [ + 'description' => '调用是否成功。取值如下：'."\n" + .'- true：调用成功。'."\n" + .'- false：调用失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"8abcb91f-d266-4073-b907-2ed6****\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => '取消数据质量规则与监控的关联关系', + 'description' => '需要购买 DataWorks 基础版及以上版本才能使用。', + ], + 'DeleteDataQualityEvaluationTask' => [ + 'summary' => '删除数据质量校验任务。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '250885', + 'abilityTreeNodes' => [ + 'FEATUREdide3WJOKE', + ], + ], + 'parameters' => [ + [ + 'name' => 'Id', + 'in' => 'query', + 'schema' => [ + 'description' => '数据质量监控ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'docRequired' => true, + 'example' => '123123', + ], + ], + [ + 'name' => 'ProjectId', + 'in' => 'query', + 'schema' => [ + 'description' => 'DataWorks工作空间的ID。您可以登录[DataWorks控制台](https://workbench.data.aliyun.com/console)，进入工作空间管理页面获取ID。'."\n" + ."\n" + .'该参数用来确定本次API调用操作使用的DataWorks工作空间。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'docRequired' => true, + 'example' => '10000', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request', + 'type' => 'string', + 'example' => '0bc1ec92159376****', + ], + 'Success' => [ + 'description' => '删除是否成功。'."\n" + .'- true：成功'."\n" + .'- false：失败', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'IdempotentParameterMismatch', + 'errorMessage' => 'The request uses the same client token as a previous, but non-identical request. Do not reuse a client token with different requests, unless the requests are identical.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0bc1ec92159376****\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => '删除数据质量监控', + 'description' => '需要购买 DataWorks 基础版及以上版本才能使用。', + ], + 'GetDataQualityEvaluationTaskInstance' => [ + 'summary' => '获取数据质量校验任务实例详情。', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '250220', + 'abilityTreeNodes' => [ + 'FEATUREdideGK4B66', + ], + ], + 'parameters' => [ + [ + 'name' => 'Id', + 'in' => 'query', + 'schema' => [ + 'description' => '数据质量监控实例ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + 'example' => '7227550902', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。用于定位日志，排查问题。', + 'type' => 'string', + 'example' => '8abcb91f-d266-4073-b907-2ed67****', + ], + 'DataQualityEvaluationTaskInstance' => [ + 'description' => '数据质量监控实例详情。', + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => '数据质量监控实例状态。'."\n" + .'- Running：校验中'."\n" + .'- Error：有规则校验出错'."\n" + .'- Passed：所有规则校验通过'."\n" + .'- Warned：有规则触发普通告警阈值'."\n" + .'- Critical：有规则触发严重告警阈值', + 'type' => 'string', + 'example' => 'Passed', + ], + 'Task' => [ + 'description' => '数据质量监控。', + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'description' => '数据质量监控名称。', + 'type' => 'string', + 'example' => 'Data quality OpenAPI monitoring test'."\n", + ], + 'Notifications' => [ + 'description' => '通知设置。', + 'type' => 'object', + 'properties' => [ + 'Condition' => [ + 'description' => '通知触发条件，当满足这个条件时，会触发消息通知。目前只能支持两种条件表达式：'."\n" + ."\n" + .'- 只指定一组规则严重类型和规则校验状态，如`${severity} == "High" AND ${status} == "Critical"`，代表执行的规则中，如果有severity为High的规则校验结果是Critical，则满足条件 '."\n" + .'- 指定多组规则严重类型和规则校验状态，如`(${severity} == "High"AND ${status} == "Critical") OR (${severity} == "Normal" AND ${status} == "Critical") OR (${severity} == "Normal" AND ${status} == "Error")`，代表执行的规则中，如果有severity为High的规则校验结果是Critical、或者severity为Normal的规则校验结果是Critical、或者severity为Normal的规则校验结果是Error，则满足条件，条件表达式中severity的枚举与DataQualityRule中severity的枚举一致、status的枚举与DataQualityResult中的status一致。', + 'type' => 'string', + 'example' => '${severity} == "High" AND ${status} == "Critical"', + ], + 'Notifications' => [ + 'description' => '告警方式。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'NotificationReceivers' => [ + 'description' => '接收方取值。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ReceiverType' => [ + 'description' => '告警接收人类型。', + 'type' => 'string', + 'example' => 'DingdingUrl', + ], + 'Extension' => [ + 'description' => '告警发送时的额外参数设置，json格式，支持的key如下：'."\n" + ."\n" + .'- atAll：发送钉钉告警时，是否需要在群里@所有人。ReceiverType为DingdingUrl时生效。', + 'type' => 'string', + 'example' => '{ "atAll": true }', + ], + 'ReceiverValues' => [ + 'description' => '告警接收人。', + 'type' => 'array', + 'items' => [ + 'description' => '接收方取值。'."\n" + ."\n" + .'- 当接收方类型为阿里云ID时，接收方取值为具体阿里云用户ID。'."\n" + .'- 当接收方类型为DingdingUrl时，接收方取值为具体钉钉机器人的告警地址。'."\n" + .'- 当接收方类型为WeixinUrl时，接收方取值为具体企业微信的告警地址。'."\n" + .'- 当接收方类型为FeishuUrl时，接收方取值为具体飞书的告警地址。'."\n" + .'- 当接收方类型为WebhookUrl时，接收方取值为具体自定义Webhook的告警地址。', + 'type' => 'string', + 'example' => 'https://api.fc.aliyuncs.com/webhook', + ], + ], + ], + ], + ], + 'NotificationChannels' => [ + 'description' => '通知方式。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Channels' => [ + 'description' => '通知方式。', + 'type' => 'array', + 'items' => [ + 'description' => '告警方式'."\n" + ."\n" + .'- Mail - 邮件'."\n" + .'- Sms - 短信'."\n" + .'- Phone - 电话'."\n" + .'- Feishu - 飞书'."\n" + .'- Weixin - 微信'."\n" + .'- Dingding - 钉钉'."\n" + .'- Webhook - 自定义Webhook', + 'type' => 'string', + 'example' => 'Mail', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'Hooks' => [ + 'description' => '回调设置。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'description' => 'Hook类型，目前只支持一种：'."\n" + ."\n" + .'- BlockTaskInstance：阻塞调度任务继续运行，数据质量监控是由调度任务触发的，那么在数据质量监控运行完成之后，会根据Hook.Condition来判断是否阻塞调度任务继续运行。', + 'type' => 'string', + 'example' => 'BlockTaskInstance', + ], + 'Condition' => [ + 'description' => 'Hook触发条件，当满足这个条件时，会触发hook动作。目前只能支持两种条件表达式：'."\n" + ."\n" + .'- 只指定一组规则严重类型和规则校验状态，如`${severity} == "High" AND ${status} == "Critical"`，代表执行的规则中，如果有severity为High的规则校验结果是Critical，则满足条件'."\n" + .'- 指定多组规则严重类型和规则校验状态，如`(${severity} == "High" AND ${status} == "Critical") OR (${severity} == "Normal" AND ${status} == "Critical") OR (${severity} == "Normal" AND ${status} == "Error")`，代表执行的规则中，如果有severity为High的规则校验结果是Critical、或者severity为Normal的规则校验结果是Critical、或者severity为Normal的规则校验结果是Error，则满足条件，条件表达式中severity的枚举与DataQualityRule中severity的枚举一致、status的枚举与DataQualityResult中的status一致。', + 'type' => 'string', + 'example' => '(${severity} == "High" AND ${status} == "Critical") OR (${severity} == "Normal" AND ${status} == "Critical") OR (${severity} == "Normal" AND ${status} == "Error")', + ], + ], + ], + ], + 'RuntimeConf' => [ + 'description' => '扩展配置，JSON格式的字符串，只对EMR类型的数据质量监控生效。'."\n" + ."\n" + .'- queue：执行EMR数据质量校验时，使用的yarn队列，默认为本项目配置的队列'."\n" + .'- sqlEngine：执行EMR的数据校验时，采用的SQL引擎'."\n" + .' - HIVE_SQL'."\n" + .' - SPARK_SQL', + 'type' => 'string', + 'example' => '{ "queue": "default" }', + ], + 'Trigger' => [ + 'description' => '数据质量校验任务的触发配置。', + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'description' => '质量监控触发类型：'."\n" + .'- ByManual：手动触发，默认值'."\n" + .'- ByScheduledTaskInstance：关联调度任务触发', + 'type' => 'string', + 'example' => 'ByScheduledTaskInstance', + ], + 'TaskIds' => [ + 'description' => '调度任务Id列表，在Type为ByScheduledTaskInstance时有效。', + 'type' => 'array', + 'items' => [ + 'description' => '调度任务Id。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '70006236752324', + ], + ], + ], + ], + 'Target' => [ + 'description' => '参看 DataQualityTarget示例，数据质量校验任务的监控对象，参考 DataQualityTarget。', + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'description' => '监控对象类型。'."\n" + .'- Table：表', + 'type' => 'string', + 'example' => 'Table', + ], + 'DatabaseType' => [ + 'description' => '表所属的数据库类型。', + 'type' => 'string', + 'example' => 'maxcompute', + ], + 'TableGuid' => [ + 'description' => '表在数据地图中的唯一ID。', + 'type' => 'string', + 'example' => 'odps.api_trace.ods_d_api_log', + ], + 'PartitionSpec' => [ + 'description' => '监控的分区范围。', + 'type' => 'string', + 'example' => 'pt=$[yyyymmdd-1]', + ], + ], + ], + 'Description' => [ + 'description' => '数据质量监控的描述信息。', + 'type' => 'string', + 'example' => 'OpenAPI quality monitoring test', + ], + 'Id' => [ + 'description' => '数据质量监控ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '28544990', + ], + 'ProjectId' => [ + 'description' => '工作空间的ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '20629', + ], + ], + ], + 'Parameters' => [ + 'description' => '数据质量校验执行参数，JSON格式，可用的key如下：'."\n" + .'- triggerTime：触发时间的毫秒时间戳，数据质量监控的数据范围中$[yyyymmdd]表达式的基准时间，必填。', + 'type' => 'string', + 'example' => '{ "triggerTime": 1733284062000 }'."\n", + ], + 'FinishTime' => [ + 'description' => '实例运行的结束时间。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1716344665000', + ], + 'TriggerContext' => [ + 'description' => '实例触发时的上下文信息，JSON格式。可能包含的key如下：'."\n" + .'- TriggerClient：数据质量监控实例的触发来源，常见的如CWF2（调度系统）等，后续有可能会新增。'."\n" + .'- TriggerClientId：关联到来源系统中某个具体的业务资源。比如TriggerClient为CWF2时，这里记录调度任务ID。', + 'type' => 'string', + 'example' => '{ "triggerClient": "CWF2", "triggerClientId": 70001238945 }', + ], + 'CreateTime' => [ + 'description' => '创建时间。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1716344665000', + ], + 'Id' => [ + 'description' => '数据质量监控实例ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '7234231689', + ], + 'ProjectId' => [ + 'description' => '工作空间的ID。'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '98330', + ], + 'Results' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Id' => [ + 'type' => 'integer', + 'format' => 'int64', + ], + 'Status' => [ + 'type' => 'string', + ], + 'CreateTime' => [ + 'type' => 'integer', + 'format' => 'int64', + ], + 'TaskInstanceId' => [ + 'type' => 'integer', + 'format' => 'int64', + ], + 'Sample' => [ + 'type' => 'string', + ], + 'Details' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ReferencedValue' => [ + 'type' => 'string', + ], + 'CheckedValue' => [ + 'type' => 'string', + ], + 'Status' => [ + 'type' => 'string', + ], + ], + ], + ], + 'Rule' => [ + 'type' => 'object', + 'properties' => [ + 'Id' => [ + 'type' => 'integer', + 'format' => 'int64', + ], + 'Name' => [ + 'type' => 'string', + ], + 'ProjectId' => [ + 'type' => 'integer', + 'format' => 'int64', + ], + 'Enabled' => [ + 'type' => 'boolean', + ], + 'Severity' => [ + 'type' => 'string', + ], + 'Description' => [ + 'type' => 'string', + ], + 'TemplateCode' => [ + 'type' => 'string', + ], + 'Target' => [ + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'type' => 'string', + ], + 'DatabaseType' => [ + 'type' => 'string', + ], + 'TableGuid' => [ + 'type' => 'string', + ], + ], + ], + 'SamplingConfig' => [ + 'type' => 'object', + 'properties' => [ + 'Metric' => [ + 'type' => 'string', + ], + 'MetricParameters' => [ + 'type' => 'string', + ], + 'SettingConfig' => [ + 'type' => 'string', + ], + 'SamplingFilter' => [ + 'type' => 'string', + ], + ], + ], + 'CheckingConfig' => [ + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'type' => 'string', + ], + 'ReferencedSamplesFilter' => [ + 'type' => 'string', + ], + 'Thresholds' => [ + 'type' => 'object', + 'properties' => [ + 'Expected' => [ + 'type' => 'object', + 'properties' => [ + 'Value' => [ + 'type' => 'string', + ], + 'Operator' => [ + 'type' => 'string', + ], + 'Expression' => [ + 'type' => 'string', + ], + ], + ], + 'Warned' => [ + 'type' => 'object', + 'properties' => [ + 'Value' => [ + 'type' => 'string', + ], + 'Operator' => [ + 'type' => 'string', + ], + 'Expression' => [ + 'type' => 'string', + ], + ], + ], + 'Critical' => [ + 'type' => 'object', + 'properties' => [ + 'Value' => [ + 'type' => 'string', + ], + 'Operator' => [ + 'type' => 'string', + ], + 'Expression' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + ], + ], + 'ErrorHandlers' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'type' => 'string', + ], + 'ErrorDataFilter' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"8abcb91f-d266-4073-b907-2ed67****\\",\\n \\"DataQualityEvaluationTaskInstance\\": {\\n \\"Status\\": \\"Passed\\",\\n \\"Task\\": {\\n \\"Name\\": \\"Data quality OpenAPI monitoring test\\\\n\\",\\n \\"Notifications\\": {\\n \\"Condition\\": \\"${severity} == \\\\\\"High\\\\\\" AND ${status} == \\\\\\"Critical\\\\\\"\\",\\n \\"Notifications\\": [\\n {\\n \\"NotificationReceivers\\": [\\n {\\n \\"ReceiverType\\": \\"DingdingUrl\\",\\n \\"Extension\\": \\"{ \\\\\\"atAll\\\\\\": true }\\",\\n \\"ReceiverValues\\": [\\n \\"https://api.fc.aliyuncs.com/webhook\\"\\n ]\\n }\\n ],\\n \\"NotificationChannels\\": [\\n {\\n \\"Channels\\": [\\n \\"Mail\\"\\n ]\\n }\\n ]\\n }\\n ]\\n },\\n \\"Hooks\\": [\\n {\\n \\"Type\\": \\"BlockTaskInstance\\",\\n \\"Condition\\": \\"(${severity} == \\\\\\"High\\\\\\" AND ${status} == \\\\\\"Critical\\\\\\") OR (${severity} == \\\\\\"Normal\\\\\\" AND ${status} == \\\\\\"Critical\\\\\\") OR (${severity} == \\\\\\"Normal\\\\\\" AND ${status} == \\\\\\"Error\\\\\\")\\"\\n }\\n ],\\n \\"RuntimeConf\\": \\"{ \\\\\\"queue\\\\\\": \\\\\\"default\\\\\\" }\\",\\n \\"Trigger\\": {\\n \\"Type\\": \\"ByScheduledTaskInstance\\",\\n \\"TaskIds\\": [\\n 70006236752324\\n ]\\n },\\n \\"Target\\": {\\n \\"Type\\": \\"Table\\",\\n \\"DatabaseType\\": \\"maxcompute\\",\\n \\"TableGuid\\": \\"odps.api_trace.ods_d_api_log\\",\\n \\"PartitionSpec\\": \\"pt=$[yyyymmdd-1]\\"\\n },\\n \\"Description\\": \\"OpenAPI quality monitoring test\\",\\n \\"Id\\": 28544990,\\n \\"ProjectId\\": 20629\\n },\\n \\"Parameters\\": \\"{ \\\\\\"triggerTime\\\\\\": 1733284062000 }\\\\n\\",\\n \\"FinishTime\\": 1716344665000,\\n \\"TriggerContext\\": \\"{ \\\\\\"triggerClient\\\\\\": \\\\\\"CWF2\\\\\\", \\\\\\"triggerClientId\\\\\\": 70001238945 }\\",\\n \\"CreateTime\\": 1716344665000,\\n \\"Id\\": 7234231689,\\n \\"ProjectId\\": 98330,\\n \\"Results\\": [\\n {\\n \\"Id\\": 0,\\n \\"Status\\": \\"\\",\\n \\"CreateTime\\": 0,\\n \\"TaskInstanceId\\": 0,\\n \\"Sample\\": \\"\\",\\n \\"Details\\": [\\n {\\n \\"ReferencedValue\\": \\"\\",\\n \\"CheckedValue\\": \\"\\",\\n \\"Status\\": \\"\\"\\n }\\n ],\\n \\"Rule\\": {\\n \\"Id\\": 0,\\n \\"Name\\": \\"\\",\\n \\"ProjectId\\": 0,\\n \\"Enabled\\": true,\\n \\"Severity\\": \\"\\",\\n \\"Description\\": \\"\\",\\n \\"TemplateCode\\": \\"\\",\\n \\"Target\\": {\\n \\"Type\\": \\"\\",\\n \\"DatabaseType\\": \\"\\",\\n \\"TableGuid\\": \\"\\"\\n },\\n \\"SamplingConfig\\": {\\n \\"Metric\\": \\"\\",\\n \\"MetricParameters\\": \\"\\",\\n \\"SettingConfig\\": \\"\\",\\n \\"SamplingFilter\\": \\"\\"\\n },\\n \\"CheckingConfig\\": {\\n \\"Type\\": \\"\\",\\n \\"ReferencedSamplesFilter\\": \\"\\",\\n \\"Thresholds\\": {\\n \\"Expected\\": {\\n \\"Value\\": \\"\\",\\n \\"Operator\\": \\"\\",\\n \\"Expression\\": \\"\\"\\n },\\n \\"Warned\\": {\\n \\"Value\\": \\"\\",\\n \\"Operator\\": \\"\\",\\n \\"Expression\\": \\"\\"\\n },\\n \\"Critical\\": {\\n \\"Value\\": \\"\\",\\n \\"Operator\\": \\"\\",\\n \\"Expression\\": \\"\\"\\n }\\n }\\n },\\n \\"ErrorHandlers\\": [\\n {\\n \\"Type\\": \\"\\",\\n \\"ErrorDataFilter\\": \\"\\"\\n }\\n ]\\n }\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => '获取数据质量校验任务实例详情', + 'description' => '需要购买 DataWorks 基础版及以上版本才能使用。', + ], + 'GetDataQualityEvaluationTask' => [ + 'summary' => '查询数据质量校验任务详情。', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '250883', + 'abilityTreeNodes' => [ + 'FEATUREdide3WJOKE', + ], + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'Id', + 'in' => 'query', + 'schema' => [ + 'description' => '数据质量监控ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'docRequired' => true, + 'example' => '1006455182', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request', + 'type' => 'string', + 'example' => 'SDFSDFSDF-SDFSDF-SDFDSF-SDFSDF', + ], + 'DataQualityEvaluationTask' => [ + 'description' => '数据质量监控详情。', + 'type' => 'object', + 'properties' => [ + 'Target' => [ + 'title' => '参看 DataQualityTarget示例 数据质量校验任务的监控对象，参考 DataQualityTarget', + 'description' => '数据质量监控对象。', + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'title' => '监控对象类型', + 'description' => '监控对象类型。'."\n" + .'- Table：表。', + 'type' => 'string', + 'example' => 'Table', + ], + 'DatabaseType' => [ + 'title' => '表所属的数据库类型', + 'description' => '表所属的数据库类型：'."\n" + .'- maxcompute'."\n" + .'- hologres'."\n" + .'- cdh'."\n" + .'- analyticdb_for_mysql'."\n" + .'- starrocks'."\n" + .'- emr'."\n" + .'- analyticdb_for_postgresql', + 'type' => 'string', + 'enumValueTitles' => [], + 'example' => 'maxcompute', + ], + 'TableGuid' => [ + 'title' => '表在数据地图中的唯一ID', + 'description' => '表在数据地图中的唯一ID。', + 'type' => 'string', + 'example' => 'odps.meta_open_api_test_sz.test_partition_tbl', + ], + 'PartitionSpec' => [ + 'description' => '数据质量监控分区范围设置。', + 'type' => 'string', + 'example' => 'pt=$[yyyymmdd-1]', + ], + ], + ], + 'Description' => [ + 'title' => '质量监控任务描述', + 'description' => '质量监控任务描述。', + 'type' => 'string', + 'example' => 'The description of the quality monitoring task.', + ], + 'Trigger' => [ + 'title' => '数据质量校验任务的触发配置', + 'description' => '数据质量校验任务的触发配置。', + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'title' => '质量监控任务触发类型', + 'description' => '质量监控触发类型：'."\n" + ."\n" + .'- ByManual：手动触发'."\n" + .'- ByScheduledTaskInstance：调度任务触发'."\n" + .'- ByQualityNode：质量节点触发', + 'type' => 'string', + 'enumValueTitles' => [], + 'example' => 'ByScheduledTaskInstance', + ], + 'TaskIds' => [ + 'title' => '调度任务Ids', + 'description' => '调度任务Id列表，在Type为ByScheduledTaskInstance时有效。', + 'type' => 'array', + 'items' => [ + 'description' => '调度任务Id。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '30001', + ], + ], + ], + ], + 'RuntimeConf' => [ + 'title' => '扩展配置', + 'description' => '扩展配置，JSON格式的字符串，只对EMR类型的数据质量监控生效。'."\n" + ."\n" + .'- queue：执行EMR数据质量校验时，使用的yarn队列，默认为本项目配置的队列'."\n" + .'- sqlEngine：执行EMR的数据校验时，采用的SQL引擎'."\n" + .' + HIVE_SQL'."\n" + .' + SPARK_SQL', + 'type' => 'string', + 'example' => '{ "queue": "default", "sqlEngine": "SPARK_SQL" }'."\n", + ], + 'Id' => [ + 'title' => '资源一级ID', + 'description' => '数据质量监控ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2178', + ], + 'Name' => [ + 'title' => '质量监控任务名称', + 'description' => '质量监控任务名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'OpenAPI create a data quality monitoring test', + ], + 'ProjectId' => [ + 'title' => '项目空间Id', + 'description' => '项目空间Id。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2626', + ], + 'Hooks' => [ + 'title' => '回调设置', + 'description' => '回调设置。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'title' => 'Hook类型', + 'description' => 'Hook类型，目前只支持一种：'."\n" + ."\n" + .'- BlockTaskInstance：阻塞调度任务继续运行，数据质量监控是由调度任务触发的，那么在数据质量监控运行完成之后，会根据Hook.Condition来判断是否阻塞调度任务继续运行。', + 'type' => 'string', + 'enumValueTitles' => [], + 'example' => 'BlockTaskInstance', + ], + 'Condition' => [ + 'title' => 'Hook触发条件', + 'description' => 'Hook触发条件，当满足这个条件时，会触发hook动作。目前只能支持两种条件表达式：'."\n" + ."\n" + .'- 只指定一组规则严重类型和规则校验状态，如`${severity} == "High" AND ${status} == "Critical"`，代表执行的规则中，如果有severity为High的规则校验结果是Critical，则满足条件'."\n" + .'- 指定多组规则严重类型和规则校验状态，如`(${severity} == "High" AND ${status} == "Critical") OR (${severity} == "Normal" AND ${status} == "Critical") OR (${severity} == "Normal" AND ${status} == "Error")`，代表执行的规则中，如果有severity为High的规则校验结果是Critical、或者severity为Normal的规则校验结果是Critical、或者severity为Normal的规则校验结果是Error，则满足条件，条件表达式中severity的枚举与DataQualityRule中severity的枚举一致、status的枚举与DataQualityResult中的status一致。', + 'type' => 'string', + 'example' => '(${severity} == "High" AND ${status} == "Critical") OR (${severity} == "Normal" AND ${status} == "Critical") OR (${severity} == "Normal" AND ${status} == "Error")', + ], + ], + 'description' => 'Hook', + ], + ], + 'Notifications' => [ + 'title' => '通知订阅配置', + 'description' => '通知订阅配置。', + 'type' => 'object', + 'properties' => [ + 'Condition' => [ + 'title' => '通知触发条件', + 'description' => '通知触发条件，当满足这个条件时，会触发消息通知。目前只能支持两种条件表达式：'."\n" + ."\n" + .'- 只指定一组规则严重类型和规则校验状态，如`${severity} == "High" AND ${status} == "Critical"`，代表执行的规则中，如果有severity为High的规则校验结果是Critical，则满足条件 '."\n" + .'- 指定多组规则严重类型和规则校验状态，如`(${severity} == "High"AND ${status} == "Critical") OR (${severity} == "Normal" AND ${status} == "Critical") OR (${severity} == "Normal" AND ${status} == "Error")`，代表执行的规则中，如果有severity为High的规则校验结果是Critical、或者severity为Normal的规则校验结果是Critical、或者severity为Normal的规则校验结果是Error，则满足条件，条件表达式中severity的枚举与DataQualityRule中severity的枚举一致、status的枚举与DataQualityResult中的status一致。', + 'type' => 'string', + 'example' => '(${severity} == "High" AND ${status} == "Critical") OR (${severity} == "Normal" AND ${status} == "Critical") OR (${severity} == "Normal" AND ${status} == "Error")', + ], + 'Notifications' => [ + 'title' => '通知设置', + 'description' => '通知设置。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'NotificationReceivers' => [ + 'title' => '告警接收人设置', + 'description' => '告警接收人设置。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ReceiverType' => [ + 'title' => '告警接收人类型', + 'description' => '告警发送时的额外参数设置，json格式，支持的key如下：'."\n" + ."\n" + .'- atAll：发送钉钉告警时，是否需要在群里@所有人。ReceiverType为DingdingUrl时生效。', + 'type' => 'string', + 'enumValueTitles' => [ + 'WebhookUrl' => '自定义webhook地址', + 'FeishuUrl' => '飞书通知地址', + 'DingdingUrl' => '钉钉群机器人地址', + 'WeixinUrl' => '微信通知地址', + 'AliUid' => '用户ID', + ], + 'example' => 'DingdingUrl', + ], + 'Extension' => [ + 'title' => '扩展信息', + 'description' => '扩展信息。', + 'type' => 'string', + 'example' => '{ "atAll": true }'."\n", + ], + 'ReceiverValues' => [ + 'title' => '告警接收人', + 'description' => '告警接收人。', + 'type' => 'array', + 'items' => [ + 'description' => '接收方取值。'."\n" + ."\n" + .'- 当接收方类型为阿里云ID时，接收方取值为具体阿里云用户ID。'."\n" + .'- 当接收方类型为DingdingUrl时，接收方取值为具体钉钉机器人的告警地址。'."\n" + .'- 当接收方类型为WeixinUrl时，接收方取值为具体企业微信的告警地址。'."\n" + .'- 当接收方类型为FeishuUrl时，接收方取值为具体飞书的告警地址。'."\n" + .'- 当接收方类型为WebhookUrl时，接收方取值为具体自定义Webhook的告警地址。', + 'type' => 'string', + 'example' => 'https://api.fc.aliyuncs.com/webhook'."\n", + ], + ], + ], + 'description' => '告警接收人设置', + ], + ], + 'NotificationChannels' => [ + 'title' => '通知方式', + 'description' => '通知方式。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Channels' => [ + 'title' => '通知方式', + 'description' => '通知方式。', + 'type' => 'array', + 'items' => [ + 'description' => '告警方式'."\n" + ."\n" + .'- Mail - 邮件'."\n" + .'- Sms - 短信'."\n" + .'- Phone - 电话'."\n" + .'- Feishu - 飞书'."\n" + .'- Weixin - 微信'."\n" + .'- Dingding - 钉钉'."\n" + .'- Webhook - 自定义Webhook', + 'type' => 'string', + 'enumValueTitles' => [], + 'example' => 'Mail', + ], + ], + ], + 'description' => '通知方式', + ], + ], + ], + 'description' => '通知设置', + ], + ], + ], + ], + 'DataSourceId' => [ + 'description' => '质量监控任务所使用的数据源ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '45238', + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"SDFSDFSDF-SDFSDF-SDFDSF-SDFSDF\\",\\n \\"DataQualityEvaluationTask\\": {\\n \\"Target\\": {\\n \\"Type\\": \\"Table\\",\\n \\"DatabaseType\\": \\"maxcompute\\",\\n \\"TableGuid\\": \\"odps.meta_open_api_test_sz.test_partition_tbl\\",\\n \\"PartitionSpec\\": \\"pt=$[yyyymmdd-1]\\"\\n },\\n \\"Description\\": \\"The description of the quality monitoring task.\\",\\n \\"Trigger\\": {\\n \\"Type\\": \\"ByScheduledTaskInstance\\",\\n \\"TaskIds\\": [\\n 30001\\n ]\\n },\\n \\"RuntimeConf\\": \\"{ \\\\\\"queue\\\\\\": \\\\\\"default\\\\\\", \\\\\\"sqlEngine\\\\\\": \\\\\\"SPARK_SQL\\\\\\" }\\\\n\\",\\n \\"Id\\": 2178,\\n \\"Name\\": \\"OpenAPI create a data quality monitoring test\\",\\n \\"ProjectId\\": 2626,\\n \\"Hooks\\": [\\n {\\n \\"Type\\": \\"BlockTaskInstance\\",\\n \\"Condition\\": \\"(${severity} == \\\\\\"High\\\\\\" AND ${status} == \\\\\\"Critical\\\\\\") OR (${severity} == \\\\\\"Normal\\\\\\" AND ${status} == \\\\\\"Critical\\\\\\") OR (${severity} == \\\\\\"Normal\\\\\\" AND ${status} == \\\\\\"Error\\\\\\")\\"\\n }\\n ],\\n \\"Notifications\\": {\\n \\"Condition\\": \\"(${severity} == \\\\\\"High\\\\\\" AND ${status} == \\\\\\"Critical\\\\\\") OR (${severity} == \\\\\\"Normal\\\\\\" AND ${status} == \\\\\\"Critical\\\\\\") OR (${severity} == \\\\\\"Normal\\\\\\" AND ${status} == \\\\\\"Error\\\\\\")\\",\\n \\"Notifications\\": [\\n {\\n \\"NotificationReceivers\\": [\\n {\\n \\"ReceiverType\\": \\"DingdingUrl\\",\\n \\"Extension\\": \\"{ \\\\\\"atAll\\\\\\": true }\\\\n\\",\\n \\"ReceiverValues\\": [\\n \\"https://api.fc.aliyuncs.com/webhook\\\\n\\"\\n ]\\n }\\n ],\\n \\"NotificationChannels\\": [\\n {\\n \\"Channels\\": [\\n \\"Mail\\"\\n ]\\n }\\n ]\\n }\\n ]\\n },\\n \\"DataSourceId\\": 45238\\n }\\n}","type":"json"}]', + 'title' => '查询数据质量监控详情', + 'description' => '需要购买 DataWorks 基础版及以上版本才能使用。', + ], + 'AttachDataQualityRulesToEvaluationTask' => [ + 'summary' => '把数据质量规则关联到数据质量校验任务上。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '250888', + 'abilityTreeNodes' => [ + 'FEATUREdide3WJOKE', + ], + ], + 'parameters' => [ + [ + 'name' => 'ProjectId', + 'in' => 'formData', + 'schema' => [ + 'description' => 'DataWorks工作空间的ID。您可以登录[DataWorks控制台](https://workbench.data.aliyun.com/console)，进入工作空间配置页面获取工作空间ID。'."\n" + .'该参数用来确定本次API调用操作使用的DataWorks工作空间。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + 'example' => '100001', + ], + ], + [ + 'name' => 'DataQualityEvaluationTaskId', + 'in' => 'formData', + 'schema' => [ + 'description' => '关联的质量校验任务ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + 'example' => '200001', + ], + ], + [ + 'name' => 'DataQualityRuleIds', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'description' => '数据质量规则ID列表。', + 'type' => 'array', + 'items' => [ + 'description' => '数据质量规则ID列表。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + 'example' => '2000001', + ], + 'required' => true, + 'docRequired' => true, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request', + 'type' => 'string', + 'example' => 'E6F0DBDD-5AD8-4870-A6A0', + ], + 'Success' => [ + 'description' => '关联是否成功，取值如下：'."\n" + .'- true：调用成功。'."\n" + .'- false：调用失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"E6F0DBDD-5AD8-4870-A6A0\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => '关联数据质量规则与数据质量监控', + 'description' => '需要购买 DataWorks 基础版及以上版本才能使用。', + ], + 'UpdateDataQualityEvaluationTask' => [ + 'summary' => '更新数据质量校验任务。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '250886', + 'abilityTreeNodes' => [ + 'FEATUREdide3WJOKE', + ], + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'Target', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'title' => '参看 DataQualityTarget示例 数据质量校验任务的监控对象，参考 DataQualityTarget', + 'description' => '数据质量监控对象', + 'type' => 'object', + 'properties' => [ + 'DatabaseType' => [ + 'title' => '表所属的数据库类型', + 'description' => '表所属的数据库类型'."\n" + .'- maxcompute'."\n" + .'- hologres'."\n" + .'- cdh'."\n" + .'- analyticdb_for_mysql'."\n" + .'- starrocks'."\n" + .'- emr'."\n" + .'- analyticdb_for_postgresql', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [], + 'example' => 'maxcompute', + ], + 'TableGuid' => [ + 'title' => '表在数据地图中的唯一ID', + 'description' => '表在数据地图中的唯一ID', + 'type' => 'string', + 'required' => false, + 'example' => 'odsp.openapi.ods_d_openapi_log', + ], + 'PartitionSpec' => [ + 'title' => '分区表的分区设置', + 'description' => '分区表的分区设置', + 'type' => 'string', + 'required' => false, + 'example' => 'dt=$[yyyymmdd-1]', + 'maxLength' => 255, + ], + ], + 'required' => false, + ], + ], + [ + 'name' => 'Description', + 'in' => 'formData', + 'schema' => [ + 'title' => '质量监控任务描述', + 'description' => '质量监控任务描述', + 'type' => 'string', + 'required' => false, + 'example' => 'OpenAPI data quality monitoring test.', + 'maxLength' => 65535, + ], + ], + [ + 'name' => 'Name', + 'in' => 'formData', + 'schema' => [ + 'title' => '质量监控任务名称', + 'description' => '质量监控任务名称', + 'type' => 'string', + 'required' => false, + 'example' => 'OpenAPI data quality monitoring test.', + 'maxLength' => 255, + ], + ], + [ + 'name' => 'RuntimeConf', + 'in' => 'formData', + 'schema' => [ + 'title' => '扩展配置', + 'description' => '扩展配置，JSON格式的字符串，只对EMR类型的数据质量监控生效。'."\n" + ."\n" + .'- queue：执行EMR数据质量校验时，使用的yarn队列，默认为本项目配置的队列'."\n" + .'- sqlEngine：执行EMR的数据校验时，采用的SQL引擎'."\n" + .' + HIVE_SQL'."\n" + .' + SPARK_SQL', + 'type' => 'string', + 'required' => false, + 'example' => '{ "queue": "default", "sqlEngine": "SPARK_SQL" }', + ], + ], + [ + 'name' => 'Trigger', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'title' => '数据质量校验任务的触发配置', + 'description' => '数据质量校验任务的触发配置', + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'title' => '质量监控任务触发类型', + 'description' => '质量监控触发类型。'."\n" + .'- ByScheduledTaskInstance：关联调度任务触发'."\n" + .'- ByManual：手动触发', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [], + 'example' => 'ByScheduledTaskInstance', + ], + 'TaskIds' => [ + 'title' => '调度任务Ids', + 'description' => '调度任务Id列表，在Type为ByScheduledTaskInstance时有效', + 'type' => 'array', + 'items' => [ + 'description' => '调度任务节点ID', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1004979033', + ], + 'required' => false, + ], + ], + 'required' => false, + ], + ], + [ + 'name' => 'ProjectId', + 'in' => 'formData', + 'schema' => [ + 'title' => '项目空间Id', + 'description' => '项目空间Id', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + 'example' => '10000', + ], + ], + [ + 'name' => 'Hooks', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'title' => '回调设置', + 'description' => '回调设置', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'title' => 'Hook类型', + 'description' => '数据质量校验结束后，执行的Hook动作'."\n" + ."\n" + .'- BlockTaskInstance：阻塞调度任务', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [], + 'example' => 'ByScheduledTaskInstance', + ], + 'Condition' => [ + 'title' => 'Hook触发条件', + 'description' => 'Hook触发条件，当满足这个条件时，会触发hook动作。目前只能支持两种条件表达式：'."\n" + ."\n" + .'- 只指定一组规则严重类型和规则校验状态，如`${severity} == "High" AND ${status} == "Critical"`，代表执行的规则中，如果有severity为High的规则校验结果是Critical，则满足条件。'."\n" + .'- 指定多组规则严重类型和规则校验状态，如`(${severity} == "High" AND ${status} == "Critical") OR (${severity} == "Normal" AND ${status} == "Critical") OR (${severity} == "Normal" AND ${status} == "Error")`，代表执行的规则中，如果有severity为High的规则校验结果是Critical、或者severity为Normal的规则校验结果是Critical、或者severity为Normal的规则校验结果是Error，则满足条件，条件表达式中severity的枚举与DataQualityRule中severity的枚举一致、status的枚举与DataQualityResult中的status一致。', + 'type' => 'string', + 'required' => false, + 'example' => '${severity} == "High" AND ${status} == "Critical"', + ], + ], + 'required' => false, + 'description' => 'Hook', + ], + 'required' => false, + ], + ], + [ + 'name' => 'Notifications', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'title' => '通知订阅配置', + 'description' => '通知订阅配置', + 'type' => 'object', + 'properties' => [ + 'Condition' => [ + 'title' => '通知触发条件', + 'description' => '通知触发条件，当满足这个条件时，会触发消息通知。目前只能支持两种条件表达式：'."\n" + ."\n" + .'- 只指定一组规则严重类型和规则校验状态，如`${severity} == "High" AND ${status} == "Critical"`，代表执行的规则中，如果有severity为High的规则校验结果是Critical，则满足条件'."\n" + .'- 指定多组规则严重类型和规则校验状态，如`(${severity} == "High" AND ${status} == "Critical") OR (${severity} == "Normal" AND ${status} == "Critical") OR (${severity} == "Normal" AND ${status} == "Error")`，代表执行的规则中，如果有severity为High的规则校验结果是Critical、或者severity为Normal的规则校验结果是Critical、或者severity为Normal的规则校验结果是Error，则满足条件，条件表达式中severity的枚举与DataQualityRule中severity的枚举一致、status的枚举与DataQualityResult中的status一致。', + 'type' => 'string', + 'required' => false, + 'example' => '${severity} == "High" AND ${status} == "Critical"', + ], + 'Notifications' => [ + 'title' => '通知设置', + 'description' => '通知设置', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'NotificationReceivers' => [ + 'title' => '告警接收人设置', + 'description' => '告警接收人设置', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ReceiverType' => [ + 'title' => '告警接收人类型', + 'description' => '告警接收人类型', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'WebhookUrl' => '自定义Webhook地址', + 'FeishuUrl' => '飞书通知地址', + 'DingdingUrl' => '钉钉群机器人地址', + 'WeixinUrl' => '微信通知地址', + 'AliUid' => '阿里云用户ID', + ], + 'example' => 'DingdingUrl', + ], + 'Extension' => [ + 'title' => '扩展信息', + 'description' => '告警发送时的额外参数设置，json格式，支持的key如下：'."\n" + ."\n" + .'- atAll：发送钉钉告警时，是否需要在群里@所有人。ReceiverType为DingdingUrl时生效。', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [], + 'example' => '{ "atAll": true }'."\n", + ], + 'ReceiverValues' => [ + 'title' => '告警接收人', + 'description' => '告警接收人', + 'type' => 'array', + 'items' => [ + 'description' => '接收方取值。'."\n" + ."\n" + .'- 当接收方类型为阿里云ID时，接收方取值为具体阿里云用户ID。'."\n" + .'- 当接收方类型为DingdingUrl时，接收方取值为具体钉钉机器人的告警地址。'."\n" + .'- 当接收方类型为WeixinUrl时，接收方取值为具体企业微信的告警地址。'."\n" + .'- 当接收方类型为FeishuUrl时，接收方取值为具体飞书的告警地址。'."\n" + .'- 当接收方类型为WebhookUrl时，接收方取值为具体自定义Webhook的告警地址。', + 'type' => 'string', + 'required' => false, + 'example' => 'https://api.fc.aliyuncs.com/webhook', + 'maxLength' => 255, + ], + 'required' => false, + ], + ], + 'required' => false, + 'description' => '告警接收人设置', + ], + 'required' => false, + ], + 'NotificationChannels' => [ + 'title' => '通知方式', + 'description' => '通知方式', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Channels' => [ + 'title' => '通知方式', + 'description' => '通知方式', + 'type' => 'array', + 'items' => [ + 'description' => '通知方式'."\n" + ."\n" + .'- Dingding：钉钉群机器人'."\n" + .'- Mail：邮件'."\n" + .'- Weixin：微信通知'."\n" + .'- Feishu：飞书通知'."\n" + .'- Phone：电话'."\n" + .'- Sms：短信'."\n" + .'- Webhook：自定义Webhook', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [], + 'example' => 'Mail', + ], + 'required' => false, + ], + ], + 'required' => false, + 'description' => '通知方式', + ], + 'required' => false, + ], + ], + 'required' => false, + 'description' => '通知设置', + ], + 'required' => false, + ], + ], + 'required' => false, + ], + ], + [ + 'name' => 'DataSourceId', + 'in' => 'formData', + 'schema' => [ + 'description' => '数据源ID，您可以调用[ListDataSources](~~211431~~)获取数据源的ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '358750', + ], + ], + [ + 'name' => 'DataQualityRules', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'description' => '数据质量监控关联的数据质量规则列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'description' => '数据质量规则名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'OpenAPI test rules', + 'maxLength' => 255, + ], + 'Enabled' => [ + 'description' => '数据质量规则是否启用。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + 'Severity' => [ + 'description' => '规则对于业务的等级（对应页面上的强弱规则），可选的枚举值：'."\n" + .'- Normal'."\n" + .'- High', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [], + 'example' => 'Normal', + 'enum' => [ + 'High', + 'Normal', + ], + ], + 'Description' => [ + 'description' => '数据质量规则描述信息。', + 'type' => 'string', + 'required' => false, + 'example' => 'OpenAPI test rules', + 'maxLength' => 500, + ], + 'TemplateCode' => [ + 'description' => '规则所引用的规则模板唯一标识。', + 'type' => 'string', + 'required' => false, + 'example' => 'SYSTEM:field:null_value:fixed:0', + ], + 'SamplingConfig' => [ + 'description' => '样本采集时，所需的参数', + 'type' => 'object', + 'properties' => [ + 'Metric' => [ + 'description' => '采样的指标名称'."\n" + .'- Count：表行数'."\n" + .'- Min：字段最小值'."\n" + .'- Max：字段最大值'."\n" + .'- Avg：字段均值'."\n" + .'- DistinctCount：字段唯一值个数'."\n" + .'- DistinctPercent：字段唯一值个数与数据行数占比'."\n" + .'- DuplicatedCount：字段重复值个数'."\n" + .'- DuplicatedPercent：字段重复值个数与数据行数占比'."\n" + .'- TableSize：表大小'."\n" + .'- NullValueCount：字段为空的行数'."\n" + .'- NullValuePercent：字段为空的比例'."\n" + .'- GroupCount：按字段值聚合后每个值与对应的数据行数'."\n" + .'- CountNotIn：枚举值不匹配行数'."\n" + .'- CountDistinctNotIn：枚举值不匹配唯一值个数'."\n" + .'- UserDefinedSql：通过自定义SQL做样本采集', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [], + 'example' => 'CountNotIn', + ], + 'MetricParameters' => [ + 'description' => '样本采集时，所需的参数', + 'type' => 'string', + 'required' => false, + 'example' => '{ "Columns": [ "id", "name" ] , "SQL": "select count(1) from table;"}', + ], + 'SettingConfig' => [ + 'description' => '具体执行采样语句前，插入执行的一些运行时参数设置语句，最长1000个字符。目前只支持MaxCompute', + 'type' => 'string', + 'required' => false, + 'example' => 'odps.sql.type.system.odps2=True,odps.sql.hive.compatible=True', + 'maxLength' => 1000, + ], + 'SamplingFilter' => [ + 'description' => '采样时，对不关注的数据进行二次过滤的条件，最多16777215个字符', + 'type' => 'string', + 'required' => false, + 'example' => 'status != \'Succeeded\''."\n", + ], + ], + 'required' => false, + ], + 'CheckingConfig' => [ + 'description' => '样本校验设置', + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'description' => '阈值计算方式'."\n" + ."\n" + .'- Fluctation：波动范围校验'."\n" + .'- Auto：智能阈值校验'."\n" + .'- FluctationDiscreate：离散值波动范围校验'."\n" + .'- Average：均值波动范围校验'."\n" + .'- Fixed：固定值校验', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [], + 'example' => 'Fixed', + ], + 'ReferencedSamplesFilter' => [ + 'description' => '有些类型的阈值需要查询出一些参考样本，然后对参考样本的值进行汇总得出进行比较的阈值，这里使用一个表达式来表示参考样本的查询方式', + 'type' => 'string', + 'required' => false, + 'example' => '{"bizdate": ["-1"]}'."\n", + ], + 'Thresholds' => [ + 'description' => '校验阈值设置。', + 'type' => 'object', + 'properties' => [ + 'Expected' => [ + 'description' => '期望的阈值设置', + 'type' => 'object', + 'properties' => [ + 'Operator' => [ + 'description' => '比较符'."\n" + .'- \\>'."\n" + .'- \\>='."\n" + .'- <'."\n" + .'- <='."\n" + .'- !='."\n" + .'- =', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [], + 'example' => '=', + ], + 'Value' => [ + 'description' => '阈值数值', + 'type' => 'string', + 'required' => false, + 'example' => '0', + ], + 'Expression' => [ + 'description' => '阈值表达式。'."\n" + ."\n" + .'波动率类型规则必须使用表达式方式表示波动阈值。如：'."\n" + ."\n" + .'- 波动上升大于0.01： $checkValue > 0.01 '."\n" + .'- 波动下降大于0.01：$checkValue < -0.01 '."\n" + .'- 波动率绝对值：abs($checkValue) > 0.01'."\n" + ."\n" + .'固定值类型规则也可以使用表达式方式配置阈值，如果同时配置，表达式优先级高于Operator和Value', + 'type' => 'string', + 'required' => false, + 'example' => '$checkValue > 0.01', + ], + ], + 'required' => false, + ], + 'Warned' => [ + 'description' => '普通警告的阈值设置', + 'type' => 'object', + 'properties' => [ + 'Operator' => [ + 'description' => '比较符'."\n" + .'- \\>'."\n" + .'- \\>='."\n" + .'- \\<'."\n" + .'- \\<='."\n" + .'- !='."\n" + .'- =', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [], + 'example' => '>', + ], + 'Value' => [ + 'description' => '阈值数值', + 'type' => 'string', + 'required' => false, + 'example' => '0.001', + ], + 'Expression' => [ + 'description' => '阈值表达式。'."\n" + ."\n" + .'波动率类型规则必须使用表达式方式表示波动阈值。如：'."\n" + ."\n" + .'- 波动上升大于0.01： $checkValue > 0.01 '."\n" + .'- 波动下降大于0.01：$checkValue < -0.01 '."\n" + .'- 波动率绝对值：abs($checkValue) > 0.01'."\n" + ."\n" + .'固定值类型规则也可以使用表达式方式配置阈值，如果同时配置，表达式优先级高于Operator和Value', + 'type' => 'string', + 'required' => false, + 'example' => '$checkValue > 0.01', + ], + ], + 'required' => false, + ], + 'Critical' => [ + 'description' => '严重警告的阈值设置', + 'type' => 'object', + 'properties' => [ + 'Operator' => [ + 'description' => '比较符'."\n" + .'- \\>'."\n" + .'- \\>='."\n" + .'- <'."\n" + .'- <='."\n" + .'- !='."\n" + .'- =', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [], + 'example' => '>', + ], + 'Value' => [ + 'description' => '阈值数值。', + 'type' => 'string', + 'required' => false, + 'example' => '0.01', + ], + 'Expression' => [ + 'description' => '阈值表达式。'."\n" + ."\n" + .'波动率类型规则必须使用表达式方式表示波动阈值。如：'."\n" + ."\n" + .'- 波动上升大于0.01： $checkValue > 0.01 '."\n" + .'- 波动下降大于0.01：$checkValue < -0.01 '."\n" + .'- 波动率绝对值：abs($checkValue) > 0.01'."\n" + ."\n" + .'固定值类型规则也可以使用表达式方式配置阈值，如果同时配置，表达式优先级高于Operator和Value', + 'type' => 'string', + 'required' => false, + 'example' => '$checkValue > 0.01', + ], + ], + 'required' => false, + ], + ], + 'required' => false, + ], + ], + 'required' => false, + ], + 'ErrorHandlers' => [ + 'description' => '质量规则校验问题处理器', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'description' => '处理器类型：'."\n" + ."\n" + .'- SaveErrorData：保留问题数据', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [], + 'example' => 'SaveErrorData', + ], + 'ErrorDataFilter' => [ + 'description' => '如果是自定义SQL规则，需要用户指定SQL来过滤问题数据。', + 'type' => 'string', + 'required' => false, + 'example' => 'SELECT * FROM ods_d_openapi_log WHERE status = \'Error\'', + ], + ], + 'required' => false, + ], + 'required' => false, + ], + 'Id' => [ + 'description' => '校验规则的ID。您可以调用[ListQualityRules](~~173995~~)接口获取规则ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1022171560', + ], + ], + 'required' => false, + ], + 'required' => false, + ], + ], + [ + 'name' => 'Id', + 'in' => 'formData', + 'schema' => [ + 'description' => '数据质量监控ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + 'example' => '7227061794', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'Success' => [ + 'description' => '请求是否成功。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'RequestId' => [ + 'description' => '请求ID。用于定位日志，排查问题。', + 'type' => 'string', + 'example' => '8abcb91f-d266-4073-b907-2ed670378ed1', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"8abcb91f-d266-4073-b907-2ed670378ed1\\"\\n}","type":"json"}]', + 'title' => '更新数据质量监控', + 'description' => '需要购买DataWorks基础版及以上版本才能使用。', + ], + 'CreateDataQualityEvaluationTaskInstance' => [ + 'summary' => '创建数据质量校验任务实例。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'abilityTreeCode' => '250253', + 'abilityTreeNodes' => [ + 'FEATUREdideGK4B66', + ], + ], + 'parameters' => [ + [ + 'name' => 'DataQualityEvaluationTaskId', + 'in' => 'formData', + 'schema' => [ + 'description' => '数据质量校验任务ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + 'example' => '2000011', + ], + ], + [ + 'name' => 'RuntimeResource', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'description' => '资源组信息，运行非MaxCompute数据质量校验时需要填写。', + 'type' => 'object', + 'properties' => [ + 'ResourceGroupId' => [ + 'description' => '任务运行配置的调度资源组标识符。', + 'type' => 'string', + 'required' => false, + 'example' => '63900680', + ], + 'Cu' => [ + 'description' => '任务运行配置CU消耗，如果使用了Serverless资源组，需要指定这个参数。', + 'type' => 'number', + 'format' => 'double', + 'required' => false, + 'example' => '0.25', + ], + ], + 'required' => false, + ], + ], + [ + 'name' => 'Parameters', + 'in' => 'formData', + 'schema' => [ + 'description' => '数据质量校验执行参数，JSON格式，可用的key如下：'."\n" + .'- triggerTime：触发时间的毫秒时间戳，数据质量监控的数据范围中$[yyyymmdd]表达式的基准时间，必填。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '{ "triggerTime": 1733284062000 }', + ], + ], + [ + 'name' => 'ProjectId', + 'in' => 'formData', + 'schema' => [ + 'description' => 'DataWorks工作空间的ID。您可以登录[DataWorks控制台](https://workbench.data.aliyun.com/console)，进入工作空间管理页面获取ID。'."\n" + ."\n" + .'该参数用来确定本次API调用操作使用的DataWorks工作空间。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + 'example' => '10000', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request', + 'type' => 'string', + 'example' => 'ecb967ec-c137-48****', + ], + 'Id' => [ + 'description' => '数据质量监控实例ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '22130', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'IdempotentParameterMismatch', + 'errorMessage' => 'The request uses the same client token as a previous, but non-identical request. Do not reuse a client token with different requests, unless the requests are identical.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ecb967ec-c137-48****\\",\\n \\"Id\\": 22130\\n}","type":"json"}]', + 'title' => '创建数据质量校验监控实例', + 'description' => '需要购买 DataWorks 基础版及以上版本才能使用。', + ], + 'CreateDataQualityEvaluationTask' => [ + 'summary' => '创建DataWorks数据质量监控。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '248294', + 'abilityTreeNodes' => [ + 'FEATUREdide3WJOKE', + ], + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'Target', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'title' => '参看 DataQualityTarget示例 数据质量校验任务的监控对象，参考 DataQualityTarget', + 'description' => '数据质量监控对象', + 'type' => 'object', + 'properties' => [ + 'DatabaseType' => [ + 'title' => '表所属的数据库类型', + 'description' => '表所属的数据库类型'."\n" + .'- maxcompute'."\n" + .'- hologres'."\n" + .'- cdh'."\n" + .'- analyticdb_for_mysql'."\n" + .'- starrocks'."\n" + .'- emr'."\n" + .'- analyticdb_for_postgresql', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'enumValueTitles' => [], + 'example' => 'maxcompute', + ], + 'TableGuid' => [ + 'title' => '表在数据地图中的唯一ID', + 'description' => '表在数据地图中的唯一ID', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'odps.api_test.ods_openapi_log_d', + ], + 'PartitionSpec' => [ + 'title' => '分区表的分区设置', + 'description' => '分区表的分区设置', + 'type' => 'string', + 'required' => false, + 'example' => 'pt=$[yyyymmdd-1]', + 'maxLength' => 255, + ], + ], + 'required' => true, + 'docRequired' => true, + ], + ], + [ + 'name' => 'Description', + 'in' => 'formData', + 'schema' => [ + 'title' => '质量监控任务描述', + 'description' => '质量监控任务描述', + 'type' => 'string', + 'required' => false, + 'example' => 'OpenAPI create a data quality monitoring test', + 'maxLength' => 65535, + ], + ], + [ + 'name' => 'Name', + 'in' => 'formData', + 'schema' => [ + 'title' => '质量监控任务名称', + 'description' => '质量监控任务名称', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'OpenAPI create a data quality monitoring test'."\n", + 'maxLength' => 255, + ], + ], + [ + 'name' => 'RuntimeConf', + 'in' => 'formData', + 'schema' => [ + 'title' => '扩展配置', + 'description' => '扩展配置，JSON格式的字符串，只对EMR类型的数据质量监控生效。'."\n" + .'- queue：执行EMR数据质量校验时，使用的yarn队列，默认为本项目配置的队列'."\n" + .'- sqlEngine：执行EMR的数据校验时，采用的SQL引擎'."\n" + .' + HIVE_SQL'."\n" + .' + SPARK_SQL', + 'type' => 'string', + 'required' => false, + 'example' => '{ "queue": "default", "sqlEngine": "SPARK_SQL" }', + ], + ], + [ + 'name' => 'Trigger', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'title' => '数据质量校验任务的触发配置', + 'description' => '数据质量校验任务的触发配置', + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'title' => '质量监控任务触发类型', + 'description' => '质量监控触发类型：'."\n" + .'- ByManual：手动触发，默认值'."\n" + .'- ByScheduledTaskInstance：关联调度任务触发', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [], + 'example' => 'ByScheduledTaskInstance', + ], + 'TaskIds' => [ + 'title' => '调度任务Ids', + 'description' => '调度任务Id列表，在Type为ByScheduledTaskInstance时有效', + 'type' => 'array', + 'items' => [ + 'description' => '调度任务Id', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '30001', + ], + 'required' => false, + ], + ], + 'required' => false, + ], + ], + [ + 'name' => 'ProjectId', + 'in' => 'formData', + 'schema' => [ + 'title' => '项目空间Id', + 'description' => 'DataWorks工作空间的ID。您可以登录[DataWorks控制台](https://workbench.data.aliyun.com/console)，进入工作空间管理页面获取ID。'."\n" + ."\n" + .'该参数用来确定本次API调用操作使用的DataWorks工作空间。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + 'example' => '10000', + ], + ], + [ + 'name' => 'Hooks', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'title' => '回调设置', + 'description' => '回调设置', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'title' => 'Hook类型', + 'description' => 'Hook类型，目前只支持一种：'."\n" + .'- BlockTaskInstance：阻塞调度任务继续运行，数据质量监控是由调度任务触发的，那么在数据质量监控运行完成之后，会根据Hook.Condition来判断是否阻塞调度任务继续运行。', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [], + 'example' => 'BlockTaskInstance', + ], + 'Condition' => [ + 'title' => 'Hook触发条件', + 'description' => 'Hook触发条件，当满足这个条件时，会触发hook动作。目前只能支持两种条件表达式：'."\n" + .'1. 只指定一组规则严重类型和规则校验状态，如`${severity} == "High" AND ${status} == "Critical"`，代表执行的规则中，如果有severity为High的规则校验结果是Critical，则满足条件'."\n" + .'2. 指定多组规则严重类型和规则校验状态，如`(${severity} == "High" AND ${status} == "Critical") OR (${severity} == "Normal" AND ${status} == "Critical") OR (${severity} == "Normal" AND ${status} == "Error")`，代表执行的规则中，如果有severity为High的规则校验结果是Critical、或者severity为Normal的规则校验结果是Critical、或者severity为Normal的规则校验结果是Error，则满足条件，条件表达式中severity的枚举与DataQualityRule中severity的枚举一致、status的枚举与DataQualityResult中的status一致。', + 'type' => 'string', + 'required' => false, + 'example' => '(${severity} == "High" AND ${status} == "Critical") OR (${severity} == "Normal" AND ${status} == "Critical") OR (${severity} == "Normal" AND ${status} == "Error")', + ], + ], + 'required' => false, + 'description' => 'Hook', + ], + 'required' => false, + ], + ], + [ + 'name' => 'Notifications', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'title' => '通知订阅配置', + 'description' => '通知订阅配置', + 'type' => 'object', + 'properties' => [ + 'Condition' => [ + 'title' => '通知触发条件', + 'description' => '通知触发条件，当满足这个条件时，会触发消息通知。目前只能支持两种条件表达式：'."\n" + ."\n" + .'只指定一组规则严重类型和规则校验状态，如`${severity} == "High" AND ${status} == "Critical"`，代表执行的规则中，如果有severity为High的规则校验结果是Critical，则满足条件'."\n" + .'指定多组规则严重类型和规则校验状态，如`(${severity} == "High" AND ${status} == "Critical") OR (${severity} == "Normal" AND ${status} == "Critical") OR (${severity} == "Normal" AND ${status} == "Error")`，代表执行的规则中，如果有severity为High的规则校验结果是Critical、或者severity为Normal的规则校验结果是Critical、或者severity为Normal的规则校验结果是Error，则满足条件，条件表达式中severity的枚举与DataQualityRule中severity的枚举一致、status的枚举与DataQualityResult中的status一致。', + 'type' => 'string', + 'required' => false, + 'example' => '(${severity} == "High" AND ${status} == "Critical") OR (${severity} == "Normal" AND ${status} == "Critical") OR (${severity} == "Normal" AND ${status} == "Error")', + ], + 'Notifications' => [ + 'title' => '通知设置', + 'description' => '通知设置', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'NotificationReceivers' => [ + 'title' => '告警接收人设置', + 'description' => '告警接收人设置', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ReceiverType' => [ + 'title' => '告警接收人类型', + 'description' => '告警接收人类型'."\n" + .'- WebhookUrl：自定义webhook地址'."\n" + .'- FeishuUrl：飞书告警地址'."\n" + .'- DingdingUrl：钉钉告警地址'."\n" + .'- WeixinUrl：企业微信告警地址'."\n" + .'- AliUid：阿里云用户ID', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [], + 'example' => 'DingdingUrl', + ], + 'Extension' => [ + 'title' => '扩展信息', + 'description' => '告警发送时的额外参数设置，json格式，支持的key如下：'."\n" + .'- atAll：发送钉钉告警时，是否需要在群里@所有人。ReceiverType为DingdingUrl时生效。', + 'type' => 'string', + 'required' => false, + 'example' => '{ "atAll": true }', + ], + 'ReceiverValues' => [ + 'title' => '告警接收人', + 'description' => '告警接收人', + 'type' => 'array', + 'items' => [ + 'description' => '接收方取值。'."\n" + ."\n" + .'- 当接收方类型为阿里云ID时，接收方取值为具体阿里云用户ID。'."\n" + .'- 当接收方类型为DingdingUrl时，接收方取值为具体钉钉机器人的告警地址。'."\n" + .'- 当接收方类型为WeixinUrl时，接收方取值为具体企业微信的告警地址。'."\n" + .'- 当接收方类型为FeishuUrl时，接收方取值为具体飞书的告警地址。'."\n" + .'- 当接收方类型为WebhookUrl时，接收方取值为具体自定义Webhook的告警地址。', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [], + 'example' => 'https://api.fc.aliyuncs.com/webhook', + 'maxLength' => 255, + ], + 'required' => false, + ], + ], + 'required' => false, + 'description' => '告警接收人设置', + ], + 'required' => false, + ], + 'NotificationChannels' => [ + 'title' => '通知方式', + 'description' => '通知方式', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Channels' => [ + 'title' => '通知方式', + 'description' => '通知方式', + 'type' => 'array', + 'items' => [ + 'description' => '告警方式'."\n" + .'- Mail - 邮件'."\n" + .'- Sms - 短信'."\n" + .'- Phone - 电话'."\n" + .'- Feishu - 飞书'."\n" + .'- Weixin - 微信'."\n" + .'- Dingding - 钉钉'."\n" + .'- Webhook - 自定义Webhook', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [], + 'example' => 'Mail', + ], + 'required' => false, + ], + ], + 'required' => false, + 'description' => '通知方式', + ], + 'required' => false, + ], + ], + 'required' => false, + 'description' => '通知设置', + ], + 'required' => false, + ], + ], + 'required' => false, + ], + ], + [ + 'name' => 'DataSourceId', + 'in' => 'formData', + 'schema' => [ + 'description' => '数据源ID，您可以调用[ListDataSources](~~211431~~)获取数据源的ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + 'example' => '1', + ], + ], + [ + 'name' => 'DataQualityRules', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'description' => '数据质量监控关联的数据质量规则列表。如果设置了DataQualityRule.Id，则把Id对应的规则关联到新建质量监控中；如果没有设置，则用其他字段创建一个新的规则，关联到新建的质量监控中。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'description' => '数据质量规则名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'OpenAPI test rules', + 'default' => '255', + ], + 'Enabled' => [ + 'description' => '质量规则是否启用', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + 'Severity' => [ + 'description' => '规则对于业务的等级（对应页面上的强弱规则），可选的枚举值：'."\n" + .'- Normal'."\n" + .'- High', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [], + 'example' => 'High', + 'enum' => [ + 'High', + 'Normal', + ], + ], + 'Description' => [ + 'description' => '数据质量规则描述。', + 'type' => 'string', + 'required' => false, + 'example' => 'OpenAPI test rules'."\n", + 'maxLength' => 500, + ], + 'TemplateCode' => [ + 'description' => '规则所引用的规则模板唯一标识。', + 'type' => 'string', + 'required' => false, + 'example' => 'SYSTEM:field:null_value:fixed:0', + ], + 'SamplingConfig' => [ + 'description' => '样本采集时，所需的参数。', + 'type' => 'object', + 'properties' => [ + 'Metric' => [ + 'description' => '采样的指标名称'."\n" + .'- Count：表行数'."\n" + .'- Min：字段最小值'."\n" + .'- Max：字段最大值'."\n" + .'- Avg：字段均值'."\n" + .'- DistinctCount：字段唯一值个数'."\n" + .'- DistinctPercent：字段唯一值个数与数据行数占比'."\n" + .'- DuplicatedCount：字段重复值个数'."\n" + .'- DuplicatedPercent：字段重复值个数与数据行数占比'."\n" + .'- TableSize：表大小'."\n" + .'- NullValueCount：字段为空的行数'."\n" + .'- NullValuePercent：字段为空的比例'."\n" + .'- GroupCount：按字段值聚合后每个值与对应的数据行数'."\n" + .'- CountNotIn：枚举值不匹配行数'."\n" + .'- CountDistinctNotIn：枚举值不匹配唯一值个数'."\n" + .'- UserDefinedSql：通过自定义SQL做样本采集', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [], + 'example' => 'NullValueCount', + ], + 'MetricParameters' => [ + 'description' => '样本采集时，所需的参数', + 'type' => 'string', + 'required' => false, + 'example' => '{ "Columns": [ "id", "name" ] , "SQL": "select count(1) from table;"}', + ], + 'SettingConfig' => [ + 'description' => '具体执行采样语句前，插入执行的一些运行时参数设置语句，最长1000个字符。目前只支持MaxCompute', + 'type' => 'string', + 'required' => false, + 'example' => 'odps.sql.type.system.odps2=True,odps.sql.hive.compatible=True', + 'maxLength' => 1000, + ], + 'SamplingFilter' => [ + 'description' => '采样时，对不关注的数据进行二次过滤的条件，最多16777215个字符', + 'type' => 'string', + 'required' => false, + 'example' => 'status != \'Succeeded\'', + ], + ], + 'required' => false, + ], + 'CheckingConfig' => [ + 'description' => '样本校验设置', + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'description' => '阈值计算方式'."\n" + ."\n" + .'- Fixed'."\n" + .'- Fluctation'."\n" + .'- FluctationDiscreate'."\n" + .'- Auto'."\n" + .'- Average', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [], + 'example' => 'Fixed', + ], + 'ReferencedSamplesFilter' => [ + 'description' => '有些类型的阈值需要查询出一些参考样本，然后对参考样本的值进行汇总得出进行比较的阈值，这里使用一个表达式来表示参考样本的查询方式', + 'type' => 'string', + 'required' => false, + 'example' => '{"bizdate": ["-1"]}', + ], + 'Thresholds' => [ + 'description' => '校验阈值设置。', + 'type' => 'object', + 'properties' => [ + 'Expected' => [ + 'description' => '期望的阈值设置', + 'type' => 'object', + 'properties' => [ + 'Operator' => [ + 'description' => '比较符'."\n" + .'- \\>'."\n" + .'- \\>='."\n" + .'- <'."\n" + .'- <='."\n" + .'- !='."\n" + .'- =', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [], + 'example' => '=', + ], + 'Value' => [ + 'description' => '阈值数值。', + 'type' => 'string', + 'required' => false, + 'example' => '0', + ], + 'Expression' => [ + 'description' => '阈值表达式。'."\n" + ."\n" + .'波动率类型规则必须使用表达式方式表示波动阈值。如：'."\n" + ."\n" + .'- 波动上升大于0.01： $checkValue > 0.01 '."\n" + .'- 波动下降大于0.01：$checkValue < -0.01 '."\n" + .'- 波动率绝对值：abs($checkValue) > 0.01'."\n" + ."\n" + .'固定值类型规则也可以使用表达式方式配置阈值，如果同时配置，表达式优先级高于Operator和Value', + 'type' => 'string', + 'required' => false, + 'example' => '$checkValue > 0.01', + ], + ], + 'required' => false, + ], + 'Warned' => [ + 'description' => '普通警告的阈值设置', + 'type' => 'object', + 'properties' => [ + 'Operator' => [ + 'description' => '比较符'."\n" + .'- \\>'."\n" + .'- \\>='."\n" + .'- <'."\n" + .'- <='."\n" + .'- !='."\n" + .'- =', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [], + 'example' => '>', + ], + 'Value' => [ + 'description' => '阈值数值', + 'type' => 'string', + 'required' => false, + 'example' => '0.001', + ], + 'Expression' => [ + 'description' => '阈值表达式。'."\n" + ."\n" + .'波动率类型规则必须使用表达式方式表示波动阈值。如：'."\n" + ."\n" + .'- 波动上升大于0.01： $checkValue > 0.01 '."\n" + .'- 波动下降大于0.01：$checkValue < -0.01 '."\n" + .'- 波动率绝对值：abs($checkValue) > 0.01'."\n" + ."\n" + .'固定值类型规则也可以使用表达式方式配置阈值，如果同时配置，表达式优先级高于Operator和Value', + 'type' => 'string', + 'required' => false, + 'example' => '$checkValue > 0.01', + ], + ], + 'required' => false, + ], + 'Critical' => [ + 'description' => '严重警告的阈值设置', + 'type' => 'object', + 'properties' => [ + 'Operator' => [ + 'description' => '比较符'."\n" + .'- \\>'."\n" + .'- \\>='."\n" + .'- <'."\n" + .'- <='."\n" + .'- !='."\n" + .'- =', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [], + 'example' => '>', + ], + 'Value' => [ + 'description' => '阈值数值', + 'type' => 'string', + 'required' => false, + 'example' => '0.01', + ], + 'Expression' => [ + 'description' => '阈值表达式。'."\n" + ."\n" + .'波动率类型规则必须使用表达式方式表示波动阈值。如：'."\n" + ."\n" + .'- 波动上升大于0.01： $checkValue > 0.01 '."\n" + .'- 波动下降大于0.01：$checkValue < -0.01 '."\n" + .'- 波动率绝对值：abs($checkValue) > 0.01'."\n" + ."\n" + .'固定值类型规则也可以使用表达式方式配置阈值，如果同时配置，表达式优先级高于Operator和Value', + 'type' => 'string', + 'required' => false, + 'example' => '$checkValue > 0.01', + ], + ], + 'required' => false, + ], + ], + 'required' => false, + ], + ], + 'required' => false, + ], + 'ErrorHandlers' => [ + 'description' => '质量规则校验问题处理器列表。', + 'type' => 'array', + 'items' => [ + 'description' => '质量规则校验问题处理器。', + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'description' => '处理器类型：'."\n" + ."\n" + .'- SaveErrorData：保留问题数据', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [], + 'example' => 'SaveErrorData', + ], + 'ErrorDataFilter' => [ + 'description' => '如果是自定义SQL规则，需要用户指定SQL来过滤问题数据。', + 'type' => 'string', + 'required' => false, + 'example' => 'SELECT * FROM ods_api_log WHERE status = \'Error\';', + ], + ], + 'required' => false, + ], + 'required' => false, + ], + 'Id' => [ + 'description' => '规则ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '2176', + ], + ], + 'required' => false, + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request', + 'type' => 'string', + 'example' => '2d9ce-38ef-4923-baf6-391a7e656', + ], + 'Id' => [ + 'description' => '新建的数据质量监控ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10001', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'IdempotentParameterMismatch', + 'errorMessage' => 'The request uses the same client token as a previous, but non-identical request. Do not reuse a client token with different requests, unless the requests are identical.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"2d9ce-38ef-4923-baf6-391a7e656\\",\\n \\"Id\\": 10001\\n}","type":"json"}]', + 'title' => '创建数据质量监控', + 'description' => '需要购买 DataWorks 基础版及以上版本才能使用。', + ], + 'DeleteDataQualityRule' => [ + 'summary' => '删除质量规则。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'abilityTreeCode' => '247983', + 'abilityTreeNodes' => [ + 'FEATUREdide3WJOKE', + ], + ], + 'parameters' => [ + [ + 'name' => 'Id', + 'in' => 'query', + 'schema' => [ + 'description' => '规则ID', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + 'example' => '19715', + ], + ], + [ + 'name' => 'ProjectId', + 'in' => 'query', + 'schema' => [ + 'description' => 'DataWorks工作空间ID', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'docRequired' => true, + 'example' => '17302', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '返回值', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'API请求ID', + 'type' => 'string', + 'example' => '691CA452-D37A-4ED0-9441'."\n", + ], + 'Success' => [ + 'description' => '删除是否成功', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"691CA452-D37A-4ED0-9441\\\\n\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => '删除质量规则', + 'description' => '需要购买DataWorks基础版及以上版本才能使用', + ], + 'UpdateDataQualityRuleTemplate' => [ + 'summary' => '更新质量规则模版。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '248082', + 'abilityTreeNodes' => [ + 'FEATUREdideRGVRPF', + ], + ], + 'parameters' => [ + [ + 'name' => 'Code', + 'in' => 'formData', + 'schema' => [ + 'description' => '规则模版Code', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'USER_DEFINED:123', + ], + ], + [ + 'name' => 'Name', + 'in' => 'formData', + 'schema' => [ + 'description' => '规则模板名称，数字、英文字母、汉字、半角全角标点符号组合，最长512个字符', + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => 'Table row Count Verification'."\n", + 'maxLength' => 128, + ], + ], + [ + 'name' => 'ProjectId', + 'in' => 'query', + 'schema' => [ + 'description' => 'DataWorks工作空间的ID。您可以登录[DataWorks控制台](https://workbench.data.aliyun.com/console)，进入工作空间管理页面获取ID。'."\n" + ."\n" + .'该参数用来确定本次API调用操作使用的DataWorks工作空间。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + 'example' => '10000', + ], + ], + [ + 'name' => 'DirectoryPath', + 'in' => 'formData', + 'schema' => [ + 'description' => '自定义模板被存放的类目目录，斜线分隔层级。每个层级名称最长1024个字符，由不能包含空白字符、不能包含斜线', + 'type' => 'string', + 'required' => false, + 'example' => '/ods/order_data', + ], + ], + [ + 'name' => 'SamplingConfig', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'description' => '样本采集所需的设置', + 'type' => 'object', + 'properties' => [ + 'Metric' => [ + 'description' => '采样的指标名称'."\n" + .'- Count：表行数'."\n" + .'- Min：字段最小值'."\n" + .'- Max：字段最大值'."\n" + .'- Avg：字段均值'."\n" + .'- DistinctCount：字段唯一值个数'."\n" + .'- DistinctPercent：字段唯一值个数与数据行数占比'."\n" + .'- DuplicatedCount：字段重复值个数'."\n" + .'- DuplicatedPercent：字段重复值个数与数据行数占比'."\n" + .'- TableSize：表大小'."\n" + .'- NullValueCount：字段为空的行数'."\n" + .'- NullValuePercent：字段为空的比例'."\n" + .'- GroupCount：按字段值聚合后每个值与对应的数据行数'."\n" + .'- CountNotIn：枚举值不匹配行数'."\n" + .'- CountDistinctNotIn：枚举值不匹配唯一值个数'."\n" + .'- UserDefinedSql：通过自定义SQL做样本采集', + 'type' => 'string', + 'required' => false, + 'example' => 'Max', + ], + 'MetricParameters' => [ + 'description' => '样本采集时，所需的参数', + 'type' => 'string', + 'required' => false, + 'example' => '{"SQL": "select count(1) from table;"}'."\n", + ], + 'SettingConfig' => [ + 'description' => '具体执行采样语句前，插入执行的一些运行时参数设置语句，最长1000个字符。目前只支持MaxCompute', + 'type' => 'string', + 'required' => false, + 'example' => 'SET odps.sql.udf.timeout=600s; '."\n" + .'SET odps.sql.python.version=cp27;'."\n", + 'maxLength' => 1000, + ], + ], + 'required' => false, + ], + ], + [ + 'name' => 'CheckingConfig', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'description' => '样本校验设置', + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'description' => '监控对象类型'."\n" + ."\n" + .'- Table', + 'type' => 'string', + 'required' => false, + 'example' => 'Table', + ], + 'ReferencedSamplesFilter' => [ + 'description' => '有些类型的阈值需要查询出一些参考样本，然后对参考样本的值进行汇总得出进行比较的阈值，这里使用一个表达式来表示参考样本的查询方式', + 'type' => 'string', + 'required' => false, + 'example' => '{ "bizdate": [ "-1", "-7", "-1m" ] }'."\n", + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '返回值', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request', + 'type' => 'string', + 'example' => '691CA452-D37A-4ED0-****'."\n", + ], + 'Success' => [ + 'description' => '更新是否成功', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"691CA452-D37A-4ED0-****\\\\n\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => '更新质量规则模版', + 'description' => '需要购买DataWorks基础版及以上版本才能使用', + ], + 'CreateDataQualityRuleTemplate' => [ + 'summary' => '创建规则模版。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'abilityTreeCode' => '248081', + 'abilityTreeNodes' => [ + 'FEATUREdideRGVRPF', + ], + ], + 'parameters' => [ + [ + 'name' => 'Name', + 'in' => 'formData', + 'schema' => [ + 'description' => '规则模板名称，数字、英文字母、汉字、半角全角标点符号组合，最长512个字符。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'Table row Count Verification'."\n", + 'maxLength' => 128, + ], + ], + [ + 'name' => 'ProjectId', + 'in' => 'formData', + 'schema' => [ + 'description' => 'DataWorks工作空间ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + 'example' => '12345', + ], + ], + [ + 'name' => 'VisibleScope', + 'in' => 'formData', + 'schema' => [ + 'description' => '模板的可用范围：'."\n" + .'- Tenant：全租户都可用'."\n" + .'- Project：只在当前项目中可用', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'enumValueTitles' => [], + 'example' => 'Project', + 'default' => 'Project', + 'enum' => [ + 'Project', + 'Tenant', + ], + ], + ], + [ + 'name' => 'DirectoryPath', + 'in' => 'formData', + 'schema' => [ + 'description' => '自定义模板被存放的类目目录，斜线分隔层级。每个层级名称最长1024个字符，由不能包含空白字符、不能包含斜线。', + 'type' => 'string', + 'required' => false, + 'example' => '/ods/order_data'."\n", + ], + ], + [ + 'name' => 'SamplingConfig', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'description' => '样本采集所需的设置。', + 'type' => 'object', + 'properties' => [ + 'Metric' => [ + 'description' => '采样的指标名称：'."\n" + .'- Count：表行数'."\n" + .'- Min：字段最小值'."\n" + .'- Max：字段最大值'."\n" + .'- Avg：字段均值'."\n" + .'- DistinctCount：字段唯一值个数'."\n" + .'- DistinctPercent：字段唯一值个数与数据行数占比'."\n" + .'- DuplicatedCount：字段重复值个数'."\n" + .'- DuplicatedPercent：字段重复值个数与数据行数占比'."\n" + .'- TableSize：表大小'."\n" + .'- NullValueCount：字段为空的行数'."\n" + .'- NullValuePercent：字段为空的比例'."\n" + .'- GroupCount：按字段值聚合后每个值与对应的数据行数'."\n" + .'- CountNotIn：枚举值不匹配行数'."\n" + .'- CountDistinctNotIn：枚举值不匹配唯一值个数'."\n" + .'- UserDefinedSql：通过自定义SQL做样本采集', + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => 'Count', + ], + 'MetricParameters' => [ + 'description' => '样本采集时，所需的参数。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '{"SQL": "select count(1) from table;"}'."\n", + ], + 'SettingConfig' => [ + 'description' => '具体执行采样语句前，插入执行的一些运行时参数设置语句，最长1000个字符。目前只支持MaxCompute。', + 'type' => 'string', + 'required' => false, + 'example' => 'SET odps.sql.udf.timeout=600s; '."\n" + .'SET odps.sql.python.version=cp27;'."\n", + 'maxLength' => 1000, + ], + ], + 'required' => true, + 'docRequired' => true, + ], + ], + [ + 'name' => 'CheckingConfig', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'description' => '样本校验设置。', + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'description' => '阈值计算方式：'."\n" + .'- Fixed'."\n" + .'- Fluctation'."\n" + .'- FluctationDiscreate'."\n" + .'- Auto'."\n" + .'- Average'."\n" + .'- Variance', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'Fixed', + ], + 'ReferencedSamplesFilter' => [ + 'description' => '有些类型的阈值需要查询出一些参考样本，然后对参考样本的值进行汇总得出进行比较的阈值，这里使用一个表达式来表示参考样本的查询方式。', + 'type' => 'string', + 'required' => false, + 'example' => '{ "bizdate": [ "-1", "-7", "-1m" ] }'."\n", + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '返回值。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'API请求ID。', + 'type' => 'string', + 'example' => '691CA452-D37A-4ED0-9441'."\n", + ], + 'Code' => [ + 'description' => '规则模板Code。', + 'type' => 'string', + 'example' => 'UserDefined:3001', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"691CA452-D37A-4ED0-9441\\\\n\\",\\n \\"Code\\": \\"UserDefined:3001\\"\\n}","type":"json"}]', + 'title' => '创建质量规则模板', + 'description' => '需要购买DataWorks基础版及以上版本才能使用', + ], + 'DeleteDataQualityRuleTemplate' => [ + 'summary' => '删除自定义质量规则模版。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'abilityTreeCode' => '248058', + 'abilityTreeNodes' => [ + 'FEATUREdideRGVRPF', + ], + ], + 'parameters' => [ + [ + 'name' => 'Code', + 'in' => 'query', + 'schema' => [ + 'description' => '规则模版Code', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'USER_DEFINED:123', + ], + ], + [ + 'name' => 'ProjectId', + 'in' => 'query', + 'schema' => [ + 'description' => 'DataWorks工作空间ID', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'docRequired' => true, + 'example' => '10001', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '返回值', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'API请求ID', + 'type' => 'string', + 'example' => '691CA452-D37A-4ED0-9441'."\n", + ], + 'Success' => [ + 'description' => '删除是否成功', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"691CA452-D37A-4ED0-9441\\\\n\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => '删除自定义质量规则模版', + 'description' => '需要购买DataWorks基础版及以上版本才能使用', + ], + 'GetDataQualityRuleTemplate' => [ + 'summary' => '查询质量规则模版详情。', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '247999', + 'abilityTreeNodes' => [ + 'FEATUREdideRGVRPF', + ], + ], + 'parameters' => [ + [ + 'name' => 'Code', + 'in' => 'query', + 'schema' => [ + 'description' => '规则模版Code。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'USER_DEFINED:123', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '返回值。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'API请求ID。', + 'type' => 'string', + 'example' => '691CA452-D37A-4E****', + ], + 'DataQualityRuleTemplate' => [ + 'description' => '规则模版详情。', + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '规则模版Code。', + 'type' => 'string', + 'example' => 'USER_DEFINED:123', + ], + 'Name' => [ + 'description' => '规则模板名称，数字、英文字母、汉字、半角全角标点符号组合，最长512个字符。', + 'type' => 'string', + 'example' => 'Table row Count Verification', + ], + 'ProjectId' => [ + 'description' => 'DataWorks工作空间ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '4020', + ], + 'SamplingConfig' => [ + 'description' => '样本采集所需的设置。', + 'type' => 'object', + 'properties' => [ + 'Metric' => [ + 'description' => '采样的指标名称：'."\n" + .'- Count：表行数'."\n" + .'- Min：字段最小值'."\n" + .'- Max：字段最大值'."\n" + .'- Avg：字段均值'."\n" + .'- DistinctCount：字段唯一值个数'."\n" + .'- DistinctPercent：字段唯一值个数与数据行数占比'."\n" + .'- DuplicatedCount：字段重复值个数'."\n" + .'- DuplicatedPercent：字段重复值个数与数据行数占比'."\n" + .'- TableSize：表大小'."\n" + .'- NullValueCount：字段为空的行数'."\n" + .'- NullValuePercent：字段为空的比例'."\n" + .'- GroupCount：按字段值聚合后每个值与对应的数据行数'."\n" + .'- CountNotIn：枚举值不匹配行数'."\n" + .'- CountDistinctNotIn：枚举值不匹配唯一值个数'."\n" + .'- UserDefinedSql：通过自定义SQL做样本采集', + 'type' => 'string', + 'example' => 'Max', + ], + 'MetricParameters' => [ + 'description' => '样本采集时，所需的参数。', + 'type' => 'string', + 'example' => '{"SQL": "select count(1) from table;"}', + ], + 'SettingConfig' => [ + 'description' => '具体执行采样语句前，插入执行的一些运行时参数设置语句，最长1000个字符。目前只支持MaxCompute。', + 'type' => 'string', + 'example' => 'SET odps.sql.udf.timeout=600s; '."\n" + .'SET odps.sql.python.version=cp27;'."\n", + ], + ], + ], + 'CheckingConfig' => [ + 'description' => '样本校验设置。', + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'description' => '阈值计算方式：'."\n" + .'- Fixed'."\n" + .'- Fluctation'."\n" + .'- FluctationDiscreate'."\n" + .'- Auto'."\n" + .'- Average'."\n" + .'- Variance', + 'type' => 'string', + 'example' => 'Fixed', + ], + 'ReferencedSamplesFilter' => [ + 'description' => '有些类型的阈值需要查询出一些参考样本，然后对参考样本的值进行汇总得出进行比较的阈值，这里使用一个表达式来表示参考样本的查询方式。', + 'type' => 'string', + 'example' => '{ "bizdate": [ "-1", "-7", "-1m" ] }'."\n", + ], + ], + ], + 'VisibleScope' => [ + 'description' => '模板的可用范围：'."\n" + .'- Tenant：全租户都可用'."\n" + .'- Project：只在当前项目中可用', + 'type' => 'string', + 'example' => 'Project', + ], + 'DirectoryPath' => [ + 'description' => '自定义模板被存放的类目目录，斜线分隔层级。每个层级名称最长1024个字符，由不能包含空白字符、不能包含斜线。', + 'type' => 'string', + 'example' => '/ods/order_data', + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"691CA452-D37A-4E****\\",\\n \\"DataQualityRuleTemplate\\": {\\n \\"Code\\": \\"USER_DEFINED:123\\",\\n \\"Name\\": \\"Table row Count Verification\\",\\n \\"ProjectId\\": 4020,\\n \\"SamplingConfig\\": {\\n \\"Metric\\": \\"Max\\",\\n \\"MetricParameters\\": \\"{\\\\\\"SQL\\\\\\": \\\\\\"select count(1) from table;\\\\\\"}\\",\\n \\"SettingConfig\\": \\"SET odps.sql.udf.timeout=600s; \\\\nSET odps.sql.python.version=cp27;\\\\n\\"\\n },\\n \\"CheckingConfig\\": {\\n \\"Type\\": \\"Fixed\\",\\n \\"ReferencedSamplesFilter\\": \\"{ \\\\\\"bizdate\\\\\\": [ \\\\\\"-1\\\\\\", \\\\\\"-7\\\\\\", \\\\\\"-1m\\\\\\" ] }\\\\n\\"\\n },\\n \\"VisibleScope\\": \\"Project\\",\\n \\"DirectoryPath\\": \\"/ods/order_data\\"\\n }\\n}","type":"json"}]', + 'title' => '查询质量规则模版详情', + 'description' => '需要购买DataWorks基础版及以上版本才能使用', + ], + 'CreateDataQualityRule' => [ + 'summary' => '创建质量规则。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'abilityTreeCode' => '247801', + 'abilityTreeNodes' => [ + 'FEATUREdide3WJOKE', + ], + ], + 'parameters' => [ + [ + 'name' => 'Name', + 'in' => 'formData', + 'schema' => [ + 'description' => '规则名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'The table cannot be empty.', + 'maxLength' => 255, + ], + ], + [ + 'name' => 'ProjectId', + 'in' => 'formData', + 'schema' => [ + 'description' => 'DataWorks工作空间ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + 'example' => '10726', + ], + ], + [ + 'name' => 'Enabled', + 'in' => 'formData', + 'schema' => [ + 'description' => '质量规则是否启用。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + 'default' => 'true', + ], + ], + [ + 'name' => 'Severity', + 'in' => 'formData', + 'schema' => [ + 'description' => '规则对于业务的等级（对应页面上的强弱规则），可选的枚举值：'."\n" + .'- Normal'."\n" + .'- High', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [], + 'example' => 'Normal', + 'default' => 'Normal', + 'enum' => [ + 'High', + 'Normal', + ], + ], + ], + [ + 'name' => 'Description', + 'in' => 'formData', + 'schema' => [ + 'description' => '规则描述信息，最长500个字符。', + 'type' => 'string', + 'required' => false, + 'example' => 'this is a odps _sql task'."\n", + 'maxLength' => 500, + ], + ], + [ + 'name' => 'Target', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'description' => '规则所监控的对象。', + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'description' => '监控对象类型。'."\n" + ."\n" + .'- Table', + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => 'Table', + ], + 'DatabaseType' => [ + 'description' => '表类型的数据集，表所属的数据库类型。'."\n" + .'- maxcompute'."\n" + .'- emr'."\n" + .'- cdh'."\n" + .'- hologres'."\n" + .'- analyticdb_for_postgresql'."\n" + .'- analyticdb_for_mysql'."\n" + .'- starrocks', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'maxcompute'."\n", + ], + 'TableGuid' => [ + 'description' => '规则所作用的表在数据地图中的唯一ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'odps.unit_test.tb_unit_test'."\n", + ], + 'PartitionSpec' => [ + 'description' => '分区表的分区设置。', + 'type' => 'string', + 'required' => false, + 'example' => 'ds=$[yyyymmdd-1]'."\n", + ], + ], + 'required' => true, + 'docRequired' => true, + ], + ], + [ + 'name' => 'TemplateCode', + 'in' => 'formData', + 'schema' => [ + 'description' => '规则所引用的规则模板唯一标识。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'SYSTEM:table:table_count:fixed', + 'default' => 'SYSTEM:user_defined_sql', + ], + ], + [ + 'name' => 'SamplingConfig', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'description' => '样本采集所需的设置。', + 'type' => 'object', + 'properties' => [ + 'Metric' => [ + 'description' => '采样的指标名称，使用模版时可不设置。'."\n" + .'- Count：表行数'."\n" + .'- Min：字段最小值'."\n" + .'- Max：字段最大值'."\n" + .'- Avg：字段均值'."\n" + .'- DistinctCount：字段唯一值个数'."\n" + .'- DistinctPercent：字段唯一值个数与数据行数占比'."\n" + .'- DuplicatedCount：字段重复值个数'."\n" + .'- DuplicatedPercent：字段重复值个数与数据行数占比'."\n" + .'- TableSize：表大小'."\n" + .'- NullValueCount：字段为空的行数'."\n" + .'- NullValuePercent：字段为空的比例'."\n" + .'- GroupCount：按字段值聚合后每个值与对应的数据行数'."\n" + .'- CountNotIn：枚举值不匹配行数'."\n" + .'- CountDistinctNotIn：枚举值不匹配唯一值个数'."\n" + .'- UserDefinedSql：通过自定义SQL做样本采集', + 'type' => 'string', + 'required' => false, + 'example' => 'Count', + ], + 'MetricParameters' => [ + 'description' => '样本采集时，所需的参数。', + 'type' => 'string', + 'required' => false, + 'example' => '{ "Columns": [ "id", "name" ] , "SQL": "select count(1) from table;"}', + ], + 'SettingConfig' => [ + 'description' => '具体执行采样语句前，插入执行的一些运行时参数设置语句，最长1000个字符。目前只支持MaxCompute。', + 'type' => 'string', + 'required' => false, + 'example' => 'SET odps.sql.udf.timeout=600s; '."\n" + .'SET odps.sql.python.version=cp27;', + 'maxLength' => 1000, + ], + 'SamplingFilter' => [ + 'description' => '采样时，对不关注的数据进行二次过滤的条件，最多16777215个字符。', + 'type' => 'string', + 'required' => false, + 'example' => 'id IS NULL'."\n", + ], + ], + 'required' => false, + ], + ], + [ + 'name' => 'CheckingConfig', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'description' => '样本校验设置。', + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'description' => '阈值计算方式，使用模版时可不设置。'."\n" + .'- Fixed'."\n" + .'- Fluctation'."\n" + .'- FluctationDiscreate'."\n" + .'- Auto'."\n" + .'- Average'."\n" + .'- Variance', + 'type' => 'string', + 'required' => false, + 'example' => 'Fixed', + ], + 'ReferencedSamplesFilter' => [ + 'description' => '有些类型的阈值需要查询出一些参考样本，然后对参考样本的值进行汇总得出进行比较的阈值，这里使用一个表达式来表示参考样本的查询方式。', + 'type' => 'string', + 'required' => false, + 'example' => '{ "bizdate": [ "-1", "-7", "-1m" ] }'."\n", + ], + 'Thresholds' => [ + 'description' => '阈值设置。', + 'type' => 'object', + 'properties' => [ + 'Expected' => [ + 'description' => '期望的阈值设置。', + 'type' => 'object', + 'properties' => [ + 'Operator' => [ + 'description' => '比较符：'."\n" + .'- \\>'."\n" + .'- \\>='."\n" + .'- \\<'."\n" + .'- \\<='."\n" + .'- !='."\n" + .'- =', + 'type' => 'string', + 'required' => false, + 'example' => '>', + ], + 'Value' => [ + 'description' => '阈值数值。', + 'type' => 'string', + 'required' => false, + 'example' => '100.0', + ], + 'Expression' => [ + 'description' => '阈值表达式。'."\n" + ."\n" + .'波动率类型规则必须使用表达式方式表示波动阈值。如：'."\n" + ."\n" + .'- 波动上升大于0.01： $checkValue > 0.01 '."\n" + .'- 波动下降大于0.01：$checkValue < -0.01 '."\n" + .'- 波动率绝对值：abs($checkValue) > 0.01'."\n" + ."\n" + .'固定值类型规则也可以使用表达式方式配置阈值，如果同时配置，表达式优先级高于Operator和Value。', + 'type' => 'string', + 'required' => false, + 'example' => '$checkValue <= 0.01', + ], + ], + 'required' => false, + ], + 'Warned' => [ + 'description' => '普通警告的阈值设置。', + 'type' => 'object', + 'properties' => [ + 'Operator' => [ + 'description' => '比较符：'."\n" + .'- \\>'."\n" + .'- \\>='."\n" + .'- \\<'."\n" + .'- \\<='."\n" + .'- !='."\n" + .'- =', + 'type' => 'string', + 'required' => false, + 'example' => '>', + ], + 'Value' => [ + 'description' => '阈值数值。', + 'type' => 'string', + 'required' => false, + 'example' => '100.0', + ], + 'Expression' => [ + 'description' => '阈值表达式。'."\n" + ."\n" + .'波动率类型规则必须使用表达式方式表示波动阈值。如：'."\n" + ."\n" + .'- 波动上升大于0.01： $checkValue > 0.01 '."\n" + .'- 波动下降大于0.01：$checkValue < -0.01 '."\n" + .'- 波动率绝对值：abs($checkValue) > 0.01'."\n" + ."\n" + .'固定值类型规则也可以使用表达式方式配置阈值，如果同时配置，表达式优先级高于Operator和Value。', + 'type' => 'string', + 'required' => false, + 'example' => '$checkValue > 0.01'."\n", + ], + ], + 'required' => false, + ], + 'Critical' => [ + 'description' => '严重警告的阈值设置。', + 'type' => 'object', + 'properties' => [ + 'Operator' => [ + 'description' => '比较符：'."\n" + .'- \\>'."\n" + .'- \\>='."\n" + .'- \\<'."\n" + .'- \\<='."\n" + .'- !='."\n" + .'- =', + 'type' => 'string', + 'required' => false, + 'example' => '>', + ], + 'Value' => [ + 'description' => '阈值数值。', + 'type' => 'string', + 'required' => false, + 'example' => '100.0', + ], + 'Expression' => [ + 'description' => '阈值表达式。'."\n" + ."\n" + .'波动率类型规则必须使用表达式方式表示波动阈值。如：'."\n" + ."\n" + .'- 波动上升大于0.01： $checkValue > 0.01 '."\n" + .'- 波动下降大于0.01：$checkValue < -0.01 '."\n" + .'- 波动率绝对值：abs($checkValue) > 0.01'."\n" + ."\n" + .'固定值类型规则也可以使用表达式方式配置阈值，如果同时配置，表达式优先级高于Operator和Value。', + 'type' => 'string', + 'required' => false, + 'example' => '$checkValue > 0.05', + ], + ], + 'required' => false, + ], + ], + 'required' => false, + ], + ], + 'required' => false, + ], + ], + [ + 'name' => 'ErrorHandlers', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'description' => '质量规则校验问题处理器列表。', + 'type' => 'array', + 'items' => [ + 'description' => '质量规则校验问题处理器。', + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'description' => '处理器类型：'."\n" + .'- SaveErrorData', + 'type' => 'string', + 'required' => false, + 'example' => 'SaveErrorData', + ], + 'ErrorDataFilter' => [ + 'description' => '如果是自定义SQL规则，需要用户指定SQL来过滤问题数据。', + 'type' => 'string', + 'required' => false, + 'example' => 'SELECT * FROM tb_api_log WHERE id IS NULL'."\n", + ], + ], + 'required' => false, + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '返回值。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'API请求ID。', + 'type' => 'string', + 'example' => '691CA452-D37A-4ED0-9441'."\n", + ], + 'Id' => [ + 'description' => '规则ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '19715', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"691CA452-D37A-4ED0-9441\\\\n\\",\\n \\"Id\\": 19715\\n}","type":"json"}]', + 'title' => '创建质量规则', + 'description' => '需要购买DataWorks基础版及以上版本才能使用', + 'extraInfo' => '规则模版Code列表：'."\n" + .'- 自定义SQL：SYSTEM:user_defined_sql'."\n" + ."\n" + .'- 表行数大于0：SYSTEM:table:table_count:fixed:0'."\n" + .'- 表行数，固定值：SYSTEM:table:table_count:fixed'."\n" + .'- 表行数，1天差值：SYSTEM:table:table_count_delta:fixed:1_bizdate'."\n" + .'- 表行数，上周期差值：SYSTEM:table:table_count_delta:fixed:latest_bizdate'."\n" + .'- 表行数，上周期波动率：SYSTEM:table:table_count:cycle:latest_bizdate'."\n" + .'- 表行数，7天平均值波动率：SYSTEM:table:table_count:avg:7_bizdate'."\n" + .'- 表行数，30天平均值波动率：SYSTEM:table:table_count:avg:1m_bizdate'."\n" + .'- 表行数，1天波动率：SYSTEM:table:table_count:flux:1_bizdate'."\n" + .'- 表行数，7天波动率：SYSTEM:table:table_count:flux:7_bizdate'."\n" + .'- 表行数，30天波动率：SYSTEM:table:table_count:flux:1m_bizdate'."\n" + .'- 表行数，1，7，30天波动率：SYSTEM:table:table_count:flux:1_7_1m_bizdate'."\n" + .'- 表行数，1，7，30天，本月1号，波动率：SYSTEM:table:table_count:flux:1_7_1m_1st_bizdate'."\n" + .'- 表行数，自定义范围：SYSTEM:table:count'."\n" + .'- 条件匹配占比，自定义范围：SYSTEM:table:count_percent'."\n" + ."\n" + .'- 平均值，1天波动率：SYSTEM:field:avg:cycle:1_bizdate'."\n" + .'- 平均值，1、7、30天波动率：SYSTEM:field:avg:flux:1_7_1m_bizdate'."\n" + .'- 平均值，自定义范围：SYSTEM:field:avg'."\n" + ."\n" + .'- 汇总值，1天波动率：SYSTEM:field:sum:cycle:1_bizdate'."\n" + .'- 汇总值，上周期波动率：SYSTEM:field:sum:cycle:latest_bizdate'."\n" + .'- 汇总值，1、7、30天波动率：SYSTEM:field:sum:flux:1_7_1m_bizdate'."\n" + .'- 汇总值，自定义范围：SYSTEM:field:sum'."\n" + ."\n" + .'- 最小值，1天波动率：SYSTEM:field:min:cycle:1_bizdate'."\n" + .'- 最小值，上周期波动率：SYSTEM:field:min:cycle:latest_bizdate'."\n" + .'- 最小值，1、7、30天波动率：SYSTEM:field:min:flux:1_7_1m_bizdate'."\n" + .'- 最小值，自定义范围：SYSTEM:field:min'."\n" + ."\n" + .'- 最大值，1天波动率：SYSTEM:field:max:cycle:1_bizdate'."\n" + .'- 最大值，上周期波动率：SYSTEM:field:max:cycle:latest_bizdate'."\n" + .'- 最大值，1、7、30天波动率：SYSTEM:field:max:flux:1_7_1m_bizdate'."\n" + .'- 最大值，自定义范围：SYSTEM:field:max'."\n" + ."\n" + .'- 空值记录数为0：SYSTEM:field:null_value:fixed:0'."\n" + .'- 空值个数，固定值：SYSTEM:field:null_value:fixed'."\n" + .'- 空值个数/总行数，固定值：SYSTEM:field:null_value_percent:fixed'."\n" + ."\n" + .'- 字段重复值为0：SYSTEM:field:duplicated_count:fixed:0'."\n" + .'- 重复值个数/总行数，固定值：SYSTEM:field:duplicated_percent:fixed'."\n" + .'- 重复值个数，固定值：YSTEM:field:duplicated_count:fixed'."\n" + .'- 多字段重复值为0：SYSTEM:fields:duplicated_count:fixed:0'."\n" + ."\n" + .'- 离散值（状态值），固定值：SYSTEM:field:all_discrete_count:fixed'."\n" + .'- 离散值（分组个数及状态值），1、7、30天波动率：SYSTEM:field:all_discrete_metrics:fluxdiscrete:1_7_1m_bizdate'."\n" + .'- 离散值（分组个数），固定值：SYSTEM:field:discrete_group_count:fixed'."\n" + .'- 离散值（分组个数），1天波动率：SYSTEM:field:discrete_group_count:cycle:latest_bizdate'."\n" + ."\n" + .'- 表大小，固定值：SYSTEM:table:table_size:fixed'."\n" + .'- 表大小，上周期差值：SYSTEM:table:table_size_delta:fixed:latest_bizdate'."\n" + .'- 表大小，相比1天前差值（字节）：SYSTEM:table:table_size_delta:fixed:1_bizdate'."\n" + .'- 表大小，1天波动率：SYSTEM:table:table_size:flux:1_bizdate'."\n" + .'- 表大小，7天波动率：SYSTEM:table:table_size:flux:7_bizdate'."\n" + .'- 表大小，30天波动率：SYSTEM:table:table_size:flux:1m_bizdate'."\n" + ."\n" + .'- 唯一值个数，固定值：SYSTEM:field:count_distinct:fixed'."\n" + .'- 唯一值个数，1、7、30天波动率：SYSTEM:field:count_distinct:flux:1_7_1m_bizdate'."\n" + .'- 唯一值个数/总行数，固定值：SYSTEM:field:count_distinct_percent:fixed'."\n" + ."\n" + .'- 表行数，动态阈值：SYSTEM:table:table_count:dynamic_threshold'."\n" + .'- 汇总值，动态阈值：SYSTEM:field:sum:dynamic_threshold'."\n" + .'- 平均值，动态阈值：SYSTEM:field:avg:dynamic_threshold'."\n" + .'- 最大值，动态阈值：SYSTEM:field:max:dynamic_threshold'."\n" + .'- 最小值，动态阈值：SYSTEM:field:min:dynamic_threshold'."\n" + .'- 唯一值率动态阈值：SYSTEM:table:table_size:dynamic_threshold'."\n" + .'- 唯一值个数，动态阈值：SYSTEM:table:distinct_count:dynamic_threshold'."\n" + .'- 离散值（分组个数），动态阈值：SYSTEM:field:avg:dynamic_threshold'."\n" + .'- 离散值（状态值），动态阈值：SYSTEM:field:sum:dynamic_threshold'."\n" + .'- 离散值（分组个数），动态阈值：SYSTEM:field:discrete_group_count:dynamic_threshold'."\n" + .'- 离散值（状态值），动态阈值：SYSTEM:field:discrete_value_count:dynamic_threshold', + ], + 'UpdateDataQualityRule' => [ + 'summary' => '更新质量规则。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '247829', + 'abilityTreeNodes' => [ + 'FEATUREdide3WJOKE', + ], + ], + 'parameters' => [ + [ + 'name' => 'Id', + 'in' => 'formData', + 'schema' => [ + 'description' => '规则ID', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + 'example' => '100001', + ], + ], + [ + 'name' => 'Name', + 'in' => 'formData', + 'schema' => [ + 'description' => '规则名称，数字、英文字母、汉字、半角全角标点符号组合，最长255个字符', + 'type' => 'string', + 'required' => false, + 'example' => '表不能为空', + 'maxLength' => 255, + ], + ], + [ + 'name' => 'Enabled', + 'in' => 'formData', + 'schema' => [ + 'description' => '规则是否启用', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + 'default' => 'true', + ], + ], + [ + 'name' => 'Severity', + 'in' => 'formData', + 'schema' => [ + 'description' => '规则对于业务的等级（对应页面上的强弱规则），可选的枚举值：'."\n" + .'- Normal'."\n" + .'- High', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [], + 'example' => 'High', + 'enum' => [ + 'High', + 'Normal', + ], + ], + ], + [ + 'name' => 'Description', + 'in' => 'formData', + 'schema' => [ + 'description' => '规则描述信息，最长500个字符', + 'type' => 'string', + 'required' => false, + 'example' => 'this is a odps _sql task'."\n", + 'maxLength' => 500, + ], + ], + [ + 'name' => 'ProjectId', + 'in' => 'query', + 'schema' => [ + 'description' => 'DataWorks工作空间的ID。您可以登录[DataWorks控制台](https://workbench.data.aliyun.com/console)，进入工作空间配置页面获取工作空间ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + 'example' => '10000', + ], + ], + [ + 'name' => 'TemplateCode', + 'in' => 'formData', + 'schema' => [ + 'description' => '规则所引用的规则模板唯一标识', + 'type' => 'string', + 'required' => false, + 'example' => 'SYSTEM:table:table_count:fixed', + ], + ], + [ + 'name' => 'SamplingConfig', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'description' => '样本采集所需的设置', + 'type' => 'object', + 'properties' => [ + 'Metric' => [ + 'description' => '采样的指标名称，使用模版时可不设置'."\n" + .'- Count：表行数'."\n" + .'- Min：字段最小值'."\n" + .'- Max：字段最大值'."\n" + .'- Avg：字段均值'."\n" + .'- DistinctCount：字段唯一值个数'."\n" + .'- DistinctPercent：字段唯一值个数与数据行数占比'."\n" + .'- DuplicatedCount：字段重复值个数'."\n" + .'- DuplicatedPercent：字段重复值个数与数据行数占比'."\n" + .'- TableSize：表大小'."\n" + .'- NullValueCount：字段为空的行数'."\n" + .'- NullValuePercent：字段为空的比例'."\n" + .'- GroupCount：按字段值聚合后每个值与对应的数据行数'."\n" + .'- CountNotIn：枚举值不匹配行数'."\n" + .'- CountDistinctNotIn：枚举值不匹配唯一值个数'."\n" + .'- UserDefinedSql：通过自定义SQL做样本采集', + 'type' => 'string', + 'required' => false, + 'example' => 'Min', + ], + 'MetricParameters' => [ + 'description' => '样本采集时，所需的参数', + 'type' => 'string', + 'required' => false, + 'example' => '{ "Columns": [ "id", "name" ] , "SQL": "select count(1) from table;"}', + ], + 'SettingConfig' => [ + 'description' => '具体执行采样语句前，插入执行的一些运行时参数设置语句，最长1000个字符。目前只支持MaxCompute', + 'type' => 'string', + 'required' => false, + 'example' => 'SET odps.sql.udf.timeout=600s; '."\n" + .'SET odps.sql.python.version=cp27;', + 'maxLength' => 1000, + ], + 'SamplingFilter' => [ + 'description' => '采样时，对不关注的数据进行二次过滤的条件，最多16777215个字符', + 'type' => 'string', + 'required' => false, + 'example' => 'id IS NULL'."\n", + ], + ], + 'required' => false, + ], + ], + [ + 'name' => 'CheckingConfig', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'description' => '样本校验设置', + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'description' => '阈值计算方式，使用模版时可不设置'."\n" + .'- Fixed'."\n" + .'- Fluctation'."\n" + .'- FluctationDiscreate'."\n" + .'- Auto'."\n" + .'- Average'."\n" + .'- Variance', + 'type' => 'string', + 'required' => false, + 'example' => 'Fixed', + ], + 'ReferencedSamplesFilter' => [ + 'description' => '有些类型的阈值需要查询出一些参考样本，然后对参考样本的值进行汇总得出进行比较的阈值，这里使用一个表达式来表示参考样本的查询方式', + 'type' => 'string', + 'required' => false, + 'example' => '{ "bizdate": [ "-1", "-7", "-1m" ] }'."\n", + ], + 'Thresholds' => [ + 'description' => '阈值设置', + 'type' => 'object', + 'properties' => [ + 'Expected' => [ + 'description' => '期望的阈值设置', + 'type' => 'object', + 'properties' => [ + 'Operator' => [ + 'description' => '比较符'."\n" + .'- \\>'."\n" + .'- \\>='."\n" + .'- <'."\n" + .'- <='."\n" + .'- !='."\n" + .'- =', + 'type' => 'string', + 'required' => false, + 'example' => '>', + ], + 'Value' => [ + 'description' => '阈值数值', + 'type' => 'string', + 'required' => false, + 'example' => '100.0', + ], + 'Expression' => [ + 'description' => '阈值表达式。'."\n" + ."\n" + .'波动率类型规则必须使用表达式方式表示波动阈值。如：'."\n" + ."\n" + .'- 波动上升大于0.01： $checkValue > 0.01 '."\n" + .'- 波动下降大于0.01：$checkValue < -0.01 '."\n" + .'- 波动率绝对值：abs($checkValue) > 0.01'."\n" + ."\n" + .'固定值类型规则也可以使用表达式方式配置阈值，如果同时配置，表达式优先级高于Operator和Value', + 'type' => 'string', + 'required' => false, + 'example' => '$checkValue <= 0.01', + ], + ], + 'required' => false, + ], + 'Warned' => [ + 'description' => '普通警告的阈值设置', + 'type' => 'object', + 'properties' => [ + 'Operator' => [ + 'description' => '比较符'."\n" + .'- \\>'."\n" + .'- \\>='."\n" + .'- \\<'."\n" + .'- \\<='."\n" + .'- !='."\n" + .'- =', + 'type' => 'string', + 'required' => false, + 'example' => '>', + ], + 'Value' => [ + 'description' => '阈值数值', + 'type' => 'string', + 'required' => false, + 'example' => '100.0', + ], + 'Expression' => [ + 'description' => '阈值表达式。'."\n" + ."\n" + .'波动率类型规则必须使用表达式方式表示波动阈值。如：'."\n" + ."\n" + .'- 波动上升大于0.01： $checkValue > 0.01 '."\n" + .'- 波动下降大于0.01：$checkValue < -0.01 '."\n" + .'- 波动率绝对值：abs($checkValue) > 0.01'."\n" + ."\n" + .'固定值类型规则也可以使用表达式方式配置阈值，如果同时配置，表达式优先级高于Operator和Value', + 'type' => 'string', + 'required' => false, + 'example' => '$checkValue > 0.01', + ], + ], + 'required' => false, + ], + 'Critical' => [ + 'description' => '严重警告的阈值设置', + 'type' => 'object', + 'properties' => [ + 'Operator' => [ + 'description' => '比较符'."\n" + .'- \\>'."\n" + .'- \\>='."\n" + .'- \\<'."\n" + .'- \\<='."\n" + .'- !='."\n" + .'- =', + 'type' => 'string', + 'required' => false, + 'example' => '>', + ], + 'Value' => [ + 'description' => '阈值数值', + 'type' => 'string', + 'required' => false, + 'example' => '100.0', + ], + 'Expression' => [ + 'description' => '阈值表达式。'."\n" + ."\n" + .'波动率类型规则必须使用表达式方式表示波动阈值。如：'."\n" + ."\n" + .'- 波动上升大于0.01： $checkValue > 0.01 '."\n" + .'- 波动下降大于0.01：$checkValue < -0.01 '."\n" + .'- 波动率绝对值：abs($checkValue) > 0.01'."\n" + ."\n" + .'固定值类型规则也可以使用表达式方式配置阈值，如果同时配置，表达式优先级高于Operator和Value', + 'type' => 'string', + 'required' => false, + 'example' => '$checkValue > 0.05', + ], + ], + 'required' => false, + ], + ], + 'required' => false, + ], + ], + 'required' => false, + ], + ], + [ + 'name' => 'ErrorHandlers', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'description' => '质量规则校验问题处理器列表', + 'type' => 'array', + 'items' => [ + 'description' => '质量规则校验问题处理器', + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'description' => '处理器类型：'."\n" + .'- SaveErrorData', + 'type' => 'string', + 'required' => false, + 'example' => 'SaveErrorData', + ], + 'ErrorDataFilter' => [ + 'description' => '如果是自定义SQL规则，需要用户指定SQL来过滤问题数据', + 'type' => 'string', + 'required' => false, + 'example' => 'SELECT * FROM tb_api_log WHERE id IS NULL'."\n", + ], + ], + 'required' => false, + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '返回值', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request', + 'type' => 'string', + 'example' => '691CA452-D37A-4ED0-9441'."\n", + ], + 'Success' => [ + 'description' => '更新是否成功', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"691CA452-D37A-4ED0-9441\\\\n\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => '更新质量规则', + 'description' => '需要购买DataWorks基础版及以上版本才能使用', + 'extraInfo' => '规则模版Code列表：'."\n" + .'- 自定义SQL：SYSTEM:user_defined_sql'."\n" + ."\n" + .'- 表行数大于0：SYSTEM:table:table_count:fixed:0'."\n" + .'- 表行数，固定值：SYSTEM:table:table_count:fixed'."\n" + .'- 表行数，1天差值：SYSTEM:table:table_count_delta:fixed:1_bizdate'."\n" + .'- 表行数，上周期差值：SYSTEM:table:table_count_delta:fixed:latest_bizdate'."\n" + .'- 表行数，上周期波动率：SYSTEM:table:table_count:cycle:latest_bizdate'."\n" + .'- 表行数，7天平均值波动率：SYSTEM:table:table_count:avg:7_bizdate'."\n" + .'- 表行数，30天平均值波动率：SYSTEM:table:table_count:avg:1m_bizdate'."\n" + .'- 表行数，1天波动率：SYSTEM:table:table_count:flux:1_bizdate'."\n" + .'- 表行数，7天波动率：SYSTEM:table:table_count:flux:7_bizdate'."\n" + .'- 表行数，30天波动率：SYSTEM:table:table_count:flux:1m_bizdate'."\n" + .'- 表行数，1，7，30天波动率：SYSTEM:table:table_count:flux:1_7_1m_bizdate'."\n" + .'- 表行数，1，7，30天，本月1号，波动率：SYSTEM:table:table_count:flux:1_7_1m_1st_bizdate'."\n" + .'- 表行数，自定义范围：SYSTEM:table:count'."\n" + .'- 条件匹配占比，自定义范围：SYSTEM:table:count_percent'."\n" + ."\n" + .'- 平均值，1天波动率：SYSTEM:field:avg:cycle:1_bizdate'."\n" + .'- 平均值，1、7、30天波动率：SYSTEM:field:avg:flux:1_7_1m_bizdate'."\n" + .'- 平均值，自定义范围：SYSTEM:field:avg'."\n" + ."\n" + .'- 汇总值，1天波动率：SYSTEM:field:sum:cycle:1_bizdate'."\n" + .'- 汇总值，上周期波动率：SYSTEM:field:sum:cycle:latest_bizdate'."\n" + .'- 汇总值，1、7、30天波动率：SYSTEM:field:sum:flux:1_7_1m_bizdate'."\n" + .'- 汇总值，自定义范围：SYSTEM:field:sum'."\n" + ."\n" + .'- 最小值，1天波动率：SYSTEM:field:min:cycle:1_bizdate'."\n" + .'- 最小值，上周期波动率：SYSTEM:field:min:cycle:latest_bizdate'."\n" + .'- 最小值，1、7、30天波动率：SYSTEM:field:min:flux:1_7_1m_bizdate'."\n" + .'- 最小值，自定义范围：SYSTEM:field:min'."\n" + ."\n" + .'- 最大值，1天波动率：SYSTEM:field:max:cycle:1_bizdate'."\n" + .'- 最大值，上周期波动率：SYSTEM:field:max:cycle:latest_bizdate'."\n" + .'- 最大值，1、7、30天波动率：SYSTEM:field:max:flux:1_7_1m_bizdate'."\n" + .'- 最大值，自定义范围：SYSTEM:field:max'."\n" + ."\n" + .'- 空值记录数为0：SYSTEM:field:null_value:fixed:0'."\n" + .'- 空值个数，固定值：SYSTEM:field:null_value:fixed'."\n" + .'- 空值个数/总行数，固定值：SYSTEM:field:null_value_percent:fixed'."\n" + ."\n" + .'- 字段重复值为0：SYSTEM:field:duplicated_count:fixed:0'."\n" + .'- 重复值个数/总行数，固定值：SYSTEM:field:duplicated_percent:fixed'."\n" + .'- 重复值个数，固定值：YSTEM:field:duplicated_count:fixed'."\n" + .'- 多字段重复值为0：SYSTEM:fields:duplicated_count:fixed:0'."\n" + ."\n" + .'- 离散值（状态值），固定值：SYSTEM:field:all_discrete_count:fixed'."\n" + .'- 离散值（分组个数及状态值），1、7、30天波动率：SYSTEM:field:all_discrete_metrics:fluxdiscrete:1_7_1m_bizdate'."\n" + .'- 离散值（分组个数），固定值：SYSTEM:field:discrete_group_count:fixed'."\n" + .'- 离散值（分组个数），1天波动率：SYSTEM:field:discrete_group_count:cycle:latest_bizdate'."\n" + ."\n" + .'- 表大小，固定值：SYSTEM:table:table_size:fixed'."\n" + .'- 表大小，上周期差值：SYSTEM:table:table_size_delta:fixed:latest_bizdate'."\n" + .'- 表大小，相比1天前差值（字节）：SYSTEM:table:table_size_delta:fixed:1_bizdate'."\n" + .'- 表大小，1天波动率：SYSTEM:table:table_size:flux:1_bizdate'."\n" + .'- 表大小，7天波动率：SYSTEM:table:table_size:flux:7_bizdate'."\n" + .'- 表大小，30天波动率：SYSTEM:table:table_size:flux:1m_bizdate'."\n" + ."\n" + .'- 唯一值个数，固定值：SYSTEM:field:count_distinct:fixed'."\n" + .'- 唯一值个数，1、7、30天波动率：SYSTEM:field:count_distinct:flux:1_7_1m_bizdate'."\n" + .'- 唯一值个数/总行数，固定值：SYSTEM:field:count_distinct_percent:fixed'."\n" + ."\n" + .'- 表行数，动态阈值：SYSTEM:table:table_count:dynamic_threshold'."\n" + .'- 汇总值，动态阈值：SYSTEM:field:sum:dynamic_threshold'."\n" + .'- 平均值，动态阈值：SYSTEM:field:avg:dynamic_threshold'."\n" + .'- 最大值，动态阈值：SYSTEM:field:max:dynamic_threshold'."\n" + .'- 最小值，动态阈值：SYSTEM:field:min:dynamic_threshold'."\n" + .'- 唯一值率动态阈值：SYSTEM:table:table_size:dynamic_threshold'."\n" + .'- 唯一值个数，动态阈值：SYSTEM:table:distinct_count:dynamic_threshold'."\n" + .'- 离散值（分组个数），动态阈值：SYSTEM:field:avg:dynamic_threshold'."\n" + .'- 离散值（状态值），动态阈值：SYSTEM:field:sum:dynamic_threshold'."\n" + .'- 离散值（分组个数），动态阈值：SYSTEM:field:discrete_group_count:dynamic_threshold'."\n" + .'- 离散值（状态值），动态阈值：SYSTEM:field:discrete_value_count:dynamic_threshold', + ], + 'GetDataQualityRule' => [ + 'summary' => '查询质量规则详情。', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '247799', + 'abilityTreeNodes' => [ + 'FEATUREdide3WJOKE', + ], + ], + 'parameters' => [ + [ + 'name' => 'Id', + 'in' => 'query', + 'schema' => [ + 'description' => '规则ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + 'example' => '19715', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '返回值。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'API请求ID。', + 'type' => 'string', + 'example' => '691CA452-D37A-4ED0-****', + ], + 'DataQualityRule' => [ + 'description' => '规则详情。', + 'type' => 'object', + 'properties' => [ + 'Id' => [ + 'description' => '规则ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '16033', + ], + 'Name' => [ + 'description' => '规则名称。', + 'type' => 'string', + 'example' => 'The table cannot be empty.'."\n", + ], + 'ProjectId' => [ + 'description' => 'DataWorks工作空间ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1948', + ], + 'Enabled' => [ + 'description' => '规则是否启用。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Severity' => [ + 'description' => '规则对于业务的等级（对应页面上的强弱规则），可选的枚举值：'."\n" + .'- Normal'."\n" + .'- High', + 'type' => 'string', + 'example' => 'High', + ], + 'Description' => [ + 'description' => '规则描述信息，最长500个字符。', + 'type' => 'string', + 'example' => 'this is a odps _sql task'."\n", + ], + 'Target' => [ + 'description' => '规则所监控的对象。', + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'description' => '监控对象类型'."\n" + ."\n" + .'- Table', + 'type' => 'string', + 'example' => 'Table', + ], + 'DatabaseType' => [ + 'description' => '表类型的数据集，表所属的数据库类型'."\n" + .'- maxcompute'."\n" + .'- emr'."\n" + .'- cdh'."\n" + .'- hologres'."\n" + .'- analyticdb_for_postgresql'."\n" + .'- analyticdb_for_mysql'."\n" + .'- starrocks', + 'type' => 'string', + 'example' => 'maxcompute', + ], + 'TableGuid' => [ + 'description' => '规则所作用的表在数据地图中的唯一ID。', + 'type' => 'string', + 'example' => 'odps.unit_test.tb_unit_test'."\n", + ], + 'PartitionSpec' => [ + 'description' => '分区表的分区设置。', + 'type' => 'string', + 'example' => 'ds=$[yyyymmdd-1]'."\n", + ], + ], + ], + 'TemplateCode' => [ + 'description' => '规则所引用的规则模板唯一标识。', + 'type' => 'string', + 'example' => 'SYSTEM:table:table_count:fixed', + ], + 'SamplingConfig' => [ + 'description' => '样本采集所需的设置。', + 'type' => 'object', + 'properties' => [ + 'Metric' => [ + 'description' => '采样的指标名称：'."\n" + .'- Count：表行数'."\n" + .'- Min：字段最小值'."\n" + .'- Max：字段最大值'."\n" + .'- Avg：字段均值'."\n" + .'- DistinctCount：字段唯一值个数'."\n" + .'- DistinctPercent：字段唯一值个数与数据行数占比'."\n" + .'- DuplicatedCount：字段重复值个数'."\n" + .'- DuplicatedPercent：字段重复值个数与数据行数占比'."\n" + .'- TableSize：表大小'."\n" + .'- NullValueCount：字段为空的行数'."\n" + .'- NullValuePercent：字段为空的比例'."\n" + .'- GroupCount：按字段值聚合后每个值与对应的数据行数'."\n" + .'- CountNotIn：枚举值不匹配行数'."\n" + .'- CountDistinctNotIn：枚举值不匹配唯一值个数'."\n" + .'- UserDefinedSql：通过自定义SQL做样本采集', + 'type' => 'string', + 'example' => 'Max', + ], + 'MetricParameters' => [ + 'description' => '样本采集时，所需的参数。', + 'type' => 'string', + 'example' => '{ "Columns": [ "id", "name" ] , "SQL": "select count(1) from table;"}', + ], + 'SettingConfig' => [ + 'description' => '具体执行采样语句前，插入执行的一些运行时参数设置语句，最长1000个字符。目前只支持MaxCompute。', + 'type' => 'string', + 'example' => 'SET odps.sql.udf.timeout=600s; '."\n" + .'SET odps.sql.python.version=cp27;'."\n", + ], + 'SamplingFilter' => [ + 'description' => '采样时，对不关注的数据进行二次过滤的条件，最多16777215个字符。', + 'type' => 'string', + 'example' => 'id IS NULL'."\n", + ], + ], + ], + 'CheckingConfig' => [ + 'description' => '样本校验设置。', + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'description' => '阈值计算方式：'."\n" + .'- Fixed'."\n" + .'- Fluctation'."\n" + .'- FluctationDiscreate'."\n" + .'- Auto'."\n" + .'- Average'."\n" + .'- Variance', + 'type' => 'string', + 'example' => 'Fixed', + ], + 'ReferencedSamplesFilter' => [ + 'description' => '有些类型的阈值需要查询出一些参考样本，然后对参考样本的值进行汇总得出进行比较的阈值，这里使用一个表达式来表示参考样本的查询方式。', + 'type' => 'string', + 'example' => '{ "bizdate": [ "-1", "-7", "-1m" ] }'."\n", + ], + 'Thresholds' => [ + 'description' => '阈值设置。', + 'type' => 'object', + 'properties' => [ + 'Expected' => [ + 'description' => '期望的阈值设置。', + 'type' => 'object', + 'properties' => [ + 'Operator' => [ + 'description' => '比较符：'."\n" + .'- \\>'."\n" + .'- \\>='."\n" + .'- <'."\n" + .'- <='."\n" + .'- !='."\n" + .'- =', + 'type' => 'string', + 'example' => '>', + ], + 'Value' => [ + 'description' => '阈值数值。', + 'type' => 'string', + 'example' => '100.0', + ], + 'Expression' => [ + 'description' => '阈值表达式。', + 'type' => 'string', + 'example' => '$checkValue <= 0.01', + ], + ], + ], + 'Warned' => [ + 'description' => '普通警告的阈值设置。', + 'type' => 'object', + 'properties' => [ + 'Operator' => [ + 'description' => '比较符：'."\n" + .'- \\>'."\n" + .'- \\>='."\n" + .'- <'."\n" + .'- <='."\n" + .'- !='."\n" + .'- =', + 'type' => 'string', + 'example' => '>', + ], + 'Value' => [ + 'description' => '阈值数值。', + 'type' => 'string', + 'example' => '100.0', + ], + 'Expression' => [ + 'description' => '阈值表达式。', + 'type' => 'string', + 'example' => '$checkValue > 0.01', + ], + ], + ], + 'Critical' => [ + 'description' => '严重警告的阈值设置。', + 'type' => 'object', + 'properties' => [ + 'Operator' => [ + 'description' => '比较符：'."\n" + .'- \\>'."\n" + .'- \\>='."\n" + .'- <'."\n" + .'- <='."\n" + .'- !='."\n" + .'- =', + 'type' => 'string', + 'example' => '>', + ], + 'Value' => [ + 'description' => '阈值数值。', + 'type' => 'string', + 'example' => '100.0', + ], + 'Expression' => [ + 'description' => '阈值表达式。', + 'type' => 'string', + 'example' => '$checkValue > 0.05', + ], + ], + ], + ], + ], + ], + ], + 'ErrorHandlers' => [ + 'description' => '质量规则校验问题处理器列表。', + 'type' => 'array', + 'items' => [ + 'description' => '质量规则校验问题处理器。', + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'description' => '处理器类型：'."\n" + .'- SaveErrorData', + 'type' => 'string', + 'example' => 'SaveErrorData'."\n", + ], + 'ErrorDataFilter' => [ + 'description' => '如果是自定义SQL规则，需要用户指定SQL来过滤问题数据。', + 'type' => 'string', + 'example' => 'SELECT * FROM tb_api_log WHERE id IS NULL'."\n", + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"691CA452-D37A-4ED0-****\\",\\n \\"DataQualityRule\\": {\\n \\"Id\\": 16033,\\n \\"Name\\": \\"The table cannot be empty.\\\\n\\",\\n \\"ProjectId\\": 1948,\\n \\"Enabled\\": true,\\n \\"Severity\\": \\"High\\",\\n \\"Description\\": \\"this is a odps _sql task\\\\n\\",\\n \\"Target\\": {\\n \\"Type\\": \\"Table\\",\\n \\"DatabaseType\\": \\"maxcompute\\",\\n \\"TableGuid\\": \\"odps.unit_test.tb_unit_test\\\\n\\",\\n \\"PartitionSpec\\": \\"ds=$[yyyymmdd-1]\\\\n\\"\\n },\\n \\"TemplateCode\\": \\"SYSTEM:table:table_count:fixed\\",\\n \\"SamplingConfig\\": {\\n \\"Metric\\": \\"Max\\",\\n \\"MetricParameters\\": \\"{ \\\\\\"Columns\\\\\\": [ \\\\\\"id\\\\\\", \\\\\\"name\\\\\\" ] , \\\\\\"SQL\\\\\\": \\\\\\"select count(1) from table;\\\\\\"}\\",\\n \\"SettingConfig\\": \\"SET odps.sql.udf.timeout=600s; \\\\nSET odps.sql.python.version=cp27;\\\\n\\",\\n \\"SamplingFilter\\": \\"id IS NULL\\\\n\\"\\n },\\n \\"CheckingConfig\\": {\\n \\"Type\\": \\"Fixed\\",\\n \\"ReferencedSamplesFilter\\": \\"{ \\\\\\"bizdate\\\\\\": [ \\\\\\"-1\\\\\\", \\\\\\"-7\\\\\\", \\\\\\"-1m\\\\\\" ] }\\\\n\\",\\n \\"Thresholds\\": {\\n \\"Expected\\": {\\n \\"Operator\\": \\">\\",\\n \\"Value\\": \\"100.0\\",\\n \\"Expression\\": \\"$checkValue <= 0.01\\"\\n },\\n \\"Warned\\": {\\n \\"Operator\\": \\">\\",\\n \\"Value\\": \\"100.0\\",\\n \\"Expression\\": \\"$checkValue > 0.01\\"\\n },\\n \\"Critical\\": {\\n \\"Operator\\": \\">\\",\\n \\"Value\\": \\"100.0\\",\\n \\"Expression\\": \\"$checkValue > 0.05\\"\\n }\\n }\\n },\\n \\"ErrorHandlers\\": [\\n {\\n \\"Type\\": \\"SaveErrorData\\\\n\\",\\n \\"ErrorDataFilter\\": \\"SELECT * FROM tb_api_log WHERE id IS NULL\\\\n\\"\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => '查询质量规则详情', + 'description' => '需要购买DataWorks基础版及以上版本才能使用', + 'extraInfo' => '规则模版Code列表：'."\n" + .'- 自定义SQL：SYSTEM:user_defined_sql'."\n" + ."\n" + .'- 表行数大于0：SYSTEM:table:table_count:fixed:0'."\n" + .'- 表行数，固定值：SYSTEM:table:table_count:fixed'."\n" + .'- 表行数，1天差值：SYSTEM:table:table_count_delta:fixed:1_bizdate'."\n" + .'- 表行数，上周期差值：SYSTEM:table:table_count_delta:fixed:latest_bizdate'."\n" + .'- 表行数，上周期波动率：SYSTEM:table:table_count:cycle:latest_bizdate'."\n" + .'- 表行数，7天平均值波动率：SYSTEM:table:table_count:avg:7_bizdate'."\n" + .'- 表行数，30天平均值波动率：SYSTEM:table:table_count:avg:1m_bizdate'."\n" + .'- 表行数，1天波动率：SYSTEM:table:table_count:flux:1_bizdate'."\n" + .'- 表行数，7天波动率：SYSTEM:table:table_count:flux:7_bizdate'."\n" + .'- 表行数，30天波动率：SYSTEM:table:table_count:flux:1m_bizdate'."\n" + .'- 表行数，1，7，30天波动率：SYSTEM:table:table_count:flux:1_7_1m_bizdate'."\n" + .'- 表行数，1，7，30天，本月1号，波动率：SYSTEM:table:table_count:flux:1_7_1m_1st_bizdate'."\n" + .'- 表行数，自定义范围：SYSTEM:table:count'."\n" + .'- 条件匹配占比，自定义范围：SYSTEM:table:count_percent'."\n" + ."\n" + .'- 平均值，1天波动率：SYSTEM:field:avg:cycle:1_bizdate'."\n" + .'- 平均值，1、7、30天波动率：SYSTEM:field:avg:flux:1_7_1m_bizdate'."\n" + .'- 平均值，自定义范围：SYSTEM:field:avg'."\n" + ."\n" + .'- 汇总值，1天波动率：SYSTEM:field:sum:cycle:1_bizdate'."\n" + .'- 汇总值，上周期波动率：SYSTEM:field:sum:cycle:latest_bizdate'."\n" + .'- 汇总值，1、7、30天波动率：SYSTEM:field:sum:flux:1_7_1m_bizdate'."\n" + .'- 汇总值，自定义范围：SYSTEM:field:sum'."\n" + ."\n" + .'- 最小值，1天波动率：SYSTEM:field:min:cycle:1_bizdate'."\n" + .'- 最小值，上周期波动率：SYSTEM:field:min:cycle:latest_bizdate'."\n" + .'- 最小值，1、7、30天波动率：SYSTEM:field:min:flux:1_7_1m_bizdate'."\n" + .'- 最小值，自定义范围：SYSTEM:field:min'."\n" + ."\n" + .'- 最大值，1天波动率：SYSTEM:field:max:cycle:1_bizdate'."\n" + .'- 最大值，上周期波动率：SYSTEM:field:max:cycle:latest_bizdate'."\n" + .'- 最大值，1、7、30天波动率：SYSTEM:field:max:flux:1_7_1m_bizdate'."\n" + .'- 最大值，自定义范围：SYSTEM:field:max'."\n" + ."\n" + .'- 空值记录数为0：SYSTEM:field:null_value:fixed:0'."\n" + .'- 空值个数，固定值：SYSTEM:field:null_value:fixed'."\n" + .'- 空值个数/总行数，固定值：SYSTEM:field:null_value_percent:fixed'."\n" + ."\n" + .'- 字段重复值为0：SYSTEM:field:duplicated_count:fixed:0'."\n" + .'- 重复值个数/总行数，固定值：SYSTEM:field:duplicated_percent:fixed'."\n" + .'- 重复值个数，固定值：YSTEM:field:duplicated_count:fixed'."\n" + .'- 多字段重复值为0：SYSTEM:fields:duplicated_count:fixed:0'."\n" + ."\n" + .'- 离散值（状态值），固定值：SYSTEM:field:all_discrete_count:fixed'."\n" + .'- 离散值（分组个数及状态值），1、7、30天波动率：SYSTEM:field:all_discrete_metrics:fluxdiscrete:1_7_1m_bizdate'."\n" + .'- 离散值（分组个数），固定值：SYSTEM:field:discrete_group_count:fixed'."\n" + .'- 离散值（分组个数），1天波动率：SYSTEM:field:discrete_group_count:cycle:latest_bizdate'."\n" + ."\n" + .'- 表大小，固定值：SYSTEM:table:table_size:fixed'."\n" + .'- 表大小，上周期差值：SYSTEM:table:table_size_delta:fixed:latest_bizdate'."\n" + .'- 表大小，相比1天前差值（字节）：SYSTEM:table:table_size_delta:fixed:1_bizdate'."\n" + .'- 表大小，1天波动率：SYSTEM:table:table_size:flux:1_bizdate'."\n" + .'- 表大小，7天波动率：SYSTEM:table:table_size:flux:7_bizdate'."\n" + .'- 表大小，30天波动率：SYSTEM:table:table_size:flux:1m_bizdate'."\n" + ."\n" + .'- 唯一值个数，固定值：SYSTEM:field:count_distinct:fixed'."\n" + .'- 唯一值个数，1、7、30天波动率：SYSTEM:field:count_distinct:flux:1_7_1m_bizdate'."\n" + .'- 唯一值个数/总行数，固定值：SYSTEM:field:count_distinct_percent:fixed'."\n" + ."\n" + .'- 表行数，动态阈值：SYSTEM:table:table_count:dynamic_threshold'."\n" + .'- 汇总值，动态阈值：SYSTEM:field:sum:dynamic_threshold'."\n" + .'- 平均值，动态阈值：SYSTEM:field:avg:dynamic_threshold'."\n" + .'- 最大值，动态阈值：SYSTEM:field:max:dynamic_threshold'."\n" + .'- 最小值，动态阈值：SYSTEM:field:min:dynamic_threshold'."\n" + .'- 唯一值率动态阈值：SYSTEM:table:table_size:dynamic_threshold'."\n" + .'- 唯一值个数，动态阈值：SYSTEM:table:distinct_count:dynamic_threshold'."\n" + .'- 离散值（分组个数），动态阈值：SYSTEM:field:avg:dynamic_threshold'."\n" + .'- 离散值（状态值），动态阈值：SYSTEM:field:sum:dynamic_threshold'."\n" + .'- 离散值（分组个数），动态阈值：SYSTEM:field:discrete_group_count:dynamic_threshold'."\n" + .'- 离散值（状态值），动态阈值：SYSTEM:field:discrete_value_count:dynamic_threshold', + ], + 'ListDataQualityRuleTemplates' => [ + 'summary' => '查询质量规则模版列表。', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'abilityTreeCode' => '259074', + 'abilityTreeNodes' => [ + 'FEATUREdideRGVRPF', + ], + ], + 'parameters' => [ + [ + 'name' => 'ProjectId', + 'in' => 'query', + 'schema' => [ + 'description' => 'DataWorks工作空间ID', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + 'example' => '10000', + ], + ], + [ + 'name' => 'CreationSource', + 'in' => 'query', + 'schema' => [ + 'description' => '规则模板的创建来源，必填。'."\n" + .'- System：系统模板'."\n" + .'- UserDefined：用户自定义模板', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'System'."\n", + ], + ], + [ + 'name' => 'DirectoryPath', + 'in' => 'query', + 'schema' => [ + 'description' => '自定义模板被存放的类目目录，斜线/分隔层级。每个层级名称最长1024个字符，由不能包含空白字符、不能包含反斜线', + 'type' => 'string', + 'required' => false, + 'example' => '/ods/order_data', + ], + ], + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => [ + 'description' => '模板规则名称模糊匹配，如果是系统模板，则会根据语言模糊匹配系统模板的国际化名称', + 'type' => 'string', + 'required' => false, + 'example' => 'Table rows', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '列表分页查询页大小，默认为10', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'docRequired' => true, + 'minimum' => '1', + 'example' => '10', + 'default' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '列表分页查询页码，默认为1', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'docRequired' => true, + 'maximum' => '200', + 'minimum' => '1', + 'example' => '1', + 'default' => '10', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '返回值', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'API请求ID', + 'type' => 'string', + 'example' => '691CA452-D37A-****', + ], + 'PagingInfo' => [ + 'description' => '质量规则模版分页查询结果', + 'type' => 'object', + 'properties' => [ + 'TotalCount' => [ + 'description' => '总条数', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '42', + ], + 'PageSize' => [ + 'description' => '页大小', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'PageNumber' => [ + 'description' => '页码', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'DataQualityRuleTemplates' => [ + 'description' => '规则模版列表', + 'type' => 'array', + 'items' => [ + 'description' => '规则模版详情', + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '规则模版Code', + 'type' => 'string', + 'example' => 'USER_DEFINED:123', + ], + 'Name' => [ + 'description' => '规则模板名称，数字、英文字母、汉字、半角全角标点符号组合，最长512个字符', + 'type' => 'string', + 'example' => 'Table row Count Verification'."\n", + ], + 'ProjectId' => [ + 'description' => 'DataWorks工作空间ID', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2043', + ], + 'SamplingConfig' => [ + 'description' => '样本采集所需的设置', + 'type' => 'object', + 'properties' => [ + 'Metric' => [ + 'description' => '采样的指标名称'."\n" + .'- Count：表行数'."\n" + .'- Min：字段最小值'."\n" + .'- Max：字段最大值'."\n" + .'- Avg：字段均值'."\n" + .'- DistinctCount：字段唯一值个数'."\n" + .'- DistinctPercent：字段唯一值个数与数据行数占比'."\n" + .'- DuplicatedCount：字段重复值个数'."\n" + .'- DuplicatedPercent：字段重复值个数与数据行数占比'."\n" + .'- TableSize：表大小'."\n" + .'- NullValueCount：字段为空的行数'."\n" + .'- NullValuePercent：字段为空的比例'."\n" + .'- GroupCount：按字段值聚合后每个值与对应的数据行数'."\n" + .'- CountNotIn：枚举值不匹配行数'."\n" + .'- CountDistinctNotIn：枚举值不匹配唯一值个数'."\n" + .'- UserDefinedSql：通过自定义SQL做样本采集', + 'type' => 'string', + 'example' => 'Max', + ], + 'MetricParameters' => [ + 'description' => '样本采集时，所需的参数', + 'type' => 'string', + 'example' => '{"Sql": "select count(1) from table;"}'."\n", + ], + 'SettingConfig' => [ + 'description' => '具体执行采样语句前，插入执行的一些运行时参数设置语句，最长1000个字符。目前只支持MaxCompute', + 'type' => 'string', + 'example' => 'SET odps.sql.udf.timeout=600s; '."\n" + .'SET odps.sql.python.version=cp27;'."\n", + ], + ], + ], + 'CheckingConfig' => [ + 'description' => '样本校验设置', + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'description' => '阈值计算方式'."\n" + .'- Fixed'."\n" + .'- Fluctation'."\n" + .'- FluctationDiscreate'."\n" + .'- Auto'."\n" + .'- Average'."\n" + .'- Variance', + 'type' => 'string', + 'example' => 'Fixed', + ], + 'ReferencedSamplesFilter' => [ + 'description' => '有些类型的阈值需要查询出一些参考样本，然后对参考样本的值进行汇总得出进行比较的阈值，这里使用一个表达式来表示参考样本的查询方式', + 'type' => 'string', + 'example' => '{ "bizdate": [ "-1", "-7", "-1m" ] }'."\n", + ], + ], + ], + 'VisibleScope' => [ + 'description' => '模板的可用范围：'."\n" + .'- Tenant：全租户都可用'."\n" + .'- Project：只在当前项目中可用', + 'type' => 'string', + 'example' => 'Project', + ], + 'DirectoryPath' => [ + 'description' => '自定义模板被存放的类目目录，斜线分隔层级。每个层级名称最长1024个字符，由不能包含空白字符、不能包含斜线', + 'type' => 'string', + 'example' => '/ods/order_data', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"691CA452-D37A-****\\",\\n \\"PagingInfo\\": {\\n \\"TotalCount\\": 42,\\n \\"PageSize\\": 10,\\n \\"PageNumber\\": 1,\\n \\"DataQualityRuleTemplates\\": [\\n {\\n \\"Code\\": \\"USER_DEFINED:123\\",\\n \\"Name\\": \\"Table row Count Verification\\\\n\\",\\n \\"ProjectId\\": 2043,\\n \\"SamplingConfig\\": {\\n \\"Metric\\": \\"Max\\",\\n \\"MetricParameters\\": \\"{\\\\\\"Sql\\\\\\": \\\\\\"select count(1) from table;\\\\\\"}\\\\n\\",\\n \\"SettingConfig\\": \\"SET odps.sql.udf.timeout=600s; \\\\nSET odps.sql.python.version=cp27;\\\\n\\"\\n },\\n \\"CheckingConfig\\": {\\n \\"Type\\": \\"Fixed\\",\\n \\"ReferencedSamplesFilter\\": \\"{ \\\\\\"bizdate\\\\\\": [ \\\\\\"-1\\\\\\", \\\\\\"-7\\\\\\", \\\\\\"-1m\\\\\\" ] }\\\\n\\"\\n },\\n \\"VisibleScope\\": \\"Project\\",\\n \\"DirectoryPath\\": \\"/ods/order_data\\"\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => '查询质量规则模版列表', + 'description' => '需要购买DataWorks基础版及以上版本才能使用', + ], + ], + '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', + ], + ], +]; |