Jump to

• Request
• Response

Lists the shapes that can be used to create container instances.

get

/20210415/containerInstanceShapes

Request

Supported Media Types

• application/json

Query Parameters

• availabilityDomain: string
  The availability domain of the pod shape.
• compartmentId(required): string
  Minimum Length: 1

  Maximum Length: 255

  The OCID of the compartment.
• faultDomain: string
  The name of the fault domain. Should be one of `FAULT-DOMAIN-1`, `FAULT-DOMAIN-2` or `FAULT-DOMAIN-3`
• 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: 0

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

A page of ContainerInstanceShapeSummary objects.

Headers

• opc-next-page: string
  Pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items.
• opc-request-id: string
  Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Body ()

Root Schema : ContainerInstanceShapeCollection

Type: object

A collection of container instance shapes.

Show Source

• items(required): array items
  A list of shapes.

{
    "type":"object",
    "description":"A collection of container instance shapes.",
    "required":[
        "items"
    ],
    "properties":{
        "items":{
            "description":"A list of shapes.",
            "type":"array",
            "items":{
                "$ref":"#/definitions/ContainerInstanceShapeSummary"
            }
        }
    }
}

Nested Schema : items

Type: array

A list of shapes.

Show Source

• Array of: object ContainerInstanceShapeSummary
  Details about a shape for a container instance.

{
    "description":"A list of shapes.",
    "type":"array",
    "items":{
        "$ref":"#/definitions/ContainerInstanceShapeSummary"
    }
}

Nested Schema : ContainerInstanceShapeSummary

Type: object

Details about a shape for a container instance.

Show Source

• availabilityDetails: array availabilityDetails
  Minimum Number of Items: 0

  Maximum Number of Items: 20

  List of ADs / FDs in which the given shape is available.
• memoryOptions: object ShapeMemoryOptions
  For a flexible shape, the amount of memory available for instances that use this shape. If this field is null, then this shape has a fixed amount of memory equivalent to memoryInGBs.
• name(required): string
  The name identifying the shape.
• networkingBandwidthOptions: object ShapeNetworkingBandwidthOptions
  For a flexible shape, the amount of networking bandwidth available for instances that use this shape. If this field is null, then this shape has a fixed amount of bandwidth equivalent to networkingBandwidthInGbps.
• ocpuOptions: object ShapeOcpuOptions
  For a flexible shape, the number of OCPUs available for instances that use this shape. If this field is null, then this shape has a fixed number of OCPUs equal to ocpus.
• processorDescription(required): string
  Minimum Length: 1

  Maximum Length: 255

  A short description of the container instance's processor (CPU).

{
    "description":"Details about a shape for a container instance. ",
    "x-obmcs-splat":{
        "resourceKind":"container-instances",
        "adLocality":"regional"
    },
    "required":[
        "name",
        "processorDescription"
    ],
    "properties":{
        "name":{
            "description":"The name identifying the shape. ",
            "type":"string"
        },
        "processorDescription":{
            "description":"A short description of the container instance's processor (CPU). ",
            "maxLength":255,
            "minLength":1,
            "type":"string"
        },
        "availabilityDetails":{
            "description":"List of ADs / FDs in which the given shape is available.",
            "type":"array",
            "minItems":0,
            "maxItems":20,
            "items":{
                "$ref":"#/definitions/FaultDomainDetails"
            }
        },
        "ocpuOptions":{
            "$ref":"#/definitions/ShapeOcpuOptions"
        },
        "memoryOptions":{
            "$ref":"#/definitions/ShapeMemoryOptions"
        },
        "networkingBandwidthOptions":{
            "$ref":"#/definitions/ShapeNetworkingBandwidthOptions"
        }
    },
    "type":"object"
}

Nested Schema : availabilityDetails

Type: array

Minimum Number of Items: 0

Maximum Number of Items: 20

List of ADs / FDs in which the given shape is available.

Show Source

• Array of: object FaultDomainDetails
  Object with details of AD and FD information in which given shape is available.

{
    "description":"List of ADs / FDs in which the given shape is available.",
    "type":"array",
    "minItems":0,
    "maxItems":20,
    "items":{
        "$ref":"#/definitions/FaultDomainDetails"
    }
}

Nested Schema : ShapeMemoryOptions

Type: object

For a flexible shape, the amount of memory available for instances that use this shape. If this field is null, then this shape has a fixed amount of memory equivalent to memoryInGBs.

Show Source

• defaultPerOcpuInGBs: number(float)
  Minimum Value: 0

  The default amount of memory per OCPU available for this shape, in gigabytes.
• maxInGBs: number(float)
  Minimum Value: 0

  The maximum amount of memory, in gigabytes.
• maxPerNumaNodeInGBs: number(float)
  Minimum Value: 0

  The maximum amount of memory per NUMA node, in gigabytes.
• maxPerOcpuInGBs: number(float)
  Minimum Value: 0

  Minimum Value: > true

  The maximum amount of memory per OCPU available for this shape, in gigabytes.
• minInGBs: number(float)
  Minimum Value: 0

  The minimum amount of memory, in gigabytes.
• minPerOcpuInGBs: number(float)
  Minimum Value: 0

  Minimum Value: > true

  The minimum amount of memory per OCPU available for this shape, in gigabytes.

{
    "description":"For a flexible shape, the amount of memory available for instances that use this shape. If this field is null, then this shape has a fixed amount of memory equivalent to memoryInGBs. ",
    "properties":{
        "minInGBs":{
            "description":"The minimum amount of memory, in gigabytes. ",
            "format":"float",
            "minimum":0,
            "type":"number"
        },
        "maxInGBs":{
            "description":"The maximum amount of memory, in gigabytes. ",
            "format":"float",
            "minimum":0,
            "type":"number"
        },
        "defaultPerOcpuInGBs":{
            "description":"The default amount of memory per OCPU available for this shape, in gigabytes. ",
            "format":"float",
            "minimum":0,
            "type":"number"
        },
        "minPerOcpuInGBs":{
            "description":"The minimum amount of memory per OCPU available for this shape, in gigabytes. ",
            "format":"float",
            "minimum":0,
            "exclusiveMinimum":true,
            "type":"number"
        },
        "maxPerOcpuInGBs":{
            "description":"The maximum amount of memory per OCPU available for this shape, in gigabytes. ",
            "format":"float",
            "minimum":0,
            "exclusiveMinimum":true,
            "type":"number"
        },
        "maxPerNumaNodeInGBs":{
            "description":"The maximum amount of memory per NUMA node, in gigabytes. ",
            "format":"float",
            "minimum":0,
            "type":"number"
        }
    },
    "type":"object"
}

Nested Schema : ShapeNetworkingBandwidthOptions

Type: object

For a flexible shape, the amount of networking bandwidth available for instances that use this shape. If this field is null, then this shape has a fixed amount of bandwidth equivalent to networkingBandwidthInGbps.

Show Source

• defaultPerOcpuInGbps: number(float)
  Minimum Value: 0

  The default amount of networking bandwidth per OCPU, in gigabits per second.
• maxInGbps: number(float)
  Minimum Value: 0

  The maximum amount of networking bandwidth, in gigabits per second.
• minInGbps: number(float)
  Minimum Value: 0

  The minimum amount of networking bandwidth, in gigabits per second.

{
    "description":"For a flexible shape, the amount of networking bandwidth available for instances that use this shape. If this field is null, then this shape has a fixed amount of bandwidth equivalent to networkingBandwidthInGbps. ",
    "properties":{
        "minInGbps":{
            "description":"The minimum amount of networking bandwidth, in gigabits per second. ",
            "format":"float",
            "minimum":0,
            "type":"number"
        },
        "maxInGbps":{
            "description":"The maximum amount of networking bandwidth, in gigabits per second. ",
            "format":"float",
            "minimum":0,
            "type":"number"
        },
        "defaultPerOcpuInGbps":{
            "description":"The default amount of networking bandwidth per OCPU, in gigabits per second. ",
            "format":"float",
            "minimum":0,
            "type":"number"
        }
    },
    "type":"object"
}

Nested Schema : ShapeOcpuOptions

Type: object

For a flexible shape, the number of OCPUs available for instances that use this shape. If this field is null, then this shape has a fixed number of OCPUs equal to ocpus.

Show Source

• max: number(float)
  Minimum Value: 0

  The maximum number of OCPUs.
• maxPerNumaNode: number(float)
  Minimum Value: 0

  The maximum number of cores available per NUMA node.
• min: number(float)
  Minimum Value: 0

  The minimum number of OCPUs.

{
    "description":"For a flexible shape, the number of OCPUs available for instances that use this shape. If this field is null, then this shape has a fixed number of OCPUs equal to ocpus. ",
    "properties":{
        "min":{
            "description":"The minimum number of OCPUs. ",
            "format":"float",
            "minimum":0,
            "type":"number"
        },
        "max":{
            "description":"The maximum number of OCPUs. ",
            "format":"float",
            "minimum":0,
            "type":"number"
        },
        "maxPerNumaNode":{
            "description":"The maximum number of cores available per NUMA node. ",
            "format":"float",
            "minimum":0,
            "type":"number"
        }
    },
    "type":"object"
}

Nested Schema : FaultDomainDetails

Type: object

Object with details of AD and FD information in which given shape is available.

Show Source

• availabilityDomain(required): string
  Minimum Length: 1

  Maximum Length: 255

  Availability domain in which shape is available. Example: `Uocm:PHX-AD-1`
• faultDomain(required): string
  Minimum Length: 1

  Maximum Length: 255

  Fault domain in which shape is available. Will be one of `FAULT-DOMAIN-1`, `FAULT-DOMAIN-2` or `FAULT-DOMAIN-3`

{
    "description":"Object with details of AD and FD information in which given shape is available. ",
    "required":[
        "availabilityDomain",
        "faultDomain"
    ],
    "properties":{
        "availabilityDomain":{
            "description":"Availability domain in which shape is available. Example: `Uocm:PHX-AD-1` ",
            "maxLength":255,
            "minLength":1,
            "type":"string"
        },
        "faultDomain":{
            "description":"Fault domain in which shape is available. Will be one of `FAULT-DOMAIN-1`, `FAULT-DOMAIN-2` or `FAULT-DOMAIN-3` ",
            "maxLength":255,
            "minLength":1,
            "type":"string"
        }
    },
    "type":"object"
}

400 Response

Bad Request

Headers

• opc-request-id: string
  Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

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. See [API Errors](https://docs.us-phoenix-1.oraclecloud.com/Content/API/References/apierrors.htm).
• message(required): string
  A human-readable error string.

{
    "description":"The properties that define an error.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"A short error code that defines the error, meant for programmatic parsing. See [API Errors](https://docs.us-phoenix-1.oraclecloud.com/Content/API/References/apierrors.htm)."
        },
        "message":{
            "type":"string",
            "description":"A human-readable error string."
        }
    },
    "type":"object"
}

401 Response

Unauthorized

Headers

• opc-request-id: string
  Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

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. See [API Errors](https://docs.us-phoenix-1.oraclecloud.com/Content/API/References/apierrors.htm).
• message(required): string
  A human-readable error string.

{
    "description":"The properties that define an error.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"A short error code that defines the error, meant for programmatic parsing. See [API Errors](https://docs.us-phoenix-1.oraclecloud.com/Content/API/References/apierrors.htm)."
        },
        "message":{
            "type":"string",
            "description":"A human-readable error string."
        }
    },
    "type":"object"
}

404 Response

Not Found

Headers

• opc-request-id: string
  Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

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. See [API Errors](https://docs.us-phoenix-1.oraclecloud.com/Content/API/References/apierrors.htm).
• message(required): string
  A human-readable error string.

{
    "description":"The properties that define an error.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"A short error code that defines the error, meant for programmatic parsing. See [API Errors](https://docs.us-phoenix-1.oraclecloud.com/Content/API/References/apierrors.htm)."
        },
        "message":{
            "type":"string",
            "description":"A human-readable error string."
        }
    },
    "type":"object"
}

429 Response

Too Many Requests

Headers

• opc-request-id: string
  Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

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. See [API Errors](https://docs.us-phoenix-1.oraclecloud.com/Content/API/References/apierrors.htm).
• message(required): string
  A human-readable error string.

{
    "description":"The properties that define an error.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"A short error code that defines the error, meant for programmatic parsing. See [API Errors](https://docs.us-phoenix-1.oraclecloud.com/Content/API/References/apierrors.htm)."
        },
        "message":{
            "type":"string",
            "description":"A human-readable error string."
        }
    },
    "type":"object"
}

500 Response

Internal Server Error

Headers

• opc-request-id: string
  Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

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. See [API Errors](https://docs.us-phoenix-1.oraclecloud.com/Content/API/References/apierrors.htm).
• message(required): string
  A human-readable error string.

{
    "description":"The properties that define an error.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"A short error code that defines the error, meant for programmatic parsing. See [API Errors](https://docs.us-phoenix-1.oraclecloud.com/Content/API/References/apierrors.htm)."
        },
        "message":{
            "type":"string",
            "description":"A human-readable error string."
        }
    },
    "type":"object"
}

Default Response

Unknown Error

Headers

• opc-request-id: string
  Unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier.

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. See [API Errors](https://docs.us-phoenix-1.oraclecloud.com/Content/API/References/apierrors.htm).
• message(required): string
  A human-readable error string.

{
    "description":"The properties that define an error.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"A short error code that defines the error, meant for programmatic parsing. See [API Errors](https://docs.us-phoenix-1.oraclecloud.com/Content/API/References/apierrors.htm)."
        },
        "message":{
            "type":"string",
            "description":"A human-readable error string."
        }
    },
    "type":"object"
}

Back to Top