GetProject - - Centre de documentation Alibaba Cloud

Consulte les informations de base d'un projet MaxCompute.

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.

odps:GetProject

get

*Projet.

acs:odps:{#regionId}:{#accountId}:projects/{#ProjectName}

Aucune

Syntaxe de la requête

GET /api/v1/projects/{projectName} HTTP/1.1

Paramètres de chemin

Paramètre	Type	Requis	Description	Exemple
projectName	string	Oui	Le nom du projet.	odps_project

Paramètres de requête

Paramètre	Type	Requis	Description	Exemple
verbose	boolean	Non	Indique si des informations supplémentaires doivent être incluses (securityProperties, superAdmins).	true
withStorageTierInfo	boolean	Non	Indique si des informations supplémentaires doivent être incluses (properties.storageTierInfo).	true
withQuotaProductType	boolean	Non	Indique si des informations supplémentaires doivent être incluses (productType).	true

Éléments de réponse

Élément	Type	Description	Exemple
	object	Les paramètres de réponse.
data	object	Les données de réponse.
comment	string	La description du projet.	BI_Analysis
costStorage	string	La taille totale de stockage. Indique la taille de stockage actuelle du projet. Cette taille de stockage est conforme à la norme de comptage, qui correspond à la taille de stockage logique après collecte et compression des données au niveau du projet.	16489027
createdTime	integer	L'heure de création.	1704380838000
defaultQuota	string	Le quota de calcul par défaut. Utilisé pour l'allocation des ressources de calcul. Si aucun quota de calcul n'est spécifié, les tâches lancées par ce projet consomment les ressources du quota par défaut. Pour plus d'informations sur l'utilisation des ressources de calcul, consultez Ressources de calcul - Utilisation des quotas.	os_PayAsYouGoQuota
ipWhiteList	object	La liste blanche d'adresses IP.
ipList	string	La liste blanche d'adresses IP pour Internet et le réseau d'interconnexion des services cloud. Remarque Si seule la liste blanche d'adresses IP pour Internet et le réseau d'interconnexion des services cloud est configurée, l'accès depuis Internet et le réseau d'interconnexion des services cloud est restreint par cette configuration, et tout accès au réseau VPC est interdit.	10.88.111.3
vpcIpList	string	La liste blanche d'adresses IP pour les réseaux VPC. Remarque Si seule la liste blanche d'adresses IP pour le réseau VPC est configurée, l'accès au réseau VPC est restreint par cette configuration, et tout accès depuis Internet et le réseau d'interconnexion des services cloud est interdit.	10.88.111.3
name	string	Le nom du projet.	odps_project
owner	string	Les informations de compte du propriétaire du projet.	ALIYUN$odps****@aliyunid.com
productType	string	La méthode de facturation du quota de calcul par défaut.	PayAsYouGo
properties	object	Les propriétés de base du projet.
allowFullScan	boolean	Indique si les analyses complètes de table sont autorisées dans le projet. Les analyses complètes de table consomment une grande quantité de ressources. Pour améliorer l'efficacité du traitement, cette fonctionnalité est désactivée par défaut.	false
autoMvQuotaGb	integer
elderTunnelQuota	string	Le groupe parent du groupe de ressources EPS de transfert de données rattaché au projet. Vous pouvez ignorer ce paramètre.	Default_p
enableAutoMv	boolean
enableDataMasking	boolean
enableDecimal2	boolean	Indique si le type de données Decimal de MaxCompute 2.0 est activé pour le projet.	true
enableDr	boolean
enableFdcCacheForce	boolean	Indique s'il faut activer de force la mise en cache des tables externes.	true
enableTieredStorage	boolean	Indique si le stockage hiérarchisé est activé.	true
enableTunnelQuotaRoute	boolean	Indique si le routage du groupe de ressources EPS de transfert de données est activé. true : les tâches de transfert de données soumises par ce projet utilisent par défaut le groupe de ressources EPS de transfert de données lié. false : les tâches de transfert de données soumises par ce projet utilisent par défaut le groupe de ressources EPS de transfert de données partagé.	true
encryption	object	Les propriétés de chiffrement du stockage.
algorithm	string	L'algorithme de chiffrement des données. Les algorithmes de chiffrement pris en charge incluent AES256, AESCTR et RC4.	AES256
enable	boolean	Indique si le chiffrement des données est activé pour le projet. Pour plus d'informations sur le chiffrement des données, consultez Chiffrement du stockage.	true
key	string	Le type de clé utilisé pour le chiffrement des données, y compris la clé par défaut (MaxCompute Default Key) et Bring Your Own Key (BYOK). La clé par défaut (MaxCompute Default Key) est une clé par défaut créée en interne par MaxCompute.	dafault
externalProjectProperties	object	Les propriétés du projet externe.
externalCatalogId	string
foreignServerName	string
foreignServerType	string
isExternalCatalogBound	string	Indique s'il s'agit d'un projet externe Data Lakehouse Solution 2.0.	true
tableFormat	string
warehouse	string
fdcQuota	string	Le quota de cache des tables externes.	fdc_quota
retentionDays	integer	Le nombre de jours pendant lesquels les données de sauvegarde sont conservées. Pendant cette période, vous pouvez restaurer la version actuelle vers n'importe quelle version de données sauvegardée. Valeurs valides : 0 à 30. Valeur par défaut : 1. Une valeur de 0 indique que la fonctionnalité de sauvegarde est désactivée.	1
sqlMeteringMax	string	Le seuil maximum pour une seule instruction SQL. Unité : volume d'analyse (Go) × complexité.	1500
storageTierInfo	object	Les informations sur le stockage hiérarchisé.
projectBackupSize	integer	La taille de stockage de sauvegarde.	86672917
projectTotalSize	integer	L'utilisation totale du stockage.	56066037
storageTierSize	object	Les informations sur le stockage hiérarchisé.
longTermSize	integer	L'utilisation du stockage à long terme.	21764917
lowFrequencySize	integer	L'utilisation du stockage à basse fréquence.	767693
standardSize	integer	L'utilisation du stockage standard.	27649172
tableLifecycle	object	Les propriétés de cycle de vie de la table.
type	string	Le type de cycle de vie. Valeurs valides : mandatory : la clause Lifecycle est requise. Vous devez définir le cycle de vie de la table. optional : la clause Lifecycle est facultative lors de la création d'une table. Si le cycle de vie n'est pas défini, la table est valide de façon permanente. inherit : si le cycle de vie n'est pas défini lors de la création d'une table, le cycle de vie de la table correspond à la valeur de odps.table.lifecycle.value.	optional
value	string	Le cycle de vie de la table. Unité : jours. Valeurs valides : 1 à 37231. Valeur par défaut : 37231.	37231
tableLifecycleConfig	object	Les propriétés des règles de cycle de vie du stockage hiérarchisé. Après configuration, le système déclenche automatiquement la conversion des niveaux de stockage en fonction de ces règles.
TierToLongterm	object	L'identifiant de stockage à long terme.
DaysAfterLastAccessGreaterThan	integer	Le nombre de jours après l'heure du dernier accès aux données avant que le paramètre ne soit automatiquement appliqué. Cela correspond à la `LastAccessTime` de la table ou de la partition. Remarque Si la LastAccessTime de la table ou de la partition est vide : Pour les tables ou partitions créées avant le 1er octobre 2023, le calcul utilise par défaut la date du 2023.10.01 00:00:00 dans le fuseau horaire UTC+0. Pour les tables ou partitions créées après le 1er octobre 2023, si les données n'ont pas été consultées, le calcul est basé sur la CreateTime.	180
DaysAfterLastModificationGreaterThan	integer	Le nombre de jours après l'heure de la dernière modification des données avant que le paramètre ne soit automatiquement appliqué. Cela correspond à la `LastModifiedTime` de la table ou de la partition.	180
DaysAfterLastTierModificationGreaterThan	integer	Le nombre de jours depuis la dernière conversion de niveau de stockage.	1
TierToLowFrequency	object	L'identifiant de stockage à basse fréquence.
DaysAfterLastAccessGreaterThan	integer	Le nombre de jours après l'heure du dernier accès aux données avant que le paramètre ne soit automatiquement appliqué. Cela correspond à la `LastAccessTime` de la table ou de la partition. Remarque Si la LastAccessTime de la table ou de la partition est vide : Pour les tables ou partitions créées avant le 1er octobre 2023, le calcul utilise par défaut la date du 2023.10.01 00:00:00 dans le fuseau horaire UTC+0. Pour les tables ou partitions créées après le 1er octobre 2023, si les données n'ont pas été consultées, le calcul est basé sur la CreateTime.	30
DaysAfterLastModificationGreaterThan	integer	Le nombre de jours après l'heure de la dernière modification des données avant que le paramètre ne soit automatiquement appliqué. Cela correspond à la `LastModifiedTime` de la table ou de la partition.	30
DaysAfterLastTierModificationGreaterThan	integer	Le nombre de jours depuis la dernière conversion de niveau de stockage.	1
timezone	string	Le fuseau horaire du projet, qui correspond à la propriété `odps.sql.timezone`.	Asia/Shanghai
tunnelQuota	string	Le groupe de ressources du service de transfert de données lié au projet. Par défaut (groupe de ressources EPS de transfert de données partagé) : le projet n'est pas autorisé à utiliser un groupe de ressources de service de transfert de données (abonnement). Quel que soit le paramètre du groupe de ressources EPS de transfert de données par défaut, les tâches de transfert de données soumises par ce projet utilisent automatiquement le groupe de ressources par défaut. Groupe de ressources de service de transfert de données (abonnement) : le projet est autorisé à utiliser un groupe de ressources de service de transfert de données (abonnement).	Default
typeSystem	string	La version du type de données. Valeurs valides : 1 : version 1.0 2 : version 2.0 hive : type compatible avec Hive Pour connaître les différences entre les trois versions de types de données, consultez Éditions de types de données.	2.0
regionId	string	L'identifiant de la région.	cn-beijing
saleTag	object	L'identifiant d'instance et le type de facturation du quota de calcul par défaut.
resourceId	string	L'identifiant d'instance du quota de calcul par défaut.	b7afb7d1-**--**-c393669c307b
resourceType	string	Le type de facturation du quota de calcul par défaut.	PayAsYouGo
securityProperties	object	Les propriétés de sécurité.
enableDownloadPrivilege	boolean	Indique si la fonctionnalité de contrôle des autorisations de téléchargement est activée. Cette fonctionnalité est désactivée par défaut.	false
enableNamespacePrivilege	boolean	Indique s'il faut activer les autorisations IAM.
labelSecurity	boolean	Indique si la fonctionnalité de contrôle d'accès basé sur les étiquettes est activée. Cette fonctionnalité est désactivée par défaut.	false
objectCreatorHasAccessPermission	boolean	Indique si les créateurs d'objets sont autorisés à disposer d'autorisations d'accès sur les objets qu'ils créent. Cette option est activée par défaut.	true
objectCreatorHasGrantPermission	boolean	Indique si les créateurs d'objets sont autorisés à disposer d'autorisations d'octroi sur les objets qu'ils créent. Cette option est activée par défaut.	true
projectProtection	object	Les propriétés de protection des données.
exceptionPolicy	string	Si la protection des données du projet est activée, vous pouvez définir des exceptions ou des projets de confiance pour autoriser des utilisateurs spécifiés à exporter les données d'objets spécifiés vers des projets spécifiés. Tous les scénarios décrits dans la stratégie d'exception peuvent contourner le mécanisme de protection des données.	{ "Version": "1", "Statement": [ { "Effect": "Allow", "Principal": "", "Action": [ "odps:[, , ...]" ], "Resource": "acs:odps:*:", "Condition": { "StringEquals": { "odps:TaskType": [ "" ] } } } ] }
protected	boolean	Indique l'état d'activation du mécanisme de protection des données pour le projet, qui interdit ou autorise le flux de données à sortir du projet. Cette option est désactivée par défaut.	true
usingAcl	boolean	Indique si la fonctionnalité de contrôle d'accès basé sur les ACL est activée. Cette fonctionnalité est activée par défaut.	true
usingPolicy	boolean	Indique si la fonctionnalité de contrôle d'accès basé sur les stratégies est activée. Cette fonctionnalité est activée par défaut.	true
status	string	L'état du projet. Valeurs valides : AVAILABLE : normal. READONLY : lecture seule. FROZEN : gelé. DELETING : en cours de suppression.	AVAILABLE
superAdmins	array	La liste des membres ayant le rôle `Super_Administrator` dans le projet.
	string	Les informations de compte des comptes membres ayant le rôle `Super_Administrator` dans le projet.	RAM$odps****@aliyunid.com:RAM_USER
threeTierModel	boolean	Indique si le stockage basé sur des schémas est pris en charge. MaxCompute prend en charge les schémas, qui sont des objets situés sous un projet et au-dessus des tables, des ressources et des UDF, utilisés pour catégoriser les tables, les ressources et les UDF. Un projet peut contenir plusieurs schémas. Pour plus d'informations, consultez Opérations sur les schémas.	true
type	string	Le type de projet. Valeurs valides : managed : projet interne. external : projet externe.	managed
errorCode	string	Le code d'erreur.	OBJECT_NOT_EXIST
errorMsg	string	Le message d'erreur.	Cet objet n'existe pas
httpCode	integer	Le code d'état HTTP. 1xx : réponse informative - la requête a été reçue et est en cours de traitement. 2xx : succès - la requête a été reçue, comprise et acceptée avec succès par le serveur. 3xx : redirection - la requête a été redirigée. Une action supplémentaire est nécessaire pour terminer la requête. 4xx : erreur client - la requête contient des paramètres invalides, des erreurs de syntaxe ou des conditions de requête spécifiques qui ne peuvent pas être satisfaites. 5xx : erreur serveur - le serveur ne peut pas satisfaire la requête pour d'autres raisons.	200
requestId	string	L'identifiant de la requête.	0b87b7b316643495896551555e855b

Exemples

JSON format

{
  "data": {
    "comment": "BI_Analysis",
    "costStorage": "16489027",
    "createdTime": 1704380838000,
    "defaultQuota": "os_PayAsYouGoQuota",
    "ipWhiteList": {
      "ipList": "10.88.111.3",
      "vpcIpList": "10.88.111.3"
    },
    "name": "odps_project",
    "owner": "ALIYUN$odps****@aliyunid.com",
    "productType": "PayAsYouGo",
    "properties": {
      "allowFullScan": false,
      "autoMvQuotaGb": 0,
      "elderTunnelQuota": "Default_p",
      "enableAutoMv": false,
      "enableDataMasking": false,
      "enableDecimal2": true,
      "enableDr": false,
      "enableFdcCacheForce": true,
      "enableTieredStorage": true,
      "enableTunnelQuotaRoute": true,
      "encryption": {
        "algorithm": "AES256",
        "enable": true,
        "key": "dafault"
      },
      "externalProjectProperties": {
        "externalCatalogId": "",
        "foreignServerName": "",
        "foreignServerType": "",
        "isExternalCatalogBound": "true",
        "tableFormat": "",
        "warehouse": ""
      },
      "fdcQuota": "fdc_quota",
      "retentionDays": 1,
      "sqlMeteringMax": "1500",
      "storageTierInfo": {
        "projectBackupSize": 86672917,
        "projectTotalSize": 56066037,
        "storageTierSize": {
          "longTermSize": 21764917,
          "lowFrequencySize": 767693,
          "standardSize": 27649172
        }
      },
      "tableLifecycle": {
        "type": "optional",
        "value": "37231"
      },
      "tableLifecycleConfig": {
        "TierToLongterm": {
          "DaysAfterLastAccessGreaterThan": 180,
          "DaysAfterLastModificationGreaterThan": 180,
          "DaysAfterLastTierModificationGreaterThan": 1
        },
        "TierToLowFrequency": {
          "DaysAfterLastAccessGreaterThan": 30,
          "DaysAfterLastModificationGreaterThan": 30,
          "DaysAfterLastTierModificationGreaterThan": 1
        }
      },
      "timezone": "Asia/Shanghai",
      "tunnelQuota": "Default",
      "typeSystem": "2.0"
    },
    "regionId": "cn-beijing",
    "saleTag": {
      "resourceId": "b7afb7d1-****-****-****-c393669c307b",
      "resourceType": "PayAsYouGo"
    },
    "securityProperties": {
      "enableDownloadPrivilege": false,
      "enableNamespacePrivilege": false,
      "labelSecurity": false,
      "objectCreatorHasAccessPermission": true,
      "objectCreatorHasGrantPermission": true,
      "projectProtection": {
        "exceptionPolicy": "{",
        "protected": true
      },
      "usingAcl": true,
      "usingPolicy": true
    },
    "status": "AVAILABLE",
    "superAdmins": [
      "RAM$odps****@aliyunid.com:RAM_USER"
    ],
    "threeTierModel": true,
    "type": "managed"
  },
  "errorCode": "OBJECT_NOT_EXIST",
  "errorMsg": "Cet objet n'existe pas",
  "httpCode": 200,
  "requestId": "0b87b7b316643495896551555e855b"
}

Codes d'erreur

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

Notes de version

Consultez Notes de version pour la liste complète.