DescribeAdvisorChecksFoPages - 分页获取巡检项

更新时间:
复制 MD 格式

巡检项设置-分页

接口说明

不兼容 Go SDK,如需要 Go SDK 请使用 DescribeAdvicesFlatPage API。

调试

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

调试

授权信息

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

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

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

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

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

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

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

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

操作

访问级别

资源类型

条件关键字

关联操作

advisor:DescribeAdvisorChecksFoPages

none

*全部资源

*

无 无

请求参数

名称

类型

必填

描述

示例值

PageNumber

integer

否

算法库列表的页码。起始值:1。默认值:1 。

1

PageSize

integer

否

每页数据条数。

10

Name

string

否

巡检项名称。

****

Category

string

否

该参数为无效参数,成本优化暂不支持

*

Product

string

否

云产品 Code。

ecs

Status

string

否

诊断项是否被禁用状态:

  • enabled: 可用

  • disabled: 禁用

enabled

Token

string

否

凭证 Token 内容。

***

BizCategory

string

否

巡检类型

2

AssumeAliyunId

integer

否

巡检主账号

11*********35

CheckTypes

array

否

该参数为无效参数,成本优化暂不支持

integer

否

巡检分类

*

Source

string

否

该参数为无效参数,成本优化暂不支持

*

Language

string

否

使用的语言。

zh

返回参数

名称

类型

描述

示例值

object

Schema of Response

RequestId

string

Id of the request

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

Code

string

错误编码。

200

Data

array<object>

查询结果对象体。

array<object>

查询结果。

PageNo

integer

分页号。

1

PageSize

integer

每页数据条数。

10

Total

integer

数据总条数

100

Result

array<object>

查询结果对象体。

object

查询结果对象体。

Name

string

巡检项名称。

ECS低利用率检查

Code

string

巡检项 Code。

EcsCostLowUtilizationCheck

Tips

string

巡检建议一句话简述

ECS低利用率建议结合实际业务考虑对实例进行降配操作,参考文档。

Category

string

巡检项分类:

  • 21: 低资源利用率

  • 22: 闲置资源

  • 23: 付费方式

  • 24: 代次升级

21

SubCategory

array

暂不支持返回

integer

暂不支持

*

Status

string

诊断项是否被禁用状态:

  • enabled: 可用

  • disabled: 禁用

enabled

ConfigSupport

string

是否支持自定义配置

false

ViewColumn

string

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

[{\"type\":\"DEFAULT\",\"key\":\"EcsCostIdleCheck_resourceId\"},{\"type\":\"DEFAULT\",\"key\":\"EcsCostIdleCheck_resourceName\"},{\"type\":\"DEFAULT\",\"key\":\"EcsCostIdleCheck_regionId\"},{\"type\":\"DEFAULT\",\"key\":\"EcsCostIdleCheck_instanceChargeType\"},{\"type\":\"DEFAULT\",\"key\":\"EcsCostIdleCheck_instanceType\"},{\"type\":\"DEFAULT\",\"key\":\"EcsCostIdleCheck_severity\"},{\"type\":\"DEFAULT\",\"key\":\"EcsCostIdleCheck_costBefore\"},{\"type\":\"DEFAULT\",\"key\":\"EcsCostIdleCheck_costAfter\"},{\"type\":\"DEFAULT\",\"key\":\"EcsCostIdleCheck_costSavings\"},{\"type\":\"DEFAULT\",\"key\":\"First_time\"},{\"type\":\"DEFAULT\",\"key\":\"Duration_time\"}]

OperateColumn

string

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

[{\"type\":\"template\",\"value\":\"cloudmonitor.console.aliyun.com/index.htm?custom_trace=ecs_console#/hostDetail/chart/instanceId=${Resource.resourceId}&system=Linux&region=${Resource.regionId}&aliyunhost=true\",\"key\":\"Detail\"},{\"type\":\"template\",\"value\":\"/diagnosis?product=${Product}&resourceId=${Resource.resourceId}\",\"key\":\"Refresh\"}]

InspectionScope

string

巡检范围

false

Product

string

云产品 Code

ECS

Description

string

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

Advisor 将检查账号下所有ECS实例,规格为r5或g5规格的ECS,建议升级为r6或g6

Source

string

巡检项来源。

  • Advisor: 智能顾问自建巡检项

  • Governance: 云治理中心

  • Config: 配置审计

Advisor

RiskLevel

integer

风险等级

  • 1:预警

  • 2:严重

1

Success

boolean

请求是否成功。

True

Message

string

消息详情

OK

示例

正常返回示例

JSON格式

{
  "RequestId": "566331F9-5AB3-550F-B745-A730331F97A9",
  "Code": "200",
  "Data": [
    {
      "PageNo": 1,
      "PageSize": 10,
      "Total": 100,
      "Result": [
        {
          "Name": "ECS低利用率检查",
          "Code": "EcsCostLowUtilizationCheck",
          "Tips": "ECS低利用率建议结合实际业务考虑对实例进行降配操作,参考文档。",
          "Category": "21",
          "SubCategory": [
            0
          ],
          "Status": "enabled",
          "ConfigSupport": "false",
          "ViewColumn": "[{\\\"type\\\":\\\"DEFAULT\\\",\\\"key\\\":\\\"EcsCostIdleCheck_resourceId\\\"},{\\\"type\\\":\\\"DEFAULT\\\",\\\"key\\\":\\\"EcsCostIdleCheck_resourceName\\\"},{\\\"type\\\":\\\"DEFAULT\\\",\\\"key\\\":\\\"EcsCostIdleCheck_regionId\\\"},{\\\"type\\\":\\\"DEFAULT\\\",\\\"key\\\":\\\"EcsCostIdleCheck_instanceChargeType\\\"},{\\\"type\\\":\\\"DEFAULT\\\",\\\"key\\\":\\\"EcsCostIdleCheck_instanceType\\\"},{\\\"type\\\":\\\"DEFAULT\\\",\\\"key\\\":\\\"EcsCostIdleCheck_severity\\\"},{\\\"type\\\":\\\"DEFAULT\\\",\\\"key\\\":\\\"EcsCostIdleCheck_costBefore\\\"},{\\\"type\\\":\\\"DEFAULT\\\",\\\"key\\\":\\\"EcsCostIdleCheck_costAfter\\\"},{\\\"type\\\":\\\"DEFAULT\\\",\\\"key\\\":\\\"EcsCostIdleCheck_costSavings\\\"},{\\\"type\\\":\\\"DEFAULT\\\",\\\"key\\\":\\\"First_time\\\"},{\\\"type\\\":\\\"DEFAULT\\\",\\\"key\\\":\\\"Duration_time\\\"}]",
          "OperateColumn": "[{\\\"type\\\":\\\"template\\\",\\\"value\\\":\\\"cloudmonitor.console.aliyun.com/index.htm?custom_trace=ecs_console#/hostDetail/chart/instanceId=${Resource.resourceId}&system=Linux&region=${Resource.regionId}&aliyunhost=true\\\",\\\"key\\\":\\\"Detail\\\"},{\\\"type\\\":\\\"template\\\",\\\"value\\\":\\\"/diagnosis?product=${Product}&resourceId=${Resource.resourceId}\\\",\\\"key\\\":\\\"Refresh\\\"}]\n",
          "InspectionScope": "false",
          "Product": "ECS",
          "Description": "Advisor 将检查账号下所有ECS实例,规格为r5或g5规格的ECS,建议升级为r6或g6",
          "Source": "Advisor",
          "RiskLevel": 1
        }
      ]
    }
  ],
  "Success": true,
  "Message": "OK"
}

错误码

HTTP status code

错误码

错误信息

描述

500 InternalError The request processing has failed due to some unknown error. 服务端错误。
403 Rd.NoManagePermission The RD management account does not have the specified member account management permission. RD管理账号没有指定成员账号管理权限
403 Rd.NoMasterRole Login account is not RD management or co-management role. 登录账号不是RD管理或协管角色
403 Forbidden.NotActivated User has not activated Advisor Service. 用户未开通Advisor产品。
403 Forbidden.NotAuthorized User has not authorized Advisor to provide services.
403 Forbidden.RAM User not authorized to operate on the specified resource, or this API doesn't support RAM. 未通过鉴权

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

变更历史

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