서비스 매개변수 예

다음 예제는 필수 텍스트 필드에 대한 사용자 정의 서비스 매개변수를 지정하는 방법을 보여줍니다.

주변 metadata 및 service JSON 구조 내에서 parameters 키는 사용자 정의 서비스 매개변수의 JSON 배열을 식별합니다. 이 예제에서 배열에는 ID가 subscription_id 인 하나의 사용자 정의 매개변수만 포함되어 있습니다. Subscription ID 레이블과 Subscription ID that will be used when provisioning the service instance 설명이 있는 필수 텍스트 필드입니다. 이 사용자 지정 매개변수는 사용자가 두 가지 관련 요금제( 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"
      }]
  }
}

이 사용자 정의 매개변수는 Service 오브젝트뿐만 아니라 매개변수가 연관된 두 서비스 플랜의 모든 Deployment 오브젝트에도 추가되어야 합니다. 또한 사용자 정의 매개변수를 처리하도록 배치 오브젝트의 배치를 업데이트해야 합니다.

항상 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 가 호출되고 이 매개변수가 UI에 표시됩니다.

parameters.optionsUrl

드롭 다운, 선택란 또는 단일 선택 입력 유형의 옵션 목록을 가져오기 위해 콘솔에서 호출하는 API입니다. 응답은 다음 두 필드를 포함하는 JSON 구조입니다.

parameters.optionsUrl.options

parameters.options를 리턴하는 JSON 배열입니다. 세부사항은 parameters.options 항목을 참조하십시오.

parameters.optionsUrl.value

매개변수의 새로운 기본값입니다. 세부사항은 parameters.value 항목을 참조하십시오.

콘솔은 현재 조직 GUID, 공간 GUID, 모든 사용자 정의 매개변수의 현재 값 및 현재 가격 플랜 ID를 포함하는 ace_config 조회 매개변수를 전달합니다. 전달자 토큰은 헤더에서 전파됩니다.

parameters.invalidmessage

텍스트 상자의 컨텐츠가 올바르지 않으면 표시되는 메시지입니다.

parameters.description

사용자에게 매개변수 값에 관한 도움을 주기 위해 표시되는 매개변수 설명입니다.

parameters.required

매개변수를 IBM Cloud 사용자 인터페이스에 입력해야 하는지 표시하는 부울 값입니다.

parameters.pattern

값이 검사되는 정규식입니다.

parameters.placeholder

예상된 값을 설명하는 짧은 힌트입니다.

parameters.readonly

매개변수 값만 표시할지를 나타내고 사용자가 변경할 수 없는 부울 값입니다. 기본값은 false입니다.

parameters.hidden

사용자에게 키-값 쌍을 숨길지를 나타내는 부울 값입니다. 기본값은 false입니다.