ListClusterHealthCheckTask - 获取风险评估任务列表 - 微服务引擎MSE

获取历史风险评估任务列表。

调试

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

授权信息

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

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

操作	访问级别	资源类型	条件关键字	关联操作
mse:ListClusterHealthCheckTask	get	全部资源 ``	无	无

请求参数

名称	类型	必填	描述	示例值
InstanceId	string	否	实例 ID。	mse_prepaid_public_cn-7pp2o4wfx01
PageNum	integer	否	查询第几页	1
PageSize	integer	否	每页展示条数	10
RegionId	string	否	集群所在地域。	cn-hangzhou
RequestPars	string	否	扩展请求参数，JSON 格式。	{}
AcceptLanguage	string	否	返回信息的语言类型： zh：中文 en：英文	zh

返回参数

名称	类型	描述	示例值
	object	RestResult<PageResult>
RequestId	string	请求 ID。	4E9FDCFE-0738-493B-B801-82BDFBCB****
Success	boolean	请求结果，取值如下： `true`：请求成功。 `false`：请求失败。	true
Code	integer	Code 仅仅用来和 success 同步	200
ErrorCode	string	错误码。取值说明如下：请求成功：不返回 ErrorCode 字段。请求失败：返回 ErrorCode 字段。具体信息，请参见本文的错误码目录。	mse-100-000
HttpStatusCode	integer	HTTP 状态码。	200
Message	string	返回信息。	请求处理成功
DynamicCode	string	动态错误信息中的占位符	code
DynamicMessage	string	动态错误信息，用于替换返回参数 ErrMessage 错误信息中的%s。说明如果 ErrMessage 返回The Value of Input Parameter %s is not valid，且 DynamicMessage 返回 DtsJobId，则代表所传入的请求参数 DtsJobId 不合法。	The specified parameter is invalid.
Data	object	数据概览。
PageNumber	integer	列表的页码。	1
TotalSize	integer	查询到的总数。	9
PageSize	integer	输入时设置的每页行数。	10
Result	array<object>	风险评估任务列表。
Result	object	风险评估任务。
Id	integer	ID。	1
Score	integer	总得分。	60
TotalItem	integer	总检查项数。	10
TotalRisk	integer	总风险项数。	3
InstanceId	string	实例 ID。	mse_ingresspost-cn-0jbvrcex****
ClusterType	string	集群类型。	Nacos-Ans
Type	string	冗余字段。	null
Status	string	任务状态。	FINISH
PrimaryUser	string	集群归属用户 ID。	123456
Spec	string	规格。	MSE_SC_2_4_200_c
Replica	string	集群节点数量。	3
VersionCode	string	版本号。	NACOS_ANS_1_2_1_3
AppVersion	string	完整版本号。	1.2.1
ImageVersion	string	冗余字段。	null
CreateTime	string	任务创建时间。	2022-06-20T06:51:46Z
UpdateTime	string	最后更新时间。	2022-11-12 15:07:55
RiskList	array<object>	风险项列表。
RiskList	object	风险项信息。
Id	integer	ID。	3426
TaskId	long	关联的父任务 ID。	1
RiskName	string	风险名称。	引擎版本过低
RiskCode	string	风险编码。	22020010001
PrimaryUser	string	集群归属用户 ID。	123456
Type	integer	冗余字段。	null
Values	string	冗余字段。	null
Module	string	冗余字段。	null
RiskType	string	风险类型。	版本风险
RiskLevel	string	风险等级，取值： HIGH 高风险 MID 中风险 LOW 低风险	MID
Suggestion	string	建议。	{\"desc\":\"请尽快升级至最新版本\",\"links\":[{\"type\":\"upgrade\",\"desc\":\"点击升级\"}]}
Situation	string	现状。	{\"desc\":\"当前引擎版本过低，有大量功能缺失\",\"links\":[{\"type\":\"url\",\"value\":\"https://xxxx"\",\"desc\":\"版本说明\"}]}
Description	string	描述说明。	{\"desc\":\"引擎版本过低，有大量功能缺失，请尽快升级至最新版本！\"}
Mute	boolean	是否禁用此风险项通知功能。 true 禁用风险项通知 false 开启风险项通知	false
NoticeFeature	boolean	冗余字段。	null
ChargeType	string	付费类型。	PREPAY

示例

正常返回示例

JSON格式

{
  "RequestId": "4E9FDCFE-0738-493B-B801-82BDFBCB****",
  "Success": true,
  "Code": 200,
  "ErrorCode": "mse-100-000",
  "HttpStatusCode": 200,
  "Message": "请求处理成功",
  "DynamicCode": "code",
  "DynamicMessage": "The specified parameter is invalid.",
  "Data": {
    "PageNumber": 1,
    "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": "引擎版本过低",
            "RiskCode": "22020010001",
            "PrimaryUser": "123456",
            "Type": 0,
            "Values": "null",
            "Module": "null",
            "RiskType": "版本风险",
            "RiskLevel": "MID",
            "Suggestion": "{\\\"desc\\\":\\\"请尽快升级至最新版本\\\",\\\"links\\\":[{\\\"type\\\":\\\"upgrade\\\",\\\"desc\\\":\\\"点击升级\\\"}]}",
            "Situation": "{\\\"desc\\\":\\\"当前引擎版本过低，有大量功能缺失\\\",\\\"links\\\":[{\\\"type\\\":\\\"url\\\",\\\"value\\\":\\\"https://xxxx\"\\\",\\\"desc\\\":\\\"版本说明\\\"}]}",
            "Description": "{\\\"desc\\\":\\\"引擎版本过低，有大量功能缺失，请尽快升级至最新版本！\\\"}",
            "Mute": false,
            "NoticeFeature": true
          }
        ],
        "ChargeType": "PREPAY"
      }
    ]
  }
}

错误码

HTTP status code	错误码	错误信息	描述
400	IllegalRequest	Invalid request:%s	非法请求： %s
400	InvalidParameter	Parameter error:%s	请求参数错误：%s
403	NoPermission	You are not authorized to perform this operation:%s	没有权限使用此接口：%s
404	NotFound	Not found:%s	资源不存在：%s
500	InternalError	Console error. Try again later:%s	控制台错误.稍后重试：%s

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

变更历史

变更时间	变更内容概要	操作
2023-04-25	API 内部配置变更，不影响调用	查看变更详情