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

DataWorks:ListProjects

最終更新日:Mar 21, 2026

ユーザーが属するテナントの DataWorks ワークスペースのリストを照会します。

今すぐお試しください

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

テスト

RAM 認証

この操作の認証情報はありません。問題が発生した場合は、アカウントマネージャーにご連絡ください。

リクエストパラメーター

パラメーター

必須 / 任意

説明

PageNumber

integer

任意

ページ番号。有効な値:1~100。

1

PageSize

integer

任意

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

10

ResourceManagerResourceGroupId

string

任意

リソースグループ ID。

rg-acfmzbn7pt****

Tags

array<object>

任意

ワークスペースに追加するタグ。

object

任意

Key

string

任意

ワークスペースに追加するタグ N のキー。

key

Value

string

任意

ワークスペースに追加するタグ N の値。

value

レスポンスフィールド

フィールド

説明

object

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

RequestId

string

リクエスト ID。

20658801****

PageResult

object

返される結果。

PageNumber

integer

ページ番号。

1

PageSize

integer

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

10

TotalCount

integer

返された総エントリ数。

68

ProjectList

array<object>

DataWorks ワークスペース。

array<object>

ProjectStatusCode

string

ワークスペースの状態コード。有効な値:

  • AVAILABLE:0。これは、ワークスペースが正常に稼働中であることを示します。

  • DELETED:1。これは、ワークスペースが削除されたことを示します。

  • INITIALIZING:2。これは、ワークスペースが初期化中であることを示します。

  • INIT_FAILED:3。これは、ワークスペースの初期化に失敗したことを示します。

  • FORBIDDEN:4。これは、ワークスペースが手動で無効化されたことを示します。

  • DELETING:5。これは、ワークスペースが削除中であることを示します。

  • DEL_FAILED:6。これは、ワークスペースの削除に失敗したことを示します。

  • FROZEN:7。これは、支払い遅延によりワークスペースが凍結されたことを示します。

  • UPDATING:8。これは、ワークスペースが更新中であることを示します。コンピュートエンジンをワークスペースに関連付けた後、システムはコンピュートエンジンを初期化し、ワークスペースを更新します。

  • UPDATE_FAILED:9。これは、ワークスペースの更新に失敗したことを示します。

AVAILABLE

ProjectStatus

integer

ワークスペースの状態。有効な値:

  • 0:AVAILABLE。これは、ワークスペースが正常に稼働中であることを示します。

  • 1:DELETED。これは、ワークスペースが削除されたことを示します。

  • 2:INITIALIZING。これは、ワークスペースが初期化中であることを示します。

  • 3:INIT_FAILED。これは、ワークスペースの初期化に失敗したことを示します。

  • 4:FORBIDDEN。これは、ワークスペースが手動で無効化されたことを示します。

  • 5:DELETING。これは、ワークスペースが削除中であることを示します。

  • 6:DEL_FAILED。これは、ワークスペースの削除に失敗したことを示します。

  • 7:FROZEN。これは、支払い遅延によりワークスペースが凍結されたことを示します。

  • 8:UPDATING。これは、ワークスペースが更新中であることを示します。コンピュートエンジンをワークスペースに関連付けた後、システムはコンピュートエンジンを初期化し、ワークスペースを更新します。

  • 9:UPDATE_FAILED。これは、ワークスペースの更新に失敗したことを示します。

0

ProjectName

string

ワークスペースの表示名。

test_project

ProjectIdentifier

string

ワークスペースの名前。

test_project

ProjectId

integer

ワークスペース ID。

466230

ProjectDescription

string

ワークスペースの説明。

test_describe

ProjectOwnerBaseId

string

ワークスペース所有者が使用するユーザーの ID。

13969939245****

ResourceManagerResourceGroupId

string

リソースグループ ID。

rg-acfmzbn7****

Tags

array<object>

ワークスペースに追加されたタグ。

object

Key

string

ワークスペースに追加されたタグ N のキー。

key

Value

string

ワークスペースに追加されたタグ N の値。

value

DisableDevelopment

boolean

開発ロールが無効になっているかどうかを示します。有効な値:

  • false:有効

  • true:無効

true

UseProxyOdpsAccount

boolean

プロキシ アカウントがワークスペースに関連付けられた MaxCompute コンピュートエンジンへのアクセスに使用されるかどうかを示します。有効な値:

  • false

  • true

true

TablePrivacyMode

integer

ワークスペース内の MaxCompute テーブルがテナント内のユーザーに表示されるかどうかを示します。有効な値:

  • 0:非表示

  • 1:表示

1

IsDefault

integer

ワークスペースがデフォルトのワークスペースであるかどうかを示します。有効な値:

  • 1:ワークスペースはデフォルトのワークスペースです。

  • 0:ワークスペースはデフォルトのワークスペースではありません。

1

成功レスポンス

JSONJSON

{
  "RequestId": "20658801****",
  "PageResult": {
    "PageNumber": 1,
    "PageSize": 10,
    "TotalCount": 68,
    "ProjectList": [
      {
        "ProjectStatusCode": "AVAILABLE",
        "ProjectStatus": 0,
        "ProjectName": "test_project",
        "ProjectIdentifier": "test_project",
        "ProjectId": 466230,
        "ProjectDescription": "test_describe",
        "ProjectOwnerBaseId": "13969939245****",
        "ResourceManagerResourceGroupId": "rg-acfmzbn7****",
        "Tags": [
          {
            "Key": "key",
            "Value": "value"
          }
        ],
        "DisableDevelopment": true,
        "UseProxyOdpsAccount": true,
        "TablePrivacyMode": 1,
        "IsDefault": 1
      }
    ]
  }
}

エラーコード

HTTP ステータスコード

エラーコード

エラーメッセージ

説明

400 Invalid.Tenant.ConnectionNotExists The connection does not exist.
400 Invalid.Tenant.ProjectNotExists The project does not exist.
400 Invalid.Tenant.UserAlreadyInProject The user already exists in the project.
400 Invalid.Tenant.UserNotInProject The user is not in the project.
403 Invalid.Tenant.UserIsNotProjectOwnerOrAdmin The user is not a project administrator or owner.
403 Invalid.Tenant.UserNotInTenant The user is not in tenant.

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

変更履歴

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