调用ListInstanceSnapshot查询实例快照列表_人工智能平台 PAI(PAI)-阿里云帮助中心

查询实例快照列表。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

当前API暂无授权信息透出。

请求语法

GET /api/v2/instances/{InstanceId}/snapshots HTTP/1.1

请求参数

名称	类型	必填	描述	示例值
InstanceId	string	是	实例 ID。如何获取实例 ID，请参见 ListInstances 。	dsw-730xxxxxxxxxx
PageNumber	long	否	实例快照列表的页码。起始值为 1，默认为 1。	1
PageSize	long	否	分页查询时设置的每页显示的实例快照列表数量，默认为 10。	10
SortBy	string	否	按排序字段 gmtCreae 排序。	gmtCreate
Order	string	否	排列顺序，取值如下： Desc：降序排列。 Asc：升序排列。	DESC

返回参数

名称	类型	描述	示例值
	object	实例快照列表。
RequestId	string	请求 ID。	E7D55162-4489-1619-AAF5-3F97D5FCA948
Success	boolean	成功标志，可能值： true false	true
Message	string	返回结果说明。	"XXX"
Code	string	状态码，可能值： InternalError：内部错误（除了参数验证错误外的其他错误，目前都归类到内部错误）。 ValidationError：参数验证错误。	null
HttpStatusCode	integer	HTTP 状态码，可能值： 400 404	null
TotalCount	long	实例总数。	35
Snapshots	array<object>	本分页中请求的实例镜像列表。
Snapshot	object	实例快照对象
InstanceId	string	实例 ID。	dsw-730xxxxxxxxxx
SnapshotId	string	实例快照 ID。	snp-05cexxxxxxxxx
SnapshotName	string	实例快照名称。	training_data_env
Status	string	实例快照状态。	Pushing
ImageId	string	实例快照的镜像 ID。	image-05cefd0be2exxxx
ImageUrl	string	实例快照的镜像地址。	registry.cn-shanghai.aliyuncs.com/pai_product/tensorflow:py36_cpu_tf1.12_ubuntu
ReasonCode	string	实例快照错误代码。	Internal Error
ReasonMessage	string	实例快照错误消息。	ImagePullBackOff
GmtCreateTime	string	实例快照创建时间。	2021-01-12T14:36:01Z
GmtModifiedTime	string	实例快照修改时间。	2021-01-12T14:36:01Z
Labels	array<object>	用户自定义标签。	{'foo': 'bar'}
Label	object	用户定义标签键值对。
Key	string	用户定义标签键。	stsTokenOwner
Value	string	用户定义标签值。	123xxxxxxxx
ExcludePaths	array	排除文件路径列表，仅支持 ECI 实例设置，用于制作镜像时忽略指定文件夹或文件
ExcludePath	string

示例

正常返回示例

JSON格式

{
  "RequestId": "E7D55162-4489-1619-AAF5-3F97D5FCA948",
  "Success": true,
  "Message": "\"XXX\"",
  "Code": "null",
  "HttpStatusCode": 0,
  "TotalCount": 35,
  "Snapshots": [
    {
      "InstanceId": "dsw-730xxxxxxxxxx",
      "SnapshotId": "snp-05cexxxxxxxxx",
      "SnapshotName": "training_data_env",
      "Status": "Pushing",
      "ImageId": "image-05cefd0be2exxxx",
      "ImageUrl": "registry.cn-shanghai.aliyuncs.com/pai_product/tensorflow:py36_cpu_tf1.12_ubuntu",
      "ReasonCode": "Internal Error",
      "ReasonMessage": "ImagePullBackOff",
      "GmtCreateTime": "2021-01-12T14:36:01Z",
      "GmtModifiedTime": "2021-01-12T14:36:01Z",
      "Labels": [
        {
          "Key": "stsTokenOwner",
          "Value": "123xxxxxxxx"
        }
      ],
      "ExcludePaths": [
        ""
      ]
    }
  ]
}

错误码

访问错误中心查看更多错误码。

变更历史

变更时间	变更内容概要	操作
2023-12-18	OpenAPI 返回结构发生变更	查看变更详情
2022-01-20	OpenAPI 返回结构发生变更	查看变更详情