Retrieve key metadata container (GET /v1/{tenant_id}/containers/{resource_id})
Retrieves the specified key metadata container.
{tenant_id}: Project ID used to retrieve a key metadata container
{resource_id}: Resource ID of the key metadata container to be retrieved
Request headers
X-Auth-Token
Specify the authentication token.
| Data type | Cardinality |
|---|---|
| String | 1..1 |
Request parameters
None
Request body
None
Response headers
Status
The following error codes can be returned for the request.
One of the following values will be returned.
- 200:
- Normal completion
- 401:
- Authentication error (no authentication token, incorrect authentication token, etc.)
- 400:
- Invalid access (invalid parameter, etc.)
- 403:
- Cannot access (no privileges)
- 404:
- No applicable resources
- 500:
- Unexpected error
| Data type | Cardinality |
|---|---|
| int | 1..1 |
Response elements
status
Status of key metadata container
| Data type | Cardinality | Parent element | Child element |
|---|---|---|---|
| Enum(ACTIVE,ERROR) | 1..1 | None | None |
updated
Timestamp (UTC) of last update
| Data type | Cardinality | Parent element | Child element |
|---|---|---|---|
| datetime | 1..1 | None | None |
name
Name of key metadata container
| Data type | Cardinality | Parent element | Child element |
|---|---|---|---|
| String | 1..1 | None | None |
created
Timestamp (UTC) of creation
| Data type | Cardinality | Parent element | Child element |
|---|---|---|---|
| datetime | 1..1 | None | None |
container_ref
Key metadata container resource URI
| Data type | Cardinality | Parent element | Child element |
|---|---|---|---|
| String | 1..1 | None | None |
secret_refs
Envelope of key metadata list registered in the key information container
| Data type | Cardinality | Parent element | Child element |
|---|---|---|---|
| Element | 1..1 | None | (secret_ref_env) |
(secret_ref_env)
Envelope of key metadata registered in the key information container
| Data type | Cardinality | Parent element | Child element |
|---|---|---|---|
| Element | 0..3 | secret_refs | name secret_ref |
name
The name of the key information for the key information container in which the key is registered
| Data type | Cardinality | Parent element | Child element |
|---|---|---|---|
| String | 1..1 | (secret_ref_env) | None |
secret_ref
URI of the key metadata registered in the key information container
| Data type | Cardinality | Parent element | Child element |
|---|---|---|---|
| String | 1..1 | (secret_ref_env) | None |
Example of request
GET /v1/a759452216fd41cf8ee5aba321cfbd49/containers/81d1dc32-019e-4caf-b04e-49471f4f3aaf
X-Auth-Token: "JpZCI6ICJjM2VlNzA4YTZhZTI0ZGRmOTJjMDc4 . . ."
Example of response
Status Code: 200 OK
Content-Length: 647
Content-Type: application/json; charset=UTF-8
{
"status": "ACTIVE",
"updated": "2014-08-01T08:04:25.038787",
"name": "container1",
"secret_refs": [
{
"secret_ref": "http://<host>:9311/v1/a759452216fd41cf8ee5aba321cfbd49/secrets/087cf096-3947-4a54-8968-7b021cfe8196",
"name": "private_key"
},
{
"secret_ref": "http://<host>:9311/v1/a759452216fd41cf8ee5aba321cfbd49/secrets/4bbcf05f-d15d-444c-ae9f-799746349a9f",
"name": "certificate"
},
{
"secret_ref": "http://<host>:9311/v1/a759452216fd41cf8ee5aba321cfbd49/secrets/8573540e-ad7c-467a-a196-43cf6b5c3468",
"name": "intermediates"
}
],
"created": "2014-08-01T08:04:25.038781",
"container_ref": "http://<host>:9311/v1/a759452216fd41cf8ee5aba321cfbd49/containers/81d1dc32-019e-4caf-b04e-49471f4f3aaf",
"type": "certificate"
}