API設定変更例

APIはテナント毎に管理します。そのため、テナントIDの変更はできません。

■API設定値の変更(node_group_name、tenant_id、front_path、method以外)

spike_arrest、concurrent_rate_limit、back_path、keys、connect_timeout、write_timeout、read_timeout、retries、additional_headerの各値を変更する場合に実施します。

オプションの項目は省略可能です。省略した場合は、項目により、対象外となるかデフォルト値が設定されます。

API情報設定ファイルをコピーし、太字部分を変更して所定の場所へ配置後、APIの登録・変更コマンドを実行します。

変更完了後、ローカルサーバのAPI情報設定ファイルのマスタファイルへ反映してください。

API情報設定ファイル

api_proxy:
  node_group_name: apiserver1.v1.com
  tenant_id: 581bd924
  policy:
    spike_arrest:
      per_minute: 30  (または per_second: xx に書き換え)
    concurrent_rate_limit:
      limit: 10
  apis:
    - front_path: "/581bd924/api1"
     back_path: "/v1/core/581bd924/api1"
     methods:
       - method: ["POST","GET"]
        keys:
          - api_key: 62eb165c070a41d5c1b58d9d3d725cal
     connect_timeout: 10000
     write_timeout: 10000
     read_timeout: 10000
     retries: 10
     additional_header:
       key: Host
       value: 581bd924-abcdefgh

■API振り分け先の変更(node_group_name、targets)

APIの振り分け先を変更する場合に実施します。

API振り分け先の変更には、新しい振り分け先の定義を追加後、古い振り分け先を削除します。

振り分け先ノード情報設定ファイルをコピーし、新しいノードグループ名と、配下のtargets情報(太字部分)を指定し、所定の場所へ配置後、API振り分け先ノードの登録コマンドを実行します。登録完了後、振り分け先ノード情報設定ファイルのマスタファイルへ反映してください。
振り分け先ノード情報設定ファイル
```
node_group:
 - name: apiserver1.v1.com
   targets:
    - node: 192.168.2.10:30000
      enabled: true
    - node: 192.168.2.11:30000
      enabled: true
- name: apiserver1.v2.com
   targets:
    - node: 192.168.2.12:30000
      enabled: true
    - node: 192.168.2.13:30000
      enabled: true
```
API情報設定ファイルをコピーし、node_group_nameを、1. で登録した新しいノードグループ名に変更し、所定の場所へ配置後、APIの登録・変更コマンドを実行します。登録完了後、API情報設定ファイルのマスタファイルへ反映してください。
登録完了後、API情報設定ファイルのマスタファイルへ反映してください。
```
api_proxy:
  node_group_name: apiserver1.v2.com
	：
```
振り分け先ノード情報設定ファイルをコピーし、削除したいノードグループ名と、配下のtargets情報を記載し、所定の場所へ配置後、API振り分け先ノードの削除コマンドを実行します。
振り分け先ノード情報設定ファイル
```
node_group:
 - name: apiserver1.v1.com
   targets:
    - node: 192.168.2.10:30000
      enabled: true
    - node: 192.168.2.11:30000
      enabled: true
```

振り分け先ノード情報設定ファイルのマスタファイルから、3. の情報を削除してください。

振り分け先ノード情報設定ファイル

node_group:
 - name: apiserver1.v1.com    #削除する
   targets:    #削除する
    - node: 192.168.2.10:30000    #削除する
      enabled: true    #削除する
    - node: 192.168.2.11:30000    #削除する
      enabled: true    #削除する
- name: apiserver1.v2.com
   targets:
    - node: 192.168.2.12:30000
      enabled: true
    - node: 192.168.2.13:30000
      enabled: true

■APIの変更(method追加)

APIのmethodを追加する場合に実施します。

API情報設定ファイルをコピーして、新しいmethod（太字部分）を追加し、所定の場所へ配置後、APIの登録・変更コマンドを実行します。変更完了後、API情報設定ファイルのマスタファイルへ反映してください。

API情報設定ファイル

api_proxy:
  node_group_name: apiserver1.v1.com
  tenant_id: 581bd924
  policy:
    spike_arrest:
      per_minute: 30
    concurrent_rate_limit:
      limit: 10
  apis:
    - front_path: "/581bd924/api2"
     back_path: "/v1/core/581bd924/api1"
     methods:
       - method: ["POST", "GET", "PUT"]
        auth: true
        keys:
          - api_key: 62eb165c070a41d5c1b58d9d3d725cal
     connect_timeout: 10000
     write_timeout: 10000
     read_timeout: 10000
     retries: 10
     additional_header:
       key: Host
       value: 581bd924-abcdefgh

■APIの変更(front_path、method)

APIのfront_path、または、method、または、両方を変更する場合に実施します。

APIの変更には、APIの削除後、登録を行います。

API情報設定ファイルをコピーして、変更対象のfront_path、methodを記載し、所定の場所へ配置後、APIの削除コマンドを実行します。削除完了後、API情報設定ファイルのマスタファイルへ反映してください。

API情報設定ファイル

api_proxy:
  node_group_name: apiserver1.v1.com
  tenant_id: 581bd924
  policy:
    spike_arrest:
      per_minute: 30
    concurrent_rate_limit:
      limit: 10
  apis:
    - front_path: "/581bd924/api1"
     back_path: "/v1/core/581bd924/api1"
     methods:
       - method: ["POST", "GET"]
        keys:
          - api_key: 62eb165c070a41d5c1b58d9d3d725cal
     connect_timeout: 10000
     write_timeout: 10000
     read_timeout: 10000
     retries: 10
     additional_header:
       key: Host
       value: 581bd924-abcdefgh

API情報設定ファイルをコピーして、新しいfront_path、methodを記載し、所定の場所へ配置後、APIの登録・変更コマンドを実行します。変更完了後、API情報設定ファイルのマスタファイルへ反映してください。

API情報設定ファイル

api_proxy:
  node_group_name: apiserver1.v1.com
  tenant_id: 581bd924
  policy:
    spike_arrest:
      per_minute: 30
    concurrent_rate_limit:
      limit: 10
  apis:
    - front_path: "/581bd924/api2"
     back_path: "/v1/core/581bd924/api1"
     methods:
       - method: ["GET"]
        keys:
          - api_key: 62eb165c070a41d5c1b58d9d3d725cal
     connect_timeout: 10000
     write_timeout: 10000
     read_timeout: 10000
     retries: 10
     additional_header:
       key: Host
       value: 581bd924-abcdefgh

付録A API設定変更例

■API設定値の変更(node_group_name、tenant_id、front_path、method以外)

■API振り分け先の変更(node_group_name、targets)

■APIの変更(method追加)

■APIの変更(front_path、method)