Legacy Tacker API

API versions

Lists information of NFV Orchestration API versions.

GET
/

List versions

Lists NFV Orchestration API versions.

Response Codes

Success

Code

Reason
200 - OK

Request was successful.
Error

Code

Reason
401 - Unauthorized

User must authenticate before making a request.
500 - Internal Server Error

Something went wrong inside the service. This should not happen usually. If it does happen, it means the server has experienced some serious problems.

Response Parameters

Name

In

Type

Description

versions

body

array

A list of version objects.

status

body

string

Status of the API, which can be CURRENT, STABLE or DEPRECATED.

id

body

string

Version of the API.

links

body

array

List of version links. Each link contains href and rel.

href

body

string

Link to the API.

rel

body

string

Relationship of link with the version.

Response Example

{
    "versions": [
        {
            "status": "CURRENT",
            "id": "v1.0",
            "links": [
                {
                    "href": "http://192.168.1.1:9890/v1.0",
                    "rel": "self"
                }
            ]
        }
    ]
}

Virtualized Infrastructure Managers (VIMs)

Manages Virtualized Infrastructure Managers (VIMs).

The VIM is responsible for controlling and managing Network Function Virtualization Infrastructure (NFVI) which provides VNFs with the resources they need.

POST
/v1.0/vims

Register VIM

Registers a VIM.

Response Codes

Success

Code

Reason
201 - Created

Resource was created and is ready to use.
Error

Code

Reason
400 - Bad Request

Some content in the request was invalid.
401 - Unauthorized

User must authenticate before making a request.
404 - Not Found

The requested resource could not be found.
500 - Internal Server Error

Something went wrong inside the service. This should not happen usually. If it does happen, it means the server has experienced some serious problems.

Request Parameters

Name

In

Type

Description

vim

body

object

A vim object.

tenant_id (Optional)

body

string

The UUID of the tenant. A tenant is also known as a project.

type

body

string

The type of VIM. Currently there is only one built-in VIM driver, which is for “openstack” type.

auth_url

body

string

The authentication URL for the Keystone service of the remote OpenStack site.

auth_cred

body

object

An authentication credential object for the remote OpenStack site. Credential can contain user_id (and/or username) and password. It also contains user_domain_name when using identity v3.

vim_project

body

object

A VIM’s project information object for the remote OpenStack site. Project information can contain id or name. It also contains project_domain_name when using identity v3.

name

body

string

Human-readable name for the resource.

description (Optional)

body

string

Human-readable description for the resource.

is_default (Optional)

body

boolean

Indicate whether the VIM is used as default.

Request Example

{
    "vim": {
        "type": "openstack",
        "auth_url": "http://192.168.56.10/identity",
        "auth_cred": {
            "username": "nfv_user",
            "user_domain_name": "Default",
            "password": "password",
            "cert_verify": "True"
        },
        "vim_project": {
            "name": "nfv",
            "project_domain_name": "Default"
        },
        "name": "VIM0",
        "description": "",
        "is_default": true
    }
}

Response Parameters

Name

In

Type

Description

vim

body

object

A vim object.

status

body

string

Status of the VIM.

description

body

string

Human-readable description for the resource.

tenant_id

body

string

The UUID of the tenant. A tenant is also known as a project.

created_at

body

string

The date and time when the VIM was registered. The format is YYYY-MM-DD hh:mm:ss.ssssss. For example, 2016-09-23 09:59:27.392759.

vim_project

body

object

A VIM’s project information object for the remote OpenStack site. Project information can contain id or name. It also contains project_domain_name when using identity v3.

updated_at

body

string

The date and time when the VIM was updated. The format is YYYY-MM-DD hh:mm:ss.ssssss. For example, 2016-09-23 09:59:27.392759.

is_default

body

boolean

Indicate whether the VIM is used as default.

auth_url

body

string

The authentication URL for the Keystone service of the remote OpenStack site.

placement_attr

body

object

VIM placement information object that includes regions, which is a list of Region IDs. regions are automatically derived from VIM.

auth_cred

body

object

An authentication credential object for the remote OpenStack site. Credential contains user_id (and/or username), password, project_id, project_name, and auth_url. It also contains user_domain_name and project_domain_name when using identity v3.

type

body

string

The type of VIM. Currently there is only one built-in VIM driver, which is for “openstack” type.

id

body

string

The UUID of the VIM.

name

body

string

Human-readable name for the resource.

Response Example

{
    "vim": {
        "auth_cred": {
            "auth_url": "http://192.168.56.10/identity/v3",
            "cert_verify": "True",
            "key_type": "barbican_key",
            "password": "***",
            "project_domain_name": "Default",
            "project_id": null,
            "project_name": "nfv",
            "secret_uuid": "***",
            "user_domain_name": "Default",
            "username": "nfv_user"
        },
        "auth_url": "http://192.168.56.10/identity/v3",
        "created_at": "2024-12-03 08:17:28.513225",
        "description": "",
        "extra": {},
        "id": "ac65f86a-eece-4ab3-9be3-483d09189c7f",
        "is_default": true,
        "name": "VIM0",
        "placement_attr": {
            "regions": [
                "RegionOne"
            ]
        },
        "status": "ACTIVE",
        "tenant_id": "875c2bf1627b4b22a7f3c8c0cae5efda",
        "type": "openstack",
        "updated_at": null,
        "vim_project": {
            "name": "nfv",
            "project_domain_name": "Default"
        }
    }
}
GET
/v1.0/vims

List VIMs

Lists VIMs.

Response Codes

Success

Code

Reason
200 - OK

Request was successful.
Error

Code

Reason
401 - Unauthorized

User must authenticate before making a request.
500 - Internal Server Error

Something went wrong inside the service. This should not happen usually. If it does happen, it means the server has experienced some serious problems.

Response Parameters

Name

In

Type

Description

vims

body

array

A list of vim objects.

status

body

string

Status of the VIM.

description

body

string

Human-readable description for the resource.

tenant_id

body

string

The UUID of the tenant. A tenant is also known as a project.

created_at

body

string

The date and time when the VIM was registered. The format is YYYY-MM-DD hh:mm:ss.ssssss. For example, 2016-09-23 09:59:27.392759.

vim_project

body

object

A VIM’s project information object for the remote OpenStack site. Project information can contain id or name. It also contains project_domain_name when using identity v3.

updated_at

body

string

The date and time when the VIM was updated. The format is YYYY-MM-DD hh:mm:ss.ssssss. For example, 2016-09-23 09:59:27.392759.

is_default

body

boolean

Indicate whether the VIM is used as default.

auth_url

body

string

The authentication URL for the Keystone service of the remote OpenStack site.

placement_attr

body

object

VIM placement information object that includes regions, which is a list of Region IDs. regions are automatically derived from VIM.

auth_cred

body

object

An authentication credential object for the remote OpenStack site. Credential contains user_id (and/or username), password, project_id, project_name, and auth_url. It also contains user_domain_name and project_domain_name when using identity v3.

type

body

string

The type of VIM. Currently there is only one built-in VIM driver, which is for “openstack” type.

id

body

string

The UUID of the VIM.

name

body

string

Human-readable name for the resource.

Response Example

{
    "vims": [
        {
            "auth_cred": {
                "auth_url": "http://192.168.56.10/identity/v3",
                "cert_verify": "False",
                "key_type": "barbican_key",
                "password": "***",
                "project_domain_name": "Default",
                "project_id": null,
                "project_name": "nfv",
                "secret_uuid": "***",
                "user_domain_name": "Default",
                "username": "nfv_user"
            },
            "auth_url": "http://192.168.56.10/identity/v3",
            "created_at": "2024-12-03 05:19:49",
            "description": "",
            "extra": {},
            "id": "fd8a3ac0-8e61-4740-a021-8fa35d833635",
            "is_default": true,
            "name": "VIM0",
            "placement_attr": {
                "regions": [
                    "RegionOne"
                ]
            },
            "status": "ACTIVE",
            "tenant_id": "875c2bf1627b4b22a7f3c8c0cae5efda",
            "type": "openstack",
            "updated_at": null,
            "vim_project": {
                "name": "nfv",
                "project_domain_name": "Default"
            }
        }
    ]
}
GET
/v1.0/vims/{vim_id}

Show VIM

Shows information of a given VIM.

Response Codes

Success

Code

Reason
200 - OK

Request was successful.
Error

Code

Reason
401 - Unauthorized

User must authenticate before making a request.
404 - Not Found

The requested resource could not be found.
500 - Internal Server Error

Something went wrong inside the service. This should not happen usually. If it does happen, it means the server has experienced some serious problems.

Request Parameters

Name

In

Type

Description

vim_id

path

string

The UUID of the VIM.

Response Parameters

Name

In

Type

Description

vim

body

object

A vim object.

status

body

string

Status of the VIM.

description

body

string

Human-readable description for the resource.

tenant_id

body

string

The UUID of the tenant. A tenant is also known as a project.

created_at

body

string

The date and time when the VIM was registered. The format is YYYY-MM-DD hh:mm:ss.ssssss. For example, 2016-09-23 09:59:27.392759.

vim_project

body

object

A VIM’s project information object for the remote OpenStack site. Project information can contain id or name. It also contains project_domain_name when using identity v3.

updated_at

body

string

The date and time when the VIM was updated. The format is YYYY-MM-DD hh:mm:ss.ssssss. For example, 2016-09-23 09:59:27.392759.

is_default

body

boolean

Indicate whether the VIM is used as default.

auth_url

body

string

The authentication URL for the Keystone service of the remote OpenStack site.

placement_attr

body

object

VIM placement information object that includes regions, which is a list of Region IDs. regions are automatically derived from VIM.

auth_cred

body

object

An authentication credential object for the remote OpenStack site. Credential contains user_id (and/or username), password, project_id, project_name, and auth_url. It also contains user_domain_name and project_domain_name when using identity v3.

type

body

string

The type of VIM. Currently there is only one built-in VIM driver, which is for “openstack” type.

id

body

string

The UUID of the VIM.

name

body

string

Human-readable name for the resource.

Response Example

{
    "vim": {
        "auth_cred": {
            "auth_url": "http://192.168.56.10/identity/v3",
            "cert_verify": "False",
            "key_type": "barbican_key",
            "password": "***",
            "project_domain_name": "Default",
            "project_id": null,
            "project_name": "nfv",
            "secret_uuid": "***",
            "user_domain_name": "Default",
            "username": "nfv_user"
        },
        "auth_url": "http://192.168.56.10/identity/v3",
        "created_at": "2024-12-03 05:19:49",
        "description": "",
        "extra": {},
        "id": "fd8a3ac0-8e61-4740-a021-8fa35d833635",
        "is_default": true,
        "name": "VIM0",
        "placement_attr": {
            "regions": [
                "RegionOne"
            ]
        },
        "status": "ACTIVE",
        "tenant_id": "875c2bf1627b4b22a7f3c8c0cae5efda",
        "type": "openstack",
        "updated_at": null,
        "vim_project": {
            "name": "nfv",
            "project_domain_name": "Default"
        }
    }
}
PUT
/v1.0/vims/{vim_id}

Update VIM

Updates a given VIM. Only a VIM without any associated VNFs can be updated.

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.
404 - Not Found

The requested resource could not be found.
409 - Conflict

This operation conflicted with another operation on this resource.
500 - Internal Server Error

Something went wrong inside the service. This should not happen usually. If it does happen, it means the server has experienced some serious problems.

Request Parameters

Name

In

Type

Description

vim_id

path

string

The UUID of the VIM.

vim

body

object

A vim object.

auth_cred

body

object

An authentication credential object for the remote OpenStack site. Credential can contain user_id (and/or username) and password. It also contains user_domain_name when using identity v3.

vim_project (Optional)

body

object

A VIM’s project information object for the remote OpenStack site. Project information can contain id or name. It also contains project_domain_name when using identity v3.

name (Optional)

body

string

Human-readable name for the resource.

description (Optional)

body

string

Human-readable description for the resource.

is_default (Optional)

body

boolean

Indicate whether the VIM is used as default.

Request Example

{
    "vim": {
        "auth_cred": {
            "username": "new_nfv_user",
            "user_domain_name": "NewDomain",
            "password": "newpassword",
            "cert_verify": "True"
        },
        "vim_project": {
            "name": "new_nfv",
            "project_domain_name": "NewDomain"
        },
        "name": "new_VIM1",
        "description": "New Description"
    }
}

Response Parameters

Name

In

Type

Description

vim

body

object

A vim object.

status

body

string

Status of the VIM.

description

body

string

Human-readable description for the resource.

tenant_id

body

string

The UUID of the tenant. A tenant is also known as a project.

created_at

body

string

The date and time when the VIM was registered. The format is YYYY-MM-DD hh:mm:ss.ssssss. For example, 2016-09-23 09:59:27.392759.

vim_project

body

object

A VIM’s project information object for the remote OpenStack site. Project information can contain id or name. It also contains project_domain_name when using identity v3.

updated_at

body

string

The date and time when the VIM was updated. The format is YYYY-MM-DD hh:mm:ss.ssssss. For example, 2016-09-23 09:59:27.392759.

is_default

body

boolean

Indicate whether the VIM is used as default.

auth_url

body

string

The authentication URL for the Keystone service of the remote OpenStack site.

placement_attr

body

object

VIM placement information object that includes regions, which is a list of Region IDs. regions are automatically derived from VIM.

auth_cred

body

object

An authentication credential object for the remote OpenStack site. Credential contains user_id (and/or username), password, project_id, project_name, and auth_url. It also contains user_domain_name and project_domain_name when using identity v3.

type

body

string

The type of VIM. Currently there is only one built-in VIM driver, which is for “openstack” type.

id

body

string

The UUID of the VIM.

name

body

string

Human-readable name for the resource.

Response Example

{
    "vim": {
        "auth_cred": {
            "auth_url": "http://192.168.56.10/identity/v3",
            "cert_verify": "True",
            "key_type": "barbican_key",
            "password": "***",
            "project_domain_name": "NewDomain",
            "project_id": null,
            "project_name": "new_nfv",
            "secret_uuid": "***",
            "user_domain_name": "NewDomain",
            "username": "new_nfv_user"
        },
        "auth_url": "http://192.168.56.10/identity/v3",
        "created_at": "2024-12-03 05:19:49",
        "description": "New Description",
        "extra": {},
        "id": "fd8a3ac0-8e61-4740-a021-8fa35d833635",
        "is_default": true,
        "name": "new_VIM0",
        "placement_attr": {
            "regions": [
                "RegionOne"
            ]
        },
        "status": "ACTIVE",
        "tenant_id": "875c2bf1627b4b22a7f3c8c0cae5efda",
        "type": "openstack",
        "updated_at": "2024-12-03 05:49:54.671415",
        "vim_project": {
            "name": "new_nfv",
            "project_domain_name": "NewDomain"
        }
    }
}
DELETE
/v1.0/vims/{vim_id}

Delete VIM

Deletes a given VIM. Only a VIM without any associated VNFs can be deleted.

Response Codes

Success

Code

Reason
204 - No Content

The server has fulfilled the request by deleting the resource.
Error

Code

Reason
401 - Unauthorized

User must authenticate before making a request.
404 - Not Found

The requested resource could not be found.
409 - Conflict

This operation conflicted with another operation on this resource.
500 - Internal Server Error

Something went wrong inside the service. This should not happen usually. If it does happen, it means the server has experienced some serious problems.

Request Parameters

Name

In

Type

Description

vim_id

path

string

The UUID of the VIM.