용어집

Red Hat 3scale API Management 2.12

Red Hat 3scale API Management에서 사용되는 용어에 대해 알아보십시오.

초록

본 가이드는 Red Hat 3scale API Management 2.12와 함께 사용되는 용어에 대해 설명합니다.

보다 포괄적 수용을 위한 오픈 소스 용어 교체

Red Hat은 코드, 문서, 웹 속성에서 문제가 있는 용어를 교체하기 위해 최선을 다하고 있습니다. 먼저 마스터(master), 슬레이브(slave), 블랙리스트(blacklist), 화이트리스트(whitelist) 등 네 가지 용어를 교체하고 있습니다. 이러한 변경 작업은 작업 범위가 크므로 향후 여러 릴리스에 걸쳐 점차 구현할 예정입니다. 자세한 내용은 Red Hat CTO Chris Wright의 메시지를 참조하십시오.

1장. 3scale 용어

이 섹션은 3scale 플랫폼 내에서 사용되는 일반적인 용어의 용어집으로 사용됩니다. 다음은 용어 항목의 구조입니다.

  • 용어집
  • 다음 항목 중 하나 이상 또는 두 항목 모두:

    • 용어의 정의, 선택사항 뒤에 하나 또는 두 개의 설명 문장을 붙이고, See는 관련 용어 또는 용어를 가리키는 용어를 참조합니다. 예제:

적중: 모든 메서드가 보고하는 기본 제공 지표입니다. 적중 횟수를 늘리지 않아야 하는 다른 사용량을 추적하기 위해 추가 최상위 지표를 추가할 수 있습니다. 1.14.4절. “지표” 참조하십시오.

이 경우 hit지표 와 관련이 있습니다. hit는 기본 제공 지표이기 때문입니다.

  • 해당 용어에 대해 선호되는 동의어 또는 축약된 용어의 맞춤법된 버전을 가리키는 See 참조. 예제:

계정: 1.21.1절. “테넌트 계정”, 1.5.2절. “개발자 계정” 을 참조하십시오.

이 경우 리더는 계정에서 한정자를 포함하는 관련 용어로 리디렉션됩니다.

  • 용어에 대한 정의가 두 개 이상 있으면 각 항목에 번호가 지정됩니다.

1.1. 특수 문자

1.1.1. [Your_admin_domain]

사용자가 생성한 admin 도메인.

1.1.2. [Your_API_name]

사용자가 생성한 API. 자세한 내용은 1.2.22절. “애플리케이션 프로그래밍 인터페이스” 참조하십시오.

1.1.3. [Your_API_service]

1.1.2절. “[Your_API_name]”을 참조하십시오.

1.1.4. [Your_product_name]

사용자가 만든 제품. 자세한 내용은 1.17.3절. “제품” 참조하십시오.

1.1.5. 3scale API 문서

Red Hat 3scale API Management의 REST API 문서화를 위한 3scale 사양인 OAS(Open API Specification)를 기반으로 합니다. 1.2.2절. “ActiveDocs”, 1.16.2절. “OpenAPI 사양” 도 참조하십시오.

1.1.6. 3scale 백엔드

3scale API Manager의 일부와 System.

1.2. A

1.2.1. 계정

1.21.1절. “테넌트 계정”, 1.5.2절. “개발자 계정” 을 참조하십시오.

1.2.2. ActiveDocs

사용자가 생성한 REST API를 문서화하기 위한 3scale 사양인 OAS(Open API Specification)를 기반으로 합니다. API에는 개발자가 API를 쉽게 이해하고 설치 없이도 테스트할 수 있는 대화형 문서가 제공됩니다. 1.1.5절. “3scale API 문서”, 1.16.2절. “OpenAPI 사양” 도 참조하십시오.

1.2.3. 액세스 토큰

HTTP Basic Auth를 통해 사용자가 Account Management API, Analytics API 및 Billing API에 대해 인증할 수 있는 개인 토큰. 사용자는 사용자 지정 범위 및 권한으로 여러 액세스 토큰을 생성할 수 있습니다. 1.1.5절. “3scale API 문서”, 1.20.2절. “서비스 토큰” 도 참조하십시오.

1.2.4. 관리 포털

제품 액세스를 관리하고 보호하는 API 프로바이더를 위한 중앙 포털입니다. 이 포털에서 API 프로바이더는 3scale을 사용하여 제품 통합을 구성하고, 애플리케이션 계획을 관리하고, 내부 구성원 및 외부 고객에 대한 액세스 권한을 부여하고, 애플리케이션 키당 트래픽을 제한하고, 개발자 포털을 사용자 지정할 수 있습니다. 1.5.3절. “개발자 포털”, 1.17.3절. “제품” 도 참조하십시오.

1.2.5. 관리 포털

1.2.4절. “관리 포털”을 참조하십시오.

1.2.6. API

1.2.22절. “애플리케이션 프로그래밍 인터페이스”을 참조하십시오.

1.2.7. apisonator

1.1.6절. “3scale 백엔드”을 참조하십시오.

1.2.8. API 백엔드

호스트에 배포된 API 구현. 1.2.22절. “애플리케이션 프로그래밍 인터페이스”, 1.3.1절. “백엔드” 도 참조하십시오.

1.2.9. API 소비자

API 프로바이더가 관리하는 제품 또는 API에 액세스하는 개인, 그룹 또는 회사입니다. 용어는 조직에서 작성한 조직 및 소프트웨어 애플리케이션을 모두 참조하여 API를 사용할 수 있습니다. 지정된 조직에는 API에 액세스하는 애플리케이션이 하나 이상 있을 수 있습니다. 자세한 내용은 1.2.12절. “API 공급자” 참조하십시오.

1.2.10. API 인증 정보

1.2.13절. “API 키”, 1.22.1절. “사용자 키” 을 참조하십시오.

1.2.11. API 끝점

1.2.22절. “애플리케이션 프로그래밍 인터페이스”, 1.14.3절. “method” 을 참조하십시오.

1.2.12. API 공급자

API 및 제품을 소유하고 Red Hat 3scale API Management를 사용하여 액세스 권한을 부여하는 엔터티입니다. API 프로바이더는 조직 내에서 내부적으로 또는 타사 개발자, 파트너 또는 일반 대중에게 외부적으로 API에 액세스할 수 있도록 할 수 있습니다. 하나 이상의 테넌트가 포함될 수 있습니다. 1.2.9절. “API 소비자”, 1.21.1절. “테넌트 계정” 도 참조하십시오.

1.2.13. API 키

특정 API 또는 제품에서 호출을 수행할 수 있는 애플리케이션의 자격 증명 유형입니다. API 키는 특정 유형의 인증 패턴입니다. 자세한 내용은 1.2.22절. “애플리케이션 프로그래밍 인터페이스” 참조하십시오.

1.2.14. API 관리자

1.2.4절. “관리 포털”을 참조하십시오.

1.2.15. API 방법

1.14.3절. “method”을 참조하십시오.

1.2.16. API 제품

1.17.3절. “제품”을 참조하십시오.

1.2.17. APIcast

내부 및 외부 API를 Red Hat 3scale API Management와 통합하는 데 사용되는 NGINX 기반의 API 게이트웨이입니다. APIcast는 API 요청을 처리하는 인터페이스이며 구성에 따라 액세스 제어, 속도 제한, 보안 필터링, 로깅, 라우팅, 캐싱 등을 처리할 수 있습니다. 1.2.22절. “애플리케이션 프로그래밍 인터페이스”, 1.17.3절. “제품” 도 참조하십시오.

1.2.18. APIcast 게이트웨이

1.2.17절. “APIcast”을 참조하십시오.

1.2.19. 앱 식별자

앱 식별자로 작동하는 인증 방법. 자세한 내용은 1.2.20절. “앱 키” 참조하십시오.

1.2.20. 앱 키

app 키를 사용한 인증 방법. 자세한 내용은 1.2.19절. “앱 식별자” 참조하십시오.

1.2.21. 애플리케이션

일부 논리를 수행하도록 개발된 소프트웨어 코드입니다. 일반적으로 애플리케이션은 3scale 시스템 내에서 API에 대한 고유한 자격 증명 집합인 애플리케이션 생성 시 캡처된 API 및 메타 데이터로 전송된 호출의 트래픽 이력을 갖습니다. 애플리케이션은 개발자 계정에 연결됩니다. 1.2.9절. “API 소비자”을 참조하십시오. 1.5.2절. “개발자 계정” 참조하십시오.

1.2.22. 애플리케이션 프로그래밍 인터페이스

  1. 표준 기반 기술을 사용하여 통신 네트워크를 통해 멀리 떨어진 곳에서 호출할 수 있는 소프트웨어 구성 요소의 인터페이스입니다.
  2. 다른 컴퓨터 프로그램에서 사용할 추상화 계층으로 프로그래밍 라이브러리에서 제공하는 프로세스, 함수 및 메서드의 논리적 번들입니다.

1.1.2절. “[Your_API_name]”, 1.2.17절. “APIcast”, 1.2.13절. “API 키”, 1.3.1절. “백엔드”, 1.6.1절. “엔드포인트”, 1.6.2절. “최종 사용자”, 1.14.3절. “method”, 1.17.3절. “제품”, 1.20.1절. “service” 을 참조하십시오.

1.2.23. 인증

API 또는 제품에 대한 액세스를 요청하는 사용자 또는 서버의 ID를 확인하는 프로세스입니다.

1.3. B

1.3.1. 백엔드

  1. 제품로서의 API 컨텍스트에서 하나 이상의 API가 제품에 번들로 포함됨. 1.3.2절. “기본 URL”, 1.17.3절. “제품” 도 참조하십시오.
  2. API로 1.2.8절. “API 백엔드” 도 참조하십시오.
  3. 3scale 구성 요소로 1.1.6절. “3scale 백엔드” 참조하십시오.

1.3.2. 기본 URL

  1. Product로서의 API 컨텍스트에서 백엔드에 정의된 개인 엔드포인트. 1.3.1절. “백엔드”, 1.6.1절. “엔드포인트” 도 참조하십시오.
  2. API 게이트웨이의 통합 설정에 정의된 URL 주소입니다. 이러한 주소는 Staging Public Base URL과 Production Public Base URL입니다.

1.4. C

1.4.1. 클라이언트

1.2.9절. “API 소비자”을 참조하십시오.

1.4.2. CMS

1.5.3절. “개발자 포털”을 참조하십시오.

1.5. D

1.5.1. 더 이상 사용되지 않음

지원되는 기능 또는 지원되는 구성과 같은 엔터티와 관련이 있지만 더 이상 권장되지 않으며 이 항목을 사용하지 않는 것이 좋습니다. 자세한 내용은 1.19.1절. “삭제됨” 참조하십시오.

1.5.2. 개발자 계정

  1. 3scale Hosted에서 API 프로바이더가 볼 수 있는 모든 계정은 개발자 계정입니다.
  2. 3scale 온프레미스의 테넌트 관리 포털에서 계정이 개발자 계정으로 간주됩니다. 1.2.21절. “애플리케이션”, 1.21.1절. “테넌트 계정” 도 참조하십시오.

1.5.3. 개발자 포털

개발자가 API를 등록할 수 있는 사이트입니다. 이 사이트에서 개발자는 서브스크립션을 관리하고, API에 액세스하고, 애플리케이션을 만들고, 대화형 API 문서, 3scale API 문서, API 사용을 확인할 수 있습니다. 자세한 내용은 1.2.4절. “관리 포털” 참조하십시오.

1.5.4. 중단됨

1.19.1절. “삭제됨”을 참조하십시오.

1.6. E

1.6.1. 엔드포인트

통신 채널의 끝. API가 다른 시스템과 상호 작용하면 이 통신의 접점을 엔드포인트로 간주합니다. 1.2.22절. “애플리케이션 프로그래밍 인터페이스”, 1.3.2절. “기본 URL”, 1.14.2절. “매핑 규칙”, 1.14.3절. “method” 을 참조하십시오.

1.6.2. 최종 사용자

하나 이상의 제품 및 API를 호출하는 애플리케이션의 사용자입니다. 1.2.22절. “애플리케이션 프로그래밍 인터페이스”, 1.17.3절. “제품” 도 참조하십시오.

1.7. F

1.7.1. 필드 정의

새 사용자, 애플리케이션 또는 계정이 생성될 때 표시되는 필드입니다.

1.8. G

1.9. H

1.9.1. 적중

모든 메서드가 보고하는 기본 제공 지표입니다. 적중 횟수를 늘리지 않아야 하는 다른 사용량을 추적하기 위해 추가 최상위 지표를 추가할 수 있습니다. 자세한 내용은 1.14.4절. “지표” 참조하십시오.

1.9.2. 호스트 URL

1.3.2절. “기본 URL”을 참조하십시오.

1.10. I

1.10.1. 통합 오류

잘못된 자격 증명, 잘못된 ID, URL 주소 등으로 호출을 수행할 때 3scale에 의해 생성된 오류 메시지. 이러한 메시지는 API를 호출하는 애플리케이션에서 발생하는 오류이거나 API와 3scale의 통합으로 구성 오류가 될 수 있습니다.

1.11. J

1.12. K

1.13. L

1.14. M

1.14.1. 관리 포털

1.2.4절. “관리 포털”을 참조하십시오.

1.14.2. 매핑 규칙

특정 끝점에서 수신되는 호출을 3scale로 생성된 해당 메서드 및 지표에 연결하는 규칙입니다. 사용량 추적, 엔드포인트 액세스 및 제한은 매핑 규칙에 구성된 메서드 및 지표를 기반으로 합니다. 1.6.1절. “엔드포인트”, 1.14.3절. “method”, 1.14.4절. “지표” 도 참조하십시오.

1.14.3. method

API 또는 제품을 통한 GET, POST 또는 DELETE-와 같은 허용되는 상호 작용. 메서드는 3scale에서 제품 및 API의 사용을 추적하는 데 사용됩니다. API의 API 엔드포인트에서 사용할 수 있는 각 HTTP 메서드에 대해 메서드를 추가할 수 있습니다. 기본적으로 3scale에서 메서드 호출은 기본 제공 적중 차트 지표를 트리거합니다. 1.2.22절. “애플리케이션 프로그래밍 인터페이스”, 1.6.1절. “엔드포인트”, 1.14.2절. “매핑 규칙”, 1.14.4절. “지표” 을 참조하십시오.

1.14.4. 지표

API에 대한 특정 호출 추적. 이 추적은 호출을 통합 페이지의 매핑 규칙 섹션에서 하나 이상의 URL 패턴에 매핑하여 수행됩니다. 지표는 누적되며 개별적이지 않습니다. 3scale의 기본 제공 최상위 수준 지표는 Hits입니다. 필요한 경우 추가 최상위 지표를 추가할 수 있으며 이러한 지표는 별도로 고려됩니다. 1.9.1절. “적중”, 1.14.2절. “매핑 규칙”, 1.14.3절. “method” 도 참조하십시오.

1.15. N

1.16. O

1.16.1. OAS

보기 1.16.2절. “OpenAPI 사양”

1.16.2. OpenAPI 사양

사람이 및 컴퓨터 둘 다 소스 코드, 문서 또는 네트워크 트래픽 검사를 통해 액세스하지 않고도 서비스의 기능을 검색하고 이해할 수 있는 RESTful API에 대한 표준 언어와 무관한 인터페이스입니다. 1.1.5절. “3scale API 문서”, 1.2.2절. “ActiveDocs” 도 참조하십시오.

1.17. P

1.17.1. Plan

특정 API 및 엔드포인트에 대한 액세스 권한을 부여하여 트래픽 제한 및 API 사용량 수익화를 위한 접근 방식. 3scale에는 애플리케이션 계획 및 계정 계획과 같이 자체적으로 또는 함께 사용할 수 있는 다양한 유형의 계획이 있습니다.

1.17.2. 잠재적인 업그레이드

트래픽 제한 경고를 트리거하는 개발자 계정. 이러한 개발자 계정은 트래픽 볼륨 측면에서 요구 사항을 충족하는 계획으로 잠재적으로 업그레이드할 수 있습니다.

1.17.3. 제품

하나 이상의 API 백엔드로 구성된 번들입니다. 1.1.4절. “[Your_product_name]”, 1.2.4절. “관리 포털”, 1.2.17절. “APIcast”, 1.2.22절. “애플리케이션 프로그래밍 인터페이스”, 1.3.1절. “백엔드”, 1.6.2절. “최종 사용자” 을 참조하십시오.

1.18. Q

1.19. R

1.19.1. 삭제됨

제품에서 사용할 수 없으며 더 이상 지원되지 않는 기능 또는 지원되는 구성과 같은 엔터티와 관련이 있습니다. 자세한 내용은 1.5.1절. “더 이상 사용되지 않음” 참조하십시오.

1.20. S

1.20.1. service

1.2.22절. “애플리케이션 프로그래밍 인터페이스”을 참조하십시오.

1.20.2. 서비스 토큰

서비스 관리 API 인증에 사용되는 키입니다. 이러한 키는 자동으로 생성되며 서비스별로 고유하며 계정 사용자 간에 공유됩니다. 3scale API 문서 내에서 서비스 토큰 사용. 자세한 내용은 1.2.3절. “액세스 토큰” 참조하십시오.

1.21. T

1.21.1. 테넌트 계정

3scale 온프레미스에서 마스터 관리 포털은 계정을 테넌트 계정으로 간주합니다. 1.2.12절. “API 공급자”, 1.5.2절. “개발자 계정” 도 참조하십시오.

1.22. U

1.22.1. 사용자 키

1.2.20절. “앱 키”을 참조하십시오.

1.23. V

1.24. W

1.25. X

1.26. Y

1.26.1. 도메인

1.1.1절. “[Your_admin_domain]”을 참조하십시오.

1.27. Z