更新项目

版本 3.1.23.2

更新项目配置

对项目配置应用更改。

为项目配置 Git

如需使用远程 git 代码库设置 Looker 项目，请按以下步骤操作：

  1. 调用 update_session 以选择“开发”工作区。
  2. 调用 create_git_deploy_key 以便为项目创建新的部署密钥
  3. 将部署密钥文本复制到远程 Git 代码库的 SSH 密钥配置
  4. 如有必要，请调用 update_project 以设置项目的 git_remote_url () 和 git_service_name。

当您修改项目的 git_remote_url 时，Looker 会连接到远程代码库以提取元数据。在设置项目的 git_remote_url 之前，必须使用此项目为 Looker 生成的部署密钥配置远程 git 代码库。

如需为 Looker 项目设置一个位于 Looker 服务器上的 Git 代码库（“bare”git 代码库），请运行以下命令：

  1. 调用 update_session 以选择“开发”工作区。
  2. 调用 update_project，将 git_remote_url 设置为 null，并将 git_service_name 设置为“bare”。

请求

PATCH /projects/{project_id}
数据类型
说明
请求
HTTP 请求
路径
HTTP 路径
展开 HTTPPath 定义...
project_id
字符串
项目 ID
body
HTTP 正文
展开 HTTPBody 定义...
body
项目
展开项目定义...
可以
对象
当前用户可以对此对象执行的操作
id
字符串
项目 ID
name
字符串
项目的显示名称
使用 git
布尔值
如果为 true，则表示项目配置了 git 代码库
git_remote_url
字符串
Git 远程代码库网址
git_username
字符串
用于 HTTPS 身份验证的 Git 用户名。（仅适用于生产环境，前提是使用用户属性。）
git_password
字符串
（只写）用于 HTTPS 身份验证的 Git 密码。（仅适用于生产环境，前提是使用用户属性。）
git_production_branch_name
字符串
Git 生产分支名称。默认为母版。仅在 Looker 21.0 及更高版本中受支持。
使用 git_cookie_auth
布尔值
如果为 true，则表示项目使用 git cookie 进行身份验证。
git_username_user_attribute
字符串
每位用户的 HTTPS 身份验证中的用户名的用户属性名称。
git_password_user_attribute
字符串
每位用户的 HTTPS 身份验证密码的用户属性名称。
git_service_name
字符串
Git 服务提供商的名称
git_application_server_http_port
整数
HTTP(S) 应用服务器运行时的端口（用于 PR、文件浏览等）
git_application_server_http_scheme
字符串
在应用服务器上运行的方案（用于 PR、文件浏览等）
部署密钥
字符串
（只写）可选密钥令牌，用于向 webhook 部署端点发出的请求进行身份验证。如果未设置，则端点未经身份验证。
un_deploy_secret
布尔值
（只写）如果为 true，则取消设置部署密钥，以允许对 webhook 部署端点进行未经身份验证的访问。
拉取请求模式
字符串
此项目的 Git 拉取请求政策。有效值为“off”、“links”、“recommended”、“required”。
验证（必需）
布尔值
验证政策：如果值为 true，则项目必须通过验证检查，然后项目更改才能提交到 git 代码库
git_release_mgmt_enabled
布尔值
如果为 true，则表示此项目已启用高级 Git 版本管理
allow_warnings
布尔值
验证政策：如果为 true，则当 `verification_required` 为 true 时，可以提交项目并显示警告。（如果“verification_required”为 false，则“allow_warnings”不会执行任何操作）。
is_example
布尔值
如果为 true，则表示项目是示例项目且无法修改
查询
HTTPQuery
展开 HTTPQuery 定义...
字段
字符串
请求的字段

响应

200：项目

数据类型
说明
（对象）
可以
对象
当前用户可以对此对象执行的操作
id
字符串
项目 ID
name
字符串
项目的显示名称
使用 git
布尔值
如果为 true，则表示项目配置了 git 代码库
git_remote_url
字符串
Git 远程代码库网址
git_username
字符串
用于 HTTPS 身份验证的 Git 用户名。（仅适用于生产环境，前提是使用用户属性。）
git_password
字符串
（只写）用于 HTTPS 身份验证的 Git 密码。（仅适用于生产环境，前提是使用用户属性。）
git_production_branch_name
字符串
Git 生产分支名称。默认为母版。仅在 Looker 21.0 及更高版本中受支持。
使用 git_cookie_auth
布尔值
如果为 true，则表示项目使用 git cookie 进行身份验证。
git_username_user_attribute
字符串
每位用户的 HTTPS 身份验证中的用户名的用户属性名称。
git_password_user_attribute
字符串
每位用户的 HTTPS 身份验证密码的用户属性名称。
git_service_name
字符串
Git 服务提供商的名称
git_application_server_http_port
整数
HTTP(S) 应用服务器运行时的端口（用于 PR、文件浏览等）
git_application_server_http_scheme
字符串
在应用服务器上运行的方案（用于 PR、文件浏览等）
部署密钥
字符串
（只写）可选密钥令牌，用于向 webhook 部署端点发出的请求进行身份验证。如果未设置，则端点未经身份验证。
un_deploy_secret
布尔值
（只写）如果为 true，则取消设置部署密钥，以允许对 webhook 部署端点进行未经身份验证的访问。
拉取请求模式
字符串
此项目的 Git 拉取请求政策。有效值为“off”、“links”、“recommended”、“required”。
验证（必需）
布尔值
验证政策：如果值为 true，则项目必须通过验证检查，然后项目更改才能提交到 git 代码库
git_release_mgmt_enabled
布尔值
如果为 true，则表示此项目已启用高级 Git 版本管理
allow_warnings
布尔值
验证政策：如果为 true，则当 `verification_required` 为 true 时，可以提交项目并显示警告。（如果“verification_required”为 false，则“allow_warnings”不会执行任何操作）。
is_example
布尔值
如果为 true，则表示项目是示例项目且无法修改

400：错误请求

数据类型
说明
（对象）
消息
字符串
错误详情
文档网址
字符串
文档链接

404：未找到

数据类型
说明
（对象）
消息
字符串
错误详情
文档网址
字符串
文档链接

409：资源已存在

数据类型
说明
（对象）
消息
字符串
错误详情
文档网址
字符串
文档链接

422：验证错误

数据类型
说明
（对象）
消息
字符串
错误详情
展开 ValidationErrorDetail 定义...
字段
字符串
出错的字段
代码
字符串
错误代码
消息
字符串
错误信息消息
文档网址
字符串
文档链接
文档网址
字符串
文档链接

429：请求数过多

数据类型
说明
（对象）
消息
字符串
错误详情
文档网址
字符串
文档链接

500：服务器错误

数据类型
说明
（对象）
消息
字符串
错误详情
文档网址
字符串
文档链接