调用GetWorkspace获取工作空间_人工智能平台 PAI(PAI)-阿里云帮助中心

获取工作空间详细信息。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作	访问级别	资源类型	条件关键字	关联操作
paiworkspace:GetWorkspace	get	全部资源 *	无	无

请求语法

GET /api/v1/workspaces/{WorkspaceId} HTTP/1.1

请求参数

名称	类型	必填	描述	示例值
WorkspaceId	string	是	工作空间 ID。如何获取工作空间 ID，请参见 ListWorkspaces 。	12345
Verbose	boolean	否	是否显示工作空间 Owner 等补充信息。取值如下： false（默认值）：不显示补充信息。 true：显示补充信息。	true

返回参数

名称	类型	描述	示例值
	object	返回结构体。
RequestId	string	请求 ID。	A0F049F0-8D69-5BAC-8F10-B4DED1B5A34C
WorkspaceId	string	工作空间 ID。	1234
WorkspaceName	string	工作空间名称。	workspace-example
GmtCreateTime	string	工作空间创建 UTC 时间，时间格式为 ISO8601。	2021-01-21T17:12:35.232Z
GmtModifiedTime	string	工作空间修改 UTC 时间，时间格式为 ISO8601。	2021-01-21T17:12:35.232Z
DisplayName	string	工作空间显示名称。	workspace-example
Description	string	工作空间描述。	workspace description example
EnvTypes	array	工作空间包含的环境，取值如下：简单模式只有生产环境（prod）。标准模式包含开发环境（dev）和生产环境（prod）。
EnvTypes	string	环境类型，可能值： dev：开发环境。 prod：生产环境。	prod
Creator	string	创建者用户 ID。	1157******94123
Status	string	工作空间状态，可能值： ENABLED：正常。 INITIALIZING：初始化中。 FAILURE：失败。 DISABLED：手动禁用。 FROZEN：欠费冻结。 UPDATING：项目更新中。	ENABLED
AdminNames	array	管理员账户名称列表。
AdminNames	string	管理员账户名称。当 Verbose 为 true 时显示。	demo_test@***.aliyunid.com
IsDefault	boolean	是否为默认工作空间，可能值： false：不是默认工作空间。 true：是默认工作空间。	true
ExtraInfos	object	附加信息，目前包含 TenantId（租户 ID）。	{"TenantId": "4286******98"}
Owner	object	工作空间所有者 ID，当 Verbose 为 true 时显示。
UserKp	string	用户 UID。	1157******94123
UserId	string	用户 ID。	1157******94123
UserName	string	用户名。	mings****t
DisplayName	string	显示名。	mings****t

示例

正常返回示例

JSON格式

{
  "RequestId": "A0F049F0-8D69-5BAC-8F10-B4DED1B5A34C",
  "WorkspaceId": "1234",
  "WorkspaceName": "workspace-example",
  "GmtCreateTime": "2021-01-21T17:12:35.232Z",
  "GmtModifiedTime": "2021-01-21T17:12:35.232Z",
  "DisplayName": "workspace-example",
  "Description": "workspace description example",
  "EnvTypes": [
    "prod"
  ],
  "Creator": "1157******94123",
  "Status": "ENABLED",
  "AdminNames": [
    "demo_test@***.aliyunid.com"
  ],
  "IsDefault": true,
  "ExtraInfos": {
    "TenantId": "4286******98"
  },
  "Owner": {
    "UserKp": "1157******94123",
    "UserId": "1157******94123",
    "UserName": "mings****t",
    "DisplayName": "mings****t"
  }
}

错误码

访问错误中心查看更多错误码。

变更历史

变更时间	变更内容概要	操作
2021-03-02	OpenAPI 入参发生变更	查看变更详情
2021-03-02	OpenAPI 返回结构发生变更	查看变更详情
2021-03-02	OpenAPI 返回结构发生变更	查看变更详情
2021-03-02	OpenAPI 返回结构发生变更	查看变更详情