Skip to main content
OpenAPI

ドメインと送信元 IP

現在の環境の Qoder アクセスドメインと送信元パブリック IP を取得し、ファイアウォールや IP／ドメインの許可リストを設定します。

このエンドポイントは公開情報を提供します。認証不要で、API キーも組織 ID も必要ありません。
呼び出す前に OpenAPI 共通仕様を確認してください。

概要

サービスネットワークメタ情報エンドポイントを使用すると、現在の環境で有効なアクセスドメインと送信元パブリック IP を取得し、ネットワークの許可リストを設定できます。
  • 送信元 IP：同じ環境で複数の送信元 IP が使用される場合があります。egressIps に返されたすべてのアドレスを許可してください。
  • アクセスドメイン：domains[].pattern を使用してドメインの許可リストを設定します。完全一致ドメインと *. ワイルドカードドメインをサポートします。details は具体的なドメインと用途の補足情報で、省略される場合があり、完全なドメイン一覧ではありません。
  • 情報の更新：ネットワークメタ情報の変更が反映されると、再連携せずに新しい値を取得できます。レスポンスには Cache-Control: no-store が付与されます。結果を長期間キャッシュせず、最新のレスポンスに基づいて許可リストを更新してください。

API 一覧

ドメインと送信元 IP の取得

GET /v1/public/meta このエンドポイントは、非推奨となった GET /v1/public/egress-ips を置き換えます。 パスパラメータ、クエリパラメータ（ページネーションを含む）、リクエストボディは使用できません。クエリパラメータまたはリクエストボディを指定すると 400 BadRequest を返します。

リクエスト例

curl --silent --show-error "https://api.qoder.com/v1/public/meta"

成功レスポンス（200 OK）

以下の IP とドメインは形式を示すサンプルです。許可リストには実際のレスポンスの値を使用してください。 
{
  "egressIps": [
    {
      "ip": "203.0.113.10",
      "ipVersion": "IPv4"
    },
    {
      "ip": "2001:db8::1",
      "ipVersion": "IPv6"
    }
  ],
  "domains": [
    {
      "pattern": "*.example.com",
      "details": [
        {
          "domain": "api.example.com",
          "purpose": "サービス API ドメイン"
        }
      ]
    },
    {
      "pattern": "example.com"
    }
  ]
}
フィールド型必須説明
egressIpsarrayはい現在有効なすべてのサービス送信元 IP。アドレス順に並べ、重複を除去
egressIps[].ipstringはい正規化された IP アドレス
egressIps[].ipVersionstringはいアドレスから判定されるバージョン：IPv4 または IPv6
domainsarrayはい現在有効な粗粒度ドメイン一覧。ドメインが未設定の場合は空配列 []
domains[].patternstringはい許可が推奨される完全一致ドメインまたは *. ワイルドカードドメイン
domains[].detailsarrayいいえpattern 配下の詳細なドメイン情報。未設定または空の場合は省略
domains[].details[].domainstringはい詳細な完全一致ドメインまたは *. ワイルドカードドメイン
domains[].details[].purposestringいいえ詳細なドメインの用途。未設定または空の場合は省略
完全一致ドメインとワイルドカードドメインは前後の空白を除去し、小文字に変換されます。purpose は前後の空白を除去します。domains と details はプラットフォームの設定順で返されます。

エラー

エラーは OpenAPI 共通仕様で説明する標準レスポンス形式を使用します。requestId はレスポンスヘッダーの X-Request-ID と一致します。
HTTP ステータスエラーコード主な原因
400BadRequestクエリパラメータまたはリクエストボディが指定された
503InternalErrorネットワークメタ情報の設定が未読み込み、または一時的に利用できない
503 InternalError のレスポンス例： 
{
  "requestId": "req_example",
  "code": "InternalError",
  "message": "service meta is not available"
}
設定を利用できない場合、空の送信元 IP 一覧は返されません。許可すべきアドレスがないのではなく、取得に失敗したものとして扱ってください。