订单 API - 参考

GET /v1/orders

列出项目的订单。

订单列表可以通过 URL 中传递的参数进行过滤。

参数

名称	类型	描述
offset	整数	您希望检索的订单总列表中的起始索引。（默认值为 0）
limit	整数	返回的最大记录数（最多 100 个）。（默认值为 10）

请求:

GET /v1/orders
Headers:
    Content-Type: application/json
    X-Auth-Token: {token}

响应:

200 Success

{
    "orders": [
    {
        "created": "2015-10-20T18:38:44",
        "creator_id": "40540f978fbd45c1af18910e3e02b63f",
        "meta": {
            "algorithm": "AES",
            "bit_length": 256,
            "expiration": null,
            "mode": "cbc",
            "name": "secretname",
            "payload_content_type": "application/octet-stream"
        },
        "order_ref": "https://:9311/v1/orders/2284ba6f-f964-4de7-b61e-c413df5d1e47",
        "secret_ref": "https://:9311/v1/secrets/15dcf8e4-3138-4360-be9f-fc4bc2e64a19",
        "status": "ACTIVE",
        "sub_status": "Unknown",
        "sub_status_message": "Unknown",
        "type": "key",
        "updated": "2015-10-20T18:38:44"
    },
    {
        "created": "2015-10-20T18:38:47",
        "creator_id": "40540f978fbd45c1af18910e3e02b63f",
        "meta": {
            "algorithm": "AES",
            "bit_length": 256,
            "expiration": null,
            "mode": "cbc",
            "name": "secretname",
            "payload_content_type": "application/octet-stream"
        },
        "order_ref": "https://:9311/v1/orders/87b7169e-3aa2-4cb1-8800-b5aadf6babd1",
        "secret_ref": "https://:9311/v1/secrets/80183f4b-c0de-4a94-91ad-6d55251acee2",
        "status": "ACTIVE",
        "sub_status": "Unknown",
        "sub_status_message": "Unknown",
        "type": "key",
        "updated": "2015-10-20T18:38:47"
    }
    ],
    "total": 2
}

响应属性

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

HTTP 状态码

代码	描述
200	成功请求
401	无效的 X-Auth-Token 或令牌没有访问此资源的权限

POST /v1/orders

创建订单

参数

属性名称	类型	描述	默认值
type	字符串	要生成的密钥类型。有效类型为 key 和 asymmetric	无
meta	dict	包含用于生成密钥的密钥元数据的字典。	无

请求:

POST /v1/orders
Headers:
    Content-Type: application/json
    X-Auth-Token: {token}

Content:
{
    "type":"key",
    "meta":
        {
            "name":"secretname",
            "algorithm": "AES",
            "bit_length": 256,
            "mode": "cbc",
            "payload_content_type":"application/octet-stream"
        }
}

响应:

202 Created

{
    "order_ref": "http://{barbican_host}/v1/orders/{order_uuid}"
}

响应属性

名称	类型	描述
order_ref	字符串	订单引用

HTTP 状态码

代码	描述
202	成功创建订单
400	错误请求
401	无效的 X-Auth-Token 或令牌没有访问此资源的权限
415	不支持的媒体类型

GET /v1/orders/{uuid}

检索订单的元数据

请求:

GET /v1/orders/{order_uuid}
Headers:
    Accept: application/json
    X-Auth-Token: {token}

参数

无

响应:

200 Success

{
    "created": "2015-10-20T18:49:02",
    "creator_id": "40540f978fbd45c1af18910e3e02b63f",
    "meta": {
        "algorithm": "AES",
        "bit_length": 256,
        "expiration": null,
        "mode": "cbc",
        "name": "secretname",
        "payload_content_type": "application/octet-stream"
    },
    "order_ref": "https://:9311/v1/orders/5443d349-fe0c-4bfd-bd9d-99c4a9770638",
    "secret_ref": "https://:9311/v1/secrets/16f8d4f3-d3dd-4160-a5bd-8e5095a42613",
    "status": "ACTIVE",
    "sub_status": "Unknown",
    "sub_status_message": "Unknown",
    "type": "key",
    "updated": "2015-10-20T18:49:02"
}

响应属性

名称	类型	描述
创建时间	字符串	订单创建时间的 ISO8601 格式的时间戳
creator_id	字符串	创建订单的 Keystone Id 用户
meta	dict	用于信息目的的密钥元数据
order_ref	字符串	与订单关联的订单 href
secret_ref	字符串	与订单关联的密钥 href
status	字符串	订单的当前状态
sub_status	字符串	与订单关联的元数据
sub_status_message	字符串	与订单关联的元数据
type	字符串	指示订单类型
updated	字符串	订单上次更新时间的 ISO8601 格式的时间戳。

HTTP 状态码

代码	描述
200	成功检索订单
400	错误请求
401	无效的 X-Auth-Token 或令牌没有访问此资源的权限
404	未找到

DELETE /v1/orders/{uuid}

删除订单

请求:

DELETE /v1/orders/{order_uuid}
Headers:
    X-Auth-Token: {token}

参数

无

响应:

204 Success

HTTP 状态码

代码	描述
204	成功删除订单
400	错误请求
401	无效的 X-Auth-Token 或令牌没有访问此资源的权限
404	未找到