공유 흐름 번들 구성 참조

공유 흐름은 API 프록시와 비슷한 재사용 가능한 기능입니다. API 프록시에 대해 이미 알고 있다면 이 참조의 내용 대부분은 익숙할 것입니다.

공유 흐름을 빌드하는 방법을 알아보려면 재사용 가능한 공유 흐름 주제로 시작하세요.

공유 흐름 번들 구조

공유 흐름 번들은 다음 구성으로 이루어집니다.

기본 구성 기본 구성 설정. 기본 구성을 참고하세요.
정책 Apigee Edge 정책 스키마를 준수하는 XML 형식의 구성 파일입니다. 정책을 참조하세요.
리소스 커스텀 로직을 실행하기 위해 정책에서 참고하는 스크립트, JAR 파일 및 XSLT 파일입니다. 리소스를 참조하세요.
SharedFlows 이 번들에 포함된 공유 흐름 공유 흐름을 참조하세요.

위 표의 구성요소는 다음과 같은 디렉터리 구조의 구성 파일에서 정의됩니다.

공유 흐름 번들의 구성 파일 및 디렉터리 구조

이 섹션에서는 공유 흐름 번들의 구성 파일 및 디렉터리 구조를 설명합니다.

기본 구성

기본 구성 파일은 번들의 루트 디렉터리에 있습니다. 이 이름이 번들의 이름입니다.

/sharedflowbundle/traffic-management-shared.xml

기본 구성은 공유 흐름 번들의 콘텐츠와 번들의 업데이트 기록을 추적하기 위한 정보를 정의합니다.

<SharedFlowBundle revision="2" name="traffic-management-shared">
    <ConfigurationVersion majorVersion="4" minorVersion="0"/>
    <CreatedAt>1478637529218</CreatedAt>
    <CreatedBy>gladys@example.com</CreatedBy>
    <Description>Shared flow to moderate API traffic</Description>
    <DisplayName>traffic-management-shared</DisplayName>
    <LastModifiedAt>1481573374023</LastModifiedAt>
    <LastModifiedBy>gladys@example.com</LastModifiedBy>
    <Policies>
        <Policy>Auth-Flow-Callout</Policy>
        <Policy>Extract-Token</Policy>
        <Policy>Spike-Arrest</Policy>
    </Policies>
    <Resources>
        <Resource>jsc://extract-token.js</Resource>
    </Resources>
    <SharedFlows>
        <SharedFlow>default</SharedFlow>
    </SharedFlows>
</SharedFlowBundle>

기본 구성 속성

이름 설명 기본값 필수 여부
SharedFlowBundle
name 공유 흐름 번들의 이름이며 조직 내에서 고유해야 합니다. 이름에 사용할 수 있는 문자는 A-Za-z0-9_-로 제한됩니다. 해당 없음
revision 공유 흐름 번들 구성의 버전 번호입니다. Apigee Edge는 공유 흐름의 현재 버전을 자동으로 추적하므로 버전 번호를 명시적으로 설정할 필요가 없습니다. 해당 없음 N

기본 구성 요소

이름 설명 기본값 필수 여부
SharedFlowBundle
ConfigurationVersion 이 공유 흐름이 준수하는 공유 흐름 번들 구성 스키마의 버전입니다. 현재 majorVersion 4 및 minorVersion 0만 지원됩니다. 이 설정은 향후에 공유 흐름 번들 형식을 만드는 데 사용될 수 있습니다 4.0 N
CreatedAt, CreatedBy 공유 흐름 번들을 만든 날짜/시간(에포크 시간)을 번들을 만든 사용자의 이메일과 함께 표시됩니다.
Description 공유 흐름의 텍스트 설명입니다. 설명을 입력하면 Edge 관리 UI에 설명이 표시됩니다. 해당 없음 N
DisplayName 사용자 친화적인 이름으로 공유 흐름 구성의 name 속성과 다를 수 있습니다. 해당 없음 N
LastModifiedAt, LastModifiedBy 공유 흐름 번들이 마지막으로 수정된 날짜/시간(에포크 시간)이며 수정한 사용자 이메일과 함께 표시됩니다.
Policies 이 공유 흐름의 /policies 디렉터리에 있는 정책 목록입니다. 일반적으로 Edge 관리 UI를 사용하여 공유 흐름을 만든 경우에만 이 요소가 표시됩니다. 이 요소는 단순히 공유 흐름의 콘텐츠를 볼 수 있도록 설계된 '매니페스트' 설정입니다. 해당 없음 N
Resources 이 공유 흐름의 /resources 디렉터리에 있는 리소스(자바스크립트, Python, 자바, XSLT) 목록입니다. 일반적으로 Edge 관리 UI를 사용하여 공유 흐름을 만든 경우에만 이 요소가 표시됩니다. 이 요소는 단순히 공유 흐름의 콘텐츠를 볼 수 있도록 설계된 '매니페스트' 설정입니다. 해당 없음 N
SharedFlows 이 번들에 포함된 공유 흐름을 지정합니다.

현재 이 요소는 하나의 하위 요소 <SharedFlow>만 지원합니다. 하나의 공유 흐름만 공유 흐름 번들에 추가할 수 있습니다.

해당 없음

공유 흐름

/sharedflowbundle/sharedflows/default.xml

SharedFlow 구성은 흐름 요소를 실행해야 하는 시퀀스를 정의합니다. <SharedFlow> 요소의 <Step> 하위 요소는 각각 정책 호출 등 시퀀스의 일부를 지정합니다.

다음 SharedFlow 구성은 하향식 순서로(관리 콘솔에서는 왼쪽에서 오른쪽으로) 실행할 세 가지 정책을 지정합니다. 급증 저지 정책이 가장 먼저이고 흐름 콜아웃 정책이 마지막입니다.

<SharedFlow name="default">
    <Step>
        <Name>Spike-Arrest</Name>
    </Step>
    <Step>
        <Name>Extract-Token</Name>
    </Step>
    <Step>
        <Name>Auth-Flow-Callout</Name>
    </Step>
</SharedFlow>

공유 흐름 구성 속성

이름 설명 기본값 필수 여부
SharedFlow
name 공유 흐름의 이름은 조직 내에서 고유해야 합니다. 이름에 사용할 수 있는 문자는 A-Za-z0-9_-로 제한됩니다. 해당 없음
revision 공유 흐름 구성의 버전 번호입니다. Apigee Edge는 공유 흐름의 현재 버전을 자동으로 추적하므로 버전 번호를 명시적으로 설정할 필요가 없습니다. 해당 없음 N

공유 흐름 구성 요소

이름 설명 기본값 필수 여부
SharedFlow 공유 흐름의 정책 시퀀스를 정의합니다. 해당 없음
Step 흐름 시퀀스의 단계를 정의합니다. 해당 없음
Name 단계에서 참조하는 항목의 이름을 지정합니다. 이 요소의 값은 정책의 이름 속성 값과 같은 항목의 고유 식별자와 동일해야 합니다. 해당 없음

정책

/sharedflowbundle/policies

API 프록시와 마찬가지로 공유 흐름 번들의 /policies 디렉터리에는 번들의 공유 흐름에 연결할 수 있는 모든 정책에 대한 구성 XML이 포함되어 있습니다. 정책은 요소의 하위 집합을 공유하지만 이 하위 집합은 정책에 맞는 요소로 보강됩니다. 정책을 구성하는 방법에 대한 자세한 내용은 원하는 정책에 대한 주제를 참조하세요. 정책 참조 개요에서도 확인할 수 있습니다.

리소스

/sharedflowbundle/resources

리소스는 정책을 사용하여 공유 흐름에 연결할 수 있는 스크립트, 코드, XSL 변환입니다. 관리 UI의 공유 흐름 편집기에 있는 스크립트 섹션에 표시됩니다.

지원되는 리소스 유형은 리소스 파일을 참고하세요.

Apigee 개발자 포럼에 질문을 게시하세요.