ListClusterHealthCheckTask - Microservices Engine - Alibaba Cloud Documentation Center

Retrieves information about historical health check tasks.

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

mse:ListClusterHealthCheckTask

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
InstanceId	string	No	The instance ID.	mse_prepaid_public_cn-7pp2o4wfx01
PageNum	integer	No	The number of the page to return.	0
PageSize	integer	No	The number of entries per page.	10
RegionId	string	No	The region in which the cluster resides.	cn-hangzhou
RequestPars	string	No	The extended request parameter in the JSON format.	{}
AcceptLanguage	string	No	The language of the response. Valid values: zh: Chinese en: English	zh

Response elements

Parameter	Type	Description	Example
	object	RestResult<PageResult>
RequestId	string	The request ID.	4E9FDCFE-0738-493B-B801-82BDFBCB****
Success	boolean	Indicates whether the call was successful. Valid values: `true`: The request was successful. `false`: The request failed.	true
Code	integer	Code is only used to synchronize with success	200
ErrorCode	string	The error code. Take note of the following items: Successful request: The ErrorCode field is not returned. Failed request: The ErrorCode field is returned. For more information, see the Error codes section in this topic.	mse-100-000
HttpStatusCode	integer	The HTTP status code.	200
Message	string	The returned message.	The request was successfully processed.
DynamicCode	string	The dynamic part in the error message.	code
DynamicMessage	string	The dynamic error message used to replace %s in the ErrMessage parameter. Note If ErrMessage returns The Value of Input Parameter %s is not valid, and DynamicMessage returns DtsJobId, it indicates that the DtsJobId request parameter is invalid.	The specified parameter is invalid.
Data	object	The data returned.
PageNumber	integer	The page number of the list.	0
TotalSize	integer	The total number of queried rules.	9
PageSize	integer	The number of entries per page.	10
Result	array	The list of health check tasks.
	object	The health check task.
Id	integer	The ID.	1
Score	integer	The total score.	60
TotalItem	integer	The total number of inspection items.	10
TotalRisk	integer	The total number of risk items.	3
InstanceId	string	The instance ID.	mse_ingresspost-cn-0jbvrcex****
ClusterType	string	The type of the instance.	Nacos-Ans
Type	string	Redundant field.	null
Status	string	The job states.	FINISH
PrimaryUser	string	The ID of the user to which the cluster belongs.	123456
Spec	string	The specifications.	MSE_SC_2_4_200_c
Replica	string	The number of nodes in the cluster.	3
VersionCode	string	The version number.	NACOS_ANS_1_2_1_3
AppVersion	string	The complete version number.	1.2.1
ImageVersion	string	Redundant field.	null
CreateTime	string	The time when the task was created.	2022-06-20T06:51:46Z
UpdateTime	string	The time when the instance was last updated.	2022-11-12 15:07:55
RiskList	array	The list of risk items.
	object	The information about risk items.
Id	integer	The ID.	3426
TaskId	integer	The ID of the associated parent task.	1
RiskName	string	The risk name.	The engine version is outdated.
RiskCode	string	The risk code.	22020010001
PrimaryUser	string	The ID of the user to which the cluster belongs.	123456
Type	integer	Redundant field.	null
Values	string	Redundant field.	null
Module	string	Redundant field.	null
RiskType	string	The type of the risk.	Version risk
RiskLevel	string	The risk level. Valid values: HIGH: High risk MID: Medium risk LOW: Low risk	MID
Suggestion	string	The suggestion.	{"desc": "Upgrade to the latest version at the earliest opportunity.", "links":\[{"type": "upgrade", "desc": "Click to upgrade"}]}
Situation	string	The current situation.	{\\"desc\\":\\"The engine version is outdated and a large number of features are not supported.\\",\\"links\\":\[{\\"type\\":\\"url\\",\\"value\\":\\"https://xxxx"\\",\\"desc\\":\\"Release notes\\"}]}
Description	string	The description.	{\\"desc\\":\\"The engine version is outdated and a large number of features are not supported. Upgrade the engine to the latest version at the earliest opportunity. \\"}
Mute	boolean	Specifies whether to disable the notification feature if the risk item occurs. true: Disables risk item notifications false: Enables risk item notifications	false
NoticeFeature	boolean	Redundant field.	null
RiskNameEn	string	The English name of the risk.
SuggestionEn	string	The English description of the suggestion.
SituationEn	string	The English description of the current situation.
DescriptionEn	string	The English description of the risk.
ChargeType	string	The billing method.	PREPAY

Examples

Success response

JSON format

{
  "RequestId": "4E9FDCFE-0738-493B-B801-82BDFBCB****",
  "Success": true,
  "Code": 200,
  "ErrorCode": "mse-100-000",
  "HttpStatusCode": 200,
  "Message": "The request was successfully processed.\n",
  "DynamicCode": "code",
  "DynamicMessage": "The specified parameter is invalid.",
  "Data": {
    "PageNumber": 0,
    "TotalSize": 9,
    "PageSize": 10,
    "Result": [
      {
        "Id": 1,
        "Score": 60,
        "TotalItem": 10,
        "TotalRisk": 3,
        "InstanceId": "mse_ingresspost-cn-0jbvrcex****",
        "ClusterType": "Nacos-Ans",
        "Type": "null\n",
        "Status": "FINISH",
        "PrimaryUser": "123456",
        "Spec": "MSE_SC_2_4_200_c",
        "Replica": "3",
        "VersionCode": "NACOS_ANS_1_2_1_3",
        "AppVersion": "1.2.1",
        "ImageVersion": "null",
        "CreateTime": "2022-06-20T06:51:46Z",
        "UpdateTime": "2022-11-12 15:07:55",
        "RiskList": [
          {
            "Id": 3426,
            "TaskId": 1,
            "RiskName": "The engine version is outdated.\n",
            "RiskCode": "22020010001",
            "PrimaryUser": "123456",
            "Type": 0,
            "Values": "null",
            "Module": "null",
            "RiskType": "Version risk\n",
            "RiskLevel": "MID",
            "Suggestion": "{\"desc\": \"Upgrade to the latest version at the earliest opportunity.\", \"links\":\\[{\"type\": \"upgrade\", \"desc\": \"Click to upgrade\"}]}\n",
            "Situation": "{\\\\\"desc\\\\\":\\\\\"The engine version is outdated and a large number of features are not supported.\\\\\",\\\\\"links\\\\\":\\[{\\\\\"type\\\\\":\\\\\"url\\\\\",\\\\\"value\\\\\":\\\\\"https://xxxx\"\\\\\",\\\\\"desc\\\\\":\\\\\"Release notes\\\\\"}]}\n",
            "Description": "{\\\\\"desc\\\\\":\\\\\"The engine version is outdated and a large number of features are not supported. Upgrade the engine to the latest version at the earliest opportunity. \\\\\"}\n",
            "Mute": false,
            "NoticeFeature": true,
            "RiskNameEn": "",
            "SuggestionEn": "",
            "SituationEn": "",
            "DescriptionEn": ""
          }
        ],
        "ChargeType": "PREPAY"
      }
    ]
  }
}

Error codes

HTTP status code	Error code	Error message	Description
400	IllegalRequest	Invalid request:%s	Invalid request: %s
400	InvalidParameter	Parameter error:%s	Request parameter error: %s
500	InternalError	Console error. Try again later:%s	Console error. Try again later: %s
403	NoPermission	You are not authorized to perform this operation:%s	You do not have the permission to use this interface:%s
404	NotFound	Not found:%s	The resource does not exist:%s

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.