GetWorkspace - 获取工作空间详情 - 开源大数据平台E-MapReduce

获取工作空间详情

调试

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

调试

授权信息

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

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

操作

访问级别

资源类型

条件关键字

关联操作

emr-serverless-spark:GetWorkspace

get

*全部资源

*

无

请求语法

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

路径参数

名称	类型	必填	描述	示例值
workspaceId	string	是	工作空间 Id。	w-***

请求参数

名称	类型	必填	描述	示例值
regionId	string	否	区域 ID。	cn-hangzhou

返回参数

名称	类型	描述	示例值
	object	返回数据
workspace	object	工作空间对象。
workspaceId	string	workspace Id。	w-******
workspaceName	string	工作空间名称。	spark批作业空间-1
resourceSpec	string	资源规格。	{"cu": 100}
storage	string	oss 路径。	spark-result
dlfCatalogId	string	dlf catalog 信息。	default
paymentType	string	付费类型。	PayAsYouGo or Subscription
paymentDurationUnit	string	订购周期(pre 付费类型必须)。	YEAR, MONTH, WEEK, DAY, HOUR, MINUTE
duration	integer	订购周期数量(pre 付费类型必须)。	1
autoRenew	boolean	是否自动续费(pre 付费类型必须)。	true
autoRenewPeriod	integer	自动续费时长(pre 付费类型必须)。	1
autoRenewPeriodUnit	string	自动续费周期(pre 付费类型必须)。	YEAR, MONTH, WEEK, DAY, HOUR, MINUTE
workspaceStatus	string	工作空间状态。	STARTING,RUNNING,TERMINATED
failReason	string	失败原因。	out of stock
paymentStatus	string	支付状态。	PAID/UNPAID
regionId	string	地域 ID。	cn-beijing
createTime	integer	工作空间创建时间。采用 Unix 时间戳，单位为毫秒。	1776824869000
endTime	integer	工作空间释放时间。	1786586477000
stateChangeReason	object	工作空间状态的变更信息。
code	string	错误码。	1000000
message	string	节点 Pod 状态信息。	ok
releaseType	string	工作空间释放原因。	stable
ramRoleName	string	Spark 作业执行角色名。	Aliyun
dlfType	string	绑定 dlf 类型。	DLF-NEXT
prePaidQuota	object	预付费资源配额的信息。
usedResource	string	当前已使用的资源量。	{"cu": 50}
maxResource	string	可使用的最大资源量。	{"cu": 100}
allocatedResource	string	当前已分配的资源量。	{"cu": 100}
createTime	integer	工作空间创建时间。采用 Unix 时间戳，单位为毫秒。	1791802817000
expireTime	integer	GPU 预付费配额过期时间，采用 Unix 时间戳，单位为毫秒。	1779768979586
autoRenewal	boolean	资源是否开启了自动续费功能。 true：开启自动续费，资源到期后会自动续订。 false：未开启自动续费，资源到期后将停止使用。	False
paymentStatus	string	订单状态。	NORMAL
instanceId	string	实例 id。	ray-df0tghlhat1776wy-klbifz8l
orderId	string	订单 id。	298581757170384
prePaidQuotaGpu	array<object>	gpu 包年包月列表。
	object	gpu 包年包月。
orderId	string	订单 id。	2345634254
instanceId	string	实例 id。	w-xxxxxx-quota-gpu-xxxx
createTime	integer	创建时间。	1782292672000
expireTime	integer	过期时间。	1782292772000
autoRenewal	boolean	是否自动续费。	False
paymentStatus	string	订单状态。	NORMAL
gpuSpec	string	gpu 机型。	ecs.gn7i-c8g1.2xlarge
gpuNum	integer	gpu 机器数量。	8
instanceTypeId	string	实例规格 ID。	ecs.g5.small
instanceTypeFamily	string	实例规格族。	ecs.g5
cpuCoreCount	string	CPU 核数。	1
gpuAmount	integer	GPU 数量。	1
memorySize	string	内存大小。	4096
gpuMemorySize	integer	GPU 显存大小。	4096
gpuMachineNum	integer	gpu 机器数量。	1
tags	array<object>	标签键。
	object	标签键。
tagKey	string	标签键。	[\"COST\"]
tagValue	string	标签值。	3d775731-9ec1-4fe2-a00d-061d51fce677
resourceGroupId	string	资源组 ID。	rg-aek4f7uj74wdthi
resourceOwnerId	string	创建用户 UID。	13*************
gpuSpec	array	gpu 机型列表。
	string	gpu 机型。	ecs.gn6e-c12g1.3xlarge
ipWhiteList	array	工作空间 ip 白名单。
	string	工作空间 ip 白名单。	10.0.0.1
requestId	string	请求 ID。	DD6B1B2A-5837-5237-ABE4-FF0C8944****

示例

正常返回示例

JSON格式

{
  "workspace": {
    "workspaceId": "w-******",
    "workspaceName": "spark批作业空间-1",
    "resourceSpec": "{\"cu\": 100}",
    "storage": "spark-result",
    "dlfCatalogId": "default",
    "paymentType": "PayAsYouGo or Subscription",
    "paymentDurationUnit": "YEAR, MONTH, WEEK, DAY, HOUR, MINUTE",
    "duration": 1,
    "autoRenew": true,
    "autoRenewPeriod": 1,
    "autoRenewPeriodUnit": "YEAR, MONTH, WEEK, DAY, HOUR, MINUTE",
    "workspaceStatus": "STARTING,RUNNING,TERMINATED",
    "failReason": "out of stock",
    "paymentStatus": "PAID/UNPAID",
    "regionId": "cn-beijing",
    "createTime": 1776824869000,
    "endTime": 1786586477000,
    "stateChangeReason": {
      "code": "1000000",
      "message": "ok"
    },
    "releaseType": "stable",
    "ramRoleName": "Aliyun",
    "dlfType": "DLF-NEXT",
    "prePaidQuota": {
      "usedResource": "{\"cu\": 50}",
      "maxResource": "{\"cu\": 100}",
      "allocatedResource": "{\"cu\": 100}",
      "createTime": 1791802817000,
      "expireTime": 1779768979586,
      "autoRenewal": true,
      "paymentStatus": "NORMAL",
      "instanceId": "ray-df0tghlhat1776wy-klbifz8l",
      "orderId": "298581757170384"
    },
    "prePaidQuotaGpu": [
      {
        "orderId": "2345634254",
        "instanceId": "w-xxxxxx-quota-gpu-xxxx",
        "createTime": 1782292672000,
        "expireTime": 1782292772000,
        "autoRenewal": true,
        "paymentStatus": "NORMAL",
        "gpuSpec": "ecs.gn7i-c8g1.2xlarge",
        "gpuNum": 8,
        "instanceTypeId": "ecs.g5.small",
        "instanceTypeFamily": "ecs.g5",
        "cpuCoreCount": "1",
        "gpuAmount": 1,
        "memorySize": "4096",
        "gpuMemorySize": 4096,
        "gpuMachineNum": 1
      }
    ],
    "tags": [
      {
        "tagKey": "[\\\"COST\\\"]",
        "tagValue": "3d775731-9ec1-4fe2-a00d-061d51fce677"
      }
    ],
    "resourceGroupId": "rg-aek4f7uj74wdthi",
    "resourceOwnerId": "13*************",
    "gpuSpec": [
      "ecs.gn6e-c12g1.3xlarge"
    ],
    "ipWhiteList": [
      "10.0.0.1"
    ]
  },
  "requestId": "DD6B1B2A-5837-5237-ABE4-FF0C8944****"
}

错误码

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

变更历史

更多信息，参考变更详情。