MomentoトピックのHTTP APIリファレンス
Momentoは、私たちのSDKを使用できないアプリケーションや、curlやfetchのようなものを使用したいアプリケーションのためにHTTP APIインターフェイスを提供します。例えば、Cloudflare Workers、Fastly Compute@Edgeなどのエッジコンピュートサービスにデプロイする場合、このAPIはあなたのためにあります。その他のアプリケーションは、Momento's SDK clients を使用する必要があります。
私たちのPostmanの公開ワークスペースでもOpen API Specificationを見ることができます。
このドキュメントでは、HTTPリクエスト構文の実装方法については説明しません。
認証
各接続には、Momento コンソール または ホスティングしているトークン "自動販売機" マイクロサービス を介して生成された Momento 認証トークンが必要です。Momento auth トークンは、Momento サービスへのアクセスを制御し、有効期限を設定したり、特定のリソースへのアクセスを許可/制限することができます。
リージョン
Momento HTTP API にアクセスするには、API トークンとキャッシュのリージョンで以下のエンドポイントのいずれかを使用します。ご希望の地域がない場合は、サポートまでご連絡ください。
Publish
トピックにメッセージを公開する。
Request
- Path: /topics/{cacheName}/{topicName}
- HTTP Method: POST
Body
- Content-Type: octet-stream
- リクエストのボディには、トピックに公開するバイナリ値を含める。
Path Parameters
| Parameter name | Required? | Type | Description |
|---|---|---|---|
| cacheName | yes | URL-safe string | トピックを含むキャッシュの名前 |
| topicName | yes | URL-safe string | 公開するトピックの名前 |
Query Parameters
| Parameter name | Required? | Type | Description |
|---|---|---|---|
| token | no** | URL-safe string | リクエストの認証/認可に使用する Momento 認証トークン (文字列形式) |
*** リクエストの認証/認可に使用する Momento auth トークンを指定する必要があります。これは、トークンクエリパラメータか Authorization ヘッダで指定します。
Headers
| Header name | Required? | Type | Description |
|---|---|---|---|
| Authorization | no** | URL-safe string | 文字列形式の Momento auth トークンは、リクエストの認証/認可に使用されます |
** リクエストの認証/認可に使用する Momento auth トークンを指定する必要があります。これは、トークンクエリパラメータか Authorization ヘッダで指定します。
Responses
Success
Status Code: 204 No Content
- メッセージは指定されたトピックに正常に公開されました
Error
Status Code: 400 Bad Request
- このエラータイプは通常、リクエストの指定が正しくないことを示す。詳細はメッセージ本文を参照のこと。
Status Code: 401 Unauthorized
- このエラータイプは通常、渡された Momento 認証トークンが無効か期限切れであることを示します。詳細はメッセージの本文を参照してください。
Status Code: 403 Forbidden
- このエラータイプは通常、渡された Momento 認証トークンが、試行したリソースへの必要なアクセスを許可していないことを示します。詳細はメッセージの本文を参照してください。
Status Code: 404 Not Found
- 「Cache Not Found」は、指定されたキャッシュが存在しないことを示す。
Status Code: 429 Too Many Requests
- このエラー タイプは通常、アカウントの上限を超えたことを示します。詳細についてはメッセージ本文を参照するか、Momento サポートに連絡して限度額の引き上げを依頼してください。
Status Code: 500 Internal Server Error
- このエラータイプは通常、サービスに問題が発生していることを示します。Momentoサポートにお問い合わせください。
サンプル
Publish
以下は、hello world! という値を us-east-1 リージョンの my-cache キャッシュの example トピックに発行する例です。
クエリ・パラメータで指定されたトークン:
curl -X POST -d 'hello world!' "https://api.cache.cell-us-east-1-1.prod.a.momentohq.com/topics/my-cache/example?token=<token>"
Authorizationヘッダーとして提供されるトークン:
curl -X POST -H "Authorization: <token>" -d 'hello world!' "https://api.cache.cell-us-east-1-1.prod.a.momentohq.com/topics/my-cache/example"