namespaces
Creates, updates, deletes, gets or lists a namespaces resource.
Overview​
| Name | namespaces |
| Type | Resource |
| Id | oci.object_storage.namespaces |
Fields​
The following fields are returned by SELECT queries:
- get
| Name | Datatype | Description |
|---|---|---|
namespace | string | The Object Storage namespace of the tenancy (top-level bucket container). |
Methods​
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
get | select | region | opc-client-request-id, compartmentId | Each Oracle Cloud Infrastructure tenant is assigned one unique and uneditable Object Storage namespace. The namespace<br />is a system-generated string assigned during account creation. For some older tenancies, the namespace string may be<br />the tenancy name in all lower-case letters. You cannot edit a namespace.<br /><br />GetNamespace returns the name of the Object Storage namespace for the user making the request.<br />If an optional compartmentId query parameter is provided, GetNamespace returns the namespace name of the corresponding<br />tenancy, provided the user has access to it.<br /> |
Parameters​
Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.
| Name | Datatype | Description |
|---|---|---|
region | string | OCI region identifier (e.g. us-ashburn-1, ap-sydney-1); resolves from OCI_REGION when not supplied in the query. (default: us-ashburn-1, x-stackQL-envVar: OCI_REGION) |
compartmentId | string | This is an optional field representing either the tenancy [OCID](/Content/General/Concepts/identifiers.htm) or the compartment [OCID](/Content/General/Concepts/identifiers.htm) within the tenancy whose Object Storage namespace is to be retrieved. |
opc-client-request-id | string | The client request ID for tracing. |
SELECT examples​
- get
Each Oracle Cloud Infrastructure tenant is assigned one unique and uneditable Object Storage namespace. The namespace<br />is a system-generated string assigned during account creation. For some older tenancies, the namespace string may be<br />the tenancy name in all lower-case letters. You cannot edit a namespace.<br /><br />GetNamespace returns the name of the Object Storage namespace for the user making the request.<br />If an optional compartmentId query parameter is provided, GetNamespace returns the namespace name of the corresponding<br />tenancy, provided the user has access to it.<br />
SELECT
namespace
FROM oci.object_storage.namespaces
WHERE region = '{{ region }}' -- required
AND opc-client-request-id = '{{ opc-client-request-id }}'
AND compartmentId = '{{ compartmentId }}'
;