调用GetLifecycle查询实例生命周期-人工智能平台 PAI-阿里云

获取实例的生命周期。

接口说明

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

调试

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

调试

授权信息

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

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

操作

访问级别

资源类型

条件关键字

关联操作

paidsw:GetLifecycle

get

*全部资源

*

无

请求语法

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
Token	string	否	用于分享 url

返回参数

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

错误码

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

变更历史

更多信息，参考变更详情。