すべてのプロダクト
Search
ドキュメントセンター

:ListProjects

最終更新日:Dec 18, 2025

MaxCompute プロジェクトのリストを照会します。

今すぐお試しください

この API を OpenAPI Explorer でお試しください。手作業による署名は必要ありません。呼び出しに成功すると、入力したパラメーターに基づき、資格情報が組み込まれた SDK コードが自動的に生成されます。このコードをダウンロードしてローカルで使用できます。

テスト

RAM 認証

下表に、この API を呼び出すために必要な認証情報を示します。認証情報は、RAM (Resource Access Management) ポリシーを使用して定義できます。以下で各列名について説明します。

  • アクション:特定のリソースに対して実行可能な操作。ポリシー構文ではAction要素として指定します。

  • API:アクションを具体的に実行するための API。

  • アクセスレベル:各 API に対して事前定義されているアクセスの種類。有効な値:create、list、get、update、delete。

  • リソースタイプ:アクションが作用するリソースの種類。リソースレベルでの権限をサポートするかどうかを示すことができます。ポリシーの有効性を確保するため、アクションの対象として適切なリソースを指定してください。

    • リソースレベルの権限を持つ API の場合、必要なリソースタイプはアスタリスク (*) でマークされます。ポリシーのResource要素で対応する ARN を指定してください。

    • リソースレベルの権限を持たない API の場合、「すべてのリソース」と表示され、ポリシーのResource要素でアスタリスク (*) でマークされます。

  • 条件キー:サービスによって定義された条件のキー。このキーにより、きめ細やかなアクセス制御が可能になります。この制御は、アクション単体に適用することも、特定のリソースに対するアクションに適用することもできます。Alibaba Cloud は、サービス固有の条件キーに加えて、すべての RAM 統合サービスに適用可能な一連の共通条件キーを提供しています。

  • 依存アクション:ある特定のアクションを実行するために、前提として実行が必要となる他のアクション。依存アクションの権限も RAM ユーザーまたは RAM ロールに付与する必要があります。

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

odps:ListProjects

list

Project

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

なし なし

リクエスト構文

GET /api/v1/projects HTTP/1.1

リクエストパラメーター

パラメーター

必須 / 任意

説明

tenantId

string

任意

テナント ID。 MaxCompute コンソールにログインし、左側のナビゲーションウィンドウで [テナント] > [テナントプロパティ] を選択してテナント ID を表示できます。

549532154333697

region

string

任意

リージョン ID。

cn-beijing

quotaNickName

string

任意

クォータのニックネーム。 MaxCompute コンソールにログインし、左側のナビゲーションウィンドウで [ワークスペース] > [クォータ] を選択し、[クォータ] ページでクォータのニックネームを表示できます。

quotaA

quotaName

string

任意

自動的に生成されるクォータ名。 MaxCompute コンソールにログインし、左側のナビゲーションウィンドウで [ワークスペース] > [クォータ] を選択し、[クォータ] ページでクォータ名を表示できます。

"hsajkdgbkaubh"

prefix

string

任意

返されるリストの開始位置を示すマーカーを指定します。

a

marker

string

任意

各ページで返すエントリの最大数。

cHlvZHBzX3VkZl8xMDExNV8xNDU3NDI4NDkzKg==

maxItem

integer

任意

ページあたりの最大エントリ数。 デフォルト値:10。

10

saleTags

string

任意

デフォルトのコンピューティングクォータのインスタンス ID と課金方法。

"aaaa-bbbb"

type

string

任意

プロジェクトタイプ。 有効な値:

  • managed:内部プロジェクト

  • external:外部プロジェクト

"managed"

listSystemCatalog

boolean

任意

プロジェクトのメタデータや過去の使用状況データなどのデータを提供するために使用される、組み込みの SYSTEM_CATALOG プロジェクトをリスト表示するかどうかを指定します。 詳細については、「テナントレベルの Information Schema」をご参照ください。

有効な値:

  • true:組み込みの SYSTEM_CATALOG プロジェクトがリスト表示されます。

  • false:組み込みの SYSTEM_CATALOG プロジェクトはリスト表示されません。

列挙値:

  • true :
  • false :

true

レスポンスフィールド

フィールド

説明

object

レスポンスパラメーター。

requestId

string

リクエスト ID。

0b16399216671970335563173e2340

data

object

返されたデータ。

projects

array<object>

プロジェクトのリスト。

array<object>

プロジェクト情報。

name

string

プロジェクトの名前。

odps_project

owner

string

プロジェクトオーナーのアカウント情報。

1139815775606813

type

string

プロジェクトタイプ。 有効な値:

  • managed:内部プロジェクト

  • external:外部プロジェクト

managed

comment

string

プロジェクトの説明。

maxcompute projects

defaultQuota

string

コンピューティングリソースを割り当てるために使用されるデフォルトのコンピューティングクォータ。 プロジェクトにコンピューティングクォータを指定しない場合、プロジェクトによって開始されたジョブはデフォルトのクォータのコンピューティングリソースを消費します。 コンピューティングリソースの使用方法の詳細については、「コンピューティングリソースのクォータグループの使用」をご参照ください。

quotaA

status

string

プロジェクトのステータス。 有効な値:

  • AVAILABLE

  • READONLY

  • FROZEN

  • DELETING

AVAILABLE

costStorage

string

合計ストレージ使用量。 プロジェクトが占有するストレージ領域であり、プロジェクトデータが収集および圧縮された後の論理ストレージ領域です。

16489027

regionId

string

リージョン ID。

cn-beijing

createdTime

integer

作成時間。

1704380838000

properties

object

プロジェクトの基本プロパティ。

timezone

string

プロジェクトで使用されるタイムゾーン。 タイムゾーンは odps.sql.timezone で指定されたタイムゾーンと同じです。

Asia/Shanghai

retentionDays

integer

バックアップデータの保存期間。 単位:日。 保存期間中、使用中のバージョンのデータを任意のバージョンのバックアップデータに復元できます。 有効な値の範囲:[0,30]。 デフォルト値:1。 値 0 は、バックアップ機能が無効になっていることを示します。

1

allowFullScan

boolean

プロジェクトで全表スキャンが許可されているかどうかを示します。 全表スキャンは大量のリソースを占有し、データ処理効率を低下させます。 デフォルトでは、全表スキャン機能は無効になっています。

false

typeSystem

string

データ型エディション。 有効な値:

  • 1:MaxCompute V1.0 データ型エディション

  • 2:MaxCompute V2.0 データ型エディション

  • hive:Hive 互換データ型エディション

3つのデータ型エディションの違いの詳細については、「データ型エディション」をご参照ください。

2

enableDecimal2

boolean

MaxCompute V2.0 データ型エディションの DECIMAL 型が有効になっているかどうかを示します。

true

sqlMeteringMax

string

単一の SQL 文の最大消費しきい値。 計算式:スキャンされたデータ量 (GB) × 複雑度。

1500

tableLifecycle

object

テーブルのライフサイクルプロパティ。

type

string

ライフサイクルタイプ。 有効な値:

  • mandatory:テーブル作成ステートメントでライフサイクル句が必要です。

  • optional:テーブル作成ステートメントでライフサイクル句はオプションです。 テーブルにライフサイクルを設定しない場合、テーブルは有効期限切れになりません。

  • inherit:テーブル作成時にテーブルのライフサイクルを設定しない場合、odps.table.lifecycle.value パラメーターの値がデフォルトでテーブルのライフサイクルとして使用されます。

optional

value

string

テーブルのライフサイクル。 単位:日。 有効な値:1~37231。 デフォルト値:37231。

37231

encryption

object

ストレージ暗号化プロパティ。

enable

boolean

プロジェクトでデータ暗号化機能を有効にする必要があるかどうかを示します。 データ暗号化の詳細については、

ストレージ暗号化をご参照ください。

true

algorithm

string

キーでサポートされているデータ暗号化アルゴリズム。 有効な値:AES256、AESCTR、および RC4。

SHA1

key

string

データ暗号化に使用されるキーのタイプ。 キータイプとして MaxCompute デフォルトキーまたは Bring Your Own Key (BYOK) を選択できます。 MaxCompute デフォルトキーを選択した場合、MaxCompute によって作成されたデフォルトキーが使用されます。

dafault

tunnelQuota

string

プロジェクトにバインドされている Tunnel リソースグループ。

  • デフォルトのリソースグループ:Tunnel 共有リソースグループが使用されます。 プロジェクトにサブスクリプションベースの Tunnel リソースグループを使用することはできません。 デフォルトのリソースグループは、パラメーター設定に関係なく、プロジェクトの Tunnel サービスによって自動的に使用されます。

  • サブスクリプションベースの Tunnel リソースグループ:プロジェクトにサブスクリプションベースの Tunnel リソースグループを使用できます。

quota_tunnel

enableTunnelQuotaRoute

boolean

Tunnel リソースグループのルーティングが有効になっているかどうかを示します。

  • true:プロジェクトによってデフォルトで送信されるデータ転送タスクは、プロジェクトにバインドされている Tunnel リソースグループを使用します。

  • false:プロジェクトによってデフォルトで送信されるデータ転送タスクは、Tunnel 共有リソースグループを使用します。

true

externalProjectProperties

object

外部プロジェクトのプロパティ。

isExternalCatalogBound

string

外部プロジェクトが データレイクハウスソリューション 2.0 のための外部プロジェクトであるかどうかを示します。

true

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

データ保護メカニズムのプロパティ。

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 アドレスホワイトリスト。

説明

インターネットまたは他の Alibaba Cloud サービスと相互接続するためのネットワーク経由のアクセスのための IP アドレスホワイトリストのみを構成する場合、インターネットまたは他の Alibaba Cloud サービスと相互接続するためのネットワーク経由のアクセスは構成に従い、Virtual Private 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。

"aaaa-bbbb"

resourceType

string

デフォルトのコンピューティングクォータの課金方法。

"project"

threeTierModel

boolean

スキーマによるデータストレージがサポートされているかどうかを示します。 MaxCompute はスキーマ機能をサポートしています。 この機能を使用すると、プロジェクト内のテーブル、リソース、ユーザー定義関数 (UDF) などのオブジェクトをスキーマ別に分類できます。 プロジェクト内に複数のスキーマを作成できます。 詳細については、「スキーマ関連の操作」をご参照ください。

有効な値:

  • true:サポートされています

  • false:サポートされていません

列挙値:

  • true :
  • false :

true

marker

string

返されるリストの開始位置を示すマーカーを示します。

cHlvZHBzX3VkZl8xMDExNV8xNDU3NDI4NDkzKg==

maxItem

integer

ページごとに返されるエントリの最大数。

10

NextToken

string

ページネーショントークン。 連続したページめくりにのみ対応しています。 NextToken が空でない場合、次のページが存在します。 NextToken の値は、次のリクエストで結果の新しいページを取得するために使用できます。

AAAAAV3MpHK1AP0pfERHZN5pu6kvikyUl3ChyRxN+qLPvtOb

成功レスポンス

JSONJSON

{
  "requestId": "0b16399216671970335563173e2340",
  "data": {
    "projects": [
      {
        "name": "odps_project",
        "owner": "1139815775606813",
        "type": "managed",
        "comment": "maxcompute projects\n",
        "defaultQuota": "quotaA",
        "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": "SHA1",
            "key": "dafault"
          },
          "tunnelQuota": "quota_tunnel",
          "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": "\"aaaa-bbbb\"",
          "resourceType": "\"project\""
        },
        "threeTierModel": true
      }
    ],
    "marker": "cHlvZHBzX3VkZl8xMDExNV8xNDU3NDI4NDkzKg==",
    "maxItem": 10,
    "NextToken": "AAAAAV3MpHK1AP0pfERHZN5pu6kvikyUl3ChyRxN+qLPvtOb"
  }
}

エラーコード

完全なリストについては、「エラーコード」をご参照ください。

変更履歴

完全なリストについては、「変更履歴」をご参照ください。