容器消费者 API - 参考

GET {container_ref}/consumers

列出容器的消费者。

消费者列表可以通过 URL 中传递的参数进行过滤。

参数

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

请求:

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

响应:

200 OK

{
    "total": 3,
    "consumers": [
        {
            "status": "ACTIVE",
            "URL": "consumerurl",
            "updated": "2015-10-15T21:06:33.123878",
            "name": "consumername",
            "created": "2015-10-15T21:06:33.123872"
        },
        {
            "status": "ACTIVE",
            "URL": "consumerURL2",
            "updated": "2015-10-15T21:17:08.092416",
            "name": "consumername2",
            "created": "2015-10-15T21:17:08.092408"
        },
        {
            "status": "ACTIVE",
            "URL": "consumerURL3",
            "updated": "2015-10-15T21:21:29.970370",
            "name": "consumername3",
            "created": "2015-10-15T21:21:29.970365"
        }
    ]
}

请求:

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

{
    "total": 3,
    "next": "https://:9311/v1/containers/{container_ref}/consumers?limit=1&offset=2",
    "consumers": [
        {
            "status": "ACTIVE",
            "URL": "consumerURL2",
            "updated": "2015-10-15T21:17:08.092416",
            "name": "consumername2",
            "created": "2015-10-15T21:17:08.092408"
        }
    ],
    "previous": "https://:9311/v1/containers/{container_ref}/consumers?limit=1&offset=0"
}

响应属性

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

HTTP 状态码

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

POST {container_ref}/consumers

创建消费者

属性

属性名称	类型	描述	默认值
name	字符串	用户设置的消费者名称。	无
url	字符串	使用该容器的用户或服务的 URL。	无

请求:

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

Content:
{
    "name": "ConsumerName",
    "url": "ConsumerURL"
}

响应:

200 OK

{
    "status": "ACTIVE",
    "updated": "2015-10-15T17:56:18.626724",
    "name": "container name",
    "consumers": [
        {
            "URL": "consumerURL",
            "name": "consumername"
        }
    ],
    "created": "2015-10-15T17:55:44.380002",
    "container_ref": "https://:9311/v1/containers/74bbd3fd-9ba8-42ee-b87e-2eecf10e47b9",
    "creator_id": "b17c815d80f946ea8505c34347a2aeba",
    "secret_refs": [
        {
            "secret_ref": "https://:9311/v1/secrets/b61613fc-be53-4696-ac01-c3a789e87973",
            "name": "private_key"
        }
    ],
    "type": "generic"
}

HTTP 状态码

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

DELETE {container_ref}/consumers

删除消费者。

属性

属性名称	类型	描述	默认值
name	字符串	用户设置的消费者名称。	无
URL	字符串	使用该容器的用户或服务的 URL。	无

请求:

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

Content:
{
    "name": "ConsumerName",
    "URL": "ConsumerURL"
}

响应:

200 OK

{
    "status": "ACTIVE",
    "updated": "2015-10-15T17:56:18.626724",
    "name": "container name",
    "consumers": [],
    "created": "2015-10-15T17:55:44.380002",
    "container_ref": "https://:9311/v1/containers/74bbd3fd-9ba8-42ee-b87e-2eecf10e47b9",
    "creator_id": "b17c815d80f946ea8505c34347a2aeba",
    "secret_refs": [
        {
            "secret_ref": "https://:9311/v1/secrets/b61613fc-be53-4696-ac01-c3a789e87973",
            "name": "private_key"
        }
    ],
"type": "generic"
}

HTTP 状态码

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