5 "title": "ONAP VNFM Driver Development Related API",
6 "description": "ONAP VNFM Driver Development Related Rest API.",
8 "name": "ONAP VFC team",
9 "email": "onap-discuss@lists.onap.org",
10 "url": "https://gerrit.onap.org/r/#/admin/projects/vfc/nfvo/lcm"
25 "/{vnfmtype}/v1/{vnfmid}/vnfs": {
30 "summary": "vnf create&instantiate",
31 "description": "VNF create&instantiate Rest API should be provided by the VNFM Driver",
32 "operationId": "vnf_instantiate",
43 "description": "The value of vnfmtype should be the SVNFM driver service name",
50 "description": "The value of vnfmid should be the VNFM Instantiate ID",
57 "description": "instantiate request param",
60 "$ref": "#/definitions/VnfInstantiateRequest"
68 "$ref": "#/definitions/VnfInstantiateResponse"
74 "/{vnfmtype}/v1/{vnfmid}/vnfs/{vnfInstanceId}/scale": {
79 "summary": "vnf Scale",
80 "description": "VNF Scale Rest API should be provided by the VNFM Driver",
81 "operationId": "vnf_scale",
92 "description": "The value of vnfmtype should be the SVNFM driver service name",
99 "description": "The value of vnfmid should be the VNFM Instantiate ID",
106 "description": "The value of vnfInstanceId should be the VNF Instantiate ID",
107 "name": "vnfInstanceId",
113 "description": "instantiate request param",
116 "$ref": "#/definitions/VnfScaleRequest"
124 "$ref": "#/definitions/JobInfo"
128 "description": "the VNF instance id is wrong"
131 "description": "the url is invalid"
136 "/{vnfmtype}/v1/{vnfmid}/vnfs/{vnfInstanceId}/heal": {
141 "summary": "vnf heal",
142 "description": "VNF Heal Rest API should be provided by the VNFM Driver",
143 "operationId": "vnf_heal",
154 "description": "The value of vnfmtype should be the SVNFM driver service name",
161 "description": "The value of vnfmid should be the VNFM Instantiate ID",
168 "description": "The value of vnfInstanceId should be the VNF Instantiate ID",
169 "name": "vnfInstanceId",
175 "description": "instantiate request param",
178 "$ref": "#/definitions/VnfHealRequest"
186 "$ref": "#/definitions/JobInfo"
190 "description": "the VNF instance id is wrong"
193 "description": "the url is invalid"
198 "/{vnfmtype}/v1/{vnfmid}/vnfs/{vnfInstanceId}/terminate": {
203 "summary": "terminate&delete vnf",
204 "description": "VNF terminate&delete Rest API should be provided by the VNFM Driver",
205 "operationId": "terminate_vnf",
216 "description": "The value of vnfmtype should be the SVNFM driver service name",
223 "description": "The value of vnfmid should be the VNFM Instantiate ID",
230 "description": "The value of vnfInstanceId should be the VNF Instantiate ID",
231 "name": "vnfInstanceId",
237 "description": "instantiate request param",
240 "$ref": "#/definitions/VnfTerminateRequest"
246 "description": "successful operation",
248 "$ref": "#/definitions/JobInfo"
252 "description": "the VNF instance id is wrong"
255 "description": "the url is invalid"
260 "/{vnfmtype}/v1/{vnfmid}/vnfs/{vnfInstanceId}": {
265 "summary": "query the specified vnf info",
267 "operationId": "query_vnf",
278 "description": "The value of vnfmtype should be the SVNFM driver service name",
285 "description": "The value of vnfmid should be the VNFM Instantiate ID",
292 "description": "The value of vnfInstanceId should be the VNF Instantiate ID",
293 "name": "vnfInstanceId",
299 "description": "successful operation",
301 "$ref": "#/definitions/VnfInfo"
305 "description": "the vnf instance id is wrong"
308 "description": "the url is invalid"
313 "/nslcm/v1/ns/grantvnf": {
318 "summary": "grantvnf",
319 "description": "Grant VNF, provived by the NSLCM component",
320 "operationId": "grantvnf",
325 "description": "Grant VNF Request",
328 "$ref": "#/definitions/GrantVNFRequest"
336 "$ref": "#/definitions/GrantVNFResponse"
340 "description": "URL not found"
343 "description": "the url is invalid"
348 "/nslcm/v1/ns/{vnfmid}/vnfs/{vnfInstanceId}/Notify": {
353 "summary": "VNF LCM Notification",
354 "description": "VNF LCM Notification API should be provided by NSLCM component",
355 "operationId": "VNF_LCM_Notification",
360 "description": "VNFM Instance Id",
367 "description": "VNF Instance Id",
368 "name": "vnfInstanceId",
373 "name": "vnf Notification",
374 "description": "VNF LCM Notification",
377 "$ref": "#/definitions/VNFLCMNotification"
386 "description": "URL not found"
389 "description": "the url is invalid"
394 "/{vnfmid}/jobs/{jobid}": {
399 "summary": "jobstatus",
400 "description": "Job Infomation API should be provided by VNFM Driver",
401 "operationId": "get_jobstatus",
406 "description": "job Id",
413 "description": "The value of vnfmid should be the VNFM Instantiate ID",
420 "description": "job response message id",
421 "name": "responseId",
429 "$ref": "#/definitions/JobDetailInfo"
435 "/catalog/v1/vnfpackages/{csarId}": {
440 "summary": "query vnf package info",
441 "description": "query one vnf package info via vnf package csarId",
442 "operationId": "query_vnf_package",
453 "description": "csar id of vnf package",
460 "description": "successful operation",
462 "$ref": "#/definitions/VnfPkgDetailInfo"
466 "description": "internal error"
471 "/nslcm/v1/vnfms/{vnfmid}":{
476 "summary": "Query VNFM register info",
477 "description": "query VNFM register info",
478 "operationId": "query_vnfm_info",
489 "description": "vnfm id",
496 "description": "successful operation",
498 "$ref": "#/definitions/VnfmInfo"
502 "description": "URL not found"
505 "description": "internal error"
510 "/nslcm/v1/vims/{vimid}":{
515 "summary": "Query VIM register info",
516 "description": "query VIM register info",
517 "operationId": "query_VIM_info",
528 "description": "vim id",
535 "description": "successful operation",
537 "$ref": "#/definitions/VimInfo"
541 "description": "URL not found"
544 "description": "internal error"
560 "statusDescription": {
572 "description": "The status of the job",
588 "responseDescriptor": {
592 "$ref": "#/definitions/JobStatus",
593 "description": "The status of the job"
597 "description": "The progress of the job. Value between 0 and 100."
599 "statusDescription": {
601 "description": "The reason of the current status of the job."
609 "responseHistoryList": {
612 "$ref": "#/definitions/jobResponseInfo"
620 "description": "The type of the change",
630 "$ref": "#/definitions/ChangeType",
631 "description": "The type of the resource."
633 "resourceDefinitionId": {
634 "description": "The identifier of the resource within the grant request.",
638 "description": "The identifier of the VDU.",
644 "description": "The type of operation",
665 "lifecycleOperation": {
666 "description" : "The type of the operation.",
667 "$ref": "#/definitions/OperationType"
675 "$ref": "#/definitions/ResourceChange"
681 "$ref": "#/definitions/ResourceChange"
686 "description": "Additional parameters passed to the NFVO, specific to the VNF and the LCM operation. The currently interpreted keys are the following: vimId"
690 "GrantVNFResponse": {
704 "description": "The name of the tenant"
712 "VnfNotificationType": {
713 "description": "The type of the notification",
726 "description": "Identifier of the VNFC instance"
730 "description": "Identifier of the VDU in the VNFD"
733 "$ref": "#/definitions/VnfNotificationType",
734 "description": "The type of the change"
738 "description": "Identifier of vim"
742 "description": "Identifier of virtual machine"
746 "description": "Name of virtual machine"
750 "AffectedVirtualLinkType": {
751 "description": "The type of the affected virtual link",
758 "AffectedVirtualLink":{
763 "description": "Identifier of the VL instance"
767 "description": "Identifier of the VLD in the VNFD"
770 "$ref": "#/definitions/VnfNotificationType",
771 "description": "The type of the change"
775 "description": "network Resource",
778 "$ref": "#/definitions/AffectedVirtualLinkType",
779 "description": "Must be network"
783 "description": "Identifier of the resource in the scope of the VIM"
787 "description": "Name of the resource in the scope of the VIM"
793 "VnfCpNotificationType": {
794 "description": "The type of the notification for connection points",
805 "virtualLinkInstanceId": {
807 "description": "Identifier of the VL instance"
811 "description": "Identifier of the connection point"
815 "description": "Identifier of the connection point in the VNFD"
819 "description": "The type of the owner."
823 "description": "Identifier of the owner. Mandatory if ownerType is specified."
826 "$ref": "#/definitions/VnfCpNotificationType",
827 "description": "The type of the change"
831 "description": "port Resource",
835 "description": "Identifier of the VIM"
839 "description": "Identifier of the resource in the scope of the VIM"
843 "description": "Resource name in the vim"
847 "description": "The identifier of the tenant"
851 "description": "The IP address of the port"
855 "description": "The MAC address of the port"
859 "description": "The instance id of the server to which the port is attached to"
865 "AffectedVirtualStorage" : {
868 "VnfLcmNotificationStatus" : {
869 "description": "The status of the operation",
876 "VNFLCMNotification": {
880 "description" : "The status of the operation that triggered the LCN.",
881 "$ref": "#/definitions/VnfLcmNotificationStatus"
887 "description" : "The type of the operation that tiggered the LCN.",
888 "$ref": "#/definitions/OperationType"
891 "description" : "The identifier fo the job that triggered the LCN.",
896 "description": "The affected VNFCs",
898 "$ref": "#/definitions/AffectedVnfc"
903 "description": "The affected Connected Points",
905 "$ref": "#/definitions/AffectedCp"
910 "description": "The affected virtual links",
912 "$ref": "#/definitions/AffectedVirtualLink"
915 "affectedVirtualStorage": {
917 "description": "The affected virtual storages. (Not supported)",
919 "$ref": "#/definitions/AffectedVirtualStorage"
924 "VnfInstantiateRequest": {
936 "vnfInstanceDescription": {
942 "$ref": "#/definitions/extVirtualLinkInfo"
947 "description": "Additional parameters passed to the VNFM. The vimId may be passed in the additional parameter section by the NFVO to VNFM."
951 "extVirtualLinkInfo":{
964 "$ref": "#/definitions/vimInfo"
968 "VnfInstantiateResponse": {
980 "description": "The direction of the scaling",
991 "description" : "The direction of the scaling.",
992 "$ref": "#/definitions/ScaleDirection"
996 "description": "Identifies the aspect of the VNF that is requested to be scaled"
1000 "description": "Number of scaling steps to be executed as part of this ScaleVnf operation. It shall be a positive number"
1004 "description": "Additional parameters passed by the NFVO as input to the scaling process, specific to the VNF being scaled"
1030 "VnfTerminationType": {
1031 "description": "The type of the termination.",
1038 "VnfTerminateRequest":{
1041 "terminationType": {
1042 "description" : "The type of the termination",
1043 "$ref": "#/definitions/VnfTerminationType"
1045 "gracefulTerminationTimeout": {
1046 "description": "The time interval(second) to wait for the VNF to be taken out of service during graceful termination.",
1065 "vnfInstanceName": {
1068 "vnfInstanceDescription": {
1105 "description": "The vim Type value wil be openstack"
1109 "description": "The api Version Type value will be "
1113 "description": "The protocol Type value will be http or https"
1122 "description": "Tenant Name of tenant"
1126 "description": "Username for login"
1130 "description": "Password of login user"
1134 "interfaceEndpoint": {
1136 "description": "Information about the interface endpoint. It is a URL"
1140 "VnfPkgDetailInfo": {
1145 "description": "vnf package id, UUID"
1148 "$ref": "#/definitions/VnfPkgInfo"
1151 "$ref": "#/definitions/VnfPkgImgListInfo"
1153 "vnfInstanceInfo": {
1154 "$ref": "#/definitions/VnfInstListInfo"
1160 "description": "vnf package infomation",
1164 "description": "vnf package id (csarId)"
1168 "description": "The name of the csar"
1172 "description": "VNF descriptor ID"
1176 "description": "VNF descriptor vendor ID"
1180 "description": "The model of the VNF (JSON) encoded to string"
1184 "description": "VNF descriptor version"
1188 "description": "VNF Software version"
1192 "description": "The URL from which the VNF package can be downloaded"
1196 "VnfInstListInfo": {
1199 "$ref": "#/definitions/VnfInstInfo"
1207 "description": "VNF instance ID"
1209 "vnfInstanceName": {
1211 "description": "VNF instance name"
1215 "VnfPkgImgListInfo": {
1218 "$ref": "#/definitions/VnfPkgImgInfo"
1226 "description": "image file name"
1230 "description": "image file path in the csar or image url in external repository"
1239 "description": "vnfm Id"
1243 "description": "vnfm name"
1247 "description": "vnfm type"
1251 "description": "vnfm url"
1255 "description": "vnfm login username"
1259 "description": "vnfm login password"
1263 "description": "vim Id"
1267 "description": "vendor name"
1271 "description": "vnfm version"
1275 "description": "vnfm description"
1279 "description": "vnfm certificate Url"
1283 "description": "vnfm info createTime"
1292 "description": "vim Id"
1296 "description": "vim name"
1300 "description": "vim type"
1304 "description": "vim url"
1308 "description": "vim login username"
1312 "description": "vim login password"
1316 "description": "vendor name"
1320 "description": "vim version"
1324 "description": "vim description"
1328 "description": "vim info createTime"
1332 "description": "The collection of trusted certificates towards the VIM connection."
1336 "description": "Whether to verify VIM's certificate"
1340 "description": "The status of external system"