19장. 방법 지정 및 사용량 세부 정보 캡처를 위한 지표 추가

애플리케이션 계획은 API에 대한 소비자 액세스에 대한 제한 및 가격 규칙을 설정합니다. 제한 및 규칙을 적용하려면 API에서 개별 사용 데이터를 수집하거나 지표를 추가하는 지정 방법을 지정합니다. 지정된 각 메서드와 각 사용자 지정 메트릭에 매핑 규칙을 추가합니다. 매핑 규칙은 캡처할 사용 데이터에 대한 세부 정보를 지정합니다.

제품 및 백엔드에 대한 메서드를 지정하거나 지표를 추가할 수 있습니다. 제품의 경우 제품의 경우 제품의 애플리케이션 계획에서 제한 및 가격 규칙을 설정할 수 있습니다. 백엔드의 경우 이를 통해 해당 백엔드를 번들하는 모든 제품에 대해 애플리케이션 계획의 제한 및 가격 규칙을 설정할 수 있습니다.

개별 호출 수를 캡처하는 Designate 메서드입니다. 이렇게 하면 API 사용을 추적하기 위한 세분화가 제공됩니다. 메서드에 대한 트래픽을 보고하면 메서드 및 Hits 지표의 카운터가 자동으로 증가합니다. API 백엔드의 각 엔드포인트 또는 끝점과 HTTP 메서드의 조합에 대해 메서드를 지정할 수 있습니다. API 엔드포인트를 여기에 추가된 메서드에 매핑하는 방법을 알아보려면 메서드 및 메트릭에 매핑 규칙 추가를 참조하십시오.

지표는 제품 및 백엔드 모두에 대해 API의 사용을 추적하는 데 적합합니다. hits 는 각 API에 대해 존재하는 기본 제공 지표입니다. API에 대한 호출 수를 추적합니다. Hits 와 별도로 API 사용을 캡처하려면 다른 단위로 사용량을 보고하는 지표를 정의합니다. 단위는 측정 가능해야 하며 메가바이트, CPU 시간 또는 API에서 반환한 요소 수와 같은 비즈니스 목표에 의미를 적용해야 합니다. Hits 이외의 지표(예: CPU 시간 또는 mb )는 기본적으로 제공되지 않습니다. 사용자가 구성한 외부 서비스에서 호출한 엔드포인트를 사용하여 이러한 지표를 가져옵니다.

메서드 및 지표는 API 패키징을 위한 스캐폴딩입니다. 각 애플리케이션 계획을 사용하면 지정된 방법 및 각 메트릭에 대해 서로 다른 사용 제한 및 가격 규칙을 정의할 수 있습니다. 메트릭 및 메서드에서 보고한 사용량에 대한 자세한 내용은 API 분석을 참조하십시오.

19.1. 제품 및 백엔드에 방법 추가

제품 또는 백엔드에 메서드를 추가하면 개별 사용 세부 정보를 캡처하려는 API에서 메서드를 지정합니다. 애플리케이션 계획에서는 제품 또는 백엔드에 추가하는 각 메서드에 대해 제한을 설정하는 기능을 제공합니다. 메서드 또는 지표를 제품에 추가하는 절차는 백엔드에 메서드 또는 지표를 추가하는 절차와 유사합니다.

절차

  1. [your_product_name] > Integration > Methods & Metrics 또는 [your_backend_name] > Methods & Metrics 로 이동합니다.
  2. New Method(새 메서드 )를 클릭합니다.

  3. name( 이름) 필드에 메서드에 대한 간단한 설명을 입력합니다. 이 이름은 3scale 관리 포털의 여러 섹션에 표시됩니다. 친숙한 이름은 제품에 고유해야 합니다.

    중요

    메서드의 시스템 이름을 변경하거나 삭제하는 데 주의하십시오. 이러한 변경 사항은 이전 시스템 이름을 가리키는 매핑 규칙이 있는 경우 이미 배포된 3scale 통합이 중단될 수 있습니다.

  4. 시스템 이름 필드에 3scale Service Management API를 통해 사용량을 보고하는 데 사용할 API의 메서드 이름을 입력합니다.

    시스템 이름의 형식을 결정합니다. 이 이름은 끝점(/status)과 유사하거나, 예를 들어 메서드 및 경로(GET_/status)를 포함할 수 있습니다. 그러나 시스템 이름은 다음 규칙을 따라야 합니다.

    • 제품 또는 백엔드에서 고유
    • 영숫자 문자, 밑줄 _, 하이픈 - 또는 슬래시 /만 포함합니다.
    • 공백 없음
    • 백엔드 API의 경우 시스템 이름 방법에는 매핑된 백엔드를 식별하는 숫자 문자열이 포함됩니다. 이 백엔드 ID는 수정할 수 없습니다.
  5. 선택 사항: Description (설명) 필드에 메서드에 대한 자세한 설명을 입력합니다.
  6. Create Method(메서드 만들기)를 클릭합니다.

검증 단계

  • 추가된 방법은 애플리케이션 계획에서 사용할 수 있습니다.

다음 단계

  • [your _product_name] > 애플리케이션 > 애플리케이션 계획 > [plan_you_want_to_edit] 로 이동하여 각 방법에 대한 제한 및 가격 규칙을 편집합니다.