고급 API 작업 개요

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

Apigee의 고급 API 작업(AAPI Ops)은 API가 의도한 대로 계속 작동 및 실행하도록 하는 도구를 제공합니다. AAPI Ops는 지연 시간 또는 오류율의 급증과 같이 이상이라고 하는 API 트래픽의 비정상적인 패턴을 자동으로 감지합니다. 이상은 API 성능 문제의 징후일 수 있습니다. AAPI Ops가 이상을 감지하면 이상 이벤트 대시보드에서 세부정보를 보고 정상적인 API 동작을 복원하기 위한 적절한 조치를 취할 수 있습니다.

AAPI Ops를 통해 다음을 수행할 수 있습니다.

이상 감지: AAPI Ops는 이상 이벤트 대시보드에서 비정상적인 API 이벤트(이상)를 보고합니다.
이상 조사: AAPI Ops가 이상을 감지하면 이슈가 언제 어디에서 어떻게 발생했는지 알 수 있으므로 상황을 신속하게 해결할 수 있습니다.
이상 알림을 만들고 이슈가 발생할 때 Apigee에서 메시지를 보내도록 알림을 설정합니다. 이메일, Slack, PagerDuty, 웹훅 등 여러 채널을 통해 알림을 받을 수 있습니다.

이상에 대한 자세한 내용은 이상 감지 정보를 참조하세요.

AAPI Ops의 필수 역할

AAPI Ops를 사용하려면 다음 역할을 할당해야 합니다.

roles/apigee.readOnlyAdmin
roles/logging.viewer
roles/monitoring.viewer

자세한 내용은 Apigee 역할을 참조하세요.

조직에서 AAPI 작업 사용 설정

AAPI 작업을 사용하려면 조직에서 이를 사용 설정해야 합니다. 이렇게 하려면 먼저 OAuth 2.0 액세스 토큰을 가져옵니다. 그러면 액세스 토큰을 전달하는 API 호출을 사용하여 AAPI 작업을 사용 설정할 수 있습니다.

현재 부가기능 구성 보기

AAPI 작업을 사용 설정하기 전에 다음 API를 호출하여 이미 사용 설정되었는지 확인합니다.

curl "https://apigee.googleapis.com/v1/organizations/YOUR_ORG" \
  -X GET \
  -H "Content-type: application/json" \
  -H "Authorization: Bearer $TOKEN"

여기서 YOUR_ORG는 조직의 이름이고 $TOKEN은 OAuth 액세스 토큰의 환경 변수입니다. 이 API를 호출하면 다음 줄로 시작하는 Apigee 부가기능 섹션이 포함된 조직의 기본 정보가 반환됩니다.

"addonsConfig": {

다음 예시와 같이 이 섹션에 "advancedApiOpsConfig"로 시작하는 항목이 포함되어 있는지 확인합니다.

"advancedApiOpsConfig": {
          "enabled": "true"
      }

이 항목이 있으면 AAPI 작업이 이미 조직에서 사용 설정된 것입니다. 그렇지 않은 경우 다음에 설명된 대로 이를 사용 설정해야 합니다.

AAPI 작업 사용 설정

기본 구성으로 조직에서 AAPI 작업을 사용 설정하려면 다음과 같은 POST 요청을 실행합니다.

curl "https://apigee.googleapis.com/v1/organizations/ORG:setAddons" \
  -X POST \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-type: application/json" \
  -d '{
    "addonsConfig": {
      "advancedApiOpsConfig": {
          "enabled": "true"
      }
      <Current add-ons configuration>
    }
  }'

여기서 <Current add-ons configuration>은 현재 부가기능 구성입니다. 현재 부가기능 구성 보기 호출에 대한 응답에서 현재 부가기능 구성을 확인할 수 있습니다. 예를 들어 현재 부가기능 구성이 다음과 같은 경우

"addonsConfig": {
    "integrationConfig": {
        "enabled":"true"
     },
    "monetizationConfig": {
        "enabled":"true"
     }
  },

AAPI 작업을 사용 설정하는 명령어는 다음과 같습니다.

curl "https://apigee.googleapis.com/v1/organizations/YOUR_ORG:setAddons" \
  -X POST \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-type: application/json" \
  -d '{
    "addonsConfig": {
      "advancedApiOpsConfig": {
          "enabled": "true"
      },
    "integrationConfig": {
          "enabled": "true"
      },
    "monetizationConfig": {
          "enabled": "true"
      }
    }
  }'

요청을 보내면 다음과 같은 응답이 표시됩니다.

{
  "name": "organizations/apigee-docs-d/operations/0718a945-76e0-4393-a456-f9929603b32c",
  "metadata": {
    "@type": "type.googleapis.com/google.cloud.apigee.v1.OperationMetadata",
    "operationType": "UPDATE",
    "targetResourceName": "organizations/apigee-docs-d",
    "state": "IN_PROGRESS"
  }
}

조직에서 AAPI 작업 중지

어떤 이유로든 조직에서 AAPI 작업을 중지해야 하는 경우에는 다음과 같이 POST 요청을 실행하고 요청 본문에 부가기능 구성을 전달하면 됩니다.

curl "https://apigee.googleapis.com/v1/organizations/$ORG:setAddons" \
  -X POST \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-type: application/json" \
  -d '{
    "addonsConfig": {
      "advancedApiOpsConfig`": {
          "enabled": "false"
      }
     <Include current add-ons configuration>
    }
  }'

다음은 작업이 진행 중임을 나타내는 응답 예시를 제공합니다.

{
  "name": "organizations/$ORG/operations/06274ffb-8940-41da-836d-781cba190437",
  "metadata": {
    "@type": "type.googleapis.com/google.cloud.apigee.v1.OperationMetadata",
    "operationType": "UPDATE",
    "targetResourceName": "organizations/$ORG",
    "state": "IN_PROGRESS"
  }
}

자세한 내용은 조직 부가기능 API 구성을 참조하세요.