获取 Workspace

版本 4.0.23.2

获取工作区

返回有关工作区的信息，例如 Git 状态以及调用方用户帐号可用的所有项目的选定分支。

工作区定义哪些版本的项目文件将用于评估使用模型定义的表达式和操作，例如运行查询或渲染信息中心。每个项目都有自己的 git 代码库，工作区中的每个项目都可以配置为在各自的代码库中引用特定分支或修订版本。

系统提供了两个预定义的工作区：“生产”和“开发”。

生产工作区由所有 Looker 用户共享。生产工作区中的模型是只读的。通过在 git 分支中修改文件并使用拉取请求将开发分支中的更改合并到生产分支中，然后让 Looker 与生产环境同步，可以更改生产环境中的文件。

每个 Workspace 用户都是本地的开发工作区。对开发工作区中的项目/模型文件所做的更改只会影响该用户的设置，并且只有在选择开发工作区作为 API 会话的活跃工作区时才会影响。（请参阅 set_session_workspace()）。

开发工作区并非 API 会话独有。使用同一个用户帐号访问 Looker API 的两个应用将在开发者工作区中看到相同的文件。为避免 API 客户端之间发生冲突，最好让每个客户端分别使用不同的用户帐号的 API3 凭据进行登录。

对开发工作区中的文件所做的更改会在 API 会话之间保持不变。最好提交您对自己 Git 代码库所做的任何更改，但并非必须严格执行。修改后的文件位于 Looker 服务器上特定于用户的特殊目录中，当您稍后再次登录时，该文件仍将保留，并使用 update_session(workspace_id: "dev") 为新的 API 会话选择开发工作区。

请求

获取 /workspaces/{workspace_id}
数据类型
说明
请求
HTTP 请求
路径
HTTP 路径
展开 HTTPPath 定义...
workspace_id
字符串
工作区 ID

响应

200：工作区

数据类型
说明
（对象）
可以
对象
当前用户可以对此对象执行的操作
id
字符串
此用户工作区的唯一 ID。预定义的工作区 ID 包括“正式版”和“开发者”
项目
展开项目定义...
可以
对象
当前用户可以对此对象执行的操作
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：未找到

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

示例