DescribeAdvisorChecks - 获取巡检项

更新时间:
复制 MD 格式

获取用户当前可用的巡检项

调试

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

调试

授权信息

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

  • 操作:是指具体的权限点。

  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。

  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:

    • 对于必选的资源类型,用前面加 * 表示。

    • 对于不支持资源级授权的操作,用全部资源表示。

  • 条件关键字:是指云产品自身定义的条件关键字。

  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

advisor:DescribeAdvisorChecks

none

*全部资源

*

无 无

请求参数

名称

类型

必填

描述

示例值

Language

string

否

使用的语言。

zh

Product

string

否

云产品 Code。

ecs

返回参数

名称

类型

描述

示例值

object

Code

string

错误编码。

200

RequestId

string

请求 ID。

566331F9-5AB3-550F-B745-A730331F97A9

Data

object

AdvisorCheck

array<object>

查询结果。

object

查询结果对象体。

Status

string

诊断项是否被禁用状态:

  • enabled: 可用

  • disabled: 禁用

enabled

Product

string

云产品 Code。

ecs

OperateColumn

string

操作字段,使用前端模板或诊断建议 action 中定义 json 字段。

[{"key": "Detail", "value": "/diagnosis?product=${Product}&resourceId=${Resource.resourceId}", "type": "template"} ]

GmtModified

string

巡检项配置更新时间,格式为 yyyy-mm-dd hh:mm:ss。

2023-07-01 00:00:00

ViewColumn

string

展示列,即控制台展示巡检项详情的具体配置。

[{"key":"EcsHighCpuUtilization_xxxx", "type":"DEFAULT"}, {"key":"EcsHighCpuUtilization_xxxx", "type":"DEFAULT"}, {"key":"EcsHighCpuUtilization_xxxx", "type":"DEFAULT"}, ]

GmtCreated

string

巡检项配置创建时间,格式为 yyyy-mm-dd hh:mm:ss。

2023-07-01 00:00:00

Description

string

巡检项描述,推荐操作和操作说明。

CPU负载,公网带宽负载,内存负载百分比算法超过标准值过高

Tips

string

巡检建议一句话简述。

请排查实例资源占用情况或升级实例规格

Code

string

巡检项 Code。

EcsHighCpuUtilization

Category

string

巡检项分类:

  • 1: 安全合规

  • 2: 性能效率

  • 3: 业务稳定

  • 4: 成本优化

  • 5: 服务限制

1

Name

string

巡检项名称。

ECS 性能负载巡检

示例

正常返回示例

JSON格式

{
  "Code": "200",
  "RequestId": "566331F9-5AB3-550F-B745-A730331F97A9",
  "Data": {
    "AdvisorCheck": [
      {
        "Status": "enabled",
        "Product": "ecs",
        "OperateColumn": "[{\"key\": \"Detail\", \"value\": \"/diagnosis?product=${Product}&resourceId=${Resource.resourceId}\", \"type\": \"template\"} ]",
        "GmtModified": "2023-07-01 00:00:00",
        "ViewColumn": "[{\"key\":\"EcsHighCpuUtilization_xxxx\", \"type\":\"DEFAULT\"}, {\"key\":\"EcsHighCpuUtilization_xxxx\", \"type\":\"DEFAULT\"}, {\"key\":\"EcsHighCpuUtilization_xxxx\", \"type\":\"DEFAULT\"}, ]",
        "GmtCreated": "2023-07-01 00:00:00",
        "Description": "CPU负载,公网带宽负载,内存负载百分比算法超过标准值过高",
        "Tips": "请排查实例资源占用情况或升级实例规格",
        "Code": "EcsHighCpuUtilization",
        "Category": "1",
        "Name": "ECS 性能负载巡检"
      }
    ]
  }
}

错误码

HTTP status code

错误码

错误信息

描述

500 InternalError The request processing has failed due to some unknown error. 服务端错误。
403 Forbidden.RAM User not authorized to operate on the specified resource, or this API doesn't support RAM. 未通过鉴权
403 Forbidden.NotActivated User has not activated Advisor Service. 用户未开通Advisor产品。

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

变更历史

更多信息,参考变更详情。