Skip to content

データオブジェクトを配信する ​

データオブジェクトは、Edge が distribution のために保存し、/_api で配信できるファイルです。フロー、設定、ページが同一オリジンで取得するその他のペイロードに使います。deployment バンドル内のファイルではありません。

データオブジェクトは ウェブコンソールではまだ管理できません。エージェント、CLI、または API を使ってください。

このページは公開中の distribution があることを前提とします。まだの場合は 最初のサイトを公開する から始めてください。以降、その distribution は acme-marketing(d3f7a1c4-90b2-4e6a-8f15-6c2b7e0a9d38)とします。

1. オブジェクトを書く ​

text
acme-marketing にデータオブジェクト flows.json を
{"welcome":"Hello from Edge"} で保存して、etag を見せて。
bash
edge api PUT /v1/distributions/d3f7a1c4-90b2-4e6a-8f15-6c2b7e0a9d38/documents --input - <<'EOF'
{
        "documents": [
          {
            "path": "flows.json",
            "content": "{\"welcome\":\"Hello from Edge\"}"
          }
        ]
      }
EOF
bash
curl -s -X PUT \
  https://api.edge.deca-dev.com/v1/distributions/d3f7a1c4-90b2-4e6a-8f15-6c2b7e0a9d38/documents \
  -H "Authorization: Bearer $EDGE_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
        "documents": [
          {
            "path": "flows.json",
            "content": "{\"welcome\":\"Hello from Edge\"}"
          }
        ]
      }'

エージェントは edge_document_write を実行します。HTTP ボディのフィールドは documents です(objects も受け付けます)。書き込みでは if_match または if_none_match を送れます。ふたりの編集者が互いを上書きしないためです。get の応答には etag と version_id が含まれます。

これだけでは、どの /_api パスが存在するかは変わりません。パスが配信するまで、訪問者はこのファイルを見えません。

上限は distribution あたり 1,000 オブジェクト、ボディあたり 1 MiB です。キーは最大 256 文字、深さは 8 セグメントまでです。制限 を参照してください。

2. 割り当てる(または GET のフォールバックを使う) ​

割り当てがなくても GET /_api/flows はすでに flows.json を探します。明示的な TTL や、その規約に合わないキーが欲しいときにパスを割り当てます。

エンドポイントマップの JSON フィールドは runtime です。runtime を送るとマップ全体が置き換わります。ほかの /_api パスがある場合は、同じ更新に含めないと消えます。

text
acme-marketing の GET /_api/flows をデータオブジェクト flows.json に
割り当てて、キャッシュは 300 秒。既存のエンドポイントはすべて残して。
bash
edge api PATCH /v1/distributions/d3f7a1c4-90b2-4e6a-8f15-6c2b7e0a9d38 --input - <<'EOF'
{
        "runtime": {
          "api": {
            "routes": [
              {
                "match": "/_api/flows",
                "document": "flows.json",
                "cache_ttl_seconds": 300
              }
            ]
          }
        }
      }
EOF
bash
curl -s -X PATCH \
  https://api.edge.deca-dev.com/v1/distributions/d3f7a1c4-90b2-4e6a-8f15-6c2b7e0a9d38 \
  -H "Authorization: Bearer $EDGE_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
        "runtime": {
          "api": {
            "routes": [
              {
                "match": "/_api/flows",
                "document": "flows.json",
                "cache_ttl_seconds": 300
              }
            ]
          }
        }
      }'

エージェントは edge_distribution_update を実行します。データオブジェクトのルートは GET のみです。methods は省略します。ページからは次のようにします。

javascript
fetch('/_api/flows').then((r) => r.json())

/api/flows を作らないでください。割り当てのない POST を /_api に送ると 405 が返ります。

3. 他人を上書きせずに変更する ​

先にオブジェクトを読み、次の書き込みでその etag を if_match として送ってください。その間に別の書き込みがあれば、黙って置き換えるのではなく失敗します。パスがまだ存在してはいけないときは if_none_match を使います。

同じパスへ書くと新しいバージョンができます。訪問者は現在の etag を If-None-Match で送ると、ボディが変わっていなければ 304 を受け取れます。

4. 履歴を見るか、切り戻す ​

履歴と切り戻しは MCP のみです。

text
acme-marketing の flows.json のバージョン履歴を見せて。
削除マーカーも含めて。

エージェントは edge_document_history を実行します。各エントリには version_id、etag、サイズ、最終更新時刻、削除マーカーかどうかが含まれます。

text
acme-marketing の flows.json を version 4dzQ… に戻して、
新しい etag を見せて。

エージェントは edge_document_rollback を実行します。切り戻しは古いバージョンのポインタを動かしません。選んだバージョンを新しい最新版として前方にコピーし、履歴全体は残します。

5. 削除する ​

配信を止めるには、runtime.api.routes からルートを外します(またはオブジェクト削除後の 404 に任せます)。エージェントは edge_document_delete を実行します。

データオブジェクトに秘密を入れないでください。ここに保存したものは、パスを知っている訪問者が取得できます。

次に読む ​