Get image member schema

Overview

Gets a JSON schema document that represents an image member entity.

Classification

  • Show

API Operation Object

  • schemas

Synchronous / Asynchronous

  • -

Request

HTTP Request Method

  • GET

HTTP Request Path

{api_endpoint}/v2/schemas/member

HTTP Request Header

Format

Accept-Encoding: gzip, deflate, compress (optional)
Accept: application/json
X-Auth-Token: <token_id>
Content-Type: application/json

HTTP Request Body

Format

  • none

Request Parameter

Request Parameters
name style format description required/optional
none - - - -

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 Codes
response code condition
200 normal end
* Follow a Common Error Code

HTTP Response Body

Format

{
    "name": "<name>",
    "properties": {
        "created_at": {
            "description": "<description>",
            "type": "<type>"
        },
        "image_id": {
            "description": "<description>",
            "pattern": "<pattern>",
            "type": "<type>"
        },
        "member_id": {
            "description": "<description>",
            "type": "<type>"
        },
        "schema": {
            "type": "<type>"
        },
        "status": {
            "description": "<description>",
            "enum": [
                "<enum>",
                <<repeat>>
            ],
            "type": "<type>"
        },
        "updated_at": {
            "description": "<description>",
            "type": "<type>"
        }
    }
}

Response Parameter

Response Parameters
item format description
status String The image status.
created_at time/date The date and time when the resource was created.The date and time stamp format is ISO 8601:
updated_at time/date The date and time when the resource was updated.The date and time stamp format is ISO 8601:
image_id UUID Image ID stored through the image API. Typically a UUID.
member_id String Image member ID. For example, the tenant ID of the user with whom the image is being shared.
schema String The URL for schema of the member.
schema String The URL for schema of the members.

Sample API Request and Response

Sample API Request

Request URI

https://example.com/v2/schemas/member

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

{
    "name": "member",
    "properties": {
        "created_at": {
            "description": "Date and time of image member creation",
            "type": "string"
        },
        "image_id": {
            "description": "An identifier for the image",
            "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"
        },
        "member_id": {
            "description": "An identifier for the image member (tenantId)",
            "type": "string"
        },
        "schema": {
            "type": "string"
        },
        "status": {
            "description": "The status of this image member",
            "enum": [
                "pending",
                "accepted",
                "rejected"
            ],
            "type": "string"
        },
        "updated_at": {
            "description": "Date and time of last modification of image member",
            "type": "string"
        }
    }
}

Execution Example

HTTP Request

GET /v2/schemas/member HTTP/1.1
User-Agent: curl/7.35.0
Host: 192.168.56.250:9292
Accept: */*
X-Auth-Token: 2529f972b5744519bea7b26327d4925d

HTTP Response

HTTP/1.1 200 OK
Content-Type: application/json; charset=UTF-8
Content-Length: 660
X-Openstack-Request-Id: req-33540bc0-add8-4918-b41a-a3f205fb981a
Date: Thu, 15 Oct 2015 14:31:53 GMT

{"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": {"type": "string"}}}

Error Execution Example

HTTP Request

GET /v2/schema/member HTTP/1.1
User-Agent: curl/7.35.0
Host: 192.168.56.250:9292
Accept: */*
X-Auth-Token: 7d14e25e0f1e4eaebbc922c69757e573

HTTP Response

HTTP/1.1 404 Not Found
Content-Length: 154
Content-Type: text/html; charset=UTF-8
X-Openstack-Request-Id: req-f362cf01-ddc6-433a-8171-d414a418d2bd
Date: Thu, 15 Oct 2015 17:52:34 GMT

404 Not Found

The resource could not be found.
Get images schema
Get metadata definition namespace schema