首页 微服务引擎MSE API参考指南 API目录 注册配置中心 风险评估 ListClusterHealthCheckTask - 获取风险评估任务列表

ListClusterHealthCheckTask - 获取风险评估任务列表

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

调试

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

调试

授权信息

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

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

请求参数

名称类型必填描述示例值
InstanceIdstring

实例ID。

mse_prepaid_public_cn-7pp2o4wfx01
PageNuminteger

查询第几页

0
PageSizeinteger

每页展示条数

10
RegionIdstring

集群所在地域。

cn-hangzhou
RequestParsstring

扩展请求参数,JSON格式。

{}
AcceptLanguagestring

返回信息的语言类型:

  • zh:中文
  • en:英文
zh

返回参数

名称类型描述示例值
object

RestResult<PageResult>

RequestIdstring

请求ID。

4E9FDCFE-0738-493B-B801-82BDFBCB****
Successboolean

请求结果,取值如下:

  • true:请求成功。
  • false:请求失败。
true
Codeinteger

Code仅仅用来和success同步

200
ErrorCodestring

错误码。取值说明如下:

  • 请求成功:不返回ErrorCode字段。
  • 请求失败:返回ErrorCode字段。具体信息,请参见本文的错误码目录。
mse-100-000
HttpStatusCodeinteger

HTTP状态码。

200
Messagestring

返回信息。

请求处理成功
DynamicCodestring

动态错误信息中的占位符

code
DynamicMessagestring

动态错误信息,用于替换返回参数ErrMessage错误信息中的**%s**。

说明如果ErrMessage返回The Value of Input Parameter %s is not valid,且DynamicMessage返回DtsJobId,则代表所传入的请求参数DtsJobId不合法。
The specified parameter is invalid.
Dataobject

数据概览。

PageNumberinteger

列表的页码。

0
TotalSizeinteger

查询到的总数。

9
PageSizeinteger

输入时设置的每页行数。

10
Resultarray

风险评估任务列表。

object

风险评估任务。

Idinteger

ID。

1
Scoreinteger

总得分。

60
TotalIteminteger

总检查项数。

10
TotalRiskinteger

总风险项数。

3
InstanceIdstring

实例ID。

mse_ingresspost-cn-0jbvrcex****
ClusterTypestring

集群类型。

Nacos-Ans
Typestring

冗余字段。

null
Statusstring

任务状态。

FINISH
PrimaryUserstring

集群归属用户ID。

123456
Specstring

规格。

MSE_SC_2_4_200_c
Replicastring

集群节点数量。

3
VersionCodestring

版本号。

NACOS_ANS_1_2_1_3
AppVersionstring

完整版本号。

1.2.1
ImageVersionstring

冗余字段。

null
CreateTimestring

任务创建时间。

2022-06-20T06:51:46Z
UpdateTimestring

最后更新时间。

2022-11-12 15:07:55
RiskListarray

风险项列表。

object

风险项信息。

Idinteger

ID。

3426
TaskIdlong

关联的父任务ID。

1
RiskNamestring

风险名称。

引擎版本过低
RiskCodestring

风险编码。

22020010001
PrimaryUserstring

集群归属用户ID。

123456
Typeinteger

冗余字段。

null
Valuesstring

冗余字段。

null
Modulestring

冗余字段。

null
RiskTypestring

风险类型。

版本风险
RiskLevelstring

风险等级,取值:

  • HIGH 高风险
  • MID 中风险
  • LOW 低风险
MID
Suggestionstring

建议。

{\"desc\":\"请尽快升级至最新版本\",\"links\":[{\"type\":\"upgrade\",\"desc\":\"点击升级\"}]}
Situationstring

现状。

{\"desc\":\"当前引擎版本过低,有大量功能缺失\",\"links\":[{\"type\":\"url\",\"value\":\"https://xxxx"\",\"desc\":\"版本说明\"}]}
Descriptionstring

描述说明。

{\"desc\":\"引擎版本过低,有大量功能缺失,请尽快升级至最新版本!\"}
Muteboolean

是否禁用此风险项通知功能。

  • true 禁用风险项通知
  • false 开启风险项通知
false
NoticeFeatureboolean

冗余字段。

null
ChargeTypestring

付费类型。

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": 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": "引擎版本过低",
            "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错误码错误信息描述
400IllegalRequestInvalid request:%s非法请求: %s
400InvalidParameterParameter error:%s请求参数错误:%s
403NoPermissionYou are not authorized to perform this operation:%s没有权限使用此接口:%s
404NotFoundNot found:%s资源不存在:%s
500InternalErrorConsole error. Try again later:%s控制台错误.稍后重试:%s

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

阿里云首页 微服务引擎 相关技术圈