MaxCompute プロジェクトの基本情報を照会します。
今すぐお試しください
テスト
RAM 認証
|
アクション |
アクセスレベル |
リソースタイプ |
条件キー |
依存アクション |
|
odps:GetProject |
get |
*Project
|
なし | なし |
リクエスト構文
GET /api/v1/projects/{projectName} HTTP/1.1パスパラメータ
|
パラメーター |
型 |
必須 / 任意 |
説明 |
例 |
| projectName |
string |
必須 |
プロジェクト名。 |
odps_project |
リクエストパラメーター
|
パラメーター |
型 |
必須 / 任意 |
説明 |
例 |
| verbose |
boolean |
任意 |
securityProperties や superAdmins などの追加情報を含めるかどうかを指定します。 |
true |
| withStorageTierInfo |
boolean |
任意 |
properties.storageTierInfo などの追加情報を含めるかどうかを指定します。 |
true |
| withQuotaProductType |
boolean |
任意 |
productType などの追加情報を含めるかどうかを指定します。 |
true |
レスポンスフィールド
|
フィールド |
型 |
説明 |
例 |
|
object |
レスポンスパラメーター。 |
||
| requestId |
string |
リクエスト ID。 |
0b87b7b316643495896551555e855b |
| httpCode |
integer |
HTTP ステータスコード。
|
200 |
| errorCode |
string |
エラーコード。 |
OBJECT_NOT_EXIST |
| errorMsg |
string |
エラーメッセージ。 |
This object does not exist. |
| data |
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 |
| productType |
string |
デフォルトの計算クォータの課金方法。 |
PayAsYouGo |
| threeTierModel |
boolean |
スキーマによるデータストレージがサポートされているかどうかを指定します。 MaxCompute はスキーマをサポートしています。 スキーマはプロジェクト内のオブジェクトです。 テーブル、リソース、ユーザー定義関数 (UDF) などのオブジェクトを分類するために使用されます。 プロジェクト内に複数のスキーマを作成できます。 詳細については、「スキーマ操作」をご参照ください。 |
true |
| costStorage |
string |
合計ストレージ使用量。 この値は、プロジェクトのデータが収集および圧縮された後の論理ストレージサイズを示します。 ストレージ使用量は、課金のための使用量と同じです。 |
16489027 |
| regionId |
string |
リージョン ID。 |
cn-beijing |
| createdTime |
integer |
プロジェクトが作成された時間。 |
1704380838000 |
| properties |
object |
プロジェクトの基本プロパティ。 |
|
| timezone |
string |
プロジェクトのタイムゾーン。 このパラメーターは |
Asia/Shanghai |
| retentionDays |
integer |
バックアップデータの保持期間。 単位: 日。 この期間中、現在のデータバージョンを任意のバックアップバージョンに復元できます。 値は 0 から 30 までの整数です。 デフォルト値は 1 です。 値 0 は、バックアップ機能が無効になっていることを示します。 |
1 |
| allowFullScan |
boolean |
プロジェクトで全表スキャンを許可するかどうかを指定します。 全表スキャンは大量のリソースを消費し、処理効率を低下させます。 デフォルトでは、この機能は無効になっています。 |
false |
| typeSystem |
string |
データ型のエディション。 有効な値:
詳細については、「データ型のエディション」をご参照ください。 |
2.0 |
| enableDecimal2 |
boolean |
プロジェクトで MaxCompute V2.0 の DECIMAL データ型を有効にするかどうかを指定します。 |
true |
| sqlMeteringMax |
string |
単一の SQL 文の最大消費しきい値。 式: スキャンされたデータ量 (GB) × 複雑度。 |
1500 |
| tableLifecycle |
object |
テーブルのライフサイクルプロパティ。 |
|
| type |
string |
ライフサイクルのタイプ。 有効な値:
|
optional |
| value |
string |
テーブルのライフサイクル。 単位: 日。 値は 1 から 37231 までの整数です。 デフォルト値は 37231 です。 |
37231 |
| encryption |
object |
ストレージ暗号化プロパティ。 |
|
| enable |
boolean |
プロジェクトのデータ暗号化を有効にするかどうかを指定します。 詳細については、「ストレージの暗号化」をご参照ください。 |
true |
| algorithm |
string |
データ暗号化アルゴリズム。 サポートされているアルゴリズムには、AES256、AESCTR、RC4 があります。 |
AES256 |
| key |
string |
データ暗号化に使用されるキーのタイプ。 有効な値には、MaxCompute Default Key と Bring-Your-Own-Key (BYOK) があります。 MaxCompute Default Key は、MaxCompute 内で作成されるデフォルトのキーです。 |
dafault |
| tunnelQuota |
string |
プロジェクトにバインドされている Data Transmission Service リソースグループ。
|
Default |
| elderTunnelQuota |
string |
プロジェクトにバインドされている Data Transmission Service リソースグループの親リソースグループ。 このパラメーターは内部使用向けです。 |
Default_p |
| enableTunnelQuotaRoute |
boolean |
Data Transmission Service リソースグループのルーティングを有効にするかどうかを指定します。
|
true |
| storageTierInfo |
object |
階層型ストレージ情報。 |
|
| storageTierSize |
object |
階層型ストレージ情報。 |
|
| standardSize |
integer |
標準ストレージの使用量。 |
27649172 |
| longTermSize |
integer |
長期ストレージの使用量。 |
21764917 |
| lowFrequencySize |
integer |
低頻度アクセスストレージタイプの使用量。 |
767693 |
| projectTotalSize |
integer |
合計ストレージ使用量。 |
56066037 |
| projectBackupSize |
integer |
バックアップストレージサイズ。 |
86672917 |
| fdcQuota |
string |
外部テーブルキャッシングのクォータ。 |
fdc_quota |
| enableFdcCacheForce |
boolean |
外部テーブルキャッシングを強制的に有効にするかどうかを指定します。 |
true |
| enableTieredStorage |
boolean |
階層型ストレージを有効にするかどうかを指定します。 |
true |
| tableLifecycleConfig |
object |
階層型ストレージのライフサイクルルールのプロパティ。 これらのプロパティを設定すると、システムはルールに基づいてストレージタイプの変換を自動的にトリガーします。 |
|
| TierToLongterm |
object |
長期ストレージタイプの識別子。 |
|
| DaysAfterLastModificationGreaterThan |
integer |
データが最後に変更されてからの日数。 この期間が経過すると、ストレージタイプは自動的に変更されます。 これは、テーブルまたはパーティションの |
180 |
| DaysAfterLastAccessGreaterThan |
integer |
データが最後にアクセスされてからの日数。 この期間が経過すると、ストレージタイプは自動的に変更されます。 これは、テーブルまたはパーティションの 説明
テーブルまたはパーティションの LastAccessTime が空の場合:
|
180 |
| DaysAfterLastTierModificationGreaterThan |
integer |
ストレージタイプが最後に変更されてからの日数。 |
1 |
| TierToLowFrequency |
object |
低頻度アクセスストレージタイプの識別子。 |
|
| DaysAfterLastModificationGreaterThan |
integer |
データが最後に変更されてからの日数。 この期間が経過すると、ストレージタイプは自動的に変更されます。 これは、テーブルまたはパーティションの |
30 |
| DaysAfterLastAccessGreaterThan |
integer |
データが最後にアクセスされてからの日数。 この期間が経過すると、ストレージタイプは自動的に変更されます。 これは、テーブルまたはパーティションの 説明
テーブルまたはパーティションの LastAccessTime が空の場合:
|
30 |
| DaysAfterLastTierModificationGreaterThan |
integer |
ストレージタイプが最後に変更されてからの日数。 |
1 |
| externalProjectProperties |
object |
外部プロジェクトのプロパティ。 |
|
| isExternalCatalogBound |
string |
プロジェクトが データレイクハウス 2.0 の外部プロジェクトであるかどうかを指定します。 |
true |
| tableFormat |
string |
||
| warehouse |
string |
||
| foreignServerName |
string |
||
| foreignServerType |
string |
||
| externalCatalogId |
string |
||
| enableAutoMv |
boolean |
||
| autoMvQuotaGb |
integer |
||
| enableDr |
boolean |
||
| superAdmins |
array |
プロジェクトで |
|
|
string |
プロジェクトで |
RAM$odps****@aliyunid.com:RAM_USER |
|
| securityProperties |
object |
権限プロパティ。 |
|
| usingAcl |
boolean |
ACL ベースのアクセスの制御機能を使用するかどうかを指定します。 デフォルトでは、この機能は有効になっています。 |
true |
| usingPolicy |
boolean |
ポリシーベースのアクセスの制御機能を使用するかどうかを指定します。 デフォルトでは、この機能は有効になっています。 |
true |
| objectCreatorHasAccessPermission |
boolean |
オブジェクトの作成者がオブジェクトに対するアクセス権限を持つかどうかを指定します。 デフォルト値: true。 |
true |
| objectCreatorHasGrantPermission |
boolean |
オブジェクトの作成者がオブジェクトに対する付与権限を持つかどうかを指定します。 デフォルト値: true。 |
true |
| labelSecurity |
boolean |
ラベルベースのアクセスの制御機能を使用するかどうかを指定します。 デフォルトでは、この機能は無効になっています。 |
false |
| enableDownloadPrivilege |
boolean |
ダウンロード制御機能を使用するかどうかを指定します。 デフォルトでは、この機能は無効になっています。 |
false |
| projectProtection |
object |
データ保護メカニズムのプロパティ。 |
|
| exceptionPolicy |
string |
プロジェクトでデータ保護が有効になっている場合、例外ポリシーを構成して例外または信頼できるプロジェクトを指定できます。 このポリシーにより、指定されたユーザーは、指定されたオブジェクトから指定されたプロジェクトにデータを転送できます。 データ保護メカニズムは、例外ポリシーで説明されているシナリオには適用されません。 |
{ "Version": "1", "Statement": [ { "Effect": "Allow", "Principal": "", "Action": [ "odps:[, , ...]" ], "Resource": "acs:odps:*:", "Condition": { "StringEquals": { "odps:TaskType": [ "" ] } } } ] } |
| protected |
boolean |
プロジェクトの データ保護メカニズムを有効にして、プロジェクトからのデータの流出を禁止または許可するかどうかを指定します。 デフォルトでは、このメカニズムは無効になっています。 |
true |
| ipWhiteList |
object |
IP アドレスホワイトリスト。 |
|
| ipList |
string |
インターネットまたは他の Alibaba Cloud サービスとの相互接続に使用されるネットワーク経由のアクセスのための IP アドレスホワイトリスト。 説明
この IP アドレスホワイトリストのみを構成した場合、インターネットまたは他の Alibaba Cloud サービスとの相互接続に使用されるネットワーク経由のアクセスは構成に基づいて制限され、VPC 経由のアクセスは禁止されます。 |
10.88.111.3 |
| vpcIpList |
string |
VPC 経由のアクセスのための IP アドレスホワイトリスト。 説明
この IP アドレスホワイトリストのみを構成した場合、VPC 経由のアクセスは構成に基づいて制限され、インターネットまたは他の Alibaba Cloud サービスとの相互接続に使用されるネットワーク経由のアクセスは禁止されます。 |
10.88.111.3 |
| saleTag |
object |
デフォルトの計算クォータのインスタンス ID と課金方法。 |
|
| resourceId |
string |
デフォルトの計算クォータのインスタンス ID。 |
b7afb7d1-****-****-****-c393669c307b |
| resourceType |
string |
デフォルトの計算クォータの課金方法。 |
PayAsYouGo |
例
成功レスポンス
JSONJSON
{
"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"
}
}
}エラーコード
完全なリストについては、「エラーコード」をご参照ください。
変更履歴
完全なリストについては、「変更履歴」をご参照ください。