DescribeWorkgroups - Server Migration Center - Alibaba Cloud Documentation Center

Queries the information about workgroups. After you create a workgroup, you can query the information about the workgroup, such as the name, description, and alert information.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

Parameter	Type	Required	Description	Example
WorkgroupId	array	No	The workgroup IDs. You can specify up to 50 workgroup IDs.
	string	No	The workgroup ID.	w-***
Name	string	No	The name of the workgroup.	test
Status	string	No	The state of the workgroup. Valid values: NotStarted InProgress Cutover Completed	InProgress
PageNumber	integer	No	The page number. Pages start from page 1. Default value: 1.	1
PageSize	integer	No	The number of entries per page. Valid values: 1 to 50. Default value: 10.	10

Response parameters

Parameter	Type	Description	Example
	object	The response parameters.
RequestId	string	The request ID.	2D69A58F-345C-4FDE-88E4-BF518948****
TotalCount	integer	The total number of workgroups.	1
PageSize	integer	The number of entries per page. Valid values: 1 to 50. Default value: 10.	10
PageNumber	integer	The page number.	1
Workgroups	array<object>	The queried workgroups.
Workgroup	object	The queried workgroup.
WorkgroupId	string	The workgroup ID.	w-***
Name	string	The name of the workgroup.	testWorkgroupName
Description	string	The description of the workgroup.	test
Status	string	The state of the workgroup. Valid values: NotStarted InProgress Cutover Completed	InProgress
Warnings	array<object>	The alert information of the workgroup, which can contain multiple types of alerts.
Waring	object	The information about the alert.
WarningType	string	The type of the alert. Valid values: InError: A migration job failed. UnRelated: No migration job is created for a migration source. NotPassed: A migration job failed to pass the migration test.	InError
SourceIds	array	The migration sources for which alerts are generated.
SourceId	string	The ID of the migration source.	s-***

Examples

Sample success responses

JSONformat

{
  "RequestId": "2D69A58F-345C-4FDE-88E4-BF518948****",
  "TotalCount": 1,
  "PageSize": 10,
  "PageNumber": 1,
  "Workgroups": {
    "Workgroup": [
      {
        "WorkgroupId": "w-***",
        "Name": "testWorkgroupName",
        "Description": "test",
        "Status": "InProgress",
        "Warnings": {
          "Waring": [
            {
              "WarningType": "InError",
              "SourceIds": {
                "SourceId": [
                  "s-***"
                ]
              }
            }
          ]
        }
      }
    ]
  }
}

Error codes

HTTP status code	Error code	Error message	Description
403	Forbidden.Unauthorized	A required authorization for the specified action is not supplied.	-
500	InternalError	An error occurred while processing your request. Please try again. If the problem still exists, please submit a ticket.	An error occurred while processing your request. Please try again. If the problem still exists, please submit a ticket.

For a list of error codes, visit the Service error codes.