GetProject - MaxCompute

Mengambil informasi dasar tentang 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	Menentukan apakah akan menyertakan informasi tambahan, seperti securityProperties dan superAdmins.	true
withStorageTierInfo	boolean	No	Menentukan apakah akan menyertakan informasi tambahan, seperti properties.storageTierInfo.	true
withQuotaProductType	boolean	No	Menentukan apakah akan menyertakan informasi tambahan, seperti productType.	true

Elemen respons

Element	Type	Description	Example
	object	Parameter respons.
requestId	string	ID permintaan.	0b87b7b316643495896551555e855b
httpCode	integer	Kode status HTTP. 1xx: Respons informatif. Permintaan diterima dan sedang diproses. 2xx: Sukses. Permintaan berhasil diterima, dipahami, dan diterima oleh server. 3xx: Pengalihan. Permintaan dialihkan, dan tindakan lebih lanjut diperlukan untuk menyelesaikan permintaan. 4xx: Kesalahan klien. Permintaan berisi parameter atau sintaksis permintaan yang tidak valid, atau kondisi permintaan tertentu tidak dapat dipenuhi. 5xx: Kesalahan server. Server tidak dapat memenuhi permintaan karena alasan lain.	200
errorCode	string	Kode kesalahan.	OBJECT_NOT_EXIST
errorMsg	string	Pesan kesalahan.	This object does not exist.
data	object	Data yang dikembalikan.
name	string	Nama proyek.	odps_project
owner	string	Informasi akun pemilik proyek.	ALIYUN$odps****@aliyunid.com
type	string	Tipe proyek. Nilai yang valid: managed: proyek internal. external: proyek eksternal.	managed
comment	string	Deskripsi proyek.	BI_Analysis
defaultQuota	string	Kuota komputasi default. Kuota digunakan untuk alokasi sumber daya. Jika Anda tidak menentukan kuota komputasi, pekerjaan yang diinisiasi dalam proyek akan mengonsumsi sumber daya dari kuota default. Untuk informasi selengkapnya, lihat Use of computing resources.	os_PayAsYouGoQuota
status	string	Status proyek. Nilai yang valid: AVAILABLE: Normal READONLY: read-only FROZEN: frozen DELETING: sedang dihapus	AVAILABLE
productType	string	Metode penagihan kuota komputasi default.	PayAsYouGo
threeTierModel	boolean	Menentukan apakah penyimpanan data berbasis skema didukung. MaxCompute mendukung skema. Skema adalah objek dalam proyek yang digunakan untuk mengklasifikasikan objek seperti tabel, resource, dan user-defined function (UDF). Anda dapat membuat beberapa skema dalam satu proyek. Untuk informasi selengkapnya, lihat Schema operations.	true
costStorage	string	Total penggunaan penyimpanan. Nilai ini menunjukkan ukuran penyimpanan logis setelah data dikumpulkan dan dikompresi untuk proyek tersebut. Penggunaan penyimpanan ini sama dengan penggunaan untuk penagihan.	16489027
regionId	string	ID wilayah.	cn-beijing
createdTime	integer	Waktu saat proyek dibuat.	1704380838000
properties	object	Properti dasar proyek.
timezone	string	Zona waktu proyek. Parameter ini sesuai dengan properti `odps.sql.timezone`.	Asia/Shanghai
retentionDays	integer	Periode retensi data backup. Satuan: hari. Selama periode ini, Anda dapat memulihkan versi data saat ini ke versi backup mana pun. Nilainya dapat berupa bilangan bulat dari 0 hingga 30. Nilai default adalah 1. Nilai 0 menunjukkan bahwa fitur backup dinonaktifkan.	1
allowFullScan	boolean	Menentukan apakah pemindaian tabel penuh diizinkan dalam proyek. Pemindaian tabel penuh mengonsumsi banyak sumber daya dan mengurangi efisiensi pemrosesan. Secara default, fitur ini dinonaktifkan.	false
typeSystem	string	Edisi tipe data. Nilai yang valid: 1: V1.0 2: V2.0 hive: Kompatibel dengan Hive Untuk informasi selengkapnya, lihat Data type editions.	2.0
enableDecimal2	boolean	Menentukan apakah tipe data DECIMAL MaxCompute V2.0 diaktifkan untuk proyek.	true
sqlMeteringMax	string	Ambang batas konsumsi maksimum untuk satu pernyataan SQL. Rumus: Jumlah data yang dipindai (GB) × Kompleksitas.	1500
tableLifecycle	object	Properti siklus hidup tabel.
type	string	Tipe siklus hidup. Nilai yang valid: mandatory: Klausul Lifecycle wajib. Anda harus menetapkan siklus hidup untuk tabel. optional: Klausul Lifecycle opsional saat Anda membuat tabel. Jika Anda tidak menetapkan siklus hidup untuk tabel, tabel tersebut berlaku secara permanen. inherit: Jika Anda tidak menetapkan siklus hidup untuk tabel saat membuatnya, siklus hidup tabel tersebut mengikuti nilai odps.table.lifecycle.value.	optional
value	string	Siklus hidup tabel. Satuan: hari. Nilainya dapat berupa bilangan bulat dari 1 hingga 37231. Nilai default adalah 37231.	37231
encryption	object	Properti enkripsi penyimpanan.
enable	boolean	Menentukan apakah enkripsi data diaktifkan untuk proyek. Untuk informasi selengkapnya, lihat Storage encryption.	true
algorithm	string	Algoritma enkripsi data. Algoritma yang didukung meliputi AES256, AESCTR, dan RC4.	AES256
key	string	Jenis kunci yang digunakan untuk enkripsi data. Nilai yang valid meliputi MaxCompute Default Key dan Bring-Your-Own-Key (BYOK). MaxCompute Default Key adalah kunci default yang dibuat dalam MaxCompute.	dafault
tunnelQuota	string	Kelompok sumber daya Data Transmission Service yang ditautkan ke proyek. Default (kelompok sumber daya Data Transmission Service bersama): Proyek tidak dapat menggunakan kelompok sumber daya Data Transmission Service berlangganan. Terlepas dari nilai kelompok sumber daya Data Transmission Service default, Data Transmission Service secara otomatis menggunakan kelompok sumber daya Default untuk tugas transmisi data yang dikirimkan secara default dalam proyek. Kelompok sumber daya Data Transmission Service berlangganan: Proyek dapat menggunakan kelompok sumber daya Data Transmission Service berlangganan.	Default
elderTunnelQuota	string	Kelompok sumber daya induk dari kelompok sumber daya Data Transmission Service yang ditautkan ke proyek. Parameter ini digunakan secara internal.	Default_p
enableTunnelQuotaRoute	boolean	Menentukan apakah routing untuk kelompok sumber daya Data Transmission Service diaktifkan. true: Tugas transmisi data yang dikirimkan secara default dalam proyek menggunakan kelompok sumber daya Data Transmission Service yang ditautkan ke proyek. false: Tugas transmisi data yang dikirimkan secara default dalam proyek menggunakan kelompok sumber daya Data Transmission Service bersama.	true
storageTierInfo	object	Informasi penyimpanan bertingkat.
storageTierSize	object	Informasi penyimpanan bertingkat.
standardSize	integer	Penggunaan penyimpanan Jenis Penyimpanan Standar.	27649172
longTermSize	integer	Penggunaan penyimpanan jangka panjang.	21764917
lowFrequencySize	integer	Penggunaan kelas penyimpanan IA.	767693
projectTotalSize	integer	Total penggunaan penyimpanan.	56066037
projectBackupSize	integer	Ukuran penyimpanan backup.	86672917
fdcQuota	string	Kuota untuk caching tabel eksternal.	fdc_quota
enableFdcCacheForce	boolean	Menentukan apakah caching tabel eksternal diaktifkan secara paksa.	true
enableTieredStorage	boolean	Menentukan apakah penyimpanan bertingkat diaktifkan.	true
tableLifecycleConfig	object	Properti aturan siklus hidup penyimpanan bertingkat. Setelah Anda menetapkan properti ini, sistem secara otomatis memicu konversi kelas penyimpanan berdasarkan aturan tersebut.
TierToLongterm	object	Identifikasi untuk kelas penyimpanan jangka panjang.
DaysAfterLastModificationGreaterThan	integer	Jumlah hari setelah data terakhir dimodifikasi. Setelah periode ini, kelas penyimpanan secara otomatis berubah. Ini sesuai dengan `LastModifiedTime` tabel atau partisi.	180
DaysAfterLastAccessGreaterThan	integer	Jumlah hari setelah data terakhir diakses. Setelah periode ini, kelas penyimpanan secara otomatis berubah. Ini sesuai dengan `LastAccessTime` tabel atau partisi. Catatan Jika LastAccessTime tabel atau partisi kosong: Untuk tabel atau partisi yang dibuat sebelum 1 Oktober 2023, waktu akses terakhir dianggap 00:00:00 pada 1 Oktober 2023 (UTC+0). Untuk tabel atau partisi yang dibuat pada atau setelah 1 Oktober 2023, jika data belum diakses, waktu pembuatan tabel atau partisi dianggap sebagai waktu akses terakhir.	180
DaysAfterLastTierModificationGreaterThan	integer	Jumlah hari setelah kelas penyimpanan terakhir diubah.	1
TierToLowFrequency	object	Identifikasi untuk kelas penyimpanan IA.
DaysAfterLastModificationGreaterThan	integer	Jumlah hari setelah data terakhir dimodifikasi. Setelah periode ini, kelas penyimpanan secara otomatis berubah. Ini sesuai dengan `LastModifiedTime` tabel atau partisi.	30
DaysAfterLastAccessGreaterThan	integer	Jumlah hari setelah data terakhir diakses. Setelah periode ini, kelas penyimpanan secara otomatis berubah. Ini sesuai dengan `LastAccessTime` tabel atau partisi. Catatan Jika LastAccessTime tabel atau partisi kosong: Untuk tabel atau partisi yang dibuat sebelum 1 Oktober 2023, waktu akses terakhir dianggap 00:00:00 pada 1 Oktober 2023 (UTC+0). Untuk tabel atau partisi yang dibuat pada atau setelah 1 Oktober 2023, jika data belum diakses, waktu pembuatan tabel atau partisi dianggap sebagai waktu akses terakhir.	30
DaysAfterLastTierModificationGreaterThan	integer	Jumlah hari setelah kelas penyimpanan terakhir diubah.	1
externalProjectProperties	object	Properti proyek eksternal.
isExternalCatalogBound	string	Menentukan apakah proyek merupakan proyek eksternal dari data lakehouse 2.0.	true
tableFormat	string
warehouse	string
foreignServerName	string
foreignServerType	string
externalCatalogId	string
enableAutoMv	boolean
autoMvQuotaGb	integer
enableDr	boolean
superAdmins	array	Daftar anggota yang diberi peran `Super_Administrator` dalam proyek.
	string	Informasi akun anggota yang diberi peran `Super_Administrator` dalam proyek.	RAM$odps****@aliyunid.com:RAM_USER
securityProperties	object	Properti izin.
usingAcl	boolean	Menentukan apakah fitur Kontrol akses berbasis ACL digunakan. Secara default, fitur ini diaktifkan.	true
usingPolicy	boolean	Menentukan apakah fitur Kontrol akses berbasis kebijakan digunakan. Secara default, fitur ini diaktifkan.	true
objectCreatorHasAccessPermission	boolean	Menentukan apakah pembuat objek memiliki izin akses terhadap objek tersebut. Nilai default: true.	true
objectCreatorHasGrantPermission	boolean	Menentukan apakah pembuat objek memiliki izin memberikan izin terhadap objek tersebut. Nilai default: true.	true
labelSecurity	boolean	Menentukan apakah fitur Kontrol akses berbasis label digunakan. Secara default, fitur ini dinonaktifkan.	false
enableDownloadPrivilege	boolean	Menentukan apakah fitur kontrol unduhan digunakan. Secara default, fitur ini dinonaktifkan.	false
projectProtection	object	Properti mekanisme perlindungan data.
exceptionPolicy	string	Jika perlindungan data diaktifkan untuk proyek, Anda dapat mengonfigurasi kebijakan pengecualian untuk menentukan proyek pengecualian atau tepercaya. Kebijakan ini memungkinkan pengguna tertentu mentransfer data dari objek tertentu ke proyek tertentu. Mekanisme perlindungan data tidak berlaku untuk skenario yang dijelaskan dalam kebijakan pengecualian.	{ "Version": "1", "Statement": [ { "Effect": "Allow", "Principal": "", "Action": [ "odps:[, , ...]" ], "Resource": "acs:odps:*:", "Condition": { "StringEquals": { "odps:TaskType": [ "" ] } } } ] }
protected	boolean	Menentukan apakah mekanisme perlindungan data diaktifkan untuk proyek guna melarang atau mengizinkan aliran data keluar dari proyek. Secara default, mekanisme ini dinonaktifkan.	true
ipWhiteList	object	Daftar putih alamat IP.
ipList	string	Daftar putih alamat IP untuk akses melalui Internet atau jaringan yang digunakan untuk saling menghubungkan dengan layanan Alibaba Cloud lainnya. Catatan Jika Anda hanya mengonfigurasi daftar putih alamat IP ini, akses melalui Internet atau jaringan yang digunakan untuk saling menghubungkan dengan layanan Alibaba Cloud lainnya dibatasi berdasarkan konfigurasi tersebut, dan akses melalui VPC dilarang.	10.88.111.3
vpcIpList	string	Daftar putih alamat IP untuk akses melalui VPC. Catatan Jika Anda hanya mengonfigurasi daftar putih alamat IP ini, akses melalui VPC dibatasi berdasarkan konfigurasi tersebut, dan akses melalui Internet atau jaringan yang digunakan untuk saling menghubungkan dengan layanan Alibaba Cloud lainnya dilarang.	10.88.111.3
saleTag	object	ID instans dan metode penagihan kuota komputasi default.
resourceId	string	ID instans kuota komputasi default.	b7afb7d1-**--**-c393669c307b
resourceType	string	Metode penagihan kuota komputasi default.	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
    },
    "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.