API Gateway:REST API を作成して操作を追加する

インスタンス外の API

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

2. 左側のナビゲーションウィンドウで、[API] をクリックします。上部のメニューバーで、リージョンを選択します。

3. [API の作成] をクリックします。

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

   設定項目	説明
   API 名	API のカスタム名を入力します。API 名はグローバルに一意である必要があります。
   ベースパス	API のベースパス。特定の操作にアクセスする場合、完全なパスは http(s)://{ドメイン名}/{ベースパス}/{操作パス} です。
   バージョン管理	API のバージョン管理を有効にするかどうかを指定します。異なるバージョンの API は独立した API として扱われます。同じ API 名を共有しますが、基本情報と操作の詳細は異なる場合があります。特定のバージョンにアクセスするには、バージョン識別子を指定する必要があります。 [バージョン管理] を有効にする場合は、[使用方法] を設定する必要があります。 説明 [使用方法] を [クエリ] に設定した場合は、[クエリの追加] パラメーターを設定する必要があります。 [使用方法] を [ヘッダー] に設定した場合は、[ヘッダーの追加] パラメーターを設定する必要があります。
   使用方法	[パス]、[クエリ]、および [ヘッダー] をサポートしています。 [パス] を使用する場合、完全なアクセスパスは /API ベースパス/バージョン番号/操作パス です。 [クエリ] を使用する場合、完全なアクセスパスは /API ベースパス/操作パス です。リクエストパラメーターで、[クエリの追加] パラメーターをバージョン番号に設定する必要があります。 [ヘッダー] を使用する場合、完全なアクセスパスは /API ベースパス/操作パス です。リクエストヘッダーで、[ヘッダーの追加] パラメーターをバージョン番号に設定する必要があります。
   説明	API の説明を入力します。
   リソースグループ	ターゲットリソースグループを選択します。右側の [リソースグループの作成] をクリックできます。

[API の作成] をクリックします。

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

   設定項目	説明
   API 名	API のカスタム名を入力します。API 名はグローバルに一意である必要があります。
   ベースパス	API のベースパス。特定の操作にアクセスする場合、完全なパスは http(s)://{ドメイン名}/{ベースパス}/{操作パス} です。
   バージョン管理	API のバージョン管理を有効にするかどうかを指定します。異なるバージョンの API は独立した API として扱われます。同じ API 名を共有しますが、基本情報と操作の詳細は異なる場合があります。特定のバージョンにアクセスするには、バージョン識別子を指定する必要があります。 [バージョン管理] を有効にする場合は、[使用方法] を設定する必要があります。 説明 [使用方法] を [クエリ] に設定した場合は、[クエリの追加] パラメーターを設定する必要があります。 [使用方法] を [ヘッダー] に設定した場合は、[ヘッダーの追加] パラメーターを設定する必要があります。
   使用方法	[パス]、[クエリ]、および [ヘッダー] をサポートしています。 [パス] を使用する場合、完全なアクセスパスは /API ベースパス/バージョン番号/操作パス です。 [クエリ] を使用する場合、完全なアクセスパスは /API ベースパス/操作パス です。リクエストパラメーターで、[クエリの追加] パラメーターをバージョン番号に設定する必要があります。 [ヘッダー] を使用する場合、完全なアクセスパスは /API ベースパス/操作パス です。リクエストヘッダーで、[ヘッダーの追加] パラメーターをバージョン番号に設定する必要があります。
   説明	API の説明を入力します。
   リソースグループ	ターゲットリソースグループを選択します。右側の [リソースグループの作成] をクリックできます。

インスタンス内の API

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

2. 左側のナビゲーションウィンドウで、[インスタンス] をクリックします。上部のメニューバーで、リージョンを選択します。

3. [インスタンス] ページで、ターゲットの [インスタンス ID] をクリックして [概要] ページに移動します。次に、左側のナビゲーションウィンドウで [API] をクリックし、[API の作成] をクリックします。

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

   設定項目	説明
   API 名	API のカスタム名を入力します。API 名はグローバルに一意である必要があります。
   ドメイン	API のドメイン名を選択します。複数のドメイン名を選択できます。 新しいドメイン名を作成するには、[ドメイン名の追加] をクリックします。
   ベースパス	API のベースパス。特定の操作にアクセスする場合、完全なパスは http(s)://{ドメイン名}/{ベースパス}/{操作パス} です。
   バージョン管理	API のバージョン管理を有効にするかどうかを指定します。異なるバージョンの API は独立した API として扱われます。同じ API 名を共有しますが、基本情報と操作の詳細は異なる場合があります。特定のバージョンにアクセスするには、バージョン識別子を指定する必要があります。 [バージョン管理] を有効にする場合は、[使用方法] を設定する必要があります。 説明 [使用方法] を [クエリ] に設定した場合は、[クエリの追加] パラメーターを設定する必要があります。 [使用方法] を [ヘッダー] に設定した場合は、[ヘッダーの追加] パラメーターを設定する必要があります。
   使用方法	[パス]、[クエリ]、および [ヘッダー] をサポートしています。 [パス] を使用する場合、完全なアクセスパスは /API ベースパス/バージョン番号/操作パス です。 [クエリ] を使用する場合、完全なアクセスパスは /API ベースパス/操作パス です。リクエストパラメーターで、[クエリの追加] パラメーターをバージョン番号に設定する必要があります。 [ヘッダー] を使用する場合、完全なアクセスパスは /API ベースパス/操作パス です。リクエストヘッダーで、[ヘッダーの追加] パラメーターをバージョン番号に設定する必要があります。
   説明	API の説明を入力します。
   リソースグループ	ターゲットリソースグループを選択します。右側の [リソースグループの作成] をクリックできます。
   シナリオ	現在の操作のシナリオを選択します。 基本シナリオ: [単一サービス]。 カナリアリリースシナリオ: [比率別 (マルチサービス)]、[コンテンツ別 (マルチサービス)]、[タグベースのルーティング (比率別)]。 説明 重みを持つすべてのターゲットサービスのトラフィック比率の合計は 100% である必要があります。
   バックエンドサービス	このゲートウェイまたは VPC の下のバックエンドサービスを関連付けます。ゲートウェイの下にバックエンドサービスが存在しない場合は、[サービスの作成] をクリックして作成します。 重要 新しいサービスを作成すると、サービスポート情報がすぐに表示されない場合があります。[サービス名] ドロップダウンリストを展開し、[更新] をクリックする必要があります。ポート情報は非同期で同期されるため、完全なサービスポート情報が読み込まれて表示されるまでに時間がかかる場合があります。

インスタンス外の API

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

2. 左側のナビゲーションウィンドウで、[API] をクリックします。上部のメニューバーで、リージョンを選択します。

3. [API の作成] をクリックします。

4. [REST API] カードで、[インポート] をクリックします。[OpenAPI から作成] パネルで、パラメーターを設定し、[ドライランと作成] をクリックします。

   設定項目	説明
   API 名	API のカスタム名を入力します。API 名はグローバルに一意である必要があります。
   アップロード方法	[ローカルファイル] と [OSS からインポート] をサポートしています。 説明 ローカルアップロードと OSS インポートの両方のファイルは、OpenAPI 仕様に準拠している必要があります。
   OpenAPI ファイル	このパラメーターは、[ローカルファイル] を選択したときに設定されます。ファイルを選択するか、テキストコンテンツを貼り付けることができます。ファイルサイズは 30 MB に制限されています。
   リージョンの選択	このパラメーターは、[OSS からインポート] を選択したときに設定されます。リージョンを選択して、その OSS リソースを選択します。
   OSS バケット	このパラメーターは、[OSS からインポート] を選択したときに設定されます。OSS バケットを選択します。リージョン属性のないバケットはサポートされていません。
   バージョン管理	API のバージョン管理を有効にするかどうかを指定します。異なるバージョンの API は独立した API として扱われます。同じ API 名を共有しますが、基本情報と操作の詳細は異なる場合があります。特定のバージョンにアクセスするには、バージョン識別子を指定する必要があります。 [バージョン管理] を有効にする場合は、[使用方法] を設定する必要があります。 説明 [使用方法] を [クエリ] に設定した場合は、[クエリの追加] パラメーターを設定する必要があります。 [使用方法] を [ヘッダー] に設定した場合は、[ヘッダーの追加] パラメーターを設定する必要があります。
   使用方法	[パス]、[クエリ]、および [ヘッダー] をサポートしています。 [パス] を使用する場合、完全なアクセスパスは /API ベースパス/バージョン番号/操作パス です。 [クエリ] を使用する場合、完全なアクセスパスは /API ベースパス/操作パス です。リクエストパラメーターで、[クエリの追加] パラメーターをバージョン番号に設定する必要があります。 [ヘッダー] を使用する場合、完全なアクセスパスは /API ベースパス/操作パス です。リクエストヘッダーで、[ヘッダーの追加] パラメーターをバージョン番号に設定する必要があります。
   説明	API の説明を入力します。
   リソースグループ	ターゲットリソースグループを選択します。右側の [リソースグループの作成] をクリックできます。

インスタンス内の API

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

2. 左側のナビゲーションウィンドウで、[インスタンス] をクリックします。上部のメニューバーで、リージョンを選択します。

3. [インスタンス] ページで、ターゲットの [インスタンス ID] をクリックして [概要] ページに移動します。次に、左側のナビゲーションウィンドウで [API] をクリックし、[API の作成] をクリックします。

4. [REST API] カードで、[インポート] をクリックします。[OpenAPI から作成] パネルで、パラメーターを設定し、[ドライランと作成] をクリックします。

   設定項目	説明
   API 名	API のカスタム名を入力します。API 名はグローバルに一意である必要があります。
   ドメイン	API のドメイン名を選択します。複数のドメイン名を選択できます。 新しいドメイン名を作成するには、[ドメイン名の追加] をクリックします。
   アップロード方法	[ローカルファイル] と [OSS からインポート] をサポートしています。 説明 ローカルアップロードと OSS インポートの両方のファイルは、OpenAPI 仕様に準拠している必要があります。
   OpenAPI ファイル	このパラメーターは、[ローカルファイル] を選択したときに設定されます。ファイルを選択するか、テキストコンテンツを貼り付けることができます。ファイルサイズは 30 MB に制限されています。
   リージョンの選択	このパラメーターは、[OSS からインポート] を選択したときに設定されます。リージョンを選択して、その OSS リソースを選択します。
   OSS バケット	このパラメーターは、[OSS からインポート] を選択したときに設定されます。OSS バケットを選択します。リージョン属性のないバケットはサポートされていません。
   バージョン管理	API のバージョン管理を有効にするかどうかを指定します。異なるバージョンの API は独立した API として扱われます。同じ API 名を共有しますが、基本情報と操作の詳細は異なる場合があります。特定のバージョンにアクセスするには、バージョン識別子を指定する必要があります。 [バージョン管理] を有効にする場合は、[使用方法] を設定する必要があります。 説明 [使用方法] を [クエリ] に設定した場合は、[クエリの追加] パラメーターを設定する必要があります。 [使用方法] を [ヘッダー] に設定した場合は、[ヘッダーの追加] パラメーターを設定する必要があります。
   使用方法	[パス]、[クエリ]、および [ヘッダー] をサポートしています。 [パス] を使用する場合、完全なアクセスパスは /API ベースパス/バージョン番号/操作パス です。 [クエリ] を使用する場合、完全なアクセスパスは /API ベースパス/操作パス です。リクエストパラメーターで、[クエリの追加] パラメーターをバージョン番号に設定する必要があります。 [ヘッダー] を使用する場合、完全なアクセスパスは /API ベースパス/操作パス です。リクエストヘッダーで、[ヘッダーの追加] パラメーターをバージョン番号に設定する必要があります。
   説明	API の説明を入力します。
   リソースグループ	ターゲットリソースグループを選択します。右側の [リソースグループの作成] をクリックできます。
   シナリオ	現在の操作のシナリオを選択します。 基本シナリオ: [単一サービス]。 カナリアリリースシナリオ: [比率別 (マルチサービス)]、[コンテンツ別 (マルチサービス)]、[タグベースのルーティング (比率別)]。 説明 重みを持つすべてのターゲットサービスのトラフィック比率の合計は 100% である必要があります。
   バックエンドサービス	このゲートウェイまたは VPC の下のバックエンドサービスを関連付けます。ゲートウェイの下にバックエンドサービスが存在しない場合は、[サービスの作成] をクリックして作成します。 重要 新しいサービスを作成すると、サービスポート情報がすぐに表示されない場合があります。[サービス名] ドロップダウンリストを展開し、[更新] をクリックする必要があります。ポート情報は非同期で同期されるため、完全なサービスポート情報が読み込まれて表示されるまでに時間がかかる場合があります。