該介面用於擷取租戶下的工作空間列表。
調試
您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。
調試
授權資訊
|
操作 |
存取層級 |
資源類型 |
條件關鍵字 |
關聯操作 |
|
dms:ListWorkspaces |
list |
*全部資源
|
無 | 無 |
請求參數
|
名稱 |
類型 |
必填 |
描述 |
樣本值 |
| AlreadyJoined |
boolean |
否 |
目前使用者是否已加入工作空間。 |
true |
| SearchKey |
string |
否 |
搜尋關鍵詞，支援模糊搜尋。 |
poc_test |
| Region |
string |
否 |
地區。 |
cn-hangzhou |
| ServiceAccountId |
integer |
否 |
服務帳號 ID |
12345 |
| WorkspaceId |
integer |
否 |
工作空間的 ID。 |
12**** |
| PageNumber |
integer |
否 |
頁碼。 |
1 |
| PageSize |
integer |
否 |
每頁的返回結果個數。 |
10 |
| VpcId |
string |
否 |
Virtual Private Cloud 的 ID。 說明
暫時無法用作過濾。 |
vpc-bp10wnlcmor**** |
返回參數
|
名稱 |
類型 |
描述 |
樣本值 |
|
object |
|||
| RequestId |
string |
請求 ID。 |
EE214ECD-4330-503A-82F0-FFB03975**** |
| ErrorCode |
string |
錯誤碼。 |
UserNotExist |
| ErrorMessage |
string |
調用失敗時，返回的錯誤資訊。 |
UnknownError |
| Success |
boolean |
請求是否成功。傳回值如下：
|
true |
| TotalCount |
integer |
滿足條件的工作空間總個數。 |
10 |
| Data |
object |
||
| BaseWorkspaces |
array<object> |
資料集。 |
|
|
object |
|||
| Description |
string |
工作空間的描述。 |
Test |
| CreatorId |
integer |
建立人的 ID。 |
123 |
| OwnerUid |
string |
責任人的阿里雲 UID。 |
15608564799**** |
| WorkspaceId |
integer |
工作空間的 ID。 |
8652340494**** |
| GmtModified |
string |
更新時間。 |
2025-01-01 00:00:00 |
| ServiceAccountId |
integer |
服務帳號 ID。 |
12345 |
| CreatorUid |
string |
建立者的阿里雲 UID。 |
1344**** |
| ServiceAccountNickName |
string |
服務帳號的暱稱。 |
testname |
| Name |
string |
工作空間的名稱。 |
workspace-xxxx |
| AlreadyJoined |
boolean |
目前使用者是否已加入工作空間。 |
true |
| TenantId |
integer |
專案空間所在的租戶 ID。 |
23456 |
| GmtCreate |
string |
建立時間。 |
2025-01-01 00:00:00 |
| ServiceAccountUid |
string |
服務帳號的阿里雲 UID。 |
1422**** |
| OwnerId |
integer |
負責人的 ID。 |
123**** |
| VpcId |
string |
Virtual Private Cloud 的 ID。 |
vpc-25fl3qjqb**** |
| Region |
string |
地區資訊。 |
cn-hangzhou |
| WorkspaceName |
string |
工作空間的名稱。 |
test-workspace |
| CreatorNickName |
string |
建立人的暱稱。 |
work***** |
| OwnerNickName |
string |
Owner 暱稱。 |
hel**** |
| NextToken |
string |
NextToken 暫無用途。 |
token-xxx |
| MaxResults |
integer |
與 TotalCount 相同，滿足條件的工作空間總個數。 |
10 |
樣本
正常返回樣本
JSON格式
{
"RequestId": "EE214ECD-4330-503A-82F0-FFB03975****",
"ErrorCode": "UserNotExist",
"ErrorMessage": "UnknownError",
"Success": true,
"TotalCount": 10,
"Data": {
"BaseWorkspaces": [
{
"Description": "Test",
"CreatorId": 123,
"OwnerUid": "15608564799****",
"WorkspaceId": 0,
"GmtModified": "2025-01-01 00:00:00",
"ServiceAccountId": 12345,
"CreatorUid": "1344****",
"ServiceAccountNickName": "testname",
"Name": "workspace-xxxx",
"AlreadyJoined": true,
"TenantId": 23456,
"GmtCreate": "2025-01-01 00:00:00",
"ServiceAccountUid": "1422****",
"OwnerId": 0,
"VpcId": "vpc-25fl3qjqb****",
"Region": "cn-hangzhou",
"WorkspaceName": "test-workspace",
"CreatorNickName": "work*****",
"OwnerNickName": "hel****"
}
]
},
"NextToken": "token-xxx",
"MaxResults": 10
}錯誤碼
訪問錯誤中心查看更多錯誤碼。
變更歷史
更多資訊，參考變更詳情。