ListProjects - - Centre de documentation Alibaba Cloud

Débogage

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

Paramètres de requête

Paramètre

Type

Obligatoire

Exemple

Description

L'opération à effectuer. Définissez la valeur sur ListProjects.

|

| PageNumber | Integer | Oui | 1 |

Le numéro de page.

|

| PageSize | Integer | Non | 10 |

Le nombre d'entrées par page. Valeurs acceptées : 1 à 100. Valeur par défaut : 10.

|

L'ID du groupe de ressources.

|

Les tags.

|

| Key | String | Non | Env |

La clé du tag.

|

La valeur du tag.

|

Paramètres de réponse

Paramètre	Type	Exemple	Description
RequestId	String	20658801***	L'ID de la requête.
PageResult	Object		Les résultats renvoyés.
PageNumber	Integer	1	Le numéro de page.
PageSize	Integer	10	Le nombre d'entrées par page. Valeurs acceptées : 1 à 100. Valeur par défaut : 10.
TotalCount	Integer	123	Le nombre total d'entrées renvoyées.
ProjectList	Array of Project		Les espaces de travail DataWorks renvoyés.
ProjectStatusCode	String	AVAILABLE	Le code d'état de l'espace de travail. Valeurs acceptées : AVAILABLE : 0, indique que l'espace de travail fonctionne normalement. DELETED : 1, indique que l'espace de travail est supprimé. INITIALIZING : 2, indique que l'espace de travail est en cours d'initialisation. INIT_FAILED : 3, indique que l'initialisation de l'espace de travail a échoué. FORBIDDEN : 4, indique que l'espace de travail est désactivé manuellement. DELETING : 5, indique que l'espace de travail est en cours de suppression. DEL_FAILED : 6, indique que la suppression de l'espace de travail a échoué. FROZEN : 7, indique que l'espace de travail est gelé en raison de paiements impayés. UPDATING : 8, indique que l'espace de travail est en cours de mise à jour. Après avoir associé un moteur de calcul à l'espace de travail, le système initialise le moteur de calcul et met à jour l'espace de travail. UPDATE_FAILED : 9, indique que la mise à jour de l'espace de travail a échoué.
ProjectStatus	Integer	0	L'état de l'espace de travail. Valeurs acceptées : 0 : AVAILABLE, indique que l'espace de travail fonctionne normalement. 1 : DELETED, indique que l'espace de travail est supprimé. 2 : INITIALIZING, indique que l'espace de travail est en cours d'initialisation. 3 : INIT_FAILED, indique que l'initialisation de l'espace de travail a échoué. 4 : FORBIDDEN, indique que l'espace de travail est désactivé manuellement. 5 : DELETING, indique que l'espace de travail est en cours de suppression. 6 : DEL_FAILED, indique que la suppression de l'espace de travail a échoué. 7 : FROZEN, indique que l'espace de travail est gelé en raison de paiements impayés. 8 : UPDATING, indique que l'espace de travail est en cours de mise à jour. Après avoir associé un moteur de calcul à l'espace de travail, le système initialise le moteur de calcul et met à jour l'espace de travail. 9 : UPDATE_FAILED, indique que la mise à jour de l'espace de travail a échoué.
ProjectName	String	Test	Le nom de l'espace de travail.
ProjectIdentifier	String	test	L'identifiant de l'espace de travail.
ProjectId	Long	1212	L'ID de l'espace de travail.
ProjectDescription	String	Test	La description de l'espace de travail.
ProjectOwnerBaseId	String	122222	L'ID de l'utilisateur utilisé par le propriétaire de l'espace de travail.
ResourceManagerResourceGroupId	String	rg-acfmzbn7pti3zfa	L'ID du groupe de ressources.
Tags	Array of Tag		Les tags.
Key	String	Env	La clé du tag.
Value	String	Test	La valeur du tag.
DisableDevelopment	Boolean	true	Indique si le rôle Development est désactivé. Valeurs acceptées : false : activé true : désactivé Valeur par défaut : false
UseProxyOdpsAccount	Boolean	true	Indique si un compte proxy est utilisé pour accéder au moteur de calcul MaxCompute associé à l'espace de travail.
TablePrivacyMode	Integer	1	Indique si les tables MaxCompute de l'espace de travail sont visibles pour les utilisateurs d'un locataire. Valeurs acceptées : 0 : invisible 1 : visible
IsDefault	Integer	1	Indique si l'espace de travail est un espace de travail par défaut. Valeurs acceptées : 1 : L'espace de travail est un espace de travail par défaut. 0 : L'espace de travail n'est pas un espace de travail par défaut.

Exemples

Exemple de requête

http(s)://[Endpoint]/?Action=ListProjects
&PageNumber=1
&PageSize=10
&ResourceManagerResourceGroupId=rg-acfmzbn7pti3zfa
&Tags=[{"Key":"Env","Value":"Test"}]
&<Common request parameters>

Exemple de réponse réussie

Format XML

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

<ListProjectsResponse>
    <RequestId>20658801***</RequestId>
    <PageResult>
        <PageNumber>1</PageNumber>
        <PageSize>10</PageSize>
        <TotalCount>123</TotalCount>
        <ProjectList>
            <ProjectStatusCode>AVAILABLE</ProjectStatusCode>
            <ProjectStatus>0</ProjectStatus>
            <ProjectName>Test</ProjectName>
            <ProjectIdentifier>test</ProjectIdentifier>
            <ProjectId>1212</ProjectId>
            <ProjectDescription>Test</ProjectDescription>
            <ProjectOwnerBaseId>122222</ProjectOwnerBaseId>
            <ResourceManagerResourceGroupId>rg-acfmzbn7pti3zfa</ResourceManagerResourceGroupId>
            <Tags>
                <Key>Env</Key>
                <Value>Test</Value>
            </Tags>
            <DisableDevelopment>true</DisableDevelopment>
            <UseProxyOdpsAccount>true</UseProxyOdpsAccount>
            <TablePrivacyMode>1</TablePrivacyMode>
            <IsDefault>1</IsDefault>
        </ProjectList>
    </PageResult>
</ListProjectsResponse>

Format JSON

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

{
  "RequestId" : "20658801***",
  "PageResult" : {
    "PageNumber" : 1,
    "PageSize" : 10,
    "TotalCount" : 123,
    "ProjectList" : {
      "ProjectStatusCode" : "AVAILABLE",
      "ProjectStatus" : 0,
      "ProjectName" : "Test",
      "ProjectIdentifier" : "test",
      "ProjectId" : 1212,
      "ProjectDescription" : "Test",
      "ProjectOwnerBaseId" : "122222",
      "ResourceManagerResourceGroupId" : "rg-acfmzbn7pti3zfa",
      "Tags" : {
        "Key" : "Env",
        "Value" : "Test"
      },
      "DisableDevelopment" : true,
      "UseProxyOdpsAccount" : true,
      "TablePrivacyMode" : 1,
      "IsDefault" : 1
    }
  }
}

Codes d'erreur

Code d'état HTTP	Code d'erreur	Message d'erreur	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.UserAlreadyInProject	The user already exists in the project.	L'utilisateur à ajouter se trouve déjà dans l'espace de travail.
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 ni le propriétaire ni 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 consulter la liste des codes d'erreur, reportez-vous aux Codes d'erreur de service.