Definizioni ed esempi dei parametri di servizio

I parametri del servizio vengono utilizzati per raccogliere e aggiungere ulteriori punti di dati a una chiamata quando un cliente di IBM Cloud crea un'istanza di servizio. Le seguenti sezioni forniscono esempi e definizioni di come poter utilizzare i parametri di servizio. Per iniziare ad aggiungere parametri di servizio personalizzati per il tuo prodotto, vedi Aggiunta di parametri di servizio personalizzati per il tuo servizio.

Esempi di parametri di servizio

Il seguente esempio illustra come specificare un parametro del servizio personalizzato per un campo di testo richiesto.

All'interno delle strutture JSON metadata e service circostanti, la chiave parameters identifica un array JSON di parametri di servizi personalizzati. In questo esempio, l'array contiene solo un parametro personalizzato, che ha l'identificativo subscription_id. È un campo di testo obbligatorio con l'etichetta Subscription ID e la descrizione Subscription ID that will be used when provisioning the service instance. Questo parametro personalizzato verrà visualizzato nell'interfaccia utente ogni volta che l'utente seleziona uno dei due piani tariffari associati, 068f8a20-8b27-4049-91fe-a3ff5f505352 o 45333bd7-79f5-475f-9b14-9fe99734592a:

{
  "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"
      }]
  }
}

Questo parametro personalizzato deve essere aggiunto non solo all'oggetto Service ma anche a tutti gli oggetti Deployment per i due piani di servizio a cui è associato il parametro. Inoltre, le distribuzione per gli oggetti di distribuzione devono essere aggiornate per elaborare il parametro personalizzato.

Testate sempre il vostro parametro nella console IBM Cloud per verificare che le modifiche specificate funzionino correttamente.

Definizioni dei parametri di servizio

La struttura parameters definisce un array JSON di parametri di servizi personalizzati. Quando viene creata un'istanza del servizio, utilizza le informazioni nell'array per gestire i parametri del servizio personalizzato. Per un esempio, consultare il topic secondario precedente in questo topic.

Ogni parametro del servizio personalizzato nella struttura parameters ha il layout seguente. Molti degli attributi sono facoltativi:

parameters.name: La chiave del parametro.
parameters.displayname: Il nome del parametro che viene visualizzato.
parameters.type: Il tipo di campo put visualizzato dall'interfaccia utente di IBM Cloud. Il valore può essere text, password, dropdown, check box, o radio.

Questo valore è obbligatorio.

Il seguente codeblock mostra esempi per i parametri name, displayname e type:

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

parameters.options: Una struttura JSON per specificare i valori disponibili per i tipi di input dropdown, check box e radio.
parameters.options.displayname: Il nome del menu a discesa, della casella di spunta o del pulsante di opzione che vuoi visualizzare nell'IU.
parameters.options.value: Il valore del parametro da inviare al broker dei servizi durante la creazione del servizio.

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

parameters.value: Il valore predefinito del parametro. Per il tipo di input della casella di spunta, può essere un array di valori.

{
  ["hfs","yarn"]
}

parameters.layout: Specifica il layout dei tipi di input della casella di spunta o del pulsante di opzione. Se non specificato, il layout predefinito è orizzontale.
parameters.associations: Una struttura JSON per descrivere le interazioni con i piani tariffari e/o altri parametri personalizzati.

Questo valore è facoltativo e tutti i valori successivi aggiunti a parameters.associations.<value> sono facoltativi.

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

parameters.associations.plan: Una struttura JSON per descrivere l'interazione con i piani dei prezzi.
parameters.associations.plan.showFor: Un array di ID di piano dei prezzi. Se specificato, il parametro viene visualizzato nell'IU quando viene selezionato il piano dei prezzi corrispondente.
parameters.associations.plan.optionsRefresh: Se specificato, optionsUrl viene richiamato quando viene selezionato il piano dei prezzi associato.
parameters.associations.parameters: Un array di JSON che descrive l'interazione con altri parametri personalizzati.
parameters.associations.parameters.name: Il nome dell'altro parametro personalizzato con cui si vuole interagire.

Richiesto quando è in uso parameters.associations.parameters.

parameters.associations.parameters.showFor: Un array di valori selezionati associati al parametro personalizzato con cui si vuole interagire. Questo parametro viene visualizzato nell'IU quando viene selezionato uno di questi valori.
parameters.associations.parameters.optionsRefresh: Quando questo parametro è impostato su true, optionsUrl viene richiamato quando il valore del parametro associato viene modificato e questo parametro è visibile nell'interfaccia utente.
parameters.optionsUrl: L'API che viene richiamata dalla console per ottenere un elenco di opzioni per il tipo di input del menu a discesa, della casella di spunta o del pulsante di opzione. La risposta è una struttura JSON che contiene due campi:
parameters.optionsUrl.options: Un array di JSON che restituirà parameters.options; per maggiori dettagli vedere la voce parameters.options.
parameters.optionsUrl.value: Il nuovo valore predefinito per il parametro. Per maggiori dettagli, vedere la voce relativa a parameters.value.

La console passa il parametro di query ace_config, che contiene il GUID dell'org corrente, il GUID dello spazio, il valore corrente di tutti i parametri personalizzati e l'ID del piano tariffario corrente. Il token bearer viene propagato nell'intestazione.

parameters.invalidmessage: Il messaggio che viene visualizzato quando il contenuto della casella di testo non è valido.
parameters.description: La descrizione del parametro che viene visualizzata per aiutare gli utenti con il valore del parametro.
parameters.required: Un valore booleano che indica se il parametro deve essere immesso nell'interfaccia utente IBM Cloud.
parameters.pattern: Un'espressione regolare rispetto alla quale il valore viene controllato.
parameters.placeholder: Un breve suggerimento che descrive il valore atteso.
parameters.readonly: Un valore booleano che indica se il valore del parametro viene solo visualizzato e non può essere modificato dagli utenti. Il valore predefinito è false.
parameters.hidden: Un valore booleano che indica se la coppie chiave-valore è nascosta agli utenti. Il valore predefinito è false.