ListResourceGroups API 概要 - DataWorks - Alibaba Cloud - DataWorks - Alibaba Cloud ドキュメントセンター

リソースグループのリストを取得します。

操作説明

この操作には、DataWorks Basic Edition 以上が必要です。
この操作を呼び出す前に、サービスリンクロール AliyunServiceRoleForDataWorks が作成されていることを確認してください。

今すぐお試しください

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

list

*DwResourceGroup

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

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
Name	string	任意	リソースグループの名前。あいまい検索がサポートされています。	Resource
ProjectId	integer	任意	ワークスペースの ID。	1000
Statuses	array	任意	クエリ対象のリソースグループのステータス。
	string	任意	リソースグループのステータス。有効な値は次のとおりです： `Normal`：リソースグループは実行中です。 `Stop`：リソースグループは停止しています。通常、期限切れが原因です。 `Deleted`：リソースグループは削除、リリース、または破棄済みです。 `Creating`：リソースグループは作成中です。 `CreateFailed`：リソースグループの作成に失敗しました。 `Updating`：リソースグループは更新中です (スケールアップ、スケールダウン、構成変更など)。 `UpdateFailed`：リソースグループの更新に失敗しました (スケーリングやスペックアップの失敗など)。 `Deleting`：リソースグループは削除、リリース、または破棄中です。 `DeleteFailed`：リソースグループの削除に失敗しました (リリースや破棄の失敗など)。 `Timeout`：操作がタイムアウトしました。 `Frozen`：リソースグループは凍結されています。 `Starting`：リソースグループは起動中です。	Normal
ResourceGroupTypes	array	任意	クエリ対象のリソースグループのタイプ。このパラメーターが指定されていない場合、デフォルトで汎用リソースグループがクエリされます。
	string	任意	リソースグループのタイプ。有効な値は次のとおりです： `CommonV2`：汎用リソースグループ (新バージョン)。 `ExclusiveDataIntegration`：Data Integration 専用リソースグループ。 `ExclusiveScheduler`：専用スケジューリングリソースグループ。 `ExclusiveDataService`：データサービス専用リソースグループ。	CommonV2
PaymentType	string	任意	リソースグループの課金方法。有効な値は次のとおりです： `PrePaid`：サブスクリプション。 `PostPaid`：従量課金。	PrePaid
AliyunResourceGroupId	string	任意	Alibaba Cloud リソースグループ ID。	rg-aek2kqofrgXXXXX
AliyunResourceTags	array<object>	任意	Alibaba Cloud タグのリスト。
	object	任意	Alibaba Cloud タグ。
Key	string	任意	タグキー。	key
Value	string	任意	タグ値。	value
PageSize	integer	任意	ページサイズ。	100
PageNumber	integer	任意	ページ番号。	1
SortBy	string	任意	結果のソート条件。フォーマットは `FieldName SortOrder` です。`SortOrder` には `Asc` (昇順) または `Desc` (降順) を指定できます。`SortOrder` を指定しない場合、デフォルトは `Asc` です。次のフィールドがサポートされています： `Id`：リソースグループ ID `Name`：リソースグループ名 `Remark`：リソースグループの備考 `Type`：リソースグループタイプ `Status`：リソースグループのステータス `Spec`：リソースグループの仕様 `CreateUser`：リソースグループを作成したユーザー `CreateTime`：リソースグループが作成された時刻デフォルト値：`CreateTime Asc`	CreateTime Asc

レスポンスフィールド

フィールド	型	説明	例
	object	返されたデータ。
Success	boolean	リクエストが成功したかどうかを示します。	true
PagingInfo	object	ページネーション情報。
ResourceGroupList	array<object>	リソースグループのリスト。
	array<object>	リソースグループの詳細。
Id	string	リソースグループの一意の識別子。	Serverless_res_group_524257424564736_6831777003XXXXX
Name	string	リソースグループの名前。	common_resource_group
Remark	string	リソースグループの説明。	创建用于普通任务的通用资源组
PaymentType	string	リソースグループの課金方法。`PrePaid` はサブスクリプションを示し、`PostPaid` は従量課金を示します。	PrePaid
Status	string	リソースグループのステータス。有効な値： `Normal`：実行中。 `Stop`：期限切れによる凍結。 `Deleted`：リリース済み。 `Creating`：作成中。 `CreateFailed`：作成失敗。 `Updating`：更新中。 `UpdateFailed`：更新失敗。 `Deleting`：リリース中。 `DeleteFailed`：リリース失敗。 `Timeout`：操作がタイムアウトしました。 `Freezed`：凍結。 `Starting`：起動中。	Normal
Spec	object	リソースグループの仕様。
Standard	string	リソースの仕様。	2CU
Amount	integer	リソースユニットの数。	1
ResourceGroupType	string	リソースグループのタイプ。有効な値： `CommonV2`：新しい汎用リソースグループ。 `ExclusiveDataIntegration`：Data Integration 専用リソースグループ。 `ExclusiveScheduler`：専用スケジューリングリソースグループ。 `ExclusiveDataService`：データサービス専用リソースグループ。	CommonV2
OrderInstanceId	string	リソースグループの注文 ID。	c442b330-3b10-4584-959e-736e4edXXXXX
CreateUser	string	作成者のユーザー ID。	11075500042XXXXX
CreateTime	integer	リソースグループの作成時刻 (64 ビットのタイムスタンプ)。	1727055811000
DefaultVpcId	string	汎用リソースグループにバインドされているデフォルトの Virtual Private Cloud (VPC) の ID。	vpc-m2et4f3oc8msfbccXXXXX
DefaultVswicthId	string	汎用リソースグループにバインドされているデフォルトの vSwitch の ID。	vsw-uf8usrhs7hjd9amsXXXXX
AliyunResourceGroupId	string	Alibaba Cloud リソースグループ ID。	rg-aek2kqofrgXXXXX
AliyunResourceTags	array<object>	Alibaba Cloud タグのリスト。
	object	Alibaba Cloud タグ。
Key	string	タグキー。	Key
Value	string	タグ値。	Value
PageNumber	integer	ページ番号。	1
PageSize	integer	1 ページあたりのエントリ数。	100
TotalCount	integer	エントリの総数。	100
RequestId	string	リクエスト ID。この ID を使用して、ログの特定や問題のトラブルシューティングを行うことができます。	6A6CBE87-9F91-1323-B680-E7A7065XXXXX

例

成功レスポンス

JSONJSON

{
  "Success": true,
  "PagingInfo": {
    "ResourceGroupList": [
      {
        "Id": "Serverless_res_group_524257424564736_6831777003XXXXX",
        "Name": "common_resource_group",
        "Remark": "创建用于普通任务的通用资源组",
        "PaymentType": "PrePaid",
        "Status": "Normal",
        "Spec": {
          "Standard": "2CU",
          "Amount": 1
        },
        "ResourceGroupType": "CommonV2",
        "OrderInstanceId": "c442b330-3b10-4584-959e-736e4edXXXXX",
        "CreateUser": "11075500042XXXXX",
        "CreateTime": 1727055811000,
        "DefaultVpcId": "vpc-m2et4f3oc8msfbccXXXXX",
        "DefaultVswicthId": "vsw-uf8usrhs7hjd9amsXXXXX",
        "AliyunResourceGroupId": "rg-aek2kqofrgXXXXX",
        "AliyunResourceTags": [
          {
            "Key": "Key",
            "Value": "Value"
          }
        ]
      }
    ],
    "PageNumber": 1,
    "PageSize": 100,
    "TotalCount": 100
  },
  "RequestId": "6A6CBE87-9F91-1323-B680-E7A7065XXXXX"
}

エラーコード

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

変更履歴

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