文档

RestartApplication - 重启应用

更新时间:

调用RestartApplication接口重启应用。

调试

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

授权信息

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

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

请求语法

PUT /pop/v1/sam/app/restartApplication

请求参数

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

目标应用 ID。

0099b7be-5f5b-4512-a7fc-56049ef1****
MinReadyInstancesinteger

最小存活实例数。取值说明如下:

  • 如果设置为 0,应用在升级过程中将会中断业务。
  • 如果设置为**-1**,最小存活实例数将使用系统推荐值,即取现有实例数的 25%。如果当前为 5 个实例,5×25%=1.25,向上取整后,最小存活实例数为 2。
说明 每次滚动部署最小存活的实例数建议≥1,保证业务不中断。
1
MinReadyInstanceRatiointeger

最小存活实例数百分比。取值说明如下:

  • -1:初始化值,表示不采用百分比。
  • 0~100:单位为百分比,向上取整。例如设置为 50%,如果当前为 5 个实例,则最小存活实例数为 3。
说明 MinReadyInstanceMinReadyInstanceRatio 同时传递时,且 MinReadyInstanceRatio 的取值非**-1**时,以 MinReadyInstanceRatio 参数为准。假设 MinReadyInstances 取值为 5MinReadyInstanceRatio 取值为 50,则会用 50 来计算最小存活实例数。
-1
AutoEnableApplicationScalingRuleboolean

是否自动启用应用弹性伸缩策略。取值说明如下:

  • true:开启。
  • false:关闭。
false

返回参数

名称类型描述示例值
object

返回数据。

RequestIdstring

请求 ID。

91F93257-7A4A-4BD3-9A7E-2F6EAE6D****
Messagestring

附加信息。取值说明如下:

  • 请求正常,返回 success
  • 请求异常,返回具体异常错误码。
success
TraceIdstring

调用链 ID,用于精确查询调用信息。

0a98a02315955564772843261e****
Dataobject

返回结果。

ChangeOrderIdstring

变更单 ID。

4a815998-b468-4bea-b7d8-59f52a44****
ErrorCodestring

错误码。取值说明如下:

  • 请求成功:不返回 ErrorCode 字段。
  • 请求失败:返回 ErrorCode 字段。具体信息,请参见本文的错误码列表。
Codestring

接口状态或 POP 错误码。取值说明如下:

  • 2xx:成功。
  • 3xx:重定向。
  • 4xx:请求错误。
  • 5xx:服务器错误。
200
Successboolean

重启实例是否成功。取值说明如下:

  • true:表示重启成功。
  • false:表示重启失败。
true

示例

正常返回示例

JSON格式

{
  "RequestId": "91F93257-7A4A-4BD3-9A7E-2F6EAE6D****",
  "Message": "success",
  "TraceId": "0a98a02315955564772843261e****",
  "Data": {
    "ChangeOrderId": "4a815998-b468-4bea-b7d8-59f52a44****"
  },
  "ErrorCode": "空",
  "Code": "200",
  "Success": true
}

错误码

HTTP status code错误码错误信息描述
400InvalidApplication.NotFoundThe current application does not exist.找不到当前应用。
400InvalidParameter.NotEmptyYou must specify the parameter %s.不合法的参数:%s不能为空。
400InvalidParameter.ObviouslyThe specified parameter is invalid {%s}.不合法的参数{%s}。
400InvalidParameter.WithMessageThe parameter is invalid {%s}: %s不合法的参数{%s}:%s。
400NoComputeResourceQuota.ExceedYour compute resource is insufficient. Please contact us to raise the quota.-
400user.indebtThe user has an outstanding payment.当前用户处于欠费状态。
400NoComputeResourceQuota.App.ExceedYou can create %s instances for each application. Please submit a ticket to raise the quota.每个应用只允许创建%s个实例,请加入钉群32874633联系技术产品专家进行咨询。
400NoComputeResourceQuota.User.ExceedYour account is limited to create %s instances. Please submit a ticket to raise the quota.您的账户限额%s个实例,请加入钉群32874633联系技术产品专家进行咨询。
400System.UpgradingThe system is being upgraded. Please try again later.系统正在升级,请稍后操作。
400Application.ChangerOrderRunningAn application change process is in progress. Please try again later.应用有变更流程正在执行,请稍后重试。
400Application.InvalidStatusThe application status is abnormal. Please try again later.应用状态异常,请稍后重试。
400Application.NotDeployYetThe application has not been deployed. Please deploy it and try again.应用没有部署,请部署后重试。
404Associate.Eip.Not.EnoughNo sufficient EIPs are available.绑定EIP时,EIP不足,需要您购买。

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

变更历史

变更时间变更内容概要操作
2023-03-30OpenAPI 错误码发生变更、OpenAPI 入参发生变更查看变更详情