ESR server Component Offered APIs

The esr server module provides the following APIs.

  • VIM register
  • VIM query
  • VIM update
  • VIM Deletion
  • VNFM register
  • VNFM query
  • VNFM update
  • VNFM Deletion
  • EMS register
  • EMS query
  • EMS update
  • EMS Deletion
  • thirdparty SDNC register
  • thirdparty SDNC query
  • thirdparty SDNC update
  • thirdparty SDNC Deletion

vnfm Management

POST /vnfms

create a vnfm

  • Produces: [u’text/plain’, u’application/json’]
  • Description:
  • Consumes: [u’application/json’]

Parameters

Name Position Description Type
body body vnfm

Responses

415 - Unprocessable MicroServiceInfo Entity

404 - microservice not found

500 - internal server error

GET /vnfms

get all vnfm

  • Produces: [u’application/json’]
  • Description:

Responses

415 - Unprocessable MicroServiceInfo Entity

404 - microservice not found

500 - internal server error

PUT /vnfms/{vnfmId}

update a vnfm

  • Produces: [u’text/plain’, u’application/json’]
  • Description:
  • Consumes: [u’application/json’]

Parameters

Name Position Description Type
body body vnfm
vnfmId path vnfm id string

Responses

415 - Unprocessable MicroServiceInfo Entity

404 - microservice not found

500 - internal server error

DELETE /vnfms/{vnfmId}

delete a vnfm

  • Description:

Parameters

Name Position Description Type
vnfmId path vnfm id string

Responses

415 - Unprocessable MicroServiceInfo Entity

404 - microservice not found

500 - internal server error

GET /vnfms/{vnfmId}

get vnfm by id

  • Produces: [u’application/json’]
  • Description:

Parameters

Name Position Description Type
vnfmId path vnfm id string

Responses

415 - Unprocessable MicroServiceInfo Entity

404 - microservice not found

500 - internal server error

vim Management

PUT /vims/{cloudOwner}/{cloudRegionId}

update a vim

  • Produces: [u’application/json’]
  • Description:
  • Consumes: [u’application/json’]

Parameters

Name Position Description Type
cloudOwner path string
cloudRegionId path string

Responses

415 - Unprocessable MicroServiceInfo Entity

404 - microservice not found

500 - internal server error

DELETE /vims/{cloudOwner}/{cloudRegionId}

delete a vim

  • Description:

Parameters

Name Position Description Type
cloudOwner path string
cloudRegionId path string

Responses

415 - Unprocessable MicroServiceInfo Entity

404 - microservice not found

500 - internal server error

GET /vims/{cloudOwner}/{cloudRegionId}

get vim by id

  • Produces: [u’application/json’]
  • Description:

Parameters

Name Position Description Type
cloudOwner path string
cloudRegionId path string

Responses

415 - Unprocessable MicroServiceInfo Entity

404 - microservice not found

500 - internal server error

POST /vims

create a vim

  • Produces: [u’text/plain’, u’application/json’]
  • Description:
  • Consumes: [u’application/json’]

Responses

415 - Unprocessable MicroServiceInfo Entity

404 - microservice not found

500 - internal server error

GET /vims

get all vim

  • Produces: [u’application/json’]
  • Description:

Responses

415 - Unprocessable MicroServiceInfo Entity

404 - microservice not found

500 - internal server error

ThirdParty sdnc Management

POST /sdncontrollers

register a thirdparty sdnc

  • Produces: [u’text/plain’, u’application/json’]
  • Description:
  • Consumes: [u’application/json’]

Parameters

Name Position Description Type
body body thirdPartySdnc

Responses

415 - Unprocessable MicroServiceInfo Entity

404 - microservice not found

500 - internal server error

GET /sdncontrollers

get all thirdParty sdnc

  • Produces: [u’application/json’]
  • Description:

Responses

415 - Unprocessable MicroServiceInfo Entity

404 - microservice not found

500 - internal server error

PUT /sdncontrollers/{thirdPartySdncId}

update a thirdParty Sdnc

  • Produces: [u’text/plain’, u’application/json’]
  • Description:
  • Consumes: [u’application/json’]

Parameters

Name Position Description Type
body body thirdpartySdnc
thirdPartySdncId path sdnc id string

Responses

415 - Unprocessable MicroServiceInfo Entity

404 - microservice not found

500 - internal server error

DELETE /sdncontrollers/{thirdPartySdncId}

delete a thirdparty sdnc

  • Description:

Parameters

Name Position Description Type
thirdPartySdncId path thirdparty sdnc id string

Responses

415 - Unprocessable MicroServiceInfo Entity

404 - microservice not found

500 - internal server error

GET /sdncontrollers/{thirdPartySdncId}

get thirdParty sdnc by id

  • Produces: [u’application/json’]
  • Description:

Parameters

Name Position Description Type
thirdPartySdncId path thirdparty sdnc id string

Responses

415 - Unprocessable MicroServiceInfo Entity

404 - microservice not found

500 - internal server error

ems Management

PUT /emses/{emsId}

update a ems

  • Produces: [u’text/plain’, u’application/json’]
  • Description:
  • Consumes: [u’application/json’]

Parameters

Name Position Description Type
body body ems
emsId path ems id string

Responses

415 - Unprocessable MicroServiceInfo Entity

404 - microservice not found

500 - internal server error

DELETE /emses/{emsId}

delete a ems

  • Description:

Parameters

Name Position Description Type
emsId path ems id string

Responses

415 - Unprocessable MicroServiceInfo Entity

404 - microservice not found

500 - internal server error

GET /emses/{emsId}

get ems by id

  • Produces: [u’application/json’]
  • Description:

Parameters

Name Position Description Type
emsId path ems id string

Responses

415 - Unprocessable MicroServiceInfo Entity

404 - microservice not found

500 - internal server error

POST /emses

create a ems

  • Produces: [u’text/plain’, u’application/json’]
  • Description:
  • Consumes: [u’application/json’]

Parameters

Name Position Description Type
body body ems

Responses

415 - Unprocessable MicroServiceInfo Entity

404 - microservice not found

500 - internal server error

GET /emses

get all ems

  • Produces: [u’application/json’]
  • Description:

Responses

415 - Unprocessable MicroServiceInfo Entity

404 - microservice not found

500 - internal server error

service test

GET /test

service test

  • Produces: [u’application/json’]
  • Description:

Responses

415 - Unprocessable MicroServiceInfo Entity

404 - microservice not found

500 - internal server error