통합 상태 및 설정 확인

Apigee Edge 문서를 보고 있습니다.
Apigee X 문서로 이동하세요. info

이 페이지에서는 Apigee Edge 조직에서 Apigee Edge API 허브 커넥터 통합을 사용 설정한 후 상태와 설정을 확인하는 방법을 설명합니다.

API 허브 커넥터 통합 설정 확인

조직의 API 허브 커넥터 통합 설정을 가져오려면 GET 요청을 실행하여 다음 요청을 전송합니다.

curl -X GET https://api.enterprise.apigee.com/v1/organizations/ORG_NAME/uapim/settings -H "Authorization: Bearer OAUTH_TOKEN"

각 항목의 의미는 다음과 같습니다.

  • ORG_NAME은 Apigee Edge 조직의 이름입니다.
  • OAUTH_TOKEN은 요청을 인증하는 데 사용되는 OAuth 토큰입니다. OAuth 토큰 생성에 관한 자세한 내용은 토큰 가져오기를 참고하세요.

성공적인 응답은 다음과 유사하게 표시됩니다.

  {
    "enabled": true,
    "gatewayId": "my-gateway-id"
  }

"enabled": true는 조직에 API 허브 커넥터 통합이 활성화되어 있음을 확인합니다.

"gatewayId"에는 이 Apigee Edge 조직이 연결된 인스턴스 리소스 이름이 표시됩니다.

통합 상태 확인

세부 업로드 진행 상황이 포함된 통합 상태의 경우 Edge 관리 API에 GET 요청을 실행합니다.

curl -X GET https://api.enterprise.apigee.com/v1/organizations/ORG_NAME/uapim/status
  -H "Authorization: Bearer OAUTH_TOKEN

각 항목의 의미는 다음과 같습니다.

  • ORG_NAME은 Apigee Edge 조직의 이름입니다.

성공적인 통합 응답은 다음과 유사하게 표시되며 프록시 및 환경의 업로드 진행 상황을 보여줍니다. 아래 예에서는 Queued 단계를 보여줍니다.

{
  "phase": "Preparing",
  "lastUpdated": "2025-09-15T02:23:50.706Z",
  "components": {
    "proxy": {
      "lastUpdated": "2025-09-15T02:23:50.706Z",
      "progress": {
        "totalItems": 10,
        "pendingItems": 1,
        "completedItems": 9,
        "failedItems": 0
      }
    },
    "environment": {
      "lastUpdated": "2025-09-15T02:23:50.706Z",
      "progress": {
        "totalItems": 5,
        "pendingItems": 0,
        "completedItems": 4,
        "failedItems": 1
      }
    }
  }
}

통합 상태 필드

필드 설명
phase 조직의 현재 처리 단계입니다. 가능한 값은 다음과 같습니다.
  • Queued: 조직이 최근에 추가되었으며 초기 처리를 위해 대기열에 추가되었습니다.
  • Preparing: 조직이 콜드 전송 상태에 있으며 모든 기존 프록시가 API 허브에 업로드되고 있습니다. 이 상태는 조직이 최근에 추가되어 준비 중일 때 발생합니다.
  • Processing: 프록시 및 환경의 변경사항이 API 허브에 지속적으로 업로드되는 지속적인 업데이트 상태에 있습니다.
lastUpdated 이 조직에 대해 처리된 마지막 이벤트의 타임스탬프입니다.
components 처리된 프록시 및 환경에 관한 세부정보를 제공하는 지도입니다. 맵에는 다음 키가 포함될 수 있습니다.
  • proxy: Edge 시스템에서 처리되어 API 허브에 업로드된 API 프록시의 세부 개수를 제공합니다.
  • environment: 처리되어 API 허브에 업로드된 Edge 시스템의 환경에 관한 자세한 개수를 제공합니다.
progress proxy 또는 environment 섹션의 값은 다음과 같습니다.
  • totalItems: 총 항목 수입니다.
  • pendingItems: 처리 대기 중인 항목 수입니다.
  • completedItems: 성공적으로 완료된 항목의 수입니다.
  • failedItems: 업로드 중에 실패한 항목의 수입니다.

자세한 업로드 상태 확인

/details 엔드포인트와 쿼리 매개변수를 사용하여 개별 API 프록시 또는 환경의 세부 상태나 상태별로 필터링된 항목 그룹을 확인할 수 있습니다.

특정 항목의 상태

특정 항목의 세부 상태를 확인하려면 filter 및 name 쿼리 매개변수를 사용합니다. 조직 acme의 API 프록시 이름이 myproxy인 경우 다음과 같이 상태 API를 호출합니다.

curl -X GET https://api.enterprise.apigee.com/v1/organizations/acme/uapim/status/details?filter=proxy&name=myproxy \
  -H "Authorization: Bearer OAUTH_TOKEN"

조직 acme의 환경 이름이 myenv인 경우 다음과 같이 상태 API를 호출합니다.

GET http://enterprise.apigee.com/organizations/acme/uapim/status/details?filter=environment&name=myenv

위 API를 호출하면 최근에 업로드된 프록시에 대해 다음과 유사한 JSON 출력이 생성됩니다.

{
  "name": "myProxy",
  "status": "Pending Upload",
  "lastSuccessfulUploadTime": "2025-09-15T02:23:50.706Z",
}

버전 정보가 포함된 상세 상태

추가 쿼리 매개변수 showRevisions=true를 제공하여 특정 프록시의 개별 프록시 수정사항에 관한 정보를 가져올 수 있습니다. 여기에서 생성된 출력은 특정 프록시에 업로드된 각 버전에 관한 세부정보를 제공합니다.

GET http://enterprise.apigee.com/organizations/acme/uapim/status/details?filter=proxy&name=myproxy&showRevisions=true

showrevisions 매개변수를 사용하여 위의 API를 호출하면 다음과 유사한 JSON 출력이 생성됩니다.

{
  "name": "myProxy",
  "status": "Pending Upload",
  "lastSuccessfulUploadTime": "2025-09-15T02:23:50.706Z",
  "revisions": [
    {
      "name": "1",
      "status": "Up to date",
      "lastSuccessfulUploadTime": "2025-09-15T02:23:50.706Z",
    },  
    {
      "name": "2",
      "status": "Pending upload",
      "lastSuccessfulUploadTime": "2025-09-15T02:23:55.000Z",
    }  
  ]
}

그룹 업로드 상태

state 쿼리 매개변수와 함께 그룹 필터를 사용하여 항목 그룹의 업로드 상태를 확인할 수 있습니다.

조직 acme에서 failed 상태인 모든 API 프록시의 상태를 확인하려면 다음과 같이 상태 API를 호출합니다.

GET http://enterprise.apigee.com/organizations/acme/uapim/status/details?filter=proxy&state=failed

마찬가지로 조직 acme에서 업로드를 대기 중인 모든 환경의 세부 목록을 가져오려면 다음과 같이 상태 API를 호출합니다.

GET http://enterprise.apigee.com/organizations/acme/uapim/status/details?filter=environment&state=pending

이 API를 호출한 결과는 필터와 일치하는 개별 상태 항목의 JSON 컬렉션입니다. 예:

[
  {
    "name": "myProxy",
    "status": "last upload failed",
    "lastSuccessfulUploadTime": "2025-09-12T02:23:50.706Z",
    "lastFailedUploadTime": "2025-09-13T02:23:50.706Z",
    "lastUploadError": "Errors connecting to API Hub"
  },
  {
    "name": "secondProxy",
    "status": "last upload failed",
    "lastSuccessfulUploadTime": "2025-09-12T02:23:51.706Z",
    "lastFailedUploadTime": "2025-09-13T02:23:51.706Z",
    "lastUploadError": "Errors connecting to API Hub"
  }
]

자세한 상태의 쿼리 매개변수

API는 세 가지 쿼리 매개변수를 제공합니다. 값은 대소문자를 구분합니다.

쿼리 매개변수 가능한 값 설명
filter proxy, environment 이 쿼리 매개변수는 프록시 또는 환경별로 결과를 필터링해야 함을 나타냅니다.
state failed, pending, all 이 쿼리 매개변수는 filter 외에도 상태별로 결과를 필터링해야 함을 나타냅니다.
name 특정 상품의 이름 이 쿼리 매개변수는 filter 외에 이름으로 결과를 필터링해야 함을 나타냅니다.
showrevisions true, false 이 쿼리 매개변수가 제공되면 출력에 수정 버전 상태가 생성됩니다 (filter=proxy인 경우에만 유효).

세부 상태의 매개변수 조합

아래 표에서는 자세한 상태를 가져오기 위해 REST API에 전달할 수 있는 가능한 매개변수 조합을 설명합니다. NA은 매개변수가 무시됨을 나타냅니다. NULL은 매개변수가 제공되지 않았음을 나타냅니다.

filter 주 이름 결과
proxy all NULL 모든 프록시의 상태 세부정보를 보고합니다.
proxy failed NULL 업로드에 실패한 모든 프록시의 상태 세부정보를 보고합니다.
proxy pending NULL 업로드 또는 재업로드가 대기 중인 모든 프록시의 상태 세부정보를 보고합니다.
proxy NULL myproxy myproxy라는 프록시의 상태 세부정보를 보고합니다.
proxy NON-NULL NON-NULL 오류를 보고합니다.
environment all NULL 모든 환경의 상태 세부정보를 보고합니다.
environment failed NULL 업로드에 실패한 모든 환경의 상태 세부정보를 보고합니다.
environment pending NULL 업로드 또는 재업로드가 대기 중인 모든 환경의 상태 세부정보를 보고합니다.
environment NULL myenv myenv라는 환경의 상태 세부정보를 보고합니다.
environment NON-NULL NON-NULL 오류를 보고합니다.