文档

GetDefaultWorkspace - 获取默认工作空间

更新时间:

获取默认工作空间详情。

调试

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

授权信息

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

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

请求语法

GET /api/v1/defaultWorkspaces

请求参数

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

是否显示默认工作空间的详细信息,目前详细信息包含阶段列表详情(Conditions)。取值如下。

  • false(默认值):不显示详细信息。
  • true:显示详细信息。
false

返回参数

名称类型描述示例值
object

返回结构体。

RequestIdstring

请求 ID。

5A14FA81-DD4E-******-6343FE44B941
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

创建者的阿里云账号 UID。

17915******4216
Ownerobject

创建者的阿里云账号 UID。

UserIdstring

用户 UID。

17915******4216
UserNamestring

用户名。

username
UserKpstring

用户 UID。

17915******4216
Statusstring

工作空间状态,可能值:

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

默认工作空间创建流程的阶段列表详情。

object

默认工作空间创建流程的阶段详情。

Typestring

任务类型,可能值:

  • CREATING:创建中。
  • WORKSPACE_CREATED:工作空间创建完成。
  • MEMBERS_ADDED:成员添加完成。
  • ENABLED:总体完成。
CREATING
Codelong

返回码。200 表示返回正常,其他表示返回异常。

200
Messagestring

请求返回的错误消息。当返回码为 200 时,该字段为空。

Create Failed

示例

正常返回示例

JSON格式

{
  "RequestId": "5A14FA81-DD4E-******-6343FE44B941",
  "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": "17915******4216\n",
  "Owner": {
    "UserId": "17915******4216",
    "UserName": "username",
    "UserKp": "17915******4216"
  },
  "Status": "ENABLED",
  "Conditions": [
    {
      "Type": "CREATING ",
      "Code": 200,
      "Message": "Create Failed"
    }
  ]
}

错误码

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

变更历史

变更时间变更内容概要操作
2022-08-10OpenAPI 返回结构发生变更查看变更详情
2021-09-22新增 OpenAPI查看变更详情
2021-09-22OpenAPI 入参发生变更查看变更详情