Help Center/ Image Management Service/ API Reference/ Native OpenStack APIs/ Image Schema (Native OpenStack APIs)/ Querying a Schema for an Image Sharing Member List (Native OpenStack API)
Updated on 2024-06-25 GMT+08:00
View PDF
Share

Querying a Schema for an Image Sharing Member List (Native OpenStack API)

Function

This API is used to query an image sharing member list schema, which allows you to view image sharing member attributes and their data types.

URI

GET /v2/schemas/members

Request

Request parameters

None

Example Request

Querying a schema for an image sharing member list

GET https://{Endpoint}/v2/schemas/members

Response

  • Response parameters

    Parameter

    Type

    Description

    name

    String

    Specifies the schema name.

    links

    Array of objects

    Specifies the URL for accessing the schema.

    For details, see Table 1.

    properties

    Object

    Describes basic image attributes, including the type and usage of each attribute.

    For details about the parameters, see Image Attributes.
    Table 1 Data structure description of the links field

    Parameter

    Type

    Description

    href

    String

    Specifies the domain name.

    rel

    String

    Specifies the domain name description.
  • Example response 
    STATUS CODE 200
     1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
    		 
    {
    "name": "members",
    "links": [
        {
            "href": "{schema}",
            "rel": "describedby"
        }
    ],
    "properties": {
        "members": {
            "items": {
                "name": "member",
                "properties": {
                    "status": {
                        "enum": [
                            "pending",
                            "accepted",
                            "rejected"
                        ],
                        "type": "string",
                        "description": "The status of this image member"
                    },
                    "created_at": {
                        "type": "string",
                        "description": "Date and time of image member creation"
                    },
                    "updated_at": {
                        "type": "string",
                        "description": "Date and time of last modification of image member"
                    },
                    "image_id": {
                        "pattern": "^([0-9a-fA-F]){8}-([0-9a-fA-F]){4}-([0-9a-fA-F]){4}-([0-9a-fA-F]){4}-([0-9a-fA-F]){12}$",
                        "type": "string",
                        "description": "An identifier for the image"
                    },
                    "member_id": {
                        "type": "string",
                        "description": "An identifier for the image member (tenantId)"
                    },
                    "schema": {
                        "readOnly": true,
                        "type": "string"
                    }
                }
            },
            "type": "array"
        },
        "schema": {
            "type": "string"
        }
    }
}

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.