커스텀 도메인 설정

Cloud Endpoints API의 포털을 만들면 포털은 기본적으로 Google이 소유하고 관리하는 cloud.goog 도메인에서 호스팅됩니다. 포털의 기본 URL은 다음 형식으로 지정됩니다. 여기서 YOUR_PROJECT_ID는 Endpoints 구성이 배포된 Google Cloud 프로젝트입니다.

https://endpointsportal.YOUR_PROJECT_ID.cloud.goog
이 URL은 OpenAPI 문서의 host 필드에 커스텀 도메인(예: example.com 또는 my-api.example.com)을 지정한 경우에도 기본 URL입니다.

API 사용자가 커스텀 도메인을 사용하여 포털에 액세스하도록 하려면 도메인 이름 등록기관에서 Cloud Endpoints 포털 및 DNS 설정을 구성해야 합니다. 포털에 커스텀 도메인을 추가하면 Endpoints 포털에 DNS 레코드 유형과 도메인 이름 등록기관에서 구성해야 하는 기타 정보가 표시됩니다.

이 페이지에서는 커스텀 도메인을 사용하도록 Endpoints 포털을 구성하는 방법을 설명합니다. 각 작업에 대해 작업 완료에 필요한 최소한의 ID 및 액세스 관리 역할이 제공됩니다. IAM 권한에 대한 자세한 내용은 다음을 참조하세요.

기본 요건

이 가이드에서는 다음과 같이 가정합니다.

커스텀 도메인 추가

  1. Google Cloud Console에서 프로젝트의 Endpoints > 개발자 포털 페이지로 이동합니다.

    Cloud Endpoints 포털로 이동

  2. 커스텀 도메인 추가를 클릭합니다.
  3. 루트 도메인 또는 하위 도메인 이름을 입력합니다.
  4. 도메인을 추가하려면 계속을 클릭합니다.

  5. Endpoints 포털에 DNS 레코드 업데이트가 표시됩니다. DNS 레코드 업데이트 섹션에 나열된 모든 레코드에 대해 도메인 이름 등록기관을 사용하여 DNS 레코드를 추가합니다.

    • example.com과 같은 루트 도메인을 입력한 경우 DNS 레코드 업데이트 섹션에 IP 주소와 함께 A 레코드와 AAAA 레코드 목록이 표시됩니다. 예를 들면 다음과 같습니다.

      유형 데이터 별칭
      A 198.51.100.0 -
      A 198.51.100.2 -
      A 198.51.100.4 -
      A 198.51.100.6 -
      AAAA 2001:db8:ffff:32::15 -
      AAAA 2001:db8:ffff:34::15 -
      AAAA 2001:db8:ffff:36::15 -
      AAAA 2001:db8:ffff:38::15 -

      도메인 이름으로 A 및 AAAA 레코드 여러 개를 추가하기 위한 구성 단계 및 용어는 도메인 이름 등록기관에 따라 다릅니다. 확실하지 않은 경우 도메인 이름 등록기관의 문서에서 레코드 세트 또는 여러 응답과 같은 용어를 검색합니다.

    • apidocs.example.com과 같은 하위 도메인을 입력한 경우 DNS 레코드 업데이트 섹션에 CNAME이 표시됩니다. 예를 들면 다음과 같습니다.

      유형 데이터 별칭
      CNAME ghs.googlehosted.com apidocs

  6. 완료를 클릭합니다.

  7. 포털을 방문하려면 커스텀 도메인 링크를 클릭합니다. DNS 레코드 전파에 따라 커스텀 도메인 링크가 작동하기까지 최대 24시간이 걸릴 수 있습니다.

Google은 개발자가 도메인 등록기관을 사용하여 DNS 레코드를 추가한 후에만 SSL 인증서를 프로비저닝합니다. 그 때까지는 http://를 사용하더라도 커스텀 도메인이 포털에서 작동하지 않습니다. 하지만 Endpoints > 개발자 포털 페이지에 표시된 기본 URL을 계속 사용할 수 있습니다.

DNS에 추가할 정보 보기

도메인 이름 등록기관에 추가해야 하는 정보(또는 이미 추가된 정보)를 보려면 다음 단계를 따르세요.

  1. Google Cloud 콘솔에서 Endpoints > 개발자 포털 페이지로 이동합니다.

    Cloud Endpoints 포털로 이동

  2. API를 소유하는 Google Cloud 프로젝트를 선택합니다.
  3. 커스텀 도메인 옆에 있는 DNS 세부정보를 클릭합니다.

커스텀 도메인 삭제

  1. Google Cloud Console에서 프로젝트의 Endpoints > 개발자 포털 페이지로 이동합니다.

    Cloud Endpoints 포털로 이동

  2. 커스텀 도메인의 DNS 세부정보 옆에 있는 삭제 를 클릭합니다.
  3. 확인 대화상자에서 삭제를 클릭합니다.

문제해결

커스텀 도메인을 추가하면 일반 오류가 발생합니다. 원인은 여러 가지일 수 있습니다. 포털의 기본 URL인 endpointsportal.YOUR_PROJECT_ID.cloud.goog가 작동하는지 확인합니다. 기본 URL이 작동하지 않으면 포털을 삭제한 후 Endpoints API에 대한 포털 만들기의 단계를 따라 다시 만듭니다.

커스텀 도메인 추가에 실패했지만, 기본 페이지의 테이블에 계속 표시됩니다. 이는 알려진 문제입니다. 이 문제를 해결하려면 커스텀 도메인을 삭제한 후 다시 추가합니다.

'DNS 세부정보'를 클릭하면 추가할 레코드가 없는 빈 테이블이 표시됩니다. 이 문제는 커스텀 도메인 추가에 실패했지만 테이블에 커스텀 도메인이 계속 표시되면 발생할 수 있습니다. 이 문제를 해결하려면 커스텀 도메인을 삭제한 후 다시 추가합니다.

커스텀 도메인 링크가 작동하지 않습니다. 도메인 등록기관에서 DNS 레코드가 올바르게 추가되었는지 확인해야 합니다. 커스텀 도메인이 작동하기까지 최대 24시간이 걸릴 수 있습니다.

커스텀 도메인을 추가할 수 있는 권한이 없습니다. 최소한 프로젝트에 대한 프로젝트 뷰어 역할과 Endpoints 포털 관리자가 있어야 합니다. 프로젝트에 대한 프로젝트 편집자 역할에도 필수 권한이 있습니다. 자세한 내용은 커스텀 역할 만들기 및 관리를 참조하세요.

내 App Engine 애플리케이션에 사용한 도메인 이름과 동일한 도메인 이름을 다시 사용하고 싶습니다. 도메인 이름은 웹 애플리케이션 하나만 지원할 수 있습니다. App Engine 웹 애플리케이션과 포털에 동일한 도메인 이름을 사용할 수 없습니다. 고유한 도메인 이름을 사용하세요.

다음 단계

다음 사항에 대해 알아보세요.