Jump to

• Request
• Response

CreateBootVolume

post

/20160918/bootVolumes

Create a new boot volume in the specified compartment from an existing boot volume or a boot volume backup. You may optionally specify a display name for the volume. The display name does not need to be unique, and you can change it. Avoid entering confidential information.

Request

Supported Media Types

• application/json

Header Parameters

• 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 ()

Request to create a new boot volume.

Root Schema : CreateBootVolumeDetails

Type: object

Show Source

• autotunePolicies: array autotunePolicies
  Unique Items Required: true

  The list of autotune policies to be enabled for this volume.
• availabilityDomain: string
  Minimum Length: 1

  Maximum Length: 255

  The availability domain of the volume. Omissible for cloning a volume. The new volume will be created in the availability domain of the source volume. Example: AD-1
• backupPolicyId: string
  Minimum Length: 1

  Maximum Length: 255

  Specifies the OCID of the boot volume backup policy to assign to the newly created boot volume. If omitted, no policy will be assigned.
• bootVolumeReplicas: array bootVolumeReplicas
  Maximum Number of Items: 1

  Unique Items Required: true

  The list of boot volume replicas to be enabled for this boot volume in the specified destination availability domains.
• compartmentId(required): string
  Minimum Length: 1

  Maximum Length: 255

  The OCID of the compartment that contains the boot volume.
• 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"}
• isAutoTuneEnabled: boolean
  Specifies whether the auto-tune performance is enabled for this boot volume. This field is deprecated. Use the DetachedVolumeAutotunePolicy instead to enable the volume for detached autotune.
• kmsKeyId: string
  Minimum Length: 1

  Maximum Length: 255

  The OCID of the Key Management key to assign as the master encryption key for the boot volume.
• sizeInGBs: integer(int64)
  The size of the volume in GBs.
• sourceDetails(required): object BootVolumeSourceDetails
  Discriminator: type
• vpusPerGB: integer(int64)
  The number of volume performance units (VPUs) that will be applied to this volume per GB, representing the Block Volume service's elastic performance options. Allowed values are: 10 - Balanced option. 20 - Higher Performance option.

{
    "properties":{
        "availabilityDomain":{
            "description":"The availability domain of the volume. Omissible for cloning a volume. The new volume will be created in the availability domain of the source volume. Example: AD-1 ",
            "maxLength":"255",
            "minLength":"1",
            "type":"string"
        },
        "backupPolicyId":{
            "description":"Specifies the OCID of the boot volume backup policy to assign to the newly created boot volume. If omitted, no policy will be assigned.",
            "maxLength":"255",
            "minLength":"1",
            "type":"string"
        },
        "compartmentId":{
            "description":"The OCID of the compartment that contains the boot volume.",
            "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.",
                "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"
            }
        },
        "kmsKeyId":{
            "description":"The OCID of the Key Management key to assign as the master encryption key for the boot volume.",
            "maxLength":"255",
            "minLength":"1",
            "type":"string"
        },
        "sizeInGBs":{
            "description":"The size of the volume in GBs.",
            "format":"int64",
            "type":"integer"
        },
        "vpusPerGB":{
            "description":"The number of volume performance units (VPUs) that will be applied to this volume per GB, representing the Block Volume service's elastic performance options. Allowed values are: 10 - Balanced option. 20 - Higher Performance option.",
            "format":"int64",
            "type":"integer"
        },
        "sourceDetails":{
            "$ref":"#/definitions/BootVolumeSourceDetails"
        },
        "isAutoTuneEnabled":{
            "description":"Specifies whether the auto-tune performance is enabled for this boot volume. This field is deprecated. Use the DetachedVolumeAutotunePolicy instead to enable the volume for detached autotune.",
            "type":"boolean"
        },
        "bootVolumeReplicas":{
            "description":"The list of boot volume replicas to be enabled for this boot volume in the specified destination availability domains.",
            "items":{
                "$ref":"#/definitions/BootVolumeReplicaDetails"
            },
            "type":"array",
            "uniqueItems":true,
            "maxItems":"1"
        },
        "autotunePolicies":{
            "description":"The list of autotune policies to be enabled for this volume.",
            "items":{
                "$ref":"#/definitions/AutotunePolicy"
            },
            "type":"array",
            "uniqueItems":true
        }
    },
    "required":[
        "compartmentId",
        "sourceDetails"
    ],
    "type":"object"
}

Nested Schema : autotunePolicies

Type: array

Unique Items Required: true

The list of autotune policies to be enabled for this volume.

Show Source

• Array of: object AutotunePolicy
  Discriminator: autotuneType

  An autotune policy automatically tunes the volume's performace based on the type of the policy.

{
    "description":"The list of autotune policies to be enabled for this volume.",
    "items":{
        "$ref":"#/definitions/AutotunePolicy"
    },
    "type":"array",
    "uniqueItems":true
}

Nested Schema : bootVolumeReplicas

Type: array

Maximum Number of Items: 1

Unique Items Required: true

The list of boot volume replicas to be enabled for this boot volume in the specified destination availability domains.

Show Source

• Array of: object BootVolumeReplicaDetails
  Contains the details for the boot volume replica

{
    "description":"The list of boot volume replicas to be enabled for this boot volume in the specified destination availability domains.",
    "items":{
        "$ref":"#/definitions/BootVolumeReplicaDetails"
    },
    "type":"array",
    "uniqueItems":true,
    "maxItems":"1"
}

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.

{
    "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.",
        "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 : BootVolumeSourceDetails

Type: object

Discriminator: type

Show Source

• type(required): string

{
    "discriminator":"type",
    "properties":{
        "type":{
            "type":"string"
        }
    },
    "required":[
        "type"
    ],
    "type":"object"
}

Nested Schema : AutotunePolicy

Type: object

Discriminator: autotuneType

An autotune policy automatically tunes the volume's performace based on the type of the policy.

Show Source

• autotuneType(required): string
  Allowed Values: [ "DETACHED_VOLUME", "PERFORMANCE_BASED" ]

  This specifies the type of autotunes supported by OCI.

{
    "description":"An autotune policy automatically tunes the volume's performace based on the type of the policy.",
    "discriminator":"autotuneType",
    "properties":{
        "autotuneType":{
            "description":"This specifies the type of autotunes supported by OCI.",
            "type":"string",
            "enum":[
                "DETACHED_VOLUME",
                "PERFORMANCE_BASED"
            ]
        }
    },
    "required":[
        "autotuneType"
    ],
    "type":"object"
}

Nested Schema : BootVolumeReplicaDetails

Type: object

Contains the details for the boot volume replica

Show Source

• availabilityDomain(required): string
  Minimum Length: 1

  Maximum Length: 255

  The availability domain of the boot volume replica. Example: AD-1
• 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.

{
    "description":"Contains the details for the boot volume replica",
    "properties":{
        "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"
        },
        "availabilityDomain":{
            "description":"The availability domain of the boot volume replica. Example: AD-1 ",
            "maxLength":"255",
            "minLength":"1",
            "type":"string"
        }
    },
    "required":[
        "availabilityDomain"
    ],
    "type":"object"
}

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.",
    "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.

Nested Schema : additionalProperties

Type: object

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

Back to Top

Response

Supported Media Types

• application/json

200 Response

The boot volume is being created.

Headers

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

Type: object

A detachable boot volume device that contains the image used to boot a Compute instance. For more information, see "Managing Boot Volumes" (https://docs.oracle.com/en/engineered-systems/private-cloud-appliance/3.0-latest/user/user-usr-blk-bootvolumes.html). Avoid entering confidential information when you supply string values using the API.

Show Source

• autoTunedVpusPerGB: integer(int64)
  The number of Volume Performance Units per GB that this boot volume is effectively tuned to.
• autotunePolicies: array autotunePolicies
  Unique Items Required: true

  The list of autotune policies enabled for this volume.
• availabilityDomain(required): string
  Minimum Length: 1

  Maximum Length: 255

  The availability domain of the boot volume. Example: AD-1
• bootVolumeReplicas: array bootVolumeReplicas
  The list of boot volume replicas of this boot volume
• compartmentId(required): string
  Minimum Length: 1

  Maximum Length: 255

  The OCID of the compartment that contains the boot volume.
• 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 boot volume's OCID.
• imageId: string
  Minimum Length: 1

  Maximum Length: 255

  The image OCID used to create the boot volume.
• isAutoTuneEnabled: boolean
  Specifies whether the auto-tune performance is enabled for this boot volume. This field is deprecated. Use the DetachedVolumeAutotunePolicy instead to enable the volume for detached autotune.
• isHydrated: boolean
  Specifies whether the boot volume's data has finished copying from the source boot volume or boot volume backup.
• kmsKeyId: string
  Minimum Length: 1

  Maximum Length: 255

  The OCID of the Key Management master encryption key assigned to the boot volume.
• lifecycleState(required): string
  Allowed Values: [ "PROVISIONING", "RESTORING", "AVAILABLE", "TERMINATING", "TERMINATED", "FAULTY" ]

  The current state of a boot volume.
• sizeInGBs: integer(int64)
  The size of the boot volume in GBs.
• sizeInMBs(required): integer(int64)
  The size of the volume in MBs. The value must be a multiple of 1024. This field is deprecated. Please use sizeInGBs.
• sourceDetails: object BootVolumeSourceDetails
  Discriminator: type
• systemTags: object systemTags
  Additional Properties Allowed: additionalProperties

  System tags for this resource. Each key is predefined and scoped to a namespace.
• timeCreated(required): string(date-time)
  The date and time the boot volume was created. Format defined by [RFC3339](https://tools.ietf.org/html/rfc3339).
• volumeGroupId: string
  Minimum Length: 1

  Maximum Length: 255

  The OCID of the source volume group.
• vpusPerGB: integer(int64)
  The number of volume performance units (VPUs) that will be applied to this boot volume per GB, representing the Block Volume service's elastic performance options. Allowed values are: 10 - Balanced option. 20 - Higher Performance option.

{
    "description":"A detachable boot volume device that contains the image used to boot a Compute instance. For more information, see \"Managing Boot Volumes\" (https://docs.oracle.com/en/engineered-systems/private-cloud-appliance/3.0-latest/user/user-usr-blk-bootvolumes.html). Avoid entering confidential information when you supply string values using the API.",
    "x-obmcs-splat":{
        "resourceKind":"volumes",
        "adLocality":"ad-local",
        "getOperationId":"GetBootVolume",
        "listResourcesOperationId":"ListBootVolumes",
        "ocidEntityType":"bootvolume",
        "activeLifecycleStates":[
            "AVAILABLE"
        ],
        "deletedLifecycleStates":[
            "TERMINATED",
            "FAULTY",
            "TERMINATING"
        ],
        "searchMetadata":{
            "resourceSchemaVersion":"1",
            "resourceType":"BootVolume",
            "scope":"customer",
            "rvnFromHeader":true
        }
    },
    "properties":{
        "availabilityDomain":{
            "description":"The availability domain of the boot volume. Example: AD-1 ",
            "maxLength":"255",
            "minLength":"1",
            "type":"string"
        },
        "compartmentId":{
            "description":"The OCID of the compartment that contains the boot volume.",
            "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.",
                "type":"object",
                "additionalProperties":{
                    "description":"The value of the tag. Only the String type is supported.",
                    "type":"object"
                }
            }
        },
        "systemTags":{
            "description":"System 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.",
                "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"
            }
        },
        "id":{
            "description":"The boot volume's OCID.",
            "maxLength":"255",
            "minLength":"1",
            "type":"string"
        },
        "imageId":{
            "description":"The image OCID used to create the boot volume.",
            "maxLength":"255",
            "minLength":"1",
            "type":"string"
        },
        "isHydrated":{
            "description":"Specifies whether the boot volume's data has finished copying from the source boot volume or boot volume backup.",
            "type":"boolean"
        },
        "vpusPerGB":{
            "description":"The number of volume performance units (VPUs) that will be applied to this boot volume per GB, representing the Block Volume service's elastic performance options. Allowed values are: 10 - Balanced option. 20 - Higher Performance option.",
            "format":"int64",
            "type":"integer"
        },
        "lifecycleState":{
            "description":"The current state of a boot volume.",
            "enum":[
                "PROVISIONING",
                "RESTORING",
                "AVAILABLE",
                "TERMINATING",
                "TERMINATED",
                "FAULTY"
            ],
            "type":"string"
        },
        "sizeInGBs":{
            "description":"The size of the boot volume in GBs.",
            "format":"int64",
            "type":"integer"
        },
        "sizeInMBs":{
            "description":"The size of the volume in MBs. The value must be a multiple of 1024. This field is deprecated. Please use sizeInGBs.",
            "format":"int64",
            "type":"integer"
        },
        "sourceDetails":{
            "$ref":"#/definitions/BootVolumeSourceDetails"
        },
        "timeCreated":{
            "description":"The date and time the boot volume was created. Format defined by [RFC3339](https://tools.ietf.org/html/rfc3339).",
            "format":"date-time",
            "type":"string"
        },
        "volumeGroupId":{
            "description":"The OCID of the source volume group.",
            "maxLength":"255",
            "minLength":"1",
            "type":"string"
        },
        "kmsKeyId":{
            "description":"The OCID of the Key Management master encryption key assigned to the boot volume.",
            "maxLength":"255",
            "minLength":"1",
            "type":"string"
        },
        "isAutoTuneEnabled":{
            "description":"Specifies whether the auto-tune performance is enabled for this boot volume. This field is deprecated. Use the DetachedVolumeAutotunePolicy instead to enable the volume for detached autotune.",
            "type":"boolean"
        },
        "autoTunedVpusPerGB":{
            "description":"The number of Volume Performance Units per GB that this boot volume is effectively tuned to.",
            "format":"int64",
            "type":"integer"
        },
        "bootVolumeReplicas":{
            "description":"The list of boot volume replicas of this boot volume",
            "items":{
                "$ref":"#/definitions/BootVolumeReplicaInfo"
            },
            "type":"array"
        },
        "autotunePolicies":{
            "description":"The list of autotune policies enabled for this volume.",
            "items":{
                "$ref":"#/definitions/AutotunePolicy"
            },
            "type":"array",
            "uniqueItems":true
        }
    },
    "required":[
        "id",
        "availabilityDomain",
        "sizeInMBs",
        "compartmentId",
        "timeCreated",
        "lifecycleState"
    ],
    "type":"object"
}

Nested Schema : autotunePolicies

Type: array

Unique Items Required: true

The list of autotune policies enabled for this volume.

Show Source

• Array of: object AutotunePolicy
  Discriminator: autotuneType

  An autotune policy automatically tunes the volume's performace based on the type of the policy.

{
    "description":"The list of autotune policies enabled for this volume.",
    "items":{
        "$ref":"#/definitions/AutotunePolicy"
    },
    "type":"array",
    "uniqueItems":true
}

Nested Schema : bootVolumeReplicas

Type: array

The list of boot volume replicas of this boot volume

Show Source

• Array of: object BootVolumeReplicaInfo
  Information about the boot volume replica in the destination availability domain.

{
    "description":"The list of boot volume replicas of this boot volume",
    "items":{
        "$ref":"#/definitions/BootVolumeReplicaInfo"
    },
    "type":"array"
}

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.

{
    "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.",
        "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 : BootVolumeSourceDetails

Type: object

Discriminator: type

Show Source

• type(required): string

{
    "discriminator":"type",
    "properties":{
        "type":{
            "type":"string"
        }
    },
    "required":[
        "type"
    ],
    "type":"object"
}

Nested Schema : systemTags

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.

{
    "description":"System 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.",
        "type":"object",
        "additionalProperties":{
            "description":"The value of the tag. Only the String type is supported.",
            "type":"object"
        }
    }
}

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

Nested Schema : AutotunePolicy

Type: object

Discriminator: autotuneType

An autotune policy automatically tunes the volume's performace based on the type of the policy.

Show Source

• autotuneType(required): string
  Allowed Values: [ "DETACHED_VOLUME", "PERFORMANCE_BASED" ]

  This specifies the type of autotunes supported by OCI.

{
    "description":"An autotune policy automatically tunes the volume's performace based on the type of the policy.",
    "discriminator":"autotuneType",
    "properties":{
        "autotuneType":{
            "description":"This specifies the type of autotunes supported by OCI.",
            "type":"string",
            "enum":[
                "DETACHED_VOLUME",
                "PERFORMANCE_BASED"
            ]
        }
    },
    "required":[
        "autotuneType"
    ],
    "type":"object"
}

Nested Schema : BootVolumeReplicaInfo

Type: object

Information about the boot volume replica in the destination availability domain.

Show Source

• availabilityDomain(required): string
  Minimum Length: 1

  Maximum Length: 255

  The availability domain of the boot volume replica. Example: AD-1
• bootVolumeReplicaId(required): string
  Minimum Length: 1

  Maximum Length: 255

  The boot volume replica's OCID.
• displayName(required): 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.

{
    "description":"Information about the boot volume replica in the destination availability domain.",
    "properties":{
        "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"
        },
        "bootVolumeReplicaId":{
            "description":"The boot volume replica's OCID.",
            "maxLength":"255",
            "minLength":"1",
            "type":"string"
        },
        "availabilityDomain":{
            "description":"The availability domain of the boot volume replica. Example: AD-1 ",
            "maxLength":"255",
            "minLength":"1",
            "type":"string"
        }
    },
    "required":[
        "bootVolumeReplicaId",
        "availabilityDomain",
        "displayName"
    ],
    "type":"object"
}

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.",
    "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.

Nested Schema : additionalProperties

Type: object

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

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.",
    "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.

Nested Schema : additionalProperties

Type: object

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

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

409 Response

Conflict

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