ListWorkspaces - - Alibaba Cloud ドキュメントセンター

リージョン内のワークスペースを一覧表示します。

操作説明

options パラメーターでさまざまなクエリオプションを指定して、ワークスペースに関する情報を取得できます。

今すぐお試しください

この 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	任意	ページングクエリで各ページに返すエントリの数。デフォルト値は 20 です。	20
SortBy	string	任意	ページングクエリでソートに使用するフィールド。デフォルト値は GmtCreateTime です。有効な値: GmtCreateTime (デフォルト): 作成時間でソートします。 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****

レスポンスフィールド

フィールド	型	説明	例
	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	ワークスペースが作成された時刻。時刻は ISO 8601 標準に準拠し、yyyy-MM-ddTHH:mm:ss.SSSZ 形式です。時刻は UTC で表示されます。	2021-01-21T17:12:35.232Z
GmtModifiedTime	string	ワークスペースが最後に変更された時刻。時刻は ISO 8601 標準に準拠し、yyyy-MM-ddTHH:mmZ 形式です。時刻は UTC で表示されます。	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****
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****"
    }
  ],
  "TotalCount": 1,
  "ResourceLimits": {
    "MaxCompute_share": 1,
    "MaxCompute_isolate": 1,
    "DLC_share": 1
  }
}

エラーコード

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

変更履歴

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