Apigee 애널리틱스 서비스에서 측정기준의 측정항목을 가져오고 필터링합니다.

현재 Apigee Edge 문서가 표시되고 있습니다.
Apigee X 문서로 이동
정보

API 플랫폼 기본 경로: https://api.enterprise.apigee.com/v1/o/{org_name}

API 리소스 경로: /environments/{env_name}/stats/{dimension_name}

설명: GET 메서드를 사용하여 측정기준의 측정항목을 가져옵니다.

동사: GET
인증: 기본 인증
미디어 유형:
application/json
개요: 보고서는 /stats API 리소스에 GET 요청을 사용하여 생성되며 다음 항목이 함께 제공됩니다.
  • 보고서의 측정기준을 정의하는 선택적 URI 매개변수입니다. Apigee는 측정기준 집합을 정의하고 해당 측정기준에 대한 측정항목 집합을 미리 집계합니다. 측정기준이 정의되지 않은 경우 (즉, URI 매개변수가 비어 있는 경우) 지정된 환경에 있는 모든 API에 관한 보고서가 생성됩니다.
  • 보고서의 측정항목, 기간, 시간 간격, 필터/드릴다운 요소를 정의하는 쿼리 매개변수의 집합입니다.

dimension_name: API 플랫폼 측정항목을 검색해야 하는 항목을 정의하는 URI 매개변수입니다. Apigee는 보고서에 사용할 수 있는 일련의 측정기준을 정의합니다. 지원되는 측정기준은 다음과 같습니다.

  • /stats/apis: API 플랫폼에 있는 조직의 API 프록시
  • /stats/apiproducts: 조직에 정의된 API 제품
  • /stats/apps: API에 요청하는 개발자 앱의 이름
  • /stats/client_ip: API 플랫폼에서 API에 요청하는 앱의 IP 주소입니다.
  • /stats/developer_email: API 플랫폼에서 조직에 등록된 개발자의 이메일 주소
  • /stats/developer_app: API에 요청하는 개발자 앱의 이름
  • /stats/devs:API 플랫폼에서 조직에 등록된 고유한 에지 생성 개발자 ID입니다.
  • /stats/access_token: 앱 최종 사용자의 OAuth 액세스 토큰입니다.
필터링

커스텀 리소스에 필터를 적용할 수 있습니다. 커스텀 리소스는 다음과 같습니다.

기호 작업
in 목록 포함
notin 목록 제외
eq =
ne != 또는
gt >
lt
ge >=
le
샘플 필터
설명 쿼리 구조 필터링
이름이 api1 또는 api2인 API 프록시의 통계입니다. filter=(apiproxy in 'api1','api2')
api1 및 api2를 제외한 모든 API 프록시에 대한 통계 filter=(apiproxy notin 'ap1','api2')
오류가 없는 통계 filter=(iserror eq 0)
오류 메시지가 없거나 API 프록시 이름이 api1 또는 api2인 통계입니다. filter=(iserror eq 1) or (apiproxy in 'api1','api2')
(응답 코드가 201 또는 301인 경우) 또는 (오류가 있음) 또는 (API 프록시 이름이 api1 또는 api2인 경우)인 통계입니다. filter=(responsecode le 201 or responsecode eq 301) and (iserror eq 1) or (apiproxy in 'api1','api2')

샘플 요청:

$ curl -X GET -H "Accept:application/json" \
https://api.enterprise.apigee.com/v1/o/{org_name}/environments/{env_name}/stats/{dimension_name}?"select={metric_name}&timeRange=1/1/2013%2000:00~1/2/2013%2000:00&timeUnit=hour&sortby={metric_name}&sort=DESC&filter=(apiproxy%20in%20'weather','news')" \
-u myname:mypass
쿼리 매개변수:
이름 설명 기본 계정 필수 여부
select 보고서에 대해 집계할 측정항목을 지정합니다. 지원되는 측정항목은 message_count, error_count, total_response_time, max_response_time, min_response_time, data_Exchange_size, end_point_response_time입니다. N/A
timeRange 원하는 간격의 시작 및 종료 시간입니다. 날짜 형식은 MM/DD/YYYY HH:MM입니다. 예: 1/1/2013%2000:00~1/2/2013%2000:00 최대 기간은 6개월입니다. N/A
timeUnit 초, 분, 시간, 일, 주, 월, 분기, 연도, 10년, 세기, 밀레니엄 N/A
정렬비 2개 이상의 선택 값이 지정되면 'sortby'를 사용하여 결과 정렬에 사용되는 선택 항목(message_count, error_count, total_response_time, max_response_time, min_response_time, data_Exchange_size, end_point_response_time)을 지정할 수 있습니다. N/A No
sort 지원되는 정렬 범위는 DESC 또는 ASC입니다. N/A No
최상위 예를 들어 결과에서 '상위 k' 결과를 가져옵니다. 예를 들어 상위 5개 결과 'topk=5'를 반환합니다. N/A No
filter 특정 측정기준 값에서 드릴다운을 사용 설정합니다. N/A No
제한 API에서 반환하는 항목 수의 제한 설정 N/A No
오프셋 결과를 페이지로 나누기를 사용 설정하려면 제한이 있는 오프셋을 사용하세요. 예를 들어 결과 11~20을 표시하려면 제한을 '10'으로 설정하고 오프셋을 '10'으로 설정합니다. N/A No
샘플 응답:
{
  "environments" : [ {
        "dimensions" : [ {
          "metrics" : [ 
                 {
                "name" : "message_count",
                "values" : [ {
                   "timestamp" : 1335241800000,
                   "value" : "1.0"
                 } ]
              } ,
                 {
                 "name" : "error_count",
                 "values" : [ {
                    "timestamp" : 1335241800000,
                    "value" : "0.0"
                   } ]
            } 
              ],
        
               "name" : "api1"
        }, 
            {
          "metrics" : [ 
               {
              "name" : "message_count",
              "values" : [ {
                     "timestamp" : 1335241800000,
                     "value" : "1.0"
                  } ]
             },
                {
                "name" : "error_count",
                "values" : [ {
                      "timestamp" : 1335241800000,
                      "value" : "0.0"
                } ]
            } 
             ],
        
             "name" : "api2"
        } 
          ],
        
         "name" : "test"
      } 
    ],
   "metaData" : {
    }
}
응답 페이로드 요소:
이름 설명
metadata 보고서와 관련된 메타데이터
environments 통계가 수집되는 조직의 환경 (교차 환경 통계 수집에 와일드 카드 * 지원)
metrics 지정된 측정기준에 대해 반환된 값
dimensions 측정을 위해 정의된 측정기준입니다. 이 예에서는 api_name입니다.
metrics 보고서 측정항목