Send Docs Feedback

Note: Most user interface tasks can be performed in Edge Classic or the New Edge experience. For an overview, getting started topics, and release notes specific to the New Edge experience, see the docs.

Creating and editing environment key value maps

This topic shows you how to create and edit key value maps (KVMs) in the management UI. The KVMs you create in the UI are environment scoped. For more information about KVMs and scope, see Working with key value maps.

Enabling encrypted KVMs in the Edge UI with Edge for Private Cloud 

Encrypted KVMs are supported in Edge for Private Cloud version 4.17.01 and later. However, support for encrypted KVMs in the Edge UI is disabled by default. To enable the Edge UI to support encrypted KVMs:

  1. On the Edge UI server, open the file in an editor. If the file does not exist, create it:
    > vi /opt/apigee/customer/application/
  2. Set the conf_apigee_apigee.feature.kvmencryption token to true:
  3. 変更を保存します。
  4. Change the owner of to "apigee":
    > chown apigee:apigee /opt/apigee/customer/application/  
  5. Restart the Edge UI:
    > /<inst_root>/apigee/apigee-service/bin/apigee-service edge-ui restart

Creating and editing environment key value maps

These steps describe how to create or edit a key value map in the management UI. Key value maps created this way are at the environment scope. For example, if you create a key value map in the 'test' environment, API proxies running in the 'prod' environment won't have access to the key value map.

  1. 管理 UI で「APIs」 > 「Environment Configuration」を選択します。
  2. Select the Environment for which you want to configure key value maps, such as test or prod.
  3. On the Key Value Maps tab, click +Key Value Map to create an new one (or expand an existing key value map and click Edit).
  4. Select Encrypted if you want the key value map to be encrypted. In the UI, values to appear as asterisks (*****). Encryption is set on the entire map. You cannot set encryption entry by entry. 
    You can only encrypt key value maps when you create them. You can't encrypt or decrypt a key value map after it's created.
  5. 「+Entry」ボタンをクリックして、新しいキー/値マップペアを追加します。

  6. キー/値のプロパティを、以下の表の説明に従って入力します。
    プロパティ名 デフォルト値 説明
    Key 該当なし

    API プロキシでデータ値のアクセスに使用するキー名。

    Core Persistence Services (後述を参照) 対応組織の場合は、キー名が 2 KB を上回らないようにしてください。


    The value of the key. Enter any combination of numbers, letters, or special characters.

    Note that the total size of a KVM cannot be larger than 15 MB.

  7. 「Save」をクリックします。

キーの数が 150 個を上回るマップを表示または変更する場合は、UI から管理 API を使用するよう促されます。

If your organization is enabled with Core Persistence Services (CPS), working with key value maps is slightly different than in non-CPS organizations. For example, with CPS, you add, modify, and save individual key/value entries. Without CPS, you add and modify key/value entries, then save the entire key value map. For more information on CPS, see "About Core Persistence Services (CPS)" in API reference getting started.


Help or comments?