Updated on 2025-09-08 GMT+08:00

Querying Image Sharing Members

Function

This API is used to query the members that accepted a shared image.

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.

Request

Request parameters

None

Example Request

Querying image sharing members

https://{Endpoint}/v1/1bed856811654c1cb661a6ca845ebc77/cloudimages/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.

    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 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 member ID.

    schema

    String

    Specifies the sharing schema.

    member_type

    String

    Specifies the member type.

    urn

    String

    Specifies the organization URN.

    This field is returned only when member_type is set to organization.

  • Example response
    STATUS CODE 200
     1
     2
     3
     4
     5
     6
     7
     8
     9
    10
    11
    12
    13
    14
    15
    {
        "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.