Jump to

• Request
• Response

GetBlockVolumeReplica

get

/20160918/blockVolumeReplicas/{block_volume_replica_id}

Gets information for the specified block volume replica.

Request

Supported Media Types

• application/json

Path Parameters

• blockVolumeReplicaId(required): string
  The OCID of the block volume replica.

Back to Top

Response

Supported Media Types

• application/json

200 Response

The block volume replica's information has been retrieved.

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

Type: object

An asynchronous replica of a block volume that can then be used to create a new block volume or recover a block volume. For more information, see [Overview of Cross-Region Volume Replication](/iaas/Content/Block/Concepts/volumereplication.htm) To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, talk to an administrator. If you're an administrator who needs to write policies to give users access, see [Getting Started with Policies](/iaas/Content/Identity/Concepts/policygetstarted.htm). **Warning:** Oracle recommends that you avoid using any 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 block volume replica. Example: `Uocm:PHX-AD-1`
• blockVolumeId(required): string
  Minimum Length: 1

  Maximum Length: 255

  The OCID of the source block volume.
• compartmentId(required): string
  Minimum Length: 1

  Maximum Length: 255

  The OCID of the compartment that contains the block volume replica.
• 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 block volume replica's Oracle ID (OCID).
• ioAlignmentSizeInBytes: integer(int32)
  Minimum Value: 512

  Maximum Value: 32768

  Multiple Of: 512

  The size (in Bytes) of the blocks for this block volume, between 512B to 32KB.
• 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, see [Overview of Vault service](/iaas/Content/KeyManagement/Concepts/keyoverview.htm) and [Using Keys](/iaas/Content/KeyManagement/Tasks/usingkeys.htm).
• lifecycleState(required): string
  Allowed Values: [ "PROVISIONING", "AVAILABLE", "ACTIVATING", "TERMINATING", "TERMINATED", "FAULTY" ]

  The current state of a block volume replica.
• sizeInGBs(required): integer(int64)
  Minimum Value: 1

  Maximum Value: 16384

  The size of the source block volume, in GBs.
• timeCreated(required): string(date-time)
  The date and time the block volume replica was created. Format defined by [RFC3339](https://tools.ietf.org/html/rfc3339).
• timeLastSynced(required): string(date-time)
  The date and time the block volume replica was last synced from the source block volume. Format defined by [RFC3339](https://tools.ietf.org/html/rfc3339).
• totalDataTransferredInGBs: integer(int64)
  The total size of the data transferred from the source block volume to the block volume replica, in GBs.
• volumeGroupReplicaId: string
  Minimum Length: 1

  Maximum Length: 255

  The OCID of the volume group replica.

{
    "description":"An asynchronous replica of a block volume that can then be used to create a new block volume or recover a block volume. For more information, see [Overview of Cross-Region Volume Replication](/iaas/Content/Block/Concepts/volumereplication.htm) To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, talk to an administrator. If you're an administrator who needs to write policies to give users access, see [Getting Started with Policies](/iaas/Content/Identity/Concepts/policygetstarted.htm).  **Warning:** Oracle recommends that you avoid using any confidential information when you supply string values using the API. ",
    "properties":{
        "availabilityDomain":{
            "description":"The availability domain of the block volume replica.  Example: `Uocm:PHX-AD-1` ",
            "maxLength":255,
            "minLength":1,
            "type":"string"
        },
        "compartmentId":{
            "description":"The OCID of the compartment that contains the block volume replica.",
            "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 block volume replica's Oracle ID (OCID).",
            "maxLength":255,
            "minLength":1,
            "type":"string"
        },
        "lifecycleState":{
            "description":"The current state of a block volume replica.",
            "enum":[
                "PROVISIONING",
                "AVAILABLE",
                "ACTIVATING",
                "TERMINATING",
                "TERMINATED",
                "FAULTY"
            ],
            "type":"string"
        },
        "ioAlignmentSizeInBytes":{
            "description":"The size (in Bytes) of the blocks for this block volume, between 512B to 32KB. ",
            "minimum":512,
            "maximum":32768,
            "multipleOf":512,
            "format":"int32",
            "type":"integer"
        },
        "sizeInGBs":{
            "description":"The size of the source block volume, in GBs. ",
            "format":"int64",
            "maximum":16384,
            "minimum":1,
            "type":"integer"
        },
        "timeCreated":{
            "description":"The date and time the block volume replica was created. Format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). ",
            "format":"date-time",
            "type":"string"
        },
        "timeLastSynced":{
            "description":"The date and time the block volume replica was last synced from the source block volume. Format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). ",
            "format":"date-time",
            "type":"string"
        },
        "blockVolumeId":{
            "type":"string",
            "description":"The OCID of the source block volume.",
            "minLength":1,
            "maxLength":255
        },
        "totalDataTransferredInGBs":{
            "description":"The total size of the data transferred from the source block volume to the block volume replica, in GBs. ",
            "format":"int64",
            "type":"integer"
        },
        "volumeGroupReplicaId":{
            "description":"The OCID of the volume group replica. ",
            "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, see [Overview of Vault service](/iaas/Content/KeyManagement/Concepts/keyoverview.htm) and [Using Keys](/iaas/Content/KeyManagement/Tasks/usingkeys.htm). ",
            "type":"string",
            "maxLength":255,
            "minLength":1
        }
    },
    "required":[
        "id",
        "availabilityDomain",
        "sizeInGBs",
        "compartmentId",
        "displayName",
        "timeCreated",
        "lifecycleState",
        "timeLastSynced",
        "blockVolumeId"
    ],
    "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 : 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.

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

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