裸金属端口组

裸金属端口组列表

功能介绍

获取裸金属端口组列表

URI

GET /v1/portgroups

请求消息

参数	参数类型	是否必选	描述
node	string	否	按照裸金属节点 UUID 过滤
address	string	否	按照端口组 MAC 地址过滤
limit	integer	否	限制一次查询的数量
sort_dir	string	否	按照 acs 或者 desc 排序
sort_key	string	否	按照给定的键进行排序

响应消息

参数	参数类型	描述
portgroups	array	端口组对象列表
name	string	端口组名称
uuid	string	端口组 UUID
address	string	端口组 MAC 地址
node_uuid	string	端口组所在的节点 UUID
standalone_ports_supported	boolean	端口组所在的交换机设备是否支持端口组回退功能
internal_info	JSON	内部信息， 只读
extra	object	端口组额外信息
mode	string	端口组聚合模式
properties	string	端口组属性， 用于配制 bond 设备
created_at	string	端口组创建时间
updated_at	string	端口组更新时间
links	array	端口组相关信息链接
ports	array	端口组内端口列表

请求示例

无

正常响应示例

{
  "portgroups": [
    {
      "address": "11:11:11:11:11:11",
      "links": [
        {
          "href": "http://127.0.0.1:6385/v1/portgroups/e43c722c-248e-4c6e-8ce8-0d8ff129387a",
          "rel": "self"
        },
        {
          "href": "http://127.0.0.1:6385/portgroups/e43c722c-248e-4c6e-8ce8-0d8ff129387a",
          "rel": "bookmark"
        }
      ],
      "name": "test_portgroup",
      "uuid": "e43c722c-248e-4c6e-8ce8-0d8ff129387a"
    }
  ]
}

正常响应代码

200

错误码

400,401,403,404

裸金属端口组详情

功能介绍

获取裸金属端口组详情

URI

GET /v1/portgroups/{portgroup_indent}

请求消息

参数	参数类型	是否必选	描述
portgroup_ident	string	否	端口组UUID
fields	array	否	按给定的键返回值

响应消息

参数	参数类型	描述
name	string	端口组名称
uuid	string	端口组 UUID
address	string	端口组 MAC 地址
node_uuid	string	端口组所在的节点 UUID
standalone_ports_supported	boolean	端口组所在的交换机设备是否支持端口组回退功能
internal_info	JSON	内部信息， 只读
extra	object	端口组额外信息
mode	string	端口组聚合模式
properties	string	端口组属性， 用于配制 bond 设备
created_at	string	端口组创建时间
updated_at	string	端口组更新时间
links	array	端口组相关信息链接
ports	array	端口组内端口列表

请求示例

无

正常响应示例

{
  "address": "11:11:11:11:11:11",
  "created_at": "2016-08-18T22:28:48.643434+11:11",
  "extra": {},
  "internal_info": {},
  "links": [
    {
      "href": "http://127.0.0.1:6385/v1/portgroups/e43c722c-248e-4c6e-8ce8-0d8ff129387a",
      "rel": "self"
    },
    {
      "href": "http://127.0.0.1:6385/portgroups/e43c722c-248e-4c6e-8ce8-0d8ff129387a",
      "rel": "bookmark"
    }
  ],
  "mode": "active-backup",
  "name": "test_portgroup",
  "node_uuid": "6d85703a-565d-469a-96ce-30b6de53079d",
  "ports": [
    {
      "href": "http://127.0.0.1:6385/v1/portgroups/e43c722c-248e-4c6e-8ce8-0d8ff129387a/ports",
      "rel": "self"
    },
    {
      "href": "http://127.0.0.1:6385/portgroups/e43c722c-248e-4c6e-8ce8-0d8ff129387a/ports",
      "rel": "bookmark"
    }
  ],
  "properties": {},
  "standalone_ports_supported": true,
  "updated_at": null,
  "uuid": "e43c722c-248e-4c6e-8ce8-0d8ff129387a"
}

正常响应代码

200

错误码

400,401,403,404

创建裸金属端口组

功能介绍

创建裸金属端口组

URI

POST /v1/portgroups

请求消息

参数	参数类型	描述
name	string	端口组名称
uuid	string	端口组 UUID
address	string	端口组 MAC 地址
node_uuid	string	端口组所在的节点 UUID
standalone_ports_supported	boolean	端口组所在的交换机设备是否支持端口组回退功能
extra	object	端口组额外信息
mode	string	端口组聚合模式
properties	string	端口组属性， 用于配置 bond 设备

响应消息

参数	参数类型	描述
name	string	端口组名称
uuid	string	端口组 UUID
address	string	端口组 MAC 地址
node_uuid	string	端口组所在的节点 UUID
standalone_ports_supported	boolean	端口组所在的交换机设备是否支持端口组回退功能
internal_info	JSON	内部信息， 只读
extra	object	端口组额外信息
mode	string	端口组聚合模式
properties	string	端口组属性， 用于配制 bond 设备
created_at	string	端口组创建时间
updated_at	string	端口组更新时间
links	array	端口组相关信息链接
ports	array	端口组内端口列表

请求示例

{
    "node_uuid": "6d85703a-565d-469a-96ce-30b6de53079d",
    "address": "11:11:11:11:11:11",
    "name": "test_portgroup"
}

正常响应示例

{
  "address": "11:11:11:11:11:11",
  "created_at": "2016-08-18T22:28:48.643434+11:11",
  "extra": {},
  "internal_info": {},
  "links": [
    {
      "href": "http://127.0.0.1:6385/v1/portgroups/e43c722c-248e-4c6e-8ce8-0d8ff129387a",
      "rel": "self"
    },
    {
      "href": "http://127.0.0.1:6385/portgroups/e43c722c-248e-4c6e-8ce8-0d8ff129387a",
      "rel": "bookmark"
    }
  ],
  "mode": "active-backup",
  "name": "test_portgroup",
  "node_uuid": "6d85703a-565d-469a-96ce-30b6de53079d",
  "ports": [
    {
      "href": "http://127.0.0.1:6385/v1/portgroups/e43c722c-248e-4c6e-8ce8-0d8ff129387a/ports",
      "rel": "self"
    },
    {
      "href": "http://127.0.0.1:6385/portgroups/e43c722c-248e-4c6e-8ce8-0d8ff129387a/ports",
      "rel": "bookmark"
    }
  ],
  "properties": {},
  "standalone_ports_supported": true,
  "updated_at": null,
  "uuid": "e43c722c-248e-4c6e-8ce8-0d8ff129387a"
}

正常响应代码

201

错误码

400,401,403,404

编辑裸金属端口组

功能介绍

编辑裸金属端口组

URI

PATCH /v1/portgroups/{portgroup_ident}

请求消息

参数	参数类型	是否必选	描述
portgroup_ident	string	是	端口组UUID

响应消息

参数	参数类型	描述
name	string	端口组名称
uuid	string	端口组 UUID
address	string	端口组 MAC 地址
node_uuid	string	端口组所在的节点 UUID
standalone_ports_supported	boolean	端口组所在的交换机设备是否支持端口组回退功能
internal_info	JSON	内部信息， 只读
extra	object	端口组额外信息
mode	string	端口组聚合模式
properties	string	端口组属性， 用于配制 bond 设备
created_at	string	端口组创建时间
updated_at	string	端口组更新时间
links	array	端口组相关信息链接
ports	array	端口组内端口列表

请求示例

[
   {
      "path" : "/address",
      "value" : "22:22:22:22:22:22",
      "op" : "replace"
   }
]

正常响应示例

{
  "address": "11:11:11:11:11:11",
  "created_at": "2016-08-18T22:28:48.643434+11:11",
  "extra": {},
  "internal_info": {},
  "links": [
    {
      "href": "http://127.0.0.1:6385/v1/portgroups/e43c722c-248e-4c6e-8ce8-0d8ff129387a",
      "rel": "self"
    },
    {
      "href": "http://127.0.0.1:6385/portgroups/e43c722c-248e-4c6e-8ce8-0d8ff129387a",
      "rel": "bookmark"
    }
  ],
  "mode": "active-backup",
  "name": "test_portgroup",
  "node_uuid": "6d85703a-565d-469a-96ce-30b6de53079d",
  "ports": [
    {
      "href": "http://127.0.0.1:6385/v1/portgroups/e43c722c-248e-4c6e-8ce8-0d8ff129387a/ports",
      "rel": "self"
    },
    {
      "href": "http://127.0.0.1:6385/portgroups/e43c722c-248e-4c6e-8ce8-0d8ff129387a/ports",
      "rel": "bookmark"
    }
  ],
  "properties": {},
  "standalone_ports_supported": true,
  "updated_at": null,
  "uuid": "e43c722c-248e-4c6e-8ce8-0d8ff129387a"
}

正常响应代码

200

错误码

400,401,403,404

删除裸金属端口组

功能介绍

删除裸金属端口组

URI

DELETE /v1/portgroups/{portgroup_ident}

请求消息

参数	参数类型	是否必选	描述
portgroup_ident	string	是	端口组UUID

响应消息

无

请求示例

无

正常响应示例

无

正常响应代码

204

错误码

400,401,403,404

端口组中端口列表

功能介绍

获取端口组中端口列表

URI

GET /v1/portgroups/{portgroup_ident}/ports

请求消息

参数	参数类型	是否必选	描述
portgroup_ident	string	是	端口组UUID
fields	array	否	返回结果的指定字段
limit	integer	否	分页数目限制
marker	string	否	每页最后一条数据的ID
sort_dir	string	否	排序方向（升序或降序）
sort_key	string	否	排序键值

响应消息

参数	参数类型	描述
ports	array	端口列表
uuid	string	端口UUID
address	string	端口MAC地址
links	array	相关链接列表

请求示例

无

正常响应示例

无

正常响应代码

200

错误码

400,401,403,404