Create image member
POST /v2/images/{image_id}/members
Normal response codes: 200
前提条件
- 指定するイメージは作成されている必要があります。
- "visibility"属性が"private"であるイメージにのみ新規メンバーを追加できる。
- APIは指定するイメージの所有者が実行する必要があります。
実行後の状態
- 適切な権限があれば、APIの実行によってイメージの更新するメンバーのステータスを確認できます。
トラブルシューティング
- 適切な権限があったとしても、"visibility"属性がパブリックに設定されている場合は、HTTP 403のエラーコードがリクエストにより返却されます。前提条件を満たしていることを確認後、リクエストを再度実行してください。リクエストに再び失敗した場合は、APIリクエストの内容を見直してください。
- 指定したメンバーがすでにイメージのメンバーである場合は、HTTP 409 Conflictのエラーコードがサービスにより返却されます。作成しようとしていたメンバーと別のメンバーを指定していないか再度確認してください。
イメージを共有して使用する場合、以下の流れで作業を実施してください。
- 共有するイメージへメンバーを追加する。
イメージの提供者は、イメージの visibility 属性を "private" で作成した後、イメージを共有するメンバー(プロジェクトID/プロジェクトID)を追加します。
イメージにメンバーを追加するためには、「Create image member」を使用します。
- 共有されたイメージの利用を開始する。
イメージを共有されたメンバーは、イメージを利用するためメンバーステータスを "accepted" に変更します。
イメージのメンバーステータスを変更するためには、「Update image member」を使用します。
イメージのメンバーステータスを "accepted" に変更することで、「List images」で取得するイメージ一覧に共有したイメージが表示されます。
イメージの共有を停止する場合、以下の作業を実施してください。
- 共有されたイメージの利用を停止する。
イメージの提供者が、共有しているイメージから、利用を停止するメンバーを削除します。
イメージのメンバーを削除するためには、「Delete image member」を使用します。
イメージのメンバーを削除することで、メンバーが、共有していたイメージを参照および使用できなくなります。
注意:
イメージを共有されたメンバーが、イメージのメンバーステータスを "rejected" に変更しても、イメージの利用は可能であるため、必ずイメージの提供者に対して、メンバーの削除を依頼してください。
Request
下表は、イメージメンバー作成リクエストのURIパラメーターの一覧です。
Name | Type | Description |
---|---|---|
image_id | uuid | イメージID |
下表は、イメージメンバー作成リクエストのボディ部のパラメーターの一覧です。
Name | Type | Description |
---|---|---|
member | string | イメージメンバーID。イメージを共有するプロジェクトのID |
Example. Create image member: JSON request
{
"member": "8989447062e04a818baf9e073fd04fa7"
}
Response
{
"created_at": "2013-09-20T19:22:19Z",
"image_id": "a96be11e-8536-4910-92cb-de50aa19dfe6",
"member_id": "8989447062e04a818baf9e073fd04fa7",
"schema": "/v2/schemas/member",
"status": "pending",
"updated_at": "2013-09-20T19:25:31Z"
}