全部产品
Search
文档中心

服务网格 ASM:DescribeServiceMeshAdditionalStatus - 查询ASM实例的附加检查信息

更新时间:Nov 22, 2024

调用DescribeServiceMeshAdditionalStatus查询ASM实例的附加检查信息。

调试

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

授权信息

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

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

请求参数

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

ASM 实例 ID。

ca04bc38979214bf2882be79d39b4****
CheckModestring

网格检查模式,取值:

  • normal:将仅检查 API Server 负载均衡、Pilot 负载均衡、审计日志、数据面 Logtail 安装的状态。

  • full:将检查包括 normal 模式下检查项以及控制面日志、访问日志、网格安全组、APIServer EIP 的状态。

full

返回参数

名称类型描述示例值
object

状态查询结果

RequestIdstring

请求 ID。

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

集群状态。

ApiServerLoadBalancerStatusobject

API Server 负载均衡状态检查。

SLBExistStatusstring

CLB 状态检查结果,取值:

  • exist:存在。
  • not_exist:不存在。
  • conflict:检测存在冲突。
  • failed:检测失败 。
  • time_out:检测超时。
exist
SLBBackEndServerNumStatusstring

CLB 数目检测结果,取值:

  • too_much:数量过多。

  • num_exact:数量刚好。

  • too_little:数量过少。

num_exact
Reusedboolean

CLB 是否被复用,取值:

  • true:CLB 被复用。

  • false:CLB 未被复用。

false
Lockedboolean

CLB 是否被锁定,取值:

  • true:CLB 被锁定。

  • false:CLB 未被锁定。

false
PayTypestring

CLB 付费类型,取值:

  • PrePay:包年包月。

  • PayOnDemand:按量付费。

PrePay
PilotLoadBalancerStatusobject

Pilot 负载均衡状态检查。

SLBExistStatusstring

CLB 状态检查结果,取值:

  • exist:存在。
  • not_exist:不存在。
  • conflict:检测存在冲突。
  • failed:检测失败 。
  • time_out:检测超时。
exist
SLBBackEndServerNumStatusstring

CLB 数目检测结果,取值:

  • too_much:数量过多。

  • num_exact:数量刚好。

  • too_little:数量过少。

num_exact
Reusedboolean

CLB 是否被复用,取值:

  • true:CLB 被复用。

  • false:CLB 未被复用。

true
Lockedboolean

CLB 是否被锁定,取值:

  • true:CLB 被锁定。

  • false:CLB 未被锁定。

false
PayTypestring

CLB 付费类型,取值:

  • PrePay:包年包月。

  • PayOnDemand:按量付费。

PayOnDemand
CanaryPilotLoadBalancerStatusobject

金丝雀版本 Pilot 负载均衡状态信息。

SLBExistStatusstring

CLB 是否存在,取值:

  • exist:存在。
  • not_exist:不存在。
  • time_out:获取状态超时。
  • failed:实例已失效。
exist
SLBBackEndServerNumStatusstring

CLB 后端数量状态,取值:

  • num_exact:符合预期。
  • too_much:后端数量太多。
  • too_little:后端数量太少。
num_exact
Reusedboolean

CLB 是否被复用,取值:

  • true:被复用,在 CLB 的监听中检出了非服务网格监听。
  • false:未被复用。
false
Lockedboolean

CLB 是否欠费锁定,取值:

  • true:已欠费锁定。

  • false:未欠费锁定。

false
PayTypestring

CLB 的计费类型,取值:

  • PrePay:包年包月。
  • PayOnDemand(默认值):按量付费。
PayOnDemand
AuditProjectStatusstring

审计日志存在状态,取值:

  • exist:存在。

  • not exist:不存在。

exist
LogtailStatusRecordobject

各个数据面集群的 logtail 安装状态。

{ "ca35eae22013e43758a0e26d04****":{ "accessLogDashboards":[ { "title":"mesh-access-log_details_cn", "url":"https://sls.console.aliyun.com/lognext/project/****/dashboard/mesh-access-log_details_cn" }, { "title":"mesh-access-log_monitoring_center_cn", "url":"https://sls.console.aliyun.com/lognext/project/****/dashboard/mesh-access-log_monitoring_center_cn" } ], "logtailStatus":"exist", "clusterId":"ca35eae22013e43758a0e26d04****" } }
ControlPlaneProjectStatusstring

控制面日志存在状态,可能取值有:

  • exist:存在。

  • not_exist:不存在。

  • failed:检测失败。

  • time_out:检测超时。

exist
SgStatusstring

网格安全组复用状态,取值:

  • reused:被复用。

  • not_reused:未被复用。

  • failed:检测失败。

  • time_out:检测超时。

reused
ApiServerEIPStatusstring

ApiServer 绑定 EIP 存在状态,取值:

  • exist:存在。

  • not_exist:不存在。

  • failed:检测失败。

  • time_out:检测超时。

  • not_in_use:EIP 未被绑定至 API Server。

  • locked:EIP 被锁定。

exist
PilotEIPStatusstring

Pilot 绑定 EIP 存在状态,取值:

  • exist:存在。

  • not_exist:不存在。

  • failed:检测失败。

  • time_out:检测超时。

  • not_in_use:EIP 未被绑定至 API Server。

  • locked:EIP 被锁定。

exist
AccessLogProjectStatusstring

访问日志存在状态,取值:

  • exist:存在。

  • not_exist:不存在。

  • failed:检测失败。

  • time_out:检测超时。

exist
RAMApplicationStatusstring

与网格拓扑集成的 RAM OAuth 应用状态,取值:

  • exist:存在。

  • reused:被复用。

  • not_exist:不存在。

  • failed:检测失败。

  • time_out:检测超时。

reused

示例

正常返回示例

JSON格式

{
  "RequestId": "11fd0027-c27e-41bb-a565-75583054****",
  "ClusterStatus": {
    "ApiServerLoadBalancerStatus": {
      "SLBExistStatus": "exist",
      "SLBBackEndServerNumStatus": "num_exact",
      "Reused": false,
      "Locked": false,
      "PayType": "PrePay"
    },
    "PilotLoadBalancerStatus": {
      "SLBExistStatus": "exist",
      "SLBBackEndServerNumStatus": "num_exact",
      "Reused": true,
      "Locked": false,
      "PayType": "PayOnDemand"
    },
    "CanaryPilotLoadBalancerStatus": {
      "SLBExistStatus": "exist",
      "SLBBackEndServerNumStatus": "num_exact",
      "Reused": false,
      "Locked": false,
      "PayType": "PayOnDemand"
    },
    "AuditProjectStatus": "exist",
    "LogtailStatusRecord": {
      "ca35eae22013e43758a0e26d04****": {
        "accessLogDashboards": [
          {
            "title": "mesh-access-log_details_cn",
            "url": "https://sls.console.aliyun.com/lognext/project/****/dashboard/mesh-access-log_details_cn"
          },
          {
            "title": "mesh-access-log_monitoring_center_cn",
            "url": "https://sls.console.aliyun.com/lognext/project/****/dashboard/mesh-access-log_monitoring_center_cn"
          }
        ],
        "logtailStatus": "exist",
        "clusterId": "ca35eae22013e43758a0e26d04****"
      }
    },
    "ControlPlaneProjectStatus": "exist",
    "SgStatus": "reused",
    "ApiServerEIPStatus": "exist",
    "PilotEIPStatus": "exist",
    "AccessLogProjectStatus": "exist",
    "RAMApplicationStatus": "reused",
    "CanaryPilotEIPStatus": ""
  }
}

错误码

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

变更历史

变更时间变更内容概要操作
2024-11-22OpenAPI 返回结构发生变更查看变更详情
2024-05-28OpenAPI 返回结构发生变更查看变更详情
2023-06-27OpenAPI 返回结构发生变更查看变更详情