调用GetLifecycle获取实例生命周期_人工智能平台 PAI(PAI)-阿里云帮助中心

获取实例的生命周期。

接口说明

获取实例的生命周期流转信息，可以获取实例在某个时间点流转到某个状态的详情。

调试

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

调试

授权信息

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

请求语法

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

请求参数

名称	类型	必填	描述	示例值
InstanceId	string	是	实例 ID。如何获取实例 ID，请参见 ListInstances 。	dsw-9698d842b6***
SessionNumber	integer	否	一个 Session 为实例从启动到失败或停止的过程，sessionNumber 表示实例 Session 的序号偏移值。	1
StartTime	string	否	查询的起始时间。	2020-11-08T15:00:00Z
EndTime	string	否	查询的结束时间。	2020-11-08T15:00:00Z
Limit	integer	否	查询获取的 Session 数量限制。	1
Order	string	否	结果的排序方式，取值如下： ASC：按时间升序。 DESC：按时间降序。	DESC

返回参数

名称	类型	描述	示例值
	object	生命周期查询结果。
RequestId	string	请求 ID。	E7D55162-4489-1619-AAF5-3F97D5FC****
Success	boolean	成功标志，可能值： true false	true
Message	string	操作结果信息。	"XXX"
Code	string	状态码，可能值： InternalError：内部错误（除了参数验证错误外的其他错误，目前都归类到内部错误）。 ValidationError：参数验证错误。	null
Lifecycle	array	获取到的实例生命周期详情。
Lifecycle	array<object>	生命周期结果列表，每一个子项为一个 Session 对应的生命周期。
Item	object	其中一个 Session 对应的生命周期详情。
Status	string	实例所处的状态。可能值： Creating：创建中。 SaveFailed：实例镜像保存失败。 Stopped：已停止。 Failed：实例创建失败。 ResourceAllocating：资源准备中。 Stopping：停止中。 Updating：更新中。 Saving：保存中。 Starting：启动中。 Running：运行中。 Saved：已保存。 EnvPreparing：环境准备中。 ArrearStopping：欠费停机中。 Arrearge：欠费停机。 Queuing：排队中。 Recovering：恢复中。	Starting
ReasonCode	string	发生某种事件的原因对应的代码。	“”
ReasonMessage	string	发生某种事件的原因描述。	“”
GmtCreateTime	string	该状态创建的时间，即流转到该状态的时间（GMT）。	2022-10-21T07:27:44Z
TotalCount	integer	查询得到的 Session 总数。	35

示例

正常返回示例

JSON格式

{
  "RequestId": "E7D55162-4489-1619-AAF5-3F97D5FC****",
  "Success": true,
  "Message": "\"XXX\"",
  "Code": "null",
  "Lifecycle": [
    [
      {
        "Status": "Starting",
        "ReasonCode": "“”",
        "ReasonMessage": "“”",
        "GmtCreateTime": "2022-10-21T07:27:44Z"
      }
    ]
  ],
  "TotalCount": 35
}

错误码

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