ListProjects API によるワークスペースリストの取得 - DataWorks - Alibaba Cloud - DataWorks

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

操作説明

事前準備: DataWorks が有効化されており、呼び出しアカウントに OpenAPI オペレーションの呼び出しに必須の RAM 権限が設定されている必要があります。権限またはサービスが準備できていない場合、403 Forbidden.Access エラーが返される可能性があります。

今すぐお試しください

この 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 ロールに付与する必要があります。

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

dataworks:ListProjects

get

*Project

acs:dataworks:{#regionId}:{#accountId}:workspace/*

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
PageNumber	integer	任意	ページ番号。最小値: 1。最大値: 100。	1
PageSize	integer	任意	1 ページあたりのエントリ数。デフォルト値: 10。最大値: 100。	10
ResourceManagerResourceGroupId	string	任意	リソースグループの ID。	rg-acfmzbn7pt****
Tags	array<object>	任意	ワークスペースにバインドされているタグのリスト。
	object	任意	タグ情報。
Key	string	任意	タグキー。	key
Value	string	任意	タグ値。	value

レスポンスフィールド

フィールド	型	説明	例
	object	応答。
PageResult	object	クエリ結果。
PageNumber	integer	現在のページ番号。	1
PageSize	integer	1 ページあたりのエントリ数。デフォルト値: 10。最大値: 100。	10
ProjectList	array<object>	DataWorks ワークスペースのリスト。
	array<object>	ワークスペースの詳細。
DisableDevelopment	boolean	開発ロールが無効化されているかどうかを示します。有効な値: false: 開発ロールが有効です。 true: 開発ロールが無効です。	true
IsDefault	integer	ワークスペースがデフォルトワークスペースであるかどうかを示します。有効な値: 1: はい。 0: いいえ。	1
ProjectDescription	string	ワークスペースの詳細な説明。	test_describe
ProjectId	integer	ワークスペースの ID。	466230
ProjectIdentifier	string	ワークスペースの名前。	test_project
ProjectName	string	ワークスペースの表示名。	test_project
ProjectOwnerBaseId	string	ワークスペースオーナーのユーザー ID。	13969939245****
ProjectStatus	integer	ワークスペースのステータス。有効な値: AVAILABLE: 0. ワークスペースは正常です。 DELETED: 1. ワークスペースは削除されています。 INITIALIZING: 2. ワークスペースは初期化中です。 INIT_FAILED: 3. ワークスペースの初期化に失敗した。 FORBIDDEN: 4. ワークスペースは手動で無効化されています。 DELETING: 5. ワークスペースは削除中です。 DEL_FAILED: 6. ワークスペースの削除に失敗した。 FROZEN: 7. 支払い遅延によりワークスペースは凍結されています。 UPDATING: 8. コンピュートエンジンの追加および初期化によりワークスペースは更新中です。 UPDATE_FAILED: 9. コンピュートエンジンの追加および初期化によるワークスペースの更新に失敗した。	0
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
ResourceManagerResourceGroupId	string	リソースグループの ID。	rg-acfmzbn7****
TablePrivacyMode	integer	MaxCompute テーブルの可視性権限。有効な値: 0: MaxCompute テーブルはテナント内のユーザーに対して非表示です。 1: MaxCompute テーブルはテナント内のユーザーに対して表示されます。	1
Tags	array<object>	ワークスペースにバインドされているタグのリスト。
	object	タグ情報。
Key	string	タグキー。	key
Value	string	タグ値。	value
UseProxyOdpsAccount	boolean	プロキシアカウントを使用して MaxCompute エンジンにアクセスするかどうかを示します。有効な値: false: プロキシアカウントは使用されません。 true: プロキシアカウントが使用されます。	true
TotalCount	integer	返されるエントリの総数。	68
RequestId	string	リクエストの ID。	20658801****

例

成功レスポンス

JSONJSON

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

エラーコード

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.	追加対象のメンバーがテナントに存在しません。

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

変更履歴

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