SetIntegrationRequest 정책

이 페이지는 Apigee 및 Apigee Hybrid에 적용됩니다.

Apigee Edge 문서 보기

정책 아이콘

개요

SetIntegrationRequest 정책을 사용하면 실행하려는 통합에 대한 요청 객체를 만들 수 있습니다. 정책에서 통합을 실행하는 데 필요한 API 트리거와 입력 매개변수의 세부정보를 구성해야 합니다. SetIntegrationRequest 정책을 실행하면 요청 객체가 생성되고 흐름 변수에 저장됩니다. 요청 객체에는 통합을 실행하는 데 필요한 모든 정보가 있습니다. 이 단계에서는 통합이 여전히 실행되지 않습니다. 통합을 실행하려면 IntegrationCallout 정책을 호출하거나 IntegrationEndpoint를 설정해야 합니다. IntegrationCallout 정책과 IntegrationEndpoint 모두 통합을 실행하려면 요청 객체가 필요합니다.

이 정책은 확장 가능한 정책이며, 이 정책을 사용하면 Apigee 라이선스에 따라 비용 또는 사용률이 영향을 받을 수 있습니다. 정책 유형 및 사용 영향에 대한 자세한 내용은 정책 유형을 참조하세요.

<SetIntegrationRequest>

SetIntegrationRequest 정책을 지정합니다.

기본값 해당 사항 없음
필수 여부 필수
유형 복합 유형
상위 요소 해당 사항 없음
하위 요소 <ApiTrigger>
<DisplayName>
<IntegrationName>
<IntegrationRegion>
<Parameters>
<ProjectId>
<Request>
<ScheduleTime>

다음 표에서는 <SetIntegrationRequest> 요소의 하위 요소를 간략하게 설명합니다.

하위 요소 필수 여부 설명
<ApiTrigger> 필수 통합에서 호출할 API 트리거의 이름입니다.
<DisplayName> 선택사항 정책의 커스텀 이름입니다.
<IntegrationName> 선택사항 실행할 통합의 이름입니다.
<IntegrationRegion> 필수 통합이 있는 리전의 이름입니다.
<Parameters> 선택사항 통합의 입력 매개변수입니다.
<ProjectId> 선택사항 실행할 통합이 있는 Google Cloud 프로젝트의 이름입니다.
<Request> 선택사항 요청 객체를 저장할 흐름 변수의 이름입니다.
<ScheduleTime> 선택사항 통합을 실행해야 하는 시간입니다.

SetIntegrationRequest 정책은 다음 구문을 사용합니다.

구문

<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<SetIntegrationRequest continueOnError="[true|false]" enabled="[true|false]" name="Set-Integration-Request">
  <DisplayName>POLICY_DISPLAY_NAME</DisplayName>
  <ProjectId ref="FLOW_VARIABLE_NAME">GOOGLE_CLOUD_PROJECT_ID</ProjectId>
  <IntegrationName ref="FLOW_VARIABLE_NAME">INTEGRATION_NAME</IntegrationName>
  <IntegrationRegion ref="FLOW_VARIABLE_NAME">INTEGRATION_REGION</IntegrationRegion>
  <ApiTrigger ref="FLOW_VARIABLE_NAME">API_TRIGGER_NAME</ApiTrigger>
  <ScheduleTime>PARAMETER_VALUE</ScheduleTime>
  <Parameters>
    <Parameter name="PARAMETER_NAME" type="PARAMETER_DATATYPE" ref="FLOW_VARIABLE_NAME">PARAMETER_VALUE</Parameter>
    <ParameterArray name="ARRAY_NAME" type="ARRAY_DATATYPE" ref="FLOW_VARIABLE_NAME>
      <Value ref="FLOW_VARIABLE_NAME>PARAMETER_VALUE</Value>
      <Value ref="FLOW_VARIABLE_NAME>PARAMETER_VALUE</Value>
      <Value ref="FLOW_VARIABLE_NAME>PARAMETER_VALUE</Value>
    </ParameterArray>
  </Parameters>
  <Request>FLOW_VARIABLE_NAME</Request>
</SetIntegrationRequest>

예

다음 예시는 SetIntegrationRequest 정책 정의를 보여줍니다.

<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<SetIntegrationRequest continueOnError="false" enabled="true" name="Set-Integration-Request">
  <DisplayName>Set Integration Request Policy</DisplayName>
  <ProjectId ref="my_projectid_var">apigee_staging_1</ProjectId>
  <IntegrationName ref="my_integration_ref">integration_1</IntegrationName>
  <IntegrationRegion ref="my_integration_ref">asia-east1</IntegrationRegion>
  <ApiTrigger ref="my_api_trigger_ref">API-Trigger-2</ApiTrigger>
  <ScheduleTime>2022-01-15T01:30:15Z</ScheduleTime>
  <Parameters>
    <Parameter name="my_str_param" type="string" ref="flow_var_1">someText</Parameter>
    <ParameterArray name="my_array_param" type="integer" ref="flow_var_2">
      <Value ref="flow_var_3">1</Value>
      <Value ref="flow_var_4">2</Value>
      <Value ref="flow_var_5">3</Value>
    </ParameterArray>
  </Parameters>
  <Request>my_request_var</Request>
</SetIntegrationRequest>

이 요소에는 다음과 같이 모든 정책에 공통된 속성이 있습니다.

속성 기본 필수 여부 설명
name 해당 없음 필수

정책의 내부 이름입니다. name 속성의 값에는 문자, 숫자, 공백, 하이픈, 밑줄, 마침표가 포함될 수 있습니다. 이 값은 255자(영문 기준)를 초과할 수 없습니다.

원하는 경우 <DisplayName> 요소를 사용하여 관리 UI 프록시 편집기의 정책에 다른 자연어 이름을 사용하여 정책에 라벨을 지정합니다.
continueOnError false 선택 정책이 실패할 경우 오류가 반환되도록 하려면 false로 설정합니다. 이는 대부분의 정책에서 예상되는 동작입니다. 정책이 실패해도 흐름 실행이 계속되도록 하려면 true로 설정합니다. 참조:
enabled true 선택 정책을 시행하려면 true로 설정합니다. 정책을 중지하려면 false로 설정합니다. 정책이 흐름에 연결되어 있어도 정책이 시행되지 않습니다.
async   false 지원 중단됨 이 속성은 지원이 중단되었습니다.

하위 요소 참조

이 섹션에서는 <SetIntegrationRequest>의 하위 요소를 설명합니다.

<DisplayName>

name 속성 외에 이 요소를 사용하여 관리 UI 프록시 편집기에서 자연스러운 다른 이름으로 정책의 라벨을 지정합니다.

<DisplayName> 요소는 모든 정책에 공통으로 적용됩니다.

기본값 해당 사항 없음
필수 여부 선택사항. <DisplayName>을 생략하면 정책의 name 속성 값이 사용됩니다.
유형 문자열
상위 요소 <PolicyElement>
하위 요소 없음

<DisplayName> 요소는 다음 문법을 사용합니다.

구문

<PolicyElement>
  <DisplayName>POLICY_DISPLAY_NAME</DisplayName>
  ...
</PolicyElement>

예

<PolicyElement>
  <DisplayName>My Validation Policy</DisplayName>
</PolicyElement>

<DisplayName> 요소에 속성 또는 하위 요소가 없습니다.

<ProjectId>

Google Cloud 프로젝트의 이름을 지정합니다.

Apigee는 이 요소에 지정한 값을 integration.project.id 흐름 변수에 할당합니다.

기본값 해당 사항 없음
필수 여부 선택사항
유형 문자열
상위 요소 <SetIntegrationRequest>
하위 요소 없음

<ProjectId> 요소는 다음 구문을 사용합니다.

구문

<ProjectId ref="FLOW_VARIABLE_NAME">GOOGLE_CLOUD_PROJECT_ID</ProjectId>

예

다음은 my_projectid_var 흐름 변수를 사용하여 프로젝트 ID를 가져오도록 정책을 구성하는 예시입니다. 런타임 시 흐름 변수가 확인되지 않으면 apigee_staging_1을 프로젝트 ID로 사용합니다.

<ProjectId ref="my_projectid_var">apigee_staging_1</ProjectId>

다음 표는 <ProjectId>의 속성을 설명합니다.

속성 필수 여부 유형 설명
ref 선택사항 문자열 Apigee가 Google Cloud 프로젝트 ID를 읽어야 하는 흐름 변수를 지정합니다. 다음 방법 중 하나로 <ProjectId> 요소를 설정할 수 있습니다.
  • <ProjectId>val</ProjectId>: val을 프로젝트 ID로 사용합니다.
  • <ProjectId ref="refval"/>: refval을 동적으로 확인하여 프로젝트 ID를 결정합니다. 확인된 프로젝트 ID가 유효하지 않거나 refval이 확인되지 않은 경우 Apigee가 예외를 보고합니다.
  • <ProjectId ref="refval">val</ProjectId>: refval을 동적으로 확인하여 프로젝트 ID를 결정합니다. 확인된 프로젝트 ID가 유효하지 않은 경우 Apigee가 예외를 보고합니다. refval이 확인되지 않으면 val을 프로젝트 ID로 사용합니다.

<IntegrationName>

실행할 통합을 지정합니다.

Apigee는 이 요소에 지정한 값을 integration.name 흐름 변수에 할당합니다.

통합 이름은 다음과 같은 이름 지정 요구사항을 충족해야 합니다.

  • 문자 또는 숫자로 시작하고 끝나야 합니다.
  • 공백을 포함할 수 없습니다.
  • 대시 또는 밑줄 문자를 연속으로 2개 사용할 수 없습니다.
기본값 해당 사항 없음
필수 여부 선택사항
유형 문자열
상위 요소 <SetIntegrationRequest>
하위 요소 없음

<IntegrationName> 요소는 다음 구문을 사용합니다.

구문

<IntegrationName ref="FLOW_VARIABLE_NAME">INTEGRATION_NAME</IntegrationName>

예

다음은 my_integration_ref 흐름 변수를 사용하여 통합 이름을 가져오도록 정책을 구성하는 예시입니다. 런타임 시 흐름 변수가 확인되지 않으면 integration_1을 통합 이름으로 사용합니다.

<IntegrationName ref="my_integration_ref">integration_1</IntegrationName>

다음 표는 <IntegrationName>의 속성을 설명합니다.

속성 필수 여부 유형 설명
ref 선택사항 문자열 Apigee가 통합 이름을 읽어야 하는 흐름 변수를 지정합니다. 다음 방법 중 하나로 <IntegrationName> 요소를 설정할 수 있습니다.
  • <IntegrationName>val</IntegrationName>: 통합 이름으로 val을 사용합니다.
  • <IntegrationName ref="refval"/>: refval을 동적으로 확인하여 통합 이름을 결정합니다. 확인된 통합 이름이 유효하지 않거나 refval이 확인되지 않은 경우 Apigee가 예외를 보고합니다.
  • <IntegrationName ref="refval">val</IntegrationName>: refval을 동적으로 확인하여 통합 이름을 결정합니다. 확인된 통합 이름이 유효하지 않은 경우 Apigee가 예외를 보고합니다. refval이 확인되지 않으면 val을 통합 이름으로 사용합니다.

<IntegrationRegion>

통합이 있는 리전을 지정합니다.

런타임 시 Apigee는 요소의 값을 integration.region 흐름 변수에 할당하고 리전 기반 대상 URL을 만들어 integration.target.url 흐름 변수에 저장합니다.

리전 기반 대상 URL의 형식은 다음과 같습니다. https://integration.region-integrations.googleapis.com

Application Integration에서 통합 리전을 지원해야 합니다. Application Integration의 지원되는 리전에 대한 자세한 내용은 지원되는 리전을 참조하세요.

기본값 해당 사항 없음
필수 여부 필수
유형 문자열
상위 요소 <SetIntegrationRequest>
하위 요소 없음

<IntegrationRegion> 요소는 다음 구문을 사용합니다.

구문

<IntegrationRegion ref="FLOW_VARIABLE_NAME">INTEGRATION_REGION</IntegrationRegion>

예

다음은 my_integration_region_ref 흐름 변수를 사용하여 통합 리전을 가져오도록 정책을 구성하는 예시입니다. 런타임 시 흐름 변수가 확인되지 않으면 asia-east1을 통합 리전으로 사용합니다.

<IntegrationRegion ref="my_integration_region_ref">asia-east1</IntegrationRegion>

다음 표는 <IntegrationRegion>의 속성을 설명합니다.

속성 필수 여부 유형 설명
ref 선택사항 문자열 Apigee가 통합 리전을 읽어야 하는 흐름 변수를 지정합니다. 다음 방법 중 하나로 <IntegrationRegion> 요소를 설정할 수 있습니다.
  • <IntegrationRegion>val</IntegrationRegion>: val을 통합 리전으로 사용합니다.
  • <IntegrationRegion ref="refval"/>: refval을 동적으로 확인하여 통합 리전을 결정합니다. 확인된 통합 리전이 유효하지 않거나 refval이 확인되지 않은 경우 Apigee가 예외를 보고합니다.
  • <IntegrationRegion ref="refval">val</IntegrationRegion>: refval을 동적으로 확인하여 통합 리전을 결정합니다. 확인된 통합 리전이 유효하지 않은 경우 Apigee가 예외를 보고합니다. refval이 확인되지 않으면 val을 통합 리전으로 사용합니다.

<ApiTrigger>

실행할 API 트리거를 지정합니다.

api_trigger/API_TRIGGER_NAME 형식으로 API 트리거 이름을 지정해야 합니다.

Apigee는 이 요소에 지정한 값을 integration.api.trigger 흐름 변수에 할당합니다.

<IntegrationName>을 지정한 경우 해당 통합의 API 트리거만 실행됩니다. 하지만 <IntegrationName>을 지정하지 않으면 지정된 API 트리거가 있는 모든 통합이 실행됩니다.

기본값 해당 사항 없음
필수 여부 필수
유형 문자열
상위 요소 <SetIntegrationRequest>
하위 요소 없음

<ApiTrigger> 요소는 다음 구문을 사용합니다.

구문

<ApiTrigger ref="FLOW_VARIABLE_NAME">API_TRIGGER_NAME</ApiTrigger>

예

다음은 my_api_trigger_ref 흐름 변수를 사용하여 API 트리거 이름을 가져오도록 정책을 구성하는 예시입니다. 런타임 시 흐름 변수가 확인되지 않으면 api_trigger/API-Trigger-2를 API 트리거 이름으로 사용합니다.

<ApiTrigger ref="my_api_trigger_ref">api_trigger/API-Trigger-2</ApiTrigger>

다음 표는 <ApiTrigger>의 속성을 설명합니다.

속성 필수 여부 유형 설명
ref 선택사항 문자열 Apigee가 API 트리거 이름을 읽어야 하는 흐름 변수를 지정합니다. 다음 방법 중 하나로 <ApiTrigger> 요소를 설정할 수 있습니다.
  • <ApiTrigger>val</ApiTrigger>: val을 API 트리거 이름으로 사용합니다.
  • <ApiTrigger ref="refval"/>: refval을 동적으로 확인하여 트리거 이름을 결정합니다. 확인된 API 트리거 이름이 유효하지 않거나 refval이 확인되지 않은 경우 Apigee가 예외를 보고합니다.
  • <ApiTrigger ref="refval">val</ApiTrigger>: refval을 동적으로 확인하여 트리거 이름을 결정합니다. 확인된 API 트리거 이름이 유효하지 않은 경우 Apigee가 예외를 보고합니다. refval이 확인되지 않으면 val을 트리거 이름으로 사용합니다.

<ScheduleTime>

통합을 실행해야 하는 시간을 지정합니다.

시간이 현재 시간보다 작거나 같으면 통합이 즉시 실행됩니다. 시간은 yyyy-mm-ddThh:mm:ssZ 형식으로 지정해야 합니다. 여기서 Z는 UTC 시간대입니다. 예를 들어 2022-01-15T01:30:15Z를 지정하면 통합은 1-15-2022 1:30:15 UTC에 실행되도록 예약됩니다. UTC와의 오프셋을 사용하여 시간대를 지정할 수도 있습니다. 예를 들어 2022-01-15T01:30:15-08:00을 지정하면 통합은 2022년 1월 15일 1시 30분 15초(PST)에 실행되도록 예약됩니다. 시간 형식에 대한 자세한 내용은 결합된 날짜 및 시간 표현을 참조하세요.

기본값 해당 사항 없음
필수 여부 선택사항
유형 문자열
상위 요소 <SetIntegrationRequest>
하위 요소 없음

<ScheduleTime> 요소는 다음 구문을 사용합니다.

구문

<ScheduleTime>PARAMETER_VALUE</ScheduleTime>

예

다음 예시에서는 2022-01-15T01:30:15Z에 통합을 실행하도록 예약합니다.

<ScheduleTime>2022-01-15T01:30:15Z</ScheduleTime>

<Parameters>

통합을 실행하는 데 필요한 입력 매개변수를 지정합니다.

개별 매개변수 또는 매개변수 배열을 지정할 수 있습니다.

  • 개별 매개변수를 지정하려면 <Parameter> 요소를 사용합니다.
  • 매개변수 배열을 지정하려면 <ParameterArray> 요소를 사용합니다.
기본값 해당 사항 없음
필수 여부 선택사항
유형 복합 유형
상위 요소 <SetIntegrationRequest>
하위 요소 <Parameter>
<ParameterArray>

다음 표는 <Parameters>의 속성을 설명합니다.

속성 필수 여부 유형 설명
substitutionVariableChar 선택사항 char <Parameter> 하위 요소에 흐름 변수 값을 템플릿 인수로 전달하도록 커스텀 구분 기호를 설정할 수 있습니다.

<Parameters> 요소는 다음 구문을 사용합니다.

구문

<Parameters substitutionVariableChar="SUBSTITUTION_CHAR">
  <Parameter name="PARAMETER_NAME" type="PARAMETER_DATATYPE" ref="FLOW_VARIABLE_NAME" >PARAMETER_VALUE</Parameter>
  <Parameter name="PARAMETER_NAME" type="PARAMETER_DATATYPE">SUBSTITUTION_CHAR FLOW_VARIABLE_NAME SUBSTITUTION_CHAR</Parameter>
  <ParameterArray name="ARRAY_NAME" type="ARRAY_DATATYPE ref="FLOW_VARIABLE_NAME"">
    <Value>PARAMETER_VALUE</Value>
    <Value ref="FLOW_VARIABLE_NAME"/>
    <Value ref="FLOW_VARIABLE_NAME">PARAMETER_VALUE</Value>
  </ParameterArray>
</Parameters>

예

다음 예시는 my_str_param 매개변수와 my_array_param 매개변수 배열을 초기화합니다.

<Parameters substitutionVariableChar="#">
  <Parameter name="my_str_param" type="string" ref="flow_var_1">someText</Parameter>
  <Parameter name="strVar" type="string">#flowvar1#</Parameter>
  <ParameterArray name="my_array_param" type="integer" ref="flow_var_2">
    <Value>1</Value>
    <Value ref="flow_var_3"/>
    <Value ref="flow_var_4">3</Value>
  </ParameterArray>
</Parameters>

Apigee는 빈 <Parameter> 및 <ParameterArray> 요소를 null 값으로 처리합니다. 예를 들어 <Parameter></Parameter> 및 <ParameterArray></ParameterArray> 같은 선언은 null 값으로 처리됩니다.

<Parameter>

입력 매개변수를 지정합니다.

기본값 해당 사항 없음
필수 여부 선택사항
유형 문자열
상위 요소 <Parameters>
하위 요소 없음

다음과 같은 방법으로 매개변수 값을 지정할 수 있습니다.

  • <Parameter name="my_param" type="string">val</Parameter>: 매개변수 값으로 val을 사용합니다. val이 유효하지 않으면 Apigee가 예외를 보고합니다.
  • <Parameter name="my_param" type="string" ref="refval"/>: 런타임에서 refval 흐름 변수를 확인하고 값을 사용합니다. 확인된 refval 값이 유효하지 않거나 refval이 확인되지 않은 경우 Apigee가 예외를 보고합니다.
  • <Parameter name="my_param" type="string" ref="refval">val</Parameter>: 런타임 시 refval 흐름 변수를 확인하고 값을 사용합니다. 확인된 refval 값이 잘못된 경우 Apigee가 예외를 보고합니다. refval이 확인되지 않으면 Apigee는 val을 매개변수 값으로 사용합니다.
  • <Parameter name="my_param" type="json">{"name":"$#flowval#$"}</Parameter>: $#FLOW_VARIABLE_NAME#$을 사용하여 흐름 변수 값을 매개변수의 템플릿 인수로 전달합니다. Apigee는 런타임 시 flowval 흐름 변수를 확인하고 해당 값을 사용합니다. 확인된 flowval 값이 잘못된 경우 예외가 보고됩니다.
  • <Parameter name="my_param" type="json">{"name":"SUBSTITUTION_CHAR flowval SUBSTITUTION_CHAR"}</Parameter>: 여기서 SUBSTITUTION_CHAR는 <Parameters> 상위 요소의 substitutionVariableChar 속성에 지정된 값입니다. Apigee는 런타임 시 flowval 흐름 변수를 확인하고 해당 값을 사용합니다. 확인된 flowval 값이 잘못된 경우 예외가 보고됩니다.

<Parameter> 요소는 다음 구문을 사용합니다.

구문
<Parameters substitutionVariableChar="SUBSTITUTION_CHAR">
  <Parameter name="PARAMETER_NAME" type="PARAMETER_DATATYPE">PARAMETER_VALUE</Parameter>
  <Parameter name="PARAMETER_NAME" type="PARAMETER_DATATYPE" ref="FLOW_VARIABLE_NAME"/>
  <Parameter name="PARAMETER_NAME" type="PARAMETER_DATATYPE" ref="FLOW_VARIABLE_NAME">PARAMETER_VALUE</Parameter>
  <Parameter name="PARAMETER_NAME" type="json">$#FLOW_VARIABLE_NAME#$</Parameter>
  <Parameter name="PARAMETER_NAME" type="PARAMETER_DATATYPE">SUBSTITUTION_CHAR FLOW_VARIABLE_NAME SUBSTITUTION_CHAR</Parameter>
</Parameters>
예시 1

다음 예시에서는 my_str_param 매개변수를 문자열로 선언하고 값을 someText로 설정합니다.

<Parameters>
  <Parameter name="my_str_param" type="string">someText</Parameter>
</Parameters>
예시 2

다음 예시에서는 my_double_param 매개변수를 double로 선언하고 flow_var 흐름 변수의 값을 매개변수에 할당합니다.

<Parameters>
  <Parameter name="my_double_param" type="double" ref="flow_var"/>
</Parameters>
예시 3

다음 예시에서는 값을 my_int_param_1 정수 매개변수로 설정합니다.

<Parameters>
  <Parameter name="my_int_param_1" type="integer" ref="flow_var_1">96</Parameter>
</Parameters>

이 예시에서는 flow_var_1 흐름 변수가 성공적으로 확인되면 my_int_param_1이 흐름 변수의 값으로 설정됩니다. 하지만 flow_var_1을 확인할 수 없으면 my_int_param_1이 96으로 설정됩니다.

예 4

다음 예시에서는 my_json_param_1 및 my_json_param_2 JSON 매개변수의 값을 설정합니다.

<Parameters>
  <Parameter name="my_json_param_1" type="json" ref="flow_var_1">{name:"Apple", color:"Red"}</Parameter>
  <Parameter name="my_json_param_2" type="json">{name:"Banana", color:"Yellow"}</Parameter>
</Parameters>

이 예시에서는 flow_var_1 흐름 변수가 성공적으로 확인되면 my_json_param_1이 flow_var_1 흐름 변수의 값으로 설정됩니다. 하지만 flow_var_1이 확인되지 않으면 my_json_param_1이 {name:"Apple", color:"Red"}로 설정됩니다. 지정된 ref 속성이 없으므로 my_json_param_2 매개변수가 {name:"Banana", color:"Yellow"}로 설정됩니다.

예시 5

다음 예시에서는 기본 템플릿에서 전달된 흐름 변수 값을 사용하여 template_json_param JSON 매개변수의 값을 설정합니다.

  <Parameters>
    <Parameter name="template_json_param" type="json">{"name":"$#flow_var_1#$"}</Parameter>
</Parameters>

이 예시에서는 flow_var_1 흐름 변수가 성공적으로 확인되면 template_json_param이 flow_var_1 흐름 변수의 값으로 설정됩니다. 그러나 flow_var_1이 확인되지 않으면 Apigee에서 예외가 발생합니다.

예시 6

다음 예시에서는 substitutionVariableChar 속성을 사용하여 template_json_param JSON 매개변수의 값을 설정합니다.

<Parameters substitutionVariableChar="#">
    <Parameter name="template_json_param" type="json">{"name":"#flow_var_1#"}</Parameter>
</Parameters>

이 예시에서는 flow_var_1 흐름 변수가 성공적으로 확인되면 template_json_param이 flow_var_1 흐름 변수의 값으로 설정됩니다. 그러나 flow_var_1이 확인되지 않으면 Apigee에서 예외가 발생합니다.

다음 표는 <Parameter>의 속성을 설명합니다.

속성 필수 여부 유형 설명
name 필수 문자열 매개변수 이름
type 필수 문자열 매개변수의 데이터 유형입니다. 지원되는 유형은 integer, string, boolean, double, json입니다.
ref 선택사항 문자열 Apigee가 매개변수 값을 읽어야 하는 흐름 변수를 지정합니다. Apigee는 다음 기준을 사용하여 매개변수 값을 설정합니다.
  • 흐름 변수가 런타임에서 확인되고 유효하면 Apigee는 흐름 변수의 값을 사용합니다.
  • 런타임에서 흐름 변수가 확인되지만 유효하지 않으면 Apigee가 예외를 보고합니다.
  • 런타임 시 흐름 변수가 확인되지 않는 경우 Apigee는 <Parameter> 요소 값을 사용합니다. 요소 값이 유효하지 않으면 Apigee가 오류를 보고합니다.

<ParameterArray>

입력 매개변수 배열을 지정합니다.

기본값 해당 사항 없음
필수 여부 선택사항
유형 복합 유형
상위 요소 <Parameters>
하위 요소 <Value>

<Parameters> 요소는 그 안에 여러 <ParameterArray> 요소를 포함할 수 있습니다. 매개변수 배열의 경우 실제 값을 지정하거나 ref 속성에 흐름 변수를 지정하여 배열 요소의 값을 설정할 수 있습니다. 흐름 변수를 지정하면 배열 요소가 흐름 변수의 값으로 설정됩니다. 이 섹션의 예시에서는 <ParameterArray> 요소를 구성할 수 있는 다양한 방법을 설명합니다.

<ParameterArray> 요소는 다음 구문을 사용합니다.

구문
<Parameters>
  <ParameterArray name="ARRAY_NAME" type="ARRAY_DATATYPE" ref="FLOW_VARIABLE_NAME">
    <Value ref="FLOW_VARIABLE_NAME"/>
    <Value ref="FLOW_VARIABLE_NAME">PARAMETER_VALUE</Value>
    <Value>PARAMETER_VALUE</Value>
  </ParameterArray>
  <ParameterArray name="ARRAY_NAME" type="ARRAY_DATATYPE" ref="FLOW_VARIABLE_NAME"/>
  <ParameterArray name="ARRAY_NAME" type="ARRAY_DATATYPE">
    <Value ref="FLOW_VARIABLE_NAME"/>
    <Value ref="FLOW_VARIABLE_NAME">PARAMETER_VALUE</Value>
    <Value>PARAMETER_VALUE</Value>
  </ParameterArray>
<Parameters/>
Example-1

다음 예시에서는 my_array_param을 정수 배열로 선언하고 배열 요소 값을 1, 2, 3으로 설정합니다.

<Parameters>
  <ParameterArray name="my_array_param" type="integer">
    <Value>1</Value>
    <Value>2</Value>
    <Value>3</Value>
  </ParameterArray>
<Parameters/>
Example-2

다음 예시에서는 my_array_param을 double 배열로 선언합니다. 각 항목의 의미는 다음과 같습니다.

  • 첫 번째 요소는 flow_var_1 흐름 변수의 값으로 설정됩니다.
  • 두 번째 요소는 3.0으로 설정됩니다.
<Parameters>
  <ParameterArray name="my_array_param" type="double">
    <Value ref="flow_var_1"/>
    <Value>3.0</Value>
  </ParameterArray>
<Parameters/>
Example-3

다음 예시에서는 my_array_param을 부울 배열로 선언하고 flow_var_1 흐름 변수의 값으로 설정합니다.

<Parameters>
  <ParameterArray name="my_array_param" type="boolean" ref="flow_var_1">
    <Value>true</Value>
    <Value>false</Value>
    <Value>false</Value>
  </ParameterArray>
<Parameters/>

이 예시에서는 flow_var_1이 성공적으로 확인되면 my_array_param이 flow_var_1 배열의 값으로 설정됩니다. 그러나 flow_var_1이 확인되지 않으면 my_array_param 배열이 Value 요소의 값으로 설정됩니다.

Example-4

다음 예시에서는 my_array_param을 JSON 배열로 선언하고 flow_var_1 흐름 변수의 값으로 설정합니다.

<Parameters>
  <ParameterArray name="my_array_param" type="json" ref="flow_var_1"/>
<Parameters/>

이 예시에서는 flow_var_1이 성공적으로 확인되면 my_array_param이 flow_var_1 배열의 값으로 설정됩니다. 그러나 flow_var_1이 확인되지 않으면 Apigee가 예외를 보고합니다.

Example-5

다음 예시에서는 my_array_param을 문자열 배열로 선언하고 flow_var_1 흐름 변수의 값으로 설정합니다.

<Parameters>
  <ParameterArray name="my_array_param" type="string" ref="flow_var_1">
    <Value ref="flow_var_2"/>
    <Value>test_string</Value>
  </ParameterArray>
<Parameters/>

이 예시에서는 flow_var_1이 성공적으로 확인되면 my_array_param이 flow_var_1 배열의 값으로 설정됩니다. flow_var_1이 확인되지 않을 경우 my_array_param은 <Value> 요소에 지정된 값으로 설정됩니다.

다음 표는 <ParameterArray>의 속성을 설명합니다.

속성 필수 여부 유형 설명
name 필수 문자열 매개변수 배열의 이름입니다.
type 필수 문자열 매개변수 배열의 데이터 유형입니다. 지원되는 유형은 integer, string, boolean, double입니다.
ref 선택사항 문자열 Apigee가 배열 값을 읽어야 하는 흐름 변수를 지정합니다. Apigee는 다음 기준을 사용하여 매개변수 값을 설정합니다.
  • 흐름 변수가 런타임에서 확인되고 유효하면 Apigee는 흐름 변수의 값을 사용합니다.
  • 런타임에서 흐름 변수가 확인되지만 유효하지 않으면 Apigee가 예외를 보고합니다.
  • 런타임에서 흐름 변수가 확인되지 않는 경우 Apigee는 <Value> 요소에 지정된 값을 사용합니다.
<Value>

배열 요소의 값을 지정합니다.

기본값 해당 사항 없음
필수 여부 선택사항
유형 문자열
상위 요소 <ParameterArray>
하위 요소 없음

배열의 각 요소는 별도의 <Value> 요소여야 합니다. 값은 다음 방법으로 지정할 수 있습니다.

  • <Value>val</Value>: 요소 값으로 val을 사용합니다. val이 유효하지 않으면 Apigee가 예외를 보고합니다.
  • <Value ref="refval"/>: 런타임에서 refval 흐름 변수를 확인하고 값을 사용합니다. 확인된 refval 값이 유효하지 않거나 refval이 확인되지 않은 경우 Apigee가 예외를 보고합니다.
  • <Value ref="refval">val</Value>: 런타임 시 refval 흐름 변수를 확인하고 값을 사용합니다. 확인된 refval 값이 잘못된 경우 Apigee가 예외를 보고합니다. refval이 확인되지 않으면 Apigee는 val을 요소 값으로 사용합니다.
  • <Value>val1 $#flowval#$</Value>: $#FLOW_VARIABLE_NAME#$을 사용하여 흐름 변수 값을 값의 템플릿 인수로 전달합니다. Apigee는 런타임 시 flowval 흐름 변수를 확인하고 해당 값을 사용합니다. 확인된 flowval 값이 잘못된 경우 예외가 보고됩니다.

<Value> 요소는 다음 구문을 사용합니다.

구문
<ParameterArray name="ARRAY_NAME" type="ARRAY_DATATYPE" ref="FLOW_VARIABLE_NAME">
  <Value>PARAMETER_VALUE</Value>
  <Value ref="FLOW_VARIABLE_NAME"/>
  <Value ref="FLOW_VARIABLE_NAME">PARAMETER_VALUE</Value>
</ParameterArray>
예시 1

다음 예시에서는 my_array_param을 1, 2, 3 값이 있는 정수 매개변수 배열로 선언합니다.

<ParameterArray name="my_array_param" type="integer">
  <Value>1</Value>
  <Value>2</Value>
  <Value>3</Value>
</ParameterArray>
예시 2

다음 예시에서는 my_array_param을 flow_var_1 및 flow_var_2 흐름 변수의 값이 있는 문자열 매개변수 배열로 선언합니다.

<ParameterArray name="my_array_param" type="string">
  <Value ref="flow_var_1"/>
  <Value ref="flow_var_2"/>
</ParameterArray>
예시 3

다음 예시에서는 my_array_param을 문자열 매개변수 배열로 선언합니다.

<ParameterArray name="my_array_param" type="string">
   <Value ref="flow_var_1">string_1</Value>
   <Value ref="flow_var_2">string_2</Value>
</ParameterArray>

이 예시에서는 흐름 변수가 성공적으로 확인되면 배열 요소 값이 flow_var_1 흐름 변수의 값으로 설정됩니다. 그러나 flow_var_1이 확인되지 않으면 배열 요소 값이 string_1로 설정됩니다.

예 4

다음 예시에서는 템플릿에서 전달된 흐름 변수 값을 사용하여 template_strArray_param 문자열 배열 매개변수의 값을 설정합니다.

  <Parameters>
    <ParameterArray name="template_strArray_param" type="string">
    <Value>apple $#flow_var_1#$</Value>
    </ParameterArray>
  </Parameters>

이 예시에서는 흐름 변수가 성공적으로 확인되면 배열 요소 값이 flow_var_1 흐름 변수의 값으로 설정됩니다. 그러나 flow_var_1이 확인되지 않으면 Apigee에서 예외가 발생합니다.

다음 표는 <Value>의 속성을 설명합니다.

속성 필수 여부 유형 설명
ref 선택사항 문자열 Apigee가 매개변수 값을 읽어야 하는 흐름 변수를 지정합니다. Apigee는 다음 기준을 사용하여 매개변수 값을 설정합니다.
  • 흐름 변수가 런타임에서 확인되고 유효하면 Apigee는 흐름 변수의 값을 사용합니다.
  • 런타임에서 흐름 변수가 확인되지만 유효하지 않으면 Apigee가 예외를 보고합니다.
  • 런타임 시 흐름 변수가 확인되지 않으면 Apigee는 <Value> 요소의 값을 사용합니다. 요소 값이 유효하지 않으면 Apigee가 오류를 보고합니다.

<Request>

요청 저장을 위한 흐름 변수 이름을 지정합니다.

정책이 실행되면 새 요청 메시지 객체를 만들고 요청을 읽도록 쿼리할 수 있는 FLOW_VARIABLE_NAME 변수에 객체를 저장합니다.

흐름 변수 이름을 지정하지 않으면 정책은 요청을 요청 메시지에 저장하고 기존 요청 메시지가 있으면 재정의합니다.

기본값 요청
필수 여부 선택사항
유형 문자열
상위 요소 <SetIntegrationRequest>
하위 요소 없음

<Request> 요소는 다음 구문을 사용합니다.

구문

<Request>FLOW_VARIABLE_NAME</Request>

예

다음 예시에서는 요청 객체를 my_request_var 흐름 변수에 저장합니다.

<Request>my_request_var</Request>

오류 코드

이 섹션에서는 오류 코드, 오류 메시지, 이 정책이 오류를 트리거할 때 Apigee에서 설정한 오류 변수를 설명합니다. 오류를 처리하기 위해 오류 규칙을 개발하는 경우 이 정보가 필요합니다. 자세한 내용은 정책 오류에 대해 알아야 할 사항 및 오류 처리를 참조하세요.

런타임 오류

이러한 오류는 정책이 실행될 때 발생할 수 있습니다.

오류 코드 HTTP 상태 원인
steps.setintegrationrequest.EmptyParameterArray 500

이 오류는 <ParameterArray> 요소에 name 및 type 속성이 있지만 ref 속성 또는 <Value> 요소가 없을 때 발생합니다.

steps.setintegrationrequest.EmptyParameterArrayValue 500

이 오류는 <Value> 요소가 비어 있고 ref 속성이 설정되지 않았을 때 발생합니다.

steps.setintegrationrequest.InvalidResolvedFlowVariable 500

이 오류는 요소의 ref 속성에 지정된 흐름 변수가 유효한 값으로 확인되지 않을 때 발생합니다.

  • ProjectId, IntegrationName, ApiTrigger 요소이 경우 흐름 변수가 널, 빈 문자열, 잘못된 데이터 유형으로 확인될 때 이 오류가 발생합니다.

    이러한 요소에 유효한 값은 다음과 같습니다.

    • ProjectId: 시작하기 전에 섹션에서 Project ID의 이름 지정 요구사항을 참조하세요.
    • IntegrationName: IntegrationName 요소의 이름 지정 요구사항을 참조하세요.
    • ApiTrigger: 이름이 api_trigger/로 시작해야 합니다.
  • ParameterArray 요소의 경우 흐름 변수가 빈 문자열로 확인될 때 이 오류가 발생합니다.
steps.setintegrationrequest.MismatchedTypeAndResolvedRef 500

이 오류는 <Parameter> 요소의 ref 속성에 지정된 흐름 변수가 확인되지만 흐름 변수 값의 데이터 유형이 type 속성에 지정된 데이터 유형과 일치하지 않을 때 발생합니다.

steps.setintegrationrequest.MismatchedTypeAndResolvedRefOfParameterArray 500

이 오류는 <ParameterArray> 요소의 ref 속성에 지정된 흐름 변수가 확인되지만 흐름 변수 값의 데이터 유형이 type 속성에 지정된 데이터 유형과 일치하지 않을 때 발생합니다.

steps.setintegrationrequest.MismatchedTypeAndResolvedRefOfParameterArrayValue 500

이 오류는 <Value> 요소의 ref 속성에 지정된 흐름 변수가 확인되지만 흐름 변수 값의 데이터 유형이 상위 요소(<ParameterArray>)의 type 속성에 지정된 데이터 유형과 일치하지 않을 때 발생합니다.

steps.setintegrationrequest.RequestVariableNotMessageType 500 이 오류는 Request 요소로 지정된 흐름 변수가 메시지 유형이 아닌 경우에 발생합니다.
steps.setintegrationrequest.RequestVariableNotRequestMessageType 500 이 오류는 Request 요소로 지정된 흐름 변수가 요청 메시지 유형이 아닌 경우에 발생합니다.
steps.setintegrationrequest.UnresolvedVariable 500

이 오류는 Apigee가 <Parameter>, <ParameterArray>, <Value> 요소에 지정된 흐름 변수를 확인할 수 없을 때 발생합니다.

오류 변수

정책에 실행 오류가 발생할 때마다 Apigee는 오류 메시지를 생성합니다. 오류 응답에서 이러한 오류 메시지를 볼 수 있습니다. 시스템에서 생성된 오류 메시지가 제품의 컨텍스트와 관련이 없을 경우가 많습니다. 메시지를 보다 의미 있게 만들기 위해 오류 유형에 따라 오류 메시지를 맞춤설정할 수 있습니다.

오류 메시지를 맞춤설정하려면 오류 규칙 또는 RaiseFault 정책을 사용하면 됩니다. 오류 규칙과 RaiseFault 정책의 차이점에 대한 자세한 내용은 FaultRules와 RaiseFault 정책 비교를 참조하세요. 오류 규칙과 RaiseFault 정책 모두에서 Condition 요소를 사용하여 조건을 확인해야 합니다. Apigee는 각 정책에 고유한 오류 변수를 제공하며 정책이 런타임 오류를 트리거할 때 오류 변수 값이 설정됩니다. 이러한 변수를 사용하여 특정 오류 조건을 확인하고 적절한 조치를 취할 수 있습니다. 오류 조건 확인에 대한 자세한 내용은 빌드 조건을 참조하세요.

다음 표에서는 이 정책과 관련된 오류 변수를 설명합니다.

변수 장소 예
fault.name fault.name은 런타임 오류 표에 나열된 오류 중 하나와 일치할 수 있습니다. 오류 이름은 오류 코드의 마지막 부분입니다. fault.name Matches "UnresolvedVariable"
SetIntegrationRequest.POLICY_NAME.failed POLICY_NAME은 오류를 발생시킨 정책의 사용자 지정 이름입니다. SetIntegrationRequest.set-integration-request-1.failed = true
정책 오류에 대한 자세한 내용은 정책 오류에 대해 알아야 할 사항을 참조하세요.

관련 주제

Application Integration 기능에 대한 자세한 내용은 Application Integration 개요를 참조하세요.