ListProjects API で DataWorks ワークスペースを一覧表示 - DataWorks

ご利用のアカウントが所属するテナントの DataWorks ワークスペース一覧を照会します。

今すぐお試しください

この 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

list

*All Resource

*

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
Ids	array	任意	DataWorks ワークスペースの ID。
	integer	任意	DataWorks ワークスペースの ID。DataWorks コンソール（https://dataworks.console.aliyun.com/workspace/list）にログインし、[ワークスペース] ページで確認できます。	123456
Names	array	任意	DataWorks ワークスペースの名前。
	string	任意	DataWorks ワークスペースの名前。DataWorks コンソール（https://dataworks.console.aliyun.com/workspace/list）にログインし、[ワークスペース] ページで確認できます。	sora_finance
AliyunResourceGroupId	string	任意	ワークスペースが属する Alibaba Cloud リソースグループの ID。Resource Management コンソール（https://resourcemanager.console.alibabacloud.com/resource-groups）にログインし、[リソースグループ] ページで確認できます。このパラメーターは、特定のリソースグループに属するワークスペースの情報を照会するために使用します。	rg-acfmzbn7pti3zff
Status	string	任意	ワークスペースのステータス。有効な値は以下のとおりです。 Available Initializing InitFailed Forbidden Deleting DeleteFailed Frozen Updating UpdateFailed	Available
DevEnvironmentEnabled	boolean	任意	開発環境の有効化設定。有効な値は以下のとおりです。 true：開発環境が有効化されています。この場合、ワークスペース内で開発環境が本番環境から分離されます。 false：開発環境が無効化されています。この場合、ワークスペースでは本番環境のみが使用されます。	true
DevRoleDisabled	boolean	任意	Develop ロールの無効化設定。有効な値は以下のとおりです。 false（デフォルト） true	false
PaiTaskEnabled	boolean	任意	Platform for AI (PAI) タスクのスケジューリング有効化設定。有効な値は以下のとおりです。 true：PAI タスクのスケジューリングが有効化されています。この場合、DataWorks ワークスペース内に機械学習ノードを作成し、そのノードに対してスケジューリングプロパティを設定することで、PAI タスクの定期実行が可能になります。 false：PAI タスクのスケジューリングが無効化されています。	true
AliyunResourceTags	array<object>	任意	タグ。
	object	任意	タグ。Resource Management コンソール（https://resourcemanager.console.alibabacloud.com/tags）にログインし、[タグ] ページでタグキーおよびタグ値を確認できます。
Key	string	任意	タグキー。	batch
Value	string	任意	タグ値。	blue
PageNumber	integer	任意	ページ番号。	1
PageSize	integer	任意	1 ページあたりの表示件数。デフォルト値は 10、最大値は 100 です。	10

レスポンスフィールド

フィールド	型	説明	例
	object	レスポンスパラメーター。
RequestId	string	リクエスト ID。	6D24AD9A-652F-59E2-AC1F-05029300F8A4
PagingInfo	object	ページネーション情報。
PageSize	integer	1 ページあたりの表示件数。	1
PageNumber	integer	ページ番号。	10
TotalCount	integer	返された合計件数。	100
Projects	array<object>	ワークスペース。
	array<object>	ワークスペース。
Id	integer	ワークスペース ID。	123456
Name	string	ワークスペースの名前。	sora_finance
DisplayName	string	ワークスペースの表示名。	Sora financial analysis
Description	string	ワークスペースの説明。	Financial analysis group project data development
Owner	string	ワークスペースが属する Alibaba Cloud アカウントの ID。	123532153125
AliyunResourceGroupId	string	ワークスペースが属する Alibaba Cloud リソースグループの ID。	rg-acfmzbn7pti3zfa
Status	string	ワークスペースのステータス。有効な値は以下のとおりです。 Available Initializing InitFailed Forbidden Deleting DeleteFailed Frozen Updating UpdateFailed	Available
PaiTaskEnabled	boolean	PAI タスクのスケジューリング有効化状態。有効な値は以下のとおりです。 true：PAI タスクのスケジューリングが有効化されています。この場合、DataWorks ワークスペース内に機械学習ノードを作成し、そのノードに対してスケジューリングプロパティを設定することで、PAI タスクの定期実行が可能になります。 false：PAI タスクのスケジューリングが無効化されています。	true
DevEnvironmentEnabled	boolean	開発環境の有効化状態。有効な値は以下のとおりです。 true：開発環境が有効化されています。この場合、ワークスペース内で開発環境が本番環境から分離されます。 false：開発環境が無効化されています。この場合、ワークスペースでは本番環境のみが使用されます。	true
DevRoleDisabled	boolean	Develop ロールの無効化状態。有効な値は以下のとおりです。 false（デフォルト） true	false
AliyunResourceTags	array<object>	タグ。
	object	タグ。
Key	string	タグキー。	batch
Value	string	タグ値。	blue

例

成功レスポンス

JSONJSON

{
  "RequestId": "6D24AD9A-652F-59E2-AC1F-05029300F8A4",
  "PagingInfo": {
    "PageSize": 1,
    "PageNumber": 10,
    "TotalCount": 100,
    "Projects": [
      {
        "Id": 123456,
        "Name": "sora_finance",
        "DisplayName": "Sora financial analysis\n",
        "Description": "Financial analysis group project data development",
        "Owner": "123532153125",
        "AliyunResourceGroupId": "rg-acfmzbn7pti3zfa",
        "Status": "Available",
        "PaiTaskEnabled": true,
        "DevEnvironmentEnabled": true,
        "DevRoleDisabled": false,
        "AliyunResourceTags": [
          {
            "Key": "batch",
            "Value": "blue"
          }
        ]
      }
    ]
  }
}

エラーコード

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

変更履歴

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