Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Parameter

Description

host

Host name of the CDAP server.

port

Port set as the router.bind.port in cdap-site.xml (default: 11015).

Note: If SSL is enabled for CDAP, then the base URL uses https instead and port becomes the port that is set as the router.ssl.server.port in cdap-site.xml (default: 10443).

In this API, each endpoint is documented with the HTTP method for the request and a resource identifier. The base URL is assumed to precede each API's resource identifier. For example, the endpoint documentation for creating an application is:

...

Code

Description

Explanation

200

OK

The request returned successfully.

400

Bad Request

The request had a combination of parameters that is not recognized.

401

Unauthorized

The request did not contain an authentication token; see the section below on Working with CDAP Security.

403

Forbidden

The request was authenticated but the client does not have permission; requests can fail due to a lack of privilege, as described in the section below on “Working with CDAP Security”.

404

Not Found

The request did not address any of the known URIs.

405

Method Not Allowed

A request was received with a method not supported for the URI.

409

Conflict

A request could not be completed due to a conflict with the current resource state.

500

Internal Server Error

An internal error occurred while processing the request.

501

Not Implemented

A request contained a query that is not supported by this API.

Note: These returned status codes are not necessarily included in the descriptions of the APIs, but a request may return any of these.

Working with CDAP Security

...