华为云用户手册

请求 请求样例 GET https://aissowulanalpha.inhuawei.com/dataset/softcomai/datalake/v1.0/datasets/admin?dirUrl=3343759697104414348&pageNum=1&pageSize=10 参数说明 参数名 是否必选 参数类型 备注 dirUrl 是 String 目录ID组成的字符串或目录的ID。 pageNum 否 int 分页用到的起始页。 pageSize 否 int 每页数据条数。

响应 响应样例 {"success": true,"returnData":{"page":{"currentPageNum": 1,"lastPageNum": 1,"totalPageNum": 1,"startRowIndex": 0,"gotoPageNum": 0,"pageSize": 10,"recordCount": 5},"dataList": [{"id": "7393318883446249187","name": "NEWdata1","businessName": "NEWdata1","scheme": "","url": "233354352536725172--3343759697104414348--4832665986944823199","datasetType": "HDFS","comment": "产品子域/网元覆盖：ATS， CS C，CG，ENS，DNS，HSS，SBC，MSC，MGW，UGW，UIM，UEIR，TGW，SPSV3，UPCC，USN共16种IMS网元类型；覆盖告警类别：communication、quality_of_servicesecurity_or_mech_violation、Software system等共8+种时域覆盖：2018.05到2018.06","syncSampleData": "false","source": "402880a76e91e909016ec99a88f55899","dataAmount": "","secretLevel": "15","secretLevelShow": "绝密","expireDate": "2022-12-14 23:59:59","publishRange":{"userRangeList": [],"tenantRangeList": []},"appendMetadata": "{}","dataFrom": "DG","classCode": "TABLE","timeLimit": "2000/02/01~2099/12/31","subscriptionFlag": "0","addCartFlag": "0","timeLimitAuto": false,"subscriptionCounts": 0,"downloadCounts": 0,"viewCounts": 0,"dataTags": ""}} 要素说明 参数名 参数类型 备注 success string 请求是否成功。 returnData JSON 返回体。 page JSON 分页信息。 dataList JSON 数据集列表。 id String 数据集ID。 name String 数据集名称。 businessName String 数据集名称。 scheme String 模式，暂无用。 url String 由目录ID组成的从树根部到节点目录的路径字符串。 datasetType String 数据集数据存储类型。 comment String 数据集备注信息。 source String 数据集来源。 dataAmount String 数据量。 secretLevel String 密级等级。 secretLevelShow String 密级等级，用于显示。 expireDate String 到期时间。 publishRange String 发布范围。 appendMetadata String 扩展字段。 dataFrom String 数据来源。 timeLimit String 时域。 subscriptionFlag String 是否订阅，取值包括如下： 0：代表没有订阅。 1：代表已经订阅。 2：代表申请中。 addCartFlag String 是否已加入购物车，取值包括如下： 0：代表已加入购物车。 1：代表没有加入购物车。 subscriptionCounts Int 订阅量。 downloadCounts Int 下载量。 viewCounts Int 查看量。

响应 响应样例 { "status": "Success", "outputPath": "/opt/data/tie_output_190402021111", "errorInfo": null, "resultinfo": [ { "status": "SUC CES S", "inputFilePath": "\"/opt/data/tie_input_190402021111/NEData_9-11132_11132-常州文化宫-O.txt\"", "notes": "\"\"" }, { "status": "SUCCESS", "inputFilePath": "\"/opt/data/tie_input_190402021111/NEPort_9-11026_11026-芜湖微波楼-R.txt\"", "notes": "\"\"" }, { "status": "SUCCESS", "inputFilePath": "\"/opt/data/tie_input_190402021111/NEPort_9-11108_11108-黄冈武穴城西-O.txt\"", "notes": "\"\""}], "resultFileName": "wer/tieresult/tie_output_190402021111"} 要素说明 参数名 参数类型 备注 status String 响应状态，取值包括Success和Failed。 outputPath String 临时文件的输出路径。 errorInfo String 错误信息。 resultinfo String 结果信息。 resultFileName String OBS中结果文件的路径。

响应 响应样例 { "success": true, "returnData": { "tenantCount": 1, "activeUserCount": 0, "loginUserDetail": [ { "tenantId": "b75b2a8b76be47b884d56dc17cfcd8c9", "tenantName": "SoftComAI_wl_0123456789", "users": [ { "userId": "04f6fe7b5880d3291fa4c0135bde0e4c", "userName": "test01", "count": "7" } ] }, { "tenantId": "b75b2a8b76be47b884d56dc17cfcd8c9", "tenantName": "SoftComAI_wl_0123456789", "users": [ { "userId": "04f6fe7b5880d3291fa4c0135bde0e4c", "userName": "test01", "count": "7" } ] } ] }} 要素说明 参数名 参数类型 备注 success String 请求是否成功。 returnData Json 返回统计结果。 tenantCount int 登录的租户数。 loginUserDetail Json 登录用户详情。 activeUserCount int 活跃用户数。 tenantId String 登录租户ID。 tenantName String 登录租户名称。 users Json 登录用户详情。 userId String 登录用户ID。 userName String 登录用户名。 count int 用户登录次数。

请求 请求样例 GET https://ipaddr:port/dataset/softcomai/datalake/north/v1.0/statics/users?starttime=20100430000000&endtime=20190930000000 参数说明 参数名 是否必选 参数类型 备注 starttime 是 String 统计周期的开始时间。 endtime 是 String 统计周期的结束时间。

响应 响应样例 [{"id":"1a06a1ddeee7108d9e005d04d4ea1343","name":"WDMTrail","metadata":[{"name":"Product Family","value":""},{"name":"Vendor","value":""},{"name":"Equipment Model","value":""},{"name":"Software Version","value":""},{"name":"Data Type","value":""},{"name":"Output Table Name","value":""},{"name":"Description","value":""}],"lastUpdated":"20181217110739","modelFlag":"1"},{"id":"2c6634c7e2edc7acbb1e2deaddd56b09","name":"wdmtrailgroup","metadata":[{"name":"Product Family","value":""},{"name":"Vendor","value":""},{"name":"Equipment Model","value":""},{"name":"Software Version","value":""},{"name":"Data Type","value":""},{"name":"Output Table Name","value":""},{"name":"Description","value":""}],"lastUpdated":"20181217110113","modelFlag":"1"},{"id":"3a332b151d5f663e65e12e1d3bd195c3","name":"BdFullName","metadata":[{"name":"Product Family","value":""},{"name":"Vendor","value":""},{"name":"Equipment Model","value":""},{"name":"Software Version","value":""},{"name":"Data Type","value":""},{"name":"Output Table Name","value":""},{"name":"Description","value":""}],"lastUpdated":"20181217110113","modelFlag":"1"},{"id":"f1d18def760b25d97a2eb6bc4316fb75","name":"StatisticsModel","metadata":[{"name":"Product Family","value":""},{"name":"Vendor","value":""},{"name":"Equipment Model","value":""},{"name":"Software Version","value":""},{"name":"Data Type","value":""},{"name":"Output Table Name","value":""},{"name":"Description","value":"Model for statistics"}],"lastUpdated":"20180608164155","modelFlag":"1"}]

请求 请求样例 GET https://ip:port/softcomai/datalake/collection/v1.0/collector/authorize/record?collectorId=Collector-6efeda5c&pageNum=1&pageSize=10&operateType=all&conditional=xa 参数说明 参数 是否必选 参数类型 备注 collectorId 是 String 采集机ID。 pageNum 是 String 页码。 pageSize 是 String 每页条数。 conditional 否 String 搜索条件。 operateType 是 String 类别：全部、授权、取消授权。

响应 响应样例 {"success": true,"returnData": {"page": {"currentPageNum": 1,"lastPageNum": 2,"totalPageNum": 2,"startRowIndex": 0,"gotoPageNum": 0,"pageSize": 10,"recordCount": 18},"dataList": [{"id": "239","collectorId": "Collector-a7932e65","tenantId": "062c243ee700d3cb0f72c00b26e71b00","tenantName": "SoftCom_AIMarket_test_001","operateType": "authorize","operateTime": "2021-02-20 11:04:36","userName": "xxxx"}]}} 要素说明 参数名 参数类型 备注 success Boolean 请求是否成功。 returnData Object 返回值。 page Object 分页信息。具体参数说明请参见表1。 dataList list 采集机列表。具体参数说明请参见表2。 表1 page参数说明 参数名 参数类型 备注 currentPageNum Int 当前页数。 lastPageNum Int 最后一页页数。 totalPageNum Int 总页数。 startRowIndex Int 起始页数。 gotoPageNum Int 当前页数。 pageSize Int 每页总条数。 recordCount Int 总记录数。 表2 dataList参数说明 参数名 参数类型 备注 id String ID。 collectorId String 采集机ID。 tenantId String 租户ID。 tenantName String 租户名称。 operateType String 操作类型。 operateTime String 操作时间。 userName String 用户名。

请求 请求样例 PUT https://127.0.0.1:5555/softcomai/datalake/dataplan/v1.0/catalogs[{"nodeId":"2443016954893272295","nodeName" : "云核心网修改后","parentNodeId" : "0","secretLevel" : "1","description" : "云核心网","businessType" : "MODEL"}] 参数说明 参数名 是否必选 参数类型 备注 nodeId 是 String 目录ID。 nodeName 是 String 目录名称。 parentNodeId 是 String 父目录ID。 secretLevel 是 String 密级。 description 是 String 描述。 businessType 是 String 业务类型，取值包括MODEL和PACKAGE。

Token认证 当您使用Token认证方式完成认证鉴权时，需要获取用户Token并在调用接口时增加“X-Auth-Token”到业务接口请求消息头中。 向“https:// IAM 的Endpoint/v3/auth/tokens”的URL中发送POST请求。 （IAM的Endpoint及POST请求消息体中的区 域名 称，请参见地区和终端节点中的“ 统一身份认证 服务 IAM”表格。区域名称如“华北-北京四”可在右上角账号左侧查看，对应Endpoint如“iam.cn-north-4.myhuaweicloud.com”，则对应获取token的URL为“https://iam.cn-north-4.myhuaweicloud.com/v3/auth/tokens”） 当服务区域名称为“所有”时，选择IAM“华北-北京一”的Endpoint。 请求内容示例如下： 下面示例代码中的斜体字需要替换为实际内容，详情请参考《统一身份认证服务API参考》。 { "auth": { "identity": { "methods": [ "password" ], "password": { "user": { "name": "username", "password": "password", "domain": { "name": "username" } } } }, "scope": { "project": { "name": "cn-north-4" //假设项目名称是"cn-north-4" } } } } 获取Token 。向上述URL中发送请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。 调用业务接口，在请求消息头中增加“X-Auth-Token”，“X-Auth-Token”的取值为步骤2中获取的Token。

响应 响应样例 {"success": true,"returnData": [{"id": "5515793131167029034","businessName": "eSight","statisticsCount": 2,"isVisiable": "1"},{"id": "8570469169411859849","businessName": "iMesh网络数据","statisticsCount": 2,"isVisiable": "1"},{"id": "6670303835585354768","businessName": "eSpace","statisticsCount": 2,"isVisiable": "1"},{"id": "2874007212131791399","businessName": "光纤数据","statisticsCount": 2,"isVisiable": "1"},{"id": "6662618999431869772","businessName": "5G流量监测","statisticsCount": 1,"isVisiable": "1"}]} 要素说明 参数名 参数类型 备注 success String 请求是否成功。 returnData Json 返回响应体。 id String 数据集ID。 businessName String 数据集名称。 statisticsCount int 订阅量。 isVisiable String 数据集是否对当前用户可视。

响应 响应样例 {"success" : true,"returnData" : [{"id" : "1","resourceId" : "1816033749546839721","resourceName" : "hdfs测试数据","resourceType" : "DATASET","createTime" : "2019-04-08 16:25:16","userId" : "SoftcomAI_Integration_per3__0123456789","tenantId" : "SoftcomAI_Integration_per3__0123456789","notificationType" : "EXPIRY_VISUAL_PERMISSION_NOTIFICATION","notificationContent" : "{" id ":2," userId ":" SoftcomAI_Integration_per3__0123456789 "," resources ":" 1816033749546839721 "," resourceType ":" DATASET "," createDate ":" 2019 - 04 - 04 14 : 32 : 23 "," expireDate ":" 2019 - 04 - 04 23 : 59 : 59 "," policyAction ":" VIEW "}"}]} 要素说明 参数名 参数类型 备注 success String 请求是否成功。 returnData JSON 返回体。 id String 通知记录的ID。 resourceId String 资源ID。 resourceName String 资源名称。 resourceType String 资源类型。 createTime String 创建时间。 userId String 用户ID。 tenantId String 租户ID。 notificationType String 通知类型。 notificationContent String 通知内容。

响应 响应样例 {"errorCode": 0,"errorDescription": null,"id": null,"totalProcess": 0,"description": null,"jobId": null,"status": null,"resObj": {"createTime": "2020-03-14T07:21:35.000+00:00","modifyOper": null,"modifyTime": null,"owner": "fuqiang","createOper": "06179cf4c080d5bb1faac0035a6a3650","ldmEntityAttributes": [{"attrId": "dr-8918b672b635445dae9806d631600e75","attrName": "采集间隔","attrDesc": null,"attrTag": null,"dataType": "AIINT","dataLen": null,"dataPrec": 0,"notNull": "0","sn": 1,"entityId": "dr-14e56f673fab438485c5bf5956d8ffea","tenantId": "051fb6d19780d5312f41c003c7e7258d","projectId": null,"dclId": "3","dclCode": null,"dslId": null,"dslCode": null,"extInfo": null,"status": "1","pk": "0","attrCode": "duration"}],"ldmEntityRelations": [],"ldmSource": null,"entityId": "dr-14e56f673fab438485c5bf5956d8ffea","status": "1","origin": "DM","extInfo": null,"classCode": "TABLE","classId": "01","businessName": "ATS-数据准备联调","entityName": "ats_kpi_label","entityDesc": "水","entityTag": null,"entityType": "01","sn": 0,"dclCode": null,"dclId": "3","projectId": null,"tenantId": "051fb6d19780d5312f41c003c7e7258d","layerId": "dr-761deda7c97b4595af680b802c1cca5c","verNo": "1.0","parentEntity": null,"hasPhysical": "1","absoluteDirectory": "DataModeling/数据准备/","notUpdatePdm": false,"pdmNum": 2,"physicalEntities": [{"createTime": "2020-03-14T07:21:35.000+00:00","modifyOper": "06179cf4c080d5bb1faac0035a6a3650","modifyTime": "2020-03-14T07:21:36.000+00:00","owner": null,"createOper": "06179cf4c080d5bb1faac0035a6a3650","pdmId": "dr-fd47d2f9b4014a0e98119d51b96b5f59","entityId": "dr-14e56f673fab438485c5bf5956d8ffea","status": "1","sn": 0,"extInfo": null,"cyclePrefix": null,"partitionCfg": null,"cycleType": null,"cycleField": null,"cycleFormat": null,"saveCycle": null,"dbSchema": "dws_softcomai_z00284297_03_rt1xj9ia","dbName": "dws_softcomai_z00284297_03_rt1xj9ia","dsName": null,"dsType": "DWS","dsId": "dwsbcfdb26808864f96af08bad6231b466c","saveType": "0","pdmDesc": null,"pdmName": "ats_kpi_label","connectionInfo": null,"pdmAttrs": null,"pdmTables": null,"pdmParams": null}]},"additionalObj": null} 要素说明 参数名 参数类型 备注 errorCode int 响应码。 resObj JSON 返回体。 status String 状态。 jobId String 任务id。

请求 请求样例 POST https://ipaddr:port/softcomai/datalake/v1.0/dataplan/backup/restore/result{"backupId": "20201225200000006","service": "datapermission","restoreInfo": {"aitrainalpha_wulan3_test4": "文件读取异常"},"restoreId": "20201230152018_761855303"} 参数说明 参数名 是否必选 参数类型 备注 backupId 是 String 备份ID。 service 是 String 服务名称。 restoreId 是 String 恢复ID。 restoreInfo 是 Map 上报详情。

请求 请求样例 {"agreementType": "sftp","collectorId": "Collector-883c0575","collectTaskType": "dataplan","probePackageName": "Probe_NAIE_SFTP_Common_V200R020C50SPC401.zip","protocolBody": {"host": "xx.xx.xx.xx","port": "22","userName": "root","password": "fd","localhost": "xx.xx.xx.xx"}} 参数说明 参数名 是否必选 参数类型 备注 probePackageName 是 String 探针包名称。 agreementType 是 String 协议类型（SFTP/FTPS）。 collectTaskType 是 String 创建采集任务方式（appmarket/dataplan/ consoleServer）。 collectorId 是 String 采集机ID。 protocolBody.host 否 String 主机IP。 protocolBody.port 否 String 端口。 protocolBody.userName 否 String 用户名。 protocolBody.password 否 String 密码。 protocolBody.localHost 否 String 采集机小网IP。

响应 响应样例 { "success": true, "returnData": { "page": { "currentPageNum": 1, "lastPageNum": 1, "totalPageNum": 1, "startRowIndex": 0, "gotoPageNum": 0, "pageSize": 8, "recordCount": 2 }, "dataList": [ { "id": "1720ca2033c948558c28d635d6665fd9", "filePath": "bucket-hvnngyjf/DataAssets/PLDA/Collection/LocalUpload/4f70889e-f6be-8db7-13cb-db7766a7f63e/data", "fileName": "src95156873436249665.sql", "fileSize": "3", "operTime": "2021-07-07 09:34:05", "operUser": "pengfeifei", "fullFileName": "DataAssets/PLDA/Collection/LocalUpload/4f70889e-f6be-8db7-13cb-db7766a7f63e/data", "bucketName": "bucket-hvnngyjf" }, { "id": "0d75865c11e544edb8087412b7a12505", "filePath": "bucket-hvnngyjf/DataAssets/PLDA/Collection/LocalUpload/4f70889e-f6be-8db7-13cb-db7766a7f63e/data", "fileName": "src95539275414385437.sql", "fileSize": "3", "operTime": "2021-07-07 09:34:05", "operUser": "pengfeifei", "fullFileName": "DataAssets/PLDA/Collection/LocalUpload/4f70889e-f6be-8db7-13cb-db7766a7f63e/data", "bucketName": "bucket-hvnngyjf" } ] }} 要素说明 参数名 参数类型 备注 success Boolean 请求是否成功。 returnData Object 返回值。 page Object 分页信息。具体参数说明请参见表1。 dataList list 采集机列表。具体参数说明请参见表2。 表1 page参数说明 参数名 参数类型 备注 currentPageNum Int 当前页数。 lastPageNum Int 最后一页页数。 totalPageNum Int 总页数。 startRowIndex Int 起始页数。 gotoPageNum Int 当前页数。 pageSize Int 每页总条数。 recordCount Int 总记录数。 表2 dataList参数说明 参数名 参数类型 备注 id String ID。 filePath String 文件OBS路径。 fileName String 文件名。 fileSize String 文件大小。 operTime String 操作时间。 operUser String 操作用户。 fullFileName String 文件全路径。 bucketName String 桶名。

请求 请求样例 GET https://ip:port/softcomai/datalake/collection/v1.0/upload/records?pageNum=1&pageSize=8&conditional=665&taskId=490e70277c06402a9f078de3a54d8453 参数说明 参数名 是否必选 参数类型 备注 pageNum 是 Int 当前页数。 pageSize 是 Int 每页条数。 taskId 是 String 任务ID。 conditional 否 String 搜索条件。

请求 请求样例 GET https://ip:port/softcomai/datalake/collection/v1.0/collectorPackage/cancelUpload?guid=f20d67ca-aacb-6247-f210-542021fd4b0e&packageName=NAIE_Collector_20.5.3_Linux_x64.tar.gz 参数说明 参数名 是否必选 参数类型 备注 guid 是 String 唯一标识。 packageName 是 String 探针包名称。

响应 响应样例 { "success": true, "errorMsg": null, "errorCode": null, "returnData": { "obsInfo": [ { "ipAdress": "111.111.11.11", "bucketName": "obs-collector", "obsPath": "34-dfd3d-fdfd-34322-dfd/data/IPAddr/opt/test/log" } ] }} 要素说明 参数名 参数类型 备注 success String 请求是否成功，取值包括true和false。 returnData JSON 返回值。 obsInfo List obs信息列表。 ipAdress String Ip地址。 bucketName String obs桶名称。 obsPath String obs路径。

响应 响应样例 {"success": true,"returnData": [{"probePackageId": "IT-Huawei-PMV1R1C1-sftp-Object-V1_0","probePackageProtocol": "sftp","probePackageName": "IT-Huawei-PMV1R1C1-sftp-Object-V1_0"}]} 要素说明 参数名 参数类型 备注 success Boolean 请求是否成功。 returnData Object 返回值。 probePackageId String 探针包ID。 probePackageProtocol String 探针协议。 probePackageName String 探针包名称。

请求 请求样例 {"fileName": "src95156873436249665.sql,src107493942692936010.sql","filePath": "DataAssets/PLDA/Collection/LocalUpload/1ab50e7c-b505-12bf-6e01-4bc78d460e94","fileSize": "3,3","fullFileName": "/src95156873436249665.sql,/src107493942692936010.sql","progressId": "","serviceName": "dataCatalog","uploadTime": 1625620343197,"usedTime": 725} 参数说明 参数名 是否必填 参数类型 备注 fileName 是 String 文件名，逗号隔开。 filePath 是 String OBS路径。 fileSize 是 String 文件大小，逗号隔开。 fullFileName 是 String 文件全路径。 progressId 否 String 流程ID。 serviceName 是 String 服务名称。 uploadTime 是 long 上传开始时间。 usedTime 是 long 上传耗时。

请求 请求样例 https://ip:port/softcomai/datalake/collection/v1.0/task/progress/id/del{"taskId": "1b12e30e1b3c404fb58ae888817754f0","progressId": "P_20200901155638_1265840513"} 参数说明 参数名 是否必选 参数类型 备注 taskId 是 String 任务ID。 progressId 是 String 流程ID。

URI URI格式 GET /softcomai/datalake/dataplan/v1.0/tasks/other/builtIntTask?builtInType={builtInType}&version={version}&taskType={taskType}&taskName={taskName} 参数说明 参数名 是否必选 参数类型 备注 builtInType 是 String 内置任务类型。 version 否 String 内置任务版本。 taskType 是 String 任务类型。 taskName 否 String 任务名称。

响应 响应样例 { "success": true, "returnData": { "id": "2614838683092764438", "source": "0", "taskName": "数据生成-DCPUE", "taskType": "GOVERN_BUILTIN", "builtInTaskType": "OTHER", "executeType": "SCRIPT", "executeMethod": "GET", "isKeyTask": "true", "isStautsUrl": "false", "userId": "PUBLIC", "tenantId": "PUBLIC", "createTime": "2020-08-15 18:51:43", "updateTime": "2020-08-15 18:51:43", "timeout": "60", "script": { "id": "1322719977558854598", "source": "0", "scriptName": "数据生成-DCPUE", "scriptType": "GOVERN_BUILTIN", "executeType": "JAVA", "scriptVersion": "1.0", "bucketName": "obs-private-dataplan", "scriptDesc": "数据生成-DCPUE", "userId": "PUBLIC", "tenantId": "PUBLIC", "createTime": "2020-08-15 18:51:43", "builtIn": "true", "pluginName": "Dcpue-1.0.jar", "status": "none" }, "paramList": [ { "id": "8695504866585243646", "source": "0", "paramName": "string", "paramType": "GOVERN_BUILTIN", "paramValue": "-datasetName #{datasetName} -entityName #{entityName} -projectId #{projectId} -csvPath #{csvPath} -domainId #{tenantId} -serviceType dlunion -resourceType DWS -integrationAddr #{integrationAddr} -dataRightAddr #{dataRightAddr} -managementToken ${getManageToken} -tableInfo \"#{tableInfo}\" -registeredBody \"#{registeredBody}\" -appId \"#{tenantId}\" -csbUser \"#{csbUser}\"", "appendType": "STRING", "userId": "PUBLIC", "tenantId": "PUBLIC", "createTime": "2020-08-15 18:51:43", "newCreate": "false" } ], "variables": [ { "id": "5043999222353848289", "source": "0", "showName": "csvPath", "showNameEn": "csvPath", "varName": "csvPath", "varType": "GOVERN_BUILTIN", "varValue": "***", "defaultVisible": "true", "encrypt": "true", "userId": "PUBLIC", "tenantId": "PUBLIC", "createTime": "2020-08-15 18:51:43", "taskId": "2614838683092764438" }, { "id": "8058318528809115685", "source": "0", "showName": "datasetName", "showNameEn": "datasetName", "varName": "datasetName", "varType": "GOVERN_BUILTIN", "varValue": "免费制冷数据集1_20191219081908413", "defaultVisible": "true", "encrypt": "false", "userId": "PUBLIC", "tenantId": "PUBLIC", "createTime": "2020-08-15 18:51:43", "taskId": "2614838683092764438" }, { "id": "5613251304892404103", "source": "0", "showName": "entityName", "showNameEn": "entityName", "varName": "entityName", "varType": "GOVERN_BUILTIN", "varValue": "DCPUE_WORKING_CONDITION_1576743547", "defaultVisible": "true", "encrypt": "false", "userId": "PUBLIC", "tenantId": "PUBLIC", "createTime": "2020-08-15 18:51:43", "taskId": "2614838683092764438" } ], "commonTask": "true", "children": [], "isRoot": "false", "version": "1.0" }} 要素说明 参数名 参数类型 备注 success String 请求是否成功。 returnData JSON 返回体。 version String 版本号。 isRoot String 是否是根节点。 commonTask String 是否是通用任务。 children JSON 子目录列表。 id String 任务ID。 paramList List 任务执行参数。 variables List 任务变量列表。 script String 任务执行脚本。

请求 请求样例 GET https://ipaddr:port/softcomai/datalake/dataplan/v1.0/tasks/other/builtIntTask?builtInType=OTHER&taskType=GOVERN_BUILTIN 参数说明 参数名 是否必选 参数类型 备注 builtIntType 是 String 内置任务类型。 taskType 是 String 任务类型。

响应 响应样例 {"success": true,"returnData": {"id": "20190523144150-1830503420","name": "ProgressTest001","description": "描述信息XXXXXXXXXXXXXXXXXXXXXXXXX001","userId": "SoftcomAI_Integration_Test2__zWX611819","createTime": "2019-05-23 14:41:50","updateTime": "2019-05-23 14:41:50","tenantId": "SoftcomAI_Integration_Test2","tasks": [{"id": "4258844438632314052","taskName": "测试任务名称004","taskType": "TRAIN","isKeyTask": "true","userId": "SoftcomAI_Integration_Test2__zWX611819","pId": "0","rootTask": "false","createTime": "20190522153927","updateTime": "20190522153927","script": {"id": "script2324354356435345004","scriptName": "脚本script2324354356435345004","scriptType": "SCRIPTTYPR_IN","scriptPath": "/opt/script/script2324354356435345004.py","userId": "SoftcomAI_Integration_Test2__zWX611819","createTime": "20190522161002","updateTime": "20190522161002"},"paramList": [{"id": "6432775498551194298","paramName": "INPUT_PA RAM 007","paramType": "OUTPUT_TYPE","paramValue": "out.csv","appendType": "FILE_TYPE","userId": "SoftcomAI_Integration_Test2__zWX611819","createTime": "20190522153927","updateTime": "20190522153927","taskId": "4258844438632314052"},{"id": "5917907899477015159","paramName": "INPUT_PARAM008","paramType": "INPUT_TYPE","paramValue": "/etc/test/int.out","appendType": "FILE_TYPE","userId": "SoftcomAI_Integration_Test2__zWX611819","createTime": "20190522153927","updateTime": "20190522153927","taskId": "4258844438632314052"}],"children": [{"id": "2091445797804258129","taskName": "子任务004","taskType": "TRAIN","isKeyTask": "true","userId": "SoftcomAI_Integration_Test2__zWX611819","pId": "4258844438632314052","rootTask": "false","createTime": "20190522154312","updateTime": "20190522154312","script": {"id": "script2324354356435345008","scriptName": "脚本script2324354356435345008","scriptType": "SCRIPTTYPR_IN","scriptPath": "/opt/script/script2324354356435345008.py","userId": "SoftcomAI_Integration_Test2__zWX611819","createTime": "20190522161002","updateTime": "20190522161002"},"paramList": [{"id": "7604610060700585337","paramName": "INPUT_PARAM017","paramType": "OUTPUT_TYPE","paramValue": "out.csv","appendType": "FILE_TYPE","userId": "SoftcomAI_Integration_Test2__zWX611819","createTime": "20190522154312","updateTime": "20190522154312","taskId": "2091445797804258129"},{"id": "8740119706493809528","paramName": "INPUT_PARAM018","paramType": "INPUT_TYPE","paramValue": "/etc/test/int.out","appendType": "FILE_TYPE","userId": "SoftcomAI_Integration_Test2__zWX611819","createTime": "20190522154312","updateTime": "20190522154312","taskId": "2091445797804258129"}],"children": []}]},{"id": "3317274162378352800","taskName": "测试任务名称003","taskType": "GOVERN","isKeyTask": "true","userId": "SoftcomAI_Integration_Test2__zWX611819","pId": "0","rootTask": "false","createTime": "20190522153927","updateTime": "20190522153927","script": {"id": "script2324354356435345003","scriptName": "脚本script2324354356435345003","scriptType": "SCRIPTTYPR_IN","scriptPath": "/opt/script/script2324354356435345003.py","userId": "SoftcomAI_Integration_Test2__zWX611819","createTime": "20190522161002","updateTime": "20190522161002"},"paramList": [{"id": "6294244764980269948","paramName": "INPUT_PARAM005","paramType": "OUTPUT_TYPE","paramValue": "out.csv","appendType": "FILE_TYPE","userId": "SoftcomAI_Integration_Test2__zWX611819","createTime": "20190522153927","updateTime": "20190522153927","taskId": "3317274162378352800"},{"id": "5323026608543141080","paramName": "INPUT_PARAM006","paramType": "INPUT_TYPE","paramValue": "/etc/test/int.out","appendType": "FILE_TYPE","userId": "SoftcomAI_Integration_Test2__zWX611819","createTime": "20190522153927","updateTime": "20190522153927","taskId": "3317274162378352800"}],"children": [{"id": "3669835762462846233","taskName": "子任务003","taskType": "GOVERN","isKeyTask": "true","userId": "SoftcomAI_Integration_Test2__zWX611819","pId": "3317274162378352800","rootTask": "false","createTime": "20190522154312","updateTime": "20190522154312","script": {"id": "script2324354356435345007","scriptName": "脚本script2324354356435345007","scriptType": "SCRIPTTYPR_IN","scriptPath": "/opt/script/script2324354356435345007.py","userId": "SoftcomAI_Integration_Test2__zWX611819","createTime": "20190522161002","updateTime": "20190522161002"},"paramList": [{"id": "2259610438399225887","paramName": "INPUT_PARAM015","paramType": "OUTPUT_TYPE","paramValue": "out.csv","appendType": "FILE_TYPE","userId": "SoftcomAI_Integration_Test2__zWX611819","createTime": "20190522154312","updateTime": "20190522154312","taskId": "3669835762462846233"},{"id": "7945694693556717511","paramName": "INPUT_PARAM016","paramType": "INPUT_TYPE","paramValue": "/etc/test/int.out","appendType": "FILE_TYPE","userId": "SoftcomAI_Integration_Test2__zWX611819","createTime": "20190522154312","updateTime": "20190522154312","taskId": "3669835762462846233"}],"children": []}]},{"id": "3325435561206517112","taskName": "测试任务名称002","taskType": "PARSE","isKeyTask": "true","userId": "SoftcomAI_Integration_Test2__zWX611819","pId": "0","rootTask": "false","createTime": "20190522153927","updateTime": "20190522153927","script": {"id": "script2324354356435345002","scriptName": "脚本script2324354356435345002","scriptType": "SCRIPTTYPR_IN","scriptPath": "/opt/script/script2324354356435345002.py","userId": "SoftcomAI_Integration_Test2__zWX611819","createTime": "20190522161002","updateTime": "20190522161002"},"paramList": [{"id": "5842097471414196976","paramName": "INPUT_PARAM003","paramType": "OUTPUT_TYPE","paramValue": "out.csv","appendType": "FILE_TYPE","userId": "SoftcomAI_Integration_Test2__zWX611819","createTime": "20190522153927","updateTime": "20190522153927","taskId": "3325435561206517112"},{"id": "3927581714015490447","paramName": "INPUT_PARAM004","paramType": "INPUT_TYPE","paramValue": "/etc/test/int.out","appendType": "FILE_TYPE","userId": "SoftcomAI_Integration_Test2__zWX611819","createTime": "20190522153927","updateTime": "20190522153927","taskId": "3325435561206517112"}],"children": [{"id": "5760199023622570404","taskName": "子任务002","taskType": "PARSE","isKeyTask": "true","userId": "SoftcomAI_Integration_Test2__zWX611819","pId": "3325435561206517112","rootTask": "false","createTime": "20190522154312","updateTime": "20190522154312","script": {"id": "script2324354356435345006","scriptName": "脚本script2324354356435345006","scriptType": "SCRIPTTYPR_IN","scriptPath": "/opt/script/script2324354356435345006.py","userId": "SoftcomAI_Integration_Test2__zWX611819","createTime": "20190522161002","updateTime": "20190522161002"},"paramList": [{"id": "4523873133086498486","paramName": "INPUT_PARAM013","paramType": "OUTPUT_TYPE","paramValue": "out.csv","appendType": "FILE_TYPE","userId": "SoftcomAI_Integration_Test2__zWX611819","createTime": "20190522154312","updateTime": "20190522154312","taskId": "5760199023622570404"},{"id": "1630913167819950670","paramName": "INPUT_PARAM014","paramType": "INPUT_TYPE","paramValue": "/etc/test/int.out","appendType": "FILE_TYPE","userId": "SoftcomAI_Integration_Test2__zWX611819","createTime": "20190522154312","updateTime": "20190522154312","taskId": "5760199023622570404"}],"children": []}]},{"id": "1484601205474025496","taskName": "测试任务名称001","taskType": "COLLECTION","isKeyTask": "true","userId": "SoftcomAI_Integration_Test2__zWX611819","pId": "0","rootTask": "false","createTime": "20190522153704","updateTime": "20190522153704","script": {"id": "script2324354356435345001","scriptName": "脚本script2324354356435345001","scriptType": "SCRIPTTYPR_IN","scriptPath": "/opt/script/script2324354356435345001.py","userId": "SoftcomAI_Integration_Test2__zWX611819","createTime": "20190522161002","updateTime": "20190522161002"},"paramList": [{"id": "9213996011475149768","paramName": "INPUT_PARAM001","paramType": "OUTPUT_TYPE","paramValue": "out.csv","appendType": "FILE_TYPE","userId": "SoftcomAI_Integration_Test2__zWX611819","createTime": "20190522153704","updateTime": "20190522153704","taskId": "1484601205474025496"},{"id": "4442281474120796984","paramName": "INPUT_PARAM002","paramType": "INPUT_TYPE","paramValue": "/etc/test/int.out","appendType": "FILE_TYPE","userId": "SoftcomAI_Integration_Test2__zWX611819","createTime": "20190522153704","updateTime": "20190522153704","taskId": "1484601205474025496"}],"children": [{"id": "6834608124000610806","taskName": "子任务001","taskType": "COLLECTION","isKeyTask": "true","userId": "SoftcomAI_Integration_Test2__zWX611819","pId": "1484601205474025496","rootTask": "false","createTime": "20190522154312","updateTime": "20190522154312","script": {"id": "script2324354356435345005","scriptName": "脚本script2324354356435345005","scriptType": "SCRIPTTYPR_IN","scriptPath": "/opt/script/script2324354356435345005.py","userId": "SoftcomAI_Integration_Test2__zWX611819","createTime": "20190522161002","updateTime": "20190522161002"},"paramList": [{"id": "1520374751124746368","paramName": "INPUT_PARAM009","paramType": "OUTPUT_TYPE","paramValue": "out.csv","appendType": "FILE_TYPE","userId": "SoftcomAI_Integration_Test2__zWX611819","createTime": "20190522154312","updateTime": "20190522154312","taskId": "6834608124000610806"},{"id": "2251799634628698889","paramName": "INPUT_PARAM010","paramType": "INPUT_TYPE","paramValue": "/etc/test/int.out","appendType": "FILE_TYPE","userId": "SoftcomAI_Integration_Test2__zWX611819","createTime": "20190522154312","updateTime": "20190522154312","taskId": "6834608124000610806"}],"children": []}]}]}} 要素说明 参数名 参数类型 备注 success String 请求是否成功。 returnData JSON 返回体。 id String 项目ID。 name String 项目名称。 description String 项目描述。 createTime String 创建时间。 updateTime String 更新时间。 userId String 模式，暂无用。 tenantId String 由目录ID组成的从树根部到节点目录的路径字符串。 tasks JSONLIST 任务列表。 id （tasks） String 任务ID。 taskName String 任务名称。 taskType String 任务名称。 isKeyTask String 是否是关键任务。 pId String 任务的父ID。 rootTask String 是否是根任务。 createTime （tasks） String 创建时间。 updateTime （tasks） String 更新时间。 script JSON 脚本。 id (script) String 脚本ID。 scriptName (script) String 脚本名称。 scriptType (script) String 脚本类型。 scriptPath (script) String 脚本路径。 userId (script) String 用户信息。 createTime (script) String 脚本创建时间。 updateTime (script) String 脚本更新时间。 children String 任务的子任务。 paramList JSON 参数列表。 id (paramList) String 参数的ID。 paramName (paramList) String 参数名称。 paramType (paramList) String 参数类型。 paramValue (paramList) String 参数值。 appendType (paramList) JSON 参数扩展类型。

URI URI格式 GET /softcomai/datalake/dataplan/v1.0/progress?pageNum={pageNum}&pageSize={pageSize}&searchField={searchField}&searchStr={searchStr} 参数说明 参数名 是否必选 参数类型 备注 pageNum 否 int 分页用到的起始页。 pageSize 否 int 每页数据条数。 tag 否 String 标签。 searchField 否 String 当前只支持：ALL、name、description、tag、status，其他无效。 searchStr 否 String 搜索内容。

响应 响应样例 { "success": true, "returnData": { "page": { "currentPageNum": 1, "lastPageNum": 0, "totalPageNum": 0, "startRowIndex": 0, "gotoPageNum": 0, "pageSize": 5, "recordCount": 0 }, "dataList": [ { "id": "P_20191112165111_1419961511", "userId": "lWX617768", "tenantId": "aidomainalpha_wulan3_dcpuedev", "createTime": "2019-11-12 16:51:13", "updateTime": "2019-11-12 16:51:13", "status": "init", "progressType": "PROGRESS_GROUP", "tasks": [] }, { "id": "P_20191112165055_989850390", "name": "POSTMAN测试发布公共模板001", "description": "POSTMAN测试发布公共模板", "userId": "lWX617768", "tenantId": "aidomainalpha_wulan3_dcpuedev", "createTime": "2019-11-12 16:50:57", "updateTime": "2019-11-12 16:50:57", "status": "init", "fromSource": "P_20191112165055_989850390", "progressType": "PROGRESS", "tasks": [] } ] }} 要素说明 参数名 参数类型 备注 success string 请求是否成功。 returnData JSON 返回体。 page JSON 分页信息。 dataList JSON 项目列表。 id String 项目ID。 name String 项目名称。 description String 描述。 userId String 用户信息。 tenantId String 租户信息。 createTime String 创建时间。 updateTime String 更新时间。 status String 状态。 progressType String 项目的类型，取值包括PROGRESS_GROUP和PROGRESS。 tasks String 任务列表。

响应 响应样例 {"taskId": "460611638","status": "Done","startTime": "2019-11-04 06:40:57","endTime": "2019-11-04 06:42:00","information": "Task finished","retCode": "200","opFileNumber": 100,"opFileSize": 13.31,"tenant": "SoftComAI_wl_w00293514","user": "SoftComAI_wl_w00293514"} 要素说明 参数名 参数类型 备注 taskId String 任务ID。 status String 响应状态，取值包括：Doing、Done、Failed。 startTime String 解析开始时间。 endTime String 解析结束时间。 information String 结果信息。 retCode String 结果状态码。 opFileNumber int 解析文件数量。 opFileSize double 解析文件大小。 tenant String 租户。 user String 用户。

请求 请求样例 GET https://ipaddr:port/dataset/softcomai/datalake/v1.0/datasets/comment?datasetId=445688&commentLevel=5&pageNum=1&pageSize=6 参数说明 参数名 是否必选 参数类型 备注 datasetId 是 String 数据集ID。 commentLevel 否 Integer 评论等级，取值包括如下： 1：表示差评，代表1和2。 3：表示中评，代表3和4。 5：表示好评，代表5。 如果未设置，则返回该数据集下所有评论。 pageNum 是 Integer 页数。 pageSize 是 Integer 页面大小。