Apigee プロビジョニング エラーのカタログ

このエラーカタログは、Apigee リソースのプロビジョニングで発生する可能性のある一般的なエラーのトラブルシューティングと解決に役立ちます。プロビジョニング中に UI またはコマンドラインで返されるエラーに関する詳細情報を確認できます。

カタログには次の情報が含まれています。

  • エラーコード
  • エラー メッセージ
  • エラーの考えられる原因
  • エラーの解決手順

プロビジョニング中に返されるエラー

Cloud コンソールの Apigee UI とコマンドライン インターフェース(CLI)のどちらでプロビジョニングを行うかにかかわらず、Apigee リソースのプロビジョニング中に API 呼び出しが行われます。プロビジョニング中、またはプロビジョニングのステータスを確認するために行われた API 呼び出しは、次に示すようなさまざまな状況でエラーを返します。

  • プロジェクトに対して Google Cloud Billing が有効になっていない
  • プロジェクトで必要な API が有効になっていない
  • リージョン、ピアリング範囲、その他のネットワーク構成に問題がある

通常、エラー メッセージには、問題の解決、エラーの解決、プロビジョニングのブロック解除に役立つ情報が含まれています。

エラーの形式

このカタログに含まれている一般的なエラーの場合、Cloud コンソールの Apigee UI にエラー メッセージが表示されます。次に例を示します。

  {
    "error": {
      "code": "FAILED_PRECONDITION",
      "message": "Error finding one or more network address ranges to use for the Instance. Verify
       the network configuration provided for the Instance and try again."
      }
  }

表示されたメッセージで、このリファレンスを探し、考えられるエラーの原因と解決手順を見つけてください。

一般的なエラー

ロケーションに利用可能な十分なリソースがない

エラー メッセージ

location "[loc]" does not have enough resources available to fulfill the request. Try again later
or choose a different location

考えられる原因

このエラーは、1 つ以上のリソースが使用できないゾーンまたはリージョンで Apigee インスタンスのプロビジョニングがリクエストされた場合に発生することがあります。このエラーは、インスタンス構成の問題によるものではありません。

解決手順

エラーを解決するには、別のリージョンにインスタンスをプロビジョニングするか、問題が解決するまで待ちます(通常は数時間以内)。

サービス ネットワーキングを検証できない

エラー メッセージ

最初のネットワーク検証エラー メッセージが表示され、その後に次の詳細なエラー メッセージが 1 つ以上表示されることがあります。

generic::failed_precondition: validation failed for service networking for network "[network]",
COMPUTE_API_NOT_ENABLED

generic::failed_precondition: validation failed for service networking for network "[network]",
RANGES_DELETED_LATER

generic::internal: error validating service networking consumer config for network "[network]":
This API method requires billing to be enabled. Please enable billing on project [project] by visiting
... then retry.

考えられる原因

このエラーは、ネットワーク構成の事前プロビジョニング検証で不合格だった場合に発生することがあります。

解決手順

次の表に、これらのエラー メッセージを解決するために行えるアクションの一覧を示します。

メッセージ 解決手順
COMPUTE_API_NOT_ENABLED Compute Engine API を有効にします
RANGES_DELETED_LATER 指定した IP 範囲が有効であることを確認します
Require billing to be enabled ... プロジェクトで課金が有効になっていることを確認します

/22 の空き IP 空間がない

エラー メッセージ

couldn't find a free IP space of /22 to launch an instance. Verify the peering ranges are available
as per https://cloud.google.com/apigee/docs/api-platform/get-started/install-cli#service-networking
and try again

考えられる原因

このエラーは、サブネットの作成中に、指定した範囲で /22 の IP 空間が使用できない場合に発生することがあります。

解決手順

このエラーを解決するには、指定した IP ピアリング範囲がサービス ネットワーキングでのサブネット作成の要件を満たしていることを確認します。その後、オペレーションを再試行します。

IP の割り振り中にエラーが発生した

エラー メッセージ

次のいずれかのエラー メッセージが表示されることがあります。

Error in allocating IPs to use for the Instance. Please verify the network configuration provided
for the Instance and try again.

Error in allocating IPs for ServiceAttachment.

Error finding one or more network address ranges to use for the Instance. Verify the network
configuration provided for the Instance and try again.

また、ネットワーク クライアントから詳細なエラー メッセージが表示されることもあります。次に例を示します。

Invalid resource usage: 'The resource 'projects/xxx' is already linked to another shared VPC host 
'projects/yyy'.

考えられる原因

このエラーは、サブネットの作成やネットワーク範囲の検索など、サービス ネットワーキング オペレーションの実行時に Apigee インスタンスを作成しているときに発生することがあります。サービス ネットワーキングからエラー メッセージが返されることもあります。

解決手順

サービス ネットワーキングの詳細なメッセージにある手順でエラーを解決してください。次のような操作が必要な可能性があります。

KMS 鍵の権限が拒否された

エラー メッセージ

apigee service agent <email> cannot encrypt/decrypt with kms key <keyID>: PermissionDenied

考えられる原因

Apigee インスタンスをプロビジョニングする前に、提供された KMS 鍵が検証されます。このエラーは、指定された鍵に対する Cloud KMS CryptoKey Encrypter / Decrypter ロールに必要な権限が、Apigee サービス エージェントに付与されていないことを示します。

解決手順

指定された KMS 鍵へのアクセス権を Apigee サービス エージェントに付与します。アクセス権を付与するコマンドについては、コマンドラインから有料組織をプロビジョニングするのステップ 1(f)をご覧ください。

リクエストが組織のポリシーで禁止されている

エラー メッセージ

The request is prohibited by organization's policy. Please refer to
https://cloud.google.com/vpc-service-controls/docs/troubleshooter
to review the org policy for VPC Service Control. vpcServiceControlsUniqueIdentifier:
<vpc-sc unique identifier>.

考えられる原因

このエラーは、Apigee インスタンスのプロビジョニング時に発生することがあります。インスタンス作成リクエストが、VPC Service Control に関する Google Cloud 組織のポリシーのいずれかによってブロックされています。

解決手順

このエラーを解決するには、最小限の労力で VPC Service Controls の問題を連絡、デバッグ、解決するに記載されている操作を行います。次の手順では、vpcServiceControlsUniqueIdentifier を使用して VPC-SC 構成を修正します。

ピアリングの最大数に達した

エラー メッセージ

The maximum number of peerings for the network (7) has been reached. Please delete unused peerings
for the network and try again

考えられる原因

このエラーは、Apigee インスタンスのプロビジョニング時に発生することがあります。この場合、利用可能なネットワーク ピアリングはありません。

解決手順

このエラーを解決するには、ネットワークで使用されていないピアリングを削除するか、インスタンスに別の VPC ネットワークを使用します。

ルーター数が上限を超えている

エラー メッセージ

exceeded maximum allowed routers in same network and region. Please use a different network + same
region OR same network + different region

考えられる原因

このエラーは、Cloud NAT(ネットワーク アドレス変換)の作成でプロビジョニング中に発生することがあります。この場合、ネットワークとリージョンの選択は無効です。

解決手順

エラーを解決するには、同じリージョンの別のネットワークを選択するか、別のリージョンで同じネットワークを使用します。

リソースが無効

エラー メッセージ

the resource 'projects/.../regions/.../serviceAttachments/...' was invalid. Must be either a valid
In-Project Forwarding Rule Target URL, a valid Service Attachment URL, or a supported Google API
bundle (global-only)

考えられる原因

このエラーは、指定されたサービス アタッチメントの URL が無効な場合に発生することがあります。

解決手順

この問題を解決するには、インスタンス構成のサービス アタッチメントの URL を有効な URL に更新します。

リソースが見つからない

エラー メッセージ

the resource 'projects/.../regions/.../serviceAttachments/...' was not found

考えられる原因

このエラーは、指定されたサービス アタッチメントの URL が見つからなかった場合に発生することがあります。

解決手順

このエラーを解決するには、インスタンス構成のサービス アタッチメントの URL を有効な URL に更新します。

ネットワーク範囲は削除されたが、割り当てが解放されていない

エラー メッセージ

a network range was deleted but still assigned in network <network>. Please refer to this guide
to fix: https://cloud.google.com/sdk/gcloud/reference/services/vpc-peerings/update. Valid ranges can
be found at VPC networks -> Private service connection -> Allocated IP ranges for services

考えられる原因

このエラーは、Apigee インスタンスに割り当てられたネットワーク範囲が削除されたか、部分的に削除された場合、または存在しない場合に発生することがあります。

解決手順

このエラーを解決するには、次のコマンドを実行して、割り振り範囲の VPC ピアリングを更新します。

gcloud services vpc-peerings update \
  --service=servicenetworking.googleapis.com \
  --ranges=$VALID_RANGES \
  --network=$NETWORK \
  --project=$PROJECT \
  --force

IP 範囲の重複

エラー メッセージ

An IP range in the peer network (10.128.0.0/28) overlaps with an IP range (10.128.0.0/20) in an
active peer (peering-to-consumer) of the local network. Please use a different ipRange.
If you've recently deleted an ApigeeInstance and wanted to use the same ipRange, please wait
for some time and try again

考えられる原因

このエラーは、Apigee インスタンスのプロビジョニング時に発生することがあります。この場合、割り振られた IP 範囲が無効であるか、以前に作成した Apigee インスタンスの削除後に割り振り範囲が完全に解放されていないため、Apigee インスタンスの作成オペレーションが失敗します。

解決手順

エラーを解決するには、別の IP 範囲を使用するか、完全に解放された IP 範囲を使用してもう一度お試しください。

限定公開の Google API の範囲に接続できない

エラー メッセージ

couldn't connect to the private Google APIs ranges. This is likely a DNS mis-configuration if you've
set up peered-dns-domains. Please check
https://cloud.google.com/vpc/docs/configure-private-google-access#config-domain

考えられる原因

このエラーは、Apigee インスタンスのプロビジョニング時に発生することがあります。この場合、Apigee インスタンスは限定公開の Google API 範囲に接続できません。

解決手順

この問題を解決するには、限定公開の Google API 範囲の DNS 構成が正しく、限定公開の Google API 範囲に VPC ネットワーク内から到達できることを確認します。

プロジェクトに対して削除がトリガーされた

エラー メッセージ

deletion had been triggered for project <project>

考えられる原因

このエラーは、インスタンスの作成に使用するプロジェクトの削除プロセスが開始したときに発生する可能性があります。 この検証チェックは、プロビジョニング オペレーションの各ステップ間で実行されます。

解決手順

プロジェクトの削除が意図したものでない場合は、次のコマンドを使用してプロジェクトを復元します。

gcloud projects undelete PROJECT_ID

詳細については、プロジェクトの復元をご覧ください。

KMS 鍵の引数が無効

エラー メッセージ

apigee service agent <p4sa email> cannot encrypt/decrypt with kms key <kms key>: Invalid Argument

考えられる原因

このエラーは、プロビジョニング中に提供された KMS 鍵を検証するときに発生することがあります。この場合、Cloud KMS 鍵フィールドの値の 1 つ以上が無効です。

解決手順

このエラーを解決するには、Cloud KMS 鍵の正しい値を確認し、インスタンス構成のフィールドを更新します。

Google Cloud KMS API が有効になっていない

エラー メッセージ

Google Cloud KMS API has not been used in project <project> before or it is disabled. Enable it by
visiting https://console.developers.google.com/apis/api/cloudkms.googleapis.com/overview?project=<project> then retry.
If you enabled this API recently, wait a few minutes for the action to propagate to our systems
and retry.

考えられる原因

このエラーは、Apigee のプロビジョニングに使用するプロジェクトで Cloud KMS API が有効になっていない場合に発生することがあります。

解決手順

このエラーを解決するには、Cloud KMS API を有効にします。

Apigee API が有効になっていない

エラー メッセージ

Apigee API has not been used in project <project> before or it is disabled. Enable it by visiting
https://console.developers.google.com/apis/api/apigee.googleapis.com/overview?project=<project> then retry.
If you enabled this API recently, wait a few minutes for the action to propagate to our systems
and retry.

考えられる原因

このエラーは、Apigee のプロビジョニングに使用するプロジェクトで Apigee API が有効になっていない場合に発生することがあります。

解決手順

このエラーを解決するには、Apigee API を有効にします。

Google Cloud Billing が有効になっていない

エラー メッセージ

This API method requires billing to be enabled. Please enable billing on project <project number>
by visiting https://console.developers.google.com/billing/enable?project=<project number> then
retry. If you enabled billing for this project recently, wait a few minutes for the action to
propagate to our systems and retry.

考えられる原因

このエラーは、Apigee のプロビジョニングに使用する Google Cloud プロジェクトに対して課金が有効になっていない場合に発生することがあります。

解決手順

このエラーを解決するには、Google Cloud プロジェクトの課金を有効にします

サービス ネットワーキング接続の再作成

エラー メッセージ

please create Service Networking connection with service 'servicenetworking.googleapis.com' from
consumer project <project number> network <network> again

考えられる原因

このエラーは、サービス ネットワーキング ホストのプロジェクト番号の取得中に、Google Cloud プロジェクトでサービス ネットワーキング接続に失敗した場合に発生することがあります。

解決手順

この問題を解決するには、ステップ 2: ネットワーキングを設定するの説明に従ってサービス ネットワーク接続を作成します。

IAM 権限が拒否された

エラー メッセージ

IAM permission denied for service account  
service-<project number>@gcp-sa-apigee.iam.gserviceaccount.com. Ensure that Apigee service
account has Apigee service agent role to your consumer project.

考えられる原因

このエラーは、Google Cloud コンシューマー プロジェクトとやり取りする Apigee サービス アカウントの IAM 権限が正しくない場合に発生することがあります。

解決手順

この問題を解決するには、このオペレーションを開始するサービス アカウントに Apigee service agent ロールを付与します。権限は、Google Cloud コンソールの [IAM] ページで付与できます。