[[["容易理解","easyToUnderstand","thumb-up"],["確實解決了我的問題","solvedMyProblem","thumb-up"],["其他","otherUp","thumb-up"]],[["難以理解","hardToUnderstand","thumb-down"],["資訊或程式碼範例有誤","incorrectInformationOrSampleCode","thumb-down"],["缺少我需要的資訊/範例","missingTheInformationSamplesINeed","thumb-down"],["翻譯問題","translationIssue","thumb-down"],["其他","otherDown","thumb-down"]],["上次更新時間:2025-08-18 (世界標準時間)。"],[[["\u003cp\u003eData residency in Apigee hybrid installations, available from version 1.12 onward, allows new setups to comply with data storage location regulations, but cannot be applied to existing installations.\u003c/p\u003e\n"],["\u003cp\u003eConfiguring Apigee hybrid for data residency involves creating an organization with specified control plane and consumer data regions, creating an environment via API with the control plane location, enabling a new data pipeline, and configuring override files.\u003c/p\u003e\n"],["\u003cp\u003eWhen setting up an organization for data residency, you must define the control plane location for core content storage, a consumer data region for API user data, and ensure a paid subscription billing type.\u003c/p\u003e\n"],["\u003cp\u003eEnabling the new data pipeline for hybrid version 1.13.1 is essential to allow analytics and debug data to be sent to the Apigee control plane and requires specific configuration properties in the overrides file.\u003c/p\u003e\n"],["\u003cp\u003eAccessing Apigee APIs for tasks in a hybrid setup requires calling APIs from within the specified control plane location, and special attention must be paid to non-forward proxy route and forward proxy URLs that need to be allowlisted.\u003c/p\u003e\n"]]],[],null,["# Using data residency with Apigee hybrid\n\n| You are currently viewing version 1.13 of the Apigee hybrid documentation. For more information, see [Supported versions](/apigee/docs/hybrid/supported-platforms#supported-versions).\n\nThis topic explains how to configure a new Apigee hybrid installation for data residency\ncompliance.\n\nAbout data residency\n--------------------\n\nStarting with hybrid version 1.12, you can use data residency with new Apigee\nhybrid installations. You cannot convert an existing installation to use data residency.\n\n\nData residency meets compliance and regulatory requirements by allowing you to specify\nthe geographic locations (regions) where Apigee data is stored. With data residency, selecting\nthe control plane location ensures that all customer content is stored within the specified region.\nSee also, see [Introduction to data residency](/apigee/docs/api-platform/get-started/drz-concepts).\n\nBasic steps for data residency configuration\n--------------------------------------------\n\nTo configure Apigee hybrid for data residency, you need to follow a few basic steps, including:\n\n- [Creating an Apigee organization with data residency](#creatinganorg)\n- [Creating an environment using the Apigee API](#createinganenv)\n- [Enabling the new data pipeline](#newpipeline)\n- [Configuring the overrides file(s)](#configureoverrides)\n\n### Creating an Apigee organization with data residency\n\nWhen you create an Apigee organization, you have the option of enabling the org with\ndata residency. Creating an org with data residency requires you to specify two\nkey location attributes: the **control plane location** and the **consumer data region** .\nYou will also need to specify the **billing type** . For details, see\n[Step 2: Create an organization](/apigee/docs/hybrid/v1.13/precog-provision).\n\n- **Control plane location** : You need to specify the location where customer core content like proxy bundles are stored. For a list see [Available Apigee API control plane regions](/apigee/docs/locations#available-apigee-api-control-plane-regions).\n\n\n The control plane location is the location of the service endpoint location, for example `us` for United States.\n\n\n The following table lists available hosting jurisdictions and regions for the Apigee control plane. \n\n ### Americas\n\n ### Europe\n\n ### Asia-Pacific\n\n ### Middle East\n\n- **Consumer data region** : You need to specify a region where API consumer data is stored. This must be a sub-region of the control plane region. For a list of available consumer data regions, see[Apigee locations](/apigee/docs/locations#consumer-data-region).\n- **Billing type**: You can only use data residency with paid subscription orgs.\n\n### Creating an environment using the Apigee API\n\n\nIf you create a new environment using the Apigee API, you must specify the\ncontrol plane location. See [Create an environment](/apigee/docs/hybrid/v1.13/precog-add-environment#apigee-apit).\nIf you use the UI to create an environment, no special steps are needed.\n\n### Enabling the new data pipeline\n\nIf data residency is enabled for a new hybrid 1.13.1 organization, then you must\nenable the new data pipeline feature. This feature enables analytics and debug data to be\nsent to the Apigee control plane. To enable the data pipeline, follow the instructions\nin [Configure hybrid to use the new data pipeline](/apigee/docs/hybrid/v1.13/data-collection-with-data-residency).\n\n\n#### Overrides changes to enable the new data pipeline\n\n\nAdd the following configuration properties to each overrides file and apply them:\n\n- [contractProvider](/apigee/docs/hybrid/v1.13/config-prop-ref#contractprovider): The service endpoint for Apigee management APIs. For example: `https://us-apigee.googleapis.com`.\n- [newDataPipeline.debugSession](/apigee/docs/hybrid/v1.13/config-prop-ref#newdatapipeline): Set this to `true` to use the new data pipeline.\n- [newDataPipeline.analytics](/apigee/docs/hybrid/v1.13/config-prop-ref#newdatapipeline): Set this to `true` to enable analytics to use the new data pipeline.\n\nFor example: \n\n```\ninstanceID: \"my_hybrid_example\"\nnamespace: apigee\n\ngcp:\n projectID: hybrid-example\n region: us-central1\n\nk8sCluster:\n name: apigee-hybrid\n region: us-central1\n\norg: hybrid-example\n\ncontractProvider: https://us-apigee.googleapis.com\nnewDataPipeline:\n debugSession: true\n analytics: true\n```\n\nSee [Step 6: Create the overrides](/apigee/docs/hybrid/v1.13/install-create-overrides)\n\n### When calling the Apigee APIs\n\nWhen you make `curl` calls to Apigee APIs to perform tasks in your hybrid installation, you will need to call APIs from within the control plane location: \n\n```\ncurl -H \"Authorization: Bearer $TOKEN\" \\\n \"https://CONTROL_PLANE_LOCATION-apigee.googleapis.com/v1/organizations/ORG_NAME/envgroups\"\n```\n\nFor example: \n\n```\ncurl -H \"Authorization: Bearer $TOKEN\" \\\n \"https://us-apigee.googleapis.com/v1/organizations/my-hybrid-org/envgroups\"\n```\n\n### URL allowlisting\n\nYou must enable a non-forward proxy route for Apigee hybrid data residency. This route\ncan be a NAT with allowlisting for:\n\n- `iamcredentials.googleapis.com`\n- `oauth2.googleapis.com`\n\nIf you are using forward proxy with data residency, you must allowlist in the forward proxy:\n\n- \u003cvar translate=\"no\"\u003eCONTROL_PLANE_LOCATION\u003c/var\u003e`-apigee.googleapis.com`\n- \u003cvar translate=\"no\"\u003eANALYTICS_REGION\u003c/var\u003e`-pubsub.googleapis.com`\n- URLs required by Apigee hybrid, see [Google Cloud URLs to allow for Hybrid](/apigee/docs/hybrid/v1.13/allow-gcp-urls).\n\n### Enable analytics and debug data collection with data residency\n\nTo enable analytics and debug data collection, follow the instructions\nin [Configure hybrid to use the new data pipeline](/apigee/docs/hybrid/v1.13/data-collection-with-data-residency)."]]