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

DataWorks:GetResourceGroup

最終更新日:Sep 03, 2026

ID を指定してリソースグループの情報を取得します。

操作説明

この特徴を使用するには、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:GetResourceGroup

get

*ソース

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

なし なし

リクエストパラメーター

パラメーター

型

必須 / 任意

説明

例

Id

string

必須

リソースグループの一意の識別子。

Serverless_res_group_524257424564736_6831777003XXXXX

レスポンスフィールド

フィールド

型

説明

例

object

レスポンススキーマ。

Success

boolean

リクエストが成功したかどうかを示します。

true

ResourceGroup

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: 起動中。

列挙値:

  • Creating :

    作成中。

  • Stop :

    凍結 (期限切れ)

  • Timeout :

    操作タイムアウト。

  • DeleteFailed :

    削除失敗した (リリース失敗した/破棄失敗した)

  • UpdateFailed :

    更新失敗した (スケーリングアウト失敗した/スペックアップ失敗した)

  • Updating :

    更新中 (スケーリングアウト/スケーリングイン/スペック変更進行中)

  • Deleted :

    削除済み (リリース済み/破棄済み)

  • Normal :

    法線 (実行中/サービス稼働中)

  • Deleting :

    削除中 (リリース中/破棄中)

  • CreateFailed :

    作成失敗した。

Normal

Spec

object

リソースグループのスペック。

Standard

string

リソースグループ内の計算ユニット (CU) 数です。

2CU

Amount

integer

リソースグループ内のリソース数です。

1

ResourceGroupType

string

リソースグループのタイプ。有効な値:

  • CommonV2: 新バージョンのリソースグループ。

  • ExclusiveDataIntegration: 排他的 Data Integration リソースグループ。

  • ExclusiveScheduler: 排他的スケジューリングリソースグループ。

  • ExclusiveDataService: 排他的データサービスリソースグループ。

列挙値:

  • 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

リソースグループにバインドされているデフォルト VPC の ID。

vpc-m2et4f3oc8msfbccXXXXX

DefaultVswitchId

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

RequestId

string

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

6A6CBE87-9F91-1323-B680-E7A7065XXXXX

例

成功レスポンス

JSONJSON

{
  "Success": true,
  "ResourceGroup": {
    "Id": "Serverless_res_group_524257424564736_6831777003XXXXX",
    "Name": "common_resource_group",
    "Remark": "Create a common resource group for common tasks",
    "PaymentType": "PrePaid",
    "Status": "Normal",
    "Spec": {
      "Standard": "2CU",
      "Amount": 1
    },
    "ResourceGroupType": "CommonV2",
    "OrderInstanceId": "c442b330-3b10-4584-959e-736e4edXXXXX",
    "CreateUser": "11075500042XXXXX",
    "CreateTime": 1727055811000,
    "DefaultVpcId": "vpc-m2et4f3oc8msfbccXXXXX",
    "DefaultVswitchId": "vsw-uf8usrhs7hjd9amsXXXXX",
    "AliyunResourceGroupId": "rg-aek2kqofrgXXXXX",
    "AliyunResourceTags": [
      {
        "Key": "key",
        "Value": "value"
      }
    ]
  },
  "RequestId": "6A6CBE87-9F91-1323-B680-E7A7065XXXXX"
}

エラーコード

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

変更履歴

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