全部产品
Search
文档中心

服务网格 ASM:DescribeServiceMeshUpgradeStatus - 查询ASM的升级状态

更新时间:Mar 05, 2024

调用DescribeServiceMeshUpgradeStatus查询ASM实例和ASM网关的升级状态。

调试

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

授权信息

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

请求参数

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

ASM 实例 ID

11fd0027-c27e-41bb-a565-75583054****
GuestClusterIdsstring

加入 ASM 实例管控的数据面集群 ID 列表,使用逗号分隔。

caeac85a793c94afbbb0a4bb20320****
AllIstioGatewayFullNamesstring

ASM 网关的全限定名称列表。使用逗号分隔。

istio-system:ingressgateway1,istio-system:ingressgateway2

返回参数

名称类型描述示例值
object

升级状态

RequestIdstring

请求 ID

11fd0027-c27e-41bb-a565-75583054****
UpgradeDetailobject

升级状态结果

FinishedGatewaysNumlong

升级完成的网关数目

1
MeshStatusstring

ASM 实例状态,取值:

  • running:运行中

  • upgrading:升级中

  • upgrading_failed:升级失败

running
TotalGatewaysNumlong

所有的网关数目

2
GatewayStatusRecordobject

ASM 网关状态记录

object

ASM 网关状态

Statusstring

ASM 网关升级状态。取值:

  • upgrading:升级中

  • pending:升级等待中

  • finished:升级已完成

  • notStart:升级未开始

  • failed:升级失败

  • unknown:其他状态

upgrading
Messagestring

ASM 网关实例的额外状态信息

success
Versionstring

ASM 网关版本

1.9.7

示例

正常返回示例

JSON格式

{
  "RequestId": "11fd0027-c27e-41bb-a565-75583054****",
  "UpgradeDetail": {
    "FinishedGatewaysNum": 1,
    "MeshStatus": "running",
    "TotalGatewaysNum": 2,
    "GatewayStatusRecord": {
      "key": {
        "Status": "upgrading",
        "Message": "success",
        "Version": "1.9.7"
      }
    }
  }
}

错误码

HTTP status code错误码错误信息描述
404ERR404Not found不存在

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