API Gateway:REST API の作成とオペレーションの追加

インスタンス外

1. Cloud-native API Gateway コンソールにログインします。

2. ナビゲーションペインで、[API] をクリックします。上部メニューで、リージョンを選択します。

3. Create API をクリックします。

4. [REST API] カードで Create をクリックします。[REST API の作成] パネルで、パラメーターを設定し、[確認] をクリックします。

   パラメーター	説明
   [API Name]	API の名前を入力します。名前はグローバルに一意である必要があります。
   [ベースパス]	API のベースパスです。クライアントが特定のオペレーションを呼び出すとき、完全なリクエスト URL は http(s)://{ドメイン名}/{ベースパス}/{オペレーションパス} になります。
   [Version Management]	API のバージョン管理を有効にするかどうかを指定します。API の異なるバージョンは独立しています。同じ API 名を共有しますが、基本情報とオペレーションが異なる場合があります。特定のバージョンにアクセスするには、リクエストにそのバージョンの識別子を含めます。 Version Management を有効にする場合は、Usage も設定する必要があります。 説明 Usage を クエリ に設定した場合は、Add Query パラメーターを設定する必要があります。 Usage を Header に設定した場合は、Add Header パラメーターを設定する必要があります。
   [Usage]	バージョン識別子は、[パス]、クエリ パラメーター、または Header で渡すことができます。 [パス]：完全なリクエストパスは /{ベースパス}/{バージョン番号}/{オペレーションパス} です。 クエリ：完全なリクエストパスは /{ベースパス}/{オペレーションパス} です。リクエストには、Add Query で指定したクエリパラメーターを、その値をバージョン番号に設定して含める必要があります。 Header：完全なリクエストパスは /{ベースパス}/{オペレーションパス} です。リクエストには、Add Header で指定したヘッダーを、その値をバージョン番号に設定して含める必要があります。
   [Description]	API の説明を入力します。
   [Resource Group]	対象のリソースグループを選択します。新しいリソースグループを作成するには、右側の Create Resource Group をクリックします。

Create API をクリックします。

1. On the [REST API] card, click [Create]. In the [Create REST API] panel, configure the parameters and click Confirm.

   Parameter	Description
   [API Name]	Enter a name for the API. The name must be globally unique.
   [Base path]	The base path for the API. When a client calls a specific operation, the full request URL is http(s)://{domain name}/{base path}/{operation path}.
   [Version Management]	Specifies whether to enable API version management. Different versions of an API are independent. They share the same API name but can have different basic information and operations. To access a specific version, include its version identifier in the request. If you enable [Version Management], you must also configure the [Usage] parameter. 説明 If you set [Usage] to [クエリ], you must configure the [Add Query] parameter. If you set [Usage] to [Header], you must configure the [Add Header] parameter.
   [Usage]	The version identifier can be passed in the [Path], a [クエリ] parameter, or a [Header]. [Path]: The full request path is /{base path}/{version_number}/{operation_path}. [クエリ]: The full request path is /{base path}/{operation_path}. The request must include the query parameter that you specified in [Add Query], with its value set to the version number. [Header]: The full request path is /{base path}/{operation_path}. The request must include the header that you specified in [Add Header], with its value set to the version number.
   [Description]	Enter a description for the API.
   [Resource Group]	Select the target resource group. To create a new one, click [Create Resource Group] on the right.

インスタンス内

1. Cloud-native API Gateway コンソールにログインします。

2. ナビゲーションペインで、インスタンス をクリックします。上部メニューで、リージョンを選択します。

3. インスタンス ページで、対象の インスタンス ID をクリックして Overview ページに移動します。ナビゲーションペインで [API] をクリックし、Create API をクリックします。

4. [REST API] カードで Create をクリックします。Create REST API パネルで、パラメーターを設定し、[確認] をクリックします。

   パラメーター	説明
   [API Name]	API の名前を入力します。名前はグローバルに一意である必要があります。
   [Domain Name]	API のドメイン名を 1 つ以上選択します。 新しいドメイン名を作成するには、[ドメイン名の追加] をクリックします。
   [ベースパス]	API のベースパスです。クライアントが特定のオペレーションを呼び出すとき、完全なリクエスト URL は http(s)://{ドメイン名}/{ベースパス}/{オペレーションパス} になります。
   [Version Management]	API のバージョン管理を有効にするかどうかを指定します。API の異なるバージョンは独立しています。同じ API 名を共有しますが、基本情報とオペレーションが異なる場合があります。特定のバージョンにアクセスするには、リクエストにそのバージョンの識別子を含めます。 Version Management を有効にする場合は、Usage も設定する必要があります。 説明 Usage を クエリ に設定した場合は、Add Query パラメーターを設定する必要があります。 Usage を Header に設定した場合は、Add Header パラメーターを設定する必要があります。
   [Usage]	バージョン識別子は、[パス]、クエリ パラメーター、または Header で渡すことができます。 [パス]：完全なリクエストパスは /{ベースパス}/{バージョン番号}/{オペレーションパス} です。 クエリ：完全なリクエストパスは /{ベースパス}/{オペレーションパス} です。リクエストには、Add Query で指定したクエリパラメーターを、その値をバージョン番号に設定して含める必要があります。 Header：完全なリクエストパスは /{ベースパス}/{オペレーションパス} です。リクエストには、Add Header で指定したヘッダーを、その値をバージョン番号に設定して含める必要があります。
   [Description]	API の説明を入力します。
   [Resource Group]	対象のリソースグループを選択します。新しいリソースグループを作成するには、右側の Create Resource Group をクリックします。
   [Scenario]	このオペレーションのユースケースを選択します。 基本シナリオ：Single Service。 カナリアリリースシナリオ：By Percentage (Multi-service)、By Content (Multi-service)、および By Tag (Proportion-based Routing)。 説明 すべての対象サービスのトラフィックの割合の合計は 100% である必要があります。
   [Backend Services]	現在のゲートウェイまたは VPC からバックエンドサービスを関連付けます。サービスが存在しない場合は、[サービスの作成] をクリックして作成します。 重要 新しいサービスを作成すると、そのポート情報がすぐに表示されない場合があります。サービス名 ドロップダウンリストを展開し、Refresh をクリックします。情報は非同期に同期されるため、表示されるまでに時間がかかる場合があります。

インスタンス外

1. Cloud-native API Gateway コンソールにログインします。

2. ナビゲーションペインで、[API] をクリックします。上部メニューで、リージョンを選択します。

3. Create API をクリックします。

4. REST API カードで インポート をクリックします。Create File based on OpenAPI パネルで、パラメーターを設定し、Precheck and Create をクリックします。

   パラメータ	説明
   [API Name]	API の名前を入力します。名前はグローバルに一意である必要があります。
   [Upload method]	Local File または Import OSS files を使用できます。 説明 ローカルアップロードと OSS インポートのいずれのファイルも、OpenAPI 仕様に準拠している必要があります。
   [OpenAPI File]	ローカルファイルを選択するか、テキストコンテンツを貼り付けます。ファイルサイズは 30 MB を超えることはできません。
   [Region selection]	OSS リソースが配置されているリージョンを選択します。
   OSS バケット	OSS バケットを選択します。リージョン属性を持たないバケットはサポートされていません。
   [Version Management]	API のバージョン管理を有効にするかどうかを指定します。API の異なるバージョンは独立しています。同じ API 名を共有しますが、基本情報とオペレーションが異なる場合があります。特定のバージョンにアクセスするには、リクエストにそのバージョンの識別子を含めます。 Version Management を有効にする場合は、Usage も設定する必要があります。 説明 Usage を クエリ に設定した場合は、Add Query パラメーターを設定する必要があります。 Usage を Header に設定した場合は、Add Header パラメーターを設定する必要があります。
   [Usage]	バージョン識別子は、[パス]、クエリ パラメーター、または Header で渡すことができます。 [パス]：完全なリクエストパスは /{ベースパス}/{バージョン番号}/{オペレーションパス} です。 クエリ：完全なリクエストパスは /{ベースパス}/{オペレーションパス} です。リクエストには、Add Query で指定したクエリパラメーターを、その値をバージョン番号に設定して含める必要があります。 Header：完全なリクエストパスは /{ベースパス}/{オペレーションパス} です。リクエストには、Add Header で指定したヘッダーを、その値をバージョン番号に設定して含める必要があります。
   [Description]	API の説明を入力します。
   [Resource Group]	対象のリソースグループを選択します。新しいリソースグループを作成するには、右側の Create Resource Group をクリックします。

インスタンス内

1. Cloud-native API Gateway コンソールにログインします。

2. ナビゲーションペインで、インスタンス をクリックします。上部メニューで、リージョンを選択します。

3. インスタンス ページで、対象の インスタンス ID をクリックして Overview ページに移動します。ナビゲーションペインで [API] をクリックし、Create API をクリックします。

4. REST API カードで インポート をクリックし、Create File based on OpenAPI パネルでパラメーターを設定して、Precheck and Create をクリックします。

   パラメータ	説明
   [API Name]	API の名前を入力します。名前はグローバルに一意である必要があります。
   [Domain Name]	API のドメイン名を 1 つ以上選択します。 新しいドメイン名を作成するには、[ドメイン名の追加] をクリックします。
   [Upload method]	Local File または Import OSS files を使用できます。 説明 ローカルアップロードと OSS インポートのいずれのファイルも、OpenAPI 仕様に準拠している必要があります。
   [OpenAPI File]	ローカルファイルを選択するか、テキストコンテンツを貼り付けます。ファイルサイズは 30 MB を超えることはできません。
   [Region selection]	OSS リソースが配置されているリージョンを選択します。
   OSS バケット	OSS バケットを選択します。リージョン属性を持たないバケットはサポートされていません。
   [Version Management]	API のバージョン管理を有効にするかどうかを指定します。API の異なるバージョンは独立しています。同じ API 名を共有しますが、基本情報とオペレーションが異なる場合があります。特定のバージョンにアクセスするには、リクエストにそのバージョンの識別子を含めます。 Version Management を有効にする場合は、Usage も設定する必要があります。 説明 Usage を クエリ に設定した場合は、Add Query パラメーターを設定する必要があります。 Usage を Header に設定した場合は、Add Header パラメーターを設定する必要があります。
   [Usage]	バージョン識別子は、[パス]、クエリ パラメーター、または Header で渡すことができます。 [パス]：完全なリクエストパスは /{ベースパス}/{バージョン番号}/{オペレーションパス} です。 クエリ：完全なリクエストパスは /{ベースパス}/{オペレーションパス} です。リクエストには、Add Query で指定したクエリパラメーターを、その値をバージョン番号に設定して含める必要があります。 Header：完全なリクエストパスは /{ベースパス}/{オペレーションパス} です。リクエストには、Add Header で指定したヘッダーを、その値をバージョン番号に設定して含める必要があります。
   [Description]	API の説明を入力します。
   [Resource Group]	対象のリソースグループを選択します。新しいリソースグループを作成するには、右側の Create Resource Group をクリックします。
   [Scenario]	このオペレーションのユースケースを選択します。 基本シナリオ：Single Service。 カナリアリリースシナリオ：By Percentage (Multi-service)、By Content (Multi-service)、および By Tag (Proportion-based Routing)。 説明 すべての対象サービスのトラフィックの割合の合計は 100% である必要があります。
   [Backend Services]	現在のゲートウェイまたは VPC からバックエンドサービスを関連付けます。サービスが存在しない場合は、[サービスの作成] をクリックして作成します。 重要 新しいサービスを作成すると、そのポート情報がすぐに表示されない場合があります。サービス名 ドロップダウンリストを展開し、Refresh をクリックします。情報は非同期に同期されるため、表示されるまでに時間がかかる場合があります。