허용 목록에 도메인 추가

이 페이지에서는 허용된 도메인 API를 사용하여 허용 목록에 도메인을 추가하는 방법을 설명합니다.

시작하기 전에

• 허용된 도메인 API 개요를 읽어보세요.
• 허용된 도메인 API를 설정합니다.

주요 고려사항

• 변경 불가능한 설계: 도메인 이름을 수정할 수 없으므로 기존 항목을 삭제하고 새 항목을 만들어 업데이트를 실행해야 합니다.
• 처리량: 시스템은 고유한 고객 계정의 모든 도메인에 공유되는 초당 쿼리 수(QPS) 할당량(약 1개)을 지원합니다.
• 용량: 관리자는 단일 고객 계정에 최대 5,000개의 도메인을 추가할 수 있습니다.

허용 목록에 도메인 추가

create 메서드를 사용하여 새 항목을 추가합니다. 이 변경사항은 비동기식이며 장기 실행 작업 (LRO)을 반환합니다.

Python

def create_allowlisted_domain(service, domain_name):
  """Creates an allowlisted domain."""
  try:
    payload = {'domain': domain_name}
    response = service.allowlistedDomains().create(body=payload).execute()
    return response
  except Exception as e:
    print(f'An error occurred during create: {e}')
    return None

오류 처리

오류 조건	RPC 상태 코드	오류 메시지	문제 해결 / 근거
리소스에 대한 권한이 없음	PERMISSION_DENIED (403)	"Permission denied for allowlisted domain resource."	• 사용자에게 적절한 범위가 부여되었는지 확인합니다. • 사용자에게 필요한 권한이 있는지 확인합니다. • 연락처 이메일에 문의하여 프로젝트/사용자가 허용 목록에 추가되었는지 확인합니다.
사용자의 고객 ID를 찾을 수 없음	NOT_FOUND (404)	"Customer ID not found for user."	로그인한 사용자가 유효한 도메인에 연결되어 있지 않습니다.
허용 목록 업데이트가 이미 진행 중입니다.	FAILED_PRECONDITION (400)	"An allowlist update is already in progress. Please wait for it to complete before making another request."	이전 변경사항이 완료될 때까지 기다립니다.
허용 목록의 도메인 한도에 도달했습니다.	FAILED_PRECONDITION (400)	"Allowlisted domain limit has been reached."	고객 계정의 최대 용량인 5,000개의 도메인에 도달했습니다. 도메인을 더 이상 추가할 수 없습니다.
도메인 이름이 비어 있음	INVALID_ARGUMENT (400)	"Domain name cannot be empty."	만들기 요청에 전달된 도메인을 다시 확인합니다. 비어 있으면 안 됩니다.
도메인 이름이 잘못됨	INVALID_ARGUMENT (400)	"Invalid domain name: <domain>."	요청에 제공된 도메인 이름이 형식이 잘못되었거나 잘못되었습니다. 이 오류는 일반적으로 다음 시나리오 중 하나에서 발생합니다. • 구문상 잘못됨: 도메인 이름이 필요한 형식 표준을 준수하지 않습니다. • 제한된 도메인: 다음 특정 도메인은 제한되어 있으며 허용 목록에 추가할 수 없습니다: • aol.com • gmail.com • hotmail.com • mail.ru • outlook.com • web.de • yahoo.com • yandex.com • yandex.ru

감사 로그

허용된 도메인 API를 사용하여 만든 항목은 관리자가 검토할 수 있는 감사 로그 이벤트를 생성합니다. 자세한 내용은 감사 로그 보기를 참조하세요.