REST API for Oracle Private Cloud Appliance Compute Enclave

Create a Tag Namespace

post

/20160918/tagNamespaces

Create a new tag namespace in the specified compartment. Specify the tenancy OCID for the compartment OCID in the request.

Specify a name for the tag namespace, which must be unique across all tag namespaces in your tenancy and cannot be changed. The name can contain any ASCII character except the space character or period (.). Names are case insensitive. For example, "myNamespace" and "mynamespace" are not allowed in the same tenancy. If you specify a name that is already in use in the tenancy, a 409 error is returned.

Specify a description for the namespace. It does not need to be unique, and you can change it.

Request

Supported Media Types

application/json

Header Parameters

opc-retry-token: string

Minimum Length: 1

Maximum Length: 64

A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations (for example, if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected).

Request object for creating a new tag namespace.

Root Schema : CreateTagNamespaceDetails

Type: object

Show Source

compartmentId(required): string

The OCID of the tenancy containing the tag namespace.
definedTags: object definedTags

Additional Properties Allowed: additionalProperties

Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"Operations": {"CostCenter": "42"}}
description(required): string

Minimum Length: 1

Maximum Length: 400

The description you assign to the tag namespace during creation.
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"}
locks: array locks

Maximum Number of Items: 1

Locks associated with this resource.
name(required): string

Minimum Length: 1

Maximum Length: 100

The name you assign to the tag namespace during creation. It must be unique across all tag namespaces in the tenancy and cannot be changed.

{
    "required":[
        "name",
        "compartmentId",
        "description"
    ],
    "properties":{
        "compartmentId":{
            "type":"string",
            "description":"The OCID of the tenancy containing the tag namespace."
        },
        "name":{
            "type":"string",
            "description":"The name you assign to the tag namespace during creation. It must be unique across all tag namespaces in the tenancy and cannot be changed.",
            "minLength":1,
            "maxLength":100
        },
        "description":{
            "type":"string",
            "description":"The description you assign to the tag namespace during creation.",
            "minLength":1,
            "maxLength":400
        },
        "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"
            }
        },
        "definedTags":{
            "type":"object",
            "description":"Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {\"Operations\": {\"CostCenter\": \"42\"}} ",
            "additionalProperties":{
                "type":"object",
                "description":"Key-value pair representing a defined tag key and value, scoped to a namespace.  Example: `{\"CostCenter\": \"42\"}` ",
                "additionalProperties":{
                    "type":"object",
                    "description":"The value of the tag. Only the String type is supported. "
                }
            }
        },
        "locks":{
            "description":"Locks associated with this resource.",
            "type":"array",
            "maxItems":1,
            "items":{
                "$ref":"#/definitions/AddLockDetails"
            }
        }
    },
    "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"}`

{
    "type":"object",
    "description":"Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {\"Operations\": {\"CostCenter\": \"42\"}} ",
    "additionalProperties":{
        "type":"object",
        "description":"Key-value pair representing a defined tag key and value, scoped to a namespace.  Example: `{\"CostCenter\": \"42\"}` ",
        "additionalProperties":{
            "type":"object",
            "description":"The value of the tag. Only the String type is supported. "
        }
    }
}

Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"Operations": {"CostCenter": "42"}}

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

Type: array

Maximum Number of Items: 1

Locks associated with this resource.

Show Source

Array of: object AddLockDetails

Request payload to add lock to the resource.

{
    "description":"Locks associated with this resource.",
    "type":"array",
    "maxItems":1,
    "items":{
        "$ref":"#/definitions/AddLockDetails"
    }
}

Nested Schema : additionalProperties

Type: object

Additional Properties Allowed

Show Source

object additionalProperties

The value of the tag. Only the String type is supported.

{
    "type":"object",
    "description":"Key-value pair representing a defined tag key and value, scoped to a namespace.  Example: `{\"CostCenter\": \"42\"}` ",
    "additionalProperties":{
        "type":"object",
        "description":"The value of the tag. Only the String type is supported. "
    }
}

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.

Nested Schema : AddLockDetails

Type: object

Request payload to add lock to the resource.

Show Source

message: string

A message added by the creator of the lock. This is typically used to give an indication of why the resource is locked.
relatedResourceId: string

The OCID of the resource that is locking this resource. Indicates that deleting this resource will remove the lock.
type(required): string

Allowed Values: [ "FULL", "DELETE" ]

Lock type.

{
    "description":"Request payload to add lock to the resource.",
    "type":"object",
    "required":[
        "type"
    ],
    "properties":{
        "type":{
            "description":"Lock type.",
            "enum":[
                "FULL",
                "DELETE"
            ],
            "type":"string"
        },
        "relatedResourceId":{
            "description":"The OCID of the resource that is locking this resource. Indicates that deleting this resource will remove the lock.",
            "type":"string"
        },
        "message":{
            "description":"A message added by the creator of the lock. This is typically used to give an indication of why the resource is locked.",
            "type":"string"
        }
    }
}

Response

Supported Media Types

application/json

200 Response

The tagNamespace is being created.

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.

Root Schema : TagNamespace

Type: object

A managed container for defined tags. A tag namespace is unique in a tenancy. Avoid entering confidential information when you supply string values using the API.

Show Source

compartmentId(required): string

Minimum Length: 1

Maximum Length: 100

The OCID of the compartment that contains the tag namespace.
definedTags: object definedTags

Additional Properties Allowed: additionalProperties

Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"Operations": {"CostCenter": "42"}}
description(required): string

Minimum Length: 1

Maximum Length: 400

The description you assign to the tag namespace.
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: 100

The OCID of the tag namespace.
isRetired(required): boolean

Whether the tag namespace is retired.
lifecycleState: string

Allowed Values: [ "ACTIVE", "INACTIVE", "DELETING", "DELETED" ]

The tagnamespace's current state. After creating a tagnamespace, make sure its lifecycleState is ACTIVE before using it. After retiring a tagnamespace, make sure its lifecycleState is INACTIVE before using it.
locks: array locks

Locks associated with this resource.
name(required): string

Minimum Length: 1

Maximum Length: 100

The name of the tag namespace. It must be unique across all tag namespaces in the tenancy and cannot be changed.
systemTags: object systemTags

Additional Properties Allowed: additionalProperties

Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`
timeCreated(required): string(date-time)

Date and time the tagNamespace was created, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z

{
    "description":"A managed container for defined tags. A tag namespace is unique in a tenancy. Avoid entering confidential information when you supply string values using the API.",
    "required":[
        "id",
        "compartmentId",
        "name",
        "description",
        "isRetired",
        "timeCreated"
    ],
    "x-obmcs-splat":{
        "resourceKind":"tag-namespaces",
        "ocidEntityType":"tagnamespace",
        "adLocality":"realm",
        "generateOcidVersion":"V2",
        "taggable":true,
        "activeLifecycleStates":[
            "active",
            "inactive"
        ],
        "deletedLifecycleStates":[
            "deleted"
        ],
        "getOperationId":"GetTagNamespace",
        "listResourcesOperationId":"ListTagNamespaces",
        "searchMetadata":{
            "resourceSchemaVersion":1,
            "resourceType":"TagNamespace",
            "scope":"customer",
            "rvnFromHeader":true,
            "fieldNameMap":{
                "name":"displayName"
            }
        },
        "workRequestDetails":{
            "workRequestEntityType":"taggingworkrequest",
            "workRequestGetOperationId":"GetTaggingWorkRequest",
            "successfulLifecycleStates":[
                "SUCCEEDED"
            ],
            "failedLifecycleStates":[
                "FAILED",
                "CANCELED"
            ]
        }
    },
    "properties":{
        "id":{
            "type":"string",
            "description":"The OCID of the tag namespace.",
            "minLength":1,
            "maxLength":100
        },
        "compartmentId":{
            "type":"string",
            "description":"The OCID of the compartment that contains the tag namespace.",
            "minLength":1,
            "maxLength":100
        },
        "name":{
            "type":"string",
            "description":"The name of the tag namespace. It must be unique across all tag namespaces in the tenancy and cannot be changed.",
            "minLength":1,
            "maxLength":100
        },
        "description":{
            "type":"string",
            "description":"The description you assign to the tag namespace.",
            "minLength":1,
            "maxLength":400
        },
        "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"
            }
        },
        "definedTags":{
            "type":"object",
            "description":"Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {\"Operations\": {\"CostCenter\": \"42\"}} ",
            "additionalProperties":{
                "type":"object",
                "description":"Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{\"CostCenter\": \"42\"}` ",
                "additionalProperties":{
                    "type":"object",
                    "description":"The value of the tag. Only the String type is supported. "
                }
            }
        },
        "systemTags":{
            "type":"object",
            "description":"Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{\"orcl-cloud\": {\"free-tier-retained\": \"true\"}}` ",
            "additionalProperties":{
                "type":"object",
                "description":"Key-value pair representing system tags' keys and values scoped to a namespace. Example: `{\"bar-key\": \"value\"}` ",
                "additionalProperties":{
                    "type":"object",
                    "description":"The value of the tag. Only string, integer and boolean types are supported. "
                }
            }
        },
        "isRetired":{
            "type":"boolean",
            "description":"Whether the tag namespace is retired."
        },
        "lifecycleState":{
            "type":"string",
            "enum":[
                "ACTIVE",
                "INACTIVE",
                "DELETING",
                "DELETED"
            ],
            "description":"The tagnamespace's current state. After creating a tagnamespace, make sure its lifecycleState is ACTIVE before using it. After retiring a tagnamespace, make sure its lifecycleState is INACTIVE before using it."
        },
        "timeCreated":{
            "type":"string",
            "format":"date-time",
            "description":"Date and time the tagNamespace was created, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z "
        },
        "locks":{
            "description":"Locks associated with this resource.",
            "type":"array",
            "items":{
                "$ref":"#/definitions/ResourceLock"
            }
        }
    },
    "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"}`

{
    "type":"object",
    "description":"Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {\"Operations\": {\"CostCenter\": \"42\"}} ",
    "additionalProperties":{
        "type":"object",
        "description":"Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{\"CostCenter\": \"42\"}` ",
        "additionalProperties":{
            "type":"object",
            "description":"The value of the tag. Only the String type is supported. "
        }
    }
}

Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"Operations": {"CostCenter": "42"}}

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

Type: array

Locks associated with this resource.

Show Source

Array of: object ResourceLock

Resource locks are used to prevent certain APIs from being called for the resource. A full lock prevents both updating the resource and deleting the resource. A delete lock prevents deleting the resource.

{
    "description":"Locks associated with this resource.",
    "type":"array",
    "items":{
        "$ref":"#/definitions/ResourceLock"
    }
}

Nested Schema : systemTags

Type: object

Additional Properties Allowed

Show Source

object additionalProperties

Additional Properties Allowed: additionalProperties

Key-value pair representing system tags' keys and values scoped to a namespace. Example: `{"bar-key": "value"}`

{
    "type":"object",
    "description":"Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{\"orcl-cloud\": {\"free-tier-retained\": \"true\"}}` ",
    "additionalProperties":{
        "type":"object",
        "description":"Key-value pair representing system tags' keys and values scoped to a namespace. Example: `{\"bar-key\": \"value\"}` ",
        "additionalProperties":{
            "type":"object",
            "description":"The value of the tag. Only string, integer and boolean types are supported. "
        }
    }
}

Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`

Nested Schema : additionalProperties

Type: object

Additional Properties Allowed

Show Source

object additionalProperties

The value of the tag. Only the String type is supported.

{
    "type":"object",
    "description":"Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{\"CostCenter\": \"42\"}` ",
    "additionalProperties":{
        "type":"object",
        "description":"The value of the tag. Only the String type is supported. "
    }
}

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.

Nested Schema : ResourceLock

Type: object

Resource locks are used to prevent certain APIs from being called for the resource. A full lock prevents both updating the resource and deleting the resource. A delete lock prevents deleting the resource.

Show Source

message: string

A message added by the creator of the lock. This is typically used to give an indication of why the resource is locked.
relatedResourceId: string

The OCID of the resource that is locking this resource. Indicates that deleting this resource will remove the lock.
timeCreated: string(date-time)

Indicates when the lock was created, in the format defined by RFC 3339.
type(required): string

Allowed Values: [ "FULL", "DELETE" ]

Lock type.

{
    "description":"Resource locks are used to prevent certain APIs from being called for the resource. A full lock prevents both updating the resource and deleting the resource. A delete lock prevents deleting the resource.",
    "type":"object",
    "required":[
        "type"
    ],
    "properties":{
        "type":{
            "description":"Lock type.",
            "enum":[
                "FULL",
                "DELETE"
            ],
            "type":"string"
        },
        "relatedResourceId":{
            "description":"The OCID of the resource that is locking this resource. Indicates that deleting this resource will remove the lock.",
            "type":"string"
        },
        "message":{
            "description":"A message added by the creator of the lock. This is typically used to give an indication of why the resource is locked.",
            "type":"string"
        },
        "timeCreated":{
            "format":"date-time",
            "type":"string",
            "description":"Indicates when the lock was created, in the format defined by RFC 3339."
        }
    }
}

Nested Schema : additionalProperties

Type: object

Additional Properties Allowed

Show Source

object additionalProperties

The value of the tag. Only string, integer and boolean types are supported.

{
    "type":"object",
    "description":"Key-value pair representing system tags' keys and values scoped to a namespace. Example: `{\"bar-key\": \"value\"}` ",
    "additionalProperties":{
        "type":"object",
        "description":"The value of the tag. Only string, integer and boolean types are supported. "
    }
}

Key-value pair representing system tags' keys and values scoped to a namespace. Example: `{"bar-key": "value"}`

Nested Schema : additionalProperties

Type: object

The value of the tag. Only string, integer and boolean types are supported.

Example Response (application-json)

{   "id" : "ocid1.namespace.oc1..aaaaaaaaqexampleuniqueID",   "compartmentId" : "ocid1.tenancy.oc1..aaaaaaaabaexampleuniqueID",   "name" : "BillingTags",   "description" : "This namespace contains tags that will be used in billing.",   "isRetired" : "false",   "lifecycleState" : "ACTIVE",   "timeCreated" : "2017-09-01T18:13:12.210Z" }

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.

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.

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.

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

409 Response

Conflict

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.

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

429 Response

Too Many Requests

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.

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.

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.

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