资源列表 API

https://blueprints.launchpad.net/vitrage/+spec/resource-list-api

一个用于列出指定类型或所有资源的 API。

问题描述

目前 Vitrage 拥有获取拓扑和告警的 API。但用户可能希望获取他关心的特定资源。

提议的变更

添加一个用于列出资源的 API。如果用户指定了资源类型,则列出具有给定类型的资源。

备选方案

数据模型影响

REST API 影响

资源列表

返回资源列表

GET /v1/resources/

头部

  • X-Auth-Token (字符串, 必需) - Keystone 认证令牌

  • Accept (字符串) - application/json

  • User-Agent (字符串)

路径参数

无。

查询参数

请求体

  • resource_type - (字符串, 可选) 资源的类型。默认为返回所有资源。

  • all_tenants - (布尔值, 可选) 显示所有租户的资源(如果用户具有权限)。

请求示例

GET /v1/resources/
Host: 127.0.0.1:8999
User-Agent: keystoneauth1/2.3.0 python-requests/2.9.1 CPython/2.7.6
Accept: application/json
X-Auth-Token: 2b8882ba2ec44295bf300aecb2caa4f7
响应

状态码

  • 200 - 确定

  • 400 - 请求错误

响应体

返回请求的所有资源列表。

响应示例

[
  {
    "category": "RESOURCE",
    "is_placeholder": false,
    "is_deleted": false,
    "name": "vm-1",
    "update_timestamp": "2015-12-01T12:46:41Z",
    "state": "ACTIVE",
    "project_id": "0683517e1e354d2ba25cba6937f44e79",
    "type": "nova.instance",
    "id": "dc35fa2f-4515-1653-ef6b-03b471bb395b",
    "vitrage_id": "RESOURCE:nova.instance:dc35fa2f-4515-1653-ef6b-03b471bb395b"
  }
]

安全影响

流水线影响

其他最终用户影响

性能/可扩展性影响

其他部署者影响

开发者影响

实现

负责人

dong wenjuan <dong.wenjuan@zte.com.cn>

工作项

  • 实现 API 和测试

  • 实现客户端和测试

未来生命周期

依赖项

测试

需要添加单元测试和 Tempest 测试。

文档影响

新的 api 应该被记录

参考资料