Definições de parâmetro de serviço e exemplos

Os parâmetros de serviço são usados para coletar e adicionar pontos de dados adicionais a uma chamada quando um cliente do IBM Cloud cria uma instância de serviço. As seções a seguir fornecem exemplos e definições de como os parâmetros de serviço podem ser usados. Para começar a adicionar parâmetros de serviço personalizados para o seu produto, consulte Adicionando parâmetros de serviço personalizados para o seu serviço.

Exemplos de parâmetros de serviço

O exemplo a seguir ilustra como especificar um parâmetro de serviço customizado para um campo de texto necessário..

Dentro das estruturas metadata e service JSON circundantes, a chave parameters identifica uma matriz JSON de parâmetros de serviço customizados. Neste exemplo, a matriz contém apenas um parâmetro customizado, que possui o identificador subscription_id.. É um campo de texto obrigatório com o rótulo Subscription ID e a descrição Subscription ID that will be used when provisioning the service instance. Esse parâmetro personalizado será exibido na interface do usuário sempre que o usuário selecionar um dos dois planos de preços associados, 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"
      }]
  }
}

Esse parâmetro customizado deve ser incluído não apenas no objeto Service, mas também em todos os objetos Deployment para os dois planos de serviço aos os quais o parâmetro está associado Além disso, as implementações para os objetos de implementação devem ser atualizadas para processar o parâmetro customizado.

Sempre teste o seu parâmetro no console IBM Cloud para verificar se as alterações que você especificou funcionam corretamente.

Definições de parâmetros de serviço

A estrutura parameters define uma matriz JSON de parâmetros de serviço customizados.. Quando uma instância de serviço é criada ele usa as informações na matriz para gerenciar os parâmetros de serviço customizados. Para obter um exemplo, consulte o subtópico anterior neste tópico

Cada parâmetro de serviço customizado na estrutura parameters tem o seguinte layout. Muitos dos atributos são opcionais:

parameters.name: A chave para o parâmetro.
parameters.displayname: O nome do parâmetro que é exibido.
parameters.type: O tipo de campo colocado que é exibido pela interface do usuário IBM Cloud. O valor pode ser text, password, dropdown, check box, ou radio.

Este valor é necessário.

O seguinte codeblock mostra exemplos para os parâmetros name, displayname e type:

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

parameters.options: Uma estrutura JSON para especificar os valores disponíveis para os tipos de entrada dropdown, check box e radio.
parameters.options.displayname: O nome do menu suspenso, da caixa de seleção ou do botão de opções que você deseja exibir na IU.
parameters.options.value: O valor do parâmetro a ser enviado para o broker de serviço ao criar o serviço.

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

parameters.value: O valor padrão do parâmetro. Para o tipo de entrada da caixa de seleção, ele pode ser uma matriz de valores.

{
  ["hfs","yarn"]
}

parameters.layout: Especifica o layout da caixa de seleção ou os tipos de entrada de rádio. Quando não especificado, o layout padrão será horizontal.
parameters.associations: Uma estrutura JSON para descrever as interações com planos de preços e/ou outros parâmetros customizados.

Esse valor é opcional, e todos os valores subsequentes anexados a parameters.associations.<value> são opcionais.

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

parameters.associations.plan: Uma estrutura JSON para descrever a interação com planos de preço.
parameters.associations.plan.showFor: Uma matriz de IDs de plano de preço. Se especificado, o parâmetro será mostrado na IU quando o plano de preço correspondente for selecionado.
parameters.associations.plan.optionsRefresh: Quando especificado, o optionsUrl será chamado quando o plano de preço associado for selecionado.
parameters.associations.parameters: Uma matriz de JSON que descreve a interação com outros parâmetros customizados.
parameters.associations.parameters.name: O nome do outro parâmetro personalizado com o qual você deseja interagir.

Obrigatório quando parameters.associations.parameters estiver em uso.

parameters.associations.parameters.showFor: Uma matriz de valores selecionados que estão associados ao parâmetro personalizado com o qual você deseja interagir. Esse parâmetro será mostrado na IU quando um desses valores for selecionado.
parameters.associations.parameters.optionsRefresh: Quando esse parâmetro é definido como true, o optionsUrl é chamado quando o valor do parâmetro associado é alterado e esse parâmetro fica visível na interface do usuário.
parameters.optionsUrl: A API que é chamada pelo console para obter uma lista de opções para menu suspenso, caixa de seleção ou tipo de entrada de rádio. A resposta é uma estrutura JSON que contém dois campos:
parameters.optionsUrl.options: Uma matriz de JSON que retornará parameters.options. Para obter mais detalhes, consulte a entrada para parameters.options.
parameters.optionsUrl.value: O novo valor padrão do parâmetro. Para obter mais detalhes, consulte a entrada para parameters.value.

O console passa o parâmetro de consulta ace_config, que contém o GUID da organização atual, o GUID de espaço, o valor atual de todos os parâmetros customizados e o ID do plano de preço atual. O token de acesso é propagado no cabeçalho.

parameters.invalidmessage: A mensagem que aparece quando o conteúdo da caixa de texto é inválido.
parameters.description: A descrição do parâmetro que é exibido para ajudar os usuários com o valor do parâmetro.
parameters.required: Um valor booleano que indica se o parâmetro deve ser inserido na interface com o usuário do IBM Cloud.
parameters.pattern: Para concluir o processo de validação, consulte Configurar os detalhes do produto.
parameters.placeholder: Uma pequena dica que descreve o valor esperado.
parameters.readonly: Um valor booleano que indica se o valor do parâmetro é exibido somente e não pode ser alterado por usuários. O valor padrão é false.
parameters.hidden: Um valor booleano que indica se o par chave-valor é oculto dos usuários. O valor padrão é false.