通過DescribeWorkgroups API擷取工作群組列表和詳情-Server Migration Center-阿里雲

建立工作群組後，您可以查看工作群組的相關資訊，包括工作群組名稱、工作群組描述、警示資訊等。

調試

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

調試

授權資訊

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

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

操作

存取層級

資源類型

條件關鍵字

關聯操作

smc:DescribeWorkgroups

list

*全部資源

*

無

請求參數

名稱	類型	必填	描述	樣本值
WorkgroupId	array	否	工作群組識別碼列表，最多可以輸入 50 個工作群組識別碼。
	string	否	工作群組識別碼。	w-bp10geepnj916e3d****
Name	string	否	工作群組名稱。	test
Status	string	否	工作群組的狀態。取值範圍： NotStarted：未開始。 InProgress：進行中。 Cutover：割接中。 Completed：已完成。	InProgress
PageNumber	integer	否	工作群組列表的頁碼。起始值：1。預設值：1。	1
PageSize	integer	否	分頁查詢時設定的每頁行數。最大值：50。預設值：10。	10
Tag	array<object>	否	標籤數組。數組長度：1~20。如果數組中有多個標籤對象，標籤鍵 Key 不允許重複。
	object	否	標籤對象。
Key	string	否	工作群組的標籤鍵。最多支援 128 個字元，一旦傳入該值，則不允許為空白字串，不能以`aliyun`或`acs:`開頭，不能包含`http://`或`https://`。	TestKey
Value	string	否	工作群組的標籤值。最多支援 128 個字元，一旦傳入該值，可以為空白字串，不能包含`http://`或`https://`。	TestValue

返回參數

名稱	類型	描述	樣本值
	object	返回參數資訊。
RequestId	string	請求 ID。	2D69A58F-345C-4FDE-88E4-BF518948****
TotalCount	integer	工作群組總個數。	1
PageSize	integer	分頁查詢時設定的每頁行數。最大值：50。預設值：10。	10
PageNumber	integer	工作群組列表的頁碼。	1
Workgroups	object
Workgroup	array<object>	工作群組詳情資訊。
	object	工作群組對象。
WorkgroupId	string	工作群組識別碼。	w-bp10geepnj916e3d****
Name	string	工作群組名稱。	testWorkgroupName
Description	string	工作群組的描述資訊。	test
Status	string	工作群組的狀態。可能值： NotStarted：未開始。 InProgress：進行中。 Cutover：割接中。 Completed：已完成。	InProgress
Warnings	object
Warning	array<object>	工作群組警示資訊列表，可能包含多種警示。
	object	警示資訊。
WarningType	string	警示類型，可能值： InError：存在失敗的遷移任務。 UnRelated：存在遷移源未關聯遷移任務。 NotPassed：存在任務遷移演練未通過。	InError
SourceIds	object
SourceId	array	存在問題的遷移源列表。
	string	存在問題的遷移源 ID。	s-bp1h7ymebl7swbt4****
Tags	object
Tag	array<object>	工作群組的標籤資訊。
	object	工作群組的標籤資訊。
Key	string	工作群組的標籤鍵。	TestKey
Value	string	工作群組的標籤值。	TestValue

樣本

正常返回樣本

JSON格式

{
  "RequestId": "2D69A58F-345C-4FDE-88E4-BF518948****",
  "TotalCount": 1,
  "PageSize": 10,
  "PageNumber": 1,
  "Workgroups": {
    "Workgroup": [
      {
        "WorkgroupId": "w-bp10geepnj916e3d****",
        "Name": "testWorkgroupName",
        "Description": "test",
        "Status": "InProgress",
        "Warnings": {
          "Warning": [
            {
              "WarningType": "InError",
              "SourceIds": {
                "SourceId": [
                  "s-bp1h7ymebl7swbt4****"
                ]
              }
            }
          ]
        },
        "Tags": {
          "Tag": [
            {
              "Key": "\t\nTestKey",
              "Value": "TestValue"
            }
          ]
        }
      }
    ]
  }
}

錯誤碼

HTTP status code	錯誤碼	錯誤資訊	描述
500	InternalError	An error occurred while processing your request. Please try again. If the problem still exists, please submit a ticket.	內部錯誤，請重試。如果多次嘗試失敗，請提交工單。
403	Forbidden.Unauthorized	A required authorization for the specified action is not supplied.	使用者未授權操作指定的資源。

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

變更歷史

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