Referensi API GetProject: Metadata Proyek & Otorisasi-MaxCompute-Alibaba Cloud - MaxCompute

Mengkueri informasi dasar sebuah proyek MaxCompute.

Coba sekarang

Coba API ini di OpenAPI Explorer tanpa perlu penandatanganan manual. Panggilan yang berhasil akan secara otomatis menghasilkan contoh kode SDK sesuai dengan parameter Anda. Unduh kode tersebut dengan kredensial bawaan yang aman untuk penggunaan lokal.

Test

RAM authorization

Tabel berikut menjelaskan otorisasi yang diperlukan untuk memanggil API ini. Anda dapat menentukannya dalam kebijakan Resource Access Management (RAM). Kolom pada tabel dijelaskan sebagai berikut:

Action: Aksi yang dapat digunakan dalam elemen Action pada pernyataan kebijakan izin RAM untuk memberikan izin guna melakukan operasi tersebut.
API: API yang dapat Anda panggil untuk melakukan aksi tersebut.
Access level: Tingkat akses yang telah ditentukan untuk setiap API. Nilai yang valid: create, list, get, update, dan delete.
Resource type: Jenis resource yang mendukung otorisasi untuk melakukan aksi tersebut. Ini menunjukkan apakah aksi tersebut mendukung izin tingkat resource. Resource yang ditentukan harus kompatibel dengan aksi tersebut. Jika tidak, kebijakan tersebut tidak akan berlaku.
- Untuk API dengan izin tingkat resource, jenis resource yang diperlukan ditandai dengan tanda bintang (*). Tentukan Nama Sumber Daya Alibaba Cloud (ARN) yang sesuai dalam elemen Resource pada kebijakan.
- Untuk API tanpa izin tingkat resource, ditampilkan sebagai All Resources. Gunakan tanda bintang (*) dalam elemen Resource pada kebijakan.
Condition key: Kunci kondisi yang didefinisikan oleh layanan. Kunci ini memungkinkan kontrol granular, berlaku baik hanya untuk aksi maupun untuk aksi yang terkait dengan resource tertentu. Selain kunci kondisi spesifik layanan, Alibaba Cloud menyediakan serangkaian common condition keys yang berlaku di semua layanan yang didukung RAM.
Dependent action: Aksi dependen yang diperlukan untuk menjalankan aksi tersebut. Untuk menyelesaikan aksi tersebut, pengguna RAM atau role RAM harus memiliki izin untuk melakukan semua aksi dependen.

Action

Access level

Resource type

Condition key

Dependent action

odps:GetProject

get

*Project

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

None

Sintaks permintaan

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

Path Parameters

Parameter	Type	Required	Description	Example
projectName	string	Yes	Nama proyek.	odps_project

Parameter permintaan

Parameter	Type	Required	Description	Example
verbose	boolean	No	Apakah akan menyertakan informasi tambahan (securityProperties, superAdmins).	true
withStorageTierInfo	boolean	No	Apakah akan menyertakan informasi tambahan (properties.storageTierInfo).	true
withQuotaProductType	boolean	No	Apakah akan menyertakan informasi tambahan (productType).	true

Elemen respons

Element	Type	Description	Example
	object	Parameter tanggapan.
requestId	string	ID permintaan.	0b87b7b316643495896551555e855b
httpCode	integer	Kode status HTTP. 1xx: Tanggapan informasi - Permintaan telah diterima dan sedang diproses. 2xx: Berhasil - Permintaan telah berhasil diterima, dipahami, dan diterima oleh server. 3xx: Pengalihan - Permintaan telah dialihkan. Diperlukan aksi lebih lanjut untuk menyelesaikan permintaan. 4xx: Error klien - Permintaan berisi parameter yang salah, kesalahan sintaks, atau kondisi permintaan tertentu tidak dapat dipenuhi. 5xx: Error server - Server tidak dapat memenuhi permintaan karena alasan lain.	200
errorCode	string	Kode kesalahan.	OBJECT_NOT_EXIST
errorMsg	string	Paket kesalahan.	This object does not exist.
data	object	Hasil tanggapan.
name	string	Nama proyek.	odps_project
owner	string	Informasi akun pemilik proyek.	ALIYUN$odps****@aliyunid.com
type	string	Tipe proyek. Nilai valid: managed: proyek internal. external: proyek eksternal.	managed
comment	string	Deskripsi proyek.	BI_Analysis
defaultQuota	string	Kuota komputasi default. Digunakan untuk mengalokasikan sumber daya komputasi. Jika tidak ada kuota komputasi yang ditentukan, pekerjaan yang dimulai oleh proyek ini akan mengonsumsi sumber daya dari kuota default. Untuk informasi lebih lanjut tentang penggunaan sumber daya komputasi, lihat Sumber Daya Komputasi - Penggunaan Kuota.	os_PayAsYouGoQuota
status	string	Status proyek. Nilai valid: AVAILABLE: normal. READONLY: hanya baca. FROZEN: dibekukan. DELETING: sedang dihapus.	AVAILABLE
productType	string	Mode penagihan kuota komputasi default.	PayAsYouGo
threeTierModel	boolean	Apakah penyimpanan berbasis schema didukung. MaxCompute mendukung Schema, yang merupakan objek antara Project dan Table/Resource/UDF untuk mengkategorikan Table, Resource, dan UDF. Sebuah Project dapat berisi beberapa Schema. Untuk informasi lebih lanjut, lihat Operasi Schema.	true
costStorage	string	Ukuran penyimpanan total. Menampilkan ukuran penyimpanan proyek saat ini. Ukuran penyimpanan ini konsisten dengan kaliber pengukuran, yaitu ukuran penyimpanan logis setelah kompresi di tingkat Project.	16489027
regionId	string	ID wilayah.	cn-beijing
createdTime	integer	Waktu pembuatan.	1704380838000
properties	object	The basic properties of the project.
timezone	string	The time zone of the project. This parameter corresponds to the `odps.sql.timezone` property.	Asia/Shanghai
retentionDays	integer	The retention period of backup data. Unit: days. During this period, you can restore the current data version to any backup version. The value can be an integer from 0 to 30. The default value is 1. A value of 0 indicates that the backup feature is disabled.	1
allowFullScan	boolean	Specifies whether to allow a full table scan in the project. A full table scan consumes a large amount of resources and reduces processing efficiency. By default, this feature is disabled.	false
typeSystem	string	The data type edition. Valid values: 1: V1.0 2: V2.0 hive: Hive-compatible For more information, see Data type editions.	2.0
enableDecimal2	boolean	Specifies whether to enable the DECIMAL data type of MaxCompute V2.0 for the project.	true
sqlMeteringMax	string	The maximum consumption threshold of a single SQL statement. Formula: Amount of scanned data (GB) × Complexity.	1500
tableLifecycle	object	The lifecycle properties of the table.
type	string	The lifecycle type. Valid values: mandatory: The Lifecycle clause is required. You must set a lifecycle for the table. optional: The Lifecycle clause is optional when you create a table. If you do not set a lifecycle for the table, the table is permanently valid. inherit: If you do not set a lifecycle for a table when you create it, the lifecycle of the table is the value of odps.table.lifecycle.value.	optional
value	string	The lifecycle of the table. Unit: days. The value can be an integer from 1 to 37231. The default value is 37231.	37231
encryption	object	The storage encryption properties.
enable	boolean	Specifies whether to enable data encryption for the project. For more information, see Storage encryption.	true
algorithm	string	The data encryption algorithm. Supported algorithms include AES256, AESCTR, and RC4.	AES256
key	string	The type of key used for data encryption. Valid values include MaxCompute Default Key and Bring-Your-Own-Key (BYOK). MaxCompute Default Key is a default key created within MaxCompute.	dafault
tunnelQuota	string	The Data Transmission Service resource group that is bound to the project. Default (shared Data Transmission Service resource group): The project cannot use a subscription Data Transmission Service resource group. Regardless of the value of the default Data Transmission Service resource group, the Data Transmission Service automatically uses the Default resource group for data transmission tasks that are submitted by default in the project. Subscription Data Transmission Service resource group: The project can use a subscription Data Transmission Service resource group.	Default
elderTunnelQuota	string	The parent resource group of the Data Transmission Service resource group that is bound to the project. This parameter is for internal use.	Default_p
enableTunnelQuotaRoute	boolean	Specifies whether to enable routing for the Data Transmission Service resource group. true: The data transmission tasks that are submitted by default in the project use the Data Transmission Service resource group that is bound to the project. false: The data transmission tasks that are submitted by default in the project use the shared Data Transmission Service resource group.	true
storageTierInfo	object	The tiered storage information.
storageTierSize	object	The tiered storage information.
standardSize	integer	The Standard storage usage.	27649172
longTermSize	integer	The long-term storage usage.	21764917
lowFrequencySize	integer	The IA storage class usage.	767693
projectTotalSize	integer	The total storage usage.	56066037
projectBackupSize	integer	The backup storage size.	86672917
fdcQuota	string	The quota for external table caching.	fdc_quota
enableFdcCacheForce	boolean	Specifies whether to forcefully enable external table caching.	true
enableTieredStorage	boolean	Specifies whether to enable tiered storage.	true
tableLifecycleConfig	object	The properties of the tiered storage lifecycle rule. After you set these properties, the system automatically triggers the conversion of storage classes based on the rule.
TierToLongterm	object	The identifier for the long-term storage class.
DaysAfterLastModificationGreaterThan	integer	The number of days after the data was last modified. After this period, the storage class is automatically changed. This corresponds to the `LastModifiedTime` of the table or partition.	180
DaysAfterLastAccessGreaterThan	integer	The number of days after the data was last accessed. After this period, the storage class is automatically changed. This corresponds to the `LastAccessTime` of the table or partition. Catatan If the LastAccessTime of the table or partition is empty: For tables or partitions that were created before October 1, 2023, the last access time is considered 00:00:00 on October 1, 2023 (UTC+0). For tables or partitions that were created on or after October 1, 2023, if the data has not been accessed, the creation time of the table or partition is considered the last access time.	180
DaysAfterLastTierModificationGreaterThan	integer	The number of days after the storage class was last changed.	1
TierToLowFrequency	object	The identifier for the IA storage class.
DaysAfterLastModificationGreaterThan	integer	The number of days after the data was last modified. After this period, the storage class is automatically changed. This corresponds to the `LastModifiedTime` of the table or partition.	30
DaysAfterLastAccessGreaterThan	integer	The number of days after the data was last accessed. After this period, the storage class is automatically changed. This corresponds to the `LastAccessTime` of the table or partition. Catatan If the LastAccessTime of the table or partition is empty: For tables or partitions that were created before October 1, 2023, the last access time is considered 00:00:00 on October 1, 2023 (UTC+0). For tables or partitions that were created on or after October 1, 2023, if the data has not been accessed, the creation time of the table or partition is considered the last access time.	30
DaysAfterLastTierModificationGreaterThan	integer	The number of days after the storage class was last changed.	1
externalProjectProperties	object	The properties of the external project.
isExternalCatalogBound	string	Specifies whether the project is an external project of data lakehouse 2.0.	true
tableFormat	string
warehouse	string
foreignServerName	string
foreignServerType	string
externalCatalogId	string
enableAutoMv	boolean
autoMvQuotaGb	integer
enableDr	boolean
enableDataMasking	boolean
superAdmins	array	Daftar anggota dengan peran `Super_Administrator` di proyek.
	string	Informasi akun anggota peran `Super_Administrator` di proyek.	RAM$odps****@aliyunid.com:RAM_USER
securityProperties	object	Properti izin.
usingAcl	boolean	Specifies whether to use the ACL-based access control feature. By default, this feature is enabled.	true
usingPolicy	boolean	Specifies whether to use the policy-based access control feature. By default, this feature is enabled.	true
objectCreatorHasAccessPermission	boolean	Specifies whether the creator of an object has access permissions on the object. Default value: true.	true
objectCreatorHasGrantPermission	boolean	Specifies whether the creator of an object has grant permissions on the object. Default value: true.	true
labelSecurity	boolean	Specifies whether to use the label-based access control feature. By default, this feature is disabled.	false
enableDownloadPrivilege	boolean	Specifies whether to use the download control feature. By default, this feature is disabled.	false
projectProtection	object	The properties of the data protection mechanism.
exceptionPolicy	string	If data protection is enabled for a project, you can configure an exception policy to specify exception or trusted projects. This policy allows specified users to transfer data from a specified object to a specified project. The data protection mechanism does not apply to the scenarios described in the exception policy.	{ "Version": "1", "Statement": [ { "Effect": "Allow", "Principal": "", "Action": [ "odps:[, , ...]" ], "Resource": "acs:odps:*:", "Condition": { "StringEquals": { "odps:TaskType": [ "" ] } } } ] }
protected	boolean	Specifies whether to enable the data protection mechanism for the project to prohibit or allow data to flow out of the project. By default, this mechanism is disabled.	true
ipWhiteList	object	Daftar putih IP.
ipList	string	The IP address whitelist for access over the Internet or a network that is used to interconnect with other Alibaba Cloud services. Catatan If you configure only this IP address whitelist, access over the Internet or the network that is used to interconnect with other Alibaba Cloud services is restricted based on the configuration, and access over a VPC is prohibited.	10.88.111.3
vpcIpList	string	The IP address whitelist for access over a VPC. Catatan If you configure only this IP address whitelist, access over a VPC is restricted based on the configuration, and access over the Internet or a network that is used to interconnect with other Alibaba Cloud services is prohibited.	10.88.111.3
saleTag	object	ID instans dan tipe penagihan kuota komputasi default.
resourceId	string	The instance ID of the default computing quota.	b7afb7d1-**--**-c393669c307b
resourceType	string	The billing method of the default computing quota.	PayAsYouGo

Contoh

Respons sukses

JSONformat

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

Kode kesalahan

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.