GetDefaultWorkspace で Platform for AI デフォルトワークスペースの詳細を取得 - PAI

デフォルトのワークスペースの詳細を取得します。

今すぐお試しください

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

get

*All Resource

*

なし

リクエスト構文

GET /api/v1/defaultWorkspaces HTTP/1.1

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
Verbose	boolean	任意	デフォルトのワークスペースに関する詳細情報を返すかどうかを指定します。詳細情報には、Conditions リストが含まれます。有効な値: false (デフォルト): 詳細情報は返されません。 true: 詳細情報が返されます。	false

レスポンスフィールド

フィールド	型	説明	例
	object	レスポンス構造体。
RequestId	string	リクエスト ID。	5A14FA81-DD4E-******-6343FE44B941
WorkspaceId	string	ワークスペース ID。	1234
WorkspaceName	string	ワークスペースの名前。名前は同じリージョン内で一意である必要があります。	workspace-example
GmtCreateTime	string	ワークスペースが作成された時間。時刻は協定世界時 (UTC) で、ISO 8601 形式です。	2021-01-21T17:12:35.232Z
GmtModifiedTime	string	ワークスペースが最後に変更された時間。時刻は UTC で、ISO 8601 形式です。	2021-01-21T17:12:35.232Z
DisplayName	string	ワークスペースの表示名。	workspace-example
Description	string	ワークスペースの説明。	workspace description example
EnvTypes	array	ワークスペース内の環境。基本モードのワークスペースには、本番 (prod) 環境のみが含まれます。標準モードのワークスペースには、開発 (dev) 環境と本番 (prod) 環境が含まれます。
	string	環境。有効な値: dev: 開発環境。 prod: 本番環境。	prod
Creator	string	ワークスペースを作成した Alibaba Cloud アカウント。	17915******4216
Owner	object	ワークスペースを作成した Alibaba Cloud アカウント。
UserId	string	ユーザーの UID。	17915******4216
UserName	string	ユーザー名。	username
UserKp	string	ユーザーの UID。	17915******4216
Status	string	ワークスペースのステータス。有効な値: ENABLED: 通常。 INITIALIZING: 初期化中。 FAILURE: 失敗。 DISABLED: 無効。 FROZEN: 支払い遅延により凍結されています。 UPDATING: ワークスペースは更新中です。	ENABLED
Conditions	array<object>	デフォルトのワークスペースの作成段階に関する詳細。
	object	デフォルトのワークスペースの作成段階に関する詳細。
Type	string	タスクタイプ。有効な値: CREATING: 作成中。 WORKSPACE_CREATED: ワークスペースが作成されました。 MEMBERS_ADDED: メンバーが追加されました。 ENABLED: プロセスは完了です。	CREATING
Code	integer	ステータスコード。値 200 は、リクエストが成功したことを示します。その他の値は、リクエストが失敗したことを示します。	200
Message	string	エラーメッセージ。ステータスコードが 200 の場合、このパラメーターは空です。	Create Failed

例

成功レスポンス

JSONJSON

{
  "RequestId": "5A14FA81-DD4E-******-6343FE44B941",
  "WorkspaceId": "1234",
  "WorkspaceName": "workspace-example",
  "GmtCreateTime": "2021-01-21T17:12:35.232Z",
  "GmtModifiedTime": "2021-01-21T17:12:35.232Z",
  "DisplayName": "workspace-example",
  "Description": "workspace description example",
  "EnvTypes": [
    "prod"
  ],
  "Creator": "17915******4216\n",
  "Owner": {
    "UserId": "17915******4216",
    "UserName": "username",
    "UserKp": "17915******4216"
  },
  "Status": "ENABLED",
  "Conditions": [
    {
      "Type": "CREATING ",
      "Code": 200,
      "Message": "Create Failed"
    }
  ]
}

エラーコード

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

変更履歴

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