GetSnapshot - Platform For AI - Alibaba Cloud ドキュメントセンター

スナップショットの詳細を取得します。

今すぐお試しください

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

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

pailangstudio:GetSnapshot

get

*All Resource

*

なし

リクエスト構文

GET /api/v1/langstudio/snapshots/{SnapshotId} HTTP/1.1

パスパラメーター

パラメーター	型	必須 / 任意	説明	例
SnapshotId	string	任意	スナップショットの ID。	snap-asfg******123

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
WorkspaceId	string	任意	ワークスペースの ID。ワークスペース ID を取得する方法については、「ListWorkspaces」をご参照ください。	478***

レスポンスフィールド

フィールド	型	説明	例
	object	レスポンスボディ。
RequestId	string	リクエスト ID。	963BD7F9-0C02-5594-9550-BCC6DD43E3C0
WorkspaceId	string	ワークスペースの ID。ワークスペース ID を取得する方法については、「ListWorkspaces」をご参照ください。	478**
Accessibility	string	スナップショットの可視性。有効な値： PRIVATE：自分と管理者のみが閲覧できます。 PUBLIC：すべてのユーザーが閲覧できます。	PRIVATE
Creator	string	作成者のユーザー ID。	2680******4103
GmtCreateTime	string	作成時刻。	2025-09-24T07:33:53Z
GmtModifiedTime	string	最終更新時刻。	2025-09-24T08:58:35Z
SnapshotId	string	スナップショットの ID。	snap-asfg******123
SnapshotName	string	スナップショットの名前。	snapshot01
Description	string	スナップショットの説明。	This is description
SnapshotResourceType	string	スナップショットのリソースタイプ。有効な値： Flow：ワークフロー。	Flow
SnapshotResourceId	string	スナップショットリソースの ID。	flow-asfg******1234
CreationType	string	スナップショットの作成方法。有効な値： ManualCreated：手動作成。 DeploymentAutoCreated：デプロイメントサービスによる自動作成。 EvaluationAutoCreated：評価タスクによる自動作成。	ManualCreated
SnapshotStoragePath	string	スナップショットのソースファイルの OSS パス。	oss://mybucket.oss-cn-hangzhou.aliyuncs.com/workdir/snapshot/snap-1234/src
WorkDir	string	スナップショットの OSS 作業ディレクトリ。	oss://mybucket.oss-cn-hangzhou-internal.aliyuncs.com/workdir/
SnapshotUrl	string	スナップショットのダウンロード URL。	https://path/to/snapshot/zipfile
SnapshotStatus	string	スナップショットのステータス。取りうる値には `CREATING`、`AVAILABLE`、`FAILED` が含まれます。
ErrorMessage	string	エラーメッセージ。リクエストの処理中にエラーが発生した場合に、エラーの詳細情報が返されます。リクエストが成功した場合、このパラメータは空です。

例

成功レスポンス

JSONJSON

{
  "RequestId": "963BD7F9-0C02-5594-9550-BCC6DD43E3C0",
  "WorkspaceId": "478**",
  "Accessibility": "PRIVATE",
  "Creator": "2680******4103",
  "GmtCreateTime": "2025-09-24T07:33:53Z",
  "GmtModifiedTime": "2025-09-24T08:58:35Z",
  "SnapshotId": "snap-asfg******123",
  "SnapshotName": "snapshot01",
  "Description": "This is description",
  "SnapshotResourceType": "Flow",
  "SnapshotResourceId": "flow-asfg******1234",
  "CreationType": "ManualCreated",
  "SnapshotStoragePath": "oss://mybucket.oss-cn-hangzhou.aliyuncs.com/workdir/snapshot/snap-1234/src",
  "WorkDir": "oss://mybucket.oss-cn-hangzhou-internal.aliyuncs.com/workdir/",
  "SnapshotUrl": "https://path/to/snapshot/zipfile",
  "SnapshotStatus": "",
  "ErrorMessage": ""
}

エラーコード

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

変更履歴

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