Menu Close

用語集

Red Hat 3scale API Management 2.11

Red Hat 3scale API Management で使用される用語について

概要

本ガイドでは、Red Hat 3scale API Management 2.11 で使用される用語を説明します。

多様性を受け入れるオープンソースの強化

Red Hat では、コード、ドキュメント、Web プロパティーにおける配慮に欠ける用語の置き換えに取り組んでいます。まずは、マスター (master)、スレーブ (slave)、ブラックリスト (blacklist)、ホワイトリスト (whitelist) の 4 つの用語の置き換えから始めます。この取り組みは膨大な作業を要するため、今後の複数のリリースで段階的に用語の置き換えを実施して参ります。詳細は、CTO である Chris Wright のメッセージ をご覧ください。

第1章 3scale 用語集

本セクションは、3scale プラットフォームで使用される共通用語に関する用語集です。用語集のエントリーの構成を以下に示します。

  • 用語
  • 1 つ/複数の以下の各項目/両項目:

    • 用語の定義、ならびにオプションとしてそれに続く 1 つまたは 2 つの説明文および関連用語をポイントする 併せて参照 部分。以下に例を示します。

hit: すべてのメソッドがレポートする組み込みのメトリクス。ここでは、ヒットカウントを増加させない他の使用状況をトラッキングするために、最上位メトリクスをさらに追加することができます。「メトリクス」も併せて参照してください。

この例では、hit は組み込みのメトリクスなので、hit は メトリクス に関連します。

  • その用語の同義語、または短縮形の用語の正式バージョンをポイントする 参照 部分。以下に例を示します。

アカウント: 「テナントアカウント」「開発者アカウント」を参照してください。

この例では、利用者は アカウント からより詳しい説明が含まれる関連用語のいずれかにリダイレクトされます。

  • 用語に複数の定義がある場合は、各項目に番号が付けられます。

1.1. 特殊文字

1.1.1. [Your_admin_domain]

ユーザーが作成した管理ドメイン

1.1.2. [Your_API_name]

ユーザーが作成した API。「アプリケーションプログラミングインターフェース」も併せて参照してください。

1.1.3. [Your_API_service]

「[Your_API_name]」を参照してください。

1.1.4. [Your_product_name]

ユーザーが作成したプロダクト。「製品」も併せて参照してください。

1.1.5. 3scale API ドキュメント

Open API Specification (OAS) をベースとする、Red Hat 3scale API Management の REST API を文書化するための 3scale 仕様。「ActiveDocs」「OpenAPI Specification (OAS)」も併せて参照してください。

1.1.6. 3scale バックエンド

システムと共に 3scale API Manager を構成します。

1.2. A

1.2.1. アカウント

「テナントアカウント」「開発者アカウント」を参照してください。

1.2.2. ActiveDocs

Open API Specification (OAS) をベースとする、ユーザーの作成した REST API を文書化するための 3scale 仕様。インタラクティブな API ドキュメントにより、開発者は API を容易に理解し、何もインストールせずに API を簡単にテストすることができます。「3scale API ドキュメント」「OpenAPI Specification (OAS)」も併せて参照してください。

1.2.3. アクセストークン

HTTP Basic 認証を通じてユーザーが Account Management API、Analytics API、および Billing API に対して認証することのできるパーソナルトークン。ユーザーは、カスタムスコープおよびパーミッションを設定して複数のアクセストークンを作成することができます。「3scale API ドキュメント」「サービストークン」も併せて参照してください。

1.2.4. 管理ポータル (Admin Portal)

API プロバイダーがプロダクトを管理し、プロダクトへのアクセスをセキュアにするための中心的なポータル。このポータルから、API プロバイダーはプロダクトと 3scale のインテグレーションの設定、アプリケーションプランの管理、内部のメンバーおよび外部の顧客へのアクセス権限の付与、アプリケーションキーごとのトラフィックの制限、およびデベロッパーポータルのカスタマイズを行うことができます。「デベロッパーポータル」「製品」も併せて参照してください。

1.2.5. Administration Portal

「管理ポータル (Admin Portal)」を参照してください。

1.2.6. API

「アプリケーションプログラミングインターフェース」を参照してください。

1.2.7. APIsonator

「3scale バックエンド」を参照してください。

1.2.8. API バックエンド

ホストにデプロイされた API の実装。「アプリケーションプログラミングインターフェース」「バックエンド」も併せて参照してください。

1.2.9. API 利用者

API プロバイダーが管理する API またはプロダクトにアクセスする個人、グループ、または企業。組織および API を使用するために組織が作成したソフトウェアアプリケーションの両方を指す場合があります。指定した組織は、API にアクセスする 1 つまたは複数のアプリケーションを持つことができます。「API プロバイダー」も併せて参照してください。

1.2.10. API クレデンシャル

「API キー」「ユーザーキー」を参照してください。

1.2.11. API エンドポイント

「アプリケーションプログラミングインターフェース」「メソッド」を参照してください。

1.2.12. API プロバイダー

API およびプロダクトの所有者で、Red Hat 3scale API Management を使用してそれらへのアクセス権限を付与します。API プロバイダーは、組織内の他のチーム、または外部のサードパーティー開発者、パートナー、もしくは一般ユーザーがその API にアクセスできるようにすることが可能です。これには、1 つまたは複数のテナントが含まれます。「API 利用者」「テナントアカウント」も併せて参照してください。

1.2.13. API キー

アプリケーションが特定の API またはプロダクトを呼び出すことができるようにするクレデンシャルの 1 つ。API キーは、特定の種類の認証パターンです。「アプリケーションプログラミングインターフェース」も併せて参照してください。

1.2.14. API Manager

「管理ポータル (Admin Portal)」を参照してください。

1.2.15. API メソッド

「メソッド」を参照してください。

1.2.16. API プロダクト

「製品」を参照してください。

1.2.17. APIcast

NGINX をベースとする API ゲートウェイで、Red Hat 3scale API Management と内部および外部の API を統合するのに使用されます。APIcast は API リクエストを処理するインターフェースで、設定によりアクセス制御、流量制御、セキュリティーフィルタリング、ロギング、ルーティング、キャッシング等の処理を行うことができます。「アプリケーションプログラミングインターフェース」「製品」も併せて参照してください。

1.2.18. APIcast ゲートウェイ

「APIcast」を参照してください。

1.2.19. アプリケーション識別子

アプリケーション識別子を使用して機能する認証方法。「アプリケーションキー」も併せて参照してください。

1.2.20. アプリケーションキー

アプリケーションキーを使用した認証方法。「アプリケーション識別子」も併せて参照してください。

1.2.21. アプリケーション

一揃いのソフトウェアコードで、特定のロジックを実行するために開発されます。アプリケーションは、通常 3scale システム内で API の一意のクレデンシャルセット、API に送信される呼び出しのトラフィック履歴、およびアプリケーション作成時に取得されたメタデータを関連付けます。アプリケーションは開発者アカウントとリンクされます。「API 利用者」を参照してください。「開発者アカウント」も併せて参照してください。

1.2.22. アプリケーションプログラミングインターフェース

  1. 規格ベースの技術を使用して通信ネットワークを介して離れた場所で呼び出すことができるソフトウェアコンポーネントに対するインターフェース
  2. プログラミングライブラリーが提供するプロセス、機能、およびメソッドの論理的なバンドルで、抽象化層として他のコンピュータープログラムにより使用されます。

「[Your_API_name]」「APIcast」「API キー」「バックエンド」「エンドポイント」「エンドユーザー」「メソッド」「製品」「サービス」も併せて参照してください。

1.2.23. 認証

API またはプロダクトへのアクセスを要求するユーザーまたはサーバーのアイデンティティーを確認するプロセス

1.3. B

1.3.1. バックエンド

  1. API プロダクトのコンテキストでは、プロダクトにバンドルされた 1 つまたは複数の API を指します。「ベース URL」「製品」も併せて参照してください。
  2. API としては、「API バックエンド」も併せて参照してください。
  3. 3scale のコンポーネントとしては、「3scale バックエンド」を参照してください。

1.3.2. ベース URL

  1. API プロダクトのコンテキストでは、バックエンドに定義されたプライベートエンドポイントを指します。「バックエンド」「エンドポイント」も併せて参照してください。
  2. API ゲートウェイの Integration Settings で定義される URL アドレス。これらのアドレスは、ステージング環境用の公開ベース URL および実稼働環境用の公開ベース URL です。

1.4. C

1.4.1. クライアント

「API 利用者」を参照してください。

1.4.2. CMS

「デベロッパーポータル」 を参照してください。

1.5. D

1.5.1. 非推奨化

機能またはサポート対象の構成に関して、サポートはされるが推奨はされなくなり、また廃止される可能性のあるもの。「廃止済み」も併せて参照してください。

1.5.2. 開発者アカウント

  1. ホスト型 3scale では、API プロバイダが把握するアカウントはすべて開発者アカウントです。
  2. オンプレミス型 3scale のテナント管理ポータルでは、アカウントは開発者アカウントとみなされます。「アプリケーション」「テナントアカウント」も併せて参照してください。

1.5.3. デベロッパーポータル

開発者が API をサブスクライブすることのできるサイト。このサイトから、開発者はサブスクリプションの管理、API へのアクセス、アプリケーションの作成、インタラクティブな API ドキュメントおよび 3scale API ドキュメントへのアクセス、API の使用状況の確認などを行うことができます。「管理ポータル (Admin Portal)」も併せて参照してください。

1.5.4. サービス停止

「廃止済み」を参照してください。

1.6. E

1.6.1. エンドポイント

通信チャネルの一方の端。API が他のシステムと相互に作用する場合、この通信のタッチポイントはエンドポイントとみなされます。「アプリケーションプログラミングインターフェース」「ベース URL」「マッピングルール」「メソッド」も併せて参照してください。

1.6.2. エンドユーザー

1 つまたは複数のプロダクトおよび API を呼び出すアプリケーションのユーザー。「アプリケーションプログラミングインターフェース」「製品」も併せて参照してください。

1.7. F

1.7.1. フィールド定義

新しいユーザー、アプリケーション、またはアカウントのいずれかが作成されたときに表示されるフィールド

1.8. G

1.9. H

1.9.1. hit

すべてのメソッドがレポートする組み込みのメトリクス。ここでは、ヒットカウントを増加させない他の使用状況をトラッキングするために、最上位メトリクスをさらに追加することができます。「メトリクス」も併せて参照してください。

1.9.2. ホスト URL

「ベース URL」を参照してください。

1.10. I

1.10.1. インテグレーションエラー

間違ったクレデンシャルのセット、ID、URL アドレス等で呼び出しが行われた場合に 3scale が生成するエラーメッセージ。これらのメッセージは、API を呼び出しているアプリケーションからのエラーであったり、API と 3scale のインテグレーションに伴う設定エラーであったりします。

1.11. J

1.12. K

1.13. L

1.14. M

1.14.1. management portal

「管理ポータル (Admin Portal)」を参照してください。

1.14.2. マッピングルール

特定のエンドポイントからの呼び出しを、3scale で作成した対応するメソッドおよびメトリクスに関連付けるルール。使用状況のトラッキング、エンドポイントへのアクセス、および制限は、マッピングルールで設定されたメソッドおよびメトリクスに基づきます。「エンドポイント」「メソッド」「メトリクス」も併せて参照してください。

1.14.3. メソッド

API またはプロダクトとの許可された相互作用 (GET、POST、DELETE 等)。メソッドは、3scale 上のプロダクトおよび API の使用状況をトラッキングするのに使用されます。API 用の API エンドポイントで利用可能な HTTP メソッドごとに、メソッドを追加することができます。3scale のデフォルトでは、メソッド呼び出しが組み込みの hits メトリクスのトリガーとなります。「アプリケーションプログラミングインターフェース」「エンドポイント」「マッピングルール」「メトリクス」も併せて参照してください。

1.14.4. メトリクス

API への特定の呼び出しのトラッキング。このトラッキングは、呼び出しを Integration ページの Mapping Rules セクションの 1 つまたは複数の URL パターンにマッピングすることで行われます。メトリクスは累積的で、独立したものではありません。3scale の最上位の組み込みメトリクスは Hits です。必要に応じて、最上位メトリクスをさらに追加することができ、それらは別々に考慮されます。「hit」「マッピングルール」「メソッド」も併せて参照してください。

1.15. N

1.16. O

1.16.1. OAS

「OpenAPI Specification (OAS)」を参照してください。

1.16.2. OpenAPI Specification (OAS)

言語に依存しない RESTful API とのインターフェース規格。これにより、ソースコードやドキュメントにアクセスしたりネットワークトラフィックを検査したりすることなく、人間とコンピューターの両方がサービスの機能を把握し理解することができます。「3scale API ドキュメント」「ActiveDocs」も併せて参照してください。

1.17. P

1.17.1. プラン

特定の API およびエンドポイントへのアクセス権限を付与し、トラフィックを制限し、API の使用に対して課金を行う手段。アプリケーションプランやアカウントプランなど、3scale にはさまざまな種類のプランがあり、単独で、または組み合わせて使用することができます。

1.17.2. 潜在的なアップグレード

トラフィックが限度を超えてアラートがトリガーされた開発者アカウント。これらの開発者アカウントは、トラフィック量の面のニーズを満たすプランにアップグレードされる可能性があります。

1.17.3. 製品

1 つまたは複数の API バックエンドのバンドル。「[Your_product_name]」「管理ポータル (Admin Portal)」「APIcast」「アプリケーションプログラミングインターフェース」「バックエンド」「エンドユーザー」も併せて参照してください。

1.18. Q

1.19. R

1.19.1. 廃止済み

機能またはサポート対象の構成に関して、製品で利用することができず、サポートされなくなったもの。「非推奨化」も併せて参照してください。

1.20. S

1.20.1. サービス

「アプリケーションプログラミングインターフェース」を参照してください。

1.20.2. サービストークン

Service Management API に対して認証するのに使用されるキー。これらのキーは自動生成され、サービスごとに一意で、同一アカウントのユーザー間で共有されます。3scale API ドキュメント内からサービストークンを使用します。「アクセストークン」も併せて参照してください。

1.21. T

1.21.1. テナントアカウント

オンプレミス型 3scale のマスター管理ポータルでは、アカウントはテナントアカウントとみなされます。「API プロバイダー」「開発者アカウント」も併せて参照してください。

1.22. U

1.22.1. ユーザーキー

「アプリケーションキー」を参照してください。

1.23. V

1.24. W

1.25. X

1.26. Y

1.26.1. ご自分のドメイン

「[Your_admin_domain]」を参照してください。

1.27. Z