Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

...

Request Sample:
/onapapi/aai/esr/v1/vims/57674786-5b2e-4c92-bb68-578dbd79e2f5?cloud_owner=owner&cloud_region=region-one

Response Parameters:
VIM

Response Sample:

...

Request Sample:
/onapapi/aai/esr/v1/vims/57674786-5b2e-4c92-bb68-578dbd79e2f5?cloud_owner=owner&cloud_region=region-one

   {
       "name":"vim",
       "cloud-owner":"owner",

...

Response Parameters:
VIM

Response Sample:

   {
       "vimIdname":"57674786-5b2e-4c92-bb68-578dbd79e2f5","vim",
       "cloud-owner":"owner",
        "namecloud-region":"vimregion-one",
       "url":"http://10.74.151.13:5000/v2.0",
       "userName":"admin",
       "password":"admin",
       "tenant":"admin",
       "vendor":"ZTE",
       "version":"v2.0",
       "description":"",
       "domain":"",
       "type":"openstack",
       "createTime":"2016-07-18 12:22:53"
   }

...

Interface DefinitionDescription
URI/onapapi/aai/esr/v1/vims/{vimId}Operation Type?cloud_owner=xxx&cloud_region=xxx
Operation TypeDELETE

Request Parameters:

...

Request Sample:
/onapapi/aai/esr/v1/vims/57674786-5b2e-4c92-bb68-578dbd79e2f5?cloud_owner=owner&cloud_region=region-one

Response Parameters:
N/A

Response Sample:
N/A

...

AttributeQualifierCardinalityContentDescription
nameM1StringSDN Controller name
locationO1Stringfit for DC type
urlM1StringAccess url
vendorM1StringSDNC vendor
versionM1StringSDNC version
descriptionO0..1StringSDNC description
productNameO0..1StringSDNC productName
protocolM1Enum{netconf/snmp}protocol
userNameM1StringUser name
passwordM1StringPassword
typeM1Enum{ODLWAN/ONOSDC}SDN Controller type

Request Sample:
/onapapi/aai/esr/v1/sdncontrollers

   {
       "name":"sdn",
       "url":"http://10.74.151.13:8181",
       "userName":"admin",
       "password":"admin",
       "version":"v1.0",
       "vendor":"ZTE",
       "description":"",
       "protocol":"netconf",
       "productName":"",
       "type":"ODLWAN"
   }

Response Parameters:
SDN Controller

...

   {
       "sdnControllerId":"a6c42529-cd6b-4c01-b149-03eb54b20a03",
       "name":"sdn",
       "url":"http://10.74.151.13:8181",
       "userName":"admin",
       "password":"admin", 
       "version":"v1.0",
       "vendor":"ZTE",
       "description":"",
       "protocol":"netconf",
       "productName":"",
       "type":"ODLWAN",
       "createTime":"2016-07-18 12:22:53"
   }

...

   {
       "sdnControllerId":"a6c42529-cd6b-4c01-b149-03eb54b20a03",
       "name":"sdn",
       "url":"http://10.74.151.13:8181",
       "userName":"admin",
       "password":"admin", 
       "version":"v1.0",
       "vendor":"ZTE",
       "description":"",
       "protocol":"netconf",
       "productName":"",
       "type":"ODLWAN",
       "createTime":"2016-07-18 12:22:53"
   }

...

   [
       {
           "sdnControllerId":"a6c42529-cd6b-4c01-b149-03eb54b20a03",
           "name":"sdn",
           "url":"http://10.74.151.13:8181",
           "userName":"admin",
           "password":"admin",
           "version":"v1.0",
           "vendor":"ZTE",
           "description":"",
           "protocol":"netconf",
           "productName":"", 
           "type":"ODLWAN",
           "createTime":"2016-07-18 12:22:53"
       }
   ]

...

   {
       "sdnControllerId":"a6c42529-cd6b-4c01-b149-03eb54b20a03",
       "name":"sdn",
       "url":"http://10.74.151.13:8181",
       "userName":"admin",
       "password":"admin", 
       "version":"v1.0",
       "vendor":"ZTE",
       "description":"",
       "protocol":"netconf",
       "productName":"", 
       "type":"ODLWAN",
       "createTime":"2016-07-18 12:22:53"
   }

...

O0..urluserName
AttributeQualifierCardinalityContentDescription
nameM1StringEMS name
vendorM1Stringvendor
versionM1Stringversion
descriptionO0..1StringdescriptionproductName
resourceAddrM1StringproductNameObjAddress to get resource data
performanceAddrM1StringAccess urlObjAddress to get performance data
alarmAddrM1StringUser name
passwordM1StringPassword

Request Sample:
/onapapi/aai/esr/v1/emses

   {
       "name":"ems",
       "vendor":"ZTE",
       "version":"v1.0",
       "description":"",
       "productName":"",
       "url":"http://10.74.44.11",
       "userName":"admin",
       "password":"admin"
   }

Response Parameters:
EMS

Response Sample:

   {
       "emsId":"19ecbb3a-3242-4fa3-9926-8dfb7ddc29ee",
       "name":"ems",
       "vendor":"ZTE",
       "version":"v1.0",
       "description":"",
       "productName":"",
       "url":"http://10.74.44.11",
       "userName":"admin",
       "password":"admin",
       "createTime":"2016-07-18 12:22:53"
   }

Get EMS by id

Interface DefinitionDescription
URI/onapapi/aai/esr/v1/emses/{emsId}
Operation TypeGET

Request Parameters:

AttributeQualifierCardinalityContentDescription
emsIdM1StringEMS identifier

Request Sample:
/onapapi/aai/esr/v1/emses/19ecbb3a-3242-4fa3-9926-8dfb7ddc29ee

Response Parameters:
EMS

Response Sample:

   {
       "emsId":"19ecbb3a-3242-4fa3-9926-8dfb7ddc29ee",
       "name":"ems",
       "version":"v1.0",
       "vendor":"ZTE",
       "description":"",
       "productName":"",
       "url":"http://10.74.44.11",
       "userName":"admin",
       "password":"admin",
       "createTime":"2016-07-18 12:22:53"
   }

Get all EMS

Interface DefinitionDescription
URI/onapapi/aai/esr/v1/emss
Operation TypeGET

Request Parameters:
N/A

Request Sample:
/onapapi/aai/esr/v1/emss

Response Parameters:
List<EMS>

Response Sample:

   [
       {
           "emsId":"19ecbb3a-3242-4fa3-9926-8dfb7ddc29ee",
           "name":"ems",
           "version":"v1.0",
           "vendor":"ZTE",
           "description":"",
           "productName":"",
           "url":"http://10.74.44.11",
           "userName":"admin",
           "password":"admin",
           "createTime":"2016-07-18 12:22:53"
       }
   ]

Update EMS

Interface DefinitionDescription
URI/onapapi/aai/esr/v1/emses/{emsId}
Operation TypePUT

Request Parameters:

AttributeQualifierCardinalityContentDescription
emsIdM1StringEMS identifier
nameO0..1StringEMS name
vendorO0..1StringVendor
versionO0..1Stringversion
descriptionO0..1Stringdescription
productNameO0..1StringproductName
urlO0..1StringAccess url
userNameO0..1StringUser name
passwordO0..1StringPassword

Request Sample:
/onapapi/aai/esr/v1/emses/19ecbb3a-3242-4fa3-9926-8dfb7ddc29ee

...

ObjAddress to get alarm data

resourceAddr:

AttributeQualifierCardinalityContentDescription
ftptypeM1Enum{ftp/sftp}ftp type
ipM1Stringservice IP of ftp server
portM1Stringservice port of ftp server
userM1Stringftp user name
passwordM1Stringftp password
remotepathM1Stringresource data file path
passiveM1Booleanftp passive mode or not

performanceAddr:

AttributeQualifierCardinalityContentDescription
ftptypeM1Enum{ftp/sftp}ftp type
ipM1Stringservice IP of ftp server
portM1Stringservice port of ftp server
userM1Stringftp user name
passwordM1Stringftp password
remotepathM1Stringperformance data file path
passiveM1Booleanftp passive mode or not

alarmAddr:

AttributeQualifierCardinalityContentDescription
ipM1Stringservice IP of ftp server
portM1Stringservice port of ftp server
userM1Stringftp user name
passwordM1Stringftp password

Request Sample:

/onapapi/aai/esr/v1/emses

{

    "emsName": "EMS_TEST",

  "version":"v1.0",
  "vendor":"ZTE",
  "description":"",
  "createTime":"2016-07-18 12:22:53"

    "resouceAddr": {
        "ftptype": "ftp",
        "ip": "10.44.55.145",
        "port": "2000",
        "user": "root",
        "password": "test",
        "remotepath": "/opt/res/data/",
        "passive": true
    },
    "performanceAddr": {
        "ftptype": "ftp",
        "ip": "10.44.55.145",
        "port": "2000",
        "user": "root",
        "password": "test",
        "remotepath": "/opt/Gcp/data/",
        "passive": true
    },
    "alarmAddr": {
        "ip": "10.44.55.145",
        "port": 2000,
        "user": "root",
        "password": "test"
    }
}


Response Parameters:
EMS

Response Sample:

{
    "emsId": "19ecbb3a-3242-4fa3-9926-8dfb7ddc29ee",

    "emsName": "EMS_TEST",

  "version":"v1.0",
  "vendor":"ZTE",
  "description":"",
  "createTime":"2016-07-18 12:22:53"

    "resouceAddr": {
        "ftptype": "ftp",
        "ip": "10.44.55.145",
        "port": "2000",
        "user": "root",
        "password": "test",
        "remotepath": "/opt/res/data/",
        "passive": true
    },
    "performanceAddr": {
        "ftptype": "ftp",
        "ip": "10.44.55.145",
        "port": "2000",
        "user": "root",
        "password": "test",
        "remotepath": "/opt/Gcp/data/",
        "passive": true
    },
    "alarmAddr": {
        "ip": "10.44.55.145",
        "port": 2000,
        "user": "root",
        "password": "test"
    }
}


Get EMS by id

Interface DefinitionDescription
URI/onapapi/aai/esr/v1/emses/{emsId}
Operation TypeGET

Request Parameters:

AttributeQualifierCardinalityContentDescription
emsIdM1StringEMS identifier

Request Sample:
/onapapi/aai/esr/v1/emses/19ecbb3a-3242-4fa3-9926-8dfb7ddc29ee

Response Parameters:
EMS

Response Sample:

{
    "emsId": "19ecbb3a-3242-4fa3-9926-8dfb7ddc29ee",

    "emsName": "EMS_TEST",

  "version":"v1.0",
  "vendor":"ZTE",
  "description":"",
  "createTime":"2016-07-18 12:22:53"

    "resouceAddr": {
        "ftptype": "ftp",
        "ip": "10.44.55.145",
        "port": "2000",
        "user": "root",
        "password": "test",
        "remotepath": "/opt/res/data/",
        "passive": true
    },
    "performanceAddr": {
        "ftptype": "ftp",
        "ip": "10.44.55.145",
        "port": "2000",
        "user": "root",
        "password": "test",
        "remotepath": "/opt/Gcp/data/",
        "passive": true
    },
    "alarmAddr": {
        "ip": "10.44.55.145",
        "port": 2000,
        "user": "root",
        "password": "test"
    }
}

Get all EMS

Interface DefinitionDescription
URI/onapapi/aai/esr/v1/emss
Operation TypeGET

Request Parameters:
N/A

Request Sample:
/onapapi/aai/esr/v1/emss

Response Parameters:
List<EMS>

Response Sample:

   [

{
    "emsId": "19ecbb3a-3242-4fa3-9926-8dfb7ddc29ee",

    "emsName": "EMS_TEST",

  "version":"v1.0",
  "vendor":"ZTE",
  "description":"",
  "createTime":"2016-07-18 12:22:53"

    "resouce": {
        "ftptype": "ftp",
        "ip": "10.44.55.145",
        "port": "2000",
        "user": "root",
        "password": "test",
        "remotepath": "/opt/res/data/",
        "passive": true
    },
    "performance": {
        "ftptype": "ftp",
        "ip": "10.44.55.145",
        "port": "2000",
        "user": "root",
        "password": "test",
        "remotepath": "/opt/Gcp/data/",
        "passive": true
    },
    "alarm": {
        "ip": "10.44.55.145",
        "port": 2000,
        "user": "root",
        "password": "test"
    }
}

   ]


Update EMS

Interface DefinitionDescription
URI/onapapi/aai/esr/v1/emses/{emsId}
Operation TypePUT

Request Parameters:

AttributeQualifierCardinalityContentDescription
emsIdM1StringEMS identifier
nameO0..1StringEMS name
vendorO0..1StringVendor
versionO0..1Stringversion
descriptionO0..1Stringdescription
resourceAddrO0..1ObjAddress to get resource data
performanceAddrO0..1ObjAddress to get performance data
alarmAddrO0..1ObjAddress to get alarm data

resourceAddr:

AttributeQualifierCardinalityContentDescription
ftptypeO0..1Enum{ftp/sftp}ftp type
ipO0..1Stringservice IP of ftp server
portO0..1Stringservice port of ftp server
userO0..1Stringftp user name
passwordO0..1Stringftp password
remotepathO0..1Stringresource data file path
passiveO0..1Booleanftp passive mode or not

performanceAddr:

AttributeQualifierCardinalityContentDescription
ftptypeO0..1Enum{ftp/sftp}ftp type
ipO0..1Stringservice IP of ftp server
portO0..1Stringservice port of ftp server
userO0..1Stringftp user name
passwordO0..1Stringftp password
remotepathO0..1Stringperformance data file path
passiveO0..1Booleanftp passive mode or not

alarmAddr:

AttributeQualifierCardinalityContentDescription
ipO0..1Stringservice IP of ftp server
portO0..1Stringservice port of ftp server
userO0..1Stringftp user name
passwordO0..1Stringftp password

Request Sample:
/onapapi/aai/esr/v1/emses/19ecbb3a-3242-4fa3-9926-8dfb7ddc29ee

{
    "emsId": "19ecbb3a-3242-4fa3-9926-8dfb7ddc29ee",

    "emsName": "EMS_TEST",

  "version":"v1.0",
  "vendor":"ZTE",
  "description":"",
  "createTime":"2016-07-18 12:22:53"

    "resouceAddr": {
        "ftptype": "ftp",
        "ip": "10.44.55.145",
        "port": "2000",
        "user": "root",
        "password": "test",
        "remotepath": "/opt/res/data/",
        "passive": true
    },
    "performanceAddr": {
        "ftptype": "ftp",
        "ip": "10.44.55.145",
        "port": "2000",
        "user": "root",
        "password": "test",
        "remotepath": "/opt/Gcp/data/",
        "passive": true
    },
    "alarmAddr": {
        "ip": "10.44.55.145",
        "port": 2000,
        "user": "root",
        "password": "test"
    }
}


Response Parameters:
EMS

Response Sample:

{
    "emsId": "19ecbb3a-3242-4fa3-9926-8dfb7ddc29ee",

    "emsName": "EMS_TEST",

  "version":"v1.0",
  "vendor":"ZTE",
  "namedescription":"ems",
        "vendor"createTime":"2016-07-18 12:22:53"

    "resouceAddr": {
        "ftptype": "

...

ftp",

...


        "ip": "

...

10.44.55.145",
        "port": "2000",

...


        "user": "root",

...

Response Parameters:
EMS

Response Sample:

...


        "password": "test",
        "remotepath": "/opt/res/data/",
        "passive": true
    },
    "performanceAddr": {
        "ftptype": "ftp",
        "ip": "10.44.55.145",
        "port": "2000",
        "user": "root",
        "password": "test",
        "remotepath": "/opt/Gcp/data/",
        "passive": true
    },
    "alarmAddr": {
        "ip": "10.44.55.145",
        "port": 2000,
        "user": "root",
        "password": "test"
    }
}


Delete EMS

Interface DefinitionDescription
URI/onapapi/aai/esr/v1/emses/{emsId}
Operation TypeDELETE

...

AttributeContentDescription
emsIdStringEMS identifier(UUID)
nameStringEMS name
descriptionStringdescription
versionStringversion
vendorStringVendor
createTimeStringCreate time
productNameStringproduct name
resourceresourceInforesource data access address
performanceperformanceInfoperformance data access address
alarmalarmInfoalarm data access address

resouceInforesourceAddr:

AttributeContentDescription
ftpType
ftptypeEnum{ftp/sftp}ftp type
ipStringservice IP of ftp server
portStringservice port of ftp server
userStringftp user name
passwordStringftp password
remotePath
remotepathStringresource data file path
passiveBoolean

...

ftp passive mode or not

performanceAddr:

AttributeContentDescription
ftpType
ftptypeEnum{ftp/sftp}ftp type
ipStringservice IP of ftp server
portStringservice port of ftp server
userStringftp user name
passwordString
remotePath
ftp password
remotepathStringperformance data file path
passiveBoolean

...

ftp passive mode or not

alarmAddr:

AttributeContentDescription
ipStringservice IP of ftp server
portStringservice port of ftp server
userStringftp user name
passwordStringftp password