Legacy Tacker API¶

API 版本¶

列出 NFV 编排 API 版本信息。

GET

列出版本

列出 NFV 编排 API 版本。

响应代码¶

成功¶

代码	原因
`200 - 正常`	请求成功。

错误¶

代码	原因
`401 - 未授权`	用户必须在发出请求之前进行身份验证。
`500 - 内部服务器错误`	服务内部出现问题。通常不应发生这种情况。如果发生这种情况，则表示服务器遇到了一些严重问题。

响应参数¶

名称	入参	类型	描述
versions	body	数组	一个 `version` 对象列表。
status	body	字符串	API 的状态，可以是 `CURRENT`、`STABLE` 或 `DEPRECATED`。
id	body	字符串	API 的版本。
links	body	数组	版本链接列表。每个链接包含 `href` 和 `rel`。
href	body	字符串	API 的链接。
rel	body	字符串	链接与版本的关系。

响应示例¶

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

虚拟化基础设施管理器 (VIM)¶

管理虚拟化基础设施管理器 (VIM)。

VIM 负责控制和管理网络功能虚拟化基础设施 (NFVI)，为 VNFs 提供所需的资源。

POST

/v1.0/vims

注册一个 VIM。

响应代码¶

成功¶

代码	原因
`201 - 已创建`	资源已创建并准备好使用。

错误¶

代码	原因
`400 - 请求错误`	请求中的某些内容无效。
`401 - 未授权`	用户必须在发出请求之前进行身份验证。
`404 - Not Found`	找不到请求的资源。
`500 - 内部服务器错误`	服务内部出现问题。通常不应发生这种情况。如果发生这种情况，则表示服务器遇到了一些严重问题。

请求参数¶

名称	入参	类型	描述
vim	body	对象	一个 `vim` 对象。
tenant_id (可选)	body	字符串	租户的 UUID。租户也称为项目。
type	body	字符串	VIM 的类型。目前只有一种内置 VIM 驱动程序，类型为“openstack”。
auth_url	body	字符串	远程 OpenStack 站点的 Keystone 服务的认证 URL。
auth_cred	body	对象	远程 OpenStack 站点的认证凭据对象。凭据可以包含 `user_id`（和/或 `username`）和 `password`。在使用 identity v3 时，它还包含 `user_domain_name`。
vim_project	body	对象	远程 OpenStack 站点的 VIM 的项目信息对象。项目信息可以包含 `id` 或 `name`。在使用 identity v3 时，它还包含 `project_domain_name`。
name	body	字符串	资源的易于理解的名称。
description (可选)	body	字符串	资源的易于理解的描述。
is_default (可选)	body	布尔值	指示 VIM 是否用作默认值。

请求示例¶

{
    "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
    }
}

响应参数¶

名称	入参	类型	描述
vim	body	对象	一个 `vim` 对象。
status	body	字符串	VIM 的状态。
description	body	字符串	资源的易于理解的描述。
tenant_id	body	字符串	租户的 UUID。租户也称为项目。
created_at	body	字符串	VIM 注册的日期和时间。格式为 `YYYY-MM-DD hh:mm:ss.ssssss`。例如，`2016-09-23 09:59:27.392759`。
vim_project	body	对象	远程 OpenStack 站点的 VIM 的项目信息对象。项目信息可以包含 `id` 或 `name`。在使用 identity v3 时，它还包含 `project_domain_name`。
updated_at	body	字符串	VIM 更新的日期和时间。格式为 `YYYY-MM-DD hh:mm:ss.ssssss`。例如，`2016-09-23 09:59:27.392759`。
is_default	body	布尔值	指示 VIM 是否用作默认值。
auth_url	body	字符串	远程 OpenStack 站点的 Keystone 服务的认证 URL。
placement_attr	body	对象	VIM 定位信息对象，包括 `regions`，这是一个区域 ID 列表。`regions` 会自动从 VIM 派生。
auth_cred	body	对象	远程 OpenStack 站点的认证凭据对象。凭据包含 `user_id`（和/或 `username`）、`password`、`project_id`、`project_name` 和 `auth_url`。在使用 identity v3 时，它还包含 `user_domain_name` 和 `project_domain_name`。
type	body	字符串	VIM 的类型。目前只有一种内置 VIM 驱动程序，类型为“openstack”。
id	body	字符串	VIM 的 UUID。
name	body	字符串	资源的易于理解的名称。

响应示例¶

{
    "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

列出 VIM

列出 VIM。

响应代码¶

成功¶

代码	原因
`200 - 正常`	请求成功。

错误¶

代码	原因
`401 - 未授权`	用户必须在发出请求之前进行身份验证。
`500 - 内部服务器错误`	服务内部出现问题。通常不应发生这种情况。如果发生这种情况，则表示服务器遇到了一些严重问题。

响应参数¶

名称	入参	类型	描述
vims	body	数组	一个 `vim` 对象列表。
status	body	字符串	VIM 的状态。
description	body	字符串	资源的易于理解的描述。
tenant_id	body	字符串	租户的 UUID。租户也称为项目。
created_at	body	字符串	VIM 注册的日期和时间。格式为 `YYYY-MM-DD hh:mm:ss.ssssss`。例如，`2016-09-23 09:59:27.392759`。
vim_project	body	对象	远程 OpenStack 站点的 VIM 的项目信息对象。项目信息可以包含 `id` 或 `name`。在使用 identity v3 时，它还包含 `project_domain_name`。
updated_at	body	字符串	VIM 更新的日期和时间。格式为 `YYYY-MM-DD hh:mm:ss.ssssss`。例如，`2016-09-23 09:59:27.392759`。
is_default	body	布尔值	指示 VIM 是否用作默认值。
auth_url	body	字符串	远程 OpenStack 站点的 Keystone 服务的认证 URL。
placement_attr	body	对象	VIM 定位信息对象，包括 `regions`，这是一个区域 ID 列表。`regions` 会自动从 VIM 派生。
auth_cred	body	对象	远程 OpenStack 站点的认证凭据对象。凭据包含 `user_id`（和/或 `username`）、`password`、`project_id`、`project_name` 和 `auth_url`。在使用 identity v3 时，它还包含 `user_domain_name` 和 `project_domain_name`。
type	body	字符串	VIM 的类型。目前只有一种内置 VIM 驱动程序，类型为“openstack”。
id	body	字符串	VIM 的 UUID。
name	body	字符串	资源的易于理解的名称。

响应示例¶

{
    "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}

显示 VIM

显示给定 VIM 的信息。

响应代码¶

成功¶

代码	原因
`200 - 正常`	请求成功。

错误¶

代码	原因
`401 - 未授权`	用户必须在发出请求之前进行身份验证。
`404 - Not Found`	找不到请求的资源。
`500 - 内部服务器错误`	服务内部出现问题。通常不应发生这种情况。如果发生这种情况，则表示服务器遇到了一些严重问题。

请求参数¶

名称	入参	类型	描述
vim_id	路径	字符串	VIM 的 UUID。

响应参数¶

名称	入参	类型	描述
vim	body	对象	一个 `vim` 对象。
status	body	字符串	VIM 的状态。
description	body	字符串	资源的易于理解的描述。
tenant_id	body	字符串	租户的 UUID。租户也称为项目。
created_at	body	字符串	VIM 注册的日期和时间。格式为 `YYYY-MM-DD hh:mm:ss.ssssss`。例如，`2016-09-23 09:59:27.392759`。
vim_project	body	对象	远程 OpenStack 站点的 VIM 的项目信息对象。项目信息可以包含 `id` 或 `name`。在使用 identity v3 时，它还包含 `project_domain_name`。
updated_at	body	字符串	VIM 更新的日期和时间。格式为 `YYYY-MM-DD hh:mm:ss.ssssss`。例如，`2016-09-23 09:59:27.392759`。
is_default	body	布尔值	指示 VIM 是否用作默认值。
auth_url	body	字符串	远程 OpenStack 站点的 Keystone 服务的认证 URL。
placement_attr	body	对象	VIM 定位信息对象，包括 `regions`，这是一个区域 ID 列表。`regions` 会自动从 VIM 派生。
auth_cred	body	对象	远程 OpenStack 站点的认证凭据对象。凭据包含 `user_id`（和/或 `username`）、`password`、`project_id`、`project_name` 和 `auth_url`。在使用 identity v3 时，它还包含 `user_domain_name` 和 `project_domain_name`。
type	body	字符串	VIM 的类型。目前只有一种内置 VIM 驱动程序，类型为“openstack”。
id	body	字符串	VIM 的 UUID。
name	body	字符串	资源的易于理解的名称。

响应示例¶

{
    "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}

更新 VIM

更新给定的 VIM。只有没有关联 VNFs 的 VIM 才能更新。

响应代码¶

成功¶

代码	原因
`200 - 正常`	请求成功。

错误¶

代码	原因
`400 - 请求错误`	请求中的某些内容无效。
`401 - 未授权`	用户必须在发出请求之前进行身份验证。
`404 - Not Found`	找不到请求的资源。
`409 - Conflict`	此操作与此资源的另一个操作冲突。
`500 - 内部服务器错误`	服务内部出现问题。通常不应发生这种情况。如果发生这种情况，则表示服务器遇到了一些严重问题。

请求参数¶

名称	入参	类型	描述
vim_id	路径	字符串	VIM 的 UUID。
vim	body	对象	一个 `vim` 对象。
auth_cred	body	对象	远程 OpenStack 站点的认证凭据对象。凭据可以包含 `user_id`（和/或 `username`）和 `password`。在使用 identity v3 时，它还包含 `user_domain_name`。
vim_project (可选)	body	对象	远程 OpenStack 站点的 VIM 的项目信息对象。项目信息可以包含 `id` 或 `name`。在使用 identity v3 时，它还包含 `project_domain_name`。
name (可选)	body	字符串	资源的易于理解的名称。
description (可选)	body	字符串	资源的易于理解的描述。
is_default (可选)	body	布尔值	指示 VIM 是否用作默认值。

请求示例¶

{
    "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"
    }
}

响应参数¶

名称	入参	类型	描述
vim	body	对象	一个 `vim` 对象。
status	body	字符串	VIM 的状态。
description	body	字符串	资源的易于理解的描述。
tenant_id	body	字符串	租户的 UUID。租户也称为项目。
created_at	body	字符串	VIM 注册的日期和时间。格式为 `YYYY-MM-DD hh:mm:ss.ssssss`。例如，`2016-09-23 09:59:27.392759`。
vim_project	body	对象	远程 OpenStack 站点的 VIM 的项目信息对象。项目信息可以包含 `id` 或 `name`。在使用 identity v3 时，它还包含 `project_domain_name`。
updated_at	body	字符串	VIM 更新的日期和时间。格式为 `YYYY-MM-DD hh:mm:ss.ssssss`。例如，`2016-09-23 09:59:27.392759`。
is_default	body	布尔值	指示 VIM 是否用作默认值。
auth_url	body	字符串	远程 OpenStack 站点的 Keystone 服务的认证 URL。
placement_attr	body	对象	VIM 定位信息对象，包括 `regions`，这是一个区域 ID 列表。`regions` 会自动从 VIM 派生。
auth_cred	body	对象	远程 OpenStack 站点的认证凭据对象。凭据包含 `user_id`（和/或 `username`）、`password`、`project_id`、`project_name` 和 `auth_url`。在使用 identity v3 时，它还包含 `user_domain_name` 和 `project_domain_name`。
type	body	字符串	VIM 的类型。目前只有一种内置 VIM 驱动程序，类型为“openstack”。
id	body	字符串	VIM 的 UUID。
name	body	字符串	资源的易于理解的名称。

响应示例¶

{
    "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}

删除 VIM

删除给定的 VIM。只有没有关联 VNFs 的 VIM 才能删除。

响应代码¶

成功¶

代码	原因
`204 - No Content`	服务器已通过删除资源来满足请求。

错误¶

代码	原因
`401 - 未授权`	用户必须在发出请求之前进行身份验证。
`404 - Not Found`	找不到请求的资源。
`409 - Conflict`	此操作与此资源的另一个操作冲突。
`500 - 内部服务器错误`	服务内部出现问题。通常不应发生这种情况。如果发生这种情况，则表示服务器遇到了一些严重问题。

请求参数¶

名称	入参	类型	描述
vim_id	路径	字符串	VIM 的 UUID。

Legacy Tacker API

Legacy Tacker API¶

API 版本¶

响应代码¶

成功¶

错误¶

响应参数¶

响应示例¶

虚拟化基础设施管理器 (VIM)¶

响应代码¶

成功¶

错误¶

请求参数¶

请求示例¶

响应参数¶

响应示例¶

响应代码¶

成功¶

错误¶

响应参数¶

响应示例¶

响应代码¶

成功¶

错误¶

请求参数¶

响应参数¶

响应示例¶

响应代码¶

成功¶

错误¶

请求参数¶

请求示例¶

响应参数¶

响应示例¶

响应代码¶

成功¶

错误¶

请求参数¶

tacker