blob: 5441ae74257275fa5e90681c2d42ce5e973ab5dd (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
|
.. This work is licensed under a Creative Commons Attribution 4.0 International License.
.. http://creativecommons.org/licenses/by/4.0
.. Copyright 2017 Huawei Technologies Co., Ltd.
.. _offeredapis:
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
|
