すべてのプロダクト
Search

このプロダクト

    DataWorks:GetProject

    ドキュメントセンター

    DataWorks:GetProject

    最終更新日:Sep 03, 2026

    DataWorks ワークスペースの詳細を照会します。

    操作説明

    この操作を使用するには、DataWorks Basic Edition 以上のエディションを購入する必要があります。

    今すぐお試しください

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

    get

    *すべてのリソース。

    *

    		 なし なし

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    Id

    integer

    必須

    DataWorks ワークスペースの ID。DataWorks コンソール にログインし、ワークスペース管理ページに移動して ID を取得できます。

    このパラメーターは、この API 呼び出しの対象となる DataWorks ワークスペースを指定します。

    123456

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    応答。

    RequestId

    string

    リクエスト ID。ログの特定や問題のトラブルシューティングに使用されます。

    22C97E95-F023-56B5-8852-B1A77A1****
    Project

    object

    ワークスペースの詳細。

    Id

    integer

    ワークスペースの ID。

    28477242
    Name

    string

    ワークスペース名。

    sora_finance
    DisplayName

    string

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

    Sora financial analysis
    Description

    string

    ワークスペースの説明。

    財務分析グループプロジェクトデータ開発
    Owner

    string

    ワークスペースのオーナーのユーザー ID (Alibaba Cloud アカウント ID)。

    207947397706614299
    AliyunResourceGroupId

    string

    ワークスペースが属する Alibaba Cloud リソースグループの ID。

    rg-acfmzbn7pti3zfa
    Status

    string

    ワークスペースのステータス。有効な値:

    • Available: ワークスペースは正常に実行中です。

    • Initializing: ワークスペースは初期化中です。

    • InitFailed: ワークスペースの初期化に失敗しました。

    • Forbidden: ワークスペースは手動で無効化されています。

    • Deleting: ワークスペースは削除中です。

    • DeleteFailed: ワークスペースの削除に失敗しました。

    • Frozen: 支払い遅延のためワークスペースが凍結されています。

    • Updating: ワークスペースは更新中です。

    • UpdateFailed: ワークスペースの更新に失敗しました。

    Available
    PaiTaskEnabled

    boolean

    PAI タスクのスケジューリングが有効かどうかを示します。有効な値:

    • true: DataWorks ワークスペースで Machine Learning Platform for AI (PAI) ノードを作成し、ノード設定に基づいて定期的なスケジュールで実行できます。

    • false: PAI タスクのスケジューリングは無効です。

    true
    DevEnvironmentEnabled

    boolean

    開発環境が有効かどうかを示します。有効な値:

    • true: ワークスペースで開発環境が有効になっており、開発環境と本番環境の隔離がサポートされています。

    • false: 本番環境のみが使用されます。

    true
    DevRoleDisabled

    boolean

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

    • false: 開発ロールは有効です。

    • true: 開発ロールは無効です。

    false
    AliyunResourceTags

    array<object>

    タグ。

    object

    タグの詳細。

    Key

    string

    タグキー。

    batch
    Value

    string

    タグ値。

    blue

    例

    成功レスポンス

    JSONJSON

    {
  "RequestId": "22C97E95-F023-56B5-8852-B1A77A1****",
  "Project": {
    "Id": 28477242,
    "Name": "sora_finance",
    "DisplayName": "Sora financial analysis",
    "Description": "Financial analysis group project data development",
    "Owner": "207947397706614299",
    "AliyunResourceGroupId": "rg-acfmzbn7pti3zfa",
    "Status": "Available",
    "PaiTaskEnabled": true,
    "DevEnvironmentEnabled": true,
    "DevRoleDisabled": false,
    "AliyunResourceTags": [
      {
        "Key": "batch",
        "Value": "blue"
      }
    ]
  }
}

    エラーコード

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

    変更履歴

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