Version: 4.0.3
shows some information about this service
successful response
get all applications registered with this broker
successful response
(This is a hacky way of supporting "oneOf" because Swagger does not support oneOf https://github.com/OAI/OpenAPI-Specification/issues/333. This is the same endpoint as PUT /application/appname, except the PUT body is different.)
Register a hydrator app for service and configuration discovery. This will light up a metrics and health endpoint for this app. appname is assumed to also be the key in consul.
application/json
required put body
| appname | Name of the application. |
path | string (text) |
application/json
Successful response
put was performed but the appname was already registered with the broker, or Invalid PUT body
endpoint to delete multiple applications at once. Returns an array of status codes, where statuscode[i] = response returned from DELETE(application/i)
required post body
successful response
Remove an app for service and configuration discovery. This will remove the metrics and health endpoints for this app.
| appname | Name of the application. |
path | string (text) |
Successful response
no app with name 'appname' registered with this broker.
Returns the representation of the application resource, including the links for healthcheck and metrics.
| appname | Name of the application. |
path | string (text) |
Successful response
no app with name 'appname' registered with this broker.
Register an app for service and configuration discovery. This will light up a metrics and health endpoint for this app. appname is assumed to also be the key in consul.
application/json
required put body
| appname | Name of the application. |
path | string (text) |
application/json
Successful response
put was performed but the appname was already registered with the broker, or Invalid PUT body
Perform a healthcheck on the running app appname.
| appname | Name of the application to get the healthcheck for. |
path | string (test) |
Successful response, healthcheck pass
no app with name 'appname' registered with this broker, or the healthcheck has failed (though I would like to disambiguiate from the first case, CDAP returns a 404 for this).
Get live (real-time) app specific metrics for the running app appname. Metrics are customized per each app by the component developer
| appname | Name of the application to get metrics for. |
path | string (test) |
Successful response
no app with name 'appname' registered with this broker.
Reconfigures the application.
required put body
| appname | Name of the application. |
path | string (text) |
Successful response
Bad request. Can happen with 1) {appname} is not registered with the broker, 2) the required PUT body is wrong, or 3) the smart interface was chosen and none of the config keys match anything in app_config or app_preferences
application name
fully qualified url to perform healthcheck
fully qualified url to get metrics from
fully qualified url of the resource
input URL that you can POST data into (URL of the CDAP stream)
a list of HTTP services exposed by this CDAP application
denotes whether this is a program-flowlet style application or a hydrator pipeline. For program-flowlet style apps, this value must be "program-flowlet"
name of the CDAP stream to ingest data into this app. Should come from the developer and Tosca model.
the cdap namespace this is deployed into
the URL that the JAR you're deploying resides
the name of the CDAP artifact to be added
the version of the artifact. Must be in X.Y.Z form
the application config JSON
the application preferences JSON
denotes whether this is a program-flowlet style application or a hydrator pipeline. For hydrator, this value must be "hydrator-pipeline"
the cdap namespace this is deployed into
the URL of the config.json for this pipeline
name of the CDAP stream to ingest data into this app. Should come from the developer and Tosca model.
represents a list of dependencies to be loaded for this pipeline. Not required.
represents a hydrator pipeline dependency. An equivelent to the following CURLs are formed with the below four params shown in CAPS "curl -v -w"\n" -X POST http://cdapurl:11015/v3/namespaces/setelsewhere/artifacts/ARTIFACT_NAME -H "Artifact-Extends:ARTIFACT_EXTENDS_HEADER" -H “Artifact-Version:ARTIFACT_VERSION_HEADER” --data-binary @(DOWNLOADED FROM ARTIFACT_URL)","curl -v -w"\n" -X PUT http://cdapurl:11015/v3/namespaces/setelsewhere/artifacts/ARTIFACT_NAME/versions/ARTIFACT_VERSION_HEADER/properties -d (DOWNLOADED FROM UI_PROPERTIES_URL)"
the value of the header that gets passed in for artifact-extends, e.g., "Artifact-Extends:system:cdap-data-pipeline[4.0.1,5.0.0)"
the name of the artifact
the value of the header that gets passed in for artifact-version, e.g., "Artifact-Version:1.0.0-SNAPSHOT"
the URL of the artifact JAR
the URL of the properties.json if the custom artifact has UI properties. This is optional.
some broker information
the url of the CDAP cluster API this broker is managing
The GUI port of the CDAP cluster this broker is managing. Mostly to help users of this API check their application in cdap. Note, will return UNKNOWN_CDAP_VERSION if it cannot be determined.
the version of the CDAP cluster this broker is managing. Note, will return UKNOWN_CDAP_VERSION if it cannot be determined.
the API version of this running broker
key,value object where the key is 'appmetrics' and the value is an app dependent json and specified by the component developer
the list of programs in this CDAP app
must be one of flows, mapreduce, schedules, spark, workflows, workers, or services
the name of the program
the preference JSON to set for this program
the list of programs in this CDAP app
must be one of flows, mapreduce, schedules, spark, workflows, workers, or services
the name of the program
the type of reconfiguration
the config JSON
descirbes a service endpoint, including the service name, the method name, and the method type (GET, PUT, etc, most of the time will be GET)
the name of the service
the name of the endpoint on the service
GET, POST, PUT, etc