Versions Compared

Key

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

This API is only exposed to esr portal.

Table of Contents

VIM

VIM registration

Interface DefinitionDescription
URI

/api/aai-esr-server/v1/vims

Operation TypePOST

...

AttributeQualifierDefaultContentDescription
cloudOwnerM
Stringcloud owner name, can be customized, e.g. att-aic
cloudRegionIdM
Stringcloud region info based on deployment, e.g. RegionOne
cloudTypeM
Stringtype of the cloud, decides which multicloud plugin to use, openstack or vio
cloudRegionVersionM
Stringcloud version, ocata, mitaka or other
ownerDefinedTypeO
StringCloud-owner defined type indicator (e.g., dcp, lcp)
cloudZoneO
StringZone where the cloud is homed.
complexNameO
Stringcomplex name for cloud-region instance.
cloudExtraInfoO
Stringextra info for Cloud
authInfoItemsvimAuthInfosM1[Obj]Auth information of Cloud

authInfoItem:

AttributeQualifierDefaultContentDescription
cloudDomainM
Stringdomain info for keystone v3
userNameM
StringUser name
passwordM
StringPassword
authUrlM
Stringauthentication url of the cloud, e.g. keystone url
ssl-cacert
sslCacertO
Stringca file content if enabled ssl on auth-url
ssl-insecure
sslInsecureO
BooleanWhether to verify VIM's certificate

Request Sample:
/api/aai-esr-server/v1/vims

Body:

{
"

...

cloudOwner": "ZTE",
"

...

cloudRegionId": "

...

region-one",
"

...

cloudType": "

...

openstack",
"

...

cloudRegionVersion":

...

 "v1.0",
"

...

ownerDefinedType": "owner-defined-type",
"

...

cloudZone": "cloud zone",
"

...

complexName": "complex name",
"

...

cloudExtraInfo": "cloud-extra-info",
"

...

vimAuthInfos": 
[

...

{
"

...

userName": "admin",
"password": "admin",
"

...

authUrl": "http://10.74.151.13:5000/v2.0",
"

...

sslCacert": "ssl-cacert",
"

...

sslInsecure":

...

 true

...

,
"

...

cloudDomain": "cloud-domain"
}

...

]
}


Response:

Success Code: 201200

body:

{
"cloudOwner": "ZTE",
"cloudRegionId": "region-one"
}

Errorcode: 500 Internal Server Error

Update VIM info

Interface Definition

Description

URI/api/aai-esr-server/v1/vims/{cloudOwner}/{cloudRegionId}
Operation TypePUT

...

AttributeQualifierDefaultContentDescription
cloudTypeM
Stringtype of the cloud, decides which multicloud plugin to use, openstack or vio
cloudRegionVersionM
Stringcloud version, ocata, mitaka or other
ownerDefinedTypeO
StringCloud-owner defined type indicator (e.g., dcp, lcp)
cloudZoneO
StringZone where the cloud is homed.
complexNameO
Stringcomplex name for cloud-region instance.
cloudExtraInfoO
Stringextra info for Cloud
authInfoItems
vimAuthInfos
M
[Obj]Auth information of Cloud

...

AttributeQualifierDefaultContentDescription
cloudDomainM
Stringdomain info for keystone v3
userNameM
StringUser name
passwordM
StringPassword
authUrlM
Stringauthentication url of the cloud, e.g. keystone url
ssl-cacert
sslCacert
O
Stringca file content if enabled ssl on auth-urlssl-insecure
sslInsecureO
BooleanWhether to verify VIM's certificate


Request Sample:
/api/aai-esr-server/v1/vims/ZTE/region-one

{
"statuscloudOwner": "activeZTE",
"cloud-typecloudRegionId": "region-one",
"cloudType": "openstack",
"cloud-region-versioncloudRegionVersion": "v1.0",
"owner-defined-typeownerDefinedType": "owner-defined-type",
"cloud-zonecloudZone": "cloud zone",
"complex-namecomplexName": "complex name",
"cloud-extra-infocloudExtraInfo": "cloud-extra-info",
"auth-info-itemsvimAuthInfos":
[
{
"usernameuserName": "admin",
"password": "admin",
"auth-url"authUrl": "http://10.74.151.13:5000/v2.0",
"ssl-cacertsslCacert": "ssl-cacert",
"ssl-insecuresslInsecure": "ssl-insecure"true,
"cloud-domaincloudDomain": "cloud-domain"
}
]
}

Get VIM

Interface DefinitionDescription
URI

/api/aai-esr-server/v1/vims/{cloud-ownercloudOwner}/{cloud-region-idcloudRegionId}

Operation TypeGET

Request Parameters:

...

Request Sample:
/api/aai-esr-server/v1/vims/ZTE/region-one

Response Parameters:

VIM

Get all VIM

Interface DefinitionDescription
URI/api/aai-esr-server/v1/vims
Operation TypeGET

...

Request Sample:
/api/aai-esr-server/v1/vims/

Response Parameters:
List<VIM>

Delete VIM

Interface DefinitionDescription
URI/api/aai-esr-server/v1/vims?cloudOwner=xxx&cloudRegionId=xxx/{cloudOwner}/{cloudRegionId}
Operation TypeDELETE

Request Parameters:

...

Request Sample:
/api/aai-esr-server/v1/vims?cloudOwner=owner&cloudRegionId=/owner/region-one

Response:

Success Code: 204

Errorcode: 500 Internal Server Error

VNFM

VNFM registration

Interface DefinitionDescription
URI/api/aai-esr-server/v1/vnfms
Operation TypePOST

...

AttributeQualifierCardinalityContentDescription
nameM1StringVNFM name
typeM1StringVNFM type
vimIdO0..1StringRelated VIM
vendorM1StringVNFM vendor
versionM1StringVNFM versiondescriptionO
0..1StringVNFM descriptioncertificateUrlO0..1Stringcertificate url
urlM1StringAccess url
userNameO0..1StringUser name
passwordO0..1StringPassword

...

       "type":"Tacker",
       "vimId":"",
       "vendor":"ZTE",
       "version":"v1.0",
       "description":"vnfm",
       "url":"http://10.74.44.11",
       "certificateUrl":"",
       "userName":"admin",
       "password":"admin"
   }

...

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

}

Success Code: 201200

Errorcode: 500 Internal Server Error

VNFM update

Interface DefinitionDescription
URI/api/aai-esr-server/v1/vnfms/{vnfmId}
Operation TypePOSTPUT

Request Parameters:

AttributeQualifierCardinalityContentDescription
nameM1StringVNFM name
typeM1StringVNFM type
vimIdO0..1StringRelated VIM
vendorM1StringVNFM vendor
versionM1StringVNFM version
descriptioncertificateUrlO0..1StringVNFM description
certificateUrlO0..1Stringcertificate url
certificate url
urlM1StringAccess url
userNameO0..1StringUser name
passwordO0..1StringPassword

...

       "type":"Tacker",
       "vimId":"",
       "vendor":"ZTE",
       "version":"v1.0",
       "description":"vnfm",
       "url":"http://10.74.44.11",
       "certificateUrl":"",
       "userName":"admin",
       "password":"admin"
   }

Response:

Success Code: 201200

Errorcode: 500 Internal Server Error


Get VNFM

Interface DefinitionDescription
URI/api/aai-esr-server/v1/vnfms/{vnfmId}
Operation TypeGET

...

Request Sample:
/api/aai-esr-server/v1/vnfms/19ecbb3a-3242-4fa3-9926-8dfb7ddc29ee

Response Parameters:
VNFM

Response Sample:

Success Code: 201200

   {
       "vnfmId":"19ecbb3a-3242-4fa3-9926-8dfb7ddc29ee",
       "name":"vnfm",
       "type":"Tacker",
       "vimId":"",
       "vendor":"ZTE",
       "version":"v1.0",
       "description":"vnfm",
       "certificateUrl":"",
       "url":"http://10.74.44.11",
       "userName":"admin",
       "password":"admin",
   }

Get all VNFM

Interface DefinitionDescription
URI/api/aai-esr-server/v1/vnfms
Operation TypeGET

...

Response Parameters:
List<VNFM>

Response Sample:

Success Code: 201200   
 [
       {
           "vnfmId":"19ecbb3a-3242-4fa3-9926-8dfb7ddc29ee",
           "name":"vnfm",
           "type":"Tacker",
           "vimId":"",
           "vendor":"ZTE",
           "version":"v1.0",
           "description":"vnfm",
           "certificateUrl":"",
           "url":"http://10.74.44.11",
           "userName":"admin",
           "password":"admin"
       }
   ]

Delete VNFM

Interface DefinitionDescription
URI/api/aai-esr-server/v1/vnfms/{vnfmId}
Operation TypeDELETE

...

AttributeQualifierCardinalityContentDescription
vnfmIdM1StringVNFM identifier

Request Sample:
/api/aai-esr-vnfmserver/v1/vnfms/19ecbb3a-3242-4fa3-9926-8dfb7ddc29ee

...

Errorcode: 500 Internal Server Error

SDN Controller

SDN Controller registration 

Interface DefinitionDescription
URI/api/aai-esr-server/v1/sdncontrollers
Operation TypePOST

...

"sdnControllerId":"a6c42529-cd6b-4c01-b149-03eb54b20a03",

}

Success Code: 201200

Errorcode: 500 Internal Server Error

Update SDN Controller info

Interface DefinitionDescription
URI/api/aai-esr-server/v1/sdncontrollers/{sdnControllerId}
Operation TypePUT

...

"type":"WAN"

}

Response:

Success Code: 201200

Errorcode: 500 Internal Server Error

Get SDN Controller

Interface DefinitionDescription
URI/api/aai-esr-server/v1/sdncontrollers/{sdnControllerId}
Operation TypeGET

...

Request Sample:
/api/aai-esr-server/v1/sdncontrollers/57674786-5b2e-4c92-bb68-578dbd79e2f5

Response Parameters:
SDN Controller

Response Sample:

Success Code: 201200

   {
       "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":"WAN"
   }

Get all SDN Controller

Interface DefinitionDescription
URI/api/aai-esr-server/v1/sdncontrollers
Operation TypeGET

...

Response Parameters:
List<SDN Controller>

Response Sample:

Success Code: 201200  
 [
       {
           "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":"WAN"
       }
   ]

Delete SDN Controller

Interface DefinitionDescription
URI/api/aai-esr-server/v1/sdncontrollers/{sdnControllerId}
Operation TypeDELETE

...

Errorcode: 500 Internal Server Error


EMS

EMS registration 

Interface DefinitionDescription
URI/api/aai-esr-server/v1/emses
Operation TypePOST

Request Parameters:

...

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

}

Success Code: 201200

Errorcode: 500 Internal Server Error

Update EMS info

Interface DefinitionDescription
URI/api/aai-esr-server/v1/emses/{emsId}
Operation TypePUT

Request Parameters:

AttributeQualifierCardinalityContentDescription
nameM1StringEMS name
vendorM1Stringvendor
versionM1Stringversion
descriptionO0..1Stringdescription
resourceAddrM1ObjAddress to get resource data
performanceAddrM1ObjAddress to get performance data
alarmAddrM1ObjAddress 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:

/api/aai-esr-server/v1/emses

...

"alarmAddr": {
        "ip": "10.44.55.145",
        "port": 2000,
        "user": "root",
        "password": "test"

}

}


Get EMS by id

Interface DefinitionDescription
URI/api/aai-esr-server/v1/emses/{emsId}
Operation TypeGET

...

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

Response Parameters:
EMS

Response Sample:

{

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

...

"alarmAddr": {
        "ip": "10.44.55.145",
        "port": 2000,
        "user": "root",
        "password": "test"

}

}

Get all EMS

Interface DefinitionDescription
URI/api/aai-esr-server/v1/emses
Operation TypeGET

Request Parameters:
N/A

Request Sample:
/api/aai-esr-server/v1/emses

Response Parameters:
List<EMS>

Response Sample:

Success Code: 201200

[

{

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

...

"alarmAddr": {
        "ip": "10.44.55.145",
        "port": 2000,
        "user": "root",
        "password": "test"

}

}

]

Delete EMS

Interface DefinitionDescription
URI/api/aai-esr-server/v1/emses/{emsId}
Operation TypeDELETE

...

Errorcode: 500 Internal Server Error

Information elements

VNFM


PNF

PNF registration

Interface Definition

Description

URI/api/aai-esr-server/v1/pnfs
Operation TypePOST

Request Parameters:

Attribute

Qualifier

Cardinality

Content

Description

vnfmId
pnfId
O
M
0..name
1String
VNFM UUID generated by ESR
unique ID of PNF
userLabelM1String
VNFM
PNF system name
type0..
subnetIdM1String
VNFM typevimIdOvendorM
subnet ID of DU network element
neIdM1String
Related VIM
network element ID
managementTypeO1String
VNFM

vendor
version
O
M
1String
VNFM version

pnfdId
description0..
M
O
1String
VNFM descriptioncertificateUrlO0..1Stringcertificate urlurl

emsIdM1String
Access urluserName

lattitudeO
0..
1String
User namepassword

longitudeO
0..
1String
Password

VIM

...


...

Request Sample:
/api/aai-esr-server/v1/pnfs

Body:

   {
       "pnfId":"dafdaf3213dfa",
       "userLabel":"pnf1",
       "subnetId":"15da65fa1f",
       "neId":"4f6asd8ff4asd",
       "managementType":"test",
       "vendor":"zte",
       "pnfdId":"8f7adfa8fa9",
       "emsId":"fdsa5f4afd4a",
       "lattitude":"156.446",
       "longitude":"121.154"
   }

Response:


Success Code: 200

Errorcode: 500 Internal Server Error

Update PNF info

Interface Definition

Description

URI/api/aai-esr-server/v1/pnfs/{pnfId}
Operation TypePUT

Request Parameters:

Attribute

Qualifier

Cardinality

Content

Description

pnfIdM1Stringunique ID of PNF
userLabelM1StringPNF system name
subnetIdM1Stringsubnet ID of DU network element
neIdM1Stringnetwork element ID
managementTypeO1String
vendorO1String
pnfdIdM1String
emsIdM1String
lattitudeO1String
longitudeO1String


Body:Request Sample:
/api/aai-esr-server/v1/pnfs/dafdaf3213dfa

   {
       "pnfId":"dafdaf3213dfa",
       "userLabel":"pnf1",
       "subnetId":"15da65fa1f",
       "neId":"4f6asd8ff4asd",
       "managementType":"test",
       "vendor":"zte",
       "pnfdId":"8f7adfa8fa9",
       "emsId":"fdsa5f4afd4a",
       "lattitude":"156.446",
       "longitude":"121.154"
   }

Response:

Success Code: 200

Errorcode: 500 Internal Server Error

Get PNF by ID

Interface Definition

Description

URI/api/aai-esr-server/v1/pnfs/{pnfId}
Operation TypeGET

Request Parameters:

Attribute

Qualifier

Cardinality

Content

Description

pnfIdM1StringPNF identifier

Request Sample:
/api/aai-esr-server/v1/pnfs/dafdaf3213dfa

Response Parameters:
PNF

Response Sample:

Success Code: 200

   {
       "pnfId":"dafdaf3213dfa",
       "userLabel":"pnf1",
       "subnetId":"15da65fa1f",
       "neId":"4f6asd8ff4asd",
       "managementType":"test",
       "vendor":"zte",
       "pnfdId":"8f7adfa8fa9",
       "emsId":"fdsa5f4afd4a",
       "lattitude":"156.446",
       "longitude":"121.154"
   }

Get all PNF

Interface Definition

Description

URI/api/aai-esr-server/v1/pnfs
Operation TypeGET

Request Parameters:
N/A

Request Sample:
/api/aai-esr-server/v1/pnfs

Response Parameters:
List<PNF>

Response Sample:

Success Code: 200   
 [
   {
       "pnfId":"dafdaf3213dfa",
       "userLabel":"pnf1",
       "subnetId":"15da65fa1f",
       "neId":"4f6asd8ff4asd",
       "managementType":"test",
       "vendor":"zte",
       "pnfdId":"8f7adfa8fa9",
       "emsId":"fdsa5f4afd4a",
       "lattitude":"156.446",
       "longitude":"121.154"
   }
   ]

Delete PNF

Interface Definition

Description

URI/api/aai-esr-server/v1/pnfs/{pnfId}
Operation TypeDELETE

Request Parameters:

Attribute

Qualifier

Cardinality

Content

Description

pnfIdM1StringPNF identifier

Request Sample:
/api/aai-esr-server/v1/pnfs/dafdaf3213dfa

Response:

Success Code: 204

Errorcode: 500 Internal Server Error

Information elements

VNFM

AttributeQualifierCardinalityContentDescription
vnfmIdO0..1StringVNFM UUID generated by ESR
nameM1StringVNFM name
typeM1StringVNFM type
vimIdO0..1StringRelated VIM
vendorM1StringVNFM vendor
versionM1StringVNFM version
certificateUrlO0..1Stringcertificate url
urlM1StringAccess url
userNameO0..1StringUser name
passwordO0..1StringPassword

VIM

AttributeQualifierCardinalityContentDescriptionauth-
AttributeQualifierDefaultContentDescription
cloudOwnerM
Stringcloud owner name, can be customized, e.g. att-aic
cloudRegionIdM
Stringcloud region info based on deployment, e.g. RegionOne
cloudTypeM
Stringtype of the cloud, decides which multicloud plugin to use, openstack or vio
cloudRegionVersionM
Stringcloud version, ocata, mitaka or other
ownerDefinedTypeO
StringCloud-owner defined type indicator
cloud-region-versionO0...1StringSoftware version employed at the site
identity-urlO0...1StringURL of the keystone identity service
cloud-zoneO0...1(e.g., dcp, lcp)
cloudZoneO
StringZone where the cloud is homed.
complex-nameO0...1complexNameO
Stringcomplex name for cloud-region instanceresource-versionO0...1complex name for cloud-region instance.
cloudExtraInfoO
StringUsed for optimistic concurrency. Must be empty on create, valid on update and delete.
volume-groupsO0...1object[]definition detail see AAI API
tenantsO0...1object[]definition detail see AAI API
flavorsO0...1object[]definition detail see AAI API
group-assignmentsO0...1object[]definition detail see AAI API
snapshotsO0...1object[]definition detail see AAI API
imagesO0...1object[]definition detail see AAI API
availability-zonesO0...1object[]definition detail see AAI API
relationship-listO0...1object[]definition detail see AAI API
authInfoItemsM1object[]Auth information of Cloud

auth-info-items

extra info for Cloud
vimAuthInfosM1[Obj]Auth information of Cloud

vimAuthInfo:

AttributeQualifierDefaultContentDescription
cloudDomainM
Stringdomain info for keystone v3
userNameM
StringUser name
passwordM
StringPassword
authUrlM
Stringauthentication url of the cloud, e.g. keystone url
defaultTenantO
String
sslCacertO
Stringca file content if enabled ssl on auth-url
sslInsecureO
BooleanWhether to verify VIM's certificate


SDN Controller

AttributeQualifierCardinalityContentDescription

sdnControllerId

M1StringUUID of sdncontroller
nameM1StringSDN Controller name
locationO1Stringfit for DC type
urlM1StringAccess url
username
vendorM1String
User name
SDNC vendor
password
versionM1String
Passworddefault-tenantM
SDNC version
descriptionO0..1String
Tenant namecloud-domain
SDNC description
productNameO0..1String
Domain

SDN Controller

sdnControllerIdO
AttributeQualifierCardinalityContentDescription
SDNC productName
protocolM1Enum{netconf/snmp}protocol
userNameM1StringUser name
passwordM1StringUUID of sdncontroller
nameM1StringSDN Controller name
locationPassword
typeM1Enum{WAN/DC}SDN Controller type

EMS

AttributeQualifierCardinalityContentDescription
emsIdM1Stringfit for DC typeurlMEMS identifier
nameO0..1StringAccess urlEMS name
vendorMO0..1StringSDNC vendorVendor
versionMO0..1StringSDNC version
descriptionO0..1StringSDNC description
productNameresourceAddrO0..1StringSDNC productName
protocolM1Enum{netconf/snmp}protocol
userNameM1StringUser name
passwordM1StringPassword
typeM1Enum{WAN/DC}SDN Controller type

...

ObjAddress to get resource data
performanceAddrO0..1ObjAddress to get performance data
alarmAddrO0..1ObjAddress to get alarm data

resourceAddr

versiondescriptiondescriptionresourceAddrperformanceAddralarmAddr
AttributeQualifierCardinalityContentDescription
emsIdM1StringEMS identifier
nameftptypeO0..1StringEMS namevendorEnum{ftp/sftp}ftp type
ipO0..1StringVendorservice IP of ftp server
portO0..1Stringversionservice port of ftp server
userO0..1Stringftp user name
passwordO0..1ObjAddress to get resource dataStringftp password
remotepathO0..1ObjAddress to get performance dataStringresource data file path
passiveO0..1ObjAddress to get alarm data

...

Booleanftp 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..1String
resource
performance data file path
passiveO0..1Booleanftp passive mode or not

...

alarmAddr

AttributeQualifierCardinalityContentDescription
ftptypeip
ipO0..1
Enum{ftp/sftp}ftp type
Stringservice IP of ftp server
portO0..1Stringservice
IP
port of ftp server
port
userO0..1String
service port of
ftp
server
user name
user
passwordO0..1Stringftp
user namepasswordO0..1Stringftp passwordremotepathO0..1Stringperformance data file pathpassiveO0..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 passwordpassword


PNF

Attribute

Qualifier

Cardinality

Content

Description

pnfIdM1Stringunique ID of PNF
userLabelM1StringPNF system name
subnetIdM1Stringsubnet ID of DU network element
neIdM1Stringnetwork element ID
managementTypeO1String
vendorO1String
pnfdIdM1String
emsIdM1String
lattitudeO1String
longitudeO1String