GetWorkspace - 获取工作空间详情_数据管理 DMS-阿里云帮助中心

该接口用于获取工作空间的详情信息。

调试

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

授权信息

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

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

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

请求参数

名称	类型	必填	描述	示例值
WorkspaceId	long	是	DMS 工作空间的 ID。	12****

返回参数

名称	类型	描述	示例值
	object	Schema of Response
RequestId	string	请求 ID，用于定位日志，排查问题。	FE8EE2F1-4880-46BC-A704-5CF63EAF****
Message	string	执行失败时，返回的错误信息。	UnknownError
Data	object	返回的数据信息。
WorkspaceId	long	工作空间的 ID。	863020290155****
WorkspaceName	string	工作空间的名称。	workspace_xxx
Description	string	工作空间的描述。	Test
RegionId	string	工作空间所属的地域 ID。	cn-hangzhou
OwnerId	string	负责人的 ID。	12345****
ServiceAccountId	string	服务账号 ID。	12345****
Tid	long	租户 ID。说明鼠标移动到界面右上角的头像处，查看租户 ID。具体操作，请参见查看租户信息。	3322****
VpcId	string	专有网络 VPC 的 ID。	vpc-xxxx
Success	boolean	请求是否成功，返回值说明如下： true：请求成功。 false：请求失败。	true

示例

正常返回示例

JSON格式

{
  "RequestId": "FE8EE2F1-4880-46BC-A704-5CF63EAF****",
  "Message": "UnknownError",
  "Data": {
    "WorkspaceId": 0,
    "WorkspaceName": "workspace_xxx",
    "Description": "Test",
    "RegionId": "cn-hangzhou",
    "OwnerId": "12345****",
    "ServiceAccountId": "12345****",
    "Tid": 0,
    "VpcId": "vpc-xxxx"
  },
  "Success": true
}

错误码

HTTP status code	错误码	错误信息	描述
404	WorkspaceNotExist	The specified workspace not exist.	工作空间不存在

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