API によるページネーションと RAM 認証でワークスペースを一覧表示 - E-MapReduce - Alibaba Cloud -

ワークスペースのリストを取得するには、ListWorkspaces API を呼び出します。

今すぐお試しください

この 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 ロールに付与する必要があります。

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

emr-serverless-spark:ListWorkspaces

リスト

* すべてのリソース

*

なし

リクエスト構文

GET /api/v1/workspaces HTTP/1.1

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
nextToken	文字列	任意	次のページを取得するためのトークンです。	1
maxResults	整数	任意	1 ページあたりの結果の最大数です。	20
name	文字列	任意	ワークスペースの名前です。あいまい検索に対応しています。	test_workspace
state	文字列	任意	ワークスペースの状態です。	running
regionId	文字列	任意	リージョン ID です。	cn-hangzhou
tag	オブジェクトの配列	任意	1 つ以上のタグで結果をフィルタリングします。
	オブジェクト	任意	タグオブジェクトです。
key	文字列	任意	タグキーです。	cn-shenzhen-finance.edas.config.server
value	文字列	任意	タグ値です。	iPhone disk space remaining rate
resourceGroupId	文字列	任意	リソースグループ ID です。	rg-aek2thxggoqhmhq

レスポンスフィールド

フィールド	型	説明	例
	オブジェクト	返されるデータです。
workspaces	配列 <オブジェクト>	ワークスペースのリストです。
	配列 <オブジェクト>	ワークスペースの詳細です。
workspaceId	文字列	ワークスペース ID です。	w-******
workspaceName	文字列	ワークスペース名です。	Spark batch workspace-1
resourceSpec	文字列	リソース仕様です。	100cu
storage	文字列	OSS パスです。	spark-result
dlfCatalogId	文字列	DLF カタログ情報です。	default
paymentType	文字列	課金方法です。	PayAsYouGo or Subscription
paymentDurationUnit	文字列	サブスクリプション期間です (前払いの場合、必須)。	YEAR, MONTH, WEEK, DAY, HOUR, MINUTE
duration	整数	前払いの場合、サブスクリプション期間の値が必要です。	1
autoRenew	ブール値	自動更新を有効にするかどうかを指定します (前払いの場合、必須)。	true
autoRenewPeriod	整数	自動更新期間です (前払いの場合、必須)。	1
autoRenewPeriodUnit	文字列	自動更新の期間単位です (前払いの場合、必須)。	YEAR, MONTH, WEEK, DAY, HOUR, MINUTE
workspaceStatus	文字列	ワークスペースのステータスです。	STARTING,RUNNING,TERMINATED
failReason	文字列	失敗理由です。	out of stock
paymentStatus	文字列	支払いステータスです。	PAID/UNPAID
regionId	文字列	リージョン ID です。	cn-shanghai
createTime	整数	ワークスペースの作成時刻です。	1684115879955
endTime	整数	ワークスペースのリリース時刻です。	1687103999999
stateChangeReason	オブジェクト	ワークスペースのステータス変更に関する情報です。
code	文字列	エラーコードです。	0
message	文字列	エラーメッセージです。	Success
releaseType	文字列	ワークスペースのリリース理由です。	SERVICE_RELEASE
dlfType	文字列	バインドするDLFタイプです。	1.0
prePaidQuota	オブジェクト	前払いのリソースクォータに関する情報です。
usedResource	文字列	現在使用中のリソース量です。	{\"cpu\":\"0\",\"memory\":\"0Gi\",\"cu\":\"0\"}
maxResource	文字列	リソースの最大量です。	{\"cpu\":\"1\",\"memory\":\"4Gi\",\"cu\":\"1\"}
allocatedResource	文字列	現在割り当て済みのリソース量です。	{\"cpu\":\"1\",\"memory\":\"4Gi\",\"cu\":\"1\"}
createTime	整数	リソースクォータの作成時刻です。	1745683200000
expireTime	整数	リソースクォータの有効期限です。	1740537153000
autoRenewal	ブール値	リソースの自動更新が有効かどうかを示します。 true：自動更新を有効にします。リソースは有効期限後に自動的に更新されます。 false：自動更新を無効にします。リソースは有効期限になるとリリースされます。	true
paymentStatus	文字列	現在のリソースの支払いステータスです。取り得る値は次のとおりです： NORMAL：アクティブ。 WAIT_FOR_EXPIRE：まもなく期限切れになります。 EXPIRED：有効期限が切れています。	NORMAL
instanceId	文字列	クォータに関連付けられたインスタンス ID です。	i-abc12345
orderId	文字列
tags	配列 <オブジェクト>
	オブジェクト
tagKey	文字列
tagValue	文字列
resourceGroupId	文字列		rg-xxxxxxxxxx
gpuSpec	配列
	文字列		ecs.gn7i-c8g1.2xlarge
ipWhiteList	配列
	文字列		0.0.0.1
requestId	文字列	リクエスト ID です。	DD6B1B2A-5837-5237-ABE4-FF0C8944****
nextToken	文字列	次のページのトークンです。	1
maxResults	整数	一度に取得するレコードの最大数です。	20
totalCount	整数	レコードの総数です。	200

例

成功レスポンス

JSON JSON

{
  "workspaces": [
    {
      "workspaceId": "w-******",
      "workspaceName": "Spark batch workspace-1",
      "resourceSpec": "100cu",
      "storage": "spark-result",
      "dlfCatalogId": "default",
      "paymentType": "PayAsYouGo or Subscription",
      "paymentDurationUnit": "YEAR, MONTH, WEEK, DAY, HOUR, MINUTE",
      "duration": 1,
      "autoRenew": true,
      "autoRenewPeriod": 1,
      "autoRenewPeriodUnit": "YEAR, MONTH, WEEK, DAY, HOUR, MINUTE",
      "workspaceStatus": "STARTING,RUNNING,TERMINATED",
      "failReason": "out of stock",
      "paymentStatus": "PAID/UNPAID",
      "regionId": "cn-shanghai",
      "createTime": 1684115879955,
      "endTime": 1687103999999,
      "stateChangeReason": {
        "code": "0",
        "message": "Success"
      },
      "releaseType": "SERVICE_RELEASE",
      "dlfType": "1.0",
      "prePaidQuota": {
        "usedResource": "{\\\"cpu\\\":\\\"0\\\",\\\"memory\\\":\\\"0Gi\\\",\\\"cu\\\":\\\"0\\\"}",
        "maxResource": "{\\\"cpu\\\":\\\"1\\\",\\\"memory\\\":\\\"4Gi\\\",\\\"cu\\\":\\\"1\\\"}",
        "allocatedResource": "{\\\"cpu\\\":\\\"1\\\",\\\"memory\\\":\\\"4Gi\\\",\\\"cu\\\":\\\"1\\\"}",
        "createTime": 1745683200000,
        "expireTime": 1740537153000,
        "autoRenewal": true,
        "paymentStatus": "NORMAL",
        "instanceId": "i-abc12345",
        "orderId": ""
      },
      "tags": [
        {
          "tagKey": "",
          "tagValue": ""
        }
      ],
      "resourceGroupId": "rg-xxxxxxxxxx",
      "gpuSpec": [
        "ecs.gn7i-c8g1.2xlarge"
      ],
      "ipWhiteList": [
        "0.0.0.1"
      ]
    }
  ],
  "requestId": "DD6B1B2A-5837-5237-ABE4-FF0C8944****",
  "nextToken": "1",
  "maxResults": 20,
  "totalCount": 200
}

エラーコード

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

変更履歴

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