Secret consumers API - 参考

GET {secret_ref}/consumers

列出 secret 的 consumers。

可以通过 URL 传递的参数来过滤 consumers 列表。

参数

名称	类型	描述
offset	整数	从 consumers 总列表中开始的索引，您希望检索的索引。
limit	整数	返回的最大记录数（最多 100 个）。默认限制为 10。

请求:

GET {secret_ref}/consumers
Headers:
    X-Auth-Token: <token>

响应:

200 OK

{
    "total": 3,
    "consumers": [
        {
            "created": "2015-10-15T21:06:33.123872",
            "updated": "2015-10-15T21:06:33.123878",
            "status": "ACTIVE",
            "service": "image",
            "resource_type": "image",
            "resource_id": "123e4567-e89b-12d3-a456-426614174001"
        },
        {
            "created": "2015-10-15T21:17:08.092408",
            "updated": "2015-10-15T21:17:08.092416",
            "status": "ACTIVE",
            "service": "volume",
            "resource_type": "volume",
            "resource_id": "123e4567-e89b-12d3-a456-426614174002"
        },
        {
            "created": "2015-10-15T21:21:29.970365",
            "updated": "2015-10-15T21:21:29.970370",
            "status": "ACTIVE",
            "service": "load-balancer",
            "resource_type": "listener",
            "resource_id": "123e4567-e89b-12d3-a456-426614174003"
        }
    ]
}

请求:

GET {secret_ref}/consumers?limit=1&offset=1
Headers:
    X-Auth-Token: <token>

{
    "total": 3,
    "next": "https://:9311/v1/secrets/{secret_ref}/consumers?limit=1&offset=2",
    "consumers": [
        {
            "created": "2015-10-15T21:17:08.092408",
            "updated": "2015-10-15T21:17:08.092416",
            "status": "ACTIVE",
            "service": "volume",
            "resource_type": "volume",
            "resource_id": "123e4567-e89b-12d3-a456-426614174002"
        }
    ],
    "previous": "https://:9311/v1/secrets/{secret_ref}/consumers?limit=1&offset=0"
}

响应属性

名称	类型	描述
consumers	列表	包含填充了 consumer 元数据的字典列表。
total	整数	用户可用的 consumers 总数。
下一个	字符串	一个 HATEOAS URL，用于根据 offset 和 limit 参数检索下一组 consumers。只有当 consumers 总数大于 offset 和 limit 参数之和时，此属性才可用。
previous	字符串	一个 HATEOAS URL，用于根据 offset 和 limit 参数检索前一组 consumers。只有当请求 offset 大于 0 时，此属性才可用。

HTTP 状态码

代码	描述
200	成功。
401	无效的 X-Auth-Token 或 token 没有访问此资源的权限。
403	禁止。用户已通过身份验证，但未被授权列出 consumers。这可能基于用户的角色。

POST {secret_ref}/consumers

创建 consumer

属性

属性名称	类型	描述	默认值
服务	字符串	Consumer 的 OpenStack 服务类型。每个服务应优先使用其保留名称，如以下所示：https://service-types.openstack.org/service-types.json	无
resource_type	字符串	使用 secret 的资源类型名称 例如“images”或“lbaas/loadbalancers”	无
resource_id	字符串	使用此 secret 的资源的唯一标识符。	无

请求:

POST {secret_ref}/consumers
Headers:
    X-Auth-Token: <token>
    Content-Type: application/json

Content:
{
    "service": "image",
    "resource_type": "image",
    "resource_id": "123e4567-e89b-12d3-a456-426614174000"
}

响应:

200 OK

{
    "status": "ACTIVE",
    "updated": "2015-10-15T17:56:18.626724",
    "name": "secret name",
    "consumers": [
        {
            "service": "image",
            "resource_type": "image",
            "resource_id": "123e4567-e89b-12d3-a456-426614174000"
        }
    ],
    "created": "2015-10-15T17:55:44.380002",
    "secret_ref": "https://:9311/v1/secrets/74bbd3fd-9ba8-42ee-b87e-2eecf10e47b9",
    "creator_id": "b17c815d80f946ea8505c34347a2aeba",
    "secret_type": "opaque",
    "expiration": null,
    "algorithm": "aes",
    "bit_length": 256,
    "mode": "cbc"
}

HTTP 状态码

代码	描述
200	成功。
400	错误请求。
401	无效的 X-Auth-Token 或 token 没有访问此资源的权限。
403	禁止。用户已通过身份验证，但未被授权创建 consumer。这可能基于用户的角色或项目的配额。

DELETE {secret_ref}/consumers

删除 consumer。

属性

属性名称	类型	描述	默认值
服务	字符串	Consumer 的 OpenStack 服务类型，如以下所示：https://service-types.openstack.org/service-types.json	无
resource_type	字符串	使用 secret 的资源类型名称 例如“images”或“lbaas/loadbalancers”	无
resource_id	字符串	使用此 secret 的资源的唯一标识符。	无

请求：

DELETE {secret_ref}/consumers
Headers:
    X-Auth-Token: <token>
    Content-Type: application/json

Content:
{
    "service": "image",
    "resource_type": "image",
    "resource_id": "123e4567-e89b-12d3-a456-426614174000"
}

响应：

200 OK

{
    "status": "ACTIVE",
    "updated": "2015-10-15T17:56:18.626724",
    "name": "secret name",
    "consumers": [],
    "created": "2015-10-15T17:55:44.380002",
    "secret_ref": "https://:9311/v1/secrets/74bbd3fd-9ba8-42ee-b87e-2eecf10e47b9",
    "creator_id": "b17c815d80f946ea8505c34347a2aeba",
    "secret_type": "opaque",
    "expiration": null,
    "algorithm": "aes",
    "bit_length": 256,
    "mode": "cbc"
}

HTTP 状态码

代码	描述
200	成功。
400	错误请求。
401	无效的 X-Auth-Token 或 token 没有访问此资源的权限。
403	禁止。用户已通过身份验证，但未被授权删除 consumer。这可能基于用户的角色。
404	Consumer 未找到。