ゲートウェイの管理

Cloudflare Web3 ゲートウェイは、さまざまな Web3 ネットワークへの HTTP アクセス可能なインターフェースを提供します。ゲートウェイとは、いくつかの方法で対話できます。

ゲートウェイの作成

ダッシュボード

To create a gateway using the dashboard:

1. Log in to the Cloudflare dashboard ↗.
2. Select your account and website.
3. Go to Web3.
4. Click Create Web3 Gateway.
5. Enter the following information:

• Hostname: Enter a hostname to use as your gateway, which has to be a subdomain of the current Cloudflare zone.
• Gateway Description: Enter a description to help distinguish between different gateways.
• Gateway Type: Select a gateway target of IPFS DNSLink, IPFS Universal Path, or Ethereum.
• DNSLink: Only applicable to IPFS gateways, more details at DNSLink.

6. Click Deploy.

API

To create a gateway using the API, send a POST request that includes the following parameters:

• name: The hostname that will point to the target gateway via a CNAME record.
• target: The gateway target for the hostname (ethereum, ipfs, ipfs_universal_path).

If you need help with API authentication, refer to Cloudflare API documentation.

Request

curl "https://api.cloudflare.com/client/v4/zones/{zone_id}/web3/hostnames" \
--header "X-Auth-Email: <EMAIL>" \
--header "X-Auth-Key: <API_KEY>" \
--header "Content-Type: application/json" \
--data '{
  "name": "gateway.example.com",
  "description": "This is my IPFS gateway.",
  "target": "ipfs",
  "dnslink": "/ipns/onboarding.ipfs.cloudflare.com"
}'

The response contains the complete definition of the new gateway.

Response

{
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "id": "<WEB3_GATEWAY_ID>",
    "name": "gateway.example.com",
    "description": "This is my IPFS gateway.",
    "status": "active",
    "target": "ipfs",
    "dnslink": "/ipns/onboarding.ipfs.cloudflare.com",
    "created_on": "<CREATED_ON_DATE>",
    "modified_on": "<MODIFIED_ON_DATE>"
  }
}

When you create a gateway, Cloudflare automatically:

• Creates and adds records to your Cloudflare DNS so your gateway can receive and route traffic appropriately.
• Proxies traffic to that hostname.
• Issues an SSL/TLS certificate to cover the specified hostname.

---

ゲートウェイの編集

ゲートウェイを作成した後は、ゲートウェイの説明のみを編集できます。また、IPFS ゲートウェイの場合は、DNSLink フィールドの値も編集できます。

他のフィールドを編集する必要がある場合は、ゲートウェイを削除して新しいものを作成してください。

ダッシュボード

ダッシュボードを使用してゲートウェイを編集するには：

1. Cloudflare ダッシュボード ↗にログインします。
2. アカウントとウェブサイトを選択します。
3. Web3に移動します。
4. 特定のゲートウェイで、編集をクリックします。
5. ゲートウェイの説明を更新し、IPFS ゲートウェイを編集している場合は、DNSLinkの値を更新します。
6. 再適用をクリックします。

API

ゲートウェイの特定の設定を編集するには、PATCH リクエストを使用します。

---

ゲートウェイの更新

ゲートウェイがエラー ステータスにある場合は、ゲートウェイを更新して、ホスト名に関連付けられた DNS レコードを再作成することを試みるべきです。

ダッシュボード

ダッシュボードを使用してゲートウェイを更新するには：

1. Cloudflare ダッシュボード ↗にログインします。
2. アカウントとウェブサイトを選択します。
3. Web3に移動します。
4. ゲートウェイで、ドロップダウンをクリックして更新を選択します。

API

APIを使用してゲートウェイを更新するには、空のリクエストボディを持つPATCH リクエストを送信します。

---

ブロックリストの更新

IPFS ユニバーサルパスゲートウェイを設定すると、特定のコンテンツへのアクセスをブロックするために、ゲートウェイのブロックリストにアイテムを追加したい場合があります。

1つ以上のアクセスをブロックする能力があります：

• CIDs (QmPZ9gcCEpqKTo6aq61g2nXGUhM4iCL3ewB6LDXZCtioEB)
• IPFS コンテンツパス (/ipfs/QmYwAPJzv5CZsnA625s3Xf2nemtYgPpHdWEz79ojWnPbdG/readme)
• IPNS コンテンツパス (/ipns/example.com)

ダッシュボード

ダッシュボードを使用してブロックリストにアイテムを追加するには：

1. Cloudflare ダッシュボード ↗にログインします。

2. アカウントとウェブサイトを選択します。

3. Web3に移動します。

4. 特定のゲートウェイで、ドロップダウンをクリックしてブロックリストを選択します。

5. エントリを追加をクリックします。

6. 次の情報を入力します：

   • ブロックリストエントリタイプ：CIDまたはコンテンツパスを選択します。
   • ブロックリストエントリコンテンツ：ブロックするCIDまたはコンテンツパスを追加します。つまり、有効なCIDv0またはCIDv1文字列（CID）であるか、エントリは/ipfs/または/ipns/で始まる必要があります（コンテンツパス）。
   • ブロックリストエントリの説明：ブロックリストエントリを識別するための説明を追加します。

7. 追加をクリックします。

API

APIを使用してブロックリストアイテムを追加するには、POST リクエストを送信します。

---

ゲートウェイの削除

ゲートウェイを削除すると、Cloudflareは関連するすべてのホスト名のDNSレコードを自動的に削除します。このアクションはトラフィックに影響を与え、元に戻すことはできません。

ダッシュボード

ダッシュボードを使用してゲートウェイを削除するには：

1. Cloudflare ダッシュボード ↗にログインします。
2. アカウントとウェブサイトを選択します。
3. Web3に移動します。
4. 特定のゲートウェイで、ドロップダウンをクリックして削除を選択します。
5. ホスト名を削除をクリックします。

API

APIを使用してゲートウェイを削除するには、DELETE リクエストを送信します。