Virtualized Network Function Lifecycle Management Versions (VNF LCM versions)

Show All

Virtualized Network Function Lifecycle Management API Versions

GET

/vnflcm/api_versions

List VNFLCM API versions

detail

This method retrieves the list of all supported versions for VNF LCM API.

Response Codes

Success

Code	Reason
200 - OK	Request was successful.

Error

Code	Reason
400 - Bad Request	Some content in the request was invalid.
401 - Unauthorized	User must authenticate before making a request.

Request Example

{
  "vnfdId": "b1bb0ce7-ebca-4fa7-95ed-4840d70a1177",
  "vnfInstanceName": "Instance name",
  "vnfInstanceDescription": "Instance description"
}

Response Parameters

Name	In	Type	Description
uriPrefix	body	string	URI prefix for the API.
apiVersions	body	Structure (inlined)	Version(s) supported for the API signalled by the uriPrefix attribute.
>version	body	String	Supported version.
>isDeprecated (Optional)	body	boolean	This attribute indicates whether use of the version signalled by the version attribute is deprecated (true) or not (false).
>retirementDate (Optional)	body	datetime	The date and time after which the API version will no longer be supported. This attribute may be included if the value of the isDeprecated attribute is set to true and shall be absent otherwise.

Response Example

{
    "uriPrefix": "/vnflcm",
    "apiVersions": [
        {
            "version": "1.3.0",
            "isDeprecated": false
        },
        {
            "version": "2.0.0",
            "isDeprecated": false
        }
    ]
}

GET

/vnflcm/{apiMajorVersion}/api_versions

Show VNFLCM API versions

detail

This method retrieves the list of supported versions for VNF LCM API corresponding to the {apiMajorVersion}.

Request Parameters

Name	In	Type	Description
apiMajorVersion	path	string	Indicates the major version of API.

Response Codes

Success

Code	Reason
200 - OK	Request was successful.

Error

Code	Reason
400 - Bad Request	Some content in the request was invalid.
401 - Unauthorized	User must authenticate before making a request.

Response Parameters

Name	In	Type	Description
uriPrefix	body	string	URI prefix for the API.
apiVersions	body	Structure (inlined)	Version(s) supported for the API signalled by the uriPrefix attribute.
>version	body	String	Supported version.
>isDeprecated (Optional)	body	boolean	This attribute indicates whether use of the version signalled by the version attribute is deprecated (true) or not (false).
>retirementDate (Optional)	body	datetime	The date and time after which the API version will no longer be supported. This attribute may be included if the value of the isDeprecated attribute is set to true and shall be absent otherwise.

Response Example

{
    "uriPrefix": "/vnflcm/v1",
    "apiVersions": [
        {
            "version": "1.3.0",
            "isDeprecated": false
        }
    ]
}