使用GetWorkspace介面擷取工作空間詳情-Data Management-阿里雲

該介面用於擷取工作空間的詳情資訊。

調試

您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。

調試

授權資訊

下表是API對應的授權資訊，可以在RAM權限原則語句的Action元素中使用，用來給RAM使用者或RAM角色授予調用此API的許可權。具體說明如下：

操作：是指具體的許可權點。
存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。
資源類型：是指操作中支援授權的資源類型。具體說明如下：
- 對於必選的資源類型，用前面加 * 表示。
- 對於不支援資源級授權的操作，用全部資源表示。
條件關鍵字：是指雲產品自身定義的條件關鍵字。
關聯操作：是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權，操作才能成功。

操作

存取層級

資源類型

條件關鍵字

關聯操作

dms:GetWorkspace

get

*全部資源

*

無

請求文法

POST  HTTP/1.1

請求參數

名稱	類型	必填	描述	樣本值
WorkspaceId	integer	是	DMS 工作空間的 ID。	12****

返回參數

名稱	類型	描述	樣本值
	object	Schema of Response
RequestId	string	請求 ID，用於定位日誌，排查問題。	FE8EE2F1-4880-46BC-A704-5CF63EAF****
Message	string	執行失敗時，返回的錯誤資訊。	UnknownError
Data	object	返回的資料資訊。
WorkspaceId	integer	工作空間的 ID。	863020290155****
WorkspaceName	string	工作空間的名稱。	workspace_xxx
Description	string	工作空間的描述。	Test
RegionId	string	工作空間所屬的地區 ID。	cn-hangzhou
OwnerId	string	負責人的 ID。	12345****
ServiceAccountId	string	服務帳號 ID。	12345****
Tid	integer	租戶 ID。說明滑鼠移動到介面右上方的頭像處，查看租戶 ID。具體操作，請參見查看租戶資訊。	3322****
VpcId	string	Virtual Private Cloud 的 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.	工作空間不存在

訪問錯誤中心查看更多錯誤碼。

變更歷史

更多資訊，參考變更詳情。