更新时间: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

    返回值。

状态码

具体请参考状态码

分享:

    相关文档

    相关产品

close