4 "title": "Resource Management API",
5 "description": "Resource Management API",
10 "name": "Resource Management services"
13 "basePath": "/api/resmgr/v1",
17 "summary": "Query limits information",
18 "description": "Query limits information",
29 "description": "vim Id",
36 "description": "Successfully Query limits information",
38 "$ref": "#/definitions/QueryLimts"
42 "description": "Unauthorized"
45 "description": "Limits Not Found"
48 "description": "Limits failed to process the request",
50 "$ref": "#/definitions/Error"
58 "summary": "Grant VNF Life Cycle Operation",
59 "description": "Grant Resource",
70 "description": "OPEN-O Interface.",
73 "$ref": "#/definitions/GrantResource"
79 "description": "VNF Resource Response",
81 "$ref": "#/definitions/GrantResourceResponse"
85 "description": "Unauthorized"
88 "description": "VNF Resource Not Found"
91 "description": "VNF resource failed to process the request",
93 "$ref": "#/definitions/Error"
101 "summary": "Create virtual link resource",
102 "description": "virtual link Resource",
113 "description": "OPEN-O Interface.",
116 "$ref": "#/definitions/VirtualLink"
122 "description": "Successfully Created VNF Resource",
124 "$ref": "#/definitions/VirtualLinkResponse"
128 "description": "Unauthorized"
131 "description": "VNF Resource Not Found"
134 "description": "VNF resource failed to process the request",
136 "$ref": "#/definitions/Error"
144 "summary": "Delete virtual link resource",
145 "description": "Delete virtual link Resource",
156 "description": "VNF Resource Id",
163 "description": "Successfully Deleted VNF Resource"
166 "description": "Unauthorized"
169 "description": "VNF Resource Not Found"
172 "description": "VNF resource failed to process the request",
174 "$ref": "#/definitions/Error"
182 "summary": "Create VNF instance resource",
183 "description": "Create VNF Resource",
194 "description": "OPEN-O Interface.",
197 "$ref": "#/definitions/CreateVNFResource"
203 "description": "Successfully Created VNF Resource",
205 "$ref": "#/definitions/CreateVNFResponse"
209 "description": "Unauthorized"
212 "description": "VNF Resource Not Found"
215 "description": "VNF resource failed to process the request",
217 "$ref": "#/definitions/Error"
225 "summary": "Write VNF status information",
226 "description": "VNF Status",
237 "description": "OPEN-O Interface.",
240 "$ref": "#/definitions/VNFStatusInfo"
246 "description": "Successfully write VNF status"
249 "description": "Unauthorized"
252 "description": "VNF Resource Not Found"
255 "description": "VNF resource failed to process the request",
257 "$ref": "#/definitions/Error"
265 "summary": "Write VNF detail information",
266 "description": "VNF detail info",
277 "description": "OPEN-O Interface",
280 "$ref": "#/definitions/VNFDetailInfo"
286 "description": "Successfully write VNF detail Info"
289 "description": "Unauthorized"
292 "description": "VNF Resource Not Found"
295 "description": "VNF resource failed to process the request",
297 "$ref": "#/definitions/Error"
307 "description": "Query Limits Response.",
321 "description": "Identifier of vimId."
325 "description": "Name."
347 "VirtualLinkResponse": {
349 "description": "Virtual Link Response.",
357 "description": "Identifier of VL."
361 "description": "Name of VL."
365 "CreateVNFResponse": {
367 "description": "Create VNF Response.",
375 "description": "UUID."
379 "description": "Instance Name."
385 "description": "List of Vm to be added or deleted",
395 "description": "The id of VNF instance"
399 "description": "NS ID"
403 "description": "VNFM ID"
408 "$ref": "#/definitions/Vm"
415 "description": "Write VNF Status.",
421 "responseDescriptor",
424 "sStatusDescription",
427 "responseHistoryList",
434 "description": "The Id of VNF Instance."
438 "description": "The ID of workflow."
442 "description": "NS ID."
446 "description": "The VNFM ID."
448 "responseDescriptor": {
450 "description": "The name of VNFM."
454 "description": "Status of VNF - started processing finished error."
458 "description": "progress (1-100)."
460 "sStatusDescription": {
462 "description": "current Progress Description."
466 "description": "Error code."
470 "description": "Message Number."
472 "responseHistoryList": {
475 "$ref": "#/definitions/progressInfo"
481 "$ref": "#/definitions/Vm"
487 "$ref": "#/definitions/Vm"
494 "description": "List of Vm to be added or deleted",
501 "responseHistoryList"
506 "description": "progress (1 - 100)"
510 "description": "status"
512 "statusDescription": {
514 "description": "status description"
518 "description": "Error Code"
524 "responseHistoryList": {
527 "$ref": "#/definitions/historyInfo"
534 "description": "List of Vm to be added or deleted",
545 "description": "progress (1 - 100)"
549 "description": "status"
551 "statusDescription": {
553 "description": "status description"
557 "description": "Error Code"
567 "description": "List of Vm to be added or deleted",
576 "description": "The ID of VM"
580 "description": "The name of VM"
584 "description": "The Status of VM"
588 "CreateVNFResource": {
590 "description": "Create VNF Resource.",
616 "description": "The Identifier of VNF Instance."
620 "description": "The name of VNF."
624 "description": "NS ID."
628 "description": "NS name."
632 "description": "The ID of VNFM."
636 "description": "The name of VNFM."
640 "description": "The description of VNF Package."
642 "vnfDescriptorName": {
644 "description": "The Description of VNFD."
648 "description": "Vim ID."
652 "description": "The Name of VIM."
656 "description": "The tenant of VIM."
660 "description": "The ID of workflow."
664 "description": "The status of VNF."
668 "description": "The type of VNF."
672 "description": "Max Vm in this VNF."
676 "description": "Max CPU in this VNF."
680 "description": "Max Disk in this VNF."
684 "description": "Max Memory in this VNF."
688 "description": "Max Share Disk in this VNF."
692 "description": "Max logical Network in this VNF."
698 "description": "Virtual Link Resource.",
715 "resourceProviderType",
721 "description": "Logical Network Name."
725 "description": "The backend id on VIM."
729 "description": "Sharable - True or False."
733 "description": "The DataCenter name."
737 "description": "vim Id."
741 "description": "The name of VIM."
745 "description": "Physicial Network."
749 "description": "NsId."
753 "description": "The name of NS."
757 "description": "Description."
761 "description": "Network Type - gre/vlan/vxlan."
765 "description": "Segmentation Id just like vlan id."
769 "description": "MTU value."
773 "description": "Support vlan transparent- True/False."
777 "description": "Support External Router - True / False."
779 "resourceProviderType": {
781 "description": "The location to be deployed in one of the list - VIM/DC/Zone/Host."
783 "resourceProviderId": {
785 "description": "The location ID to be deployed."
789 "GrantResourceResponse": {
791 "description": "Resource Response.",
805 "$ref": "#/definitions/VimInfo"
814 "$ref": "#/definitions/GrantInfo"
817 "$ref": "#/definitions/GrantInfo"
820 "$ref": "#/definitions/GrantInfo"
823 "$ref": "#/definitions/GrantInfo"
835 "description": "Information about the VIM that manages this resource.",
846 "description": "The identifier of this VimInfo instance, for the purpose of referencing it from other information elements."
850 "description": "The identifier of the VIM.."
853 "$ref": "#/definitions/interfaceInfo"
856 "$ref": "#/definitions/accessInfo"
858 "interfaceEndpoint": {
860 "description": "Information about the interface endpoint. An example is a URL."
866 "description": "Information about the interface to the VIM, including VIM provider type, API version, and protocol type..",
879 "description": "api version"
883 "description": "Type of the protocol"
889 "description": "Authentication credentials for accessing the VIM. Examples may include those to support different authentication schemes, e.g., OAuth, Token, etc..",
898 "description": "Tenant Name of tenant"
902 "description": "Username for login"
906 "description": "Password of login user"
912 "description": "Grant Information.",
914 "resourceDefinitionId",
917 "resourceProviderId",
921 "resourceDefinitionId": {
923 "description": "Identifier of the related ResourceDefinition information from Grant Request"
927 "description": "Reservation Identifier applicable to the VNFC/VL."
931 "description": "Reference to the identifier of the VimInfo information element defining the VIM under whose control this resource to be placed."
933 "resourceProviderId": {
935 "description": "Identifies the entity responsible for the management of the virtualized resource."
939 "description": "Reference of the identifier of the zoneInfo information element defining the resource zone in which resource to be placed."
945 "description": "Grant Resource Request Body.",
955 "description": "Identifier Instance."
959 "description": "Identifier vim."
964 "$ref": "#/definitions/ResourceDefinition"
966 "description": "Information sufficient to identify the VNF Descriptor which defines the VNF to be created."
971 "$ref": "#/definitions/ResourceDefinition"
976 "description": "additionalParam.",
994 "ResourceDefinition": {
996 "description": "List of resources to be added / deleted / updated.",
998 "resourceDefinitionId",
1004 "resourceDefinitionId": {
1006 "description": "Identifier of this ResourceDefinition information element, unique at least within the scope of the Grant request."
1008 "resourceTemplate": {
1009 "$ref": "#/definitions/ResourceTemplate"
1012 "default": "compute",
1019 "description": "Currently only support tosca.nodes.nfv.VDU."
1023 "description": "Reference to the related Vdu applicable to this resource in the VNFD."
1027 "ResourceTemplate": {
1029 "description": "Resource templates.",
1031 "VirtualComputeDescriptor",
1032 "VirtualStorageDescriptor"
1035 "VirtualComputeDescriptor": {
1036 "$ref": "#/definitions/VirtualComputeDescriptor"
1038 "VirtualStorageDescriptor": {
1039 "$ref": "#/definitions/VirtualStorageDescriptor"
1043 "VirtualComputeDescriptor": {
1045 "description": "Reference to a resource template.",
1054 "description": "Number of virtual CPUs"
1059 "description": "Amount of virtual Memory"
1063 "VirtualStorageDescriptor": {
1065 "description": "Reference to a resource template.",
1074 "description": "Type of virtualized storage resource"
1079 "description": "Size of virtualized storage resource"
1081 "swImageDescriptor": {
1083 "description": "Software image to be loaded on the Virtual Storage"