サービス・パラメーターの定義と例

サービス・パラメータは、 IBM Cloud、お客様サービス・インスタンスを作成する際に、呼に追加のデータ・ポイントを収集し、追加するために使用される。以下のセクションで、サービス・パラメーターの使用法の例と定義を示します。製品のカスタム・サービス・パラメーターの追加を開始するには、サービスのカスタム・サービス・パラメーターの追加を参照してください。

サービス・パラメーターの例

以下の例は、必須テキスト・フィールドにカスタム・サービス・パラメーターを指定する方法を示しています。

周囲の metadata および service JSON 構造内で、 parameters キーはカスタム・サービス・パラメーターの JSON 配列を識別します。この例では、配列には subscription_id という ID を持つカスタム・パラメーターが 1 つだけ含まれています。これは必須テキストフィールドで、ラベルは Subscription ID 、説明は Subscription ID that will be used when provisioning the service instance です。このカスタムパラメータは、ユーザーが関連する2つの料金プラン、 068f8a20-8b27-4049-91fe-a3ff5f505352 または 45333bd7-79f5-475f-9b14-9fe99734592a のいずれかを選択するたびにUIに表示されます：

{
  "metadata": {
    //...
    "service": {
      //...
      "parameters": [{
          "associations": {
              "plan": {
                  "showFor": [
                      "068f8a20-8b27-4049-91fe-a3ff5f505352",
                      "45333bd7-79f5-475f-9b14-9fe99734592a"
                  ]
              }
          },
          "description": "Subscription ID that will be used when provisioning the service instance",
          "displayname": "Subscription ID",
          "name": "subscription_id",
          "required": true,
          "type": "text"
      }]
  }
}

このカスタム・パラメーターは、 サービス ・オブジェクトだけでなく、パラメーターが関連付けられている 2 つのサービス・プランのすべての デプロイメント ・オブジェクトにも追加する必要があります。また、カスタム・パラメーターを処理するには、デプロイメント・オブジェクトのデプロイメントを更新する必要があります。

必ず IBM Cloud コンソールでパラメータをテストし、指定した変更が正しく機能することを確認してください。

サービス・パラメーターの定義

parameters 構造は、カスタム・サービス・パラメーターの JSON 配列を定義します。サービス・インスタンスは、作成されると、配列内の情報を使用してカスタム・サービス・パラメーターを管理します。例については、このトピックの前のサブトピックを参照してください。

parameters 構造内の各カスタム・サービス・パラメーターのレイアウトは以下のとおりです。多くの属性はオプションです。

parameters.name: パラメーターのキー。
parameters.displayname: 表示されるパラメーターの名前。
parameters.type: IBM Cloud ユーザー・インターフェイスで表示されるプット・フィールドのタイプ。値は text、 password、 dropdown、 check box、 radio のいずれか。

この値は必須です。

以下のコード・ブロックは、 name、 displayname、および type パラメーターの例を示しています。

{
  "name": "pwd",
  "displayname": "Password",
  "type": "password"
}

parameters.options: dropdown, check box, radio 入力タイプで利用可能な値を指定するJSON構造体。
parameters.options.displayname: UI に表示するドロップダウン、チェック・ボックス、またはラジオ・ボタンの名前。
parameters.options.value: サービスの作成時にサービス・ブローカーに送信されるパラメーターの値。

{
  "options": [
    {
      "displayname": "HDFS",
      "value": "hdfs"
    },
    {
      "displayname": "YARN",
      "value": "yarn"
    },
  ]
}

parameters.value: パラメーターのデフォルト値。入力タイプがチェック・ボックスの場合は、値の配列にすることができます。

{
  ["hfs","yarn"]
}

parameters.layout: チェック・ボックスまたはラジオの入力タイプのレイアウトを指定します。指定されない場合、デフォルトのレイアウトは水平になります。
parameters.associations: 価格プランまたはその他のカスタム・パラメーター (あるいはその両方) との対話を記述する JSON 構造。

この値はオプショナルであり、 parameters.associations.<value> に付加される後続の値はすべてオプショナルである。

{
  "type": "text",
  "associations": {
    "plan": {
    "showFor": ["apsMyserviceParametersDemo-entry","apsMyserviceParametersDemo-enterprise"]
    }
  }
}

parameters.associations.plan: 価格プランとの対話を記述する JSON 構造。
parameters.associations.plan.showFor: 価格プラン ID の配列。指定した場合、対応する価格プランが選択されると、UI にこのパラメーターが表示されます。
parameters.associations.plan.optionsRefresh: これが指定されると、関連付けられた価格プランが選択されたときに optionsUrl が呼び出されます。
parameters.associations.parameters: その他のカスタム・パラメーターとの対話を記述する JSON の配列。
parameters.associations.parameters.name: 相互作用させたい他のカスタム・パラメータの名前。

parameters.associations.parameters が使用されている場合は必須です。

parameters.associations.parameters.showFor: 対話させたいカスタムパラメータに関連付けられた、選択された値の配列。これらの値のいずれかが選択されると、このパラメーターが UI に表示されます。
parameters.associations.parameters.optionsRefresh: このパラメータをtrueに設定すると、関連するパラメータ値が変更されたときに optionsUrl。
parameters.optionsUrl: 入力タイプがドロップダウン、チェック・ボックス、またはラジオの場合にオプションのリストを取得するために、コンソールによって呼び出される API。応答は、以下の 2 つのフィールドを含む JSON 構造です。
parameters.optionsUrl.options: parameters.options を返す JSON の配列。詳しくは、parameters.options の項目を参照してください。
parameters.optionsUrl.value: パラメーターの新しいデフォルト値。詳しくは、parameters.value の項目を参照してください。

コンソールは ace_config 照会パラメーターを渡します。そこには、現在の組織 GUID、スペース GUID、すべてのカスタム・パラメーターの現行値、および現在の価格プラン ID が含まれます。ベアラー・トークンはヘッダー内で伝搬されます。

parameters.invalidmessage: テキスト・ボックスの内容が無効の場合に表示されるメッセージ。
parameters.description: パラメーターの値に関するヘルプをユーザーに提供するために表示されるパラメーターの説明。
parameters.required: IBM Cloud ユーザー・インターフェースにパラメーターを入力する必要があるかどうかを示すブール値。
parameters.pattern: 値のチェックに使用される正規表現。
parameters.placeholder: 予期される値を記述した短いヒント。
parameters.readonly: パラメーターの値は表示専用で、ユーザーが変更できないかどうかを示すブール値。デフォルト値は false です。
parameters.hidden: キー値ペアをユーザーに対し非表示にするかどうかを示すブール値。デフォルト値は false です。