List image members¶
Overview¶
Lists the projects with whom this image has been shared.
Classification¶
List
API Operation Object¶
members
Synchronous / Asynchronous¶
synchronous
Request¶
HTTP Request Method¶
GET
HTTP Request Path¶
{api_endpoint}/v2/images/{image_id}/members
HTTP Request Header¶
HTTP Request Body¶
Format¶
none
Request Parameter¶
name |
style |
format |
description |
required/optional |
default value |
action for invalid parameter |
response code for invalid parameter |
---|---|---|---|---|---|---|---|
image_id |
URL |
UUID |
An identifier for the image |
required |
- |
Terminate |
404 |
token_id |
Header |
authentication token string |
keystone authentication token |
required |
- |
Terminate |
401 |
Response¶
HTTP Response Header¶
Format¶
HTTP/1.1 <response_code> <message> (ex. 200 OK)
<response_code>: see "HTTP Responses" section
<message>: message based on the response code
skip auto insert field such as "X-Compute-Request-Id" and "Content-Length", "Date"
Response Code¶
response code |
condition |
---|---|
200 |
normal end |
401 |
unauthorized |
403 |
specify public image |
- |
if authority of non admin, requested by user whose project is not the member of specified image and the image has no owner |
404 |
specify non-existent image_id |
- |
specify the image_id of deleted image |
- |
if authority of non admin, requested by user whose project is not the member and not the owner of specified private image (assuming that the image has owner) |
500 |
Internal Error |
HTTP Response Body¶
Format¶
{
"members": [
{
"status": "<member_status>",
"created_at": "<created_time>",
"updated_at": "<updated_time>",
"image_id": "<image_id>",
"member_id": "<member_id>",
"schema": "<member_schema>"
},
<<repeat>>
],
"schema": "<members_schema>"
}
Response Parameter¶
item |
format |
description |
---|---|---|
member_status |
String (pending, accepted, rejected) |
The status of this image member |
created_time |
time/date |
Date and time of image member creation |
updated_time |
time/date |
Date and time of last modification of image member |
image_id |
UUID |
An identifier for the image |
member_id |
String (1-255 characters) |
An identifier for the image member (projectID) |
member_schema |
URL String |
URL for schema of the member |
members_schema |
URL String |
URL for schema of the members |
Sample API Request and Response¶
Sample API Request¶
Request URI¶
https://example.com/v2/images/{image_id}/members
Request Header¶
Accept-Encoding: gzip, deflate, compress (optional)
Accept: application/json
X-Auth-Token: ajk3adjiown02
Content-Type: application/json
Request Body¶
none
Sample API Response¶
Response Header¶
HTTP/1.1 200 OK
<response_code>: see "HTTP Responses" section
<message>: message based on the response code
skip auto insert field such as "X-Compute-Request-Id" and "Content-Length", "Date"
Response Body¶
{
"members": [
{
"status": "<member_status>",
"created_at": "<created_time>",
"updated_at": "<updated_time>",
"image_id": "<image_id>",
"member_id": "<member_id>",
"schema": "<member_schema>"
},
<<repeat>>
],
"schema": "<members_schema>"
}
Execution Example¶
HTTP Request¶
GET /v2/images/54d63e39-4ee1-4a62-8704-0ae5025a0deb/members HTTP/1.1
User-Agent: curl/7.35.0
Host: 192.168.11.141:9292
Accept: */*
X-Auth-Token: f682d12e8b6e46c5a6e3847b09c424a7
HTTP Response¶
HTTP/1.1 200 OK
Content-Length: 510
Content-Type: application/json; charset=UTF-8
X-Openstack-Request-Id: req-4592c51b-7111-462b-b095-a66732c8010f
Date: Wed, 06 Aug 2014 07:18:51 GMT
{"members": [{"status": "pending", "created_at": "2014-08-06T07:17:40Z", "updated_at": "2014-08-06T07:17:40Z", "image_id": "54d63e39-4ee1-4a62-8704-0ae5025a0deb", "member_id": "1efb79fe4437490aab966b57da5b9f05", "schema": "/v2/schemas/member"}, {"status": "pending", "created_at": "2014-08-06T07:18:46Z", "updated_at": "2014-08-06T07:18:46Z", "image_id": "54d63e39-4ee1-4a62-8704-0ae5025a0deb", "member_id": "f6a818c3d4aa458798ed86892e7150c0", "schema": "/v2/schemas/member"}], "schema": "/v2/schemas/members"}
Error Execution Example¶
HTTP Request¶
GET /v2/images/6e0031ac-0136-4569-9068-e43d93572574/members HTTP/1.1
User-Agent: curl/7.35.0
Host: 192.168.56.250:9292
Accept: */*
X-Auth-Token: 61c21ac4c2434175a26b085f1392
HTTP Response¶
HTTP/1.1 404 Not Found
Content-Length: 181
Content-Type: text/html; charset=UTF-8
X-Openstack-Request-Id: req-efb56a4f-2a6c-4b14-b34f-3f1a58790a83
Date: Thu, 15 Oct 2015 15:40:46 GMT
404 Not Found
No image found with ID 6e0031ac-0136-4569-9068-e43d93572574