REST Resource: projects.locations.backends.domains

리소스: 도메인

백엔드와 연결된 도메인 이름입니다.

JSON 표현
{
  "name": string,
  "displayName": string,
  "createTime": string,
  "updateTime": string,
  "type": enum (Type),
  "disabled": boolean,
  "serve": {
    object (ServingBehavior)
  },
  "customDomainStatus": {
    object (CustomDomainStatus)
  },
  "reconciling": boolean,
  "deleteTime": string,
  "purgeTime": string,
  "labels": {
    string: string,
    ...
  },
  "annotations": {
    string: string,
    ...
  },
  "uid": string,
  "etag": string
}
필드
name

string

식별자. 도메인의 리소스 이름입니다. 예: /projects/p/locations/l/backends/b/domains/foo.com

displayName

string

선택사항입니다. 사람이 읽을 수 있는 변경 가능한 도메인 이름입니다. 글자 수가 63자(영문 기준)로 제한됩니다. 예: prod domain

createTime

string (Timestamp format)

출력 전용입니다. 도메인이 생성된 시간입니다.

RFC3339 UTC 'Zulu' 형식의 타임스탬프입니다(나노초 단위, 소수점 이하 9자리). 예를 들면 "2014-10-02T15:01:23Z""2014-10-02T15:01:23.045123456Z"입니다.

updateTime

string (Timestamp format)

출력 전용입니다. 도메인이 마지막으로 업데이트된 시간입니다.

RFC3339 UTC 'Zulu' 형식의 타임스탬프입니다(나노초 단위, 소수점 이하 9자리). 예를 들면 "2014-10-02T15:01:23Z""2014-10-02T15:01:23.045123456Z"입니다.

type

enum (Type)

출력 전용입니다. 도메인의 유형입니다.

disabled

boolean

선택사항입니다. 도메인의 사용 중지 여부입니다. 기본값은 false입니다.

serve

object (ServingBehavior)

선택사항입니다. 도메인의 게재 동작입니다. 지정하면 도메인이 백엔드의 라이브 콘텐츠 이외의 콘텐츠를 제공합니다.

customDomainStatus

object (CustomDomainStatus)

출력 전용입니다. CUSTOM 유형 도메인의 상태와 구성을 나타냅니다. 해당 유형의 도메인에만 표시됩니다.

reconciling

boolean

출력 전용입니다. true인 경우 빌드에 진행 중인 LRO가 있음을 나타내는 필드입니다.

deleteTime

string (Timestamp format)

출력 전용입니다. 도메인이 삭제된 시간입니다.

RFC3339 UTC 'Zulu' 형식의 타임스탬프입니다(나노초 단위, 소수점 이하 9자리). 예를 들면 "2014-10-02T15:01:23Z""2014-10-02T15:01:23.045123456Z"입니다.

purgeTime

string (Timestamp format)

출력 전용입니다. 소프트 삭제된 도메인이 영구 삭제되어 렌더링되는 시간입니다.

RFC3339 UTC 'Zulu' 형식의 타임스탬프입니다(나노초 단위, 소수점 이하 9자리). 예를 들면 "2014-10-02T15:01:23Z""2014-10-02T15:01:23.045123456Z"입니다.

labels

map (key: string, value: string)

선택사항입니다. 키-값 쌍으로의 라벨.

"key": value 쌍 목록을 포함하는 객체입니다. 예: { "name": "wrench", "mass": "1.3kg", "count": "3" }

annotations

map (key: string, value: string)

선택사항입니다. 키-값 쌍으로서의 주석

"key": value 쌍 목록을 포함하는 객체입니다. 예: { "name": "wrench", "mass": "1.3kg", "count": "3" }

uid

string

출력 전용입니다. 시스템에서 할당한 고유 식별자입니다.

etag

string

출력 전용입니다. 다른 값을 기반으로 서버에서 계산된 체크섬 예상된 리소스에서 작업이 완료되도록 업데이트 또는 삭제 시 전송될 수 있습니다.

유형

도메인의 유형입니다.

열거형
TYPE_UNSPECIFIED 유형이 지정되지 않았습니다 (발생해서는 안 됨).
DEFAULT App Hosting에서 제공하는 기본 도메인 및 관리형 도메인입니다. 이러한 도메인은 상위 백엔드로 자동 생성되며 해당 도메인을 삭제하는 경우를 제외하고는 삭제할 수 없으며 다른 백엔드로 이동할 수 없습니다. 기본 도메인은 disabled 필드를 통해 사용 중지할 수 있습니다.
CUSTOM 개발자 소유의 맞춤 도메인. 커스텀 도메인을 사용하면 소유한 도메인을 App Hosting 백엔드와 연결하고, 백엔드 콘텐츠를 제공하도록 도메인을 구성할 수 있습니다.

게재 동작

App Hosting에서 도메인의 콘텐츠를 제공할지 여부를 나타냅니다.

JSON 표현
{

  // Union field serving_behavior can be only one of the following:
  "redirect": {
    object (Redirect)
  }
  // End of list of possible types for union field serving_behavior.
}
필드
통합 필드 serving_behavior. 지정하면 도메인의 제공 동작이 맞춤설정됩니다. serving_behavior은 다음 중 하나여야 합니다.
redirect

object (Redirect)

선택사항입니다. 도메인의 리디렉션 동작입니다(제공된 경우).

리디렉션

도메인의 리디렉션 동작을 지정합니다.

JSON 표현
{
  "uri": string,
  "status": string
}
필드
uri

string

필수 항목입니다. 리디렉션할 대상의 URI입니다. 이 URI는 원래 요청 경로 앞에 추가됩니다. 스키마가 없는 URI는 HTTPS로 가정됩니다.

status

string (int64 format)

선택사항입니다. 리디렉션 응답에서 사용할 상태 코드입니다. 유효한 HTTP 3XX 상태 코드여야 합니다. 없는 경우 기본값은 302입니다.

커스텀 도메인 상태

백엔드에 대한 커스텀 도메인의 연결 상태입니다.

JSON 표현
{
  "hostState": enum (HostState),
  "ownershipState": enum (OwnershipState),
  "certState": enum (CertState),
  "requiredDnsUpdates": [
    {
      object (DnsUpdates)
    }
  ],
  "issues": [
    {
      object (Status)
    }
  ]
}
필드
hostState

enum (HostState)

출력 전용입니다. 커스텀 도메인이 App Hosting에 트래픽을 적절하게 전달하는 것으로 감지되는지 여부를 추적합니다.

ownershipState

enum (OwnershipState)

출력 전용입니다. 도메인의 DNS 레코드를 기반으로 백엔드가 도메인에 콘텐츠를 제공하도록 허용되었는지 여부를 추적합니다.

certState

enum (CertState)

출력 전용입니다. 도메인의 SSL 인증서 상태를 추적합니다.

requiredDnsUpdates[]

object (DnsUpdates)

출력 전용입니다. 설정을 완료하고 콘텐츠 제공을 시작하기 위해 맞춤 도메인의 DNS에 추가하거나 삭제해야 하는 레코드를 나열합니다. 온보딩 중에 필드가 표시됩니다. 또한 온보딩 후 위 상태 중 하나 이상이 *_ACTIVE가 아닌 경우에도 표시됩니다. 이는 도메인의 DNS 레코드가 잘못된 상태임을 나타냅니다.

issues[]

object (Status)

출력 전용입니다. 도메인 구성 관련 문제 목록입니다. 사용자가 DNS 레코드의 문제를 직접 수정할 수 있습니다.

HostState

도메인의 호스트 상태입니다. 호스트 상태는 도메인에 연결된 각 IP 주소에서 App Hosting 원본의 적절한 샤드를 통해 제공하고 있는지 확인하여 결정됩니다.

열거형
HOST_STATE_UNSPECIFIED 커스텀 도메인의 호스트 상태가 지정되지 않았습니다. 지정되지 않으면 메시지가 유효하지 않습니다.
HOST_UNHOSTED 커스텀 도메인이 IP 주소와 연결되어 있지 않습니다.
HOST_UNREACHABLE 커스텀 도메인에 연결할 수 없습니다. App Hosting 서비스 도메인의 IP 주소를 찾기 위한 DNS 쿼리에서 오류가 발생했습니다. 자세한 내용은 CustomDomainStatusissues 필드를 참고하세요.
HOST_NON_FAH 도메인에 최종적으로 App Hosting으로 확인되지 않는 IP 주소만 있습니다.
HOST_CONFLICT 도메인에 App Hosting 및 다른 서비스로 확인되는 IP 주소가 있습니다. 일관된 결과를 얻으려면 앱 호스팅이 아닌 서비스와 관련된 AAAAA 레코드를 삭제하세요.
HOST_WRONG_SHARD 도메인에 잘못된 리전 또는 App Hosting의 복제 샤드로 확인되는 IP 주소가 있습니다.
HOST_ACTIVE 도메인에 대한 모든 요청은 도메인의 할당된 샤드를 통해 App Hosting에서 처리합니다. 커스텀 도메인의 OwnershipStateOWNERSHIP_ACTIVE이면 App Hosting은 도메인에 대한 요청 시 백엔드 콘텐츠를 제공합니다.

소유권 상태

커스텀 도메인의 소유권 상태입니다.

열거형
OWNERSHIP_STATE_UNSPECIFIED 커스텀 도메인의 소유권 상태가 지정되지 않았습니다. 이런 일이 발생해서는 안 됩니다.
OWNERSHIP_MISSING 커스텀 도메인의 도메인에 앱 호스팅 관련 소유권 레코드가 없습니다. 이 출처 샤드의 도메인에서 제공할 수 있는 백엔드가 없습니다.
OWNERSHIP_UNREACHABLE 커스텀 도메인에 연결할 수 없습니다. App Hosting 서비스 도메인의 소유권 레코드를 찾기 위한 DNS 쿼리에서 오류가 발생했습니다. 자세한 내용은 CustomDomainStatusissues 필드를 참고하세요.
OWNERSHIP_MISMATCH 다른 App Hosting 커스텀 도메인이 소유한 커스텀 도메인입니다. 충돌 레코드를 삭제하고 현재 맞춤 도메인의 레코드로 바꿉니다.
OWNERSHIP_CONFLICT 커스텀 도메인에 현재 커스텀 도메인 둘 다의 소유권을 나타내는 충돌하는 TXT 레코드가 있습니다. 관련 없는 소유권 레코드를 삭제하여 현재 커스텀 도메인 소유권을 부여합니다.
OWNERSHIP_PENDING 맞춤 도메인의 DNS 레코드가 올바르게 구성되었습니다. App Hosting은 24시간 내에 도메인 소유권을 이 커스텀 도메인으로 이전합니다.
OWNERSHIP_ACTIVE 커스텀 도메인이 도메인을 소유합니다.

인증 상태

App Hosting에 도메인 이름에 대한 SSL 인증서의 상태입니다. 이는 실제 인증서의 상태를 나타내거나, 새 커스텀 도메인의 경우 진행 중인 App Hosting의 인증서 생성 시도를 나타낼 수 있습니다.

열거형
CERT_STATE_UNSPECIFIED 인증서 상태가 지정되지 않았습니다. 지정되지 않으면 메시지가 유효하지 않습니다.
CERT_PREPARING 모든 인증서의 초기 상태는 인증 기관에 요청이 이루어지기 전에 인증서를 만들려는 App Hosting의 의도를 나타냅니다.
CERT_VALIDATING App Hosting에서 도메인 이름의 DNS 레코드가 자동으로 인증서를 생성하도록 허용하는 상태인지 확인합니다.
CERT_PROPAGATING 최근에 생성된 인증서가 App Hosting의 부하 분산기에 전파되는 데 시간이 필요합니다.
CERT_ACTIVE 인증서가 활성 상태이며, 인증서가 나타내는 도메인 이름에 보안 연결을 제공합니다.
CERT_EXPIRING_SOON 인증서가 곧 만료됩니다. 모든 도메인 이름에 새 인증서가 제공됩니다.
CERT_EXPIRED 인증서가 만료되었습니다. App Hosting에서 더 이상 도메인 이름에 보안 콘텐츠를 제공할 수 없습니다.

DNS 업데이트

App Hosting에서 도메인에 대한 요청에 대한 응답으로 보안 콘텐츠를 제공할 수 있도록 하기 위해 수행해야 하는 DNS 레코드 업데이트 모음입니다. 이러한 업데이트는 도메인 및 관련 하위 도메인의 현재 상태를 나타냅니다. App Hosting에서 마지막으로 쿼리한 시점의 DNS 레코드와 커스텀 도메인이 완전히 활성화되기 전에 App Hosting에서 확인해야 하는 원하는 레코드 모음입니다.

JSON 표현
{
  "domainName": string,
  "discovered": [
    {
      object (DnsRecordSet)
    }
  ],
  "desired": [
    {
      object (DnsRecordSet)
    }
  ],
  "checkTime": string
}
필드
domainName

string

출력 전용입니다. DNS 업데이트가 관련된 도메인 이름입니다.

discovered[]

object (DnsRecordSet)

출력 전용입니다. 도메인을 검사할 때 App Hosting에서 발견한 DNS 레코드 모음입니다.

desired[]

object (DnsRecordSet)

출력 전용입니다. App Hosting에서 도메인에 보안 콘텐츠를 제공하는 데 필요한 DNS 레코드 모음입니다.

checkTime

string (Timestamp format)

출력 전용입니다. App Hosting에서 커스텀 도메인의 DNS 레코드를 마지막으로 확인한 시간입니다.

RFC3339 UTC 'Zulu' 형식의 타임스탬프입니다(나노초 단위, 소수점 이하 9자리). 예를 들면 "2014-10-02T15:01:23Z""2014-10-02T15:01:23.045123456Z"입니다.

DnsRecordSet

App Hosting의 커스텀 도메인 설정 및 유지보수와 관련된 DNS 레코드 모음입니다.

JSON 표현
{
  "domainName": string,
  "checkError": {
    object (Status)
  },
  "records": [
    {
      object (DnsRecord)
    }
  ]
}
필드
domainName

string

출력 전용입니다. 레코드 세트가 속한 도메인 이름입니다.

checkError

object (Status)

출력 전용입니다. 도메인의 DNS 레코드를 쿼리하는 중에 App Hosting 서비스에서 오류가 발생했습니다. 참고: NXDOMAIN 오류는 일반적으로 도메인 이름이 아직 설정되지 않았음을 의미하기 때문에 App Hosting은 오류를 무시합니다.

records[]

object (DnsRecord)

출력 전용입니다. 도메인의 레코드

DNS 레코드

도메인의 DNS 레코드를 나타냅니다.

DNS 레코드는 도메인에 대한 요청을 처리할 때 시스템과 서비스의 작동 방식을 정의하는 리소스 레코드입니다. 예를 들어 도메인의 DNS 레코드에 A 레코드를 추가하면 다른 시스템 (예: 사용자의 웹브라우저)에 해당 IPv4 주소에 연결하여 도메인과 관련된 리소스 (예: App Hosting 파일)를 검색하도록 알리는 것입니다.

JSON 표현
{
  "domainName": string,
  "type": enum (Type),
  "rdata": string,
  "requiredAction": enum (Action),
  "relevantState": [
    enum (CustomDomainState)
  ]
}
필드
domainName

string

출력 전용입니다. 레코드가 속한 도메인입니다. 예: foo.bar.com.

type

enum (Type)

출력 전용입니다. 레코드의 유형으로, 레코드에 포함된 데이터가 결정됩니다.

rdata

string

출력 전용입니다. 레코드의 데이터입니다. 값의 의미는 레코드 유형에 따라 다릅니다. - A 및 AAAA: 도메인의 IP 주소입니다. - CNAME: 레코드를 확인할 다른 도메인입니다. - TXT: 도메인과 연결된 임의의 텍스트 문자열입니다. App Hosting은 TXT 레코드를 사용하여 도메인을 대신하여 작업할 권한이 있는 Firebase 프로젝트를 결정합니다. - CAA: 레코드의 플래그, 태그 및 값입니다. 예: 0 issue "pki.goog"

requiredAction

enum (Action)

출력 전용입니다. 이 레코드에 필요한 작업을 나타내는 enum입니다. 레코드가 DnsUpdates discovered 또는 desired 레코드 모음의 필수 변경사항의 일부인 경우 채워집니다.

relevantState[]

enum (CustomDomainState)

출력 전용입니다. 이 DNS 레코드가 적용되는 상태를 나타내는 열거형입니다. ADD 또는 REMOVE 필수 작업이 있는 모든 레코드에 대해 채워집니다.

유형

A, TXT, AAAA, CAA 등 DNS 레코드의 유형입니다.

열거형
TYPE_UNSPECIFIED 레코드 유형이 지정되지 않았습니다. 지정되지 않으면 메시지가 유효하지 않습니다.
A RFC 1035에 정의된 A 레코드 레코드는 도메인이 트래픽을 보내는 IPv4 주소를 결정합니다.
CNAME RFC 1035에 정의된 CNAME 레코드 CNAME 또는 표준 이름 레코드는 도메인을 다른 표준 도메인에 매핑합니다. CNAME 레코드가 존재하는 경우 이 레코드가 도메인의 유일한 레코드여야 합니다.
TXT RFC 1035에 정의된 TXT 레코드 TXT 레코드는 도메인에 있는 임의의 텍스트 데이터를 보유합니다. 호스팅은 TXT 레코드를 사용하여 도메인에서 작업할 권한이 있는 Firebase 프로젝트를 지정합니다.
AAAA RFC 3596에 정의된 AAAA 레코드는 도메인에서 트래픽을 보내는 IPv6 주소를 결정합니다.
CAA

RFC 6844에 정의된 CAA 레코드 CAA(인증 기관 승인) 레코드는 도메인에 대한 인증서를 발급할 수 있는 인증 기관(SSL 인증서 발급 조직)을 결정합니다. App Hosting은 pki.goog를 기본 CA로 사용합니다.

CAA 레코드는 하위로 전파됩니다. bar.foo.com에 자체 CAA 레코드 세트가 없으면 foo.com의 CAA 레코드는 bar.foo.com에도 적용됩니다.

CAA 레코드는 선택사항입니다. 도메인과 상위 요소에 CAA 레코드가 없는 경우 모든 CA는 이 도메인을 대신하여 인증서를 발급할 수 있습니다. 일반적으로 App Hosting은 SSL 인증서 생성을 차단 해제하는 데 필요한 경우에만 CAA 레코드를 수정하도록 요청합니다.

작업

App Hosting에서 사용하도록 도메인을 구성하기 위해 이 DNS 레코드에 대해 수행해야 하는 작업 유형입니다.

열거형
NONE 별도의 조치가 필요하지 않습니다.
ADD 이 레코드를 DNS 레코드에 추가합니다.
REMOVE DNS 레코드에서 이 레코드를 삭제합니다.

사용자설정 도메인 상태

커스텀 도메인의 정상적인 작동과 관련된 일련의 상태입니다.

열거형
CUSTOM_DOMAIN_STATE_UNSPECIFIED 지정되지 않은 경우 이 메시지는 유효하지 않습니다.
HOST_STATE 커스텀 도메인의 호스트 상태입니다.
OWNERSHIP_STATE 커스텀 도메인의 소유권 상태입니다.
CERT_STATE 커스텀 도메인의 인증서 상태입니다.

메소드

create

새 도메인을 백엔드에 연결합니다.

delete

단일 도메인을 삭제합니다.

get

도메인 정보를 가져옵니다.

list

백엔드의 도메인을 나열합니다.

patch

단일 도메인의 정보를 업데이트합니다.