文档

GetWorkspace - 查询工作空间详情

更新时间:

查询工作空间的详细信息,包括状态,描述,作业生命周期等。

调试

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

授权信息

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

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

请求参数

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

工作空间名字

MyTestWorkspace

返回参数

名称类型描述示例值
object
RequestIdstring

请求 ID

DA980AD0-158F-44F3-847D-5EAB96C0EB6B
Descriptionstring

工作空间简要描述

This is a test workspace
HostIdstring

主机 ID

easygene.cn-beijing.aliyuncs.com
JobLifecycleinteger

工作空间内作业生命周期

30
Labelsobject

工作空间标签

string

标签

test
Storagestring

工作空间内 OSS 上的工作路径

oss://my-bucket/my-path/
BucketNamestring

工作空间 Bucket

my-bucket
Rolestring

工作空间内默认的 RAM 服务角色

TestRole
CreateTimestring

创建时间

2021-06-16T15:09:14.378297+08:00
LastModifiedTimestring

最后修改时间

2021-06-16T15:09:14.378297+08:00
Workspacestring

工作空间名称

TestWorkspace
Statusstring

工作空间状态

Active
Locationstring

地域 ID

cn-beijing

示例

正常返回示例

JSON格式

{
  "RequestId": "DA980AD0-158F-44F3-847D-5EAB96C0EB6B",
  "Description": "This is a test workspace",
  "HostId": "easygene.cn-beijing.aliyuncs.com",
  "JobLifecycle": 30,
  "Labels": {
    "key": "test"
  },
  "Storage": "oss://my-bucket/my-path/",
  "BucketName": "my-bucket",
  "Role": "TestRole",
  "CreateTime": "2021-06-16T15:09:14.378297+08:00",
  "LastModifiedTime": "2021-06-16T15:09:14.378297+08:00",
  "Workspace": "TestWorkspace",
  "Status": "Active",
  "Location": "cn-beijing"
}

错误码

HTTP status code错误码错误信息描述
400InvalidParameterThe specified parameter %s is invalid.无效的参数
400MissingParameterThe input parameter %s that is mandatory for processing this request is not supplied.缺少必要的参数
404InvalidUser.NotFoundThe specified user is not found.找不到该用户信息,请先购买开通基因云产品

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

变更历史

变更时间变更内容概要操作
暂无变更历史
  • 本页导读 (0)