文档

GetWorkspace - 获取工作空间

更新时间:

获取工作空间详细信息。

调试

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

授权信息

当前API暂无授权信息透出。

请求语法

GET /api/v1/workspaces/{WorkspaceId}

请求参数

名称类型必填描述示例值
WorkspaceIdstring

工作空间 ID。如何获取工作空间 ID,请参见 ListWorkspaces

12345
Verboseboolean

是否显示工作空间 Owner 等补充信息。取值如下:

  • false(默认值):不显示补充信息。
  • true:显示补充信息。
true

返回参数

名称类型描述示例值
object

返回结构体。

RequestIdstring

请求 ID。

A0F049F0-8D69-5BAC-8F10-B4DED1B5A34C
WorkspaceIdstring

工作空间 ID。

1234
WorkspaceNamestring

工作空间名称。

workspace-example
GmtCreateTimestring

工作空间创建 UTC 时间,时间格式为 ISO8601。

2021-01-21T17:12:35.232Z
GmtModifiedTimestring

工作空间修改 UTC 时间,时间格式为 ISO8601。

2021-01-21T17:12:35.232Z
DisplayNamestring

工作空间显示名称。

workspace-example
Descriptionstring

工作空间描述。

workspace description example
EnvTypesarray

工作空间包含的环境,取值如下:

  • 简单模式只有生产环境(prod)。
  • 标准模式包含开发环境(dev)和生产环境(prod)。
string

环境类型,可能值:

dev:开发环境。 prod:生产环境。

prod
Creatorstring

创建者用户 ID。

1157******94123
Statusstring

工作空间状态,可能值:

ENABLED:正常。 INITIALIZING:初始化中。 FAILURE:失败。 DISABLED:手动禁用。 FROZEN:欠费冻结。 UPDATING:项目更新中。

ENABLED
AdminNamesarray

管理员账户名称列表。

string

管理员账户名称。当 Verbose 为 true 时显示。

demo_test@***.aliyunid.com
IsDefaultboolean

是否为默认工作空间,可能值:

  • false:不是默认工作空间。
  • true:是默认工作空间。
true
ExtraInfosobject

附加信息,目前包含 TenantId(租户 ID)。

{"TenantId": "4286******98"}
Ownerobject

工作空间所有者 ID,当 Verbose 为 true 时显示。

UserKpstring

用户 UID。

1157******94123
UserIdstring

用户 ID。

1157******94123
UserNamestring

用户名。

mings****t
DisplayNamestring

显示名。

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-02OpenAPI 入参发生变更看变更集
变更项变更内容
入参OpenAPI 入参发生变更
    新增入参:Verbose
2021-03-02OpenAPI 返回结构发生变更看变更集
变更项变更内容
出参OpenAPI 返回结构发生变更
2021-03-02OpenAPI 返回结构发生变更看变更集
变更项变更内容
出参OpenAPI 返回结构发生变更
2021-03-02OpenAPI 返回结构发生变更看变更集
变更项变更内容
出参OpenAPI 返回结构发生变更
  • 本页导读 (1)
文档反馈