API でリソースグループメトリックデータをクエリ - DataWorks

リソースグループのメトリックデータを照会します。

操作説明

DataWorks 基本版以上のバージョンをご購入いただく必要があります。
この API を使用する前に、サービスにリンクされたロール AliyunServiceRoleForDataWorks を作成済みであることをご確認ください。
この API は Serverless リソースグループにのみ適用されます。

今すぐお試しください

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

get

*DwResourceGroup

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

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
ResourceGroupId	string	必須	汎用リソースグループの一意な識別子です。	Serverless_res_group_524257424564736_6831777003XXXXX
MetricName	string	必須	メトリック名です。有効な値は以下のとおりです。 CUSpec：リソースグループの最大 CU 容量（単位：CU） CUUsage：リソースグループの CU 使用量（単位：CU） CUUtilization：リソースグループの CU 使用率（単位：%） SlotSpec：リソースグループスケジューリングにおける同時実行スロット数の上限（単位：スロット） SlotUsage：リソースグループスケジューリングにおける使用中の同時実行数（単位：スロット） SchedulerCUMaxSpec：データ計算における最大 CU クォータ（単位：CU） SchedulerCUUsage：データ計算における CU 使用量（単位：CU） SchedulerCUMinSpec：データ計算における最小保証 CU 数（単位：CU） DataIntegrationCUMaxSpec：Data Integration における最大 CU クォータ（単位：CU） DataIntegrationCUUsage：Data Integration における CU 使用量（単位：CU） DataIntegrationCUMinSpec：Data Integration における最小保証 CU 数（単位：CU） DataServiceCUMaxSpec：DataService Studio における最大 CU クォータ（単位：CU） DataServiceCUUsage：DataService Studio における CU 使用量（単位：CU） DataServiceCUMinSpec：DataService Studio における最小保証 CU 数（単位：CU） ServerIdeCUMaxSpec：個人開発環境における最大 CU クォータ（単位：CU） ServerIdeCUUsage：個人開発環境における CU 使用量（単位：CU） ServerIdeCUMinSpec：個人開発環境における最小保証 CU 数（単位：CU）	CUSpec
Period	string	任意	モニタリングデータの統計期間です。値：60 の倍数単位：秒デフォルト値：60	60
BeginTime	integer	任意	開始時刻です。サポートされる形式：UNIX タイムスタンプ（ミリ秒単位、1970 年 1 月 1 日からの経過ミリ秒数） BeginTime と EndTime の間隔は 31 日以下である必要があります。デフォルト値：現在時刻から 2 時間前のミリ秒単位 UNIX タイムスタンプ	1593950832000
EndTime	integer	任意	終了時刻です。サポートされる形式：UNIX タイムスタンプ（ミリ秒単位、1970 年 1 月 1 日からの経過ミリ秒数） BeginTime と EndTime の間隔は 31 日以下である必要があります。デフォルト値：現在時刻のミリ秒単位 UNIX タイムスタンプ	1750176000000
NextToken	string	任意	ページネーションカーソルです。説明このパラメーターが設定されていない場合、最初のページのデータが取得されます。このパラメーターに値が返された場合は、次のページが存在することを示します。返された NextToken をパラメーターとして使用して次のページのデータをリクエストできます。Null が返された場合は、すべてのデータが取得されたことを意味します。	FFqBJBxE8I0PE0IUO6K69k7m2FfyWNNc2qQ9ReUkazhz9VA7dWZKlxBcjUwOV0imSM
Length	integer	任意	ページネーションクエリにおいて、1 ページあたりに表示するレコード数です。説明 1 回のリクエストにおける Length の最大値は 1440 です。	100

レスポンスフィールド

フィールド	型	説明	例
	object	返された結果です。
Success	boolean	リクエストが成功したかどうかを示します。	true
MetricData	object	モニタリングメトリックデータです。
Id	string	リソースグループの一意な識別子です。	Serverless_res_group_524257424564736_6831777003XXXXX
MetricName	string	メトリック名です。有効な値は以下のとおりです。 CUSpec：リソースグループの最大 CU 容量（単位：CU） CUUsage：リソースグループの CU 使用量（単位：CU） CUUtilization：リソースグループの CU 使用率（単位：%） SlotSpec：リソースグループスケジューリングにおける同時実行スロット数の上限（単位：スロット） SlotUsage：リソースグループスケジューリングにおける使用中の同時実行数（単位：スロット） SchedulerCUMaxSpec：データ計算における最大 CU クォータ（単位：CU） SchedulerCUUsage：データ計算における CU 使用量（単位：CU） SchedulerCUMinSpec：データ計算における最小保証 CU 数（単位：CU） DataIntegrationCUMaxSpec：Data Integration における最大 CU クォータ（単位：CU） DataIntegrationCUUsage：Data Integration における CU 使用量（単位：CU） DataIntegrationCUMinSpec：Data Integration における最小保証 CU 数（単位：CU） DataServiceCUMaxSpec：DataService Studio における最大 CU クォータ（単位：CU） DataServiceCUUsage：DataService Studio における CU 使用量（単位：CU） DataServiceCUMinSpec：DataService Studio における最小保証 CU 数（単位：CU） ServerIdeCUMaxSpec：個人開発環境における最大 CU クォータ（単位：CU） ServerIdeCUUsage：個人開発環境における CU 使用量（単位：CU） ServerIdeCUMinSpec：個人開発環境における最小保証 CU 数（単位：CU）	CUSpec
NextToken	string	ページネーションカーソルです。	tSBOXZcAmk+akxRkwRuXnGQEsIDODyd5ulPqgytNTbLp4bhb7fuvz13FXtm87Kfl
Metrics	array<object>	メトリックデータのリストです。
	object	メトリックデータです。
Value	number	メトリックデータの値です。	1.0
Timestamp	integer	タイムスタンプです。	1761184929633
RequestId	string	ログの検索やトラブルシューティングに使用されるリクエスト ID です。	6A6CBE87-9F91-1323-B680-E7A7065XXXXX

例

成功レスポンス

JSONJSON

{
  "Success": true,
  "MetricData": {
    "Id": "Serverless_res_group_524257424564736_6831777003XXXXX\n",
    "MetricName": "CUSpec",
    "NextToken": "tSBOXZcAmk+akxRkwRuXnGQEsIDODyd5ulPqgytNTbLp4bhb7fuvz13FXtm87Kfl",
    "Metrics": [
      {
        "Value": 1,
        "Timestamp": 1761184929633
      }
    ]
  },
  "RequestId": "6A6CBE87-9F91-1323-B680-E7A7065XXXXX\n"
}

エラーコード

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

変更履歴

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