DescribeWorkgroups - 查看工作组 - 服务器迁移中心

创建工作组后，您可以查看工作组的相关信息，包括工作组名称、工作组描述、告警信息等。

调试

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

授权信息

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

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

操作	访问级别	资源类型	条件关键字	关联操作
smc:DescribeWorkgroups	list	全部资源 *	无	无

请求参数

名称	类型	必填	描述	示例值
WorkgroupId	array	否	工作组 ID 列表，最多可以输入 50 个工作组 ID。
	string	否	工作组 ID。	w-***
Name	string	否	工作组名称。	test
Status	string	否	工作组的状态。取值范围： NotStarted：未开始。 InProgress：进行中。 Cutover：割接中。 Completed：已完成。	InProgress
PageNumber	integer	否	工作组列表的页码。起始值：1。默认值：1。	1
PageSize	integer	否	分页查询时设置的每页行数。最大值：50。默认值：10。	10

返回参数

名称	类型	描述	示例值
	object	返回参数信息。
RequestId	string	请求 ID。	2D69A58F-345C-4FDE-88E4-BF518948****
TotalCount	integer	工作组总个数。	1
PageSize	integer	分页查询时设置的每页行数。最大值：50。默认值：10。	10
PageNumber	integer	工作组列表的页码。	1
Workgroups	array<object>	工作组信息。
Workgroup	object	工作组详情的集合。
WorkgroupId	string	工作组 ID。	w-***
Name	string	工作组名称。	testWorkgroupName
Description	string	工作组的描述信息。	test
Status	string	工作组的状态。可能值： NotStarted：未开始。 InProgress：进行中。 Cutover：割接中。 Completed：已完成。	InProgress
Warnings	array<object>	工作组告警信息列表，可能包含多种告警。
Warning	object	告警信息。
WarningType	string	告警类型，可能值： InError：存在失败的迁移任务。 UnRelated：存在迁移源未关联迁移任务。 NotPassed：存在任务迁移演练未通过。	InError
SourceIds	array	存在问题的迁移源列表。
SourceId	string	存在问题的迁移源 ID。	s-***

示例

正常返回示例

JSON格式

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

错误码

HTTP status code	错误码	错误信息	描述
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.	内部错误，请重试。如果多次尝试失败，请提交工单。

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