ListProjectRoles - DataWorks - Centre de documentation Alibaba Cloud

Retourne une liste paginée des rôles d'un espace de travail.

Description de l'opération

Cette fonctionnalité est disponible dans DataWorks Basic Edition et les éditions supérieures.

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.

dataworks:ListProjectRoles

list

*All Resource

*

Aucune

Paramètres de requête

Paramètre	Type	Requis	Description	Exemple
ProjectId	integer	Oui	L'identifiant de l'espace de travail DataWorks. Vous pouvez trouver cet identifiant sur la page Gestion des espaces de travail dans la console DataWorks.\n\nCe paramètre spécifie l'espace de travail DataWorks pour lequel vous souhaitez répertorier les rôles.	21229
Codes	array	Non	Un tableau des codes de rôles d'espace de travail.
	string	Non	Le code d'un rôle d'espace de travail. `role_project_admin` : Administrateur de l'espace de travail `role_project_dev` : Développeur `role_project_dg_admin` : Administrateur de la gouvernance des données `role_project_guest` : Invité `role_project_security` : Administrateur de la sécurité `role_project_deploy` : Déployeur `role_project_owner` : Propriétaire de l'espace de travail `role_project_data_analyst` : Analyste de données `role_project_pe` : Exploitation et maintenance `role_project_erd` : Concepteur de modèles	role_project_guest
Names	array	Non	Un tableau des noms de rôles d'espace de travail.
	string	Non	Le nom d'un rôle d'espace de travail.	Visiteurs
Type	string	Non	Le type du rôle de l'espace de travail. `UserCustom` : Rôle personnalisé `System` : Rôle système	System
PageNumber	integer	Non	Le numéro de page à renvoyer.	1
PageSize	integer	Non	Le nombre d'entrées à renvoyer par page. Valeur par défaut : 10. Valeur maximale : 100.	10

Éléments de réponse

Élément	Type	Description	Exemple
	object	Le schéma de la réponse.
RequestId	string	L'identifiant de la requête. Utilisez cet identifiant pour localiser les journaux et résoudre les problèmes.	61649187-0BCF-5E75-8D4B-64FDBEBBB447
PagingInfo	object	Les informations de pagination.
PageSize	string	Le nombre d'entrées par page.	10
PageNumber	string	Le numéro de page renvoyé.	1
TotalCount	string	Le nombre total d'entrées correspondantes.	42
ProjectRoles	array<object>	Une liste des rôles d'espace de travail.
	array<object>	Les détails d'un rôle d'espace de travail.
ProjectId	integer	The ID of the DataWorks workspace. Note: For system-defined roles, this parameter returns -1.	21229
Code	string	The code of the workspace role.	role_project_guest
Name	string	The name of the workspace role.	Visitors
Type	string	The type of the workspace role.	System
ModulePermissions	array<object>
	object
ModuleId	integer		2
ModuleName	string		HoloStudio
PermissionType	string		Read

Exemples

JSON format

{
  "RequestId": "61649187-0BCF-5E75-8D4B-64FDBEBBB447",
  "PagingInfo": {
    "PageSize": "10",
    "PageNumber": "1",
    "TotalCount": "42",
    "ProjectRoles": [
      {
        "ProjectId": 21229,
        "Code": "role_project_guest\n",
        "Name": "Visitors",
        "Type": "System",
        "ModulePermissions": [
          {
            "ModuleId": 2,
            "ModuleName": "HoloStudio",
            "PermissionType": "Read"
          }
        ]
      }
    ]
  }
}

Codes d'erreur

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

Notes de version

Consultez Notes de version pour la liste complète.