MaxCompute プロジェクトのリストを取得します。
今すぐお試しください
テスト
RAM 認証
|
アクション |
アクセスレベル |
リソースタイプ |
条件キー |
依存アクション |
|
odps:ListProjects |
list |
Project
|
なし | なし |
リクエスト構文
GET /api/v1/projects HTTP/1.1リクエストパラメーター
|
パラメーター |
型 |
必須 / 任意 |
説明 |
例 |
| tenantId |
string |
任意 |
テナント ID。ID を取得するには、MaxCompute コンソールにログインし、左側メニューから [テナント管理] > [テナントプロパティ] を選択します。 |
5495****3697 |
| region |
string |
任意 |
リージョン ID。 |
cn-beijing |
| quotaNickName |
string |
任意 |
クォータニックネーム。クォータニックネームを取得するには、MaxCompute コンソールにログインし、左側メニューから [ワークスペース] > [クォータ管理] を選択します。 |
os_PayAsYouGoQuota |
| quotaName |
string |
任意 |
クォータ名。この名前はシステムによって自動的に生成されます。クォータ名を取得するには、MaxCompute コンソールにログインし、左側メニューから [ワークスペース] > [クォータ管理] を選択します。 |
aliyun_5495***3697 |
| prefix |
string |
任意 |
クエリするリソース名のプレフィックス。たとえば、このパラメータに |
a |
| marker |
string |
任意 |
クエリの開始位置を指定するトークン。結果はアルファベット順に返され、マーカーの直後のエントリから始まります。 |
cHlvZHBzX3VkZl8xMDExNV8xNDU3NDI4NDkzKg== |
| maxItem |
integer |
任意 |
各ページに返される最大エントリ数。デフォルト値：10。 |
10 |
| saleTags |
string |
任意 |
デフォルトコンピューティングクォータのインスタンス ID と課金方法。 |
{ "resourceId": "b7afb7d1-****-****-****-c393669c307b", "resourceType": "PayAsYouGo" } |
| type |
string |
任意 |
プロジェクトタイプ。有効な値：
|
managed |
| sortBy |
string |
任意 |
ソートフィールド。サポートされている値は 列挙値:
|
createdTime |
| sortOrder |
string |
任意 |
ソート順。このパラメータは 列挙値:
|
DESC |
| listSystemCatalog |
boolean |
任意 |
組み込みの SYSTEM_CATALOG プロジェクトをリスト表示するかどうかを指定します。このプロジェクトは、プロジェクトメタデータや使用履歴などの情報を提供します。詳細については、「Information Schema」をご参照ください。 列挙値:
|
true |
レスポンスフィールド
|
フィールド |
型 |
説明 |
例 |
|
object |
レスポンスオブジェクト。 |
||
| requestId |
string |
リクエスト ID。 |
0b16399216671970335563173e2340 |
| data |
object |
返されたデータ。 |
|
| projects |
array<object> |
プロジェクトのリスト。 |
|
|
array<object> |
プロジェクトの詳細。 |
||
| name |
string |
プロジェクトの名前。 |
odps_project |
| owner |
string |
プロジェクトの所有者。 |
ALIYUN$odps****@aliyunid.com |
| type |
string |
プロジェクトのタイプ。有効な値：
|
managed |
| comment |
string |
プロジェクトの説明。 |
BI_Analysis |
| defaultQuota |
string |
デフォルトのコンピューティングクォータ。ジョブにクォータを指定しない場合、ジョブはこのデフォルトのクォータからコンピューティングリソースを消費します。コンピューティングリソースの使用方法の詳細については、「コンピューティングリソースの使用」をご参照ください。 |
os_PayAsYouGoQuota |
| status |
string |
プロジェクトのステータス。有効な値：
|
AVAILABLE |
| costStorage |
string |
プロジェクトの総ストレージ使用量。これは、測定に使用される圧縮された論理データサイズを表します。 |
16489027 |
| regionId |
string |
リージョン ID。 |
cn-beijing |
| createdTime |
integer |
プロジェクトが作成された時刻 (ミリ秒単位の UNIX タイムスタンプ)。 |
1704380838000 |
| properties |
object |
プロジェクトの基本プロパティ。 |
|
| timezone |
string |
プロジェクトのタイムゾーン。このパラメーターは、 |
Asia/Shanghai |
| retentionDays |
integer |
バックアップデータの保持期間 (日数)。保持期間内に作成された任意のバックアップバージョンにデータを復元できます。有効な値： |
1 |
| allowFullScan |
boolean |
プロジェクトでフルテーブルスキャンを許可するかどうかを指定します。フルテーブルスキャンは大量のコンピューティングリソースを消費する可能性があるため、この機能はデフォルトで無効になっています。 |
false |
| typeSystem |
string |
データ型バージョン。有効な値：
データ型バージョンの違いの詳細については、「データ型バージョン」をご参照ください。 |
2 |
| enableDecimal2 |
boolean |
プロジェクトで MaxCompute 2.0 Decimal データ型を有効にするかどうかを指定します。 |
true |
| sqlMeteringMax |
string |
単一の SQL ステートメントの最大測定されたコスト。コストは、(スキャンされたデータ (GB)) × (複雑度) の式を使用して計算されます。 |
1500 |
| tableLifecycle |
object |
テーブルライフサイクルプロパティ。 |
|
| type |
string |
ライフサイクルのタイプ。有効な値：
|
optional |
| value |
string |
テーブルのライフサイクル (日数)。有効な値： |
37231 |
| encryption |
object |
ストレージ暗号化プロパティ。 |
|
| enable |
boolean |
プロジェクトのストレージ暗号化を有効にするかどうかを指定します。詳細については、「ストレージ暗号化」をご参照ください。 |
true |
| algorithm |
string |
データ暗号化アルゴリズム。サポートされているアルゴリズムは、AES256、AESCTR、RC4 です。 |
AES256 |
| key |
string |
データ暗号化のキー。デフォルトの MaxCompute マネージドキーを使用するか、Bring Your Own Key (BYOK) 機能でカスタムキーを使用できます。 |
dafault |
| tunnelQuota |
string |
プロジェクトにバインドされているデータ伝送サービスリソースグループ。
|
Default |
| enableTunnelQuotaRoute |
boolean |
データ伝送サービスリソースグループのルーティングを有効にするかどうかを指定します。
|
true |
| externalProjectProperties |
object |
外部プロジェクトのプロパティ。 |
|
| isExternalCatalogBound |
string |
プロジェクトが統合レイクハウスの外部プロジェクトであるかどうかを指定します。 |
true |
| securityProperties |
object |
セキュリティ関連のプロパティ。 |
|
| usingAcl |
boolean |
ACL ベースのアクセス制御を有効にするかどうかを指定します。デフォルト値： |
true |
| usingPolicy |
boolean |
ポリシーベースのアクセス制御を有効にするかどうかを指定します。デフォルト値： |
true |
| objectCreatorHasAccessPermission |
boolean |
オブジェクトの作成者がオブジェクトにアクセスできるかどうかを指定します。デフォルト値： |
true |
| objectCreatorHasGrantPermission |
boolean |
オブジェクトの作成者が他のユーザーにオブジェクトに対する権限を付与できるかどうかを指定します。デフォルト値： |
true |
| labelSecurity |
boolean |
ラベルベースのアクセス制御を有効にするかどうかを指定します。デフォルト値： |
false |
| enableDownloadPrivilege |
boolean |
ダウンロード制御を有効にするかどうかを指定します。デフォルト値： |
false |
| projectProtection |
object |
プロジェクトデータ保護プロパティ。 |
|
| protected |
boolean |
プロジェクトデータ保護を有効にして、プロジェクトからのデータのエクスポートを防止するかどうかを指定します。デフォルト値： |
true |
| exceptionPolicy |
string |
プロジェクトデータ保護が有効になっている場合、例外ポリシーを設定できます。このポリシーにより、指定されたユーザーは、データ保護メカニズムをバイパスして、指定されたオブジェクトから信頼できるプロジェクトにデータをエクスポートできます。 |
{ "Version": "1", "Statement": [ { "Effect": "Allow", "Principal": "", "Action": [ "odps:[, , ...]" ], "Resource": "acs:odps:*:", "Condition": { "StringEquals": { "odps:TaskType": [ "" ] } } } ] } |
| ipWhiteList |
object |
IP ホワイトリスト。 |
|
| ipList |
string |
パブリックネットワークおよび他の Alibaba Cloud サービスからのアクセスのための IP ホワイトリスト。 説明
この IP ホワイトリストのみを設定した場合、パブリックネットワークおよび他の Alibaba Cloud サービスからのアクセスはホワイトリストに基づいて制限され、VPC からのすべてのアクセスは拒否されます。 |
10.88.111.3 |
| vpcIpList |
string |
VPC からのアクセスのための IP ホワイトリスト。 説明
VPC IP ホワイトリストのみを設定した場合、VPC からのアクセスはホワイトリストに基づいて制限され、パブリックネットワークおよび他の Alibaba Cloud サービスからのすべてのアクセスは拒否されます。 |
10.88.111.3 |
| saleTag |
object |
デフォルトのコンピューティングクォータのインスタンス ID と課金方法。 |
|
| resourceId |
string |
デフォルトのコンピューティングクォータのインスタンス ID。 |
b7afb7d1-****-****-****-c393669c307b |
| resourceType |
string |
デフォルトのコンピューティングクォータの課金方法。 |
PayAsYouGo |
| threeTierModel |
boolean |
プロジェクトが 3層モデル (プロジェクト > スキーマ > オブジェクト) を使用するかどうかを指定します。このモデルでは、プロジェクト内でスキーマを使用して、テーブル、リソース、ユーザー定義関数 (UDF) などのオブジェクトを整理します。詳細については、「スキーマ操作」をご参照ください。 列挙値:
|
true |
| marker |
string |
次の結果ページを取得するために使用されるページネーションマーカー。このパラメーターは、レスポンスが切り捨てられた場合に返されます。 |
cHlvZHBzX3VkZl8xMDExNV8xNDU3NDI4NDkzKg== |
| maxItem |
integer |
ページごとに返されるエントリの最大数。 |
10 |
| NextToken |
string |
次の結果ページを取得するためのトークン。このパラメーターが空の場合、すべての結果が返されたことを意味します。 |
AAAAAV3MpHK1AP0pfERHZN5pu6kvikyUl3ChyRxN+qLPvtOb |
例
成功レスポンス
JSONJSON
{
"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"
}
}エラーコード
完全なリストについては、「エラーコード」をご参照ください。
変更履歴
完全なリストについては、「変更履歴」をご参照ください。