すべてのプロダクト
Search

このプロダクト

    :ListWorkspaces

    ドキュメントセンター

    :ListWorkspaces

    最終更新日:Jul 16, 2026

    指定されたリージョンのワークスペースのリストを取得します。

    操作説明

    option パラメーターを使用して異なるクエリオプションを指定し、ワークスペース関連のさまざまな情報を取得できます。フォーマット。

    今すぐお試しください

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

    アクション

    アクセスレベル

    リソースタイプ

    条件キー

    依存アクション

    paiworkspace:ListWorkspaces

    list

    *All Resource

    *

    		 なし なし

    リクエスト構文

    GET /api/v1/workspaces HTTP/1.1

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    PageNumber

    integer

    任意

    ワークスペースリストのページ番号。最小値: 1。デフォルト値: 1。

    1
    PageSize

    integer

    任意

    ページングにおける 1 ページあたりのエントリ数。デフォルト値: 20。

    20
    SortBy

    string

    任意

    ページングのソートフィールド。デフォルト値: GmtCreateTime。有効な値:

    • GmtCreateTime (default): 作成時間でソートします。

    • GmtModifiedTime: 変更時間でソートします。

    GmtCreateTime
    Order

    string

    任意

    ページング時に指定されたソートフィールドのソート順序。有効な値:

    • ASC (デフォルト): 昇順。

    • DESC: 降順。

    ASC
    WorkspaceName

    string

    任意

    ワークスペースの名前。

    abc
    ModuleList

    string

    任意

    カンマ区切りのモジュールのリスト。デフォルト値: PAI。

    PAI
    Status

    string

    任意

    ワークスペースのステータス。有効な値:

    • ENABLED: 法線。

    • INITIALIZING: 初期化中。

    • FAILURE: 失敗。

    • DISABLED: 手動で無効化済み。

    • FROZEN: 支払い遅延による凍結。

    • UPDATING: 更新中。

    ENABLED
    Option

    string

    任意

    クエリオプション。有効な値:

    • GetWorkspaces (デフォルト): ワークスペースリストを取得します。Workspaces パラメーターが返されます。

    • GetResourceLimits: リソースの使用制限を取得します。ResourceLimits パラメーターが返されます。

    GetWorkspaces
    Verbose

    boolean

    任意

    ワークスペースの詳細情報を表示するかどうかを指定します。有効な値:

    • false (デフォルト): 詳細情報を表示しません。

    • true: 詳細情報を表示します。

    true
    Fields

    string

    任意

    ワークスペース詳細の戻りフィールドのリスト。このパラメーターは、結果に返されるワークスペースのプロパティを制限します。 複数のプロパティはカンマ (,) で区切ります。現在サポートされているのは Id のみで、ワークスペース ID を示します。

    Id
    WorkspaceIds

    string

    任意

    ワークスペース ID のリスト。複数のワークスペース ID はカンマ (,) で区切ります。

    123,234
    ResourceGroupId

    string

    任意

    リソースグループの ID。リソースグループ ID の確認方法については、「リソースグループの基本情報の表示」をご参照ください。フォーマット。

    rg-acfmwp7rky****
    UserId

    string

    任意

    ユーザー ID。

    17*****1743

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    レスポンス構造体。

    RequestId

    string

    リクエストの ID。

    8D7B2E70-F770-505B-A672-09F1D8F2EC1E
    Workspaces

    array<object>

    ワークスペース詳細のリスト。Option が GetWorkspaces に設定されている場合に返されます。

    array<object>

    ワークスペースの詳細。

    WorkspaceId

    string

    ワークスペースの ID。

    123
    WorkspaceName

    string

    ワークスペースの名前。

    workspace-example
    GmtCreateTime

    string

    ワークスペースが作成された時間。時間は協定世界時 (UTC) +0 の ISO 8601 標準です。フォーマット: yyyy-MM-ddTHH:mm:ss.SSSZ。

    2021-01-21T17:12:35.232Z
    GmtModifiedTime

    string

    ワークスペースが最後に変更済みの時間。時間は協定世界時 (UTC) +0 の ISO 8601 標準です。フォーマット: yyyy-MM-ddTHH:mmZ。

    2021-01-21T17:12:35.232Z
    Description

    string

    ワークスペースの説明。

    workspace description example
    Creator

    string

    作成者のユーザー ID。

    122424353535
    EnvTypes

    array

    ワークスペースに含まれる環境のリスト。

    string

    ワークスペースに含まれる環境。有効な値:

    • シンプルモードには本番環境 (prod) のみが含まれます。

    • 標準モードには開発環境 (dev) と本番環境 (prod) が含まれます。

    prod
    Status

    string

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

    ENABLED
    AdminNames

    array

    管理者アカウント名のリスト。

    string

    管理者アカウント名。

    demo_test@***.aliyunid.com
    IsDefault

    boolean

    ワークスペースがデフォルトワークスペースであるかどうかを示します。

    false
    ExtraInfos

    object

    拡張情報。現在はテナント ID を示す TenantId が含まれています。フォーマット。

    {"TenantId": "4286******98"}
    resourceGroupId

    string

    リソースグループの ID。

    rg-acfmwp7rky****
    DisplayName

    string

    ワークスペースの表示名。

    TotalCount

    integer

    クエリ条件に一致するワークスペースの総数。

    1
    ResourceLimits

    object

    ユーザーがワークスペース内で有効化できるリソースタイプと数量の使用制限。このリストは Option が GetResourceLimits に設定されている場合に返されます。 現在サポートされているリソースタイプは以下の通りです:

    • MaxCompute_share: MaxCompute 従量課金。

    • MaxCompute_isolate: MaxCompute サブスクリプション。

    • DLC_share: DLC 従量課金。

    • PAI_isolate: PAI サブスクリプション。

    • PAI_share: PAI 従量課金。

    • DataWorks_isolate: DataWorks サブスクリプション。

    • DataWorks_share: DataWorks 従量課金。

    { "MaxCompute_share": 1, "MaxCompute_isolate": 1, "DLC_share": 1 }

    例

    成功レスポンス

    JSONJSON

    {
  "RequestId": "8D7B2E70-F770-505B-A672-09F1D8F2EC1E",
  "Workspaces": [
    {
      "WorkspaceId": "123",
      "WorkspaceName": "workspace-example",
      "GmtCreateTime": "2021-01-21T17:12:35.232Z",
      "GmtModifiedTime": "2021-01-21T17:12:35.232Z",
      "Description": "workspace description example",
      "Creator": "122424353535",
      "EnvTypes": [
        "prod"
      ],
      "Status": "ENABLED",
      "AdminNames": [
        "demo_test@***.aliyunid.com"
      ],
      "IsDefault": false,
      "ExtraInfos": {
        "TenantId": "4286******98"
      },
      "resourceGroupId": "rg-acfmwp7rky****",
      "DisplayName": ""
    }
  ],
  "TotalCount": 1,
  "ResourceLimits": {
    "MaxCompute_share": 1,
    "MaxCompute_isolate": 1,
    "DLC_share": 1
  }
}

    エラーコード

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

    変更履歴

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