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

DataWorks:ListComputeResources

最終更新日:Sep 03, 2026

指定されたビジネス情報に一致する計算リソースのリストを照会します。

操作説明

  1. この機能を使用するには、DataWorks の Basic Edition 以上を購入する必要があります。

  2. DataWorks ワークスペースで、次のロールのいずれかが必要です:

  3. テナントオーナー、スペース管理者、デプロイ、開発者、ビジター、プロジェクトオーナー、運用/保守、モデルデザイナー、セキュリティ管理者、データアナリスト、開発プラットフォーム管理者、データガバナンス管理者

今すぐお試しください

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

get

*All Resource

*

なし なし

リクエストパラメーター

パラメーター

型

必須 / 任意

説明

例

ProjectId

integer

必須

DataWorks ワークスペースの ID。

21229

Name

string

任意

計算リソースの名前。

category name

Types

array

任意

計算リソースタイプでフィルターします。複数のタイプを設定してフィルターできます。

string

任意

計算リソースのタイプ。

hologres

EnvType

string

任意

計算リソースの環境タイプ。有効な値:

  • Dev

  • Prod

Dev

PageNumber

integer

任意

照会するページ番号。デフォルト値は 1 で、最初のページを示します。

1

PageSize

integer

任意

1ページあたりのレコード数。デフォルト値は 10、最大値は 100 です。

10

SortBy

string

任意

計算リソースリストのソート基準となるフィールド。名前、作成日時、計算リソース ID がサポートされています。

  • CreateTime:作成日時でソートします

  • Id:計算リソース ID でソートします

  • Name:計算リソース名でソートします。

  • CreateTimeWithDefaultFirst:デフォルトリソースであるかどうかと作成日時でソートし、デフォルトの計算リソースを最初にリストします。

デフォルト値:CreateTime

CreateTimeWithDefaultFirst

Order

string

任意

計算リソースリストのソート順。有効な値:

  • Desc:降順。

  • Asc:昇順。

デフォルト値:Desc

Asc

レスポンスフィールド

フィールド

型

説明

例

object

返される結果。

RequestId

string

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

7C352CB7-CD88-50CF-9D0D-E81BDF02XXXX

PagingInfo

object

ページネーション情報。

TotalCount

integer

レコードの総数。

100

PageSize

integer

1ページあたりのレコード数。

10

PageNumber

integer

現在のページ番号。

1

ComputeResources

array<object>

計算リソースのリスト。各要素は、開発環境 (存在する場合) と本番環境に関する情報を含む計算リソースグループです。

array<object>

計算リソースグループに関する情報。開発環境 (存在する場合) と本番環境の計算リソースが含まれます。開発環境と本番環境の計算リソースは、名前とタイプは同じですが、ID は異なります。

Name

string

計算リソースの名前。

cal_all_vemg_workflow_parallel

Type

string

計算リソースのタイプ。

hologres

ComputeResource

array<object>

単一の計算リソースの詳細。

object

単一の計算リソースの詳細。

Id

integer

計算リソース ID。リソースの一意の識別子です。

8649832502405358603

ConnectionProperties

any

追加された計算リソースのカテゴリ。タイプごとにサブタイプが異なり、対応するパラメーター制約があります。例:InstanceMode (インスタンスモード)、UrlMode (接続文字列モード)。

{\n \"clusterIdentifier\": \"c-da123456\",\n \"database\": \"testdb\",\n \"loginMode\":\"Anonymous\",\n \"defaultFS\":\"127.0.0.1\",\n \"envType\": \"Prod\"\n}

ConnectionPropertiesMode

string

計算リソースの特定の接続構成の詳細。エンドポイント、アクセス ID、環境情報が含まれます。計算リソースの環境を指定する envType は、このオブジェクトのプロパティです。有効な値:

  • Dev

  • Prod 異なるタイプのコンピューティングリソースは、異なる構成モード (ConnectionPropertiesMode) では異なる属性仕様を持ちます。

UrlMode

Description

string

コンピューティングリソースの一意の識別子。

home_feed

CreateTime

integer

作成日時 (タイムスタンプ)。

1624387842781448

CreateUser

string

作成者の ID。

1648711113000

ModifyTime

integer

計算リソースの最終更新日時 (タイムスタンプ)。

1624387842781448

ModifyUser

string

変更者の ID。

1648711113000

WhetherDefault

boolean

デフォルトの計算リソースであるかどうかを指定します。

true

例

成功レスポンス

JSONJSON

{
  "RequestId": "7C352CB7-CD88-50CF-9D0D-E81BDF02XXXX",
  "PagingInfo": {
    "TotalCount": 100,
    "PageSize": 10,
    "PageNumber": 1,
    "ComputeResources": [
      {
        "Name": "cal_all_vemg_workflow_parallel",
        "Type": "hologres",
        "ComputeResource": [
          {
            "Id": 8649832502405359000,
            "ConnectionProperties": "{\\n    \\\"clusterIdentifier\\\": \\\"c-da123456\\\",\\n    \\\"database\\\": \\\"testdb\\\",\\n    \\\"loginMode\\\":\\\"Anonymous\\\",\\n    \\\"defaultFS\\\":\\\"127.0.0.1\\\",\\n    \\\"envType\\\": \\\"Prod\\\"\\n}",
            "ConnectionPropertiesMode": "UrlMode",
            "Description": "home_feed",
            "CreateTime": 1624387842781448,
            "CreateUser": "1648711113000",
            "ModifyTime": 1624387842781448,
            "ModifyUser": "1648711113000",
            "WhetherDefault": true
          }
        ]
      }
    ]
  }
}

エラーコード

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

変更履歴

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