Namespace Microservices

Use the CDAP Namespace Microservices to create, list, and delete namespaces in the CDAP instance.

Namespaces, their use and examples, are described in the Namespaces.

The definition of namespace names supported by this API is described under Names and Characters for Namespace Identifiers.

All methods or endpoints described in this API have a base URL (typically http://<host>:11015 or https://<host>:10443) that precedes the resource identifier, as described in the Microservices Conventions. These methods return a status code, as listed in the Microservices Status Codes.

Create a Namespace

To create a namespace, submit an HTTP PUT request:

The namespace-id must be of the limited character set for namespaces, as described in the Introduction. Properties for the namespace are passed in the JSON request body:

If a namespace with the same name already exists, the method will still return 200 OK, but with a message that the Namespace '<namespace-id>' already exists.

HTTP Responses

List Existing Namespaces

To list all of the existing namespaces, issue an HTTP GET request:

This will return a JSON String map that lists each namespace with its name and description (reformatted to fit):

Details of a Namespace

For detailed information on a specific namespace, use:

The information (namespace name, identity, description, config) will be returned in the body of the response, such as:

HTTP Responses

Editing a Namespace

To edit an existing namespace, submit an HTTP PUT request to:

The namespace-id must be the name of an existing namespace. Properties for the namespace are passed in the JSON request body, as described for when you Create a Namespace.

HTTP Responses

Example

Deleting a Namespace

To delete an existing namespace (including all pipelines, applications, datasets, metrics, and other components), submit an HTTP DELETE request to:

To prevent accidental use of this method, it will only work if the cdap-site.xml parameter enable.unrecoverable.reset has been enabled. This method must be exercised with extreme caution, as there is no recovery from it.

Both the CDAP CLI and the CDAP UI expose this function. They also require the parameter to be enabled in order for their functions to work.

In the case of the default namespace, after everything has been deleted, the default namespace is retained, as it is always available in CDAP.

To delete only the datasets of a namespace, there is a specific dataset endpoint for that.

Namespace Configurations

When creating or editing a namespace, namespace configurations can be supplied as part of the request body. These are in the form of a JSON string of configuration key-value pairs. Note that the values for these keys cannot be modified once the namespace has been created, with the exception of the property scheduler.queue.name.

Namespace Configurations