User Guide

Reference: https://docs.openstack.org/tacker/latest/user/index.html

Support APIs

Tacker Horizon supports the following APIs:

Supported Legacy APIs

VIM Management

API name

Method & URI

ETSI NFV-SOL Version

Register VIM

POST /v1.0/vims

None

List VIMs

GET /v1.0/vims

None

Delete VIM

Delete /v1.0/vims/{vim_id}

None

Warning

Some Legacy API functions other than VIM Management are displayed, but those APIs have been removed and cannot be used.

Supported v1 APIs

VNF Package Management

API name

Method & URI

ETSI NFV-SOL Version

Create VNF Package

POST /vnfpkgm/v1/vnf_packages

ETSI NFV-SOL004 2.6.1 ETSI NFV-SOL005 2.6.1

List VNF Packages

GET /vnfpkgm/v1/vnf_packages

ETSI NFV-SOL004 2.6.1 ETSI NFV-SOL005 2.6.1

Show VNF Package

GET /vnfpkgm/v1/vnf_packages/{vnf_package_id}

ETSI NFV-SOL004 2.6.1 ETSI NFV-SOL005 2.6.1

Delete VNF Package

Delete /vnfpkgm/v1/vnf_packages/{vnf_package_id}

ETSI NFV-SOL004 2.6.1 ETSI NFV-SOL005 2.6.1

Upload VNF Package from content

PUT /vnfpkgm/v1/vnf_packages/{vnf_package_id}/ package_content

ETSI NFV-SOL004 2.6.1 ETSI NFV-SOL005 2.6.1

Upload VNF Package from uri

POST /vnfpkgm/v1/vnf_packages/{vnf_package_id}/ package_content/upload_from_uri

ETSI NFV-SOL004 2.6.1 ETSI NFV-SOL005 2.6.1

Update VNF Package Information

PATCH /vnfpkgm/v1/vnf_packages/{vnf_package_id}

ETSI NFV-SOL004 2.6.1 ETSI NFV-SOL005 2.6.1

Fetch an on-boarded VNF package with HTTP_RANGE

GET /vnfpkgm/v1/vnf_packages/{vnf_package_id}/ package_content

ETSI NFV-SOL004 2.6.1 ETSI NFV-SOL005 2.6.1

Note

v1 VNF Lifecycle Management is not supported.

Please note that when Create VNF Identifier is executed from VNF Package v1, v2 VNF Instance is created instead of v1 VNF Instance.

Supported v2 APIs

v2 VNF Lifecycle Management

API name

Method & URI

ETSI NFV-SOL Version

Create a new VNF instance resource (v2)

POST /vnflcm/v2/vnf_instances

ETSI NFV-SOL002 3.3.1 ETSI NFV-SOL003 3.3.1 ETSI NFV-SOL013 3.4.1

Instantiate a VNF instance (v2)

POST /vnflcm/v2/vnf_instances/{vnfInstanceId}/instantiate

ETSI NFV-SOL002 3.3.1 ETSI NFV-SOL003 3.3.1 ETSI NFV-SOL013 3.4.1

Terminate a VNF instance (v2)

POST /vnflcm/v2/vnf_instances/{vnfInstanceId}/terminate

ETSI NFV-SOL002 3.3.1 ETSI NFV-SOL003 3.3.1 ETSI NFV-SOL013 3.4.1

Heal a VNF instance (v2)

POST /vnflcm/v2/vnf_instances/{vnfInstanceId}/heal

ETSI NFV-SOL002 3.3.1 ETSI NFV-SOL003 3.3.1 ETSI NFV-SOL013 3.4.1

Delete a VNF instance (v2)

DELETE /vnflcm/v2/vnf_instances/{vnfInstanceId}

ETSI NFV-SOL002 3.3.1 ETSI NFV-SOL003 3.3.1 ETSI NFV-SOL013 3.4.1

Show VNF instance (v2)

GET /vnflcm/v2/vnf_instances/{vnfInstanceId}

ETSI NFV-SOL002 3.3.1 ETSI NFV-SOL003 3.3.1 ETSI NFV-SOL013 3.4.1

List VNF instance (v2)

GET /vnflcm/v2/vnf_instances

ETSI NFV-SOL002 3.3.1 ETSI NFV-SOL003 3.3.1 ETSI NFV-SOL013 3.4.1

Scale a VNF instance (v2)

POST /vnflcm/v2/vnf_instances/{vnfInstanceId}/scale

ETSI NFV-SOL002 3.3.1 ETSI NFV-SOL003 3.3.1 ETSI NFV-SOL013 3.4.1

Update a VNF instance (v2)

PATCH vnflcm/v2/vnf_instances/{vnfInstanceId}

ETSI NFV-SOL002 3.3.1 ETSI NFV-SOL003 3.3.1 ETSI NFV-SOL013 3.4.1

Change External VNF Connectivity (v2)

POST /vnflcm/v2/vnf_instances/{vnfInstanceId}/change_ext_conn

ETSI NFV-SOL002 3.3.1 ETSI NFV-SOL003 3.3.1 ETSI NFV-SOL013 3.4.1

Change Current VNF Package (v2)

POST /vnflcm/v2/vnf_instances/{vnfInstanceId}/change_vnfpkg

ETSI NFV-SOL002 3.3.1 (*1) ETSI NFV-SOL003 3.3.1 ETSI NFV-SOL013 3.4.1

Show VNF LCM operation occurrence (v2)

GET /vnflcm/v2/vnf_lcm_op_occs/{vnfLcmOpOccId}

ETSI NFV-SOL002 3.3.1 ETSI NFV-SOL003 3.3.1 ETSI NFV-SOL013 3.4.1

List VNF LCM operation occurrence (v2)

GET /vnflcm/v2/vnf_lcm_op_occs

ETSI NFV-SOL002 3.3.1 ETSI NFV-SOL003 3.3.1 ETSI NFV-SOL013 3.4.1

Retry a VNF LCM operation occurrence (v2)

POST /vnflcm/v2/vnf_lcm_op_occs/{vnfLcmOpOccId}/retry

ETSI NFV-SOL002 3.3.1 ETSI NFV-SOL003 3.3.1 ETSI NFV-SOL013 3.4.1

Fail a VNF LCM operation occurrence (v2)

POST /vnflcm/v2/vnf_lcm_op_occs/{vnfLcmOpOccId}/fail

ETSI NFV-SOL002 3.3.1 ETSI NFV-SOL003 3.3.1 ETSI NFV-SOL013 3.4.1

Rollback a VNF LCM operation occurrence (v2)

POST /vnflcm/v2/vnf_lcm_op_occs/{vnfLcmOpOccId}/rollback

ETSI NFV-SOL002 3.3.1 ETSI NFV-SOL003 3.3.1 ETSI NFV-SOL013 3.4.1

Create a new subscription (v2)

POST /vnflcm/v2/subscriptions

ETSI NFV-SOL002 3.3.1 ETSI NFV-SOL003 3.3.1 ETSI NFV-SOL013 3.4.1 (*2)

Delete a subscription (v2)

DELETE /vnflcm/v2/subscriptions/{subscriptionId}

ETSI NFV-SOL002 3.3.1 ETSI NFV-SOL003 3.3.1 ETSI NFV-SOL013 3.4.1

Show subscription (v2)

GET /vnflcm/v2/subscriptions/{subscriptionId}

ETSI NFV-SOL002 3.3.1 ETSI NFV-SOL003 3.3.1 ETSI NFV-SOL013 3.4.1

List subscription (v2)

GET /vnflcm/v2/subscriptions

ETSI NFV-SOL002 3.3.1 ETSI NFV-SOL003 3.3.1 ETSI NFV-SOL013 3.4.1

(*1)The functionality related to VNF LCM Coordination in Change current VNF package complies with ETSI NFV-SOL002 3.6.1.

(*2)OAUTH2_CLIENT_CERT in SubscriptionAuthentication is compliant with ETSI NFV-SOL013 3.5.1.

VNF Performance Management

API name

Method & URI

ETSI NFV-SOL Version

Create a PM job (v2)

POST /vnfpm/v2/pm_jobs

ETSI NFV-SOL002 3.3.1 ETSI NFV-SOL003 3.3.1 ETSI NFV-SOL013 3.4.1 (*1)

Get for PM jobs (v2)

GET /vnfpm/v2/pm_jobs

ETSI NFV-SOL002 3.3.1 ETSI NFV-SOL003 3.3.1 ETSI NFV-SOL013 3.4.1

Get a PM job (v2)

GET /vnfpm/v2/pm_jobs/{pmJobId}

ETSI NFV-SOL002 3.3.1 ETSI NFV-SOL003 3.3.1 ETSI NFV-SOL013 3.4.1

Modify a PM job(v2)

PATCH /vnfpm/v2/pm_jobs/{pmJobId}

ETSI NFV-SOL002 3.3.1 ETSI NFV-SOL003 3.3.1 ETSI NFV-SOL013 3.4.1

Delete a PM job (v2)

DELETE /vnfpm/v2/pm_jobs/{pmJobId}

ETSI NFV-SOL002 3.3.1 ETSI NFV-SOL003 3.3.1 ETSI NFV-SOL013 3.4.1

Get individual performance report (v2)

GET /vnfpm/v2/pm_jobs/{pmJobId}/reports/{reportId}

ETSI NFV-SOL002 3.3.1 ETSI NFV-SOL003 3.3.1 ETSI NFV-SOL013 3.4.1

Create a PM threshold (v2)

POST /vnfpm/v2/thresholds

ETSI NFV-SOL002 3.3.1 ETSI NFV-SOL003 3.3.1 ETSI NFV-SOL013 3.4.1 (*1)

Get for PM thresholds (v2)

GET /vnfpm/v2/thresholds

ETSI NFV-SOL002 3.3.1 ETSI NFV-SOL003 3.3.1 ETSI NFV-SOL013 3.4.1

Get a PM threshold (v2)

GET /vnfpm/v2/thresholds/{thresholdId}

ETSI NFV-SOL002 3.3.1 ETSI NFV-SOL003 3.3.1 ETSI NFV-SOL013 3.4.1

Modify a PM threshold(v2)

PATCH /vnfpm/v2/thresholds/{thresholdId}

ETSI NFV-SOL002 3.3.1 ETSI NFV-SOL003 3.3.1 ETSI NFV-SOL013 3.4.1

Delete a PM threshold (v2)

DELETE /vnfpm/v2/thresholds/{thresholdId}

ETSI NFV-SOL002 3.3.1 ETSI NFV-SOL003 3.3.1 ETSI NFV-SOL013 3.4.1

(*1)OAUTH2_CLIENT_CERT in SubscriptionAuthentication is compliant with ETSI NFV-SOL013 3.5.1.

VNF Fault Management

API name

Method & URI

ETSI NFV-SOL Version

Get all alarms (v1)

GET /vnffm/v1/alarms

ETSI NFV-SOL002 3.3.1 ETSI NFV-SOL003 3.3.1 ETSI NFV-SOL013 3.4.1

Get the individual alarm (v1)

GET /vnffm/v1/alarms/{alarmId}

ETSI NFV-SOL002 3.3.1 ETSI NFV-SOL003 3.3.1 ETSI NFV-SOL013 3.4.1

Modify the confirmation status (v1)

PATCH /vnffm/v1/alarms/{alarmId}

ETSI NFV-SOL002 3.3.1 ETSI NFV-SOL003 3.3.1 ETSI NFV-SOL013 3.4.1

Create a subscription (v1)

POST /vnffm/v1/subscriptions

ETSI NFV-SOL002 3.3.1 ETSI NFV-SOL003 3.3.1 ETSI NFV-SOL013 3.4.1 (*1)

Get all subscriptions (v1)

GET /vnffm/v1/subscriptions

ETSI NFV-SOL002 3.3.1 ETSI NFV-SOL003 3.3.1 ETSI NFV-SOL013 3.4.1

Get a subscription (v1)

GET /vnffm/v1/subscriptions/{subscriptionId}

ETSI NFV-SOL002 3.3.1 ETSI NFV-SOL003 3.3.1 ETSI NFV-SOL013 3.4.1

Delete a subscription (v1)

DELETE /vnffm/v1/subscriptions/{subscriptionId}

ETSI NFV-SOL002 3.3.1 ETSI NFV-SOL003 3.3.1 ETSI NFV-SOL013 3.4.1

(*1)OAUTH2_CLIENT_CERT in SubscriptionAuthentication is compliant with ETSI NFV-SOL013 3.5.1.