5 "title": "ONAP VFC Service Rest API"
7 "basePath": "/api/nslcm/v1",
10 "name": "vfc nslcm resource"
19 "summary": "query ns package info",
20 "description": "query ns package info",
21 "operationId": "query_ns_package",
32 "description": "successful operation",
34 "$ref": "#/definitions/NsPackageListInfo"
38 "description": "internal error"
46 "summary": "ns package distribute",
47 "description": "ns package distribute",
48 "operationId": "ns_pkg_distribute",
59 "description": "distribute request param",
62 "$ref": "#/definitions/NsPkgPostRequest"
70 "$ref": "#/definitions/NsPkgPostResponse"
74 "description": "internal error"
79 "/nspackage/{csarId}": {
84 "summary": "query one ns package info",
85 "description": "query one ns package info",
86 "operationId": "query_one_ns_package",
97 "description": "csar id of ns package",
104 "description": "successful operation",
106 "$ref": "#/definitions/NsPackageInfo"
110 "description": "internal error"
116 "ns package Resource"
118 "summary": "delete ns pkg",
119 "description": "delete ns pkg",
120 "operationId": "delete_ns_pkg",
131 "description": "csar id of ns package",
140 "$ref": "#/definitions/NsPkgPostResponse"
144 "description": "internal error"
152 "nf package Resource"
154 "summary": "query nf package info",
155 "description": "query nf package info",
156 "operationId": "query_nf_package",
167 "description": "successful operation",
169 "$ref": "#/definitions/NfPackageListInfo"
173 "description": "internal error"
179 "nf package Resource"
181 "summary": "nf package distribute",
182 "description": "nf package distribute",
183 "operationId": "nf_pkg_distribute",
194 "description": "distribute request param",
197 "$ref": "#/definitions/NfPkgPostRequest"
205 "$ref": "#/definitions/NfPkgPostResponse"
209 "description": "internal error"
214 "/vnfpackage/{csarId}": {
217 "nf package Resource"
219 "summary": "query one nf package info",
220 "description": "query one nf package info",
221 "operationId": "query_one_nf_package",
232 "description": "csar id of nf package",
239 "description": "successful operation",
241 "$ref": "#/definitions/NfPackageInfo"
245 "description": "internal error"
251 "nf package Resource"
253 "summary": "delete nf pkg",
254 "description": "delete nf pkg",
255 "operationId": "delete_nf_pkg",
266 "description": "csar id of nf package",
275 "$ref": "#/definitions/NfPkgPostResponse"
279 "description": "internal error"
289 "summary": "vl create",
291 "operationId": "create_vl",
302 "description": "instantiate request param",
305 "$ref": "#/definitions/VlPostRequest"
313 "$ref": "#/definitions/VlPostResponse"
324 "summary": "query the specified vl info",
326 "operationId": "query_vl",
337 "description": "vl instance id",
344 "description": "successful operation",
346 "$ref": "#/definitions/VlInfo"
350 "description": "the vl instance id is wrong"
353 "description": "the url is invalid"
361 "summary": "delete vl",
363 "operationId": "delete_vl",
381 "description": "successful operation",
383 "$ref": "#/definitions/DeleteVlResponse"
387 "description": "the vl instance id is wrong"
390 "description": "the url is invalid"
400 "summary": "vnf create",
402 "operationId": "create_vnf",
413 "description": "instantiate request param",
416 "$ref": "#/definitions/VnfPostRequest"
424 "$ref": "#/definitions/VnfPostResponse"
430 "/ns/vnfs/{vnfInstId}": {
435 "summary": "query the specified vnf info",
437 "operationId": "query_vnf",
448 "description": "vnf instance id",
455 "description": "successful operation",
457 "$ref": "#/definitions/VnfInfo"
461 "description": "the vnf instance id is wrong"
464 "description": "the url is invalid"
472 "summary": "delete vnf",
474 "operationId": "delete_vnf",
492 "description": "successful operation",
494 "$ref": "#/definitions/DeleteResponse"
498 "description": "the vl instance id is wrong"
501 "description": "the url is invalid"
511 "summary": "sfc create",
513 "operationId": "create_sfc",
524 "description": "request param",
527 "$ref": "#/definitions/SfcPostRequest"
535 "$ref": "#/definitions/SfcPostResponse"
541 "/ns/sfcs/{sfcInstId}": {
546 "summary": "query the specified sfc info",
548 "operationId": "query_sfc",
559 "description": "sfc instance id",
566 "description": "successful operation",
568 "$ref": "#/definitions/SfcInfo"
572 "description": "the sfc instance id is wrong"
575 "description": "the url is invalid"
583 "summary": "delete sfc",
585 "operationId": "delete_sfc",
603 "description": "successful operation",
605 "$ref": "#/definitions/DeleteResponse"
609 "description": "the sfc instance id is wrong"
612 "description": "the url is invalid"
617 "/ns/{nsInstanceId}/postdeal": {
622 "summary": "ns postdeal",
624 "operationId": "ns_postdeal",
636 "name": "nsInstanceId",
642 "description": "request param",
645 "$ref": "#/definitions/NSInstPostDetailRequest"
656 "/ns/{nsInstanceId}/scale": {
661 "summary": "ns scale",
662 "description": "ns scale",
663 "operationId": "ns_scale",
675 "name": "nsInstanceId",
680 "name": "ScaleNSRequest",
681 "description": "Scale NS Request Body",
684 "$ref": "#/definitions/ScaleNsRequest"
692 "$ref": "#/definitions/NsScaleResponse"
696 "description": "Invalid Request"
701 "/ns/{ns_instance_id}": {
706 "summary": "ns delete",
707 "description": "ns delete",
708 "operationId": "ns_delete",
719 "description": "Identifier of the NS instance.",
720 "name": "ns_instance_id",
726 "description": "The NS instance resource and the associated NS identifier were deleted successfully."
731 "/ns/{ns_instance_id}/terminate": {
736 "summary": "ns terminate",
737 "description": "ns terminate",
738 "operationId": "ns_terminate",
749 "description": "Identifier of the NS instance.",
750 "name": "ns_instance_id",
755 "name": "NsTerminateRequest",
756 "description": "NsTerminateRequest",
759 "$ref": "#/definitions/NsTerminateRequest"
767 "$ref": "#/definitions/NsTerminateResponse"
771 "description": "the url is invalid"
776 "/ns/{ns_instance_id}/heal": {
781 "summary": "ns heal",
782 "description": "ns heal",
783 "operationId": "ns_heal",
794 "description": "Identifier of the NS instance.",
795 "name": "ns_instance_id",
800 "name": "healVnfData",
801 "description": "healVnfData",
804 "$ref": "#/definitions/healVnfDataRequest"
812 "$ref": "#/definitions/healVnfDataResponse"
816 "description": "the url is invalid"
821 "/mandb/{modelName}": {
826 "summary": "query ns table info",
827 "description": "query ns table info",
828 "operationId": "query_ns_table",
839 "description": "model Name.",
846 "description": "successful operation",
848 "$ref": "#/definitions/TableInfo"
852 "description": "the url is invalid"
860 "summary": "ns table delete",
861 "description": "ns table delete",
862 "operationId": "ns_table_delete",
873 "description": "model Name.",
880 "description": "The tables were deleted successfully."
891 "description": "ns get",
892 "operationId": "ns_get",
904 "description": "successful operation",
906 "$ref": "#/definitions/NsInfo"
917 "summary": "jobstatus",
919 "operationId": "jobstatus",
937 "description": "request param",
940 "$ref": "#/definitions/JobProgressRequest"
953 "NsPkgPostRequest": {
961 "NsPkgPostResponse": {
967 "statusDescription": {
975 "NsPackageListInfo": {
979 "$ref": "#/definitions/NsPkgListInfo"
996 "$ref": "#/definitions/NsPkgDetailInfo"
999 "$ref": "#/definitions/NsInstListInfo"
1003 "NsPkgDetailInfo": {
1023 "NfPkgPostRequest": {
1031 "NfPkgPostResponse": {
1039 "NfPackageListInfo": {
1043 "$ref": "#/definitions/NfPkgListInfo"
1060 "$ref": "#/definitions/NfPkgDetailInfo"
1063 "$ref": "#/definitions/NfPkgImgInfo"
1065 "vnfInstanceInfo": {
1066 "$ref": "#/definitions/NfInstListInfo"
1070 "NfPkgDetailInfo": {
1123 "vnfInstanceData": {
1129 "nestedNsInstanceId": {
1135 "locationConstraints": {
1141 "additionalParamForNs": {
1147 "additionalParamForVnf": {
1153 "extNSVirtualLink": {
1209 "vnfInstanceData": {
1215 "nestedNsInstanceId": {
1221 "locationConstraints": {
1227 "additionalParamForNs": {
1233 "additionalParamForVnf": {
1239 "extNSVirtualLink": {
1253 "VnfPostResponse": {
1279 "vnfInstanceData": {
1285 "additionalParamForNs": {
1291 "additionalParamForVnf": {
1297 "sdnControllerId": {
1308 "NSInstPostDetailRequest": {
1316 "JobProgressRequest": {
1330 "SfcPostResponse": {
1383 "DeleteVlResponse": {
1419 "scaleNsByStepsData": {
1420 "$ref": "#/definitions/ScaleNsByStepsData"
1424 "ScaleNsByStepsData": {
1427 "scalingDirection": {
1438 "NsScaleResponse": {
1446 "NsTerminateRequest": {
1449 "terminationType": {
1452 "gracefulTerminationTimeout": {
1457 "NsTerminateResponse": {
1465 "healVnfDataRequest": {
1474 "additionalParams": {
1495 "healVnfDataResponse": {