5 "title": "ONAP VFC Service Rest API"
7 "basePath": "/api/nslcm/v1",
10 "name": "vfc nslcm resource"
19 "summary": "ns package distribute",
20 "description": "ns package distribute",
21 "operationId": "ns_pkg_distribute",
32 "description": "distribute request param",
35 "$ref": "#/definitions/NsPkgPostRequest"
43 "$ref": "#/definitions/NsPkgPostResponse"
47 "description": "internal error"
52 "/nspackage/{csarId}": {
57 "summary": "query one ns package info",
58 "description": "query one ns package info",
59 "operationId": "query_one_ns_package",
70 "description": "csar id of ns package",
77 "description": "successful operation",
79 "$ref": "#/definitions/NsPackageInfo"
83 "description": "internal error"
91 "summary": "delete ns pkg",
92 "description": "delete ns pkg",
93 "operationId": "delete_ns_pkg",
104 "description": "csar id of ns package",
113 "$ref": "#/definitions/NsPkgPostResponse"
117 "description": "internal error"
125 "nf package Resource"
127 "summary": "query nf package info",
128 "description": "query nf package info",
129 "operationId": "query_nf_package",
140 "description": "successful operation",
142 "$ref": "#/definitions/NfPackageListInfo"
146 "description": "internal error"
152 "nf package Resource"
154 "summary": "nf package distribute",
155 "description": "nf package distribute",
156 "operationId": "nf_pkg_distribute",
167 "description": "distribute request param",
170 "$ref": "#/definitions/NfPkgPostRequest"
178 "$ref": "#/definitions/NfPkgPostResponse"
182 "description": "internal error"
187 "/vnfpackage/{csarId}": {
190 "nf package Resource"
192 "summary": "query one nf package info",
193 "description": "query one nf package info",
194 "operationId": "query_one_nf_package",
205 "description": "csar id of nf package",
212 "description": "successful operation",
214 "$ref": "#/definitions/NfPackageInfo"
218 "description": "internal error"
224 "nf package Resource"
226 "summary": "delete nf pkg",
227 "description": "delete nf pkg",
228 "operationId": "delete_nf_pkg",
239 "description": "csar id of nf package",
248 "$ref": "#/definitions/NfPkgPostResponse"
252 "description": "internal error"
262 "summary": "vl create",
264 "operationId": "create_vl",
275 "description": "instantiate request param",
278 "$ref": "#/definitions/VlPostRequest"
286 "$ref": "#/definitions/VlPostResponse"
297 "summary": "query the specified vl info",
299 "operationId": "query_vl",
310 "description": "vl instance id",
317 "description": "successful operation",
319 "$ref": "#/definitions/VlInfo"
323 "description": "the vl instance id is wrong"
326 "description": "the url is invalid"
334 "summary": "delete vl",
336 "operationId": "delete_vl",
354 "description": "successful operation",
356 "$ref": "#/definitions/DeleteVlResponse"
360 "description": "the vl instance id is wrong"
363 "description": "the url is invalid"
373 "summary": "vnf create",
375 "operationId": "create_vnf",
386 "description": "instantiate request param",
389 "$ref": "#/definitions/VnfPostRequest"
397 "$ref": "#/definitions/VnfPostResponse"
403 "/ns/vnfs/{vnfInstId}": {
408 "summary": "query the specified vnf info",
410 "operationId": "query_vnf",
421 "description": "vnf instance id",
428 "description": "successful operation",
430 "$ref": "#/definitions/VnfInfo"
434 "description": "the vnf instance id is wrong"
437 "description": "the url is invalid"
445 "summary": "delete vnf",
447 "operationId": "delete_vnf",
465 "description": "successful operation",
467 "$ref": "#/definitions/DeleteResponse"
471 "description": "the vl instance id is wrong"
474 "description": "the url is invalid"
484 "summary": "sfc create",
486 "operationId": "create_sfc",
497 "description": "request param",
500 "$ref": "#/definitions/SfcPostRequest"
508 "$ref": "#/definitions/SfcPostResponse"
514 "/ns/sfcs/{sfcInstId}": {
519 "summary": "query the specified sfc info",
521 "operationId": "query_sfc",
532 "description": "sfc instance id",
539 "description": "successful operation",
541 "$ref": "#/definitions/SfcInfo"
545 "description": "the sfc instance id is wrong"
548 "description": "the url is invalid"
556 "summary": "delete sfc",
558 "operationId": "delete_sfc",
576 "description": "successful operation",
578 "$ref": "#/definitions/DeleteResponse"
582 "description": "the sfc instance id is wrong"
585 "description": "the url is invalid"
590 "/ns/{nsInstanceId}/postdeal": {
595 "summary": "ns postdeal",
597 "operationId": "ns_postdeal",
609 "name": "nsInstanceId",
615 "description": "request param",
618 "$ref": "#/definitions/NSInstPostDetailRequest"
629 "/ns/{nsInstanceId}/scale": {
634 "summary": "ns scale",
635 "description": "ns scale",
636 "operationId": "ns_scale",
648 "name": "nsInstanceId",
653 "name": "ScaleNSRequest",
654 "description": "Scale NS Request Body",
657 "$ref": "#/definitions/ScaleNsRequest"
665 "$ref": "#/definitions/NsScaleResponse"
669 "description": "Invalid Request"
674 "/ns/{ns_instance_id}": {
679 "summary": "ns delete",
680 "description": "ns delete",
681 "operationId": "ns_delete",
692 "description": "Identifier of the NS instance.",
693 "name": "ns_instance_id",
699 "description": "The NS instance resource and the associated NS identifier were deleted successfully."
704 "/ns/{ns_instance_id}/terminate": {
709 "summary": "ns terminate",
710 "description": "ns terminate",
711 "operationId": "ns_terminate",
722 "description": "Identifier of the NS instance.",
723 "name": "ns_instance_id",
728 "name": "NsTerminateRequest",
729 "description": "NsTerminateRequest",
732 "$ref": "#/definitions/NsTerminateRequest"
740 "$ref": "#/definitions/NsTerminateResponse"
744 "description": "the url is invalid"
749 "/ns/{ns_instance_id}/heal": {
754 "summary": "ns heal",
755 "description": "ns heal",
756 "operationId": "ns_heal",
767 "description": "Identifier of the NS instance.",
768 "name": "ns_instance_id",
773 "name": "healVnfData",
774 "description": "healVnfData",
777 "$ref": "#/definitions/healVnfDataRequest"
785 "$ref": "#/definitions/healVnfDataResponse"
789 "description": "the url is invalid"
794 "/mandb/{modelName}": {
799 "summary": "query ns table info",
800 "description": "query ns table info",
801 "operationId": "query_ns_table",
812 "description": "model Name.",
819 "description": "successful operation",
821 "$ref": "#/definitions/TableInfo"
825 "description": "the url is invalid"
833 "summary": "ns table delete",
834 "description": "ns table delete",
835 "operationId": "ns_table_delete",
846 "description": "model Name.",
853 "description": "The tables were deleted successfully."
864 "description": "ns get",
865 "operationId": "ns_get",
877 "description": "successful operation",
879 "$ref": "#/definitions/NsInfo"
890 "summary": "jobstatus",
892 "operationId": "jobstatus",
910 "description": "request param",
913 "$ref": "#/definitions/JobProgressRequest"
926 "NsPkgPostRequest": {
934 "NsPkgPostResponse": {
940 "statusDescription": {
956 "$ref": "#/definitions/NsPkgDetailInfo"
959 "$ref": "#/definitions/NsInstListInfo"
983 "NfPkgPostRequest": {
991 "NfPkgPostResponse": {
999 "NfPackageListInfo": {
1003 "$ref": "#/definitions/NfPkgListInfo"
1020 "$ref": "#/definitions/NfPkgDetailInfo"
1023 "$ref": "#/definitions/NfPkgImgInfo"
1025 "vnfInstanceInfo": {
1026 "$ref": "#/definitions/NfInstListInfo"
1030 "NfPkgDetailInfo": {
1083 "vnfInstanceData": {
1089 "nestedNsInstanceId": {
1095 "locationConstraints": {
1101 "additionalParamForNs": {
1107 "additionalParamForVnf": {
1113 "extNSVirtualLink": {
1169 "vnfInstanceData": {
1175 "nestedNsInstanceId": {
1181 "locationConstraints": {
1187 "additionalParamForNs": {
1193 "additionalParamForVnf": {
1199 "extNSVirtualLink": {
1213 "VnfPostResponse": {
1239 "vnfInstanceData": {
1245 "additionalParamForNs": {
1251 "additionalParamForVnf": {
1257 "sdnControllerId": {
1268 "NSInstPostDetailRequest": {
1276 "JobProgressRequest": {
1290 "SfcPostResponse": {
1343 "DeleteVlResponse": {
1379 "scaleNsByStepsData": {
1380 "$ref": "#/definitions/ScaleNsByStepsData"
1384 "ScaleNsByStepsData": {
1387 "scalingDirection": {
1398 "NsScaleResponse": {
1406 "NsTerminateRequest": {
1409 "terminationType": {
1412 "gracefulTerminationTimeout": {
1417 "NsTerminateResponse": {
1425 "healVnfDataRequest": {
1434 "additionalParams": {
1455 "healVnfDataResponse": {