All Products
Search

This Product

    Alibaba Cloud Service Mesh:DescribeServiceMeshAdditionalStatus

    Document Center

    Alibaba Cloud Service Mesh:DescribeServiceMeshAdditionalStatus

    Last Updated:Jul 01, 2024

    Queries the check results of a 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.

    Authorization information

    There is currently no authorization information disclosed in the API.

    Request parameters

    ParameterTypeRequiredDescriptionExample
    ServiceMeshIdstringYes

    The ID of the ASM instance.

    		ca04bc38979214bf2882be79d39b4****
    CheckModestringNo

    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 installation of Logtail 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 in normal mode.
    		full

    Response parameters

    ParameterTypeDescriptionExample
    object

    The response parameters.

    RequestIdstring

    The request ID.

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

    The cluster status.

    ApiServerLoadBalancerStatusobject

    The check results of the CLB instance created for exposing the API server.

    SLBExistStatusstring

    The check results of the CLB instance. Valid values:

    • exist: The CLB instance exists.
    • not_exist: The CLB instance does not exist.
    • conflict: Conflicts are detected.
    • failed: The check fails.
    • time_out: The check times out.
    		exist
    SLBBackEndServerNumStatusstring

    The check results of the number of backend servers of the CLB instance created for exposing Istio Pilot. Valid values:

    • too_much: An excessive number of backend servers are created.
    • num_exact: A proper number of backend servers are created.
    • too_little: The number of backend servers falls short.
    		num_exact
    Reusedboolean

    Indicates whether the CLB instance is reused. Valid values:

    • true
    • false
    		false
    Lockedboolean

    Indicates whether the CLB instance is locked. Valid values:

    • true
    • false
    		false
    PayTypestring

    The billing method of the CLB instance. Valid values:

    • PrePay: subscription
    • PayOnDemand: pay-as-you-go
    		PrePay
    PilotLoadBalancerStatusobject

    The check results of the CLB instance created for exposing Istio Pilot.

    SLBExistStatusstring

    The check results of the CLB instance. Valid values:

    • exist: The CLB instance exists.
    • not_exist: The CLB instance does not exist.
    • conflict: Conflicts are detected.
    • failed: The check fails.
    • time_out: The check times out.
    		exist
    SLBBackEndServerNumStatusstring

    The check results of the number of backend servers of the CLB instance created for exposing Istio Pilot. Valid values:

    • too_much: An excessive number of backend servers are created.
    • num_exact: A proper number of backend servers are created.
    • too_little: The number of backend servers falls short.
    		num_exact
    Reusedboolean

    Indicates whether the CLB instance is reused. Valid values:

    • true
    • false
    		true
    Lockedboolean

    Indicates whether the CLB instance is locked. Valid values:

    • true
    • false
    		false
    PayTypestring

    The billing method of the CLB instance. Valid values:

    • PrePay: subscription
    • PayOnDemand: pay-as-you-go
    		PayOnDemand
    CanaryPilotLoadBalancerStatusobject

    The check results of the CLB instance that is created for exposing Istio Pilot and used during canary release.

    SLBExistStatusstring

    The check result of the CLB instance. Valid values:

    • exist: The CLB instance exists.
    • not_exist: The CLB instance does not exist.
    • time_out: The check times out.
    • failed: The CLB instance has expired.
    		exist
    SLBBackEndServerNumStatusstring

    The check result of the number of backend servers of the CLB instance created for exposing Istio Pilot. Valid values:

    • num_exact: A proper number of backend servers are created.
    • too_much: An excessive number of backend servers are created.
    • too_little: The number of backend servers falls short.
    		num_exact
    Reusedboolean

    Indicates whether the CLB instance is reused. Valid values:

    • true: The CLB instance is reused. Non-ASM listener configuration is detected in the listener configurations of the CLB instance.
    • false: The CLB instance is not reused.
    		false
    Lockedboolean

    Indicates whether the CLB instance is locked due to overdue payments. Valid values:

    • true
    • false
    		false
    PayTypestring

    The billing method of the CLB instance. Valid values:

    • PrePay: subscription
    • PayOnDemand (default): pay-as-you-go
    		PayOnDemand
    AuditProjectStatusstring

    Indicates whether audit logs exist. Valid values:

    • exist
    • not exist
    		exist
    LogtailStatusRecordobject

    Indicates whether Logtail is installed in clusters on the data plane.

    		{ "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

    Indicates whether control plane logs exist. 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.
    		exist
    SgStatusstring

    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.
    		reused
    ApiServerEIPStatusstring

    The check result of the 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.
    • not_in_use: The EIP is not associated with the API Server.
    • locked: The EIP is locked.
    		exist
    PilotEIPStatusstring

    The check result of whether the EIP is 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 is timed out.
    • not_in_use: The EIP is not associated with the API server.
    • locked: The EIP is locked.
    		exist
    AccessLogProjectStatusstring

    Indicates whether access logs exist. Valid values:

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

    The status of the RAM OAuth application that is integrated with Mesh Topology. Valid values:

    • exist: The RAM OAuth application exists.
    • reused: The RAM OAuth application is reused.
    • not_exist: The RAM OAuth application does not exist.
    • failed: The check fails.
    • time_out: The check times out.
    		reused

    Examples

    Sample success responses

    JSONformat

    {
  "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"
  }
}

    Error codes

    For a list of error codes, visit the Service error codes.

    Change history

    Change timeSummary of changesOperation
    2024-05-28The response structure of the API has changedView Change Details
    2023-06-27The response structure of the API has changedView Change Details