Querying Image Sharing Members (Native OpenStack API)

Function

This API is used to query the tenants with whom an image is shared using search criteria and to display the tenants in a list.

Authorization

Each account has all of the permissions required to call all APIs, but IAM users must have the required permissions specifically assigned. For details about the required permissions, see Permissions and Supported Actions.

URI

GET /v2/images/{image_id}/members

Table 1 lists the parameters in the URI.

**Table 1** Parameter description
Parameter	Mandatory	Type	Description
image_id	Yes	String	Specifies the image ID.
limit	No	Integer	Definition Number of image sharing members on each page. Constraints Positive integer Range [1,1000] Default Value 500
marker	No	String	Definition Marker for querying the next page. Constraints The value must be Base64-encoded. Range N/A Default Value N/A

Request

Request parameters

None

Example Request

Querying image sharing members

GET https://{Endpoint}/v2/images/d164b5df-1bc3-4c3f-893e-3e471fd16e64/members

Response

Response parameters

Parameter	Type	Description
members	Array of objects	Specifies the members. For details, see Table 2.
schema	String	Specifies the sharing schema.
page_info	Object	Specifies pagination. For details, see Table 3.

Parameter

Type

Description

members

Array of objects

Specifies the members.

For details, see Table 2.

schema

String

Specifies the sharing schema.

page_info

Object

Specifies pagination.

For details, see Table 3.

**Table 2** Data structure description of the members field
Parameter	Type	Description
status	String	Specifies the image sharing status.
created_at	String	Specifies the time when a shared image was created. The value is in UTC format.
updated_at	String	Specifies the time when a shared image was updated. The value is in UTC format.
image_id	String	Specifies the image ID.
member_id	String	Specifies the member ID.
schema	String	Specifies the sharing schema.
member_type	string	Specifies the member type.
urn	string	Specifies the URN of the organization that the image is shared with. This field is returned only when member_type is set to organization.

**Table 3** Data structure description of the page_info field
Parameter	Type	Description
next_marker	String	Specifies a marker for querying the next page. The value is an image ID. If a value is returned for this field in the response, there is data on the next page.
current_count	Integer	Specifies the number of records on the current page.

Example response

STATUS CODE 200

      
           {
    "members": [
        {
            "status": "accepted",
            "created_at": "2016-09-01T02:05:14Z",
            "updated_at": "2016-09-01T02:37:11Z",
            "image_id": "d164b5df-1bc3-4c3f-893e-3e471fd16e64",
            "member_id": "edc89b490d7d4392898e19b2deb34797",
            "schema": "/v2/schemas/member"
        }
    ],
    "schema": "/v2/schemas/members"
}

Returned Values

Normal
200

Abnormal

Returned Value	Description
400 Bad Request	Request error.
401 Unauthorized	Authentication failed.
403 Forbidden	You do not have the rights to perform the operation.
404 Not Found	The requested resource was not found.
500 Internal Server Error	Internal service error.
503 Service Unavailable	The service is unavailable.