DescribeServiceMeshAdditionalStatus - Alibaba Cloud Service Mesh

Call DescribeServiceMeshAdditionalStatus to query information about additional checks for an ASM instance.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

servicemesh:DescribeServiceMeshAdditionalStatus

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
ServiceMeshId	string	Yes	The ID of the ASM instance.	ca04bc38979214bf2882be79d39b4****
CheckMode	string	No	The check mode of the service mesh. Valid values: `normal`: Checks the status of only the API Server load balancing, Pilot load balancing, audit logs, and Logtail installation on the data plane. full: Checks the items in `normal` mode and the status of control plane logs, access logs, the service mesh security group, and the API Server EIP.	full

Response elements

Element	Type	Description	Example
	object	The result of the status query.
RequestId	string	The request ID.	11fd0027-c27e-41bb-a565-75583054****
ClusterStatus	object	The status of the cluster.
ApiServerLoadBalancerStatus	object	The status of API Server load balancing.
SLBExistStatus	string	The status of the SLB instance. Valid values: `exist`: The SLB instance exists. `not_exist`: The SLB instance does not exist. `conflict`: A conflict is detected. `failed`: The check failed. `time_out`: The check timed out.	exist
SLBBackEndServerNumStatus	string	The status of the number of backend servers of the SLB instance. Valid values: `too_much`: The number of backend servers is greater than expected. `num_exact`: The number of backend servers is as expected. `too_little`: The number of backend servers is less than expected.	num_exact
Reused	boolean	Indicates whether the SLB instance is reused. Valid values: `true`: The SLB instance is reused. `false`: The SLB instance is not reused.	false
Locked	boolean	Indicates whether the SLB instance is locked. Valid values: `true`: The SLB instance is locked. `false`: The SLB instance is not locked.	false
PayType	string	The billing method of the SLB instance. Valid values: `PrePay`: subscription `PayOnDemand`: pay-as-you-go	PrePay
PilotLoadBalancerStatus	object	The status of Pilot load balancing.
SLBExistStatus	string	The status of the SLB instance. Valid values: `exist`: The SLB instance exists. `not_exist`: The SLB instance does not exist. `conflict`: A conflict is detected. `failed`: The check failed. `time_out`: The check timed out.	exist
SLBBackEndServerNumStatus	string	The status of the number of backend servers of the SLB instance. Valid values: `too_much`: The number of backend servers is greater than expected. `num_exact`: The number of backend servers is as expected. `too_little`: The number of backend servers is less than expected.	num_exact
Reused	boolean	Indicates whether the SLB instance is reused. Valid values: `true`: The SLB instance is reused. `false`: The SLB instance is not reused.	true
Locked	boolean	Indicates whether the SLB instance is locked. Valid values: `true`: The SLB instance is locked. `false`: The SLB instance is not locked.	false
PayType	string	The billing method of the SLB instance. Valid values: `PrePay`: subscription `PayOnDemand`: pay-as-you-go	PayOnDemand
CanaryPilotLoadBalancerStatus	object	The status of Pilot load balancing for the canary release version.
SLBExistStatus	string	Indicates whether the SLB instance exists. Valid values: `exist`: The SLB instance exists. `not_exist`: The SLB instance does not exist. `time_out`: A timeout occurred when obtaining the status. `failed`: The instance is invalid.	exist
SLBBackEndServerNumStatus	string	The status of the number of backend servers of the SLB instance. Valid values: `num_exact`: The number is as expected. `too_much`: The number of backend servers is too large. `too_little`: The number of backend servers is too small.	num_exact
Reused	boolean	Indicates whether the SLB instance is reused. Valid values: `true`: The SLB instance is reused. A listener that is not for the service mesh is detected on the SLB instance. `false`: The SLB instance is not reused.	false
Locked	boolean	Indicates whether the SLB instance has a financial lock. Valid values: `true`: The SLB instance has a financial lock. `false`: The SLB instance does not have a financial lock.	false
PayType	string	The billing method of the SLB instance. Valid values: `PrePay`: subscription `PayOnDemand` (default): pay-as-you-go	PayOnDemand
AuditProjectStatus	string	The status of the audit log project. Valid values: `exist`: The project exists. `not exist`: The project does not exist.	exist
LogtailStatusRecord	object	The Logtail installation status of each data plane cluster.	{ "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	string	The status of the control plane log project. Valid values: `exist`: The project exists. `not_exist`: The project does not exist. `failed`: The check failed. `time_out`: The check timed out.	exist
SgStatus	string	The reuse status of the service mesh security group. Valid values: `reused`: The security group is reused. `not_reused`: The security group is not reused. `failed`: The check failed. `time_out`: The check timed out.	reused
ApiServerEIPStatus	string	The status of the elastic IP address (EIP) that is attached to the API Server. Valid values: `exist`: The EIP exists. `not_exist`: The EIP does not exist. `failed`: The check failed. `time_out`: The check timed out. `not_in_use`: The EIP is not attached to the API Server. `locked`: The EIP is locked.	exist
PilotEIPStatus	string	The status of the EIP that is attached to Pilot. Valid values: `exist`: The EIP exists. `not_exist`: The EIP does not exist. `failed`: The check failed. `time_out`: The check timed out. `not_in_use`: The EIP is not attached to the API Server. `locked`: The EIP is locked.	exist
AccessLogProjectStatus	string	The status of the access log project. Valid values: `exist`: The project exists. `not_exist`: The project does not exist. `failed`: The check failed. `time_out`: The check timed out.	exist
RAMApplicationStatus	string	The status of the RAM OAuth application that is integrated with the service mesh topology. Valid values: `exist`: The application exists. `reused`: The application is reused. `not_exist`: The application does not exist. `failed`: The check failed. `time_out`: The check timed out.	reused
CanaryPilotEIPStatus	string	The status of the EIP for the canary release version of Pilot.	exist

Examples

Success response

JSON format

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

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.