DescribeWorkgroups - - Centre de documentation Alibaba Cloud

Après la création d'un groupe de travail, vous pouvez consulter ses informations, telles que le nom du groupe de travail, la description et les informations d'alerte.

Testez maintenant

Testez cette API dans OpenAPI Explorer, sans signature manuelle. Les appels réussis génèrent automatiquement du code SDK correspondant à vos paramètres. Téléchargez-le avec une sécurité intégrée des identifiants pour une utilisation locale. Testez cette API dans OpenAPI Explorer, sans signature manuelle. Les appels réussis génèrent automatiquement du code SDK correspondant à vos paramètres. Téléchargez-le avec une sécurité intégrée des identifiants pour une utilisation locale.

Test

Autorisation RAM

Le tableau ci-dessous décrit les autorisations nécessaires pour appeler cette API. Vous pouvez les définir dans une politique Resource Access Management (RAM). Les colonnes du tableau sont détaillées ci-dessous :

Action : les actions peuvent être utilisées dans l'élément Action des instructions de politique de permissions RAM pour accorder les autorisations nécessaires à l'exécution de l'opération.
API : l'API que vous pouvez appeler pour exécuter l'action.
Niveau d'accès : le niveau d'accès prédéfini accordé pour chaque API. Valeurs valides : create, list, get, update et delete.
Type de ressource : le type de ressource qui prend en charge l'autorisation pour exécuter l'action. Il indique si l'action prend en charge les permissions au niveau de la ressource. La ressource spécifiée doit être compatible avec l'action. Sinon, la politique sera inefficace.
- Pour les API avec permissions au niveau de la ressource, les types de ressource requis sont marqués d'un astérisque (*). Spécifiez l'Alibaba Cloud Resource Name (ARN) correspondant dans l'élément Resource de la politique.
- Pour les API sans permissions au niveau de la ressource, la valeur All Resources est affichée. Utilisez un astérisque (*) dans l'élément Resource de la politique.
Clé de condition : les clés de condition définies par le service. La clé permet un contrôle granulaire, applicable aux actions seules ou aux actions associées à des ressources spécifiques. En plus des clés de condition propres au service, Alibaba Cloud fournit un ensemble de clés de condition communes applicables à tous les services pris en charge par RAM.
Action dépendante : les actions dépendantes requises pour exécuter l'action. Pour mener à bien l'opération, l'utilisateur RAM ou le rôle RAM doit disposer des permissions pour toutes les actions dépendantes.

smc:DescribeWorkgroups

list

*All Resource

*

Aucune

Paramètres de requête

Paramètre	Type	Requis	Description	Exemple
WorkgroupId	array	Non	Une liste d'identifiants de groupes de travail. Vous pouvez spécifier jusqu'à 50 identifiants de groupes de travail.
	string	Non	L'identifiant du groupe de travail.	w-***
Name	string	Non	Le nom du groupe de travail.	test
Status	string	Non	L'état du groupe de travail. Valeurs valides : NotStarted : le groupe de travail n'est pas démarré. InProgress : le groupe de travail est en cours. Cutover : le groupe de travail est en cours de basculement. Completed : le groupe de travail est terminé.	InProgress
PageNumber	integer	Non	Le numéro de page de la liste des groupes de travail. La valeur commence à 1. Valeur par défaut : 1.	1
PageSize	integer	Non	Le nombre d'entrées à renvoyer sur chaque page pour une requête paginée. Valeur maximale : 50. Valeur par défaut : 10.	10
Tag	array<object>	Non	Le tableau de balises. Le tableau peut contenir de 1 à 20 balises. Si le tableau contient plusieurs objets de balise, les clés de balise ne peuvent pas être identiques.
	object	Non	L'objet de balise.
Key	string	Non	La clé de balise du groupe de travail. La clé peut comporter jusqu'à 128 caractères. Si vous spécifiez ce paramètre, la valeur ne peut pas être une chaîne vide. La clé ne peut pas commencer par aliyun ou acs: et ne peut pas contenir http:// ou https://.	TestKey
Value	string	Non	La valeur de balise du groupe de travail. La valeur peut comporter jusqu'à 128 caractères. Si vous spécifiez ce paramètre, la valeur peut être une chaîne vide. La valeur ne peut pas contenir http:// ou https://.	TestValue

Éléments de réponse

Élément	Type	Description	Exemple
	object	Les paramètres renvoyés.
RequestId	string	L'identifiant de la requête.	2D69A58F-345C-4FDE-88E4-BF518948****
TotalCount	integer	Le nombre total de groupes de travail.	1
PageSize	integer	Le nombre d'entrées renvoyées sur chaque page. Valeur maximale : 50. Valeur par défaut : 10.	10
PageNumber	integer	Le numéro de page de la liste des groupes de travail.	1
Workgroups	object
Workgroup	array<object>	Les détails des groupes de travail.
	array<object>	L'objet de groupe de travail.
WorkgroupId	string	The workgroup ID.	w-bp10geepnj916e3d****
Name	string	The name of the workgroup.	testWorkgroupName
Description	string	The description of the workgroup.	test
Status	string	The status of the workgroup. Possible values: NotStarted: The workgroup is not started. InProgress: The workgroup is in progress. Cutover: The workgroup is being cut over. Completed: The workgroup is completed.	InProgress
Warnings	object
Warning	array<object>	A list of alert information for the workgroup. The list may contain multiple types of alerts.
	array<object>	The alert information.
WarningType	string	The alert type. Possible values: InError: One or more migration tasks have failed. UnRelated: One or more migration sources are not associated with migration tasks. NotPassed: One or more migration task drills have failed.	InError
SourceIds	object
SourceId	array	A list of migration sources that have issues.
	string	The ID of the migration source that has an issue.	s-bp1h7ymebl7swbt4****
Tags	object
Tag	array<object>	The tag information of the workgroup.
	object	The tag information of the workgroup.
Key	string	The tag key of the workgroup.	TestKey
Value	string	The tag value of the workgroup.	TestValue

Exemples

JSON format

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

Codes d'erreur

Code de statut HTTP	Code d'erreur	Message d'erreur	Description
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.
403	Forbidden.Unauthorized	A required authorization for the specified action is not supplied.

Consultez Codes d'erreur pour la liste complète.

Notes de version

Consultez Notes de version pour la liste complète.