|
|
| (8 intermediate revisions by 2 users not shown) |
| Line 1: |
Line 1: |
| | __NOTOC__ | | __NOTOC__ |
| − | = Marconi API: v1 Blueprint =
| + | <!-- ## page was renamed from marconi-grizzly-spec-api --> |
| − | | + | = Marconi API (Grizzly Blueprint) = |
| − | See also: [[marconi/specs/grizzly]]
| |
| − | | |
| − | == Overview ==
| |
| − | | |
| − | Marconi provides an HTTP-based API in the spirit of the [https://en.wikipedia.org/wiki/Representational_state_transfer REST architecture style].
| |
| − | | |
| − | REST is a natural fit for Marconi's design philosophy, shamelessly borrowed from Donald A. Norman's work regarding The Design of Everyday Things:
| |
| − | | |
| − | The value of a well-designed object is when it has such a rich set of affordances that the people who use it can do things with it that the designer never imagined.
| |
| − | | |
| − | This guide assumes the reader is familiar with REST, HTTP/1.1, JSON and XML. URI templates are specified according to [http://tools.ietf.org/html/rfc6570 RFC 6570].
| |
| − | | |
| − | == Common API Elements ==
| |
| − | | |
| − | ''' HTTPS '''
| |
| − | | |
| − | All requests to authenticate and operate against the API in production environments use SSL/TLS over HTTP (HTTPS) on TCP port 443. Web servers should only accept high-quality cipher suites, such as AES256_SHA and ECDHE_RSA_AES256_SHA. If hardware acceleration (e.g., AES_NI) is not available, RC4_SHA and ECDHE_RSA_RC4_SHA may be used with some discretion.
| |
| − | | |
| − | ''' Clients '''
| |
| − | | |
| − | * Clients should follow HTTP redirects
| |
| − | * Clients should advertise gzip support
| |
| − | * Clients must identify themselves in the [[UserAgent]] request header; e.g., "User-Agent: python/2.7 cloudthing/1.2"
| |
| − | * Clients must not hard-code URI paths or templates since they may change over time. Instead, clients should cache links and link templates provided by the API.
| |
| − | | |
| − | ''' API Versioning '''
| |
| − | | |
| − | The Marconi API uses a URI versioning scheme. The first element of the path contains the target version identifier, e.g.:
| |
| − | | |
| − | | |
| − | <pre><nowiki>
| |
| − | https://marconi.example.com/v1
| |
| − | </nowiki></pre>
| |
| − | | |
| − | | |
| − | The URI version will only be incremented to accomodate major new features or API redesigns that can not be made backwards-compatible. When new API versions are released, older versions are deprecated. Marconi maintainers will work with developers and partners to ensure there is adequate time to migrate to new versions before deprecated ones are discontinued.
| |
| − | | |
| − | Since the base URI is only incremented to accommodate major API revisions, sub-versioning of the API is meaningless and is therefore not used. For example, the next version after "v1" would be "v2", not "v1.1" or some variant thereof. (HATEOS and media types are used in lieu of minor, URI-based versioning.)
| |
| − | | |
| − | ''' Resource Media Types '''
| |
| − | | |
| − | The API supports `application/json` and `application/xml`, encoded as UTF-8. Gzip'd requests are optionally supported by the server.
| |
| − | | |
| − | Unrecognised protocol elements should be ignored. This includes XML elements and attributes, JSON object properties, link relation types, media types, etc.
| |
| − | | |
| − | TODO: Define and register message media type/ messages media type - http://www.iana.org/assignments/media-types/index.html
| |
| − | | |
| − | ''' Authentication '''
| |
| − | | |
| − | All requests to the API may only be performed by an authenticated agent.
| |
| − | | |
| − | To authenticate, an agent issues an authentication request to a Keystone Identity Service endpoint.
| |
| − | | |
| − | In response to valid credentials, Keystone responds with an auth token and a service catalog that contains a list of all services and endpoints available for the given token. Multiple endpoints may be returned for Marconi according to physical locations and performance/availability characteristics of different deployments.
| |
| − | | |
| − | Marconi clients must specify a valid auth token in the `X-Auth-Token` header for each request to the Marconi API. The API validates auth tokens against Keystone before servicing each request.
| |
| − | | |
| − | ''' Authorization '''
| |
| − | | |
| − | TBD: The API needs to verify read/write access to all endpoints according to the provided auth token.
| |
| − | | |
| − | ''' Request Signing '''
| |
| − | | |
| − | Messages may optionally contain a signature to verify its authenticity.
| |
| − | | |
| − | TODO: How to register and query public keys? Via Keystone? Shouldn't be part of Marconi, in any case.
| |
| − | | |
| − | How to calculate signature?
| |
| − | | |
| − | [[SecP256K1]] or something using RSA-2048? (encrypt a SHA-512 value). Would be nice to allow different schemes... How is Ceilometer doing it?
| |
| − | | |
| − | See also: http://stackoverflow.com/questions/9897023/asymmetric-hmac#
| |
| − | | |
| − | ''' Tenant ID '''
| |
| − | | |
| − | Auth tokens are only valid for a particular tenant ID, which should be reflected in the service endpoints retrieved from Keystone. Agents use the given endpoint as a home document href from which to discover links to all other API requests.
| |
| − | | |
| − | An example endpoint:
| |
| − | | |
| − | | |
| − | <pre><nowiki>
| |
| − | https://marconi.example.com/v1/480924
| |
| − | </nowiki></pre>
| |
| − | | |
| − | | |
| − | The client chooses one of the presented endpoints and uses it as the base URL for all subsequent requests.
| |
| − | | |
| − | ''' Caching '''
| |
| − | | |
| − | @todo
| |
| − | | |
| − | Can be used to save bandwidth at the expense of server CPU and/or added complexity. Provide an ETag for results, the client submits in subsequent request using the If-None-Match header. Server performs query against data store, dynamically generates ETag, compares to client's ETag, and returns 204 if-and-only-if the two ETags don't match. This is especially helpful in cutting down on duplicate traffic due to the inability of the server to guarantee message ordering.
| |
| − | | |
| − | ''' Errors '''
| |
| − | | |
| − | If any request results in an error, the server will return an appropriate 4xx or 5xx HTTP status code, as well as the following information in the body:
| |
| − | | |
| − | * Title
| |
| − | * Description
| |
| − | * Internal code
| |
| − | * Link to more information
| |
| − | | |
| − | Example:
| |
| − | | |
| − | | |
| − | <pre><nowiki>
| |
| − | HTTP/1.1 400 Bad Request
| |
| − | Content-Type: application/json
| |
| − | | |
| − | {
| |
| − | "title": "Unsupported limit",
| |
| − | "description": "The given limit cannot be negative, and cannot be greater than 50.",
| |
| − | "code": 1092,
| |
| − | "link": {
| |
| − | "rel": "api-doc",
| |
| − | "href": "http://example.com/marconi/docs/messages#limit",
| |
| − | "text": "API documentation for the limit parameter"
| |
| − | }
| |
| − | }
| |
| − | </nowiki></pre>
| |
| − | | |
| − | | |
| − | ''' Common Headers '''
| |
| − | | |
| − | Each request to the API must include certain standard and extended HTTP headers. These headers provide host, agent, authentication and other pertinent information to the server.
| |
| − | | |
| − | {| border="1" cellpadding="2" cellspacing="0"
| |
| − | | '''Header'''
| |
| − | | '''Description'''
| |
| − | |-
| |
| − | | Host
| |
| − | | The host name of the API, as referenced by the Keystone service catalog
| |
| − | |-
| |
| − | | User-Agent
| |
| − | | The name and version of the Marconi client, as well as a UUID for that client. Marconi uses the UUID to distinguish publishers from subscribers, i.e., to avoid echoing an agent's own messages back to it.
| |
| − | |-
| |
| − | | Date
| |
| − | | The current date and time, using the standard RFC 1123 HTTP date format
| |
| − | |-
| |
| − | | Accept
| |
| − | | Media type desired; may be either `application/json` or `application/xml`
| |
| − | |-
| |
| − | | Accept-Encoding
| |
| − | | Specifies that the agent accepts gzip-encoded response bodies
| |
| − | |-
| |
| − | | Content-Length
| |
| − | | For POST or PUT requests, the length in bytes of the JSON or XML document being submitted
| |
| − | |-
| |
| − | | X-Auth-Token
| |
| − | | Keystone auth token
| |
| − | |}
| |
| − | | |
| − | == Sample API Request ==
| |
| − | | |
| − | | |
| − | <pre><nowiki>
| |
| − | GET /v1/480924/messages?tags=channel-foo,topic-bar&ts=1355237242783&limit=10 HTTP/1.1
| |
| − | Host: marconi.example.com
| |
| − | User-Agent: python/2.7 killer-rabbit/1.2 uuid/30387f00-39a0-11e2-be4d-a8d15f34bae2
| |
| − | Date: Wed, 28 Nov 2012 21:14:19 GMT
| |
| − | Accept: application/json
| |
| − | Accept-Encoding: gzip
| |
| − | X-Auth-Token: 7d2f63fd-4dcc-4752-8e9b-1d08f989cc00
| |
| − | </nowiki></pre>
| |
| − | | |
| − | | |
| − | == Get Home Document == | |
| − | | |
| − | '''Request Template'''
| |
| − | | |
| − | | |
| − | <pre><nowiki>
| |
| − | GET {base_url}
| |
| − | </nowiki></pre>
| |
| − | | |
| − | | |
| − | '''Request'''
| |
| − | | |
| − | | |
| − | <pre><nowiki>
| |
| − | GET /v1/480924 HTTP/1.1
| |
| − | Host: marconi.example.com
| |
| − | | |
| − | [...]
| |
| − | | |
| − | </nowiki></pre>
| |
| − | | |
| − | | |
| − | '''Response'''
| |
| − | | |
| − | | |
| − | <pre><nowiki>
| |
| − | @todo
| |
| − | </nowiki></pre>
| |
| − | | |
| − | | |
| − | '''Discussion'''
| |
| − | | |
| − | The entire Marconi API is discoverable from a single starting point; agents do not need to know any more than this one URI in order to explore the entire API.
| |
| − | | |
| − | See also: http://tools.ietf.org/html/draft-nottingham-json-home-02
| |
| − | | |
| − | == Get a Specific Message ==
| |
| − | | |
| − | '''Request Template'''
| |
| − | | |
| − | | |
| − | <pre><nowiki>
| |
| − | GET {base_url}/messages/{messageId}
| |
| − | </nowiki></pre>
| |
| − | | |
| − | | |
| − | '''Request'''
| |
| − | | |
| − | | |
| − | <pre><nowiki>
| |
| − | GET /v1/480924/messages/50b68a50d6f5b8c8a7c62b01 HTTP/1.1
| |
| − | Host: marconi.example.com
| |
| − | | |
| − | [...]
| |
| − | | |
| − | </nowiki></pre>
| |
| − | | |
| − | | |
| − | '''Response'''
| |
| − | | |
| − | | |
| − | <pre><nowiki>
| |
| − | HTTP/1.1 200 OK
| |
| − | | |
| − | [...]
| |
| − | | |
| − | {
| |
| − | "id": 50b68a50d6f5b8c8a7c62b01,
| |
| − | "userAgent": "python/2.7 killer-rabbit/1.2 uuid/79ed56f8-2519-11e2-b835-acf6018e45a1",
| |
| − | "age": 790,
| |
| − | "tags": [
| |
| − | foo,
| |
| − | snap,
| |
| − | bar,
| |
| − | bang
| |
| − | ],
| |
| − | "signature": {
| |
| − | "scheme": "SecP256K1",
| |
| − | "salt": "b8c850d6f5b8a7c6",
| |
| − | "value": "T2gJfGQNgUe1XMDHyucwH27zn628it0fWrCFgE2mPWR+oMTOiW7jb1OPNuZtLus5O1IzTzy+5ALyLCyUq7JoLQ=="
| |
| − | },
| |
| − | "body": {
| |
| − | "event": "ActivateAccount",
| |
| − | "mode": "active"
| |
| − | }
| |
| − | }
| |
| − | </nowiki></pre>
| |
| − | | |
| − | | |
| − | '''Discussion'''
| |
| − | | |
| − | @todo Define message fields.
| |
| − | | |
| − | == Get Messages ==
| |
| − | | |
| − | '''Request Template'''
| |
| − | | |
| − | | |
| − | <pre><nowiki>
| |
| − | GET {base_url}/messages{?tags,ts,limit,sort,meta,echo}
| |
| − | </nowiki></pre>
| |
| − | | |
| − | | |
| − | '''Request'''
| |
| − | | |
| − | | |
| − | <pre><nowiki>
| |
| − | GET /v1/480924/messages?tags=foo,bar,bang&ts=1355237242783&limit=10&sort=desc HTTP/1.1
| |
| − | Host: marconi.example.com
| |
| − | | |
| − | [...]
| |
| − | | |
| − | </nowiki></pre>
| |
| − | | |
| − | | |
| − | '''Response'''
| |
| − | | |
| − | HTTP 200 if the query matched 1 or more messages, HTTP 204 otherwise (with no body).
| |
| − | | |
| − | | |
| − | <pre><nowiki>
| |
| − | HTTP/1.1 200 OK
| |
| − | ETag: "2:fa0d1a60ef6616bb28038515c8ea4cb2"
| |
| − | | |
| − | [...]
| |
| − | | |
| − | {
| |
| − | "messageCount": 1,
| |
| − | "links": [
| |
| − | {
| |
| − | "rel": "self"
| |
| − | "href-template": "{base_url}/messages?tags=foo,bar,bang&ts=1355237242783&limit=10&sort=desc"
| |
| − | },
| |
| − | {
| |
| − | "rel": "next"
| |
| − | "href-template": "{base_url}/messages?tags=foo,bar,bang&ts=1355237244190&limit=10&sort=desc"
| |
| − | }
| |
| − | ],
| |
| − | "messages": [
| |
| − | {
| |
| − | "id": 50b68a50d6f5b8c8a7c62b01,
| |
| − | "href-template": "{base_url}/messages/{id}"
| |
| − | "userAgent": "python/2.7 killer-rabbit/1.2 uuid/79ed56f8-2519-11e2-b835-acf6018e45a1",
| |
| − | "ts": 1355237244190
| |
| − | "age": 790,
| |
| − | "tags": [
| |
| − | foo,
| |
| − | snap,
| |
| − | bar,
| |
| − | bang
| |
| − | ],
| |
| − | "signature": {
| |
| − | "scheme": "SecP256K1",
| |
| − | "salt": "b8c850d6f5b8a7c6",
| |
| − | "value": "T2gJfGQNgUe1XMDHyucwH27zn628it0fWrCFgE2mPWR+oMTOiW7jb1OPNuZtLus5O1IzTzy+5ALyLCyUq7JoLQ=="
| |
| − | },
| |
| − | "body": {
| |
| − | "event": "ActivateAccount",
| |
| − | "mode": "active"
| |
| − | }
| |
| − | }
| |
| − | ]
| |
| − | }
| |
| − | </nowiki></pre>
| |
| − | | |
| − | | |
| − | Example meta-messages response (if a client were to add meta=true to the sample query).
| |
| − | | |
| − | <pre><nowiki>
| |
| − | HTTP/1.1 200 OK
| |
| − | ETag: "2:fa0d1a60ef6616bb28038515c8ea4cb2"
| |
| − | | |
| − | [...]
| |
| − | | |
| − | {
| |
| − | "messageCount": 2,
| |
| − | "links": [
| |
| − | {
| |
| − | "rel": "self"
| |
| − | "href-template": "{base_url}/messages?tags=foo,bar,bang&ts=1355237242783&limit=10&sort=desc&meta=true"
| |
| − | },
| |
| − | {
| |
| − | "rel": "next"
| |
| − | "href-template": "{base_url}/messages?tags=foo,bar,bang&ts=1355237244210&limit=10&sort=desc&meta=true"
| |
| − | }
| |
| − | ],
| |
| − | "messages": [
| |
| − | {
| |
| − | "id": 10b00a50d6f5b8c8a7c62ccc,
| |
| − | "href-template": "{base_url}/messages/{id}"
| |
| − | "userAgent": "marconi/1 uuid/f2e4b36a-3f05-11e2-b71d-7823d2b0f3ce",
| |
| − | "ts": 1355237242783,
| |
| − | "age": 790,
| |
| − | "tags": [
| |
| − | foo,
| |
| − | snap,
| |
| − | bar,
| |
| − | bang
| |
| − | ],
| |
| − | "body": {
| |
| − | "event": "MessageCreated",
| |
| − | "timestamp": "2012-12-04 16:53:20Z",
| |
| − | "details": {
| |
| − | "messageId": "50b68a50d6f5b8c8a7c62b01",
| |
| − | "userAgent": "python/2.7 killer-rabbit/1.2 uuid/79ed56f8-2519-11e2-b835-acf6018e45a1",
| |
| − | }
| |
| − | }
| |
| − | },
| |
| − | {
| |
| − | "id": 10b00a50d6f5b8c8a7c62ccb,
| |
| − | "href-template": "{base_url}/messages/{id}"
| |
| − | "userAgent": "marconi/1 uuid/f2e4b36a-3f05-11e2-b71d-7823d2b0f3ce",
| |
| − | "ts": 1355237244210,
| |
| − | "age": 792,
| |
| − | "tags": [
| |
| − | foo,
| |
| − | snap,
| |
| − | bar,
| |
| − | bang
| |
| − | ],
| |
| − | "body": {
| |
| − | "event": "LockExpired",
| |
| − | "timestamp": "2012-12-04 16:53:18Z",
| |
| − | "details": {
| |
| − | "messageId": "50b68a50d6f5b8c8a7c62a87",
| |
| − | "userAgent": "python/2.7 killer-rabbit/1.2 uuid/79ed56f8-2519-11e2-b835-acf6018e45a1",
| |
| − | }
| |
| − | }
| |
| − | }
| |
| − | ]
| |
| − | }
| |
| − | </nowiki></pre>
| |
| − | | |
| − | | |
| − | '''Discussion'''
| |
| − | | |
| − | Message IDs are opaque strings; clients should make no assumptions on their format or length, except that IDs may not exceed 50 characters in length.
| |
| − | | |
| − | <code><nowiki>tags</nowiki></code> is a list of up to n message tags, where n >= 2. The maximum number of tags supported is configurable. The API will return only those messages containing ALL of the specified tags. If no tags are specified, all messages are returned.
| |
| − | | |
| − | <code><nowiki>limit</nowiki></code> specifies up to x messages to return. Note that x is configurable, but must be at least 10. If not specified, limit defaults to x. When more messages are available than can be returned in a single request, the client can pick up the next batchby simply using the URI template parameters returned from the previous call in the "next" field (TBD).
| |
| − | | |
| − | <code><nowiki>ts</nowiki></code> is the timestamp (64-bit UNIX timestamp in milliseconds) from the last message the client saw (relative to the server - use the "ts" message field). The API will return messages that were enqueued after the specified time, minus ''t'' milliseconds, where t is an implementation-defined number of milliseconds within which the server cannot guarantee message ordering (admittedly, a leaky abstraction). The client must cache messages for t milliseconds in order to check for duplicates returned in subsequent requests. Note that the message having the exact given timestamp (ts) will probably be part of the result set unless that particular message has expired or an ETag submitted by the client allows the server to definitively determine that no new messages match the given query string since the last request.
| |
| − | | |
| − | Note: If <code><nowiki>ts</nowiki></code> is not specified, the API will return all messages.
| |
| − | | |
| − | <code><nowiki>sort</nowiki></code> specifies how to chronologically order results. Use "asc" or "desc" for ascending or descending, respectively. If sort is not given, the API will return results in ascending order (oldest message first).
| |
| − | | |
| − | <code><nowiki>meta</nowiki></code> is a boolean value (i.e., "true" or "false") that determines whether the API will return actual messages or meta-messages. Meta-messages are "messages about messages", and are automatically generated by the server. Clients may query for meta-messages to audit business processes or to diagnose data flow issues. The default value for <code><nowiki>meta</nowiki></code> is "false".
| |
| − | | |
| − | <code><nowiki>echo</nowiki></code> is a boolean (i.e., "true" or "false") that determines whether or not the API will return a client's own messages, as determined by the uuid portion of the User-Agent header. If not specified, echo defaults to "false".
| |
| − | | |
| − | == Post Messages ==
| |
| − | | |
| − | '''Request Template'''
| |
| − | | |
| − | | |
| − | <pre><nowiki>
| |
| − | POST {base_url}/messages
| |
| − | </nowiki></pre>
| |
| − | | |
| − | | |
| − | '''Request'''
| |
| − | | |
| − | | |
| − | <pre><nowiki>
| |
| − | POST /v1/480924/messages HTTP/1.1
| |
| − | Host: marconi.example.com
| |
| − | | |
| − | [...]
| |
| − | | |
| − | | |
| − | [
| |
| − | {
| |
| − | "ttl": 10,
| |
| − | "durability": 3,
| |
| − | "tags": [420D29D6-3F24-11E2-BC14-7823D2B0F3CE, checkpoint]
| |
| − | "signature": {
| |
| − | "scheme": "SecP256K1",
| |
| − | "salt": "b8c850d6f5b8a7c6",
| |
| − | "value": "T2gJfGQNgUe1XMDHyucwH27zn628it0fWrCFgE2mPWR+oMTOiW7jb1OPNuZtLus5O1IzTzy+5ALyLCyUq7JoLQ=="
| |
| − | },
| |
| − | "body": {
| |
| − | "event": "BackupStarted",
| |
| − | "backupId": "c378813c-3f0b-11e2-ad92-7823d2b0f3ce"
| |
| − | }
| |
| − | },
| |
| − | {
| |
| − | "tags": [420D29D6-3F24-11E2-BC14-7823D2B0F3CE, progress]
| |
| − | "body": {
| |
| − | "event": "BackupProgress",
| |
| − | "currentBytes": "0",
| |
| − | "totalBytes": "99614720"
| |
| − | }
| |
| − | }
| |
| − | ]
| |
| − | </nowiki></pre>
| |
| − | | |
| − | | |
| − | '''Responses'''
| |
| − | | |
| − | When a single message is submitted:
| |
| − | | |
| − | | |
| − | <pre><nowiki>
| |
| − | HTTP/1.1 201 Created
| |
| − | Location: https://marconi.example.com/v1/480924/messages/50b68a50d6f5b8c8a7c62b01
| |
| − | </nowiki></pre>
| |
| − | | |
| − | | |
| − | When multiple messages are submitted:
| |
| − | | |
| − | | |
| − | <pre><nowiki>
| |
| − | HTTP/1.1 201 Created
| |
| − | Location: https://marconi.example.com/v1/480924/messages&ts=1355237242783
| |
| − | </nowiki></pre>
| |
| − | | |
| − | | |
| − | '''Discussion'''
| |
| − | | |
| − | One or more messages may be submitted in a single request, but must always be encapsulated in a collection container (an array in JSON, a parent tag in XML). In the case of a batch POST, querying the returned <code><nowiki>Location</nowiki></code> may return messages posted concurrently by other agents.
| |
| − | | |
| − | <code><nowiki>ttl</nowiki></code> is the number of seconds the server will keep a message before automatically deleting it. Should be long enough to give all observers ample time to retrieve the message. If not specified, defaults to the maximum default set for any of the message's associated tags, or the default set for the tenant (TBD), or the one configured in the deployment (?).
| |
| − | | |
| − | <code><nowiki>tags</nowiki></code> is a list of up to n tags to associate with a given message, where n >= 2. The maximum number of tags supported is configurable (the default is 5). The maximum length of each tag is likewise configurable (with a default of 150 characters). Tags are case-sensitive.
| |
| − | | |
| − | <code><nowiki>signature</nowiki></code> - TBD, probably something like sign(hash(salt + payload))
| |
| − | | |
| − | <code><nowiki>body</nowiki></code> specifies a custom document which constitutes the body of the message being sent. The size of this body, in characters and including whitespace, is configurable (the default is 64 KiB).
| |
| − | | |
| − | <code><nowiki>durability</nowiki></code> requests a certain durability guarantee from the server. The purpose of this parameter is to allow clients to dynamically make tradeoffs between durability and cost/performance depending on the type of message being sent. Note that the maximum durability level supported by the server is configurable; not all deployments will support all levels. If a level is unsupported, the server will return 400 Bad Request. If a level is supported but the server is unable to complete the request, and appropriate 5xx error will be returned to the client.
| |
| − | | |
| − | The following levels are defined:
| |
| − | | |
| − | {| border="1" cellpadding="2" cellspacing="0"
| |
| − | | Level
| |
| − | |-
| |
| − | | 0
| |
| − | |-
| |
| − | | 1
| |
| − | |-
| |
| − | | 2
| |
| − | | Guaranteed to be replicated across two or more storage servers.
| |
| − | |-
| |
| − | | 3
| |
| − | | Guaranteed to be replicated across two or more zones within the same data center.
| |
| − | |-
| |
| − | | 4
| |
| − | |}
| |
| − | | |
| − | Note that higher durability levels assume the guarantees (if any) of all lower levels.
| |
| − | | |
| − | == Delete a Single Message ==
| |
| − | | |
| − | '''Request Template'''
| |
| − | | |
| − | | |
| − | <pre><nowiki>
| |
| − | DELETE {base_url}/messages/{message_id}{?lock_id}
| |
| − | </nowiki></pre>
| |
| − | | |
| − | | |
| − | '''Request'''
| |
| − | | |
| − | | |
| − | <pre><nowiki>
| |
| − | DELETE /v1/480924/messages/50b68a50d6f5b8c8a7c62b01 HTTP/1.1
| |
| − | Host: marconi.example.com
| |
| − | | |
| − | [...]
| |
| − | | |
| − | </nowiki></pre>
| |
| − | | |
| − | | |
| − | '''Response'''
| |
| − | | |
| − | | |
| − | <pre><nowiki>
| |
| − | HTTP/1.1 204 No Content
| |
| − | </nowiki></pre>
| |
| − | | |
| − | | |
| − | '''Discussion'''
| |
| − | | |
| − | <code><nowiki>message_id</nowiki></code> specifies the message to delete.
| |
| − | | |
| − | <code><nowiki>lock_id</nowiki></code> specifies that the message should only be deleted if it has the specified transactional lock, and that lock has not expired. This is useful for ensuring only one agent processes any given message; whenever a worker client's lock expires before it has a chance to delete a message it has processed, the worker must roll back any actions it took based on that message, since another worker will likely process the same message as part of a different transaction.
| |
| − | | |
| − | == Delete Several Messages ==
| |
| − | | |
| − | '''Request Template'''
| |
| − | | |
| − | | |
| − | <pre><nowiki>
| |
| − | DELETE {base_url}/messages{?tags,all,lock_id}
| |
| − | </nowiki></pre>
| |
| − | | |
| − | | |
| − | '''Request'''
| |
| − | | |
| − | | |
| − | <pre><nowiki>
| |
| − | DELETE /v1/480924/messages?tags=420D29D6-3F24-11E2-BC14-7823D2B0F3CE HTTP/1.1
| |
| − | Host: marconi.example.com
| |
| − | | |
| − | [...]
| |
| − | | |
| − | </nowiki></pre>
| |
| − | | |
| − | | |
| − | '''Response'''
| |
| − | | |
| − | | |
| − | <pre><nowiki>
| |
| − | HTTP/1.1 200 OK
| |
| − | | |
| − | [...]
| |
| − | | |
| − | {
| |
| − | "messageCount": 43
| |
| − | }
| |
| − | </nowiki></pre>
| |
| − | | |
| − | | |
| − | '''Discussion'''
| |
| − | | |
| − | <code><nowiki>tags</nowiki></code> specifies that only messages having the given tags will be deleted. To avoid accidentally deleting all messages for a given tenant, if <code><nowiki>tags</nowiki></code> is not specified, <code><nowiki>all</nowiki></code> must equal "true"; otherwise, no messages will be deleted and the server will return 400 Bad Request. Tags are case-sensitive.
| |
| − | | |
| − | <code><nowiki>all</nowiki></code> is a boolean value (i.e., "true" or "false") that determines whether all messages will be deleted in the case that no tags are specified. If tags ''are'' specified, however, the server simply ignores <code><nowiki>all</nowiki></code>.
| |
| − | | |
| − | <code><nowiki>lock_id</nowiki></code> specifies that messages should only be deleted if they have the specified transactional lock, and that lock has not expired.
| |
| − | | |
| − | The server returns the number of messages deleted.
| |
| − | | |
| − | == Lock Messages ==
| |
| − | | |
| − | '''Request Template'''
| |
| − | | |
| − | | |
| − | <pre><nowiki>
| |
| − | POST {base_url}/messages/locks{?tags,limit}
| |
| − | </nowiki></pre>
| |
| − | | |
| − | | |
| − | '''Request'''
| |
| − | | |
| − | | |
| − | <pre><nowiki>
| |
| − | POST /v1/480924/messages/locks?tags=686897696a7c876b7e&limit=5
| |
| − | | |
| − | [...]
| |
| − |
| |
| − | {
| |
| − | "ttl": 30
| |
| − | }
| |
| − | </nowiki></pre>
| |
| − | | |
| − | | |
| − | '''Response'''
| |
| − | | |
| − | The client receives a lock ID and a list of locked messages, if any:
| |
| − | | |
| − | | |
| − | <pre><nowiki>
| |
| − | @todo
| |
| − | | |
| − | {
| |
| − | "lock": {
| |
| − | "id": "9206ebcc0939d18c351e994555de97b9",
| |
| − | "ttl": 30,
| |
| − | "age": 0
| |
| − | },
| |
| − | "messages": [
| |
| − | ...
| |
| − | ]
| |
| − | }
| |
| − | </nowiki></pre>
| |
| − | | |
| − | | |
| − | '''Discussion'''
| |
| − | | |
| − | Locks a set of messages, up to limit, from oldest to newest, skipping any that are already locked.
| |
| − | | |
| − | Lock TTL should be <= message TTLs. If it is not, the messages will expire and be
| |
| − | | |
| − | <code><nowiki>limit</nowiki></code> specifies up to x messages to lock. Note that x is configurable, but must be at least 10. If not specified, limit defaults to x.
| |
| − | | |
| − | == Check the Status of a Lock ==
| |
| − | | |
| − | '''Request Template'''
| |
| − | | |
| − | | |
| − | <pre><nowiki>
| |
| − | GET {base_url}/messages/locks/{lock_id}
| |
| − | </nowiki></pre>
| |
| − | | |
| − | | |
| − | | |
| − | <pre><nowiki>
| |
| − | GET /v1/480924/messages/locks/9206ebcc0939d18c351e994555de97b9
| |
| − | | |
| − | [...]
| |
| − | | |
| − | </nowiki></pre>
| |
| − | | |
| − | | |
| − | '''Response'''
| |
| − | | |
| − | | |
| − | <pre><nowiki>
| |
| − | {
| |
| − | "id": "9206ebcc0939d18c351e994555de97b9",
| |
| − | "ttl": 30,
| |
| − | "age": 17
| |
| − | }
| |
| − | </nowiki></pre>
| |
| − | | |
| − | | |
| − | '''Discussion'''
| |
| − | | |
| − | This query may be used to check the age of a given lock (relative to the server's clock).
| |
| − | | |
| − | == Renew a Lock ==
| |
| − | | |
| − | '''Request Template'''
| |
| − | | |
| − | | |
| − | <pre><nowiki>
| |
| − | PATCH {base_url}/messages/locks/9206ebcc0939d18c351e994555de97b9
| |
| − | </nowiki></pre>
| |
| − | | |
| − | | |
| − | '''Request'''
| |
| − | | |
| − | | |
| − | <pre><nowiki>
| |
| − | PATCH /v1/480924/messages/locks/9206ebcc0939d18c351e994555de97b9
| |
| − | | |
| − | [...]
| |
| − |
| |
| − | [
| |
| − | {
| |
| − | "replace": "/age",
| |
| − | "value": 0
| |
| − | }
| |
| − | ]
| |
| − | </nowiki></pre>
| |
| − | | |
| − | | |
| − | '''Response'''
| |
| − | | |
| − | | |
| − | <pre><nowiki>
| |
| − | HTTP/1.1 204 No Content
| |
| − | </nowiki></pre>
| |
| − | | |
| − | | |
| − | '''Discussion'''
| |
| − | | |
| − | Clients should periodically renew locks during long-running batches of work to avoid loosing a lock in the middle of processing a message. The server only accepts "0" for the age value.
| |
| − | | |
| − | == Count Messages ==
| |
| − | | |
| − | '''Request Template'''
| |
| − | | |
| − | | |
| − | <pre><nowiki>
| |
| − | HEAD /{version}/{tenant}/messages{?tags,ts,meta,echo}
| |
| − | </nowiki></pre>
| |
| − | | |
| − | | |
| − | '''Request'''
| |
| − | | |
| − | | |
| − | <pre><nowiki>
| |
| − | HEAD /v1/480924/messages?tags=foo,bar,bang&ts=1355237242783 HTTP/1.1
| |
| − | Host: marconi.example.com
| |
| − | | |
| − | [...]
| |
| − | | |
| − | </nowiki></pre>
| |
| − | | |
| − | | |
| − | '''Response'''
| |
| − | HTTP/1.1 200 OK
| |
| − | | |
| − | | |
| − | <pre><nowiki>
| |
| − | {
| |
| − | "messageCount": 46
| |
| − | }
| |
| − | </nowiki></pre>
| |
| − | | |
| − | | |
| − | '''Discussion'''
| |
| − | | |
| − | See ''Get Messages'' for definitions of the query parameters.
| |
| − | | |
| − | == Check Health ==
| |
| − | | |
| − | '''Request Template'''
| |
| − | | |
| − | | |
| − | <pre><nowiki>
| |
| − | GET {base_url}/health
| |
| − | </nowiki></pre>
| |
| − | | |
| − | | |
| − | or
| |
| − | | |
| − | | |
| − | <pre><nowiki>
| |
| − | HEAD {base_url}/health
| |
| − | </nowiki></pre>
| |
| − | | |
| − | | |
| − | '''Request'''
| |
| − | | |
| − | | |
| − | <pre><nowiki>
| |
| − | GET /v1/480924/health
| |
| − | Host: example.marconi.com
| |
| − | | |
| − | [...]
| |
| − | | |
| − | </nowiki></pre>
| |
| − | | |
| − | | |
| − | '''Response'''
| |
| − | | |
| − | | |
| − | <pre><nowiki>
| |
| − | HTTP/1.1 200 OK
| |
| − | | |
| − | [...]
| |
| − | | |
| − | {
| |
| − | "code": "green",
| |
| − | "link": {
| |
| − | "rel": "status",
| |
| − | "href": "http://marconi.example.com/status",
| |
| − | "text": "Service status page"
| |
| − | }
| |
| − | }
| |
| − | </nowiki></pre>
| |
| − | | |
| − | | |
| − | '''Discussion'''
| |
| − | | |
| − | Use this request to check on the Marconi service status as a whole. The following status values are defined:
| |
| − | | |
| − | {| border="1" cellpadding="2" cellspacing="0"
| |
| − | | Code
| |
| − | |-
| |
| − | | green
| |
| − | |-
| |
| − | | yellow
| |
| − | |-
| |
| − | | red
| |
| − | | Degraded availability
| |
| − | |}
| |
| − | | |
| − | Note that if a client performs HEAD instead of GET, the server will return one of the following:
| |
| − | | |
| − | {| border="1" cellpadding="2" cellspacing="0"
| |
| − | | Status
| |
| − | |-
| |
| − | | HTTP/1.1 204 No Content
| |
| − | |-
| |
| − | | HTTP/1.1 503 Service Unavailable
| |
| − | |}
| |
| − | | |
| − | == Poll Stats ==
| |
| − | | |
| − | @todo - also how authenticate?
| |
| − | | |
| − | == Set Message Defaults ==
| |
| − | | |
| − | '''Request Template'''
| |
| − | | |
| − | | |
| − | <pre><nowiki>
| |
| − | PUT {base_url}/config
| |
| − | | |
| − | {
| |
| − | "message": {
| |
| − | "ttl": {ttl},
| |
| − | "durability": {durability},
| |
| − | "lock": {
| |
| − | "ttl": {lock_ttl}
| |
| − | }
| |
| − | }
| |
| − | }
| |
| − | </nowiki></pre>
| |
| − | | |
| − | | |
| − | '''Request'''
| |
| − | | |
| − | <pre><nowiki>
| |
| − | PUT /v1/480924/config HTTP/1.1
| |
| − | Host: marconi.example.com
| |
| − | | |
| − | [...]
| |
| − | | |
| − | {
| |
| − | "message": {
| |
| − | "ttl": 120,
| |
| − | "durability": 1,
| |
| − | "lock": {
| |
| − | "ttl": 60
| |
| − | }
| |
| − | }
| |
| − | }
| |
| − | </nowiki></pre>
| |
| − | | |
| − | | |
| − | '''Response'''
| |
| − | | |
| − | | |
| − | <pre><nowiki>
| |
| − | HTTP/1.1 204 No Content
| |
| − | </nowiki></pre>
| |
| − | | |
| − | | |
| − | '''Discussion'''
| |
| − | | |
| − | Set per-tenant default message options, such as ttl and durability. Lock TTL must be <= message TTL.
| |
| − | | |
| − | == Get Message Defaults ==
| |
| − | | |
| − | '''Request Template'''
| |
| − | | |
| − | | |
| − | <pre><nowiki>
| |
| − | GET {base_url}/config
| |
| − | </nowiki></pre>
| |
| − | | |
| − | | |
| − | '''Request'''
| |
| − | | |
| − | <pre><nowiki>
| |
| − | GET /v1/480924/config HTTP/1.1
| |
| − | Host: marconi.example.com
| |
| − | | |
| − | [...]
| |
| − | | |
| − | </nowiki></pre>
| |
| − | | |
| − | | |
| − | '''Response'''
| |
| − | | |
| − | | |
| − | <pre><nowiki>
| |
| − | HTTP/1.1 200 OK
| |
| − | | |
| − | [...]
| |
| − | | |
| − | {
| |
| − | "message": {
| |
| − | "ttl": 120,
| |
| − | "durability": 1,
| |
| − | "lock": {
| |
| − | "ttl": 60
| |
| − | }
| |
| − | }
| |
| − | }
| |
| − | </nowiki></pre>
| |
| − | | |
| − | | |
| − | '''Discussion'''
| |
| − | | |
| − | Get per-tenant default message options, such as ttl and durability. If not set explicitly by a client, a default configuration is used, and can vary between API deployments.
| |
| − | | |
| − | == TBD ==
| |
| − | | |
| − | '''Request Template'''
| |
| − | | |
| − | | |
| − | <pre><nowiki>
| |
| − | GET /{version}/{tenant}
| |
| − | </nowiki></pre>
| |
| − | | |
| − | | |
| − | '''Response'''
| |
| − | | |
| − | | |
| − | <pre><nowiki>
| |
| − | @todo
| |
| − | </nowiki></pre>
| |
| − | | |
| − | | |
| − | '''Discussion'''
| |
| − | | |
| − | @todo
| |
