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/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": "VNF Instance Id",
361 "name": "vnfInstanceId",
366 "name": "vnf Notification",
367 "description": "VNF LCM Notification",
370 "$ref": "#/definitions/VNFLCMNotification"
379 "description": "URL not found"
382 "description": "the url is invalid"
387 "/{vnfmid}/jobs/{jobid}": {
392 "summary": "jobstatus",
393 "description": "Job Infomation API should be provided by VNFM Driver",
394 "operationId": "get_jobstatus",
399 "description": "job Id",
406 "description": "The value of vnfmid should be the VNFM Instantiate ID",
413 "description": "job response message id",
414 "name": "responseId",
422 "$ref": "#/definitions/JobDetailInfo"
428 "/catalog/v1/vnfpackages/{csarId}": {
433 "summary": "query vnf package info",
434 "description": "query one vnf package info via vnf package csarId",
435 "operationId": "query_vnf_package",
446 "description": "csar id of vnf package",
453 "description": "successful operation",
455 "$ref": "#/definitions/VnfPkgDetailInfo"
459 "description": "internal error"
464 "/nslcm/v1/vnfms/{vnfmid}":{
469 "summary": "Query VNFM register info",
470 "description": "query VNFM register info",
471 "operationId": "query_vnfm_info",
482 "description": "vnfm id",
489 "description": "successful operation",
491 "$ref": "#/definitions/VnfmInfo"
495 "description": "URL not found"
498 "description": "internal error"
503 "/nslcm/v1/vims/{vimid}":{
508 "summary": "Query VIM register info",
509 "description": "query VIM register info",
510 "operationId": "query_VIM_info",
521 "description": "vim id",
528 "description": "successful operation",
530 "$ref": "#/definitions/VimInfo"
534 "description": "URL not found"
537 "description": "internal error"
553 "statusDescription": {
570 "responseDescriptor": {
579 "statusDescription": {
588 "responseHistoryList": {
591 "$ref": "#/definitions/jobResponseInfo"
603 "description": " The value should be VDU,VL,CP,Strorage."
605 "resourceDefinitionId": {
614 "description": "The type of operation",
635 "lifecycleOperation": {
636 "description" : "The type of the operation.",
637 "$ref": "#/definitions/OperationType"
645 "$ref": "#/definitions/ResourceChange"
651 "$ref": "#/definitions/ResourceChange"
656 "description": "The data type is KeyValuePair. Additional parameters passed by the NFVO, specific to the VNF and the LCM operation."
660 "GrantVNFResponse": {
677 "description": "The vim Type value wil be openstack"
681 "description": "The api Version Type value will be "
685 "description": "The protocol Type value will be http or https"
694 "description": "Tenant Name of tenant"
698 "description": "Username for login"
702 "description": "Password of login user"
706 "interfaceEndpoint": {
708 "description": "Information about the interface endpoint. It is a URL"
714 "VnfNotificationType": {
715 "description": "The type of the notification",
728 "description": "Identifier of the VNFC instance"
732 "description": "Identifier of the VDU in the VNFD"
735 "$ref": "#/definitions/VnfNotificationType",
736 "description": "The type of the change"
740 "description": "Identifier of vim"
744 "description": "Identifier of virtual machine"
748 "description": "Name of virtual machine"
752 "AffectedVirtualLinkType": {
753 "description": "The type of the affected virtual link",
760 "AffectedVirtualLink":{
765 "description": "Identifier of the VL instance"
769 "description": "Identifier of the VLD in the VNFD"
772 "$ref": "#/definitions/VnfNotificationType",
773 "description": "The type of the change"
777 "description": "network Resource",
780 "$ref": "#/definitions/AffectedVirtualLinkType",
781 "description": "Must be network"
785 "description": "Identifier of the resource in the scope of the VIM"
791 "VnfCpNotificationType": {
792 "description": "The type of the notification for connection points",
803 "virtualLinkInstanceId": {
805 "description": "Identifier of the VL instance"
809 "description": "Identifier of the connection point"
813 "description": "Identifier of the connection point in the VNFD"
817 "description": "The type of the owner."
821 "description": "Identifier of the owner. Mandatory if ownerType is specified."
824 "$ref": "#/definitions/VnfCpNotificationType",
825 "description": "The type of the change"
829 "description": "port Resource",
833 "description": "Identifier of the VIM"
837 "description": "Identifier of the resource in the scope of the VIM"
841 "description": "Resource name in the vim"
845 "description": "The identifier of the tenant"
849 "description": "The IP address of the port"
853 "description": "The MAC address of the port"
857 "description": "The instance id of the server to which the port is attached to"
863 "AffectedVirtualStorage" : {
866 "VnfLcmNotificationStatus" : {
867 "description": "The status of the operation",
874 "VNFLCMNotification": {
878 "description" : "The status of the operation that triggered the LCN.",
879 "$ref": "#/definitions/VnfLcmNotificationStatus"
885 "description" : "The type of the operation that tiggered the LCN.",
886 "$ref": "#/definitions/OperationType"
889 "description" : "The identifier fo the job that triggered the LCN.",
894 "description": "The affected VNFCs",
896 "$ref": "#/definitions/AffectedVnfc"
901 "description": "The affected Connected Points",
903 "$ref": "#/definitions/AffectedCp"
908 "description": "The affected virtual links",
910 "$ref": "#/definitions/AffectedVirtualLink"
913 "affectedVirtualStorage": {
915 "description": "The affected virtual storages. (Not supported)",
917 "$ref": "#/definitions/AffectedVirtualStorage"
922 "VnfInstantiateRequest": {
934 "vnfInstanceDescription": {
940 "$ref": "#/definitions/extVirtualLinkInfo"
948 "extVirtualLinkInfo":{
961 "$ref": "#/definitions/vimInfo"
966 "VnfInstantiateResponse": {
978 "description": "The direction of the scaling",
989 "description" : "The direction of the scaling.",
990 "$ref": "#/definitions/ScaleDirection"
994 "description": "Identifies the aspect of the VNF that is requested to be scaled"
998 "description": "Number of scaling steps to be executed as part of this ScaleVnf operation. It shall be a positive number"
1002 "description": "Additional parameters passed by the NFVO as input to the scaling process, specific to the VNF being scaled"
1028 "VnfTerminationType": {
1029 "description": "The type of the termination.",
1036 "VnfTerminateRequest":{
1039 "terminationType": {
1040 "description" : "The type of the termination",
1041 "$ref": "#/definitions/VnfTerminationType"
1043 "gracefulTerminationTimeout": {
1044 "description": "The time interval(second) to wait for the VNF to be taken out of service during graceful termination.",
1063 "vnfInstanceName": {
1066 "vnfInstanceDescription": {
1103 "description": "The vim Type value wil be openstack"
1107 "description": "The api Version Type value will be "
1111 "description": "The protocol Type value will be http or https"
1120 "description": "Tenant Name of tenant"
1124 "description": "Username for login"
1128 "description": "Password of login user"
1132 "interfaceEndpoint": {
1134 "description": "Information about the interface endpoint. It is a URL"
1138 "VnfPkgDetailInfo": {
1143 "description": "vnf package id, UUID"
1146 "$ref": "#/definitions/VnfPkgInfo"
1149 "$ref": "#/definitions/VnfPkgImgListInfo"
1151 "vnfInstanceInfo": {
1152 "$ref": "#/definitions/VnfInstListInfo"
1158 "description": "vnf package infomation",
1162 "description": "vnf package id, UUID"
1166 "description": "VNF descriptor ID"
1170 "description": "VNF descriptor vendor ID"
1174 "description": "VNF descriptor version"
1178 "description": "VNF Software version"
1182 "description": "The download uri of VNF package"
1186 "VnfInstListInfo": {
1189 "$ref": "#/definitions/VnfInstInfo"
1197 "description": "VNF instance ID"
1199 "vnfInstanceName": {
1201 "description": "VNF instance name"
1205 "VnfPkgImgListInfo": {
1208 "$ref": "#/definitions/VnfPkgImgInfo"
1216 "description": "image file name"
1220 "description": "image file path in the csar or image url in external repository"
1229 "description": "vnfm Id"
1233 "description": "vnfm name"
1237 "description": "vnfm type"
1241 "description": "vnfm url"
1245 "description": "vnfm login username"
1249 "description": "vnfm login password"
1253 "description": "vim Id"
1257 "description": "vendor name"
1261 "description": "vnfm version"
1265 "description": "vnfm description"
1269 "description": "vnfm certificate Url"
1273 "description": "vnfm info createTime"
1282 "description": "vim Id"
1286 "description": "vim name"
1290 "description": "vim type"
1294 "description": "vim url"
1298 "description": "vim login username"
1302 "description": "vim login password"
1306 "description": "vendor name"
1310 "description": "vim version"
1314 "description": "vim description"
1318 "description": "vim info createTime"
1322 "description": "CA file content if enabled ssl on auth-url"
1326 "description": "Whether to verify VIM's certificate"
1330 "description": "The status of external system"