ListInstanceSnapshot - 查询实例快照列表

查询实例快照列表。

调试

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

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用前面加 * 表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
paidsw:ListInstanceSnapshotget
*全部资源
*

请求语法

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

请求参数

名称类型必填描述示例值
InstanceIdstring

实例 ID。如何获取实例 ID,请参见 ListInstances

dsw-730xxxxxxxxxx
PageNumberlong

实例快照列表的页码。起始值为 1,默认为 1。

1
PageSizelong

分页查询时设置的每页显示的实例快照列表数量,默认为 10。

10
SortBystring

按排序字段 gmtCreae 排序。

gmtCreate
Orderstring

排列顺序,取值如下:

  • Desc: 降序排列。
  • Asc: 升序排列。
DESC

返回参数

名称类型描述示例值
object

实例快照列表。

RequestIdstring

请求 ID。

E7D55162-4489-1619-AAF5-3F97D5FCA948
Successboolean

成功标志,可能值:

  • true
  • false
true
Messagestring

返回结果说明。

"XXX"
Codestring

状态码,可能值:

  • InternalError:内部错误(除了参数验证错误外的其他错误,目前都归类到内部错误)。
  • ValidationError:参数验证错误。
null
HttpStatusCodeinteger

HTTP 状态码,可能值:

  • 400
  • 404
null
TotalCountlong

实例总数。

35
Snapshotsarray<object>

本分页中请求的实例镜像列表。

Snapshotobject

实例快照对象

InstanceIdstring

实例 ID。

dsw-730xxxxxxxxxx
SnapshotIdstring

实例快照 ID。

snp-05cexxxxxxxxx
SnapshotNamestring

实例快照名称。

training_data_env
Statusstring

实例快照状态。

Pushing
ImageIdstring

实例快照的镜像 ID。

image-05cefd0be2exxxx
ImageUrlstring

实例快照的镜像地址。

registry.cn-shanghai.aliyuncs.com/pai_product/tensorflow:py36_cpu_tf1.12_ubuntu
ReasonCodestring

实例快照错误代码。

Internal Error
ReasonMessagestring

实例快照错误消息。

ImagePullBackOff
GmtCreateTimestring

实例快照创建时间。

2021-01-12T14:36:01Z
GmtModifiedTimestring

实例快照修改时间。

2021-01-12T14:36:01Z
Labelsarray<object>

用户自定义标签。

{'foo': 'bar'}
Labelobject

用户定义标签键值对。

Keystring

用户定义标签键。

stsTokenOwner
Valuestring

用户定义标签值。

123xxxxxxxx
ExcludePathsarray

排除文件路径列表,仅支持 ECI 实例设置, 用于制作镜像时忽略指定文件夹或文件

ExcludePathstring

示例

正常返回示例

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-18OpenAPI 返回结构发生变更查看变更详情
2022-01-20OpenAPI 返回结构发生变更查看变更详情