Jump to

• Request
• Response

ListImageShapeCompatibilityEntries

get

/20160918/images/{image_id}/shapes

List the compatible shapes for the specified image.

Request

Supported Media Types

• application/json

Path Parameters

• imageId(required): string
  The OCID of the image.

Query Parameters

• limit: integer
  Minimum Value: 1

  Maximum Value: 1000

  For list pagination. The maximum number of results per page, or items to return in a paginated List call. 1 is the minimum, 1000 is the maximum.

  Default Value: 100
• page: string
  Minimum Length: 1

  Maximum Length: 512

  For list pagination. The value of the opc-next-page response header from the previous List call.

  Default Value: oracle.doceng.json.BetterJsonNull@2c07545f

Header Parameters

• opc-request-id: string
  Unique Oracle-assigned identifier for the request. Provide this request OCID if you need to contact Oracle about this request.

Back to Top

Response

Supported Media Types

• application/json

200 Response

The list of compatible images and shapes.

Headers

• opc-next-page: string
  For list pagination. When this header appears in the response, additional pages of results remain. Use this value as the page parameter to get the next page of items.
• opc-request-id: string
  Unique Oracle-assigned identifier for the request. Provide this request OCID if you need to contact Oracle about this request.

Body ()

Root Schema : schema

Type: array

Show Source

• Array of: object ImageShapeCompatibilitySummary
  Summary information for a compatible image and shape.

{
    "items":{
        "$ref":"#/definitions/ImageShapeCompatibilitySummary"
    },
    "type":"array"
}

Nested Schema : ImageShapeCompatibilitySummary

Type: object

Summary information for a compatible image and shape.

Show Source

• imageId(required): string
  Minimum Length: 1

  Maximum Length: 255

  The image OCID.
• memoryConstraints: object ImageMemoryConstraints
  For a flexible image and shape, the amount of memory supported for instances that use this image.
• ocpuConstraints: object ImageOcpuConstraints
  OCPU options for an image and shape.
• shape(required): string
  Minimum Length: 1

  Maximum Length: 255

  The shape name.

{
    "description":"Summary information for a compatible image and shape.",
    "properties":{
        "imageId":{
            "description":"The image OCID.",
            "maxLength":"255",
            "minLength":"1",
            "type":"string"
        },
        "shape":{
            "description":"The shape name.",
            "maxLength":"255",
            "minLength":"1",
            "type":"string"
        },
        "memoryConstraints":{
            "$ref":"#/definitions/ImageMemoryConstraints"
        },
        "ocpuConstraints":{
            "$ref":"#/definitions/ImageOcpuConstraints"
        }
    },
    "required":[
        "imageId",
        "shape"
    ],
    "x-example":"{   \"imageId\": \"ocid1.image.<var>unique_ID</var>\",   \"shape\": \"VM.Standard.E3.Flex\",   \"memoryConstraints\": {     \"minInGBs\":1,     \"maxInGBs\":1024   },   \"ocpuConstraints\": {     \"min\":1,     \"max\":64   } } ",
    "type":"object"
}

Nested Schema : ImageMemoryConstraints

Type: object

For a flexible image and shape, the amount of memory supported for instances that use this image.

Show Source

• maxInGBs: integer
  Minimum Value: 0

  The maximum amount of memory, in gigabytes.
• minInGBs: integer
  Minimum Value: 0

  The minimum amount of memory, in gigabytes.

{
    "description":"For a flexible image and shape, the amount of memory supported for instances that use this image.",
    "properties":{
        "minInGBs":{
            "description":"The minimum amount of memory, in gigabytes.",
            "type":"integer",
            "minimum":"0"
        },
        "maxInGBs":{
            "description":"The maximum amount of memory, in gigabytes.",
            "type":"integer",
            "minimum":"0"
        }
    },
    "type":"object"
}

Nested Schema : ImageOcpuConstraints

Type: object

OCPU options for an image and shape.

Show Source

• max: integer
  Minimum Value: 0

  The maximum number of OCPUs supported for this image and shape.
• min: integer
  Minimum Value: 0

  The minimum number of OCPUs supported for this image and shape.

{
    "description":"OCPU options for an image and shape.",
    "properties":{
        "min":{
            "description":"The minimum number of OCPUs supported for this image and shape.",
            "type":"integer",
            "minimum":"0"
        },
        "max":{
            "description":"The maximum number of OCPUs supported for this image and shape.",
            "type":"integer",
            "minimum":"0"
        }
    },
    "type":"object"
}

400 Response

Bad Request

Headers

• opc-request-id: string
  Unique Oracle-assigned identifier for the request. Provide this request OCID if you need to contact Oracle about this request.

Body ()

Root Schema : Error

Type: object

The properties that define an error.

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing..

  Example: UnknownError
• message(required): string
  A human-readable error string.

  Example: error validating payload

{
    "type":"object",
    "description":"The properties that define an error.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "example":"UnknownError",
            "description":"A short error code that defines the error, meant for programmatic parsing.."
        },
        "message":{
            "type":"string",
            "example":"error validating payload",
            "description":"A human-readable error string."
        }
    }
}

401 Response

Unauthorized

Headers

• opc-request-id: string
  Unique Oracle-assigned identifier for the request. Provide this request OCID if you need to contact Oracle about this request.

Body ()

Root Schema : Error

Type: object

The properties that define an error.

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing..

  Example: UnknownError
• message(required): string
  A human-readable error string.

  Example: error validating payload

{
    "type":"object",
    "description":"The properties that define an error.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "example":"UnknownError",
            "description":"A short error code that defines the error, meant for programmatic parsing.."
        },
        "message":{
            "type":"string",
            "example":"error validating payload",
            "description":"A human-readable error string."
        }
    }
}

404 Response

Not Found

Headers

• opc-request-id: string
  Unique Oracle-assigned identifier for the request. Provide this request OCID if you need to contact Oracle about this request.

Body ()

Root Schema : Error

Type: object

The properties that define an error.

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing..

  Example: UnknownError
• message(required): string
  A human-readable error string.

  Example: error validating payload

{
    "type":"object",
    "description":"The properties that define an error.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "example":"UnknownError",
            "description":"A short error code that defines the error, meant for programmatic parsing.."
        },
        "message":{
            "type":"string",
            "example":"error validating payload",
            "description":"A human-readable error string."
        }
    }
}

500 Response

Internal Server Error

Headers

• opc-request-id: string
  Unique Oracle-assigned identifier for the request. Provide this request OCID if you need to contact Oracle about this request.

Body ()

Root Schema : Error

Type: object

The properties that define an error.

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing..

  Example: UnknownError
• message(required): string
  A human-readable error string.

  Example: error validating payload

{
    "type":"object",
    "description":"The properties that define an error.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "example":"UnknownError",
            "description":"A short error code that defines the error, meant for programmatic parsing.."
        },
        "message":{
            "type":"string",
            "example":"error validating payload",
            "description":"A human-readable error string."
        }
    }
}

Default Response

An error has occurred.

Headers

• opc-request-id: string
  Unique Oracle-assigned identifier for the request. Provide this request OCID if you need to contact Oracle about this request.

Body ()

Root Schema : Error

Type: object

The properties that define an error.

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing..

  Example: UnknownError
• message(required): string
  A human-readable error string.

  Example: error validating payload

{
    "type":"object",
    "description":"The properties that define an error.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "example":"UnknownError",
            "description":"A short error code that defines the error, meant for programmatic parsing.."
        },
        "message":{
            "type":"string",
            "example":"error validating payload",
            "description":"A human-readable error string."
        }
    }
}

Back to Top