DescribeWorkgroups - Server Migration Center: Central de Documentação do Alibaba Cloud

Consulta os detalhes dos grupos de trabalho, incluindo nomes, descrições e informações de alerta.

Experimente agora

Experimente esta API no OpenAPI Explorer, sem necessidade de assinatura manual. Chamadas bem-sucedidas geram automaticamente código SDK correspondente aos seus parâmetros. Faça o download com segurança de credenciais integrada para uso local.

Testar

Autorização RAM

A tabela abaixo descreve a autorização necessária para chamar esta API. Você pode defini-la em uma política do Resource Access Management (RAM). As colunas da tabela estão detalhadas abaixo:

Ação: As ações que podem ser usadas no elemento Action das instruções de política de permissão do RAM para conceder permissões para executar a operação.
API: A API que você pode chamar para executar a ação.
Nível de acesso: O nível de acesso predefinido concedido para cada API. Valores válidos: create, list, get, update e delete.
Tipo de recurso: O tipo de recurso que suporta autorização para executar a ação. Indica se a ação suporta permissão em nível de recurso. O recurso especificado deve ser compatível com a ação. Caso contrário, a política será ineficaz.
- Para APIs com permissões em nível de recurso, os tipos de recursos obrigatórios são marcados com um asterisco (*). Especifique o Nome de Recurso Alibaba Cloud (ARN) correspondente no elemento Resource da política.
- Para APIs sem permissões em nível de recurso, é exibido como Todos os Recursos. Use um asterisco (*) no elemento Resource da política.
Chave de condição: As chaves de condição definidas pelo serviço. A chave permite controle granular, aplicando-se somente a ações ou a ações associadas a recursos específicos. Além das chaves de condição específicas do serviço, o Alibaba Cloud fornece um conjunto de chaves de condição comuns aplicáveis a todos os serviços compatíveis com RAM.
Ação dependente: As ações dependentes necessárias para executar a ação. Para concluir a ação, o usuário RAM ou a função RAM deve ter permissões para executar todas as ações dependentes.

Ação

Nível de acesso

Tipo de recurso

Chave de condição

Ação dependente

smc:DescribeWorkgroups

list

*Todos os recursos.

*

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
WorkgroupId	array	Não	A lista de IDs dos grupos de trabalho. Você pode especificar até 50 IDs de grupos de trabalho.
	string	Não	O ID do grupo de trabalho.	w-bp10geepnj916e3d****
Name	string	Não	O nome do grupo de trabalho.	test
Status	string	Não	O status do grupo de trabalho. Valores válidos: NotStarted: não iniciado InProgress: em andamento Cutover: em transição Completed: concluído	InProgress
PageNumber	integer	Não	O número da página da lista de grupos de trabalho. As páginas começam em 1. Valor padrão: 1.	1
PageSize	integer	Não	O número de entradas por página para uma consulta paginada. Valor máximo: 50. Valor padrão: 10.	10
Tag	array<object>	Não	A matriz de tags. Comprimento da matriz: 1 a 20. Se a matriz contiver vários objetos de tag, as chaves de tag devem ser exclusivas.
	object	Não	O objeto de tag.
Key	string	Não	A chave de tag do grupo de trabalho. A chave de tag pode ter até 128 caracteres. Se você especificar este parâmetro, o valor não poderá ser uma string vazia. O valor não pode começar com aliyun ou acs: e não pode conter http:// ou https://.	TestKey
Value	string	Não	O valor da tag do grupo de trabalho. O valor da tag pode ter até 128 caracteres. Se você especificar este parâmetro, o valor poderá ser uma string vazia. O valor não pode conter http:// ou https://.	TestValue

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	Os parâmetros de resposta.
RequestId	string	O ID da solicitação.	2D69A58F-345C-4FDE-88E4-BF518948****
TotalCount	integer	O número total de grupos de trabalho.	1
PageSize	integer	O número de entradas por página para uma consulta paginada. Valor máximo: 50. Valor padrão: 10.	10
PageNumber	integer	O número da página da lista de grupos de trabalho.	1
Workgroups	object
Workgroup	array<object>	Os detalhes do grupo de trabalho.
	array<object>	O objeto do grupo de trabalho.
WorkgroupId	string	O ID do grupo de trabalho.	w-bp10geepnj916e3d****
Name	string	O nome do grupo de trabalho.	testWorkgroupName
Description	string	A descrição do grupo de trabalho.	test
Status	string	O status do grupo de trabalho. Valores válidos: NotStarted: não iniciado InProgress: em andamento Cutover: em transição Completed: concluído	InProgress
Warnings	object
Warning	array<object>	A lista de informações de alerta do grupo de trabalho. Vários tipos de alertas podem ser incluídos.
	array<object>	As informações de alerta.
WarningType	string	O tipo de alerta. Valores válidos: InError: nós de migração com falha. UnRelated: origens de migração não associadas a nós de migração. NotPassed: simulações de migração com falha para nós.	InError
SourceIds	object
SourceId	array	A lista de origens de migração que apresentam problemas.
	string	O ID da origem de migração que apresenta problemas.	s-bp1h7ymebl7swbt4****
Tags	object
Tag	array<object>	As informações de tag do grupo de trabalho.
	object	As informações de tag do grupo de trabalho.
Key	string	A chave de tag do grupo de trabalho.	TestKey
Value	string	O valor da tag do grupo de trabalho.	TestValue

Exemplos

Resposta de sucesso

JSON formato

{
  "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"
            }
          ]
        }
      }
    ]
  }
}

Códigos de erro

Código de status HTTP	Código de erro	Mensagem de erro	Descrição
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.

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.