文档首页/ 网络智能体/ 数据资产管理服务/ API参考/ 数据接入/ 采集机相关接口（机机接口）/ 注册采集机

更新时间：2021-12-17 GMT+08:00

注册采集机

功能介绍

注册采集机到server端。

URI

URI格式

POST /softcomai/datalake/collection/v1.0/register

参数说明
 无。

请求

请求样例

POST https://ip:port/softcomai/datalake/collection/v1.0/register
{
"id": "Collector-f5df6e9f",
"esn": "ESN1011320959",
"cusName": "PQAMONHO9ITCE3AMRYYH",
"ip": "xx.xx.xx.xx",
"port": "8668",
"country": "China",
"operate": "operate",
"collectorVersion": "21.3.5",
"overWriteSwitch": "on",
"osName": "Linux",
"osArchitecture": "x64",
"versionTimestamp": "20210312160236",
"probes": [
{
"sftpInfo": {
"sftphost": "xx.xx.xx.xx",
"sftport": "22",
"sftpuser": "root",
"sftpath": "/opt/test/ftth",
"sftpScanPeriod": "5",
"sftpIsSupportInc": "true",
"sftpIsSupportCompress": "false",
"sftpIsSupportFragment": "false"
},
"id": "Probe-0001",
"ossId": "ESN1011320959",
"probeName": "probe_sftp",
"probePackageId": "default-package-001",
"probePackageVersion": "V200R021C20SPC100",
"probePackageContractor": "Huawei",
"probePackageProtocol": "sftp",
"domainName": "Common",
"collectObjectType": "Common",
"collectObjectVersion": "iManagerU2000 V200R018C60SPC200",
"dataType": "Object",
"authScope": "Huawei_inners",
"validPeriod": "2020-01-01",
"dataPurpose": "AI_Case_Researchs",
"carrierSubnet": "China_Mobiles",
"netWorkInfo": "eNodeB_V100R018C00SPC01s",
"businessArea": "Wirelesss",
"subsystem": "U2020-M_V100R019C00SPC01s",
"metaDataType": "PMs",
"probePackageName": "Probe_NAIE_SFTP_Common_V200R021C20SPC100.zip"
}
],
"defaultProbePackages": [
{
"collectorId": "Collector-f5df6e9f",
"probePackageId": "U2000-Huawei-FMiManagerU2000 V200R018C60SPC200-corba-Object-V200R021C20SPC100",
"probePackageName": "Probe_NAIE_CORBA_U2000_FM_V200R021C20SPC100.zip",
"specifications": "default",
"domainName": "U2000",
"systemVender": "Huawei",
"systemName": "FM",
"systemVersion": "iManagerU2000 V200R018C60SPC200",
"probePackageProtocol": "corba",
"type": "Object",
"version": "V200R021C20SPC100",
"remark": "register",
"networkType": "u2000"
},
{
"collectorId": "Collector-f5df6e9f",
"probePackageId": "Common-Huawei-CommoniManager V600R009C00-database-Object-V200R021C20SPC100",
"probePackageName": "Probe_NAIE_DATABASE_Common_V200R021C20SPC100.zip",
"specifications": "default",
"domainName": "Common",
"systemVender": "Huawei",
"systemName": "Common",
"systemVersion": "iManager V600R009C00",
"probePackageProtocol": "database",
"type": "Object",
"version": "V200R021C20SPC100",
"remark": "register"
},
{
"collectorId": "Collector-f5df6e9f",
"probePackageId": "Common-Huawei-CommoniManagerU2000 V200R018C60SPC200-ftps-Object-V200R021C20SPC100",
"probePackageName": "Probe_NAIE_FTPS_Common_V200R021C20SPC100.zip",
"specifications": "default",
"domainName": "Common",
"systemVender": "Huawei",
"systemName": "Common",
"systemVersion": "iManagerU2000 V200R018C60SPC200",
"probePackageProtocol": "ftps",
"type": "Object",
"version": "V200R021C20SPC100",
"remark": "register"
},
{
"collectorId": "Collector-f5df6e9f",
"probePackageId": "Common-Huawei-CommoniManager V600R009C00-kafka-Object-V200R021C20SPC100",
"probePackageName": "Probe_NAIE_KAFKA_Common_V200R021C20SPC100.zip",
"specifications": "default",
"domainName": "Common",
"systemVender": "Huawei",
"systemName": "Common",
"systemVersion": "iManager V600R009C00",
"probePackageProtocol": "kafka",
"type": "Object",
"version": "V200R021C20SPC100",
"remark": "register"
},
{
"collectorId": "Collector-f5df6e9f",
"probePackageId": "NCE-Huawei-FMNCE V100R019C00-rest-Object-V200R021C20SPC100",
"probePackageName": "Probe_NAIE_REST_NCE_FM_V200R021C20SPC100.zip",
"specifications": "default",
"domainName": "NCE",
"systemVender": "Huawei",
"systemName": "FM",
"systemVersion": "NCE V100R019C00",
"probePackageProtocol": "rest",
"type": "Object",
"version": "V200R021C20SPC100",
"remark": "register"
},
{
"collectorId": "Collector-f5df6e9f",
"probePackageId": "CMC-Huawei-CommoniManager V600R009C00-rest-Object-V200R021C20SPC100",
"probePackageName": "Probe_NAIE_REST_CMC_Common_V200R021C20SPC100.zip",
"specifications": "default",
"domainName": "CMC",
"systemVender": "Huawei",
"systemName": "Common",
"systemVersion": "iManager V600R009C00",
"probePackageProtocol": "rest",
"type": "Object",
"version": "V200R021C20SPC100",
"remark": "register"
},
{
"collectorId": "Collector-f5df6e9f",
"probePackageId": "eService-Huawei-CommoniManager V600R009C00-rest-Object-V200R021C20SPC100",
"probePackageName": "Probe_NAIE_REST_eService_Common_V200R021C20SPC100.zip",
"specifications": "default",
"domainName": "eService",
"systemVender": "Huawei",
"systemName": "Common",
"systemVersion": "iManager V600R009C00",
"probePackageProtocol": "rest",
"type": "Object",
"version": "V200R021C20SPC100",
"remark": "register"
},
{
"collectorId": "Collector-f5df6e9f",
"probePackageId": "NetEco-Huawei-CommoniManager V600R009C00-rest-Object-V200R021C20SPC100",
"probePackageName": "Probe_NAIE_REST_NetEco_Common_V200R021C20SPC100.zip",
"specifications": "default",
"domainName": "NetEco",
"systemVender": "Huawei",
"systemName": "Common",
"systemVersion": "iManager V600R009C00",
"probePackageProtocol": "rest",
"type": "Object",
"version": "V200R021C20SPC100",
"remark": "register"
},
{
"collectorId": "Collector-f5df6e9f",
"probePackageId": "NetMap-Huawei-CommoniManager V600R009C00-rest-Object-V200R021C20SPC100",
"probePackageName": "Probe_NAIE_REST_NetMap_Common_V200R021C20SPC100.zip",
"specifications": "default",
"domainName": "NetMap",
"systemVender": "Huawei",
"systemName": "Common",
"systemVersion": "iManager V600R009C00",
"probePackageProtocol": "rest",
"type": "Object",
"version": "V200R021C20SPC100",
"remark": "register"
},
{
"collectorId": "Collector-f5df6e9f",
"probePackageId": "Common-Huawei-CommoniManagerU2000 V200R018C60SPC200-sftp-Object-V200R021C20SPC100",
"probePackageName": "Probe_NAIE_SFTP_Common_V200R021C20SPC100.zip",
"specifications": "default",
"domainName": "Common",
"systemVender": "Huawei",
"systemName": "Common",
"systemVersion": "iManagerU2000 V200R018C60SPC200",
"probePackageProtocol": "sftp",
"type": "Object",
"version": "V200R021C20SPC100",
"remark": "register"
},
{
"collectorId": "Collector-f5df6e9f",
"probePackageId": "U2000-Huawei-FMiManagerU2000 V200R018C60SPC200-snmp-model-V200R021C20SPC100",
"probePackageName": "Probe_NAIE_SNMP_U2000_FM_V200R021C20SPC100.zip",
"specifications": "default",
"domainName": "U2000",
"systemVender": "Huawei",
"systemName": "FM",
"systemVersion": "iManagerU2000 V200R018C60SPC200",
"probePackageProtocol": "snmp",
"type": "model",
"version": "V200R021C20SPC100",
"remark": "register"
}
],
"isDecrypt": "No",
"collectorPkgName": "NAIE_Collector_21.3.5_Linux_x64",
"transitAddress": ""
}

参数说明

参数名	是否必选	参数类型	备注
id	是	String	采集机ID。
esn	否	String	客户ESN。
cusName	否	String	客户cusName。
cusId	否	String	客户cusID。
ip	是	String	采集机IP。
port	是	String	采集机端口。
countryArea	否	String	国家。
country	否	String	地区。
operate	否	String	运营商。
collectorVersion	是	String	采集机版本号。
probes	是	List<RegisterProbeBody>	探针列表。具体参数说明请参见表1。
defaultProbePackages	是	List<RigisterDefaultProbePackage>	采集机自带默认探针包。具体参数说明请参见表3。
collectorStatus	否	String	采集机状态。
subNet	否	String	子网。
name	否	String	采集机名称。
packageName	否	String	采集机包名。
note	否	String	采集机备注。
createTime	否	String	采集机创建时间。
resourceUserName	否	String	资源用户名。
resourceTenantName	否	String	资源租户名。
overWriteSwitch	是	String	采集机重装是否恢复任务配置（on/off）。
osName	是	String	系统名。
osArchitecture	是	String	系统架构名。
versionTimestamp	是	String	采集机时间戳。
app_id	否	String	云道采集机用户标识ID。
transitAddress	否	String	中转地址。
isDecrypt	否	String	采集机是否可以加解密。
collectorPkgName	否	String	采集机注册时上传的软件包名称。

表1 probes参数说明
参数名	是否必选	参数类型	备注
id	是	String	唯一ID。
collectorId	否	String	采集机ID。
probeName	是	String	探针名称。
probePackageVersion	是	String	探针包版本。
probePackageId	是	String	探针包ID。
domainName	是	String	领域名称。
probePackageContractor	是	String	探针包开发商。
collectObjectType	是	String	采集对象类型。
collectObjectVersion	是	String	采集对象版本。
probePackageProtocol	是	String	探针包协议类型。
probeSource	否	String	探针包来源。
sftpInfo	是	RegisterSftpBody	默认SFTP探针信息。具体参数说明请参见表2。
startStatus	否	String	探针启动状态。
upgradeStatus	否	String	探针升级状态。
authScope	是	String	授权范围。
validPeriod	是	String	有效周期。
carrierSubnet	否	String	运营商子网。
dataType	是	String	数据类型。
metaDataType	是	String	元数据类型。
netWorkInfo	否	String	子网信息。
subsystem	否	String	子系统信息。
securityLevel	否	String	密级。
ossId	是	String	网管标识ID。
tenantId	否	String	租户ID。
probePackageName	是	String	探针包名。
dataPurpose	是	String	数据使用目的。

表2 sftpInfo参数说明
参数名	是否必选	参数类型	备注
id	是	String	唯一ID。
collectorId	否	String	采集机ID。
probeId	否	String	探针ID。
sftphost	是	String	SFTP网管IP。
sftpport	是	String	SFTP端口。
sftpuser	是	String	SFTP用户名。
sftppassword	是	String	SFTP密码。
sftppath	是	String	SFTP采集路径。
sftpScanPeriod	是	String	SFTP采集周期。
sftpIsSupportInc	是	String	SFTP是否支持增量采集。
sftpIsSupportFragment	是	String	SFTP是否支持分片。
sftpIsSupportCompress	是	String	SFTP是否支持压缩。

表3 RegisterDefaultProbePackage对象参数列表（对应defaultProbePackages）
参数名	是否必选	参数类型	备注
collectorId	是	String	采集机ID。
probePackageId	是	String	探针包ID。
probePackageName	是	String	探针包名。
probePackageProtocol	是	String	探针包协议类型。
domainName	是	String	领域名称。
specifications	是	String	该探针包是否为默认探针包。
remark	是	String	备注信息。
systemVender	是	String	探针包开发商。
systemVersion	是	String	支持网管版本。
systemName	是	String	网管数据类型。
probeAppId	否	String	探针包ID。
type	是	String	采集数据类型。
networkType	是	String	网元类型。
version	是	String	探针包版本。

响应

响应样例
```
{"success":true,"returnData": success }
```

要素说明

参数名	参数类型	备注
success	Boolean	请求是否成功。
returnData	object	返回值。

状态码

具体请参考状态码。

父主题： 采集机相关接口（机机接口）

上一篇：采集机相关接口（机机接口）

下一篇：更新采集机状态

意见反馈

文档内容是否对您有帮助？

有帮助没帮助

提供反馈

提交成功！非常感谢您的反馈，我们会继续努力做到更好！您可在我的云声建议查看反馈及问题处理状态。

系统繁忙，请稍后重试

在使用文档中是否遇到以下问题

内容与产品页面不一致

内容不易理解

缺失示例代码

步骤不可操作

搜不到想要的内容

缺少最佳实践

意见反馈（选填）

0/500

请至少选择一项反馈信息并填写问题反馈

字符长度不能超过500

直接提交取消

如您有其它疑问，您也可以通过华为云社区问答频道来与我们联系探讨

智能客服提问云社区提问

注册采集机

功能介绍

URI

请求

响应

状态码

相关文档

意见反馈

文档内容是否对您有帮助？

7*24

备案

专业服务

退订

建议反馈

售前咨询热线