VNF SDK APIs

Market Place API

Upload/Re-upload VNF Package

Interface Definition Description
URI /onapapi/marketplace/v1/csars
Operation Type POST
Content-Type multipart/form-data

Request Parameters:

Attribute Qualifier Cardinality Content Description
file M 1 InputStream The CSAR file stream
file M 1 FormDataContentDisposition The detail of CSAR file

FormDataContentDisposition

Attribute Content Description
type String the disposition type. will be “form-data”
name String the control name
fileName String the file name
creationDate Date the creation date
modificationDate Date the modification date
readDate Date the read date
size String the size
parameters Map<String,String> the parameters

Response:

Attribute Qualifier Cardinality Content Description
csarId M 1 String The CSAR identifier is a unique identifier generated by the Market place

Delete VNF package by csarId

Interface Definition Description
URI /onapapi/marketplace/v1/csars/{csarId}
Operation Type DELETE

Request Parameters:

Attribute Qualifier Cardinality Content Description
csarId M 1 String The id of CSAR package

Response:

HTTP Success or Error Code

Download VNF package files

Interface Definition Description
URI /onapapi/marketplace/v1/csars/{csarId}/files
Operation Type GET

Request Parameters:

Attribute Qualifier Cardinality Content Description
csarId M 1 String The id of CSAR

Sample:

/onapapi/marketplace/v1/csars/78ede6f3-66cc-46ab-b748-38a6c010d272/files?

Response:

CSAR Package

Query VNF package information by csarId

Interface Definition Description
URI /onapapi/marketplace/v1/csars/{csarId}
Operation Type GET

Request Parameters:

Attribute Qualifier Cardinality Content Description
csarId M 1 String The id of CSAR package

Response:

PackageMetaData

Attribute Qualifier Cardinality Content Description
csarId M 1 String The id of CSAR package
name M 1 String Name of package
provider M 1 String Provider company name
version M 1 String version of the package
createTime M 1 String create time of package
modifyTime M 1 String modify time of package
downloadUri M 1 String download uri
size M 1 String size of the package
downloadCount M 1 Integer Number of times the package is download from marketplace
shortdesc M 1 String Short description
details M 1 String Detailed description

Sample:

{
   "csarId":"78ede6f3-66cc-46ab-b748-38a6c010d272",
   "name":"NanocellGateway",
   "provider":"XYZ",
   "version":"V1.0",
   "createTime":"2016-06-29 03:33:15",
   "modifyTime":"2016-06-29 09:33:15",
   "size":"0.93M",
   "downloadUri":"http://msb_ip:msb_port/files/marketplace/CSAR/XYZ/NanocellGW/v1.0/NanocellGateway.csar",
   "type":"CSAR"
}

Query list of VNF package information by conditions

Interface Definition Description
URI /onapapi/marketplace/v1/csars?name={name}&version={version}&type={type}&provider={provider}
Operation Type GET

Query Param

Attribute Qualifier Cardinality Content Description
name M 1 String csar Name
version M 1 String csar version
type M 1 String csar type
provider M 1 String csar provider

Response:

List of PackageMetaData