REST API for Oracle Cloud Infrastructure Compute Classic

Update an Oracle Cloud Infrastructure Object Storage Classic Container

put

/integrations/osscontainer/{name}

You can modify only the value of the delete_remote attribute of the OSS container. The delete_remote attribute defines whether the remote storage container and its objects will be deleted when the local OSS container object is deleted. Updates the specified local OSS container object in Compute Classic. This request does not impact the remote Oracle Cloud Infrastructure Object Storage Classic container.

Prerequisite: Ensure that you have selected a replication policy for your Oracle Cloud Infrastructure Object Storage Classic instance. See Selecting a Replication Policy for Your Service Instance in Using Oracle Cloud Infrastructure Object Storage Classic.

Required Role: To complete this task, you must have the Compute_Operations role. If this role isn't assigned to you or you're not sure, then ask your system administrator to ensure that the role is assigned to you in Oracle Cloud My Services. See Modifying User Roles in Managing and Monitoring Oracle Cloud.

Request

Supported Media Types

application/oracle-compute-v3+json

Path Parameters

name: string

The three-part name of the object (/Compute-identity_domain/user/object).

Header Parameters

Cookie: string

The Cookie: header must be included with every request to the service. It must be set to the value of the set-cookie header in the response received to the POST /authenticate/ call.

The request body contains details of the Oracle Cloud Infrastructure Object Storage Classic container that you want to update.

Root Schema : OSSContainer-put-request

Type: object

The request body contains details of the Oracle Cloud Infrastructure Object Storage Classic container that you want to update.

Show Source

account: string

The two-part name of the account (/Compute-identity_domain/cloud_storage) that contains the credentials and access details of the associated Oracle Cloud Infrastructure Object Storage Classic instance.
delete_remote: boolean

Determines whether the contents of the Oracle Cloud Infrastructure Object Storage Classic container is also deleted when you delete the integrations/osscontainer object.
When set to true, deletes the Oracle Cloud Infrastructure Object Storage Classic container along with all the objects in the container when you delete the integration/osscontainer object created by this orchestration.
When set to false, only the integrations/osscontainer object created by this orchestration is deleted.

{
    "required":[
        "account",
        "delete_remote"
    ],
    "description":"The request body contains details of the Oracle Cloud Infrastructure Object Storage Classic container that you want to update. ",
    "properties":{
        "account":{
            "type":"string",
            "description":"The two-part name of the account (/Compute-identity_domain/cloud_storage) that contains the credentials and access details of the associated Oracle Cloud Infrastructure Object Storage Classic instance."
        },
        "delete_remote":{
            "type":"boolean",
            "description":"Determines whether the contents of the Oracle Cloud Infrastructure Object Storage Classic container is also deleted when you delete the <code>integrations/osscontainer</code> object.<p>When set to <code>true</code>, deletes the Oracle Cloud Infrastructure Object Storage Classic container along with all the objects in the container when you delete the integration/osscontainer object created by this orchestration.<p>When set to <code>false</code>, only the integrations/osscontainer object created by this orchestration is deleted."
        }
    }
}

Response

Supported Media Types

application/oracle-compute-v3+json

200 Response

OK. See Status Codes for information about other possible HTTP status codes.

Headers

set-cookie: string

The cookie value is returned if the session is extended

Root Schema : OSSContainer-response

Type: object

Show Source

account(optional): string

The two-part name of the account (/Compute-identity_domain/cloud_storage) that contains the credentials and access details of the associated Oracle Cloud Infrastructure Object Storage Classic instance.
container(optional): string

The name of the container.
creation_time(optional): string

Provides the time when the OSS container was created.
delete_remote(optional): boolean

When set to true, deletes the Oracle Cloud Infrastructure Object Storage Classic container along with all the objects in the container when you delete the integration/osscontainer object created by this orchestration. When set to false, only the integrations/osscontainer object created by this orchestration is deleted. By default, this option is set to true.
deletion_progress(optional): string

If delete operation is being carried out, this attribute indicates the current progress of the delete operation. Ignore this attribute value for other operations.
error_reason(optional): string

Describes the cause for the OSS container object to go into error state.
georeplication_details(optional): object georeplication_details

Additional Properties Allowed: additionalProperties

Details applying to the georeplication policy
georeplication_policy(optional): string

Optional georeplication policy string
modification_time(optional): string

Time when the OSS container object was last updated.
name(optional): string

Multipart name of the object.
state(optional): string

Current state of the OSS container object. If the object is in the error state, look at error_reason to identify the cause of this error.
uri(optional): string

Uniform Resource Identifier.

{
    "properties":{
        "account":{
            "type":"string",
            "description":"The two-part name of the account (<code>/Compute-<i>identity_domain</i>/cloud_storage</code>) that contains the credentials and access details of the associated Oracle Cloud Infrastructure Object Storage Classic instance."
        },
        "container":{
            "type":"string",
            "description":"The name of the container."
        },
        "creation_time":{
            "type":"string",
            "description":"Provides the time when the OSS container was created."
        },
        "delete_remote":{
            "type":"boolean",
            "description":"When set to <code>true</code>, deletes the Oracle Cloud Infrastructure Object Storage Classic container along with all the objects in the container when you delete the integration/osscontainer object created by this orchestration. When set to <code>false</code>, only the integrations/osscontainer object created by this orchestration is deleted. By default, this option is set to <code>true</code>."
        },
        "deletion_progress":{
            "type":"string",
            "description":"If delete operation is being carried out, this attribute indicates the current progress of the delete operation. Ignore this attribute value for other operations."
        },
        "error_reason":{
            "type":"string",
            "description":"Describes the cause for the OSS container object to go into error state."
        },
        "georeplication_details":{
            "additionalProperties":{
                "type":"object"
            },
            "type":"object",
            "description":"Details applying to the georeplication policy"
        },
        "georeplication_policy":{
            "type":"string",
            "description":"Optional georeplication policy string"
        },
        "modification_time":{
            "type":"string",
            "description":"Time when the OSS container object was last updated."
        },
        "name":{
            "type":"string",
            "description":"Multipart name of the object."
        },
        "state":{
            "type":"string",
            "description":"Current state of the OSS container object. If the object is in the <code>error</code> state, look at <code>error_reason</code> to identify the cause of this error."
        },
        "uri":{
            "type":"string",
            "description":"Uniform Resource Identifier."
        }
    }
}

Nested Schema : georeplication_details

Type: object

Additional Properties Allowed

Show Source

object additionalProperties

{
    "additionalProperties":{
        "type":"object"
    },
    "type":"object",
    "description":"Details applying to the georeplication policy"
}

Details applying to the georeplication policy

Nested Schema : additionalProperties

Type: object

Examples

cURL Command

The following example shows how to update an OSS container, /Compute-acme/jack.jones@example.com/container1, by submitting a PUT request on the REST resource using cURL. For more information about cURL, see Use cURL.

Enter the command on a single line. Line breaks are used in this example for readability.

curl -i -X PUT
     -H "Cookie: $COMPUTE_COOKIE"
     -H "Content-Type: application/oracle-compute-v3+json"
     -H "Accept: application/oracle-compute-v3+json"
     -d "@osscontainer.json"
        https://api-z999.compute.us0.oraclecloud.com/integrations/osscontainer/Compute-acme/jack.jones@example.com/container1

COMPUTE_COOKIE is the name of the variable in which you stored the authentication cookie earlier. For information about retrieving the authentication cookie and storing it in a variable, see Authentication.
api-z999.compute.us0.oraclecloud.com is an example REST endpoint URL. Change this value to the REST endpoint URL of your Compute Classic site. For information about finding out REST endpoint URL for your site, see Send Requests.
acme and jack.jones@example.com are example values. Replace acme with the identity domain ID of your Compute Classic account, and jack.jones@example.com with your user name.

Example of Request Body

The following shows an example of the request body content in the osscontainer.json file to update value of the delete_remote parameter to false for an Oracle Cloud Infrastructure Object Storage Classic container.

{
  "account": "/Compute-acme/cloud_storage",
  "delete_remote": false
}

Example of Response Body

The following example shows the response body in JSON format when you update value of the delete_remote parameter to false for an Oracle Cloud Infrastructure Object Storage Classic container.

{
  "account": "/Compute-acme/cloud_storage",
  "delete_remote": false,
  "container": "container1",
  "georeplication": "us2",
  "modification_time": "2016-12-23T09:36:41Z",
  "creation_time": "2016-12-23T09:36:41Z",
  "uri": "https://api-z999.compute.us0.oraclecloud.com/integrations/osscontainer/Compute-acme/jack.jones@example.com/container1",
  "deletion_progress": "",
  "state": "created",
  "error_reason": "",
  "name": "/Compute-acme/jack.jones@example.com/container1"
}