GetNamespaceMetadata
get
/n/{namespace_name}
Get the metadata for the Object Storage namespace. The namespace metadata contains defaultS3CompartmentId and defaultSwiftCompartmentId. This operation requires the OBJECTSTORAGE_NAMESPACE_READ permission. If you are not authorized, talk to an administrator. If you are an administrator who needs to write policies to give users access, see "Managing Policies" (https://docs.oracle.com/en/engineered-systems/private-cloud-appliance/3.0-latest/user/user-usr-manage-policies.html).
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.
Response
Supported Media Types
- application/json
200 Response
The default metadata.
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.
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.
Example Response (application-json)
[ { "namespace": "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.
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
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.
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
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.
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
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.
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
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.
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
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.
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
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.
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