ListResourceGroups - - Centre de documentation Alibaba Cloud

Débogage

OpenAPI Explorer calcule automatiquement la valeur de signature. Nous vous recommandons d'appeler cette opération via OpenAPI Explorer, qui génère dynamiquement des exemples de code pour différents SDK.

Paramètres de requête

Parameter	Type	Required	Example	Description
Action	String	Yes	ListResourceGroups	L'opération à effectuer. Définissez la valeur sur ListResourceGroups.
ResourceGroupType	Integer	Yes	3	Le type des groupes de ressources à interroger. Valeurs acceptées : 0 : DataWorks 1 : planification (scheduling) 2 : MaxCompute 3 : Platform for AI (PAI) 4 : Data Integration 7 : groupe de ressources exclusif pour la planification (un ID est généré pour la ressource lors de l'achat du groupe). 9 : DataService Studio Valeur par défaut : 1 Si la valeur correspond à un moteur de calcul, les groupes de ressources interrogés sont ceux créés lors de l'achat du moteur.
Keyword	String	No	abc	Mot-clé utilisé pour la recherche floue par nom et identifiant du groupe de ressources.
BizExtKey	String	No	default	Catégorie des groupes de ressources. Valeurs acceptées : default : groupe de ressources partagé single : groupe de ressources exclusif Valeur par défaut : default
ResourceManagerResourceGroupId	String	No	rg-acfmzbn7pti3zfa	ID du groupe de ressources.
Tags	Array	No		Tags.
Key	String	No	Env	Clé du tag.
Value	String	No	Test	Valeur du tag.

Paramètres de réponse

Parameter	Type	Example	Description
HttpStatusCode	Integer	200	Code d'état HTTP renvoyé.
RequestId	String	0bc1411515937635973****	ID de la requête. Utilisez cet ID pour localiser les journaux et résoudre les problèmes.
Success	Boolean	true	Indique si la requête a abouti.
Data	Array of Data		Groupes de ressources.
Status	Integer	0	État du groupe de ressources. Valeurs acceptées : 0 : NORMAL, le groupe de ressources est en cours d'exécution ou actif. 1 : STOP, le groupe de ressources a expiré et est gelé. 2 : DELETED, le groupe de ressources est libéré ou détruit. 3 : CREATING, le groupe de ressources est en cours de création ou de démarrage. 4 : CREATE_FAILED, échec de la création ou du démarrage du groupe de ressources. 5 : UPDATING, le groupe de ressources est en cours de mise à l'échelle ou de mise à niveau. 6 : UPDATE_FAILED, échec de la mise à l'échelle ou de la mise à niveau du groupe de ressources. 7 : DELETING, le groupe de ressources est en cours de libération ou de destruction. 8 : DELETE_FAILED, échec de la libération ou de la destruction du groupe de ressources. 9 : TIMEOUT, délai d'expiration de l'opération sur le groupe de ressources. Toutes les opérations peuvent expirer. Cette valeur n'est temporairement disponible que pour DataService Studio.
UpdateTime	String	Jul 9, 2018 2:43:37 PM	Date de la dernière mise à jour du groupe de ressources.
IsDefault	Boolean	true	Indique si le groupe de ressources est le groupe par défaut. Valeurs acceptées : true : Le groupe de ressources est le groupe par défaut. false : Le groupe de ressources n'est pas le groupe par défaut.
Cluster	String	AY18G	Nom du cluster. Ce paramètre n'est renvoyé que si le type de groupe de ressources est MaxCompute ou PAI.
EnableKp	Boolean	false	Indique si l'UID d'un compte Alibaba Cloud est utilisé pour l'accès. Valeurs acceptées : true : Le moteur de calcul MaxCompute utilise l'UID du compte Alibaba Cloud comme nom d'affichage pour l'accès. false : Le moteur de calcul MaxCompute utilise le nom du compte Alibaba Cloud comme nom d'affichage pour l'accès. Les autres valeurs sont ignorées. Ce paramètre n'est renvoyé que si le type de groupe de ressources est MaxCompute.
ResourceGroupType	String	3	Type du groupe de ressources. Valeurs acceptées : 0 : DataWorks 2 : MaxCompute 3 : PAI 4 : Data Integration 7 : planification (scheduling) 9 : DataService Studio
CreateTime	String	Jul 9, 2018 2:43:37 PM	Date de création du cluster. Exemple : Jul 9, 2018 02:43:37 PM.
Identifier	String	e1815577-2f4e-4c5e-b29****	Identifiant du groupe de ressources.
Mode	String	SHARE	Mode du groupe de ressources. Valeurs acceptées : ISOLATE : groupe de ressources exclusif avec facturation par abonnement SHARE : groupe de ressources partagé avec facturation au paiement à l'utilisation DEVELOP : groupe de ressources pour les développeurs
BizExtKey	String	default	Catégorie du groupe de ressources. Valeurs acceptées : default : groupe de ressources partagé single : groupe de ressources exclusif
Sequence	Integer	300	Numéro de séquence du groupe de ressources. Les groupes créés sont triés par ordre croissant selon ce numéro.
Specs	Map		Détails du groupe de ressources. Le contenu entre accolades {} correspond aux détails du groupe.
Name	String	abc	Nom du groupe de ressources.
Id	Long	1234567	ID du groupe de ressources.
TenantId	Long	1234567	ID du locataire.
ResourceManagerResourceGroupId	String	rg-acfmzbn7pti3zfa	ID de votre groupe de ressources Alibaba Cloud.
Tags	Array of Tag		Tags.
Key	String	Env	Clé du tag.
Value	String	Test	Valeur du tag.

Exemples

Exemple de requête

http(s)://[Endpoint]/?Action=ListResourceGroups
&ResourceGroupType=3
&Keyword=abc
&BizExtKey=default
&ResourceManagerResourceGroupId=rg-acfmzbn7pti3zfa
&Tags=[{"Key":"Env","Value":"Test"}]
&<Common request parameters>

Exemple de réponse réussie

XML format

HTTP/1.1 200 OK
Content-Type:application/xml

<ListResourceGroupsResponse>
    <HttpStatusCode>200</HttpStatusCode>
    <RequestId>0bc1411515937635973****</RequestId>
    <Success>true</Success>
    <Data>
        <Status>0</Status>
        <UpdateTime>Jul 9, 2018 2:43:37 PM</UpdateTime>
        <IsDefault>true</IsDefault>
        <Cluster>AY18G</Cluster>
        <EnableKp>false</EnableKp>
        <ResourceGroupType>3</ResourceGroupType>
        <CreateTime>Jul 9, 2018 2:43:37 PM</CreateTime>
        <Identifier>e1815577-2f4e-4c5e-b29****</Identifier>
        <Mode>SHARE</Mode>
        <BizExtKey>default</BizExtKey>
        <Sequence>300</Sequence>
        <Name>abc</Name>
        <Id>1234567</Id>
        <TenantId>1234567</TenantId>
        <ResourceManagerResourceGroupId>rg-acfmzbn7pti3zfa</ResourceManagerResourceGroupId>
        <Tags>
            <Key>Env</Key>
            <Value>Test</Value>
        </Tags>
    </Data>
</ListResourceGroupsResponse>

JSON format

HTTP/1.1 200 OK
Content-Type:application/json

{
  "HttpStatusCode" : 200,
  "RequestId" : "0bc1411515937635973****",
  "Success" : true,
  "Data" : [ {
    "Status" : 0,
    "UpdateTime" : "Jul 9, 2018 2:43:37 PM",
    "IsDefault" : true,
    "Cluster" : "AY18G",
    "EnableKp" : false,
    "ResourceGroupType" : "3",
    "CreateTime" : "Jul 9, 2018 2:43:37 PM",
    "Identifier" : "e1815577-2f4e-4c5e-b29****",
    "Mode" : "SHARE",
    "BizExtKey" : "default",
    "Sequence" : 300,
    "Name" : "abc",
    "Id" : 1234567,
    "TenantId" : 1234567,
    "ResourceManagerResourceGroupId" : "rg-acfmzbn7pti3zfa",
    "Tags" : [ {
      "Key" : "Env",
      "Value" : "Test"
    } ]
  } ]
}

Codes d'erreur

HTTP status code	Error code	Error message	Description
400	Invalid.Tenant.ConnectionNotExists	The connection does not exist.	La source de données spécifiée n'existe pas.
400	Invalid.Tenant.ProjectNotExists	The project does not exist.	L'espace de travail spécifié n'existe pas.
400	Invalid.Tenant.UserNotInProject	The user is not in the project.	L'utilisateur n'a pas été ajouté à l'espace de travail.
403	Invalid.Tenant.UserIsNotProjectOwnerOrAdmin	The user is not a project administrator or owner.	L'utilisateur n'est pas le propriétaire ou l'administrateur de l'espace de travail.
403	Invalid.Tenant.UserNotInTenant	The user is not in tenant.	L'utilisateur n'appartient pas au locataire.

Pour la liste des codes d'erreur, consultez les Codes d'erreur de service.