Définitions et exemples de paramètres de service

Les paramètres de service sont utilisés pour collecter et ajouter des points de données supplémentaires à un appel lorsqu'un client IBM Cloud crée une instance de service. Les sections suivantes fournissent des exemples et des définitions illustrant comment les paramètres de service peuvent être utilisés. Pour commencer à ajouter des paramètres de service personnalisé pour votre produit, voir Ajout de paramètres de service personnalisé pour votre service.

Exemples de paramètres de service

L'exemple suivant montre comment spécifier un paramètre de service personnalisé pour une zone de texte obligatoire.

Dans les structures JSON metadata et service environnantes, la clé parameters identifie un tableau JSON de paramètres de service personnalisé. Dans cet exemple, le tableau ne contient qu'un seul paramètre personnalisé, dont l'identificateur est subscription_id. Il s'agit d'un champ de texte obligatoire dont l'intitulé est Subscription ID et la description Subscription ID that will be used when provisioning the service instance. Ce paramètre personnalisé sera affiché dans l'interface utilisateur chaque fois que l'utilisateur sélectionnera l'un des deux plans tarifaires associés, 068f8a20-8b27-4049-91fe-a3ff5f505352 ou 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"
      }]
  }
}

Ce paramètre personnalisé doit être ajouté non seulement à l'objet Service, mais également à tous les objets Déploiement pour les deux plans de service auxquels le paramètre est associé. Les déploiements des objets de déploiement doivent également être mis à jour pour traiter le paramètre personnalisé.

Testez toujours vos paramètres dans la console IBM Cloud pour vérifier que les changements que vous avez spécifiés fonctionnent correctement.

Définitions de paramètres de service

La structure parameters définit un tableau JSON de paramètres de service personnalisés. Lorsqu'une instance de service est créée, elle utilise les informations du tableau pour gérer les paramètres de service personnalisé. Pour un exemple, voir la sous-rubrique précédente de cette rubrique.

Chaque paramètre de service personnalisé de la structure parameters possède la présentation suivante. De nombreux attributs sont facultatifs:

parameters.name: Clé du paramètre.
parameters.displayname: Nom du paramètre affiché.
parameters.type: Type de champ d'affichage affiché par l'interface utilisateur IBM Cloud. La valeur peut être text, password, dropdown, check box, ou radio.

Cette valeur est obligatoire.

Le codeblock suivant montre des exemples pour les paramètres name, displayname et type:

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

parameters.options: Une structure JSON pour spécifier les valeurs disponibles pour les types d'entrée dropdown, check box, et radio.
parameters.options.displayname: Nom de la liste déroulante, de la case à cocher ou du bouton d'option que vous souhaitez afficher dans l'interface utilisateur.
parameters.options.value: Valeur de paramètre à envoyer au courtier de services lors de la création du service.

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

parameters.value: Valeur par défaut du paramètre. Pour le type d'entrée case à cocher, il peut s'agir d'un tableau de valeurs.

{
  ["hfs","yarn"]
}

parameters.layout: Spécifie la configuration du type d'entrée case à cocher ou bouton d'option. Par défaut, la présentation est horizontale.
parameters.associations: Structure JSON permettant de décrire les interactions avec les plans de tarification et/ou d'autres paramètres personnalisés.

Cette valeur est facultative, et toutes les valeurs suivantes qui sont ajoutées à parameters.associations.<value> sont facultatives.

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

parameters.associations.plan: Structure JSON permettant de décrire l'interaction avec les plans de tarification.
parameters.associations.plan.showFor: Tableau d'identificateurs de plan de tarification. Si ce paramètre est spécifié, il s'affiche dans l'interface utilisateur lors de la sélection du plan de tarification correspondant.
parameters.associations.plan.optionsRefresh: Lorsque ce paramètre est spécifié, optionsUrl est appelé lors de la sélection du plan de tarification associé.
parameters.associations.parameters: Tableau de valeurs JSON décrivant l'interaction avec d'autres paramètres personnalisés.
parameters.associations.parameters.name: Le nom de l'autre paramètre personnalisé avec lequel vous souhaitez interagir.

Obligatoire avec parameters.associations.parameters.

parameters.associations.parameters.showFor: Un tableau de valeurs sélectionnées associées au paramètre personnalisé avec lequel vous souhaitez interagir. Ce paramètre s'affiche dans l'interface utilisateur lorsque l'une de ces valeurs est sélectionnée.
parameters.associations.parameters.optionsRefresh: Lorsque ce paramètre a la valeur "true", la page optionsUrl est appelée lorsque la valeur du paramètre associé est modifiée et que ce paramètre est visible dans l'interface utilisateur.
parameters.optionsUrl: API appelée par la console pour obtenir une liste d'options pour la liste déroulante, la case à cocher ou le type d'entrée radio. La réponse est une structure JSON contenant deux zones :
parameters.optionsUrl.options: Tableau JSON renvoyant parameters.options ; pour plus de détails, voir l'entrée pour parameters.options.
parameters.optionsUrl.value: Nouvelle valeur par défaut du paramètre. Pour plus de détails, voir l'entrée pour parameters.value.

La console transmet le paramètre de requête ace_config, qui contient l'identificateur global unique de l'organisation, l'identificateur global unique de l'espace, la valeur actuelle de tous les paramètres personnalisés et l'identificateur du plan de tarification en cours. Le jeton bearer est propagé dans l'en-tête.

parameters.invalidmessage: Message qui apparaît lorsque le contenu de la zone de texte n'est pas valide.
parameters.description: Description du paramètre affiché, destinée à aider les utilisateurs sur la valeur du paramètre.
parameters.required: Valeur booléenne indiquant si le paramètre doit être entré dans l'interface utilisateur IBM Cloud.
parameters.pattern: Expression régulière à laquelle la valeur est comparée.
parameters.placeholder: Suggestion courte décrivant la valeur attendue.
parameters.readonly: Valeur booléenne indiquant si la valeur du paramètre est accessible en lecture seule et non modifiable par l'utilisateur. La valeur par défaut est false.
parameters.hidden: Valeur booléenne indiquant si la paire clé-valeur est masquée aux utilisateurs. La valeur par défaut est false.