将网域添加到许可名单

本页介绍了如何使用 Allowlisted Domains API 将网域添加到许可名单。

准备工作

主要注意事项

  • 不可变设计：由于网域名称无法修改，因此必须通过删除现有条目并创建新条目来执行更新。
  • 吞吐量：对于任何唯一的客户账号，系统支持的配额约为每秒 1 次查询 (QPS)，该配额在所有网域之间共享。
  • 容量：管理员最多可为任何单个客户账号添加 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 创建的内容会生成可供管理员查看的审核日志事件。如需了解详情，请参阅查看审核日志。