ListWorkspaces - - Centre de documentation Alibaba Cloud

Consulte la liste des espaces de travail du locataire.

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.

dms:ListWorkspaces

list

*All Resource

*

Aucune

Paramètres de requête

Paramètre	Type	Requis	Description	Exemple
AlreadyJoined	boolean	Non	Indique si l'utilisateur actuel a rejoint l'espace de travail.	true
SearchKey	string	Non	Le mot-clé de recherche. La correspondance approximative est prise en charge.	poc_test
Region	string	Non	La région dans laquelle le bucket est situé.	cn-hangzhou
ServiceAccountId	integer	Non	L'identifiant du compte de service.	12345
WorkspaceId	integer	Non	L'identifiant de l'espace de travail.	12****
PageNumber	integer	Non	Le numéro de page.	1
PageSize	integer	Non	Le nombre d'entrées par page.	10
VpcId	string	Non	L'identifiant du cloud privé virtuel (VPC).\n\n> Ce paramètre ne peut pas être utilisé comme filtre.	vpc-bp10wnlcmor****

Éléments de réponse

Élément	Type	Description	Exemple
	object
RequestId	string	L'identifiant de la requête.	EE214ECD-4330-503A-82F0-FFB03975****
ErrorCode	string	Le code d'erreur.	UserNotExist
ErrorMessage	string	Le message d'erreur renvoyé en cas d'échec de la requête.	UnknownError
Success	boolean	Indique si l'appel a réussi. Valeurs valides : true : La requête a réussi. false : La requête a échoué.	true
TotalCount	integer	Le nombre total d'espaces de travail qui remplissent les conditions.	10
Data	object
BaseWorkspaces	array<object>	Le jeu de données.
	object
Description	string	The description of the workspace.	Test
CreatorId	integer	The ID of the creator.	123
OwnerUid	string	The Alibaba Cloud UID of the owner.	15608564799****
WorkspaceId	integer	The workspace ID.	8652340494****
GmtModified	string	The update time.	2025-01-01 00:00:00
ServiceAccountId	integer	The ID of the service account.	12345
CreatorUid	string	The Alibaba Cloud account UID of the creator.	1344****
ServiceAccountNickName	string	The nickname of the service account.	testname
Name	string	The name of the workspace.	workspace-xxxx
AlreadyJoined	boolean	Whether the current user has joined the workspace.	true
TenantId	integer	The ID of the tenant to which the workspace belongs.	23456
GmtCreate	string	The creation time.	2025-01-01 00:00:00
ServiceAccountUid	string	The Alibaba Cloud account UID of the service account.	1422****
OwnerId	integer	The owner ID.	123****
VpcId	string	The VPC ID.	vpc-25fl3qjqb****
Region	string	The region ID.	cn-hangzhou
WorkspaceName	string	The name of the workspace.	test-workspace
CreatorNickName	string	The nickname of the creator.	work*****
OwnerNickName	string	The nickname of the owner.	hel****
NextToken	string	NextToken ne prend pas effet.	token-xxx
MaxResults	integer	Le nombre total d'espaces de travail qui remplissent la condition, ce qui correspond au paramètre TotalCount.	10

Exemples

JSON format

{
  "RequestId": "EE214ECD-4330-503A-82F0-FFB03975****",
  "ErrorCode": "UserNotExist",
  "ErrorMessage": "UnknownError",
  "Success": true,
  "TotalCount": 10,
  "Data": {
    "BaseWorkspaces": [
      {
        "Description": "Test",
        "CreatorId": 123,
        "OwnerUid": "15608564799****",
        "WorkspaceId": 0,
        "GmtModified": "2025-01-01 00:00:00",
        "ServiceAccountId": 12345,
        "CreatorUid": "1344****",
        "ServiceAccountNickName": "testname",
        "Name": "workspace-xxxx",
        "AlreadyJoined": true,
        "TenantId": 23456,
        "GmtCreate": "2025-01-01 00:00:00",
        "ServiceAccountUid": "1422****",
        "OwnerId": 0,
        "VpcId": "vpc-25fl3qjqb****",
        "Region": "cn-hangzhou",
        "WorkspaceName": "test-workspace",
        "CreatorNickName": "work*****",
        "OwnerNickName": "hel****"
      }
    ]
  },
  "NextToken": "token-xxx",
  "MaxResults": 10
}

Codes d'erreur

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

Notes de version

Consultez Notes de version pour la liste complète.