Jump to

• Request
• Response

Update an Instance Pool

put

/20160918/instancePools/{instance_pool_id}

Update the specified instance pool. You can change the name of the pool, the size of the pool, the instance configuration that is used to create new instances, the fault domains, VCN, and subnet. Configuration changes do not affect existing instances; configuration changes only affect new instances. New instances will be provisioned using the new instance configuration and placement configuration.

To attach or detach an instance, see AttachInstancePoolInstance and DetachInstancePoolInstance.

To attach load balancers or detach load balancer attachments, see AttachLoadBalancer and DetachLoadBalancer.

Request

Supported Media Types

• application/json

Path Parameters

• instancePoolId(required): string
  The OCID of the instance pool.

Header Parameters

• if-match: string
  For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
• opc-retry-token: string
  Minimum Length: 1

  Maximum Length: 64

  A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations (for example, if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected).

Body ()

Update instance pool configuration

Root Schema : UpdateInstancePoolDetails

Type: object

The data to update an instance pool.

Show Source

• definedTags: object definedTags
  Additional Properties Allowed: additionalProperties

  Defined tags for this resource. Each key is predefined and scoped to a namespace.
• displayName: string
  Minimum Length: 1

  Maximum Length: 255

  A user-friendly name. Does not need to be unique, and it is changeable. Avoid entering confidential information.
• freeformTags: object freeformTags
  Additional Properties Allowed: additionalProperties

  Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. Example: {"Department": "Finance"}
• instanceConfigurationId: string
  Minimum Length: 1

  Maximum Length: 255

  The OCID of the instance configuration associated with the instance pool.
• instanceDisplayNameFormatter: string
  Minimum Length: 0

  Maximum Length: 255

  A user-friendly formatter for the instance pool's instance display names. Instance display names follow the format. The formatter does not retroactively change instance display names. Only future instance display names follow the format.
• instanceHostnameFormatter: string
  Minimum Length: 0

  Maximum Length: 255

  A user-friendly formatter for the instance pool's instance hostnames. Instance hostnames follow the format. The formatter does not retroactively change instance hostnames. Only future instance hostnames follow the format.
• placementConfigurations: array placementConfigurations
  The placement configurations for the instance pool. Provide one placement configuration for the AD-1 availability domain.
• size: integer
  The number of instances that should be in the instance pool. To determine whether capacity is available for a specific shape before you resize an instance pool, use the CreateComputeCapacityReport operation.

{
    "description":"The data to update an instance pool.",
    "properties":{
        "definedTags":{
            "description":"Defined tags for this resource. Each key is predefined and scoped to a namespace.",
            "type":"object",
            "additionalProperties":{
                "description":"Key-value pair representing a defined tag key and value, scoped to a namespace.  Example: `{\"CostCenter\": \"42\"}` ",
                "type":"object",
                "additionalProperties":{
                    "description":"The value of the tag. Only the String type is supported. ",
                    "type":"object"
                }
            }
        },
        "displayName":{
            "description":"A user-friendly name. Does not need to be unique, and it is changeable. Avoid entering confidential information.",
            "maxLength":255,
            "minLength":1,
            "type":"string"
        },
        "freeformTags":{
            "description":"Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. Example: {\"Department\": \"Finance\"} ",
            "type":"object",
            "additionalProperties":{
                "type":"string"
            }
        },
        "instanceConfigurationId":{
            "description":"The OCID of the instance configuration associated with the instance pool.",
            "maxLength":255,
            "minLength":1,
            "type":"string"
        },
        "placementConfigurations":{
            "description":"The placement configurations for the instance pool. Provide one placement configuration for the AD-1 availability domain.",
            "type":"array",
            "items":{
                "$ref":"#/definitions/UpdateInstancePoolPlacementConfigurationDetails"
            }
        },
        "size":{
            "description":"The number of instances that should be in the instance pool.  To determine whether capacity is available for a specific shape before you resize an instance pool, use the CreateComputeCapacityReport operation.",
            "type":"integer"
        },
        "instanceDisplayNameFormatter":{
            "description":"A user-friendly formatter for the instance pool's instance display names. Instance display names follow the format. The formatter does not retroactively change instance display names. Only future instance display names follow the format.",
            "maxLength":255,
            "minLength":0,
            "type":"string",
            "x-default-description":"null"
        },
        "instanceHostnameFormatter":{
            "description":"A user-friendly formatter for the instance pool's instance hostnames. Instance hostnames follow the format. The formatter does not retroactively change instance hostnames. Only future instance hostnames follow the format.",
            "maxLength":255,
            "minLength":0,
            "type":"string",
            "x-default-description":"null"
        }
    },
    "type":"object"
}

Nested Schema : definedTags

Type: object

Additional Properties Allowed

Show Source

• object additionalProperties
  Additional Properties Allowed: additionalProperties

  Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}`

{
    "description":"Defined tags for this resource. Each key is predefined and scoped to a namespace.",
    "type":"object",
    "additionalProperties":{
        "description":"Key-value pair representing a defined tag key and value, scoped to a namespace.  Example: `{\"CostCenter\": \"42\"}` ",
        "type":"object",
        "additionalProperties":{
            "description":"The value of the tag. Only the String type is supported. ",
            "type":"object"
        }
    }
}

Defined tags for this resource. Each key is predefined and scoped to a namespace.

Nested Schema : freeformTags

Type: object

Additional Properties Allowed

Show Source

• string

{
    "description":"Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. Example: {\"Department\": \"Finance\"} ",
    "type":"object",
    "additionalProperties":{
        "type":"string"
    }
}

Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. Example: {"Department": "Finance"}

Nested Schema : placementConfigurations

Type: array

The placement configurations for the instance pool. Provide one placement configuration for the AD-1 availability domain.

Show Source

• Array of: object UpdateInstancePoolPlacementConfigurationDetails
  The location for where an instance pool will place instances.

{
    "description":"The placement configurations for the instance pool. Provide one placement configuration for the AD-1 availability domain.",
    "type":"array",
    "items":{
        "$ref":"#/definitions/UpdateInstancePoolPlacementConfigurationDetails"
    }
}

Nested Schema : additionalProperties

Type: object

Additional Properties Allowed

Show Source

• object additionalProperties
  The value of the tag. Only the String type is supported.

{
    "description":"Key-value pair representing a defined tag key and value, scoped to a namespace.  Example: `{\"CostCenter\": \"42\"}` ",
    "type":"object",
    "additionalProperties":{
        "description":"The value of the tag. Only the String type is supported. ",
        "type":"object"
    }
}

Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}`

Nested Schema : additionalProperties

Type: object

The value of the tag. Only the String type is supported.

Nested Schema : UpdateInstancePoolPlacementConfigurationDetails

Type: object

The location for where an instance pool will place instances.

Show Source

• availabilityDomain(required): string
  Minimum Length: 1

  Maximum Length: 255

  The availability domain to place instances. Example: AD-1
• faultDomains: array faultDomains
  Unique Items Required: true

  The fault domains to place instances. If you don't provide any values, the system makes a best effort to distribute instances across all fault domains based on capacity. To distribute the instances evenly across selected fault domains, provide a set of fault domains. For example, you might want instances to be evenly distributed if your applications require high availability. To get a list of fault domains, use the [ListFaultDomains](#/en/identity/20160918/FaultDomain/ListFaultDomains) operation in the Identity and Access Management Service API. Example: [FAULT-DOMAIN-1, FAULT-DOMAIN-2, FAULT-DOMAIN-3]
• instanceAffinityDetails: array instanceAffinityDetails
  Instance affinity details containing the domain and array of instance pool instance count that should reside in that domain. Domain can be a fault domain, building, etc.
• primarySubnetId: string
  Minimum Length: 1

  Maximum Length: 255

  The OCID of the primary subnet in which to place instances. This field is deprecated. Use `primaryVnicSubnets` instead to set VNIC data for instances in the pool.
• primaryVnicSubnets: object InstancePoolPlacementPrimarySubnet
  Details about the IPv6 primary subnet.
• secondaryVnicSubnets: array secondaryVnicSubnets
  Unique Items Required: true

  The set of secondary VNIC data for instances in the pool.

{
    "description":"The location for where an instance pool will place instances.",
    "properties":{
        "availabilityDomain":{
            "description":"The availability domain to place instances. Example: AD-1 ",
            "maxLength":255,
            "minLength":1,
            "type":"string"
        },
        "faultDomains":{
            "description":"The fault domains to place instances. If you don't provide any values, the system makes a best effort to distribute instances across all fault domains based on capacity. To distribute the instances evenly across selected fault domains, provide a set of fault domains. For example, you might want instances to be evenly distributed if your applications require high availability. To get a list of fault domains, use the [ListFaultDomains](#/en/identity/20160918/FaultDomain/ListFaultDomains) operation in the Identity and Access Management Service API. Example: [FAULT-DOMAIN-1, FAULT-DOMAIN-2, FAULT-DOMAIN-3] ",
            "type":"array",
            "items":{
                "type":"string"
            },
            "uniqueItems":true
        },
        "instanceAffinityDetails":{
            "description":"Instance affinity details containing the domain and array of instance pool instance count that should reside in that domain. Domain can be a fault domain, building, etc. ",
            "type":"array",
            "maxLength":3,
            "items":{
                "$ref":"#/definitions/InstancePoolInstanceAffinityDetails"
            }
        },
        "primarySubnetId":{
            "description":"The OCID of the primary subnet in which to place instances. This field is deprecated. Use `primaryVnicSubnets` instead to set VNIC data for instances in the pool. ",
            "maxLength":255,
            "minLength":1,
            "type":"string"
        },
        "primaryVnicSubnets":{
            "$ref":"#/definitions/InstancePoolPlacementPrimarySubnet"
        },
        "secondaryVnicSubnets":{
            "description":"The set of secondary VNIC data for instances in the pool.",
            "type":"array",
            "items":{
                "$ref":"#/definitions/InstancePoolPlacementSecondaryVnicSubnet"
            },
            "uniqueItems":true
        }
    },
    "required":[
        "availabilityDomain"
    ],
    "type":"object"
}

Nested Schema : faultDomains

Type: array

Unique Items Required: true

The fault domains to place instances. If you don't provide any values, the system makes a best effort to distribute instances across all fault domains based on capacity. To distribute the instances evenly across selected fault domains, provide a set of fault domains. For example, you might want instances to be evenly distributed if your applications require high availability. To get a list of fault domains, use the [ListFaultDomains](#/en/identity/20160918/FaultDomain/ListFaultDomains) operation in the Identity and Access Management Service API. Example: [FAULT-DOMAIN-1, FAULT-DOMAIN-2, FAULT-DOMAIN-3]

Show Source

• Array of: string

{
    "description":"The fault domains to place instances. If you don't provide any values, the system makes a best effort to distribute instances across all fault domains based on capacity. To distribute the instances evenly across selected fault domains, provide a set of fault domains. For example, you might want instances to be evenly distributed if your applications require high availability. To get a list of fault domains, use the [ListFaultDomains](#/en/identity/20160918/FaultDomain/ListFaultDomains) operation in the Identity and Access Management Service API. Example: [FAULT-DOMAIN-1, FAULT-DOMAIN-2, FAULT-DOMAIN-3] ",
    "type":"array",
    "items":{
        "type":"string"
    },
    "uniqueItems":true
}

Nested Schema : instanceAffinityDetails

Type: array

Maximum Length: 3

Instance affinity details containing the domain and array of instance pool instance count that should reside in that domain. Domain can be a fault domain, building, etc.

Show Source

• Array of: object InstancePoolInstanceAffinityDetails
  Discriminator: type

  Affinity details to launch instance pool instances.

{
    "description":"Instance affinity details containing the domain and array of instance pool instance count that should reside in that domain. Domain can be a fault domain, building, etc. ",
    "type":"array",
    "maxLength":3,
    "items":{
        "$ref":"#/definitions/InstancePoolInstanceAffinityDetails"
    }
}

Nested Schema : InstancePoolPlacementPrimarySubnet

Type: object

Details about the IPv6 primary subnet.

Match All

Details about the IPv6 primary subnet.

Details about the IPv6 primary subnet.

Show Source

• object InstancePoolPlacementSubnetDetails
  Base details about the IPv6 subnet.
• object InstancePoolPlacementPrimarySubnet-allOf[1]

{
    "description":"Details about the IPv6 primary subnet.",
    "allOf":[
        {
            "$ref":"#/definitions/InstancePoolPlacementSubnetDetails"
        },
        {
            "type":"object"
        }
    ],
    "type":"object"
}

Nested Schema : secondaryVnicSubnets

Type: array

Unique Items Required: true

The set of secondary VNIC data for instances in the pool.

Show Source

• Array of: object InstancePoolPlacementSecondaryVnicSubnet
  The secondary VNIC object for the placement configuration for an instance pool.

{
    "description":"The set of secondary VNIC data for instances in the pool.",
    "type":"array",
    "items":{
        "$ref":"#/definitions/InstancePoolPlacementSecondaryVnicSubnet"
    },
    "uniqueItems":true
}

Nested Schema : InstancePoolInstanceAffinityDetails

Type: object

Discriminator: type

Affinity details to launch instance pool instances.

Show Source

• type(required): string
  Default Value: FAULT_DOMAIN_AFFINITY

  Allowed Values: [ "FAULT_DOMAIN_AFFINITY" ]

  This specifies the type of instance pool instance affinity supported by OCI.

{
    "description":"Affinity details to launch instance pool instances.",
    "discriminator":"type",
    "properties":{
        "type":{
            "description":"This specifies the type of instance pool instance affinity supported by OCI.",
            "type":"string",
            "enum":[
                "FAULT_DOMAIN_AFFINITY"
            ],
            "default":"FAULT_DOMAIN_AFFINITY"
        }
    },
    "required":[
        "type"
    ],
    "type":"object"
}

Nested Schema : InstancePoolPlacementSubnetDetails

Type: object

Base details about the IPv6 subnet.

Show Source

• ipv6AddressIpv6SubnetCidrPairDetails: array ipv6AddressIpv6SubnetCidrPairDetails
  A list of IPv6 prefix ranges from which the VNIC should be assigned an IPv6 address. You can provide only the prefix ranges and OCI will select an available address from the range. You can optionally choose to leave the prefix range empty and instead provide the specific IPv6 address that should be used from within that range.
• isAssignIpv6Ip: boolean
  Default Value: false

  Whether to allocate an IPv6 address at instance and VNIC creation from an IPv6 enabled subnet. Default: False. When provided you may optionally provide an IPv6 prefix (`ipv6SubnetCidr`) of your choice to assign the IPv6 address from. If `ipv6SubnetCidr` is not provided then an IPv6 prefix is chosen for you.
• subnetId(required): string
  Minimum Length: 1

  Maximum Length: 255

  The subnet OCID for the secondary VNIC.

{
    "description":"Base details about the IPv6 subnet.",
    "properties":{
        "isAssignIpv6Ip":{
            "description":"Whether to allocate an IPv6 address at instance and VNIC creation from an IPv6 enabled subnet. Default: False. When provided you may optionally provide an IPv6 prefix (`ipv6SubnetCidr`) of your choice to assign the IPv6 address from. If `ipv6SubnetCidr` is not provided then an IPv6 prefix is chosen for you. ",
            "type":"boolean",
            "default":false
        },
        "ipv6AddressIpv6SubnetCidrPairDetails":{
            "description":"A list of IPv6 prefix ranges from which the VNIC should be assigned an IPv6 address. You can provide only the prefix ranges and OCI will select an available address from the range. You can optionally choose to leave the prefix range empty and instead provide the specific IPv6 address that should be used from within that range. ",
            "type":"array",
            "items":{
                "$ref":"#/definitions/InstancePoolPlacementIpv6AddressIpv6SubnetCidrDetails"
            }
        },
        "subnetId":{
            "description":"The subnet OCID for the secondary VNIC.",
            "type":"string",
            "minLength":1,
            "maxLength":255
        }
    },
    "required":[
        "subnetId"
    ],
    "type":"object"
}

Nested Schema : InstancePoolPlacementPrimarySubnet-allOf[1]

Type: object

Nested Schema : ipv6AddressIpv6SubnetCidrPairDetails

Type: array

A list of IPv6 prefix ranges from which the VNIC should be assigned an IPv6 address. You can provide only the prefix ranges and OCI will select an available address from the range. You can optionally choose to leave the prefix range empty and instead provide the specific IPv6 address that should be used from within that range.

Show Source

• Array of: object InstancePoolPlacementIpv6AddressIpv6SubnetCidrDetails
  Optional. Used to specify from which subnet prefixes an IPv6 address should be allocated, or to assign valid available IPv6 addresses.

{
    "description":"A list of IPv6 prefix ranges from which the VNIC should be assigned an IPv6 address. You can provide only the prefix ranges and OCI will select an available address from the range. You can optionally choose to leave the prefix range empty and instead provide the specific IPv6 address that should be used from within that range. ",
    "type":"array",
    "items":{
        "$ref":"#/definitions/InstancePoolPlacementIpv6AddressIpv6SubnetCidrDetails"
    }
}

Nested Schema : InstancePoolPlacementIpv6AddressIpv6SubnetCidrDetails

Type: object

Optional. Used to specify from which subnet prefixes an IPv6 address should be allocated, or to assign valid available IPv6 addresses.

Show Source

• ipv6SubnetCidr: string
  Minimum Length: 1

  Maximum Length: 45

  Optional. Used to disambiguate which subnet prefix should be used to create an IPv6 allocation.

{
    "description":"Optional. Used to specify from which subnet prefixes an IPv6 address should be allocated, or to assign valid available IPv6 addresses. ",
    "properties":{
        "ipv6SubnetCidr":{
            "description":"Optional. Used to disambiguate which subnet prefix should be used to create an IPv6 allocation. ",
            "maxLength":45,
            "minLength":1,
            "type":"string"
        }
    },
    "type":"object"
}

Nested Schema : InstancePoolPlacementSecondaryVnicSubnet

Type: object

The secondary VNIC object for the placement configuration for an instance pool.

Match All

The secondary VNIC object for the placement configuration for an instance pool.

The secondary VNIC object for the placement configuration for an instance pool.

Show Source

• object InstancePoolPlacementSubnetDetails
  Base details about the IPv6 subnet.
• object InstancePoolPlacementSecondaryVnicSubnet-allOf[1]

{
    "description":"The secondary VNIC object for the placement configuration for an instance pool.",
    "allOf":[
        {
            "$ref":"#/definitions/InstancePoolPlacementSubnetDetails"
        },
        {
            "type":"object",
            "properties":{
                "displayName":{
                    "description":"The display name of the VNIC. This is also used to match against the instance configuration defined secondary VNIC. ",
                    "type":"string",
                    "minLength":1,
                    "maxLength":255,
                    "minItems":1
                }
            }
        }
    ],
    "type":"object"
}

Nested Schema : InstancePoolPlacementSecondaryVnicSubnet-allOf[1]

Type: object

Show Source

• displayName: string
  Minimum Length: 1

  Maximum Length: 255

  The display name of the VNIC. This is also used to match against the instance configuration defined secondary VNIC.

{
    "type":"object",
    "properties":{
        "displayName":{
            "description":"The display name of the VNIC. This is also used to match against the instance configuration defined secondary VNIC. ",
            "type":"string",
            "minLength":1,
            "maxLength":255,
            "minItems":1
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

The instance pool was updated.

Headers

• etag: string
  For optimistic concurrency control. See `if-match`.
• 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 : InstancePool

Type: object

An instance pool is a set of instances that are managed as a group. For more information about instance pools and instance configurations, see [Working with Instance Configurations](https://docs.oracle.com/en/engineered-systems/private-cloud-appliance/3.0-latest/user/user-usr-instance-configs.html#usr-instconfig-create) and [Working with Instance Pools](https://docs.oracle.com/en/engineered-systems/private-cloud-appliance/3.0-latest/user/user-usr-instance-pools.html#usr-instance-pools).

Show Source

• compartmentId(required): string
  Minimum Length: 1

  Maximum Length: 255

  The OCID of the compartment containing the instance pool.
• definedTags: object definedTags
  Additional Properties Allowed: additionalProperties

  Defined tags for this resource. Each key is predefined and scoped to a namespace.
• displayName: string
  Minimum Length: 1

  Maximum Length: 255

  A user-friendly name. Does not need to be unique, and it is changeable. Avoid entering confidential information.
• freeformTags: object freeformTags
  Additional Properties Allowed: additionalProperties

  Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. Example: {"Department": "Finance"}
• id(required): string
  Minimum Length: 1

  Maximum Length: 255

  The OCID of the instance pool.
• instanceConfigurationId(required): string
  Minimum Length: 1

  Maximum Length: 255

  The OCID of the instance configuration associated with the instance pool.
• instanceDisplayNameFormatter: string
  Minimum Length: 1

  Maximum Length: 255

  A user-friendly formatter for the instance pool's instance display names. Instance display names follow the format. The formatter does not retroactively change instance display names. Only future instance display names follow the format.
• instanceHostnameFormatter: string
  Minimum Length: 1

  Maximum Length: 255

  A user-friendly formatter for the instance pool's instance hostnames. Instance hostnames follow the format. The formatter does not retroactively change instance hostnames. Only future instance hostnames follow the format
• lifecycleState(required): string
  Allowed Values: [ "PROVISIONING", "SCALING", "STARTING", "STOPPING", "TERMINATING", "STOPPED", "TERMINATED", "RUNNING" ]

  The current state of the instance pool.
• loadBalancers: array loadBalancers
  The load balancers attached to the instance pool.
• placementConfigurations(required): array placementConfigurations
  The placement configurations for the instance pool.
• size(required): integer
  The number of instances that should be in the instance pool.
• timeCreated(required): string(date-time)
  The date and time the instance pool was created, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). Example: 2016-08-25T21:10:29.600Z
• timeStateUpdated: string(date-time)
  The last date and time the instance pool state was updated, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). Example: 2016-08-25T21:10:29.600Z

{
    "description":"An instance pool is a set of instances that are managed as a group. For more information about instance pools and instance configurations, see [Working with Instance Configurations](https://docs.oracle.com/en/engineered-systems/private-cloud-appliance/3.0-latest/user/user-usr-instance-configs.html#usr-instconfig-create) and [Working with Instance Pools](https://docs.oracle.com/en/engineered-systems/private-cloud-appliance/3.0-latest/user/user-usr-instance-pools.html#usr-instance-pools).",
    "properties":{
        "id":{
            "description":"The OCID of the instance pool.",
            "maxLength":255,
            "minLength":1,
            "type":"string"
        },
        "compartmentId":{
            "description":"The OCID of the compartment containing the instance pool.",
            "maxLength":255,
            "minLength":1,
            "type":"string"
        },
        "definedTags":{
            "description":"Defined tags for this resource. Each key is predefined and scoped to a namespace.",
            "type":"object",
            "additionalProperties":{
                "description":"Key-value pair representing a defined tag key and value, scoped to a namespace.  Example: `{\"CostCenter\": \"42\"}` ",
                "type":"object",
                "additionalProperties":{
                    "description":"The value of the tag. Only the String type is supported. ",
                    "type":"object"
                }
            }
        },
        "displayName":{
            "description":"A user-friendly name. Does not need to be unique, and it is changeable. Avoid entering confidential information.",
            "maxLength":255,
            "minLength":1,
            "type":"string"
        },
        "freeformTags":{
            "description":"Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. Example: {\"Department\": \"Finance\"} ",
            "type":"object",
            "additionalProperties":{
                "type":"string"
            }
        },
        "instanceConfigurationId":{
            "description":"The OCID of the instance configuration associated with the instance pool.",
            "maxLength":255,
            "minLength":1,
            "type":"string"
        },
        "lifecycleState":{
            "description":"The current state of the instance pool.",
            "enum":[
                "PROVISIONING",
                "SCALING",
                "STARTING",
                "STOPPING",
                "TERMINATING",
                "STOPPED",
                "TERMINATED",
                "RUNNING"
            ],
            "type":"string"
        },
        "placementConfigurations":{
            "description":"The placement configurations for the instance pool.",
            "type":"array",
            "items":{
                "$ref":"#/definitions/InstancePoolPlacementConfiguration"
            }
        },
        "size":{
            "description":"The number of instances that should be in the instance pool.",
            "type":"integer"
        },
        "timeCreated":{
            "description":"The date and time the instance pool was created, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). Example: 2016-08-25T21:10:29.600Z ",
            "format":"date-time",
            "type":"string"
        },
        "loadBalancers":{
            "description":"The load balancers attached to the instance pool.",
            "type":"array",
            "items":{
                "$ref":"#/definitions/InstancePoolLoadBalancerAttachment"
            }
        },
        "timeStateUpdated":{
            "description":"The last date and time the instance pool state was updated, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). Example: 2016-08-25T21:10:29.600Z ",
            "format":"date-time",
            "type":"string"
        },
        "instanceDisplayNameFormatter":{
            "description":"A user-friendly formatter for the instance pool's instance display names. Instance display names follow the format. The formatter does not retroactively change instance display names. Only future instance display names follow the format.",
            "maxLength":255,
            "minLength":1,
            "type":"string",
            "x-default-description":"null"
        },
        "instanceHostnameFormatter":{
            "description":"A user-friendly formatter for the instance pool's instance hostnames. Instance hostnames follow the format. The formatter does not retroactively change instance hostnames. Only future instance hostnames follow the format ",
            "maxLength":255,
            "minLength":1,
            "type":"string",
            "x-default-description":"null"
        }
    },
    "required":[
        "id",
        "compartmentId",
        "instanceConfigurationId",
        "lifecycleState",
        "placementConfigurations",
        "size",
        "timeCreated"
    ],
    "x-example":"{   \"id\": \"ocid1.instancepool.phx....<unique_ID>\",   \"displayName\": \"autoscaling-instance-pool\",   \"compartmentId\": \"ocid1.compartment.oc1..<unique_ID>\",   \"instanceConfigurationId\": \"ocid1.instanceconfiguration.oc1..<unique_ID>\",   \"lifecycleState\": \"PROVISIONING\",   \"placementConfigurations\": [     {       \"availabilityDomain\": \"Uocm:PHX-AD-1\",       \"primarySubnetId\": \"ocid1.subnet.oc1..<unique_ID>\"     },     {       \"availabilityDomain\": \"Uocm:PHX-AD-2\",       \"primarySubnetId\": \"ocid1.subnet.oc1..<unique_ID>\"     },     {       \"availabilityDomain\": \"Uocm:PHX-AD-3\",       \"primarySubnetId\": \"ocid1.subnet.oc1..<unique_ID>\"     }   ],   \"size\": 15,   \"timeCreated\": \"2019-04-10T17:04:47.627Z\",   \"loadBalancers\": [     {       \"id\" : \"ocid1.loadbalancerattachment.oc1.phx.<unique_ID>\",       \"instancePoolId\" : \"ocid1.instancepool.oc1.phx.<unique_ID>\",       \"loadBalancerId\" : \"ocid1.loadbalancer.oc1.phx.<unique_ID>\",       \"backendSetName\" : \"lb-20190410-1147-backend-set\",       \"port\" : 80,       \"vnicSelection\" : \"PrimaryVnic\",       \"lifecycleState\" : \"ATTACHING\"     }   ] } ",
    "type":"object"
}

Nested Schema : definedTags

Type: object

Additional Properties Allowed

Show Source

• object additionalProperties
  Additional Properties Allowed: additionalProperties

  Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}`

{
    "description":"Defined tags for this resource. Each key is predefined and scoped to a namespace.",
    "type":"object",
    "additionalProperties":{
        "description":"Key-value pair representing a defined tag key and value, scoped to a namespace.  Example: `{\"CostCenter\": \"42\"}` ",
        "type":"object",
        "additionalProperties":{
            "description":"The value of the tag. Only the String type is supported. ",
            "type":"object"
        }
    }
}

Defined tags for this resource. Each key is predefined and scoped to a namespace.

Nested Schema : freeformTags

Type: object

Additional Properties Allowed

Show Source

• string

{
    "description":"Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. Example: {\"Department\": \"Finance\"} ",
    "type":"object",
    "additionalProperties":{
        "type":"string"
    }
}

Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. Example: {"Department": "Finance"}

Nested Schema : loadBalancers

Type: array

The load balancers attached to the instance pool.

Show Source

• Array of: object InstancePoolLoadBalancerAttachment
  Represents a load balancer that is attached to an instance pool.

{
    "description":"The load balancers attached to the instance pool.",
    "type":"array",
    "items":{
        "$ref":"#/definitions/InstancePoolLoadBalancerAttachment"
    }
}

Nested Schema : placementConfigurations

Type: array

The placement configurations for the instance pool.

Show Source

• Array of: object InstancePoolPlacementConfiguration
  The location for where an instance pool will place instances.

{
    "description":"The placement configurations for the instance pool.",
    "type":"array",
    "items":{
        "$ref":"#/definitions/InstancePoolPlacementConfiguration"
    }
}

Nested Schema : additionalProperties

Type: object

Additional Properties Allowed

Show Source

• object additionalProperties
  The value of the tag. Only the String type is supported.

{
    "description":"Key-value pair representing a defined tag key and value, scoped to a namespace.  Example: `{\"CostCenter\": \"42\"}` ",
    "type":"object",
    "additionalProperties":{
        "description":"The value of the tag. Only the String type is supported. ",
        "type":"object"
    }
}

Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}`

Nested Schema : additionalProperties

Type: object

The value of the tag. Only the String type is supported.

Nested Schema : InstancePoolLoadBalancerAttachment

Type: object

Represents a load balancer that is attached to an instance pool.

Show Source

• backendSetName(required): string
  Minimum Length: 1

  Maximum Length: 255

  The name of the backend set on the load balancer.
• id(required): string
  Minimum Length: 1

  Maximum Length: 255

  The OCID of the load balancer attachment.
• instancePoolId(required): string
  Minimum Length: 1

  Maximum Length: 255

  The OCID of the instance pool of the load balancer attachment.
• lifecycleState(required): string
  Allowed Values: [ "ATTACHING", "ATTACHED", "DETACHING", "DETACHED" ]

  The status of the interaction between the instance pool and the load balancer.
• loadBalancerId(required): string
  Minimum Length: 1

  Maximum Length: 255

  The OCID of the load balancer attached to the instance pool.
• port(required): integer
  Minimum Value: 0

  Maximum Value: 65535

  The port value used for the backends.
• vnicSelection(required): string
  Minimum Length: 1

  Maximum Length: 255

  Indicates which VNIC on each instance in the instance pool should be used to associate with the load balancer. Possible values are "PrimaryVnic" or the displayName of one of the secondary VNICs on the instance configuration that is associated with the instance pool.

{
    "description":"Represents a load balancer that is attached to an instance pool.",
    "properties":{
        "id":{
            "type":"string",
            "description":"The OCID of the load balancer attachment.",
            "minLength":1,
            "maxLength":255
        },
        "instancePoolId":{
            "type":"string",
            "description":"The OCID of the instance pool of the load balancer attachment.",
            "minLength":1,
            "maxLength":255
        },
        "loadBalancerId":{
            "type":"string",
            "description":"The OCID of the load balancer attached to the instance pool.",
            "minLength":1,
            "maxLength":255
        },
        "backendSetName":{
            "type":"string",
            "description":"The name of the backend set on the load balancer.",
            "minLength":1,
            "maxLength":255
        },
        "port":{
            "type":"integer",
            "description":"The port value used for the backends.",
            "maximum":65535,
            "minimum":0
        },
        "vnicSelection":{
            "type":"string",
            "description":"Indicates which VNIC on each instance in the instance pool should be used to associate with the load balancer. Possible values are \"PrimaryVnic\" or the displayName of one of the secondary VNICs on the instance configuration that is associated with the instance pool.",
            "maxLength":255,
            "minLength":1
        },
        "lifecycleState":{
            "description":"The status of the interaction between the instance pool and the load balancer.",
            "type":"string",
            "enum":[
                "ATTACHING",
                "ATTACHED",
                "DETACHING",
                "DETACHED"
            ]
        }
    },
    "required":[
        "id",
        "instancePoolId",
        "loadBalancerId",
        "backendSetName",
        "port",
        "vnicSelection",
        "lifecycleState"
    ],
    "type":"object"
}

Nested Schema : InstancePoolPlacementConfiguration

Type: object

The location for where an instance pool will place instances.

Show Source

• availabilityDomain(required): string
  Minimum Length: 1

  Maximum Length: 255

  The availability domain to place instances. Example: AD-1
• faultDomains: array faultDomains
  Unique Items Required: true

  The fault domains to place instances. If you don't provide any values, the system makes a best effort to distribute instances across all fault domains based on capacity. To distribute the instances evenly across selected fault domains, provide a set of fault domains. For example, you might want instances to be evenly distributed if your applications require high availability. To get a list of fault domains, use the [ListFaultDomains](#/en/identity/20160918/FaultDomain/ListFaultDomains) operation in the Identity and Access Management Service API. Example: [FAULT-DOMAIN-1, FAULT-DOMAIN-2, FAULT-DOMAIN-3]
• instanceAffinityDetails: array instanceAffinityDetails
  Instance affinity details containing the domain and array of instance pool instance count that should reside in that domain. Domain can be a fault domain, building, etc.
• primarySubnetId: string
  Minimum Length: 1

  Maximum Length: 255

  The OCID of the primary subnet to place instances.
• primaryVnicSubnets: object InstancePoolPlacementPrimarySubnet
  Details about the IPv6 primary subnet.
• secondaryVnicSubnets: array secondaryVnicSubnets
  Unique Items Required: true

  The set of secondary VNIC data for instances in the pool.

{
    "description":"The location for where an instance pool will place instances.",
    "properties":{
        "availabilityDomain":{
            "description":"The availability domain to place instances. Example: AD-1 ",
            "maxLength":255,
            "minLength":1,
            "type":"string"
        },
        "primarySubnetId":{
            "description":"The OCID of the primary subnet to place instances.",
            "maxLength":255,
            "minLength":1,
            "type":"string"
        },
        "faultDomains":{
            "description":"The fault domains to place instances. If you don't provide any values, the system makes a best effort to distribute instances across all fault domains based on capacity. To distribute the instances evenly across selected fault domains, provide a set of fault domains. For example, you might want instances to be evenly distributed if your applications require high availability. To get a list of fault domains, use the [ListFaultDomains](#/en/identity/20160918/FaultDomain/ListFaultDomains) operation in the Identity and Access Management Service API. Example: [FAULT-DOMAIN-1, FAULT-DOMAIN-2, FAULT-DOMAIN-3] ",
            "type":"array",
            "items":{
                "type":"string"
            },
            "uniqueItems":true
        },
        "instanceAffinityDetails":{
            "description":"Instance affinity details containing the domain and array of instance pool instance count that should reside in that domain. Domain can be a fault domain, building, etc. ",
            "type":"array",
            "maxLength":3,
            "items":{
                "$ref":"#/definitions/InstancePoolInstanceAffinityDetails"
            }
        },
        "primaryVnicSubnets":{
            "$ref":"#/definitions/InstancePoolPlacementPrimarySubnet"
        },
        "secondaryVnicSubnets":{
            "description":"The set of secondary VNIC data for instances in the pool.",
            "type":"array",
            "items":{
                "$ref":"#/definitions/InstancePoolPlacementSecondaryVnicSubnet"
            },
            "uniqueItems":true
        }
    },
    "required":[
        "availabilityDomain"
    ],
    "type":"object"
}

Nested Schema : faultDomains

Type: array

Unique Items Required: true

The fault domains to place instances. If you don't provide any values, the system makes a best effort to distribute instances across all fault domains based on capacity. To distribute the instances evenly across selected fault domains, provide a set of fault domains. For example, you might want instances to be evenly distributed if your applications require high availability. To get a list of fault domains, use the [ListFaultDomains](#/en/identity/20160918/FaultDomain/ListFaultDomains) operation in the Identity and Access Management Service API. Example: [FAULT-DOMAIN-1, FAULT-DOMAIN-2, FAULT-DOMAIN-3]

Show Source

• Array of: string

{
    "description":"The fault domains to place instances. If you don't provide any values, the system makes a best effort to distribute instances across all fault domains based on capacity. To distribute the instances evenly across selected fault domains, provide a set of fault domains. For example, you might want instances to be evenly distributed if your applications require high availability. To get a list of fault domains, use the [ListFaultDomains](#/en/identity/20160918/FaultDomain/ListFaultDomains) operation in the Identity and Access Management Service API. Example: [FAULT-DOMAIN-1, FAULT-DOMAIN-2, FAULT-DOMAIN-3] ",
    "type":"array",
    "items":{
        "type":"string"
    },
    "uniqueItems":true
}

Nested Schema : instanceAffinityDetails

Type: array

Maximum Length: 3

Instance affinity details containing the domain and array of instance pool instance count that should reside in that domain. Domain can be a fault domain, building, etc.

Show Source

• Array of: object InstancePoolInstanceAffinityDetails
  Discriminator: type

  Affinity details to launch instance pool instances.

{
    "description":"Instance affinity details containing the domain and array of instance pool instance count that should reside in that domain. Domain can be a fault domain, building, etc. ",
    "type":"array",
    "maxLength":3,
    "items":{
        "$ref":"#/definitions/InstancePoolInstanceAffinityDetails"
    }
}

Nested Schema : InstancePoolPlacementPrimarySubnet

Type: object

Details about the IPv6 primary subnet.

Match All

Details about the IPv6 primary subnet.

Details about the IPv6 primary subnet.

Show Source

• object InstancePoolPlacementSubnetDetails
  Base details about the IPv6 subnet.
• object InstancePoolPlacementPrimarySubnet-allOf[1]

{
    "description":"Details about the IPv6 primary subnet.",
    "allOf":[
        {
            "$ref":"#/definitions/InstancePoolPlacementSubnetDetails"
        },
        {
            "type":"object"
        }
    ],
    "type":"object"
}

Nested Schema : secondaryVnicSubnets

Type: array

Unique Items Required: true

The set of secondary VNIC data for instances in the pool.

Show Source

• Array of: object InstancePoolPlacementSecondaryVnicSubnet
  The secondary VNIC object for the placement configuration for an instance pool.

{
    "description":"The set of secondary VNIC data for instances in the pool.",
    "type":"array",
    "items":{
        "$ref":"#/definitions/InstancePoolPlacementSecondaryVnicSubnet"
    },
    "uniqueItems":true
}

Nested Schema : InstancePoolInstanceAffinityDetails

Type: object

Discriminator: type

Affinity details to launch instance pool instances.

Show Source

• type(required): string
  Default Value: FAULT_DOMAIN_AFFINITY

  Allowed Values: [ "FAULT_DOMAIN_AFFINITY" ]

  This specifies the type of instance pool instance affinity supported by OCI.

{
    "description":"Affinity details to launch instance pool instances.",
    "discriminator":"type",
    "properties":{
        "type":{
            "description":"This specifies the type of instance pool instance affinity supported by OCI.",
            "type":"string",
            "enum":[
                "FAULT_DOMAIN_AFFINITY"
            ],
            "default":"FAULT_DOMAIN_AFFINITY"
        }
    },
    "required":[
        "type"
    ],
    "type":"object"
}

Nested Schema : InstancePoolPlacementSubnetDetails

Type: object

Base details about the IPv6 subnet.

Show Source

• ipv6AddressIpv6SubnetCidrPairDetails: array ipv6AddressIpv6SubnetCidrPairDetails
  A list of IPv6 prefix ranges from which the VNIC should be assigned an IPv6 address. You can provide only the prefix ranges and OCI will select an available address from the range. You can optionally choose to leave the prefix range empty and instead provide the specific IPv6 address that should be used from within that range.
• isAssignIpv6Ip: boolean
  Default Value: false

  Whether to allocate an IPv6 address at instance and VNIC creation from an IPv6 enabled subnet. Default: False. When provided you may optionally provide an IPv6 prefix (`ipv6SubnetCidr`) of your choice to assign the IPv6 address from. If `ipv6SubnetCidr` is not provided then an IPv6 prefix is chosen for you.
• subnetId(required): string
  Minimum Length: 1

  Maximum Length: 255

  The subnet OCID for the secondary VNIC.

{
    "description":"Base details about the IPv6 subnet.",
    "properties":{
        "isAssignIpv6Ip":{
            "description":"Whether to allocate an IPv6 address at instance and VNIC creation from an IPv6 enabled subnet. Default: False. When provided you may optionally provide an IPv6 prefix (`ipv6SubnetCidr`) of your choice to assign the IPv6 address from. If `ipv6SubnetCidr` is not provided then an IPv6 prefix is chosen for you. ",
            "type":"boolean",
            "default":false
        },
        "ipv6AddressIpv6SubnetCidrPairDetails":{
            "description":"A list of IPv6 prefix ranges from which the VNIC should be assigned an IPv6 address. You can provide only the prefix ranges and OCI will select an available address from the range. You can optionally choose to leave the prefix range empty and instead provide the specific IPv6 address that should be used from within that range. ",
            "type":"array",
            "items":{
                "$ref":"#/definitions/InstancePoolPlacementIpv6AddressIpv6SubnetCidrDetails"
            }
        },
        "subnetId":{
            "description":"The subnet OCID for the secondary VNIC.",
            "type":"string",
            "minLength":1,
            "maxLength":255
        }
    },
    "required":[
        "subnetId"
    ],
    "type":"object"
}

Nested Schema : InstancePoolPlacementPrimarySubnet-allOf[1]

Type: object

Nested Schema : ipv6AddressIpv6SubnetCidrPairDetails

Type: array

A list of IPv6 prefix ranges from which the VNIC should be assigned an IPv6 address. You can provide only the prefix ranges and OCI will select an available address from the range. You can optionally choose to leave the prefix range empty and instead provide the specific IPv6 address that should be used from within that range.

Show Source

• Array of: object InstancePoolPlacementIpv6AddressIpv6SubnetCidrDetails
  Optional. Used to specify from which subnet prefixes an IPv6 address should be allocated, or to assign valid available IPv6 addresses.

{
    "description":"A list of IPv6 prefix ranges from which the VNIC should be assigned an IPv6 address. You can provide only the prefix ranges and OCI will select an available address from the range. You can optionally choose to leave the prefix range empty and instead provide the specific IPv6 address that should be used from within that range. ",
    "type":"array",
    "items":{
        "$ref":"#/definitions/InstancePoolPlacementIpv6AddressIpv6SubnetCidrDetails"
    }
}

Nested Schema : InstancePoolPlacementIpv6AddressIpv6SubnetCidrDetails

Type: object

Optional. Used to specify from which subnet prefixes an IPv6 address should be allocated, or to assign valid available IPv6 addresses.

Show Source

• ipv6SubnetCidr: string
  Minimum Length: 1

  Maximum Length: 45

  Optional. Used to disambiguate which subnet prefix should be used to create an IPv6 allocation.

{
    "description":"Optional. Used to specify from which subnet prefixes an IPv6 address should be allocated, or to assign valid available IPv6 addresses. ",
    "properties":{
        "ipv6SubnetCidr":{
            "description":"Optional. Used to disambiguate which subnet prefix should be used to create an IPv6 allocation. ",
            "maxLength":45,
            "minLength":1,
            "type":"string"
        }
    },
    "type":"object"
}

Nested Schema : InstancePoolPlacementSecondaryVnicSubnet

Type: object

The secondary VNIC object for the placement configuration for an instance pool.

Match All

The secondary VNIC object for the placement configuration for an instance pool.

The secondary VNIC object for the placement configuration for an instance pool.

Show Source

• object InstancePoolPlacementSubnetDetails
  Base details about the IPv6 subnet.
• object InstancePoolPlacementSecondaryVnicSubnet-allOf[1]

{
    "description":"The secondary VNIC object for the placement configuration for an instance pool.",
    "allOf":[
        {
            "$ref":"#/definitions/InstancePoolPlacementSubnetDetails"
        },
        {
            "type":"object",
            "properties":{
                "displayName":{
                    "description":"The display name of the VNIC. This is also used to match against the instance configuration defined secondary VNIC. ",
                    "type":"string",
                    "minLength":1,
                    "maxLength":255,
                    "minItems":1
                }
            }
        }
    ],
    "type":"object"
}

Nested Schema : InstancePoolPlacementSecondaryVnicSubnet-allOf[1]

Type: object

Show Source

• displayName: string
  Minimum Length: 1

  Maximum Length: 255

  The display name of the VNIC. This is also used to match against the instance configuration defined secondary VNIC.

{
    "type":"object",
    "properties":{
        "displayName":{
            "description":"The display name of the VNIC. This is also used to match against the instance configuration defined secondary VNIC. ",
            "type":"string",
            "minLength":1,
            "maxLength":255,
            "minItems":1
        }
    }
}

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"
}

409 Response

Conflict

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"
}

412 Response

Precondition Failed

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

An error has occurred.

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"
}

Back to Top