Legacy Tacker API¶
API versions¶
Lists information of NFV Orchestration API 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 |
status |
body |
string |
Status of the API, which can be |
id |
body |
string |
Version of the API. |
links |
body |
array |
List of version links. Each link contains |
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.
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 |
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 |
vim_project |
body |
object |
A VIM’s project information object for the remote OpenStack site.
Project information can contain |
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.42.131/identity",
"auth_cred": {
"username": "nfv_user",
"user_domain_name": "Default",
"password": "password",
"cert_verify": "True"
},
"vim_project": {
"name": "nfv",
"project_domain_name": "Default"
},
"name": "VIM1",
"description": "Additional site",
"is_default": false
}
}
Response Parameters¶
Name |
In |
Type |
Description |
---|---|---|---|
vim |
body |
object |
A |
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 |
vim_project |
body |
object |
A VIM’s project information object for the remote OpenStack site.
Project information can contain |
updated_at |
body |
string |
The date and time when the VIM was updated.
The format is |
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 |
auth_cred |
body |
object |
An authentication credential object for the remote OpenStack site.
Credential contains |
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": {
"status": "PENDING",
"description": "Additional site",
"tenant_id": "a5346a4d3c464b4f8776ee2f4bfb86af",
"created_at": "2018-06-18 04:13:26.465823",
"vim_project": {
"name": "nfv",
"project_domain_name": "Default"
},
"updated_at": null,
"is_default": false,
"auth_url": "http://192.168.42.131/identity/v3",
"placement_attr": {
"regions": [
"RegionOne"
]
},
"auth_cred": {
"username": "nfv_user",
"password": "***",
"project_name": "nfv",
"cert_verify": "True",
"user_domain_name": "Default",
"auth_url": "http://192.168.42.131/identity/v3",
"project_id": null,
"key_type": "barbican_key",
"secret_uuid": "***",
"project_domain_name": "Default"
},
"type": "openstack",
"id": "28dbc4f0-80e2-4006-b26c-724a1202e82d",
"name": "VIM1"
}
}
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 |
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 |
vim_project |
body |
object |
A VIM’s project information object for the remote OpenStack site.
Project information can contain |
updated_at |
body |
string |
The date and time when the VIM was updated.
The format is |
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 |
auth_cred |
body |
object |
An authentication credential object for the remote OpenStack site.
Credential contains |
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": [
{
"status": "REACHABLE",
"description": "",
"tenant_id": "a5346a4d3c464b4f8776ee2f4bfb86af",
"created_at": "2018-06-17 16:26:52",
"vim_project": {
"name": "nfv",
"project_domain_name": "Default"
},
"updated_at": "2018-06-18 03:45:49",
"is_default": true,
"auth_url": "http://192.168.42.131/identity/v3",
"placement_attr": {
"regions": [
"RegionOne"
]
},
"auth_cred": {
"username": "nfv_user",
"password": "***",
"project_name": "nfv",
"cert_verify": "True",
"user_domain_name": "Default",
"auth_url": "http://192.168.42.131/identity/v3",
"project_id": null,
"key_type": "barbican_key",
"secret_uuid": "***",
"project_domain_name": "Default"
},
"type": "openstack",
"id": "cb7ac02e-1445-48c2-a3cb-4fcddd49fce5",
"name": "VIM0"
}
]
}
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 |
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 |
vim_project |
body |
object |
A VIM’s project information object for the remote OpenStack site.
Project information can contain |
updated_at |
body |
string |
The date and time when the VIM was updated.
The format is |
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 |
auth_cred |
body |
object |
An authentication credential object for the remote OpenStack site.
Credential contains |
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": {
"status": "REACHABLE",
"description": "",
"tenant_id": "a5346a4d3c464b4f8776ee2f4bfb86af",
"created_at": "2018-06-17 16:26:52",
"vim_project": {
"name": "nfv",
"project_domain_name": "Default"
},
"updated_at": "2018-06-18 03:45:49",
"is_default": false,
"auth_url": "http://192.168.42.131/identity/v3",
"placement_attr": {
"regions": [
"RegionOne"
]
},
"auth_cred": {
"username": "nfv_user",
"password": "***",
"project_id": null,
"project_name": "nfv",
"cert_verify": "True",
"user_domain_name": "Default",
"key_type": "barbican_key",
"secret_uuid": "***",
"auth_url": "http://192.168.42.131/identity/v3",
"project_domain_name": "Default"
},
"type": "openstack",
"id": "cb7ac02e-1445-48c2-a3cb-4fcddd49fce5",
"name": "VIM0"
}
}
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 |
auth_cred |
body |
object |
An authentication credential object for the remote OpenStack site.
Credential can contain |
vim_project (Optional) |
body |
object |
A VIM’s project information object for the remote OpenStack site.
Project information can contain |
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 |
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 |
vim_project |
body |
object |
A VIM’s project information object for the remote OpenStack site.
Project information can contain |
updated_at |
body |
string |
The date and time when the VIM was updated.
The format is |
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 |
auth_cred |
body |
object |
An authentication credential object for the remote OpenStack site.
Credential contains |
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": {
"status": "REACHABLE",
"description": "New Description",
"tenant_id": "a5346a4d3c464b4f8776ee2f4bfb86af",
"created_at": "2018-06-18 04:13:26",
"vim_project": {
"project_domain_name": "NewDomain",
"name": "new_nfv"
}
"updated_at": "2018-06-18 04:33:41.462895",
"is_default": false,
"auth_url": "http://192.168.42.131/identity/v3",
"placement_attr": {
"regions": [
"RegionOne"
]
},
"auth_cred": {
"username": "new_nfv_user",
"password": "***",
"project_id": null,
"project_name": "new_nfv",
"user_domain_name": "NewDomain",
"auth_url": "http://192.168.42.131/identity/v3",
"project_domain_name": "NewDomain",
"cert_verify": "True",
"key_type": "barbican_key",
"secret_uuid": "***"
},
"type": "openstack",
"id": "28dbc4f0-80e2-4006-b26c-724a1202e82d",
"name": "new_VIM1"
}
}
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. |