すべてのプロダクト
Search

このプロダクト

    :ListWorkspaces

    ドキュメントセンター

    :ListWorkspaces

    最終更新日:Jul 15, 2026

    ワークスペースのリストを照会します。

    今すぐお試しください

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

    list

    *すべてのリソース。

    *

    		 なし なし

    リクエスト構文

    GET /api/v1/workspaces HTTP/1.1

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    nextToken

    string

    任意

    現在の読み取り位置を示すページネーショントークン。

    1
    maxResults

    integer

    任意

    1 回のリクエストで取得するレコードの最大値。

    20
    name

    string

    任意

    ワークスペースの名前。あいまい一致がサポートされています。

    test_workspace
    state

    string

    任意

    ワークスペースのステータス。

    running
    regionId

    string

    任意

    リージョン ID。

    cn-hangzhou
    tag

    array<object>

    任意

    object

    任意

    key

    string

    任意

    cn-shenzhen-finance.edas.config.server
    value

    string

    任意

    iPhone disk space remaining rate
    resourceGroupId

    string

    任意

    ワークスペースが属するリソースグループの ID です。

    rg-aek2thxggoqhmhq

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    応答データ。

    workspaces

    array<object>

    ワークスペースのリスト。

    array<object>

    ワークスペースの詳細。

    workspaceId

    string

    ワークスペース ID。

    w-******
    workspaceName

    string

    ワークスペースの名前。

    Spark batch workspace-1
    resourceSpec

    string

    リソース仕様。

    100cu
    storage

    string

    OSS のパス。

    spark-result
    dlfCatalogId

    string

    DLF カタログ情報。

    default
    paymentType

    string

    支払いタイプ。

    PayAsYouGo or Subscription
    paymentDurationUnit

    string

    サブスクリプション期間の単位。このパラメーターは前払いタイプに必須です。

    YEAR, MONTH, WEEK, DAY, HOUR, MINUTE
    duration

    integer

    サブスクリプション期間の数量。このパラメーターは前払いタイプに必須です。

    1
    autoRenew

    boolean

    自動更新が有効かどうかを示します。このパラメーターは前払いタイプに必須です。

    true
    autoRenewPeriod

    integer

    自動更新の持続時間。このパラメーターは前払いタイプに必須です。

    1
    autoRenewPeriodUnit

    string

    自動更新のエポック単位。このパラメーターは前払いタイプに必須です。

    YEAR, MONTH, WEEK, DAY, HOUR, MINUTE
    workspaceStatus

    string

    ワークスペースのステータス。

    STARTING,RUNNING,TERMINATED
    failReason

    string

    失敗理由。

    out of stock
    paymentStatus

    string

    支払いステータス。

    PAID/UNPAID
    regionId

    string

    リージョン ID。

    cn-shanghai
    createTime

    integer

    ワークスペースが作成された時間。

    1684115879955
    endTime

    integer

    ワークスペースがリリースされた時間。

    1687103999999
    stateChangeReason

    object

    ワークスペースのステータス変更情報。

    code

    string

    エラーコードです。

    0
    message

    string

    エラーメッセージです。

    Success
    releaseType

    string

    ワークスペースがリリースされた理由。

    SERVICE_RELEASE
    dlfType

    string

    DLF バインドタイプ。

    1.0
    prePaidQuota

    object

    前払いリソースクォータ情報。

    usedResource

    string

    使用済みリソースの量です。

    {\"cpu\":\"0\",\"memory\":\"0Gi\",\"cu\":\"0\"}
    maxResource

    string

    利用可能な最大リソース量です。

    {\"cpu\":\"1\",\"memory\":\"4Gi\",\"cu\":\"1\"}
    allocatedResource

    string

    割り当て済みリソースの量です。

    {\"cpu\":\"1\",\"memory\":\"4Gi\",\"cu\":\"1\"}
    createTime

    integer

    リソースクォータの作成時刻です。ミリ秒単位の UNIX タイムスタンプで表されます。

    1745683200000
    expireTime

    integer

    リソースクォータの有効期限です。ミリ秒単位の UNIX タイムスタンプで表されます。

    1740537153000
    autoRenewal

    boolean

    リソースの自動更新を有効にするかどうかを指定します。

    • true：自動更新が有効です。リソースの有効期限が切れた後、自動的に更新されます。

    • false：自動更新が無効です。リソースの有効期限が切れた後、利用できなくなります。

    true
    paymentStatus

    string

    リソースの支払いステータスです。有効な値は以下のとおりです。

    • NORMAL：リソースは有効です。

    • WAIT_FOR_EXPIRE：リソースの有効期限が間近に迫っています。

    • EXPIRED：リソースの有効期限が切れています。

    NORMAL
    instanceId

    string

    クォータに関連付けられたリソースインスタンスの ID です。

    i-abc12345
    orderId

    string

    注文 ID です。

    23464687565
    prePaidQuotaGpu

    array<object>

    object

    orderId

    string

    2534863936
    instanceId

    string

    w-xxxxxxxxx-gpu-quota-xxxx
    createTime

    integer

    1782292672000
    expireTime

    integer

    1782292772000
    autoRenewal

    boolean

    paymentStatus

    string

    NORMAL
    gpuSpec

    string

    ecs.gn7i-c8g1.2xlarge
    gpuNum

    integer

    8
    gpuMachineNum

    integer

    4
    instanceTypeId

    string

    instanceTypeFamily

    string

    cpuCoreCount

    string

    gpuAmount

    integer

    memorySize

    string

    gpuMemorySize

    integer

    tags

    array<object>

    object

    tagKey

    string

    タグキーです。

    tagValue

    string

    タグ値です。

    resourceGroupId

    string

    リソースグループ ID です。

    rg-xxxxxxxxxx
    gpuSpec

    array

    GPU 仕様です。

    string

    GPU 仕様です。

    ecs.gn7i-c8g1.2xlarge
    ipWhiteList

    array

    string

    0.0.0.1
    requestId

    string

    リクエスト ID。

    DD6B1B2A-5837-5237-ABE4-FF0C8944****
    nextToken

    string

    次のページのトークン。

    1
    maxResults

    integer

    1 回のリクエストで取得するレコードの最大値。

    20
    totalCount

    integer

    レコードの総数。

    200

    例

    成功レスポンス

    JSONJSON

    {
  "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": "23464687565"
      },
      "prePaidQuotaGpu": [
        {
          "orderId": "2534863936",
          "instanceId": "w-xxxxxxxxx-gpu-quota-xxxx",
          "createTime": 1782292672000,
          "expireTime": 1782292772000,
          "autoRenewal": true,
          "paymentStatus": "NORMAL",
          "gpuSpec": "ecs.gn7i-c8g1.2xlarge",
          "gpuNum": 8,
          "gpuMachineNum": 4,
          "instanceTypeId": "",
          "instanceTypeFamily": "",
          "cpuCoreCount": "",
          "gpuAmount": 0,
          "memorySize": "",
          "gpuMemorySize": 0
        }
      ],
      "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
}

    エラーコード

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

    変更履歴

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