鍵情報コンテナの登録 (POST /v1/{tenant_id}/containers)

新しい鍵情報コンテナを登録する。

{tenant_id}: 鍵情報コンテナを登録するプロジェクトのID

Request Headers

X-Auth-Token

認証トークンIDを指定する。

Data Type Cardinality
String 1..1

Content-Type

Request Bodyの型を指定する。

使用可能な値:application/json

Data Type Cardinality
String 1..1

Request Parameter

なし

Request Body

name

鍵情報コンテナの名前

Data Type Cardinality
String 0..1

type

鍵情報コンテナの型

指定できる値:certificate, generic

注意:
SSL-VPN V2 Connection作成時に利用する鍵情報コンテナについて、 以下の固定値が指定されている必要があります。
  • type: "generic"が指定されている必要があります。
  • name: "ca", "server_certificate", "server_key", "dh" の4つが指定されている必要があります。

なお、上記が指定されていない場合、SSL-VPN V2 Connectionの作成に失敗します。

鍵情報コンテナ登録時にはエラーになりませんが、SSL-VPN V2 Connection作成操作後、SSL-VPN V2 ConnectionのstatusがERRORになります。

Data Type Cardinality
Enum(certificate, generic) 1..1

secret_refs

鍵情報コンテナに登録する鍵情報一覧のエンベロープ

(secret_ref_env)を含む

Data Type Cardinality
Element 0..1

(secret_ref_env)

鍵情報コンテナに登録する鍵情報のエンベロープ

nameとsecret_refを含む

Data Type Cardinality
Element 0..3

name

鍵情報コンテナに登録する鍵情報の名前

指定できる値:

  • typeがcertificateの場合

    certificate、intermediates、private_key

  • typeがgenericの場合

    制限なし

    ただし、

    • 使用可能文字:半角英数字、半角記号
    • 文字数:1~255
    • 省略した場合はnullが格納される
Data Type Cardinality
typeがcertificateの場合

Enum(certificate, intermediates, private_key)

typeがgenericの場合:

String

typeがcertificateの場合

1..1

typeがgenericの場合

0..1

secret_ref

鍵情報コンテナに登録する鍵情報の鍵情報リソースURI

Data Type Cardinality
String 1..1

Response Headers

ステータス

リクエストのステータスを返却する。

以下の値を返却する。

201:
正常終了
401:
認証エラー(認証トークン無し、認証トークン誤り等)
400:
不正なアクセス(パラメーター不正等)
403:
アクセス不可(権限がない)
404:
該当資源なし
415:
サポートされていないContent-Typeが指定されている
500:
予期せぬエラー
Data Type Cardinality
int 1..1

Response Elements

container_ref

登録した鍵情報コンテナに割り当てられた鍵情報コンテナリソースURI

Data Type Cardinality Parent Element Child Element(s)
String 1..1 None None

Example of Request


POST /v1/a759452216fd41cf8ee5aba321cfbd49/containers
X-Auth-Token: "JpZCI6ICJjM2VlNzA4YTZhZTI0ZGRmOTJjMDc4..."
Content-Type: "application/json"
Body:
{
  "name": "container1",
  "type": "certificate",
  "secret_refs": [
    {
       "name": "private_key",
"secret_ref":"http://<host>:9311/v1/a759452216fd41cf8ee5aba321cfbd49/secrets/087cf096-3947-4a54-8968-7b021cfe8196"
    },
    {
       "name": "certificate",
"secret_ref":"http://<host>:9311/v1/a759452216fd41cf8ee5aba321cfbd49/secrets/4bbcf05f-d15d-444c-ae9f-799746349a9f"
    },
    {
       "name": "intermediates",
"secret_ref":"http://<host>:9311/v1/a759452216fd41cf8ee5aba321cfbd49/secrets/8573540e-ad7c-467a-a196-43cf6b5c3468"
    }
  ]
}
     

Example of Response


Status Code: 201 Created
Content-Length: 123
Content-Type: application/json; charset=UTF-8
Location: http://<host>:9311/ a759452216fd41cf8ee5aba321cfbd49/containers/a5330b02-ee46-4883-b8ea-4359925ebbf2

{"container_ref": "http://<host>:9311/v1/ a759452216fd41cf8ee5aba321cfbd49/containers/a5330b02-ee46-4883-b8ea-4359925ebbf2"}