Gunakan ListProjects untuk kueri project-MaxCompute-Alibaba Cloud - MaxCompute

Mengambil daftar 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:ListProjects

list

Project

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

None

Sintaks permintaan

GET /api/v1/projects HTTP/1.1

Parameter permintaan

Parameter	Type	Required	Description	Example
tenantId	string	No	ID penyewa. Untuk mendapatkan ID, masuk ke Konsol MaxCompute lalu pilih Tenant Management > Tenant Properties di panel navigasi sebelah kiri.	5495****3697
region	string	No	ID Wilayah.	cn-beijing
quotaNickName	string	No	Nama panggilan Kuota. Untuk mendapatkan nama panggilan kuota, masuk ke Konsol MaxCompute lalu pilih Workspace > Quota Management di panel navigasi sebelah kiri.	os_PayAsYouGoQuota
quotaName	string	No	Nama Kuota. Sistem secara otomatis menghasilkan nama ini. Untuk mendapatkan nama kuota, masuk ke Konsol MaxCompute lalu pilih Workspace > Quota Management di panel navigasi sebelah kiri.	aliyun_5495***3697
prefix	string	No	Awalan nama sumber daya yang akan dikueri. Sebagai contoh, jika Anda menentukan `a` untuk parameter ini, hanya sumber daya yang namanya dimulai dengan "a" yang dikembalikan.	a
marker	string	No	Token yang menentukan titik awal kueri. Hasilnya dikembalikan dalam Pesanan abjad, dimulai dari entri yang segera mengikuti marker.	cHlvZHBzX3VkZl8xMDExNV8xNDU3NDI4NDkzKg==
maxItem	integer	No	Jumlah maksimum entri yang dikembalikan per halaman. Nilai default: 10.	10
saleTags	string	No	ID instans dan metode penagihan dari kuota komputasi default.	{ "resourceId": "b7afb7d1-**--**-c393669c307b", "resourceType": "PayAsYouGo" }
type	string	No	Tipe proyek. Nilai valid: managed: proyek terkelola. external: proyek eksternal.	managed
sortBy	string	No	Bidang pengurutan. Satu-satunya nilai yang didukung adalah `createdTime`. Valid values: createdTime : Mengurutkan berdasarkan pengatur waktu pembuatan.	createdTime
sortOrder	string	No	Pesanan pengurutan. Parameter ini hanya berlaku ketika `sortBy` ditentukan. Nilai valid: `ASC` dan `DESC`. Nilai tidak peka huruf besar/kecil. Valid values: ASC : Pesanan menaik. DESC : Pesanan menurun.	DESC
listSystemCatalog	boolean	No	Apakah akan menampilkan daftar proyek bawaan SYSTEM_CATALOG. Proyek ini menyediakan informasi seperti metadata proyek dan riwayat Penggunaan. Untuk informasi lebih lanjut, lihat Information Schema tingkat penyewa. Valid values: true : Menyertakan proyek SYSTEM_CATALOG dalam hasil. false : Mengecualikan proyek SYSTEM_CATALOG dari hasil.	true

Elemen respons

Element	Type	Description	Example
	object	The response object.
requestId	string	The request ID.	0b16399216671970335563173e2340
data	object	The returned data.
projects	array<object>	The list of projects.
	array<object>	The project details.
name	string	The name of the project.	odps_project
owner	string	The account information of the project owner.	ALIYUN$odps****@aliyunid.com
type	string	The project type. Valid values: managed: internal project external: external project	managed
comment	string	The project description.	BI_Analysis
defaultQuota	string	The default computing quota that is used to allocate computing resources. If you do not specify a computing quota for your project, the jobs that are initiated by your project consume the computing resources in the default quota. For more information about how to use computing resources, see Use quota groups for computing resources	os_PayAsYouGoQuota
status	string	The project status. Valid values: AVAILABLE READONLY FROZEN DELETING	AVAILABLE
costStorage	string	The total storage usage. The storage space that is occupied by your project, which is the logical storage space after your project data is collected and compressed.	16489027
regionId	string	The region ID.	cn-beijing
createdTime	integer	The creation time.	1704380838000
properties	object	The basic properties of the project.
timezone	string	The time zone that is used by your project. The time zone is the same as the time zone specified by `odps.sql.timezone`.	Asia/Shanghai
retentionDays	integer	The retention period for backup data. Unit: days. During the retention period, you can restore data of the version in use to the backup data of any version. Valid values: [0,30]. Default value: 1. The value 0 indicates that the backup feature is disabled.	1
allowFullScan	boolean	Indicates whether a full table scan is allowed in the project. A full table scan occupies a large number of resources, which reduces data processing efficiency. By default, the full table scan feature is disabled.	false
typeSystem	string	The data type edition. Valid values: 1: MaxCompute V1.0 data type edition 2: MaxCompute V2.0 data type edition hive: Hive-compatible data type edition For more information about the differences among the three data type editions, see Data type editions.	2
enableDecimal2	boolean	Indicates whether the DECIMAL type of the MaxCompute V2.0 data type edition is enabled.	true
sqlMeteringMax	string	The maximum consumption threshold of a single SQL statement. Formula: Amount of scanned data (GB) × Complexity.	1500
tableLifecycle	object	The table lifecycle properties.
type	string	The lifecycle type. Valid values: mandatory: The lifecycle clause is required in a table creation statement. optional: The lifecycle clause is optional in a table creation statement. If you do not configure a lifecycle for a table, the table does not expire. inherit: If you do not configure a lifecycle for a table when you create the table, the value of the odps.table.lifecycle.value parameter is used as the table lifecycle by default.	optional
value	string	The table lifecycle. Unit: days. Valid values: 1 to 37231. Default value: 37231.	37231
encryption	object	The storage encryption properties.
enable	boolean	Indicates whether the data encryption feature needs to be enabled for the project. For more information about data encryption, see Storage encryption.	true
algorithm	string	The data encryption algorithm that is supported by the key. Valid values: AES256, AESCTR, and RC4.	AES256
key	string	The type of key that is used for data encryption. You can select MaxCompute Default Key or Bring Your Own Key (BYOK) as the key type. If you select MaxCompute Default Key, the default key that is created by MaxCompute is used.	dafault
tunnelQuota	string	The Tunnel resource group that is bound to the project. Default resource group: The Tunnel shared resource group is used. You cannot use the subscription-based Tunnel resource group for the project. The default resource group is automatically used by the Tunnel service of your project, regardless of the parameter setting. Subscription-based Tunnel resource group: You can use the subscription-based Tunnel resource group for the project.	Default
enableTunnelQuotaRoute	boolean	Indicates whether the routing of the Tunnel resource group is enabled. true: The data transfer tasks that are submitted by the project by default use the Tunnel resource group that is bound to the project. false: The data transfer tasks that are submitted by the project by default use the Tunnel shared resource group.	true
externalProjectProperties	object	The properties of the external project.
isExternalCatalogBound	string	Indicates whether the external project is an external project for data lakehouse solution 2.0.	true
securityProperties	object	The permission properties.
usingAcl	boolean	Indicates whether the ACL-based access control feature is enabled. By default, this feature is enabled.	true
usingPolicy	boolean	Indicates whether the policy-based access control feature is enabled. By default, this feature is enabled.	true
objectCreatorHasAccessPermission	boolean	Indicates whether to allow the object creator to have the access permissions on the object. The default value is true, which indicates that the object creator has the access permissions on the object.	true
objectCreatorHasGrantPermission	boolean	Indicates whether the object creator has the authorization permissions on the object. The default value is true, which indicates that the object creator has the authorization permissions on the object.	true
labelSecurity	boolean	Indicates whether the label-based access control feature is enabled. By default, this feature is disabled.	false
enableDownloadPrivilege	boolean	Indicates whether the download control feature is enabled. By default, this feature is disabled.	false
projectProtection	object	The properties of the data protection mechanism.
protected	boolean	Indicates whether the data protection mechanism is enabled for the project. This allows or denies data transfer across projects. By default, the data protection mechanism is disabled.	true
exceptionPolicy	string	If you enable the project data protection mechanism, you can configure exception or trusted projects. This allows specified users to transfer data of a specified object to a specified project. The project data protection mechanism does not take effect in all the situations that are specified in the exception policy.	{ "Version": "1", "Statement": [ { "Effect": "Allow", "Principal": "", "Action": [ "odps:[, , ...]" ], "Resource": "acs:odps:*:", "Condition": { "StringEquals": { "odps:TaskType": [ "" ] } } } ] }
ipWhiteList	object	The information about the IP address whitelist.
ipList	string	The IP address whitelist for access over the Internet or the network for interconnecting with other Alibaba Cloud services. Catatan If you configure only the IP address whitelist for access over the Internet or the network for interconnecting with other Alibaba Cloud services, the access over the Internet or the network for interconnecting with other Alibaba Cloud services is subject to configurations, and access over a virtual private cloud (VPC) is not allowed.	10.88.111.3
vpcIpList	string	The IP address whitelist for access over a VPC. Catatan If you configure only the IP address whitelist for access over a VPC, the access over a VPC is subject to configurations, and the access over the Internet or the network for interconnecting with other Alibaba Cloud services is not allowed.	10.88.111.3
saleTag	object	The instance ID and billing method of the default computing quota.
resourceId	string	The instance ID of the default computing quota.	b7afb7d1-**--**-c393669c307b
resourceType	string	The billing method of the default computing quota.	PayAsYouGo
threeTierModel	boolean	Indicates whether data storage by schema is supported. MaxCompute supports the schema feature. This feature allows you to classify objects such as tables, resources, and user-defined functions (UDFs) in a project by schema. You can create multiple schemas in a project. For more information, see Schema-related operations. Valid values: true: supported false: not supported Valid values: true : false :	true
marker	string	A pagination marker used to retrieve the next page of results. This parameter is returned when the response is truncated.	cHlvZHBzX3VkZl8xMDExNV8xNDU3NDI4NDkzKg==
maxItem	integer	The maximum number of entries returned per page.	10
NextToken	string	The token for retrieving the next page of results. If this parameter is empty, all results have been returned.	AAAAAV3MpHK1AP0pfERHZN5pu6kvikyUl3ChyRxN+qLPvtOb

Contoh

Respons sukses

JSONformat

{
  "requestId": "0b16399216671970335563173e2340",
  "data": {
    "projects": [
      {
        "name": "odps_project",
        "owner": "ALIYUN$odps****@aliyunid.com\n",
        "type": "managed",
        "comment": "BI_Analysis",
        "defaultQuota": "os_PayAsYouGoQuota\n",
        "status": "AVAILABLE",
        "costStorage": "16489027",
        "regionId": "cn-beijing",
        "createdTime": 1704380838000,
        "properties": {
          "timezone": "Asia/Shanghai\n",
          "retentionDays": 1,
          "allowFullScan": false,
          "typeSystem": "2",
          "enableDecimal2": true,
          "sqlMeteringMax": "1500",
          "tableLifecycle": {
            "type": "optional",
            "value": "37231\n"
          },
          "encryption": {
            "enable": true,
            "algorithm": "AES256",
            "key": "dafault"
          },
          "tunnelQuota": "Default",
          "enableTunnelQuotaRoute": true,
          "externalProjectProperties": {
            "isExternalCatalogBound": "true"
          }
        },
        "securityProperties": {
          "usingAcl": true,
          "usingPolicy": true,
          "objectCreatorHasAccessPermission": true,
          "objectCreatorHasGrantPermission": true,
          "labelSecurity": false,
          "enableDownloadPrivilege": false,
          "projectProtection": {
            "protected": true,
            "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}"
          }
        },
        "ipWhiteList": {
          "ipList": "10.88.111.3",
          "vpcIpList": "10.88.111.3"
        },
        "saleTag": {
          "resourceId": "b7afb7d1-****-****-****-c393669c307b\n",
          "resourceType": "PayAsYouGo\n"
        },
        "threeTierModel": true
      }
    ],
    "marker": "cHlvZHBzX3VkZl8xMDExNV8xNDU3NDI4NDkzKg==",
    "maxItem": 10,
    "NextToken": "AAAAAV3MpHK1AP0pfERHZN5pu6kvikyUl3ChyRxN+qLPvtOb"
  }
}

Kode kesalahan

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.