X-Git-Url: https://gerrit.onap.org/r/gitweb?a=blobdiff_plain;f=docs%2Fdata-router%2Fdata-router.rst;h=2c3e1a69d54ba0eb0170619b3178926d5452ca6c;hb=ee6fa61e2cd7df99891092709765235b6166a041;hp=33ae16822473d181005d5e675d6cf3823ba926bf;hpb=118900e50d71a3db8bd6e304151cc7c20b4fbda9;p=dmaap%2Fdatarouter.git diff --git a/docs/data-router/data-router.rst b/docs/data-router/data-router.rst old mode 100644 new mode 100755 index 33ae1682..2c3e1a69 --- a/docs/data-router/data-router.rst +++ b/docs/data-router/data-router.rst @@ -1,25 +1,28 @@ +.. _data_router_api_guide: + ========================== Data Router (DR) API Guide ========================== Introduction ------------ -The DataRouter(DR) provisioning API is an HTTPS-based, REST-like API for creating and managing DR feeds and subscriptions. The Data Routing System project is intended to provide a common framework by which data producers can make data available to data consumers and a way for potential consumers to find feeds with the data they require. +The DataRouter(DR) provisioning API is an HTTPS-based, REST-like API for creating and managing DR feeds +and subscriptions. The DMaaP Data Router System project is intended to provide a common framework by which +data producers can make data available to data consumers and a way for potential consumers to find feeds +with the data they require. HTTP Service APIs ----------------- DMaaP Data Router utilizes an HTTP REST API to service all transactions. HTTP and REST standards are followed so -clients as varied as CURL, Java applications and even Web Browsers will -work to interact with the Data Router. +clients as varied as CURL, Java applications and even Web Browsers will work to interact with the Data Router. General HTTP Requirements ========================= -A DMaaP Data Router transactions consists of 4 distinct segments, -HTTP URL, HTTP Header, HTTP Body (POST/PUT) and HTTP Response. The general -considerations for each segment are as follows and are required for each +A DMaaP Data Router transactions consists of 4 distinct segments, HTTP URL, HTTP Header, HTTP Body (POST/PUT) +and HTTP Response. The general considerations for each segment are as follows and are required for each of the specific transactions described in this section. HTTP URL @@ -27,8 +30,8 @@ HTTP URL http[s]://{serverBaseURL}/{resourcePath} -* The serverBaseURL points to DMaaP Data Router host/port that will service the request. -* The resourcePath specifies the specific service that the client is attempting to reach. +* The serverBaseURL points to DMaaP Data Router host:port that will service the request. +* The resourcePath specifies the service that the client is attempting to reach. HTTP Header @@ -44,41 +47,41 @@ The HTTP Body contains the feed content when creating a feed. Create a Feed ------------- -**Description**: Creates a unique set of URL's to service the publisher/subscriber model. +**Description**: Creates a unique feed URL to service the publisher/subscriber model. Sample Request ============== -curl -v -X POST -H "Content-Type: application/vnd.att-dr.feed" -H "X-ATT-DR-ON-BEHALF-OF: {user}" --data-ascii @/opt/app/datartr/addFeed3.txt --post301 --location-trusted -k https:/{host}:{port} +``curl -k -X POST -H "Content-Type:application/vnd.dmaap-dr.feed" -H "X-DMAAP-DR-ON-BEHALF-OF:{user}" --data-ascii @createFeed.json https://{host}:{port}`` Request Parameters: =================== -+------------------------+---------------------------------+------------------+------------+--------------+-------------+---------------------+--------------------------------------+ -| Name | Description | Param Type | Data Type | MaxLen | Required | Format | Valid/Example Values | -+========================+=================================+==================+============+==============+=============+=====================+======================================+ -| name | Feed name | Body | String | <=20 | Y | | | -+------------------------+---------------------------------+------------------+------------+--------------+-------------+---------------------+--------------------------------------+ -| version | Feed version | Body | String | <=20 | Y | | | -+------------------------+---------------------------------+------------------+------------+--------------+-------------+---------------------+--------------------------------------+ -| description | Feed description | Body | String | | Y | | | -+------------------------+---------------------------------+------------------+------------+--------------+-------------+---------------------+--------------------------------------+ -| business description | Business description | Body | String | | Y | | | -+------------------------+---------------------------------+------------------+------------+--------------+-------------+---------------------+--------------------------------------+ -| Authorization | Information for authorizing | Body | Object | | Y | | | -| | publishing requests | | | | | | | -+------------------------+---------------------------------+------------------+------------+--------------+-------------+---------------------+--------------------------------------+ -| suspend | Set to true if the feed is in | Body | Boolean | | N | | * true | -| | the suspended state | | | | | | * false | -+------------------------+---------------------------------+------------------+------------+--------------+-------------+---------------------+--------------------------------------+ -| group-id | | Body | Integer | | Y | | | -| | | | | | | | | -+------------------------+---------------------------------+------------------+------------+--------------+-------------+---------------------+--------------------------------------+ -| content-type | To specify type of message | Header | String | 20 | N | | application/vnd.att-dr.feed | -| | (feed,subscriber,publisher) | | | | | | | -+------------------------+---------------------------------+------------------+------------+--------------+-------------+---------------------+--------------------------------------+ -| X-ATT-DR-ON-BEHALF-OF | User id of owner of feed | Header | String | 1 | N | | username | -+------------------------+---------------------------------+------------------+------------+--------------+-------------+---------------------+--------------------------------------+ ++------------------------+---------------------------------+------------------+------------+--------------+-------------+--------------------------------------+ +| Name | Description | Param Type | Data Type | MaxLen | Required | Valid/Example Values | ++========================+=================================+==================+============+==============+=============+======================================+ +| name | Feed name | Body | String | <=20 | Y | | ++------------------------+---------------------------------+------------------+------------+--------------+-------------+--------------------------------------+ +| version | Feed version | Body | String | <=20 | Y | | ++------------------------+---------------------------------+------------------+------------+--------------+-------------+--------------------------------------+ +| description | Feed description | Body | String | <=256 | Y | | ++------------------------+---------------------------------+------------------+------------+--------------+-------------+--------------------------------------+ +| business description | Business description | Body | String | <=256 | Y | | ++------------------------+---------------------------------+------------------+------------+--------------+-------------+--------------------------------------+ +| Authorization | Information for authorizing | Body | Object | | Y | | +| | publishing requests | | | | | | ++------------------------+---------------------------------+------------------+------------+--------------+-------------+--------------------------------------+ +| suspend | Set to true if the feed is in | Body | Boolean | | N | * true | +| | the suspended state | | | | | * false | ++------------------------+---------------------------------+------------------+------------+--------------+-------------+--------------------------------------+ +| group-id | | Body | Integer | | Y | | +| | | | | | | | ++------------------------+---------------------------------+------------------+------------+--------------+-------------+--------------------------------------+ +| content-type | To specify type of message | Header | String | | Y | application/vnd.dmaap-dr.feed | +| | (feed,subscriber,publisher) | | | | | | ++------------------------+---------------------------------+------------------+------------+--------------+-------------+--------------------------------------+ +| X-DMAAP-DR-ON-BEHALF-OF| User id of owner of feed | Header | String | <=8 | Y | username | ++------------------------+---------------------------------+------------------+------------+--------------+-------------+--------------------------------------+ Response/Error Codes ==================== @@ -107,7 +110,7 @@ Response/Error Codes | | IP address | | | * Client certificate subject is not on | | | the API’s authorized list. | -| | * X-ATT-DR-ON-BEHALF-OF identity is not | +| | * X-DMAAP-DR-ON-BEHALF-OF identity is not | | | authorized to perform | +------------------------+-------------------------------------------+ | 404 | Not Found - The Request-URI does not point| @@ -137,26 +140,23 @@ Sample Body { "name": "Jettydemo", - "version": "m1.0", + "version": "v1.0.0", "description": "Jettydemo", "business_description": "Jettydemo", "suspend": false, - "deleted": false, "changeowner": true, "authorization": { "classification": "unclassified", - "endpoint_addrs": [ - "172.18.0.3", - ], + "endpoint_addrs": ["172.18.0.3","192.167.3.42"], "endpoint_ids": [ { "password": "password", "id": "user" } ] - }, + } + } -} Updating a Feed --------------- @@ -166,32 +166,32 @@ Updating a Feed Sample Request ============== -curl -v -X PUT -H "Content-Type: application/vnd.att-dr.feed" -H "X-ATT-DR-ON-BEHALF-OF: {user}" --data-ascii @/opt/app/datartr/addFeed3.txt --location-trusted -k https:/{host}:{port} +``curl -k -X PUT -H "Content-Type: application/vnd.dmaap-dr.feed" -H "X-DMAAP-DR-ON-BEHALF-OF: {user}" --data-ascii @updateFeed.json --location-trusted https://{host}:{port}/feed/{feedId}`` Request Parameters: =================== -+------------------------+---------------------------------+------------------+------------+--------------+-------------+---------------------+--------------------------------------+ -| Name | Description | Param Type | Data Type | MaxLen | Required | Format | Valid/Example Values | -+========================+=================================+==================+============+==============+=============+=====================+======================================+ -| description | Feed description | Body | String | | Y | | | -+------------------------+---------------------------------+------------------+------------+--------------+-------------+---------------------+--------------------------------------+ -| business description | Business description | Body | String | | Y | | | -+------------------------+---------------------------------+------------------+------------+--------------+-------------+---------------------+--------------------------------------+ -| Authorization | Information for authorizing | Body | Object | | Y | | | -| | publishing requests | | | | | | | -+------------------------+---------------------------------+------------------+------------+--------------+-------------+---------------------+--------------------------------------+ -| suspend | Set to true if the feed is in | Body | Boolean | | N | | * true | -| | the suspended state | | | | | | * false | -+------------------------+---------------------------------+------------------+------------+--------------+-------------+---------------------+--------------------------------------+ -| group-id | | Body | Integer | | Y | | | -| | | | | | | | | -+------------------------+---------------------------------+------------------+------------+--------------+-------------+---------------------+--------------------------------------+ -| content-type | To specify type of message | Header | String | 20 | N | | application/vnd.att-dr.feed | -| | (feed,subscriber,publisher) | | | | | | | -+------------------------+---------------------------------+------------------+------------+--------------+-------------+---------------------+--------------------------------------+ -| X-ATT-DR-ON-BEHALF-OF | User id of owner of feed | Header | String | 1 | N | | username | -+------------------------+---------------------------------+------------------+------------+--------------+-------------+---------------------+--------------------------------------+ ++------------------------+---------------------------------+------------------+------------+--------------+-------------+--------------------------------------+ +| Name | Description | Param Type | Data Type | MaxLen | Required | Valid/Example Values | ++========================+=================================+==================+============+==============+=============+======================================+ +| description | Feed description | Body | String | <=256 | Y | | ++------------------------+---------------------------------+------------------+------------+--------------+-------------+--------------------------------------+ +| business description | Business description | Body | String | <=256 | Y | | ++------------------------+---------------------------------+------------------+------------+--------------+-------------+--------------------------------------+ +| Authorization | Information for authorizing | Body | Object | | Y | | +| | publishing requests | | | | | | ++------------------------+---------------------------------+------------------+------------+--------------+-------------+--------------------------------------+ +| suspend | Set to true if the feed is in | Body | Boolean | | N | * true | +| | the suspended state | | | | | * false | ++------------------------+---------------------------------+------------------+------------+--------------+-------------+--------------------------------------+ +| group-id | | Body | Integer | | Y | | +| | | | | | | | ++------------------------+---------------------------------+------------------+------------+--------------+-------------+--------------------------------------+ +| content-type | To specify type of message | Header | String | | Y | application/vnd.dmaap-dr.feed | +| | (feed,subscriber,publisher) | | | | | | ++------------------------+---------------------------------+------------------+------------+--------------+-------------+--------------------------------------+ +| X-DMAAP-DR-ON-BEHALF-OF| User id of owner of feed | Header | String | <=8 | Y | username | ++------------------------+---------------------------------+------------------+------------+--------------+-------------+--------------------------------------+ Response/Error Codes ==================== @@ -220,7 +220,7 @@ Response/Error Codes | | IP address | | | * Client certificate subject is not on | | | the API’s authorized list. | -| | * X-ATT-DR-ON-BEHALF-OF identity is not | +| | * X-DMAAP-DR-ON-BEHALF-OF identity is not | | | authorized to perform | +------------------------+-------------------------------------------+ | 404 | Not Found - The Request-URI does not point| @@ -250,26 +250,23 @@ Sample Body { "name": "Jettydemo", - "version": "m1.0", - "description": "Jettydemo", - "business_description": "Jettydemo", + "version": "v1.0.0", + "description": "Updated decription", + "business_description": "Updated business description", "suspend": false, - "deleted": false, "changeowner": true, "authorization": { "classification": "unclassified", - "endpoint_addrs": [ - "172.18.0.3", - ], + "endpoint_addrs": ["172.18.0.3","192.167.3.42"], "endpoint_ids": [ { "password": "password", "id": "user" } ] - }, + } + } -} Get a Feed ---------- @@ -286,7 +283,7 @@ http[s]://{host}:{port}/feed/{feedId} Sample Request ============== -curl -v -X GET -H "X-ATT-DR-ON-BEHALF-OF: {user}" --location-trusted -k https:/{host}:{port}/feed/{feedId} +``curl -k -H "X-DMAAP-DR-ON-BEHALF-OF: {user}" https://{host}:{port}/feed/{feedId}`` Response/Error Codes ==================== @@ -308,7 +305,7 @@ Response/Error Codes | | IP address | | | * Client certificate subject is not on | | | the API’s authorized list. | -| | * X-ATT-DR-ON-BEHALF-OF identity is not | +| | * X-DMAAP-DR-ON-BEHALF-OF identity is not | | | authorized to perform | +------------------------+-------------------------------------------+ | 404 | Not Found - The Request-URI does not point| @@ -347,7 +344,7 @@ http[s]://{host}:{port}/feed/{feedId} Sample Request ============== -curl -v -X DELETE -H "X-ATT-DR-ON-BEHALF-OF: {user}" --location-trusted -k https:/{host}:{port}/feed/{feedId} +``curl -k -X DELETE -H "X-DMAAP-DR-ON-BEHALF-OF: {user}" https://{host}:{port}/feed/{feedId}`` Response/Error Codes ==================== @@ -369,7 +366,7 @@ Response/Error Codes | | IP address | | | * Client certificate subject is not on | | | the API’s authorized list. | -| | * X-ATT-DR-ON-BEHALF-OF identity is not | +| | * X-DMAAP-DR-ON-BEHALF-OF identity is not | | | authorized to perform | +------------------------+-------------------------------------------+ | 404 | Not Found - The Request-URI does not point| @@ -404,40 +401,42 @@ Request URL http[s]://{host}:{port}/subscribe/{feedId} +* {feedId}: Id of the feed to subscribe to + Sample Request ============== -curl -v -X POST -H "Content-Type: application/vnd.att-dr.subscription" -H "X-ATT-DR-ON-BEHALF-OF: {user}" --data-ascii @/opt/app/datartr/addSubscriber.txt --post301 --location-trusted -k https://{host}:{port}/subscribe/{feedId} +``curl -k -X POST -H "Content-Type:application/vnd.dmaap-dr.subscription" -H "X-DMAAP-DR-ON-BEHALF-OF:{user}" --data-ascii @addSubscriber.json https://{host}:{port}/subscribe/{feedId}`` Request Parameters: =================== -+------------------------+---------------------------------+------------------+------------+--------------+-------------+---------------------+--------------------------------------+ -| Name | Description | Param Type | Data Type | MaxLen | Required | Format | Valid/Example Values | -+========================+=================================+==================+============+==============+=============+=====================+======================================+ -| feedId | ID for the feed you are | Path | String | | Y | | | -| | subscribing to | | | | | | | -+------------------------+---------------------------------+------------------+------------+--------------+-------------+---------------------+--------------------------------------+ -| delivery | Address and credentials for | Body | Object | | Y | | | -| | delivery | | | | | | | -+------------------------+---------------------------------+------------------+------------+--------------+-------------+---------------------+--------------------------------------+ -| follow_redirect | Set to true if feed redirection | Body | Boolean | | Y | | * true | -| | is expected | | | | | | * false | -+------------------------+---------------------------------+------------------+------------+--------------+-------------+---------------------+--------------------------------------+ -| metadata_only | Set to true if subscription is | Body | Boolean | | Y | | * true | -| | to receive per-file metadata | | | | | | * false | -+------------------------+---------------------------------+------------------+------------+--------------+-------------+---------------------+--------------------------------------+ -| suspend | Set to true if the subscription | Body | Boolean | | N | | * true | -| | is in the suspended state | | | | | | * false | -+------------------------+---------------------------------+------------------+------------+--------------+-------------+---------------------+--------------------------------------+ -| group-id | | Body | Integer | | Y | | | -| | | | | | | | | -+------------------------+---------------------------------+------------------+------------+--------------+-------------+---------------------+--------------------------------------+ -| content-type | To specify type of message | Header | String | 20 | N | | application/vnd.att-dr.subscription | -| | (feed,subscriber,publisher) | | | | | | | -+------------------------+---------------------------------+------------------+------------+--------------+-------------+---------------------+--------------------------------------+ -| X-ATT-DR-ON-BEHALF-OF | User id of subscriber | Header | String | 1 | N | | username | -+------------------------+---------------------------------+------------------+------------+--------------+-------------+---------------------+--------------------------------------+ ++------------------------+---------------------------------+------------------+------------+--------------+-------------+--------------------------------------+ +| Name | Description | Param Type | Data Type | MaxLen | Required | Valid/Example Values | ++========================+=================================+==================+============+==============+=============+======================================+ +| feedId | ID for the feed you are | Path | String | | Y | | +| | subscribing to | | | | | | ++------------------------+---------------------------------+------------------+------------+--------------+-------------+--------------------------------------+ +| delivery | Address and credentials for | Body | Object | | Y | | +| | delivery | | | | | | ++------------------------+---------------------------------+------------------+------------+--------------+-------------+--------------------------------------+ +| follow_redirect | Set to true if feed redirection | Body | Boolean | | Y | * true | +| | is expected | | | | | * false | ++------------------------+---------------------------------+------------------+------------+--------------+-------------+--------------------------------------+ +| metadata_only | Set to true if subscription is | Body | Boolean | | Y | * true | +| | to receive per-file metadata | | | | | * false | ++------------------------+---------------------------------+------------------+------------+--------------+-------------+--------------------------------------+ +| suspend | Set to true if the subscription | Body | Boolean | | N | * true | +| | is in the suspended state | | | | | * false | ++------------------------+---------------------------------+------------------+------------+--------------+-------------+--------------------------------------+ +| group-id | | Body | Integer | | Y | | +| | | | | | | | ++------------------------+---------------------------------+------------------+------------+--------------+-------------+--------------------------------------+ +| content-type | To specify type of message | Header | String | | Y | application/vnd.dmaap-dr.subscription| +| | (feed,subscriber,publisher) | | | | | | ++------------------------+---------------------------------+------------------+------------+--------------+-------------+--------------------------------------+ +| X-DMAAP-DR-ON-BEHALF-OF| User id of subscriber | Header | String | <=8 | Y | username | ++------------------------+---------------------------------+------------------+------------+--------------+-------------+--------------------------------------+ Response/Error Codes ==================== @@ -466,7 +465,7 @@ Response/Error Codes | | IP address | | | * Client certificate subject is not on | | | the API’s authorized list. | -| | * X-ATT-DR-ON-BEHALF-OF identity is not | +| | * X-DMAAP-DR-ON-BEHALF-OF identity is not | | | authorized to perform | +------------------------+-------------------------------------------+ | 404 | Not Found - The Request-URI does not point| @@ -502,11 +501,9 @@ Sample Body "use100" : true }, "metadataOnly" : false, - "suspend" : false, - "groupid" : 29, - "subscriber" : "subscriber123" - -} + "groupid" : 1, + "subscriber" : "subuser" + } Update subscription ------------------- @@ -516,42 +513,44 @@ Update subscription Request URL =========== -http[s]://{host}:{port}/subscribe/{feedId} +http[s]://{host}:{port}/subs/{subId} + +* {subId}: Id of the subscription to be updated Sample Request ============== -curl -v -X PUT -H "Content-Type: application/vnd.att-dr.subscription" -H "X-ATT-DR-ON-BEHALF-OF: {user}" --data-ascii @/opt/app/datartr/addSubscriber.txt --location-trusted -k https://{host}:{port}/subscribe/{feedId} +``curl -k -X PUT -H "Content-Type:application/vnd.dmaap-dr.subscription" -H "X-DMAAP-DR-ON-BEHALF-OF:{user}" --data-ascii @updateSubscriber.json https://{host}:{port}/subs/{subId}`` Request Parameters: =================== -+------------------------+---------------------------------+------------------+------------+--------------+-------------+---------------------+--------------------------------------+ -| Name | Description | Param Type | Data Type | MaxLen | Required | Format | Valid/Example Values | -+========================+=================================+==================+============+==============+=============+=====================+======================================+ -| feedId | ID for the subscription you are | Path | String | | Y | | | -| | updating | | | | | | | -+------------------------+---------------------------------+------------------+------------+--------------+-------------+---------------------+--------------------------------------+ -| delivery | Address and credentials for | Body | Object | | Y | | | -| | delivery | | | | | | | -+------------------------+---------------------------------+------------------+------------+--------------+-------------+---------------------+--------------------------------------+ -| follow_redirect | Set to true if feed redirection | Body | Boolean | | Y | | * true | -| | is expected | | | | | | * false | -+------------------------+---------------------------------+------------------+------------+--------------+-------------+---------------------+--------------------------------------+ -| metadata_only | Set to true if subscription is | Body | Boolean | | Y | | * true | -| | to receive per-file metadata | | | | | | * false | -+------------------------+---------------------------------+------------------+------------+--------------+-------------+---------------------+--------------------------------------+ -| suspend | Set to true if the subscription | Body | Boolean | | N | | * true | -| | is in the suspended state | | | | | | * false | -+------------------------+---------------------------------+------------------+------------+--------------+-------------+---------------------+--------------------------------------+ -| group-id | | Body | Integer | | Y | | | -| | | | | | | | | -+------------------------+---------------------------------+------------------+------------+--------------+-------------+---------------------+--------------------------------------+ -| content-type | To specify type of message | Header | String | 20 | N | | application/vnd.att-dr.subscription | -| | (feed,subscriber,publisher) | | | | | | | -+------------------------+---------------------------------+------------------+------------+--------------+-------------+---------------------+--------------------------------------+ -| X-ATT-DR-ON-BEHALF-OF | User id of subscriber | Header | String | 1 | N | | username | -+------------------------+---------------------------------+------------------+------------+--------------+-------------+---------------------+--------------------------------------+ ++------------------------+---------------------------------+------------------+------------+--------------+-------------+--------------------------------------+ +| Name | Description | Param Type | Data Type | MaxLen | Required | Valid/Example Values | ++========================+=================================+==================+============+==============+=============+======================================+ +| subId | ID for the subscription you are | Path | String | | Y | | +| | updating | | | | | | ++------------------------+---------------------------------+------------------+------------+--------------+-------------+--------------------------------------+ +| delivery | Address and credentials for | Body | Object | | Y | | +| | delivery | | | | | | ++------------------------+---------------------------------+------------------+------------+--------------+-------------+--------------------------------------+ +| follow_redirect | Set to true if feed redirection | Body | Boolean | | Y | * true | +| | is expected | | | | | * false | ++------------------------+---------------------------------+------------------+------------+--------------+-------------+--------------------------------------+ +| metadata_only | Set to true if subscription is | Body | Boolean | | Y | * true | +| | to receive per-file metadata | | | | | * false | ++------------------------+---------------------------------+------------------+------------+--------------+-------------+--------------------------------------+ +| suspend | Set to true if the subscription | Body | Boolean | | N | * true | +| | is in the suspended state | | | | | * false | ++------------------------+---------------------------------+------------------+------------+--------------+-------------+--------------------------------------+ +| group-id | | Body | Integer | | Y | | +| | | | | | | | ++------------------------+---------------------------------+------------------+------------+--------------+-------------+--------------------------------------+ +| content-type | To specify type of message | Header | String | | Y | application/vnd.dmaap-dr.subscription| +| | (feed,subscriber,publisher) | | | | | | ++------------------------+---------------------------------+------------------+------------+--------------+-------------+--------------------------------------+ +| X-DMAAP-DR-ON-BEHALF-OF| User id of subscriber | Header | String | 8 | Y | username | ++------------------------+---------------------------------+------------------+------------+--------------+-------------+--------------------------------------+ Response/Error Codes ==================== @@ -580,7 +579,7 @@ Response/Error Codes | | IP address | | | * Client certificate subject is not on | | | the API’s authorized list. | -| | * X-ATT-DR-ON-BEHALF-OF identity is not | +| | * X-DMAAP-DR-ON-BEHALF-OF identity is not | | | authorized to perform | +------------------------+-------------------------------------------+ | 404 | Not Found - The Request-URI does not point| @@ -610,17 +609,15 @@ Sample Body { "delivery" :{ - "url" : "http://172.18.0.3:7070/", - "user" : "LOGIN", - "password" : "PASSWORD", + "url" : "http://192.0.0.1:7070/", + "user" : "NEW_LOGIN", + "password" : "NEW_PASSWORD", "use100" : true }, "metadataOnly" : false, - "suspend" : false, - "groupid" : 29, - "subscriber" : "subscriber123" - -} + "groupid" : 2, + "subscriber" : "subuser" + } Get a Subscription @@ -631,14 +628,14 @@ Get a Subscription Request URL =========== -http[s]://{host}:{port}/subscribe/{subId} +http[s]://{host}:{port}/subs/{subId} * {subId}: Id of the subscription you want to see a representation of Sample Request ============== -curl -v -X GET -H "X-ATT-DR-ON-BEHALF-OF: {user}" --location-trusted -k https:/{host}:{port}/subscribe/{subId} +``curl -k -H "X-DMAAP-DR-ON-BEHALF-OF:{user}" https://{host}:{port}/subs/{subId}`` Response/Error Codes ==================== @@ -660,7 +657,7 @@ Response/Error Codes | | IP address | | | * Client certificate subject is not on | | | the API’s authorized list. | -| | * X-ATT-DR-ON-BEHALF-OF identity is not | +| | * X-DMAAP-DR-ON-BEHALF-OF identity is not | | | authorized to perform | +------------------------+-------------------------------------------+ | 404 | Not Found - The Request-URI does not point| @@ -692,14 +689,14 @@ Delete a subscription Request URL =========== -http[s]://{host}:{port}/feed/{feedId} +http[s]://{host}:{port}/subs/{subId} -* {feedId}: Id of the subscription you want to delete +* {subId}: Id of the subscription you want to delete Sample Request ============== -curl -v -X DELETE -H "X-ATT-DR-ON-BEHALF-OF: {user}" --location-trusted -k https:/{host}:{port}/subscribe/{feedId} +``curl -k -X DELETE -H "X-DMAAP-DR-ON-BEHALF-OF:{user}" https://{host}:{port}/subs/{subId}`` Response/Error Codes ==================== @@ -721,7 +718,7 @@ Response/Error Codes | | IP address | | | * Client certificate subject is not on | | | the API’s authorized list. | -| | * X-ATT-DR-ON-BEHALF-OF identity is not | +| | * X-DMAAP-DR-ON-BEHALF-OF identity is not | | | authorized to perform | +------------------------+-------------------------------------------+ | 404 | Not Found - The Request-URI does not point| @@ -748,32 +745,44 @@ Response/Error Codes Publish to Feed --------------- -**Description**: Publish a file to a created feed so that it can be shared to any subscribers of that feed +**Description**: Publish data to a given feed Request URL =========== http[s]://{host}:{port}/publish/{feedId}/{fileName} -* {feedId} is the id of the feed you are publishing to. -* {fileId} is the id of the file you are publishing onto the feed. +* {feedId} The id of the feed you are publishing to. +* {fileId} The name of the file you are publishing to the feed. +Sample Request +============== + +``curl -k -X PUT --user {user}:{password} -H "Content-Type:application/octet-stream" -H "X-DMAAP-DR-META:{\"filetype\":\"txt\"}" --data-binary @sampleFile.txt --post301 --location-trusted https://{host}:{port}/publish/{feedId}/sampleFile`` Request parameters ================== -+------------------------+---------------------------------+------------------+------------+--------------+-------------+---------------------+--------------------------------------+ -| Name | Description | Param Type | Data Type | MaxLen | Required | Format | Valid/Example Values | -+========================+=================================+==================+============+==============+=============+=====================+======================================+ -| feedId | ID of the feed you are | Path | String | | Y | | | -| | publishing to | | | | | | | -+------------------------+---------------------------------+------------------+------------+--------------+-------------+---------------------+--------------------------------------+ -| fileId | Name of the file when it is | Path | String | | Y | | | -| | published to subscribers | | | | | | | -+------------------------+---------------------------------+------------------+------------+--------------+-------------+---------------------+--------------------------------------+ -| content-type | To specify type of message | Header | String | 20 | N | | application/octet-stream | -| | format | | | | | | | -+------------------------+---------------------------------+------------------+------------+--------------+-------------+---------------------+--------------------------------------+ ++------------------------+---------------------------------+------------------+------------+--------------+-------------+--------------------------------------------------------------------------+ +| Name | Description | Param Type | Data Type | MaxLen | Required | Valid/Example Values | ++========================+=================================+==================+============+==============+=============+==========================================================================+ +| feedId | ID of the feed you are | Path | String | | Y | | +| | publishing to | | | | | | ++------------------------+---------------------------------+------------------+------------+--------------+-------------+--------------------------------------------------------------------------+ +| fileId | Name of the file when it is | Path | String | | Y | | +| | published to subscribers | | | | | | ++------------------------+---------------------------------+------------------+------------+--------------+-------------+--------------------------------------------------------------------------+ +| content-type | To specify type of message | Header | String | | Y | application/octet-stream | +| | format | | | | | | ++------------------------+---------------------------------+------------------+------------+--------------+-------------+--------------------------------------------------------------------------+ +| X-DMAAP-DR-META | Metadata for the file. Accepts | Header | String | 4096 | N | '{"compressionType":"gzip","id": 1234, "transferred":true, "size":null}' | +| | only non nested json objects | | | | | | +| | of the following type : | | | | | | +| | -Numbers | | | | | | +| | -Strings | | | | | | +| | -Lowercase boolean | | | | | | +| | -null | | | | | | ++------------------------+---------------------------------+------------------+------------+--------------+-------------+--------------------------------------------------------------------------+ Response/Error Codes ==================== @@ -804,10 +813,6 @@ Response/Error Codes | | available | +------------------------+---------------------------------+ -Sample Request -============== - -curl -v -X PUT --user {user}:{password} -H "Content-Type: application/octet-stream" --data-binary @/opt/app/datartr/sampleFile.txt --location-trusted -k https://{host}:{port}/publish/{feedId}/sampleFile.txt Delete a Published file ----------------------- @@ -825,7 +830,7 @@ http[s]://{host}:{port}/publish/{feedId}/{fileId} Sample Request ============== -curl -v -X DELETE -H "X-ATT-DR-ON-BEHALF-OF: {user}" --location-trusted -k https:/{host}:{port}/publish/{feedId}/{fileId} +``curl -k -X DELETE --user {user}:{password} --location-trusted https://{host}:{port}/publish/{feedId}/{fileId}`` Response/Error Codes ==================== @@ -864,107 +869,112 @@ Feed logging Request URL =========== - http[s]://{host}:{port}/feedlog/{feedId}?{queryParameter} -* {feedId} : The id of the feed you want to get logs from -* {queryParameter}: A parameter passed through to narrow the returned logs. multiple parameters can be passed +* {feedId} : The id of the feed you want to get logs for +* {queryParameter}: A parameter passed through to narrow the returned logs. Multiple parameters can be passed. + + +Sample Request +============== + +``curl -k https://{host}:{port}/feedlog/{feedId}?statusCode=204`` Request parameters ================== -+------------------------+---------------------------------+------------------+------------+--------------+-------------+---------------------+--------------------------------------+ -| Name | Description | Param Type | Data Type | MaxLen | Required | Format | Valid/Example Values | -+========================+=================================+==================+============+==============+=============+=====================+======================================+ -| feedId | Id of the feed you want | Path | String | | N | | 1 | -| | logs from | | | | | | | -+------------------------+---------------------------------+------------------+------------+--------------+-------------+---------------------+--------------------------------------+ -| type | Select records of the | Path | String | | N | | * pub: Publish attempt | -| | specified type | | | | | | * del: Delivery attempt | -| | | | | | | | * exp: Delivery expiry | -+------------------------+---------------------------------+------------------+------------+--------------+-------------+---------------------+--------------------------------------+ -| publishId | Select records with specified | Path | String | | N | | | -| | publish id, carried in the | | | | | | | -| | X-ATT-DR-PUBLISH-ID header from | | | | | | | -| | original publish request | | | | | | | -+------------------------+---------------------------------+------------------+------------+--------------+-------------+---------------------+--------------------------------------+ -| start | Select records created at or | Path | String | | N | | A date-time expressed in the format | -| | after specified date | | | | | | specified by RFC 3339 | -+------------------------+---------------------------------+------------------+------------+--------------+-------------+---------------------+--------------------------------------+ -| end | Select records created at or | Path | String | | N | | A date-time expressed in the format | -| | before specified date | | | | | | specified by RFC 3339 | -+------------------------+---------------------------------+------------------+------------+--------------+-------------+---------------------+--------------------------------------+ -| statusCode | Select records with the | Path | String | | N | | An HTTP Integer status code or one | -| | specified statusCode field | | | | | | of the following special values: | -| | | | | | | | | -| | | | | | | | * Success: Any code between 200-299 | -| | | | | | | | * Redirect: Any code between 300-399 | -| | | | | | | | * Failure: Any code > 399 | -+------------------------+---------------------------------+------------------+------------+--------------+-------------+---------------------+--------------------------------------+ -| expiryReason | Select records with the | Path | String | | N | | | -| | specified expiry reason | | | | | | | -+------------------------+---------------------------------+------------------+------------+--------------+-------------+---------------------+--------------------------------------+ ++------------------------+---------------------------------+------------------+------------+--------------+-------------+--------------------------------------+ +| Name | Description | Param Type | Data Type | MaxLen | Required | Valid/Example Values | ++========================+=================================+==================+============+==============+=============+======================================+ +| feedId | Id of the feed you want | Path | String | | N | 1 | +| | logs for | | | | | | ++------------------------+---------------------------------+------------------+------------+--------------+-------------+--------------------------------------+ +| type | Select records of the | Path | String | | N | * pub: Publish attempt | +| | specified type | | | | | * del: Delivery attempt | +| | | | | | | * exp: Delivery expiry | ++------------------------+---------------------------------+------------------+------------+--------------+-------------+--------------------------------------+ +| publishId | Select records with specified | Path | String | | N | | +| | publish id, carried in the | | | | | | +| | X-DMAAP-DR-PUBLISH-ID header | | | | | | +| | from original publish request | | | | | | ++------------------------+---------------------------------+------------------+------------+--------------+-------------+--------------------------------------+ +| start | Select records created at or | Path | String | | N | A date-time expressed in the format | +| | after specified date | | | | | specified by RFC 3339 | ++------------------------+---------------------------------+------------------+------------+--------------+-------------+--------------------------------------+ +| end | Select records created at or | Path | String | | N | A date-time expressed in the format | +| | before specified date | | | | | specified by RFC 3339 | ++------------------------+---------------------------------+------------------+------------+--------------+-------------+--------------------------------------+ +| statusCode | Select records with the | Path | String | | N | An HTTP Integer status code or one | +| | specified statusCode field | | | | | of the following special values: | +| | | | | | | | +| | | | | | | * Success: Any code between 200-299 | +| | | | | | | * Redirect: Any code between 300-399 | +| | | | | | | * Failure: Any code > 399 | ++------------------------+---------------------------------+------------------+------------+--------------+-------------+--------------------------------------+ +| expiryReason | Select records with the | Path | String | | N | | +| | specified expiry reason | | | | | | ++------------------------+---------------------------------+------------------+------------+--------------+-------------+--------------------------------------+ Response Parameters =================== -+------------------------+-------------------------------------------+ -| Name | Description | -+========================+===========================================+ -| type | Record type: | -| | | -| | * pub: publication attempt | -| | * del: delivery attempt | -| | * exp: delivery expiry | -+------------------------+-------------------------------------------+ -| date | The UTC date and time at which the record | -| | was generated, with millisecond resolution| -| | in the format specified by RFC 3339 | -+------------------------+-------------------------------------------+ -| publishId | The unique identifier assigned by the DR | -| | at the time of the initial publication | -| | request (carried in the X-ATT-DRPUBLISH-ID| -| | header in the response to the original | -| | publish request) | -+------------------------+-------------------------------------------+ -| requestURI | The Request-URI associated with the | -| | request | -+------------------------+-------------------------------------------+ -| method | The HTTP method (PUT or DELETE) for the | -| | request | -+------------------------+-------------------------------------------+ -| contentType | The media type of the payload of the | -| | request | -+------------------------+-------------------------------------------+ -| contentLength | The size (in bytes) of the payload of | -| | the request | -+------------------------+-------------------------------------------+ -| sourceIp | The IP address from which the request | -| | originated | -+------------------------+-------------------------------------------+ -| endpointId | The identity used to submit a publish | -| | request to the DR | -+------------------------+-------------------------------------------+ -| deliveryId | The identity used to submit a delivery | -| | request to a subscriber endpoint | -+------------------------+-------------------------------------------+ -| statusCode | The HTTP status code in the response to | -| | the request. A value of -1 indicates that | -| | the DR was not able to obtain an HTTP | -| | status code | -+------------------------+-------------------------------------------+ -| expiryReason | The reason that delivery attempts were | -| | discontinued: | -| | | -| | * notRetryable: The last delivery attempt | -| | encountered an error condition for which| -| | the DR does not make retries. | -| | * retriesExhausted: The DR reached its | -| | limit for making further retry attempts | -+------------------------+-------------------------------------------+ -| attempts | Total number of attempts made before | -| | delivery attempts were discontinued | -+------------------------+-------------------------------------------+ ++------------------------+----------------------------------------------+ +| Name | Description | ++========================+==============================================+ +| type | Record type: | +| | | +| | * pub: publication attempt | +| | * del: delivery attempt | +| | * exp: delivery expiry | ++------------------------+----------------------------------------------+ +| date | The UTC date and time at which the record | +| | was generated, with millisecond resolution | +| | in the format specified by RFC 3339 | ++------------------------+----------------------------------------------+ +| publishId | The unique identifier assigned by the DR | +| | at the time of the initial publication | +| | request (carried in the X-DMAAP-DR-PUBLISH-ID| +| | header in the response to the original | +| | publish request) | ++------------------------+----------------------------------------------+ +| requestURI | The Request-URI associated with the | +| | request | ++------------------------+----------------------------------------------+ +| method | The HTTP method (PUT or DELETE) for the | +| | request | ++------------------------+----------------------------------------------+ +| contentType | The media type of the payload of the | +| | request | ++------------------------+----------------------------------------------+ +| contentLength | The size (in bytes) of the payload of | +| | the request | ++------------------------+----------------------------------------------+ +| sourceIp | The IP address from which the request | +| | originated | ++------------------------+----------------------------------------------+ +| endpointId | The identity used to submit a publish | +| | request to the DR | ++------------------------+----------------------------------------------+ +| deliveryId | The identity used to submit a delivery | +| | request to a subscriber endpoint | ++------------------------+----------------------------------------------+ +| statusCode | The HTTP status code in the response to | +| | the request. A value of -1 indicates that | +| | the DR was not able to obtain an HTTP | +| | status code | ++------------------------+----------------------------------------------+ +| expiryReason | The reason that delivery attempts were | +| | discontinued: | +| | | +| | * notRetryable: The last delivery attempt | +| | encountered an error condition for which | +| | the DR does not make retries. | +| | * retriesExhausted: The DR reached its | +| | limit for making further retry attempts | ++------------------------+----------------------------------------------+ +| attempts | Total number of attempts made before | +| | delivery attempts were discontinued | ++------------------------+----------------------------------------------+ Response/Error Codes ==================== @@ -991,7 +1001,7 @@ Response/Error Codes | 406 | Not Acceptable - The request has an Accept| | | header indicating that the requester will | | | not accept a response with | -| | application/vnd.att-dr.log-list content. | +| | application/vnd.dmaap-dr.log-list content.| +------------------------+-------------------------------------------+ | 500 | Internal Server Error - The DR API server | | | encountered an internal error and could | @@ -1001,12 +1011,8 @@ Response/Error Codes | | is currently unavailable | +------------------------+-------------------------------------------+ -Sample Request -============== -curl -v -k https://{host}:{port}/feedlog/{feedId}?statusCode=204 - -Subscriber logging +Subscription logging ------------------ **Description**: View logging information for specified subscriptions, which can be narrowed down with further parameters @@ -1014,109 +1020,114 @@ Subscriber logging Request URL =========== - http[s]://{host}:{port}/sublog/{subId}?{queryParameter} * {subId}: The id of the feed you want to get logs from -* {queryParameter}: A parameter passed through to narrow the returned logs. multiple parameters can be passed +* {queryParameter}: A parameter passed through to narrow the returned logs. Multiple parameters can be passed. + + +Sample Request +============== + +``curl -k https://{host}:{port}/sublog/{subId}?statusCode=204`` Request parameters ================== -+------------------------+---------------------------------+------------------+------------+--------------+-------------+---------------------+--------------------------------------+ -| Name | Description | Param Type | Data Type | MaxLen | Required | Format | Valid/Example Values | -+========================+=================================+==================+============+==============+=============+=====================+======================================+ -| subId | Id of the feed you want | Path | String | | N | | 1 | -| | logs from | | | | | | | -+------------------------+---------------------------------+------------------+------------+--------------+-------------+---------------------+--------------------------------------+ -| type | Select records of the | Path | String | | N | | * pub: Publish attempt | -| | specified type | | | | | | * del: Delivery attempt | -| | | | | | | | * exp: Delivery expiry | -+------------------------+---------------------------------+------------------+------------+--------------+-------------+---------------------+--------------------------------------+ -| publishId | Select records with specified | Path | String | | N | | | -| | publish id, carried in the | | | | | | | -| | X-ATT-DR-PUBLISH-ID header from | | | | | | | -| | original publish request | | | | | | | -+------------------------+---------------------------------+------------------+------------+--------------+-------------+---------------------+--------------------------------------+ -| start | Select records created at or | Path | String | | N | | A date-time expressed in the format | -| | after specified date | | | | | | specified by RFC 3339 | -+------------------------+---------------------------------+------------------+------------+--------------+-------------+---------------------+--------------------------------------+ -| end | Select records created at or | Path | String | | N | | A date-time expressed in the format | -| | before specified date | | | | | | specified by RFC 3339 | -+------------------------+---------------------------------+------------------+------------+--------------+-------------+---------------------+--------------------------------------+ -| statusCode | Select records with the | Path | String | | N | | An Http Integer status code or one | -| | specified statusCode field | | | | | | of the following special values: | -| | | | | | | | | -| | | | | | | | * Success: Any code between 200-299 | -| | | | | | | | * Sedirect: Any code between 300-399 | -| | | | | | | | * Sailure: Any code > 399 | -| | | | | | | | | -+------------------------+---------------------------------+------------------+------------+--------------+-------------+---------------------+--------------------------------------+ -| expiryReason | Select records with the | Path | String | | N | | | -| | specified expiry reason | | | | | | | -+------------------------+---------------------------------+------------------+------------+--------------+-------------+---------------------+--------------------------------------+ ++------------------------+---------------------------------+------------------+------------+--------------+-------------+--------------------------------------+ +| Name | Description | Param Type | Data Type | MaxLen | Required | Valid/Example Values | ++========================+=================================+==================+============+==============+=============+======================================+ +| subId | Id of the subscription you want | Path | String | | N | 1 | +| | logs for | | | | | | ++------------------------+---------------------------------+------------------+------------+--------------+-------------+--------------------------------------+ +| type | Select records of the | Path | String | | N | * pub: Publish attempt | +| | specified type | | | | | * del: Delivery attempt | +| | | | | | | * exp: Delivery expiry | ++------------------------+---------------------------------+------------------+------------+--------------+-------------+--------------------------------------+ +| publishId | Select records with specified | Path | String | | N | | +| | publish id, carried in the | | | | | | +| | X-DMAAP-DR-PUBLISH-ID header | | | | | | +| | from original publish request | | | | | | ++------------------------+---------------------------------+------------------+------------+--------------+-------------+--------------------------------------+ +| start | Select records created at or | Path | String | | N | A date-time expressed in the format | +| | after specified date | | | | | specified by RFC 3339 | ++------------------------+---------------------------------+------------------+------------+--------------+-------------+--------------------------------------+ +| end | Select records created at or | Path | String | | N | A date-time expressed in the format | +| | before specified date | | | | | specified by RFC 3339 | ++------------------------+---------------------------------+------------------+------------+--------------+-------------+--------------------------------------+ +| statusCode | Select records with the | Path | String | | N | An Http Integer status code or one | +| | specified statusCode field | | | | | of the following special values: | +| | | | | | | | +| | | | | | | * Success: Any code between 200-299 | +| | | | | | | * Redirect: Any code between 300-399 | +| | | | | | | * Failure: Any code > 399 | +| | | | | | | | ++------------------------+---------------------------------+------------------+------------+--------------+-------------+--------------------------------------+ +| expiryReason | Select records with the | Path | String | | N | | +| | specified expiry reason | | | | | | ++------------------------+---------------------------------+------------------+------------+--------------+-------------+--------------------------------------+ Response Parameters =================== -+------------------------+-------------------------------------------+ -| Name | Description | -+========================+===========================================+ -| type | Record type: | -| | | -| | * pub: publication attempt | -| | * del: delivery attempt | -| | * exp: delivery expiry | -+------------------------+-------------------------------------------+ -| date | The UTC date and time at which the record | -| | was generated, with millisecond resolution| -| | in the format specified by RFC 3339 | -+------------------------+-------------------------------------------+ -| publishId | The unique identifier assigned by the DR | -| | at the time of the initial publication | -| | request (carried in the X-ATT-DRPUBLISH-ID| -| | header in the response to the original | -| | publish request) to a feed log URL or | -| | subscription log URL known to the system | -+------------------------+-------------------------------------------+ -| requestURI | The Request-URI associated with the | -| | request | -+------------------------+-------------------------------------------+ -| method | The HTTP method (PUT or DELETE) for the | -| | request | -+------------------------+-------------------------------------------+ -| contentType | The media type of the payload of the | -| | request | -+------------------------+-------------------------------------------+ -| contentLength | The size (in bytes) of the payload of | -| | the request | -+------------------------+-------------------------------------------+ -| sourceIp | The IP address from which the request | -| | originated | -+------------------------+-------------------------------------------+ -| endpointId | The identity used to submit a publish | -| | request to the DR | -+------------------------+-------------------------------------------+ -| deliveryId | The identity used to submit a delivery | -| | request to a subscriber endpoint | -+------------------------+-------------------------------------------+ -| statusCode | The HTTP status code in the response to | -| | the request. A value of -1 indicates that | -| | the DR was not able to obtain an HTTP | -| | status code | -+------------------------+-------------------------------------------+ -| expiryReason | The reason that delivery attempts were | -| | discontinued: | -| | | -| | * notRetryable: The last delivery attempt | -| | encountered an error condition for which| -| | the DR does not make retries. | -| | * retriesExhausted: The DR reached its | -| | limit for making further retry attempts | -+------------------------+-------------------------------------------+ -| attempts | Total number of attempts made before | -| | delivery attempts were discontinued | -+------------------------+-------------------------------------------+ ++------------------------+---------------------------------------------+ +| Name | Description | ++========================+=============================================+ +| type | Record type: | +| | | +| | * pub: publication attempt | +| | * del: delivery attempt | +| | * exp: delivery expiry | ++------------------------+---------------------------------------------+ +| date | The UTC date and time at which the record | +| | was generated, with millisecond resolution | +| | in the format specified by RFC 3339 | ++------------------------+---------------------------------------------+ +| publishId | The unique identifier assigned by the DR | +| | at the time of the initial publication | +| | request(carried in the X-DMAAP-DR-PUBLISH-ID| +| | header in the response to the original | +| | publish request) to a feed log URL or | +| | subscription log URL known to the system | ++------------------------+---------------------------------------------+ +| requestURI | The Request-URI associated with the | +| | request | ++------------------------+---------------------------------------------+ +| method | The HTTP method (PUT or DELETE) for the | +| | request | ++------------------------+---------------------------------------------+ +| contentType | The media type of the payload of the | +| | request | ++------------------------+---------------------------------------------+ +| contentLength | The size (in bytes) of the payload of | +| | the request | ++------------------------+---------------------------------------------+ +| sourceIp | The IP address from which the request | +| | originated | ++------------------------+---------------------------------------------+ +| endpointId | The identity used to submit a publish | +| | request to the DR | ++------------------------+---------------------------------------------+ +| deliveryId | The identity used to submit a delivery | +| | request to a subscriber endpoint | ++------------------------+---------------------------------------------+ +| statusCode | The HTTP status code in the response to | +| | the request. A value of -1 indicates that | +| | the DR was not able to obtain an HTTP | +| | status code | ++------------------------+---------------------------------------------+ +| expiryReason | The reason that delivery attempts were | +| | discontinued: | +| | | +| | * notRetryable: The last delivery attempt | +| | encountered an error condition for which | +| | the DR does not make retries. | +| | * retriesExhausted: The DR reached its | +| | limit for making further retry attempts | ++------------------------+---------------------------------------------+ +| attempts | Total number of attempts made before | +| | delivery attempts were discontinued | ++------------------------+---------------------------------------------+ Response/Error Codes ==================== @@ -1143,7 +1154,7 @@ Response/Error Codes | 406 | Not Acceptable - The request has an Accept| | | header indicating that the requester will | | | not accept a response with | -| | application/vnd.att-dr.log-list content. | +| | application/vnd.dmaap-dr.log-list content.| +------------------------+-------------------------------------------+ | 500 | Internal Server Error - The DR API server | | | encountered an internal error and could | @@ -1152,8 +1163,3 @@ Response/Error Codes | 503 | Service Unavailable - The DR API service | | | is currently unavailable | +------------------------+-------------------------------------------+ - -Sample Request -============== - -curl -v -k https://{host}:{port}/sublog/{subscriberId}?statusCode=204 \ No newline at end of file