Queries the check results of an Alibaba Cloud Service Mesh (ASM) instance.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes DescribeServiceMeshAdditionalStatus

The operation that you want to perform. Set the value to DescribeServiceMeshAdditionalStatus.

ServiceMeshId String Yes ca04bc38979214bf2882be79d39b4****

The ID of the ASM instance.

CheckMode String No full

The check mode of the ASM instance. Valid values:

  • normal: checks the Server Load Balancer (SLB) instances created for exposing the API server and Istio Pilot, audit logs, and the Logtail installation for clusters on the data plane.
  • full: checks control plane logs, access logs, security groups, and the elastic IP addresses (EIPs) of the API server in addition to the check items of the normal mode.

Response parameters

Parameter Type Example Description
RequestId String 11fd0027-c27e-41bb-a565-75583054****

The ID of the request.

ClusterStatus Object

The status of the cluster.

ApiServerLoadBalancerStatus Object

The check results of the SLB instances created for exposing the API server.

SLBExistStatus String exist

The check result of the SLB instance. Valid values:

  • exist: The SLB instance exists.
  • not_exist: The SLB instance does not exist.
  • conflict: Conflicts are detected.
  • failed: The check fails.
  • time_out: The check times out.
SLBBackEndServerNumStatus String num_exact

The check result of the number of SLB instances created for exposing the API server. Valid values:

  • too_much: An excessive number of SLB instances are created.
  • num_exact: A proper number of SLB instances are created.
  • too_little: The number of SLB instances falls short.
Reused Boolean false

Indicates whether the SLB instance is reused. A value of true indicates that the SLB instance is reused. A value of false indicates that the SLB instance is not reused.

PayType String PrePay

The billing method of the SLB instance. A value of PrePay indicates the subscription billing method. A value of PayOnDemand indicates the pay-as-you-go billing method.

PilotLoadBalancerStatus Object

The check results of the SLB instances created for exposing Istio Pilot.

SLBExistStatus String exist

The check result of the SLB instance. Valid values:

  • exist: The SLB instance exists.
  • not_exist: The SLB instance does not exist.
  • conflict: Conflicts are detected.
  • failed: The check fails.
  • time_out: The check times out.
SLBBackEndServerNumStatus String num_exact

The check result of the number of SLB instances created for exposing Istio Pilot. Valid values:

  • too_much: An excessive number of SLB instances are created.
  • num_exact: A proper number of SLB instances are created.
  • too_little: The number of SLB instances falls short.
Reused Boolean true

Indicates whether the SLB instance is reused. Valid values:

  • true: The SLB instance is reused.
  • false: The SLB instance is not reused.
PayType String PayOnDemand

The billing method of the SLB instance. Valid values:

  • PrePay: subscription
  • PayOnDemand: pay-as-you-go
AuditProjectStatus String exist

The check result of audit logs. Valid values:

  • exist: Audit logs exist.
  • not exist: Audit logs do not exist.
LogtailStatusRecord Map

The check results of the Longtail installation for clusters on the data plane.

Object

The check result of the Logtail installation for the cluster.

ClusterId String caeac85a793c94afbbb0a4bb20320****

The ID of the cluster on the data plane.

LogtailDetailStatus String exist

Indicates whether Logtail is installed for the cluster. Valid values:

  • exist: Logtail is installed.
  • not exist: Logtail is not installed.
AccessLogDashboards Array

The information about the Log Service dashboard of audit logs on the data plane.

Title String audit-c186a6d9641a24098b549****

The name of the dashboard.

Url String https://sls.console.aliyun.com/lognext/project/audit-c186a6d9641a24098b549xxxxxxxxxxxx/dashboard/mesh

The URL of the dashboard.

ControlPlaneProjectStatus String exist

The check result of control plane logs. Valid values:

  • exist: Control plane logs exist.
  • not_exist: Control plane logs do not exist.
  • failed: The check fails.
  • time_out: The check times out.
SgStatus String reused

Indicates whether the security group is reused. Valid values:

  • reused: The security group is reused.
  • not_reused: The security group is not reused.
  • failed: The check fails.
  • time_out: The check times out.
ApiServerEIPStatus String exist

The check result of the elastic IP address (EIP) associated with the API server. Valid values:

  • exist: The EIP exists.
  • not_exist: The EIP does not exist.
  • failed: The check fails.
  • time_out: The check times out.
AccessLogProjectStatus String exist

The check result of access logs. Valid values:

  • exist: Access logs exist.
  • not_exist: Access logs do not exist.
  • failed: The check fails.
  • time_out: The check times out.

Examples

Sample requests

http(s)://[Endpoint]/?Action=DescribeServiceMeshAdditionalStatus
&ServiceMeshId=ca04bc38979214bf2882be79d39b4****
&CheckMode=full
&<Common request parameters>

Sample success responses

XML format

HTTP/1.1 200 OK
Content-Type:application/xml

<DescribeServiceMeshAdditionalStatusResponse>
    <RequestId>11fd0027-c27e-41bb-a565-75583054****</RequestId>
    <ClusterStatus>
        <ApiServerLoadBalancerStatus>
            <SLBExistStatus>exist</SLBExistStatus>
            <SLBBackEndServerNumStatus>num_exact</SLBBackEndServerNumStatus>
            <Reused>false</Reused>
            <PayType>PrePay</PayType>
        </ApiServerLoadBalancerStatus>
        <PilotLoadBalancerStatus>
            <SLBExistStatus>exist</SLBExistStatus>
            <SLBBackEndServerNumStatus>num_exact</SLBBackEndServerNumStatus>
            <Reused>true</Reused>
            <PayType>PayOnDemand</PayType>
        </PilotLoadBalancerStatus>
        <AuditProjectStatus>exist</AuditProjectStatus>
        <LogtailStatusRecord>
            <key>
                <ClusterId>caeac85a793c94afbbb0a4bb20320****</ClusterId>
                <LogtailDetailStatus>exist</LogtailDetailStatus>
                <AccessLogDashboards>
                    <Title>audit-c186a6d9641a24098b549****</Title>
                    <Url>https://sls.console.aliyun.com/lognext/project/audit-c186a6d9641a24098b549xxxxxxxxxxxx/dashboard/mesh</Url>
                </AccessLogDashboards>
            </key>
        </LogtailStatusRecord>
        <ControlPlaneProjectStatus>exist</ControlPlaneProjectStatus>
        <SgStatus>reused</SgStatus>
        <ApiServerEIPStatus>exist</ApiServerEIPStatus>
        <AccessLogProjectStatus>exist</AccessLogProjectStatus>
    </ClusterStatus>
</DescribeServiceMeshAdditionalStatusResponse>

JSON format

HTTP/1.1 200 OK
Content-Type:application/json

{
  "RequestId" : "11fd0027-c27e-41bb-a565-75583054****",
  "ClusterStatus" : {
    "ApiServerLoadBalancerStatus" : {
      "SLBExistStatus" : "exist",
      "SLBBackEndServerNumStatus" : "num_exact",
      "Reused" : false,
      "PayType" : "PrePay"
    },
    "PilotLoadBalancerStatus" : {
      "SLBExistStatus" : "exist",
      "SLBBackEndServerNumStatus" : "num_exact",
      "Reused" : true,
      "PayType" : "PayOnDemand"
    },
    "AuditProjectStatus" : "exist",
    "LogtailStatusRecord" : {
      "key" : {
        "ClusterId" : "caeac85a793c94afbbb0a4bb20320****",
        "LogtailDetailStatus" : "exist",
        "AccessLogDashboards" : {
          "Title" : "audit-c186a6d9641a24098b549****",
          "Url" : "https://sls.console.aliyun.com/lognext/project/audit-c186a6d9641a24098b549xxxxxxxxxxxx/dashboard/mesh"
        }
      }
    },
    "ControlPlaneProjectStatus" : "exist",
    "SgStatus" : "reused",
    "ApiServerEIPStatus" : "exist",
    "AccessLogProjectStatus" : "exist"
  }
}

Error codes

For a list of error codes, visit the API Error Center.