Jump to

• Request
• Response

UpdateNamespaceMetadata

put

/n/{namespace_name}

By default, buckets created using the Amazon S3 Compatibility API or the Swift API are created in the root compartment of the tenancy. You can change the default Swift/Amazon S3 compartmentId designation to a different compartmentId. All subsequent bucket creations will use the new default compartment, but no previously created buckets will be modified. This operation requires OBJECTSTORAGE_NAMESPACE_UPDATE permission to make changes to the default compartments for Amazon S3 and Swift.

Request

Supported Media Types

• application/json

Path Parameters

• namespaceName(required): string
  Minimum Length: 1

  Pattern: [A-Za-z][A-Za-z0-9\\-_\\.]+

  The Object Storage namespace used for the request.

Header Parameters

• opc-client-request-id: string
  The client request ID for tracing.

Body ()

Request object for update NamespaceMetadata.

Root Schema : UpdateNamespaceMetadataDetails

Type: object

UpdateNamespaceMetadataDetails is used to update the NamespaceMetadata. To update NamespaceMetadata, a user must have OBJECTSTORAGE_NAMESPACE_UPDATE permission.

Show Source

• defaultS3CompartmentId: string
  The updated compartment id for use by an S3 client, if this field is set.
• defaultSwiftCompartmentId: string
  The updated compartment id for use by a Swift client, if this field is set.

{
    "description":"UpdateNamespaceMetadataDetails is used to update the NamespaceMetadata. To update NamespaceMetadata, a user must have OBJECTSTORAGE_NAMESPACE_UPDATE permission. ",
    "properties":{
        "defaultS3CompartmentId":{
            "type":"string",
            "description":"The updated compartment id for use by an S3 client, if this field is set."
        },
        "defaultSwiftCompartmentId":{
            "type":"string",
            "description":"The updated compartment id for use by a Swift client, if this field is set."
        }
    },
    "type":"object"
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

The updated NamespaceMetadata information.

Headers

• opc-client-request-id: string
  Echoes back the value passed in the opc-client-request-id header, for use by clients when debugging.
• 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 : NamespaceMetadata

Type: object

NamespaceMetadata maps a namespace string to defaultS3CompartmentId and defaultSwiftCompartmentId values.

Show Source

• defaultS3CompartmentId(required): string
  If the field is set, specifies the default compartment assignment for the Amazon S3 Compatibility API.
• defaultSwiftCompartmentId(required): string
  If the field is set, specifies the default compartment assignment for the Swift API.
• namespace(required): string
  The Object Storage namespace to which the metadata belongs.

{
    "description":"NamespaceMetadata maps a namespace string to defaultS3CompartmentId and defaultSwiftCompartmentId values. ",
    "required":[
        "namespace",
        "defaultS3CompartmentId",
        "defaultSwiftCompartmentId"
    ],
    "properties":{
        "namespace":{
            "type":"string",
            "description":"The Object Storage namespace to which the metadata belongs."
        },
        "defaultS3CompartmentId":{
            "type":"string",
            "description":"If the field is set, specifies the default compartment assignment for the Amazon S3 Compatibility API."
        },
        "defaultSwiftCompartmentId":{
            "type":"string",
            "description":"If the field is set, specifies the default compartment assignment for the Swift API."
        }
    },
    "type":"object"
}

Example Response (application-json)

{   "name": "ansh8lvru1zp",   "defaultS3CompartmentId": "ocid1.compartment.unique_ID",   "defaultSwiftCompartmentId": "ocid1.compartment.unique_ID" } 

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

408 Response

Request Timeout

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

429 Response

Too Many Requests

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