Querying Image Recipients

Function

This API is used to query image recipients.

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 /v1/{project_id}/cloudimages/{image_id}/members

Table 1 lists the parameters in the URI.

**Table 1** Parameter description
Parameter	Mandatory	Type	Description
project_id	Yes	String	Specifies the project ID.
image_id	Yes	String	Specifies the image ID.
limit	No	Integer	Definition Number of image recipients 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 recipients

https://{Endpoint}/v1/1bed856811654c1cb661a6ca845ebc77/cloudimages/d164b5df-1bc3-4c3f-893e-3e471fd16e64/members

Response

Response parameters

Parameter	Type	Description
members	Array of objects	Specifies image recipients. 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 image recipients.

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. The value can be: accepted: The shared image is accepted. After you accept an image, the image will be displayed in your image list. You can use the image to create cloud servers. rejected: The shared image is rejected. After you reject an image, the image will disappear from your image list, but you can still use the image to create cloud servers.
created_at	String	Specifies the time when an image was shared. 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 recipient ID.
schema	String	Specifies the sharing schema.
member_type	String	Specifies the recipient type. The value can be: project domain organization
urn	String	Specifies the organization URN. 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": "2023-08-23T04:07:52Z",
            "updated_at": "2023-08-23T04:07:52Z",
            "image_id": "370befec-a369-475e-a224-44a45927a8fe",
            "member_id": "ou-5x1bvygwrplokk622i9gbn3f5ftfb2l9",
            "schema": "/v2/schemas/member",
            "member_type": "organization",
            "urn": "organizations::3a2d95404f964a6aba78819bf8ddc1e3:ou:o-wvntq58r3poyv180t5df1mdna4uwy9se/ou-5x1bvygwrplokk622i9gbn3f5ftfb2l9"
        }
    ],
    "schema": "/v2/schemas/members"
}

Returned Values

Normal
200

Abnormal

Returned Value	Description
400 Bad Request	Request error.
401 Unauthorized	Authentication failed.
403 Forbidden	No operation permissions.
404 Not Found	Resource not found.
500 Internal Server Error	Internal service error.
503 Service Unavailable	Service unavailable.