Jump to

• Request
• Response

Create a Volume Group

post

/20160918/volumeGroups

Create a new volume group in the specified compartment. A volume group is a collection of volumes and may be created from a list of volumes, cloning an existing volume group, or by restoring a volume group backup.

You may optionally specify a display name for the volume group. 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 volume group.

Root Schema : CreateVolumeGroupDetails

Type: object

Show Source

• availabilityDomain(required): string
  Minimum Length: 1

  Maximum Length: 255

  The availability domain of the volume group.
• backupPolicyId: string
  Minimum Length: 1

  Maximum Length: 255

  Specifies the OCID of the volume backup policy to assign to the newly created volume group. If omitted, no policy will be assigned.
• clusterPlacementGroupId: string
  Minimum Length: 1

  Maximum Length: 255

  The clusterPlacementGroup ID of the volume group for volume group placement.
• compartmentId(required): string
  Minimum Length: 1

  Maximum Length: 255

  The OCID of the compartment that contains the volume group.
• 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"}
• sourceDetails(required): object VolumeGroupSourceDetails
  Discriminator: type

  Specifies the source for a volume group.
• volumeGroupReplicas: array volumeGroupReplicas
  Maximum Number of Items: 1

  Unique Items Required: true

  The list of volume group replicas that this volume group will be enabled to have in the specified destination availability domains.
• volumeGroupScope: string
  Indicates whether the volume group is AD-local or Regional. Regional volume groups aren't restricted to any availability domain unlike AD-local volume groups. This is an optional field. The default behavior is to create AD_LOCAL volume groups.
• xrcKmsKeyId: string
  Minimum Length: 1

  Maximum Length: 255

  The OCID of the Vault service key which is the master encryption key for the volume's cross region backups, which will be used in the destination region to encrypt the backup's encryption keys.

{
    "properties":{
        "availabilityDomain":{
            "description":"The availability domain of the volume group.",
            "maxLength":255,
            "minLength":1,
            "type":"string"
        },
        "backupPolicyId":{
            "description":"Specifies the OCID of the volume backup policy to assign to the newly created volume group. If omitted, no policy will be assigned.",
            "maxLength":255,
            "minLength":1,
            "type":"string"
        },
        "compartmentId":{
            "description":"The OCID of the compartment that contains the volume group.",
            "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"
            }
        },
        "sourceDetails":{
            "$ref":"#/definitions/VolumeGroupSourceDetails"
        },
        "volumeGroupReplicas":{
            "description":"The list of volume group replicas that this volume group will be enabled to have in the specified destination availability domains.",
            "items":{
                "$ref":"#/definitions/VolumeGroupReplicaDetails"
            },
            "type":"array",
            "uniqueItems":true,
            "maxItems":1
        },
        "clusterPlacementGroupId":{
            "description":"The clusterPlacementGroup ID of the volume group for volume group placement.",
            "maxLength":255,
            "minLength":1,
            "type":"string"
        },
        "volumeGroupScope":{
            "description":"Indicates whether the volume group is AD-local or Regional. Regional volume groups aren't restricted to any availability domain unlike AD-local volume groups. This is an optional field. The default behavior is to create AD_LOCAL volume groups. ",
            "type":"string",
            "x-obmcs-enumref":"#/definitions/VolumeGroup/volumeGroupScope"
        },
        "xrcKmsKeyId":{
            "description":"The OCID of the Vault service key which is the master encryption key for the volume's cross region backups, which will be used in the destination region to encrypt the backup's encryption keys.",
            "type":"string",
            "maxLength":255,
            "minLength":1
        }
    },
    "required":[
        "availabilityDomain",
        "compartmentId",
        "sourceDetails"
    ],
    "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 : VolumeGroupSourceDetails

Type: object

Discriminator: type

Specifies the source for a volume group.

Show Source

• type(required): string

{
    "description":"Specifies the source for a volume group.",
    "discriminator":"type",
    "properties":{
        "type":{
            "type":"string"
        }
    },
    "required":[
        "type"
    ],
    "type":"object"
}

Nested Schema : volumeGroupReplicas

Type: array

Maximum Number of Items: 1

Unique Items Required: true

The list of volume group replicas that this volume group will be enabled to have in the specified destination availability domains.

Show Source

• Array of: object VolumeGroupReplicaDetails
  Contains the details for the volume group replica.

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

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 : VolumeGroupReplicaDetails

Type: object

Contains the details for the volume group replica.

Show Source

• availabilityDomain(required): string
  Minimum Length: 1

  Maximum Length: 255

  The availability domain of the volume group 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.
• xrrKmsKeyId: string
  Minimum Length: 1

  Maximum Length: 255

  The OCID of the Vault service key which is the master encryption key for the cross region volume group's replicas, which will be used in the destination region to encrypt the volume group's replicas encryption keys.

{
    "description":"Contains the details for the volume group 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 volume group replica. Example: AD-1 ",
            "maxLength":255,
            "minLength":1,
            "type":"string"
        },
        "xrrKmsKeyId":{
            "description":"The OCID of the Vault service key which is the master encryption key for the cross region volume group's replicas, which will be used in the destination region to encrypt the volume group's replicas encryption keys.",
            "type":"string",
            "maxLength":255,
            "minLength":1
        }
    },
    "required":[
        "availabilityDomain"
    ],
    "type":"object"
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

The volume group is being created.

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 : VolumeGroup

Type: object

Specifies a volume group, which is a collection of volumes. Avoid entering confidential information when you supply string values using the API.

Show Source

• availabilityDomain(required): string
  Minimum Length: 1

  Maximum Length: 255

  The availability domain of the volume group.
• compartmentId(required): string
  Minimum Length: 1

  Maximum Length: 255

  The OCID of the compartment that contains the volume group.
• definedTags: object definedTags
  Additional Properties Allowed: additionalProperties

  Defined tags for this resource. Each key is predefined and scoped to a namespace.
• 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.
• 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 for the volume group.
• isHydrated: boolean
  Specifies whether the newly created cloned volume group's data has finished copying from the source volume group or backup.
• lifecycleState(required): string
  Allowed Values: [ "PROVISIONING", "AVAILABLE", "TERMINATING", "TERMINATED", "FAULTY", "UPDATE_PENDING" ]

  The current state of a volume group.
• sizeInGBs: integer(int64)
  The aggregate size of the volume group in GBs.
• sizeInMBs(required): integer(int64)
  The aggregate size of the volume group in MBs.
• sourceDetails: object VolumeGroupSourceDetails
  Discriminator: type

  Specifies the source for a volume group.
• timeCreated(required): string(date-time)
  The date and time the volume group was created. Format defined by [RFC 3339](https://tools.ietf.org/html/rfc3339).
• volumeGroupReplicas: array volumeGroupReplicas
  The list of volume group replicas of this volume group.
• volumeGroupScope: string
  Default Value: AD_LOCAL

  Allowed Values: [ "REGIONAL", "AD_LOCAL" ]

  The scope of the volume group
• volumeIds(required): array volumeIds
  Maximum Number of Items: 64

  OCIDs for the volumes in this volume group.

{
    "description":"Specifies a volume group, which is a collection of volumes. Avoid entering confidential information when you supply string values using the API.",
    "x-obmcs-splat":{
        "resourceKind":"volume-groups",
        "adLocality":"ad-local",
        "getOperationId":"GetVolumeGroup",
        "ocidEntityType":"volumegroup",
        "activeLifecycleStates":[
            "AVAILABLE"
        ],
        "deletedLifecycleStates":[
            "TERMINATED",
            "FAULTY"
        ],
        "searchMetadata":{
            "resourceSchemaVersion":1,
            "resourceType":"VolumeGroup",
            "scope":"customer"
        }
    },
    "properties":{
        "availabilityDomain":{
            "description":"The availability domain of the volume group.",
            "maxLength":255,
            "minLength":1,
            "type":"string"
        },
        "compartmentId":{
            "description":"The OCID of the compartment that contains the volume group.",
            "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"
            }
        },
        "id":{
            "description":"The OCID for the volume group.",
            "maxLength":255,
            "minLength":1,
            "type":"string"
        },
        "lifecycleState":{
            "description":"The current state of a volume group.",
            "enum":[
                "PROVISIONING",
                "AVAILABLE",
                "TERMINATING",
                "TERMINATED",
                "FAULTY",
                "UPDATE_PENDING"
            ],
            "type":"string"
        },
        "sizeInMBs":{
            "description":"The aggregate size of the volume group in MBs.",
            "format":"int64",
            "type":"integer"
        },
        "sizeInGBs":{
            "description":"The aggregate size of the volume group in GBs.",
            "format":"int64",
            "type":"integer"
        },
        "sourceDetails":{
            "$ref":"#/definitions/VolumeGroupSourceDetails"
        },
        "timeCreated":{
            "description":"The date and time the volume group was created. Format defined by [RFC 3339](https://tools.ietf.org/html/rfc3339).",
            "format":"date-time",
            "type":"string"
        },
        "volumeIds":{
            "description":"OCIDs for the volumes in this volume group.",
            "items":{
                "maxLength":255,
                "minLength":1,
                "type":"string"
            },
            "maxItems":64,
            "type":"array"
        },
        "isHydrated":{
            "description":"Specifies whether the newly created cloned volume group's data has finished copying from the source volume group or backup.",
            "type":"boolean"
        },
        "volumeGroupReplicas":{
            "description":"The list of volume group replicas of this volume group.",
            "items":{
                "$ref":"#/definitions/VolumeGroupReplicaInfo"
            },
            "type":"array"
        },
        "volumeGroupScope":{
            "description":"The scope of the volume group",
            "enum":[
                "REGIONAL",
                "AD_LOCAL"
            ],
            "type":"string",
            "default":"AD_LOCAL"
        }
    },
    "required":[
        "id",
        "volumeIds",
        "availabilityDomain",
        "displayName",
        "sizeInMBs",
        "compartmentId",
        "timeCreated",
        "lifecycleState"
    ],
    "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 : VolumeGroupSourceDetails

Type: object

Discriminator: type

Specifies the source for a volume group.

Show Source

• type(required): string

{
    "description":"Specifies the source for a volume group.",
    "discriminator":"type",
    "properties":{
        "type":{
            "type":"string"
        }
    },
    "required":[
        "type"
    ],
    "type":"object"
}

Nested Schema : volumeGroupReplicas

Type: array

The list of volume group replicas of this volume group.

Show Source

• Array of: object VolumeGroupReplicaInfo
  Information about the volume group replica in the destination availability domain.

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

Nested Schema : volumeIds

Type: array

Maximum Number of Items: 64

OCIDs for the volumes in this volume group.

Show Source

• Array of: string
  Minimum Length: 1

  Maximum Length: 255

{
    "description":"OCIDs for the volumes in this volume group.",
    "items":{
        "maxLength":255,
        "minLength":1,
        "type":"string"
    },
    "maxItems":64,
    "type":"array"
}

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 : VolumeGroupReplicaInfo

Type: object

Information about the volume group 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 replica. Example: AD-1
• 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.
• kmsKeyId: string
  Minimum Length: 1

  Maximum Length: 255

  The OCID of the Vault service key to assign as the master encryption key for the block volume replica.
• volumeGroupReplicaId(required): string
  Minimum Length: 1

  Maximum Length: 255

  The volume group replica's OCID.

{
    "description":"Information about the volume group 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"
        },
        "volumeGroupReplicaId":{
            "description":"The volume group replica's OCID.",
            "maxLength":255,
            "minLength":1,
            "type":"string"
        },
        "availabilityDomain":{
            "description":"The availability domain of the boot volume replica replica. Example: AD-1 ",
            "maxLength":255,
            "minLength":1,
            "type":"string"
        },
        "kmsKeyId":{
            "description":"The OCID of the Vault service key to assign as the master encryption key for the block volume replica.",
            "type":"string",
            "maxLength":255,
            "minLength":1
        }
    },
    "required":[
        "volumeGroupReplicaId",
        "availabilityDomain",
        "displayName"
    ],
    "type":"object"
}

400 Response

Bad Request

Headers

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

Body ()

Root Schema : Error

Type: object

The properties that define an error.

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing. See [API Errors](https://docs.us-phoenix-1.oraclecloud.com/Content/API/References/apierrors.htm).
• message(required): string
  A human-readable error string.

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

401 Response

Unauthorized

Headers

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

Body ()

Root Schema : Error

Type: object

The properties that define an error.

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing. See [API Errors](https://docs.us-phoenix-1.oraclecloud.com/Content/API/References/apierrors.htm).
• message(required): string
  A human-readable error string.

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

404 Response

Not Found

Headers

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

Body ()

Root Schema : Error

Type: object

The properties that define an error.

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing. See [API Errors](https://docs.us-phoenix-1.oraclecloud.com/Content/API/References/apierrors.htm).
• message(required): string
  A human-readable error string.

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

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

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