배포 관리

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

이 문서에서는 API 배포를 만들고 관리하는 방법을 설명합니다. API 배포 소개도 참조하세요. 배포 항목을 만든 후 하나 이상의 API 버전에 연결할 수 있습니다.

배포 만들기

배포 항목은 콘솔이나 REST API를 사용하여 만들 수 있습니다.

Console

새 배포를 만들려면 다음 안내를 따르세요.

Google Cloud 콘솔에서 API 허브 페이지로 이동합니다.
API 허브로 이동
API를 클릭합니다.
필터를 사용하여 API 목록을 필터링할 키워드를 지정합니다. 필요한 경우 검색을 사용하여 API를 찾습니다.
API를 클릭하여 세부정보를 확인합니다.
배포 탭에서 배포 추가를 클릭합니다.
배포 만들기 양식에 배포 세부정보를 지정합니다.
- 배포 ID: 원하는 경우 고유 ID 지정을 클릭하여 배포의 고유 ID를 제공합니다. ID를 생략하면 API 허브에서 자동으로 생성합니다. ID는 4~500자(영문 기준)여야 하며 유효한 문자는 /[A-Z][a-z][0-9]-/.입니다.
- 배포 이름: (필수) 배포의 표시 이름을 제공합니다.
- 설명: 배포에 대한 설명을 입력합니다.
- 배포 유형: 배포 유형을 선택합니다. 가능한 값은 시스템 속성에 정의되어 있으며 속성 관리에서 수정할 수 있습니다.
- 리소스 URI: (필수) 런타임 리소스에 URI를 제공합니다. 이 URI는 리소스를 관리하는 데 사용할 수 있습니다. 예를 들어 런타임 리소스가 Apigee API 프록시인 경우 이 필드에 프록시의 관리 사용자 인터페이스에 대한 URI가 포함되어야 합니다.
- 환경: 이 배포에 매핑된 환경입니다. 환경은 시스템 정의 환경 속성에 매핑됩니다.
- 문서: 배포에 대한 문서 링크를 입력합니다.
- SLO: 이 배포의 SLO를 제공합니다. 이는 SLO 시스템 정의 속성에 매핑됩니다. 속성 관리에서 이 속성 값을 수정할 수 있습니다.
- 엔드포인트: (필수) 이 배포 리소스가 API 요청을 리슨하는 엔드포인트를 제공합니다. 전체 URI, 호스트 이름 또는 IP 주소 목록일 수 있습니다.
- 버전에 연결: 배포를 하나 이상의 API 버전에 연결합니다.
- 사용자 정의 속성: 사용자 정의 키-값 쌍입니다. 속성 관리에서 사용자 정의 속성을 추가할 수 있습니다.
만들기를 클릭합니다.

REST

배포 만들기 API를 사용하여 새 배포를 추가하려면 다음 안내를 따르세요.

curl "https://apihub.googleapis.com/v1/projects/HUB_PROJECT/locations/HUB_LOCATION/deployments?deployment_id=DEPLOYMENT_ID"
  -H "Authorization: Bearer: $(gcloud auth print-access-token)" -X POST -H "Content-Type: application/json" \
  '{
    "display-name": DISPLAY_NAME
    }'

다음을 바꿉니다.

HUB_PROJECT: API 허브 호스트 프로젝트의 이름. 이 호스트 프로젝트는 API 허브가 프로비저닝되었을 때 선택되었습니다.
HUB_LOCATION: 호스트 프로젝트의 위치. 이 위치는 API 허브가 프로비저닝되었을 때 선택되었습니다.
DEPLOYMENT_ID: (선택사항) 배포 식별자입니다. 제공하지 않으면 시스템에서 생성된 ID가 사용됩니다. 이름은 4~500자(영문 기준)의 문자열이어야 하며 유효한 문자는 /[a-z][A-Z][0-9]-_/.입니다.
DISPLAY_NAME: (필수) 배포의 표시 이름입니다. 원하는 모든 이름을 사용할 수 있습니다.
선택적 속성: 필수 표시 이름 외에도 선택적인 속성 및 항목을 배포에 연결할 수 있습니다. 이러한 추가 항목은 REST API 참조의 배포 리소스 설명에 설명되어 있습니다.

API 버전에 배포 연결

버전에 하나 이상의 배포가 연결될 수 있습니다. 이 섹션에서는 배포를 버전에 연결하는 방법을 설명합니다. 버전을 만들 때 특정 버전에 배포를 연결하거나, 기존 버전을 수정하여 배포를 연결할 수 있습니다. API 버전 만들기 및 버전 수정을 참조하세요.

배포를 새 버전이나 기존 버전에 연결하려면 배포가 이미 존재해야 합니다. 배포 만들기를 참조하세요.

Console

버전에 배포를 추가하려면 다음 안내를 따르세요.

Google Cloud 콘솔에서 API 허브 페이지로 이동합니다.
API 허브로 이동
API를 클릭합니다.
필터를 사용하여 API 목록을 필터링할 키워드를 지정합니다. 필요한 경우 검색을 사용하여 API를 찾습니다.
API를 선택합니다.
버전 표에서 수정할 버전을 찾습니다.
버전 행 오른쪽에 있는 작업 메뉴에서 수정을 선택하거나 버전을 선택하고 세부정보 페이지에서 버전 수정을 클릭합니다.
배포에 연결에서 버전에 연결할 배포를 하나 이상 선택하고 확인을 클릭합니다.
저장을 클릭합니다.

REST

버전에 배포를 추가하는 예시:

curl "https://apihub.googleapis.com/v1/projects/HUB_PROJECT/locations/HUB_LOCATION/apis/API_NAME/versions/VERSION_ID"
  -H "Authorization: Bearer: $(gcloud auth print-access-token)" -X PATCH -H "Content-Type: application/json" \
  '{
    "deployments": "DEPLOYMENTS"
  }'

다음을 바꿉니다.

HUB_PROJECT: API 허브 호스트 프로젝트의 이름입니다. 이 호스트 프로젝트는 API 허브가 프로비저닝되었을 때 선택되었습니다.
HUB_LOCATION: 호스트 프로젝트의 위치입니다. 이 위치는 API 허브가 프로비저닝되었을 때 선택되었습니다.
API_NAME: 수정할 버전이 있는 API의 이름입니다.
VERSION_ID: 수정할 버전의 고유 ID입니다.
DEPLOYMENTS: 하나 이상의 배포에 대한 정규화된 리소스 이름입니다. 예를 들면 다음과 같습니다. "projects/myproject/locations/us-central1/deployments/mydeployment-1, projects/myproject/locations/us-central1/deployments/mydeployment-2"

배포 나열

이 섹션에서는 배포를 나열하는 방법을 설명합니다. API의 모든 버전과 관련된 모든 배포를 나열하거나 특정 버전과 관련된 모든 배포를 나열할 수 있습니다.

Console

UI를 사용하여 배포를 나열하려면 다음 안내를 따르세요.

Google Cloud 콘솔에서 API 허브 페이지로 이동합니다.
API 허브로 이동
API를 클릭합니다.
필터를 사용하여 API 목록을 필터링할 키워드를 지정합니다. 필요한 경우 검색을 사용하여 API를 찾습니다.
API를 클릭하여 세부정보를 확인합니다.
배포 탭을 선택하여 API와 연관된 모든 배포를 나열합니다.
해당 버전과 연결된 배포를 보려면 버전 탭에서 버전을 선택합니다.

REST

모든 배포를 나열하려면 배포 나열 API를 사용합니다.

curl "https://apihub.googleapis.com/v1/projects/HUB_PROJECT/locations/HUB_LOCATION/deployments"
        -H "Authorization: Bearer: $(gcloud auth print-access-token)" -X GET -H "Content-Type: application/json"

다음을 바꿉니다.

HUB_PROJECT: API 허브 호스트 프로젝트의 이름입니다. 이 호스트 프로젝트는 API 허브가 프로비저닝되었을 때 선택되었습니다.
HUB_LOCATION: 호스트 프로젝트의 위치입니다. 이 위치는 API 허브가 프로비저닝되었을 때 선택되었습니다.

배포 세부정보 가져오기

이 섹션에서는 API 배포에 대한 세부정보를 가져오는 방법을 설명합니다.

Console

배포 세부정보를 보려면 다음 안내를 따르세요.

Google Cloud 콘솔에서 API 허브 페이지로 이동합니다.
API 허브로 이동
API를 클릭합니다.
필터를 사용하여 API 목록을 필터링할 키워드를 지정합니다. 필요한 경우 검색을 사용하여 API를 찾습니다.
API를 클릭하여 세부정보를 확인합니다.
배포 탭을 선택하여 API와 연관된 모든 배포를 나열합니다.
배포를 선택하여 세부정보 페이지를 봅니다.

REST

배포 세부정보를 보려면 배포 세부정보 가져오기 API를 사용합니다.

curl "https://apihub.googleapis.com/v1/projects/HUB_PROJECT/locations/HUB_LOCATION/deployments/DEPLOYMENT_ID"
    -H "Authorization: Bearer: $(gcloud auth print-access-token)" -X GET -H "Content-Type: application/json"

다음을 바꿉니다.

HUB_PROJECT: API 허브 호스트 프로젝트의 이름입니다. 이 호스트 프로젝트는 API 허브가 프로비저닝되었을 때 선택되었습니다.
HUB_LOCATION: 호스트 프로젝트의 위치입니다. 이 위치는 API 허브가 프로비저닝되었을 때 선택되었습니다.
DEPLOYMENT_ID: 배포의 고유 ID입니다.

API에서 API 배포 삭제

이 섹션에서는 API 배포를 삭제하는 방법을 설명합니다. API에서 API 배포를 삭제하면 먼저 모든 API 버전에서 연결이 해제된 후 API에서 삭제됩니다. 배포가 삭제되면 더 이상 배포 목록에 표시되지 않으며 삭제된 배포를 기반으로 API를 필터링할 수 없습니다.

콘솔

UI를 사용하여 배포를 삭제하려면 다음 안내를 따르세요.

Google Cloud 콘솔에서 API 허브 페이지로 이동합니다.
API 허브로 이동
API를 클릭합니다.
필터를 사용하여 API 목록을 필터링할 키워드를 지정합니다. 필요한 경우 검색을 사용하여 API를 찾습니다.
API를 클릭하여 세부정보를 확인합니다.
배포 탭을 선택하여 API와 연관된 모든 배포를 나열합니다.
삭제하려는 배포를 찾습니다.
배포의 작업 메뉴에서 삭제를 선택합니다.

REST

API 허브에서 배포를 삭제하려면 배포 삭제 API를 사용합니다.

curl "https://apihub.googleapis.com/v1/projects/HUB_PROJECT/locations/HUB_LOCATION/deployments/DEPLOYMENT_ID"
    -H "Authorization: Bearer: $(gcloud auth print-access-token)" -X DELETE -H "Content-Type: application/json"

다음을 바꿉니다.

HUB_PROJECT: API 허브 호스트 프로젝트의 이름입니다. 이 호스트 프로젝트는 API 허브가 프로비저닝되었을 때 선택되었습니다.
HUB_LOCATION: 호스트 프로젝트의 위치입니다. 이 위치는 API 허브가 프로비저닝되었을 때 선택되었습니다.
DEPLOYMENT_ID: 삭제할 배포의 고유 ID입니다.

API 또는 버전에서 API 배포 연결 해제

이 섹션에서는 API 또는 버전에서 API 배포의 연결을 해제하는 방법을 설명합니다. API에서 배포를 연결 해제하면 모든 버전의 API에서 배포가 연결 해제됩니다. 연결을 해제하면 배포가 더 이상 배포 목록에 표시되지 않습니다.

콘솔

UI를 사용하여 API에서 배포의 연결을 해제하려면 다음 안내를 따르세요.

Google Cloud 콘솔에서 API 허브 페이지로 이동합니다.
API 허브로 이동
API를 클릭합니다.
필터를 사용하여 API 목록을 필터링할 키워드를 지정합니다. 필요한 경우 검색을 사용하여 API를 찾습니다.
API를 클릭하여 세부정보를 확인합니다.
배포 탭을 선택하여 API와 연관된 모든 배포를 나열합니다.
연결 해제하려는 배포를 찾습니다.
배포의 작업 메뉴에서 API에서 연결 해제를 선택합니다.

UI를 사용하여 버전에서 배포를 연결 해제하려면 다음 단계를 따르세요.

Google Cloud 콘솔에서 API 허브 페이지로 이동합니다.
API 허브로 이동
API를 클릭합니다.
필터를 사용하여 API 목록을 필터링할 키워드를 지정합니다. 필요한 경우 검색을 사용하여 API를 찾습니다.
API를 클릭하여 세부정보를 봅니다.
버전을 선택합니다.
배포 섹션에서 연결을 해제하려는 배포를 찾습니다.
배포의 작업 메뉴에서 버전에서 연결 해제를 선택합니다.

REST

API 허브에서 API 리소스를 삭제하려면 배포 삭제 API를 사용합니다.

curl "https://apihub.googleapis.com/v1/projects/HUB_PROJECT/locations/HUB_LOCATION/deployments/DEPLOYMENT_ID"
    -H "Authorization: Bearer: $(gcloud auth print-access-token)" -X DELETE -H "Content-Type: application/json"

다음을 바꿉니다.

HUB_PROJECT: API 허브 호스트 프로젝트의 이름입니다. 이 호스트 프로젝트는 API 허브가 프로비저닝되었을 때 선택되었습니다.
HUB_LOCATION: 호스트 프로젝트의 위치입니다. 이 위치는 API 허브가 프로비저닝되었을 때 선택되었습니다.
DEPLOYMENT_ID: 삭제할 배포의 고유 ID입니다.

배포 수정

이 섹션에서는 배포를 수정하는 방법을 설명합니다.

Console

Google Cloud 콘솔에서 API 허브 페이지로 이동합니다.
API 허브로 이동
API를 클릭합니다.
필터를 사용하여 API 목록을 필터링할 키워드를 지정합니다. 필요한 경우 검색을 사용하여 API를 찾습니다.
API를 클릭하여 세부정보를 확인합니다.
배포 탭을 선택하여 API와 연관된 모든 배포를 나열합니다.
수정하려는 배포를 찾습니다.
배포의 작업 메뉴에서 수정을 선택하거나 배포를 클릭한 다음 배포 세부정보 패널에서 배포 수정을 클릭합니다.

REST

배포를 수정하려면 패치 배포 API를 사용합니다.

curl "https://apihub.googleapis.com/v1/projects/HUB_PROJECT/locations/HUB_LOCATION/deployments/DEPLOYMENT_ID"
      -H "Authorization: Bearer: $(gcloud auth print-access-token)" -X PATCH -H "Content-Type: application/json"
      '{
        DEPLOYMENT_ATTRIBUTES
      {'

다음을 바꿉니다.

HUB_PROJECT: API 허브 호스트 프로젝트의 이름입니다. 이 호스트 프로젝트는 API 허브가 프로비저닝되었을 때 선택되었습니다.
HUB_LOCATION: 호스트 프로젝트의 위치입니다. 이 위치는 API 허브가 프로비저닝되었을 때 선택되었습니다.
DEPLOYMENT_ID: 수정할 배포의 고유 ID입니다.
DEPLOYMENT_ATTRIBUTES: 요청 본문에서 수정할 속성을 연결합니다. 수정 가능한 속성은 REST API 참조의 배포 리소스 설명에 설명되어 있습니다.