华为云用户手册

响应 响应样例 {"success" : true,"returnData" : {"page" : {"currentPageNum" : 0,"lastPageNum" : 1,"totalPageNum" : 1,"startRowIndex" : 0,"gotoPageNum" : 0,"pageSize" : 2,"recordCount" : 2},"dataList" : [{"id" : "1658940099067789417","name" : "SS_Report_Line_Description","businessName" : "事件性测量报表描述的内容","scheme" : "","url" : "402898ac6782434a016782db8ac1001d-402898ac672b54fd0167450accee005a-402898ac672b54fd016744f23fbb0050","datasetType" : "HIVE","comment" : "xxxxxx","source" : "402898ac6782434a01678323968b007e","dataAmount" : "","secretLevel" : "3","secretLevelShow" : "秘密","expireDate" : "2019-12-15","appendMetadata" : "{}"}, {"id" : "4271669953646277069","name" : "SS_Periodic_Measurment_Report","businessName" : "周期性测量报告","scheme" : "","url" : "402898ac6782434a016782db8ac1001d-402898ac672b54fd0167450accee005a-402898ac672b54fd016744f23fbb0050","datasetType" : "HIVE","comment" : "周期性测量报告dsssssssssssssssssssssssssfsf","source" : "402898ac6782434a016782e4940d0043","dataAmount" : "","secretLevel" : "3","secretLevelShow" : "秘密","expireDate" : "2021-12-24","appendMetadata" : "{}"}]}} 要素说明 参数名 参数类型 备注 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 扩展字段。

请求 请求样例 PUT https://aissowulanalpha.inhuawei.com/dataset/softcomai/datalake/v1.0/datasets[{"id": "6382142675778847936","expireDate": "2022-12-15 23:59:59","comment": "Christmas2修改","syncSampleData": "false","ownerContactList": [{"tenantId": "aitrainalpha_wulan3_test1","tenantName": "aitrainalpha_wulan3_test1","userId": "aitrainalpha_wulan3_test1__0123456789","userName": "0123456789","email": "***@huawei.com"}]}] 参数说明 表1 Body参数说明 参数名 是否必选 参数类型 备注 id 是 String 节点的ID。 expireDate 是 String 过期时间。 comment 是 String 描述信息。 syncSampleData 是 String 是否同步样例数据。 ownerContactList 否 JSON 联系人信息。 tenantId 否 String 租户ID。 tenantName 否 String 租户名称。 userId 否 String 用户ID。 userName 否 String 用户名称。 email 否 String 邮箱。

响应 响应样例 {"success": true,"errorMsg": null,"errorCode": null,"returnData": [{"id": "P_20200509151641_418408189","name": "FDI_20200509151627","description": null,"userId": "06179cf4c080d5bb1faac0035a6a3650","tenantId": "051fb6cf4c00d33d0f85c003b99352a0","tenantName": "softcomai_z00284297_03","projectId": "051fb6d19780d5312f41c003c7e7258d","scheduleCycle": null,"scheduleInterval": null,"scheduleBeginTime": null,"beginTime": null,"endTime": null,"createTime": "2020-05-09 15:16:42","updateTime": "2020-05-09 15:16:42","period": null,"status": "completed","schedulerStatus": null,"lastStartTime": "2020-05-12 19:49:44","lastEndTime": "2020-05-12 19:50:27","startUser": "061a1d780c00d3751f63c0030e17605a","tag": "DFP","tags": null,"fromSource": "P_20191214113112_204479854","driveStrategy": "dataSource","lastObsBucketName": null,"lastObsPath": null,"templateExtraInfoList": [],"subProgress": [],"progressType": "PROGRESS","tasks": []},{"id": "P_20200511190832_1663314393","name": "FDI_20200511190817","description": null,"userId": "06179cf4c080d5bb1faac0035a6a3650","tenantId": "051fb6cf4c00d33d0f85c003b99352a0","tenantName": "softcomai_z00284297_03","projectId": "051fb6d19780d5312f41c003c7e7258d","scheduleCycle": null,"scheduleInterval": null,"scheduleBeginTime": null,"beginTime": null,"endTime": null,"createTime": "2020-05-11 19:08:33","updateTime": "2020-05-11 19:08:33","period": null,"status": "failed","schedulerStatus": null,"lastStartTime": "2020-05-16 10:26:40","lastEndTime": "2020-05-16 10:27:59","startUser": "061a1d780c00d3751f63c0030e17605a","tag": "DFP","tags": null,"fromSource": "P_20191214113112_204479854","driveStrategy": "dataSource","lastObsBucketName": null,"lastObsPath": null,"templateExtraInfoList": [],"subProgress": [],"progressType": "PROGRESS","tasks": []}]} 要素说明 参数名 参数类型 备注 success Boolean 请求是否成功，取值包括true和false。 returnData JSON 模板信息。

响应 响应样例 {"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 参数扩展类型。

请求 请求样例 POST http://10.154.114.143:9000/tools/softcomai/datalake/v1.0/data-analysis/analysis-task{"analysisType":"TIE","dataSrcType":"OBS","srcPath":"changdata","dstPath":"result","bucketName":"obs-analysis","extendParam":{"modelName":"fiber"}}

响应 响应样例 {"success": true,"returnData": {"id": "1472","applyId": "20191108161551-2028400065","applyType": "Publish","applyUser": "test001","applyUserId": "06ce44035f80d5421ff5c004e706c391","applyTenantId": "4e10259f54a340b4bdde616cdec732d6","approveUser": "xxxxx","approveUserAppId": "4e10259f54a340b4bdde616cdec732d6","applyTime": "2019-11-08 16:15:52","approveTime": "2019-11-08 16:20:51","applyStatus": 0,"applyContent": "[{\"id\":\"402880a76dc838bc016dec18e2896161\",\"pId\":\"1061667308918309325\",\"label\":\"dwstest102\",\"desc\":{\"expire\":\"2022-11-07 16:15:50\",\"descrip\":\"dwstest1021_train\",\"tanentRange\":[],\"userRange\":[]},\"datasetOwnerContactList\":[{\"userId\":\"xxxxxx\",\"userName\":\"lxxxi\",\"tenantId\":\"4e10259f54a340b4bdde616cdec732d6\",\"tenantName\":\"axxxxx\",\"email\":\"xxxxx\"}],\"disabled\":false,\"isMetaDataInfo\":true,\"secretLevel\":\"3\",\"isAllPublish\":false,\"autoPublish\":false,\"children\":[]}]","approvalComments": "tr"}} 要素说明 参数名 参数类型 备注 success String 请求是否成功。 returnData JSON 返回结果详情。 applyId String 申请单号。 applyType String 申请类型。 applyUser String 申请人员用户名。 approveUser Stirng 审批人员用户名。 approveUserAppId String 审批人员租户ID。 applyTime String 申请时间。 approveTime String 审批时间 applyContent String 申请内容。 applyStatus Int 申请状态包括如下： 0：审批通过。 大于0：审批中。 -1：审批被拒绝。 approvalComments String 审批意见。

请求 请求样例 POST https://127.0.0.1:8100/softcomai/datalake/collection/v1.0/collectorStatus/taskReport{"reportStatus": "finished","collectorId": "Collector-694843bb","strategy": "period","probeId": "Probe-0002","fileSize": "1024"} 参数说明 参数名 是否必选 参数类型 备注 reportStatus 是 String 任务状态。 collectorId 是 String 采集机ID。 strategy 是 String 采集策略。 probeId 是 String 探针ID。 fileSize 否 String 本次采集的文件的大小。

响应 成功响应样例 {"success" : true,"returnData" : [{"id" : "0","pId" : "","label" : "DG","desc" : {},"disabled" : false,"isMetaDataInfo" : false,"isAllPublish" : false,"autoPublish" : false,"timeLimitAuto" : false,"children" : [{"id" : "402880c96d70ac63016f1be7cbf22148","pId" : "0","label" : "核心网通道","desc" : {},"disabled" : false,"isMetaDataInfo" : false,"isAllPublish" : false,"autoPublish" : false,"timeLimitAuto" : false,}]}]} 失败响应样例 {"success": false,"errorMsg": "","errorCode": "23469349.30000.01036"}

响应 成功响应样例 {"success" : true,"returnData" : [{"id" : "402880c6670d6c8501679719c1ad01a7","pId" : "0","label" : "训练数据集","desc" : {},"disabled" : false,"isMetaDataInfo" : false,"children" : [{"id" : "402880c6670d6c850101a8","pId" : "402880c6670d6c89c1ad01a7","label" : "DC_PUE","disabled" : false,"isMetaDataInfo" : true,"secretLevel" : "内部公开","children" : []}, ]}]} 失败响应样例 {Success:false} 要素说明 参数名 参数类型 备注 success string 请求是否成功。 returnData JSON 返回体。 id String 目录ID。 pId String 父目录ID。 label String 目录或者数据集节点的显示名称。 children JSON列表 子目录类表。 isMetaDataInfo Boolean 是否为元数据（数据集）的标识。

请求 请求样例 PUT https://ipaddr:port/softcomai/datalake/v1.0/dataSet/autoMgr/publish[{ "datasetName": "xxx", "sourceDirUrl": "Default/dir", "targetDirUrl": "DataGenerate", "userId": "1234567890", "userName": "1234567890", "tenantName": "aidomainalpha", "tenantId": "aidomainalpha_", "projectId": "aidomainalph", "desc":"xxxxxx"}] 参数说明 表1 Body参数说明 参数名 是否必选 参数类型 备注 datasetName 是 String 数据集名称。 sourceDirUrl 是 String 数据集在数据权限侧所在的目录。 targetDirUrl 是 String 数据集发布到数据集后所在的目录。 desc 否 String 数据集描述信息。 userId 是 String 用户ID。 userName 是 String 用户名称。 tenantId 是 String 租户ID。 tenentName 是 String 租户名称。 projectId 是 String 项目ID。

响应 成功响应样例 { "success" : true, "returnData" : { "applyId":"xxxxx", "autoPublish","true" }} 失败响应样例 {"success": false,"errorMsg": "待发布的数据集不存在，可能的原因是无此数据集，或者已被发布","errorCode": "23469349.30000.01036"}

请求 请求样例 GET https://ipaddr:port/softcomai/datalake/dataplan/v1.0/backup/restore/status?tenantId=Telcloud-test&backupId=20201231080000566 参数说明 参数名 是否必选 参数类型 备注 tenantId 是 String 租户Id。 backupId 是 String 备份Id。

响应 响应样例 { "success": true, "errorMsg": null, "errorCode": null, "returnData": [ { "serviceName": "dlunion", "serviceStatus": "success", "restoreId": "20201231094708_1611355097", "description": "success", "percent": null }, { "serviceName": "obs", "serviceStatus": "success", "restoreId": "20201231094708_1611355097", "description": "success", "percent": null }, { "serviceName": "localdatatransfer", "serviceStatus": "success", "restoreId": "20201231094708_1611355097", "description": "success", "percent": null }, { "serviceName": "cloudcollection", "serviceStatus": "success", "restoreId": "20201231094708_1611355097", "description": "success", "percent": null }, { "serviceName": "datapermission", "serviceStatus": "success", "restoreId": "20201231094708_1611355097", "description": "success", "percent": null } ]} 要素说明 参数名 参数类型 备注 success String 请求是否成功，取值包括true和false。 returnData JSON LIST 返回值。 serviceName String 服务名称。 serviceStatus String 服务恢复状态。 restoreId String 数据恢复Id。 description String 描述。 percent String 数据恢复百分比。

请求 请求样例 POST https://ip:port/softcomai/datalake/collection/v1.0/kafka/certificate/download{"dataSourceId": "369","certificateType": "keytab"} 参数说明 参数名 是否必选 参数类型 备注 dataSourceId 是 String 数据源ID。 certificateType 是 String 证书类型。

请求 请求样例 POST https://ipaddr:port/softcomai/datalake/dataplan/v1.0/backup/backpolicy/update{"id":"e8026f36-888f-4880-98b8-b124fd66bcc0","ifBack": true,"backupTime": "24","noticeEmail":"xxxxxx"} 参数说明 参数名 是否必选 参数类型 备注 id 是 String 当前备份策略的ID。 ifBack 是 boolean 备份策略是否开启。 backupTime 是 int 备份任务执行的间隔时间，单位小时(H)。 noticeEmail 否 String 有告警时下发通知的邮箱地址。

响应 响应样例 { "success": true, "returnData":{ "id": "30bbfdb9-e48e-448e-93ac-346620fe9447", "ifBack": true, "backupTime": 2, "updateTime": "2021-01-05 14:42:35", "status": 1, "userName": "xxxxxx", "tenantId": "051fb6cf4c00d33d0f85c003b99352a0", "tenantName": "softcomai_xxxxxx", "noticeEmail": xxxxxx" }} 要素说明 参数名 参数类型 备注 success boolean 请求是否成功，取值包括true和false。 returnData JSON LIST 返回值。 id String 当前备份策略的ID。 ifBack boolean 备份策略是否开启。 backupTime int 备份任务执行的间隔时间，单位小时(H)。 updateTime String 备份策略的修改时间。 status int 备份策略的生效状态。 userName String 设置备份策略的用户名。 tenantId String 设置备份策略的租户ID。 tenantName String 设置备份策略的租户名。 noticeEmail String 有告警时下发通知的邮箱地址。

请求 请求样例 [ { "fileName": "src1359512018718808330.sql", "fullFileName": "bucket-hvnngyjf.obs.cn-north-7.ulanqab.huawei.com:443/DataAssets/PLDA/Collection/LocalUpload/c9085f00-2310-d6ed-2c4d-b75c7055e9b5/data/", "status": "completed" }, { "fileName": "1.8g文件.zip", "fullFileName": "bucket-hvnngyjf.obs.cn-north-7.ulanqab.huawei.com:443/DataAssets/PLDA/Collection/LocalUpload/c9085f00-2310-d6ed-2c4d-b75c7055e9b5/data/", "status": "uncompleted" }] 参数说明 参数名 是否必选 参数类型 备注 fileName 是 String 文件名。 fullFileName 是 String 文件全路径。 status 是 String 文件状态。

角色访问权限 数据接入的使用对象包括“Data Asset Manager”角色和“Data Acquisition Engineer”角色，两种角色的操作权限不同。 Data Asset Manager：数据资产管理员，负责管理软件包、管理采集机，可以上传采集机软件包、发布或删除采集机软件包、以及授权采集机和删除采集机。 Data Acquisition Engineer：数据采集工程师，负责管理采集机、管理采集任务，可以升级采集机、删除采集机、下载采集机日志、创建采集任务、启动或停止采集任务、编辑采集任务、删除采集任务、以及查看采集任务详细信息。 如果一个用户同时具有“Data Asset Manager”和“Data Acquisition Engineer”角色，并且“Data Asset Manager”角色用户所属的租户ID与环境变量NAIE_D_Manager配置的值一致，则该用户仅有“Data Asset Manager”角色的操作权限。 如果一个用户同时具有“Data Asset Manager”和“Data Acquisition Engineer”角色，则该用户仅有“Data Acquisition Engineer”角色的操作权限。 父主题： 数据接入

响应 响应样例 {"success" : true,"returnData" : {'userId' : 'XXXXXXX','appId' : '','employeeNumber' : '','userEnglishName' : 'XXXXXXX','userChineseName' : 'XXXXXXX','email' : '***@huawei.com','l0DepName' : '华为技术','l1DepName' : '产品与解决方案','l2DepName' : 'XXXXXXXX','l3DepName' : 'XXXXXXXXX','l4DepName' : 'XXXXXXXXXX','l5DepName' : 'XXXXXXXXX'}} 要素说明 参数名 参数类型 备注 success String 请求是否成功。 returnData JSON 返回结果。 userId String 用户ID。 appId String 应用ID。 userEnglishName String 用户的英文名称。 userChineseName String 用户的中文名称。 email String 邮箱地址。 l0DepName String 部门信息。 l1DepName String 部门信息。 l2DepName String 部门信息。 l3DepName String 部门信息。 l4DepName String 部门信息。 l5DepName String 部门信息。

响应 响应样例 {"success": true,"returnData": {"taskName": "sftp_duan","collectionMode": "VPN","collectorId": "Collector-a7932e65","protocolType": "sftp","protocolCategory": "","strategy": "once","dataInfo": {"mainCategory": "pipe","subCategory": "cloudCore","device": "MAE-CN","dataType": "performanceData","version": ""},"history": {"historyFrom": 0,"historyTo": 0},"protocolList": [{"host": "xx.xx.xx.xx","port": "22","userName": "root","path": "/opt/test","protocolVersion": "","sslMode": "false"}],"collectorIp": "xx.xx.xx.xx","probeId": "Probe-0015","taskSource": "console"}} 要素说明 参数名 参数类型 备注 success Boolean 请求是否成功。 returnData Object 返回值。 taskName String 任务名称 collectorId String 采集机ID。 collectionMode String Agent链接方式。 collectorId String AgentID。 protocolType String 采集协议。 protocolCategory String 协议类型。 strategy String 周期。 collectorIp String AgentIP。 probeId String 探针ID。 taskSource String 任务来源。 dataInfo object 数据信息。 mainCategory String 主类别。 subCategory String 子类别。 device String 网管、设备信息。 dataType String 数据类型。 version String 版本。 history object 历史采集策略。 historyFrom String 历史采集开始时间。 historyTo String 历史采集结束时间。 protocolList List 数据源信息。 host String IP地址。 port String 端口。 userName String 用户名。 path String 路径。 protocolVersion String 协议版本。 sslMode String 是否加密。

响应 响应样例 {"success":true,"returnData":{"probePackageName":"Probe_NAIE_REST_NetMap_Common_V200R021C20SPC100.zip","probePackageId":"NetMap-Huawei-CommoniManager V600R009C00-rest-Object-V200R021C20SPC100"}} 要素说明 参数名 参数类型 备注 success Boolean 请求是否成功。 returnData Object 返回值。 probePackageName String 探针包名称。 probePackageId String 探针包ID。

请求 请求样例 { "append": false, "dataPath": [ { "fullPath": "/1+.sql" }, { "fullPath": "/src7792798983675863740.sql" } ], "fileArray": [ { "filePath": "/1+.sql", "fileName": "1+.sql", "partNumber": 1 }, { "filePath": "/src7792798983675863740.sql", "fileName": "src7792798983675863740.sql", "partNumber": 1 } ], "fileType": "data", "obsPath": "037b1714-5802-6ab5-4c14-45c75994d86a", "taskId":"eabc123456acbaee"} 参数说明 参数名 是否必选 参数类型 说明 append 是 boolean 是否追加场景。 fullPath 是 String 文件全路径。 fileName 是 String 文件名。 filePath 是 String 文件路径。 partNumber 是 int 分片数。 fileType 是 String 文件类型。 obsPath 是 String OBS路径。 taskId 否 String 上传任务ID。

响应 响应样例 {"success": true,"returnData": [{"fileName": "1+.sql","uploadId": "0000017A7ABF491C4011542EA79070BB","headers": {"property": "property-value","Host": "bucket-hvnngyjf.obs.cn-north-7.ulanqab.huawei.com:443","Content-Type": "text/plain"},"urls": [{"filePath": "bucket-hvnngyjf.obs.cn-north-7.ulanqab.huawei.com:443/DataAssets/PLDA/Collection/LocalUpload/f7c09ebb-4ef6-16a9-6c91-8e686d7834fd/data/","fileName": "1%2B.sql","fileParam": "AccessKeyId003dBV3MN664OE0KLBQECRRZ0026Expires003d16255605940026partNumber003d10026uploadId003d0000017A7ABF491C4011542EA79070BB0026Signature003dW%2FhKSdq4YKxdU557zRnPwSVTxFU%3D"}],"filePath": "/1+.sql","obsPath": "DataAssets/PLDA/Collection/LocalUpload/f7c09ebb-4ef6-16a9-6c91-8e686d7834fd"},{"fileName": "src7792798983675863740.sql","uploadId": "0000017A7ABF494B401154597EBF1BCB","headers": {"property": "property-value","Host": "bucket-hvnngyjf.obs.cn-north-7.ulanqab.huawei.com:443","Content-Type": "text/plain"},"urls": [{"filePath": "bucket-hvnngyjf.obs.cn-north-7.ulanqab.huawei.com:443/DataAssets/PLDA/Collection/LocalUpload/f7c09ebb-4ef6-16a9-6c91-8e686d7834fd/data/","fileName": "src7792798983675863740.sql","fileParam": "AccessKeyId003dBV3MN664OE0KLBQECRRZ0026Expires003d16255605940026partNumber003d10026uploadId003d0000017A7ABF494B401154597EBF1BCB0026Signature003dCWBnJcYweX3u035qi%2BcWJ1a6cUM%3D"}],"filePath": "/src7792798983675863740.sql","obsPath": "DataAssets/PLDA/Collection/LocalUpload/f7c09ebb-4ef6-16a9-6c91-8e686d7834fd"}]} 要素说明 参数名 参数类型 备注 success Boolean 请求是否成功。 returnData Object 返回值。 fileName String 文件名。 filePath String 文件路径。 obsPath String OBS路径。 uploadId String 文件唯一标识。 headers Object 分片上传请求头信息。具体参数说明请参见表1。 urls Object 分片上传url信息。具体参数说明请参见表2。 表1 heads参数说明 参数名 参数类型 备注 property String 请求头属性。 Host String OBS主机地址。 Content-Type String 上下文类型。 表2 urls参数说明 参数名 参数类型 备注 fileName String 文件名。 filePath String 文件路径。 fileParam String 文件请求参数。

请求 请求样例 https://ip:port/datacollect/softcomai/datalake/collection/v1.0/countryCityCode/search{"parentCode":"100000","level":"province"} 参数说明 参数名 是否必选 参数类型 备注 id 否 String 主键。 code 否 String 编码参数。 name 否 String 名称。 parentCode 否 String 父编码参数。 level 否 String 城市级别。 lasted 否 String 是否有子节点信息。

响应 响应样例 {"success": true,"returnData": [{"id": "ed58a73a373f45928aa40b60b3cb2d5e","code": "110000","name": "北京市","parentCode": "100000","level": "province","lasted": "false"}, {"id": "05ecbe6596a64abeb2194d267a4c21b9","code": "120000","name": "天津市","parentCode": "100000","level": "province","lasted": "false"}]} 要素说明 参数名 参数类型 备注 success Boolean 请求是否成功。 returnData Object 返回值。 id String 主建。 code String 编码。 name String 城市名称。 parentCode String 父节点编码。 level String 级别。 lasted String 是否为最后节点。

响应 响应样例 {"success": true,"returnData": {"topic": "dataCollect_07c0712c6e00d55e0fbec01f9709fe20","resources_infos": [{"resources": [{"type": "Kafka","attributes": {"public_connect_address": "ip:port,ip:port,ip:port","instance_id": "57d6b545-4912-418d-9b75-7144bbdceb4e","kafka_manager_user": "manager","passwd": "Abc@123","private_connect_address": "192.168.21.249:9092,192.168.21.196:9092,192.168.21.5:9092","name": "kafka-integration","ssl_enable": "false","management_connect_address": "https://ip:port","status": "RUNNING"}}],"status": "SUC CES S","trial": false}]}} 要素说明 参数名 参数类型 备注 success Boolean 请求是否成功。 returnData String 返回值。 topic String Kafka口令。 resources_infos Json 集成鉴权返回信息。

请求 请求样例 POST https://ipaddr:port/softcomai/datalake/dataplan/v1.0/simplemode/progress{ "tasks":[ { "nodeId":"cloudCollect_1608947480973", "id":"7655929759976819579", "pId":0, "taskName":"cor云地采集_云地采集", "variables":[ ], "paramList":[ ], "taskType":"COLLECTION_BUILTIN", "builtInTaskType":"COLLECTION_CLOUD_AUTO", "isRoot":true, "preTaskGid":"", "gid":"T_20201226095555_1608947755488", "childGid":"", "collectTaskId":"1279e316897240fdaad023121cba6f9d", "location":"114-263", "outputIdList":[ "dataProcess_1608947763680" ], "inputIdList":[ ] }, { "id":"4510470909526571607", "taskName":"corba_alarmpf", "variables":[ { "id":"2976616209261996498", "source":"0", "showName":"jobRunningParams", "showNameEn":"jobRunningParams", "varName":"jobRunningParams", "varType":"GOVERN_BUILTIN", "varValue":""[{\"label\":\"input_path\",\"value\":\"s3://bucket-hvnngyjf/f33e8c39-706c-9f74-d735-94d7f7d2363c\",\"required\":false},{\"label\":\"output_path\",\"value\":\"s3://bucket-hvnngyjf/output/1605924538222/\",\"required\":false},{\"label\":\"config_path\",\"value\":\"s3://bucket-hvnngyjf/pfftest/config_path/\",\"required\":false},{\"label\":\"dataSourceId\",\"value\":\"6|6\",\"required\":false},{\"label\":\"entityContext\",\"value\":\"\",\"required\":false},{\"label\":\"result_path\",\"value\":\"s3://bucket-hvnngyjf/pfftest/alarm_data/\",\"required\":false}]"", "defaultVisible":"true", "encrypt":"false", "userId":"PUBLIC", "tenantId":"PUBLIC", "createTime":"2020-12-25 21:56:44", "taskId":"4510470909526571607" }, { "id":"7154899495983091852", "source":"0", "showName":"obs桶名称", "showNameEn":"obsBucketName", "varName":"obsBucketName", "varType":"GOVERN_BUILTIN", "varValue":"#", "defaultVisible":"true", "encrypt":"false", "userId":"PUBLIC", "tenantId":"PUBLIC", "createTime":"2020-12-25 21:56:44", "taskId":"4510470909526571607" }, { "id":"3159719251664805542", "source":"0", "showName":"obs路径", "showNameEn":"obsPath", "varName":"obsPath", "varType":"GOVERN_BUILTIN", "varValue":"#", "defaultVisible":"true", "encrypt":"false", "userId":"PUBLIC", "tenantId":"PUBLIC", "createTime":"2020-12-25 21:56:44", "taskId":"4510470909526571607" }, { "id":"6097845527447436346", "source":"0", "showName":"test_name", "showNameEn":"dataSourceId", "varName":"dataSourceId", "varType":"GOVERN_BUILTIN", "varValue":"#", "defaultVisible":"true", "encrypt":"false", "userId":"PUBLIC", "tenantId":"PUBLIC", "createTime":"2020-12-25 21:56:44", "taskId":"4510470909526571607" }, { "id":"8307408636254011708", "source":"0", "showName":"增量标识", "showNameEn":"reserve", "varName":"reserve", "varType":"GOVERN_BUILTIN", "varValue":"#", "defaultVisible":"true", "encrypt":"false", "userId":"PUBLIC", "tenantId":"PUBLIC", "createTime":"2020-12-25 21:56:44", "taskId":"4510470909526571607" } ], "paramList":[ { "id":"829988785319470776", "source":"0", "paramName":"string", "paramType":"GOVERN_BUILTIN", "paramValue":"-dlunoinAddr "#{dlunoinAddr}" -obsModelPath "${obsModelPath}" -section "startPythonJobs,queryPythonJobStatus" -domainId #{ultimateTenantId} -domainName #{ultimateTenantName} -projectId #{ultimateProjectId} -userId #{ultimateUserId} -userName #{userName} -managementToken ${getManageToken} -jobRunningParams #{jobRunningParams} -obsPath "#{obsPath}" -obsBucketName "#{obsBucketName}" -dataSourceId "#{dataSourceId}" -entityContext "${entityContext}" -appId #{tenantId} -userNo #{userId} -reserve "#{reserve}" -instanceScene "#{instanceScene}" -parsedPath "${parsedPath}"", "appendType":"STRING", "userId":"PUBLIC", "tenantId":"PUBLIC", "createTime":"2020-12-25 21:56:44", "newCreate":"false" }, { "id":"8340996960538141027", "source":"0", "paramName":"pyJobPackageFile", "paramType":"GOVERN_BUILTIN", "paramValue":"300dcf51079742dcabb8111be2eae2bf", "appendType":"JOB_ID", "userId":"PUBLIC", "tenantId":"PUBLIC", "createTime":"2020-12-25 21:56:44", "newCreate":"false" } ], "taskType":"GOVERN_BUILTIN", "builtInTaskType":"GOVERN_NAIE_SIMPLE", "nodeId":"dataProcess_1608947763680", "pId":0, "isRoot":true, "preTaskGid":"", "gid":"", "childGid":"", "location":"426-271", "outputIdList":[ "dataLoad_1608947796922", "dataLoad_1608947811066", "dataLoad_1608947824739" ], "inputIdList":[ "cloudCollect_1608947480973" ] } ], "name":"云地采集", "description":"", "tag":"", "driveStrategy":"cloudCollectDrive", "createWay":"页面创建"} 参数说明 参数名 是否必选 参数类型 备注 name 是 String 项目名称。 description 是 String 描述。 tasks 是 JSON LIST 任务列表。 id 是 String 任务ID。 pId 是 String 父任务ID。 id 是 String 任务ID。 pId 是 String 父任务ID。 tasks 是 JSON LIST 子任务列表。 paramList 是 List 参数列表。 outputIdList 是 List 前置任务列表 inputIdList 是 List 后置任务列表 id 是 String 参数ID location 是 String 位置 source 是 String 来源ID paramName 是 String 参数名称。 paramType 是 String 参数类型。 paramValue 是 String 参数值。 userId 是 String 所属用户ID。 tenantId 是 String 租户ID。 createTime 是 String 创建时间。 updateTime 是 String 修改时间。 variables 是 JSON 变量列表。 showName 是 String 变量显示中文名。 showNameEn 是 String 变量显示英文名。 varName 是 String 参数名称。 varValue 是 String 参数值。 remark 是 String 参数备注。 defaultVisible 是 String 是否基础变量。 userId 是 String 所属用户ID。 tenantId 是 String 租户ID。 taskId 是 String 所属任务。

创建用户 在Chrome浏览器中打开https://www.huaweicloud.com/。 单击界面右上角的“登录”。 输入账号名和密码，单击“登录”。 在华为云首页，单击右上角的“控制台”。 在控制台页面，单击右上角的账号名，选择“ 统一身份认证 ”。 在统一身份认证服务左侧导航树中，选择“用户”。 在“用户”界面上右上角，单击“创建用户”。 在“创建用户”界面下的“配置用户基本信息”区域，配置用户的相关参数，如图1所示，创建用户的参数配置说明见表1。 如需一次创建多个用户，可以单击“添加用户”进行批量创建，每次最多可创建10个用户。 图1 配置用户基本信息 表1 创建用户的参数配置说明 名称 说明 用户信息 用户名 必填。 IAM 用户登录华为云的用户名，此处以“User A”为例。 邮箱 “访问方式”选择“首次登录时设置”时必填，选择其他时选填。IAM用户绑定的邮箱，可作为子账户的登录凭证，也可由IAM用户自己绑定。 手机号 选填。IAM用户绑定的手机号，可作为子账户的登录凭证，也可由IAM用户自己绑定。 描述 选填。对用户的描述信息。 访问方式 编程访问 创建用户完成后即可下载本次创建的所有用户的访问秘钥（AK/SK）。一个用户最多拥有两个访问密钥。这些AK/SK可以对华为云进行编程调用，例如，通过API调用方式访问华为云时，您可能需要使用访问密钥。 华为云管理控制台访问 控制台登录密码设置方式 首次登录时设置 如果您不是用户User A的使用主体，建议您选择该方式，输入用户的邮箱和手机，用户User A通过邮件中的一次性链接登录华为云，自行设置密码。 自动生成 仅在创建单个用户时适用，如果您本次创建2个及以上的用户，则不支持此方式。 自定义 如果您是用户User A的使用主体，建议您选择该方式，设置自己的登录密码。 登录保护 开启登录保护 开启登录保护后，IAM用户登录时，除了在登录页面输入用户名和密码外（第一次身份验证），还需要在登录验证页面输入验证码（第二次身份验证），该功能是一种安全实践，建议开启登录保护，多次身份认证可以提高账号安全性。 您可以选择通过手机、邮箱、虚拟MFA进行登录验证。 不开启 不开启登录保护。 单击“下一步”。 在“创建用户”界面下的“加入用户组（可选）”区域，在“可选用户组”下勾选需要加入的用户组，将新建用户加入用户组，如图2所示。 将用户加入用户组，用户将具备用户组的权限，这一过程即给用户授权。 一个用户可以同时加入多个用户组。 图2 加入用户组 单击“创建用户”。IAM用户创建完成，用户列表中显示新创建的IAM用户，如图3所示。 图3 完成IAM用户的创建

请求 请求样例 GET https://ipaddr:port/softcomai/datalake/dataplan/v1.0/tasks/getgorvnobs?bucketName=obs-bucket&bucketPath=/opt/test 参数说明 参数 是否必选 类型 说明 progressId 是 String 项目ID。 taskId 是 String 任务ID。 taskType 是 String 任务类型，取值为COLLECTION_BUILTIN。

响应 响应样例 {"success": true,"errorMsg": null,"errorCode": null,"returnData": {"bucketName": "bucket-ql62i9ct","path": "5ae5e3fb-ca79-2534-f4f2-aaa665ee38e5"}} 要素说明 参数名 参数类型 备注 success String 请求是否成功，取值包括true和false。 returnData Json 返回对象。 bucketName String 桶名称。 path String 路径。