如何调用API获取当前可用的巡检项_智能顾问(Intelligent Advisor)-阿里云帮助中心

调试

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

请求参数

名称	类型	是否必选	示例值	描述
Action	String	是	DescribeAdvisorChecks	系统规定参数。取值：DescribeAdvisorChecks。
Language	String	否	zh	使用的语言。
Product	String	否	ecs	云产品Code。

返回数据

名称	类型	示例值	描述
Code	String	200	错误编码。
RequestId	String	566331F9-5AB3-550F-B745-A730331F97A9	请求ID。
Data	Array of AdvisorCheck		查询结果。
AdvisorCheck
Status	String	enabled	诊断项是否被禁用状态： enabled: 可用 disabled: 禁用
Product	String	ecs	云产品Code。
OperateColumn	String	[{"key": "Detail", "value": "/diagnosis?product=${Product}&resourceId=${Resource.resourceId}", "type": "template"} ]	操作字段，使用前端模板或诊断建议action中定义json字段。
GmtModified	String	2023-07-01 00:00:00	巡检项配置更新时间，格式为yyyy-mm-dd hh:mm:ss。
ViewColumn	String	[{"key":"EcsHighCpuUtilization_xxxx", "type":"DEFAULT"}, {"key":"EcsHighCpuUtilization_xxxx", "type":"DEFAULT"}, {"key":"EcsHighCpuUtilization_xxxx", "type":"DEFAULT"}, ]	展示列，即控制台展示巡检项详情的具体配置。
GmtCreated	String	2023-07-01 00:00:00	巡检项配置创建时间，格式为yyyy-mm-dd hh:mm:ss。
Description	String	CPU负载，公网带宽负载，内存负载百分比算法超过标准值过高	巡检项描述，推荐操作和操作说明。
Tips	String	请排查实例资源占用情况或升级实例规格	巡检建议一句话简述。
Code	String	EcsHighCpuUtilization	巡检项Code。
Category	String	1	巡检项分类： 1: 安全合规 2: 性能效率 3: 业务稳定 4: 成本优化 5: 服务限制
Name	String	ECS 性能负载巡检	巡检项名称。

示例

请求示例

http(s)://advisor.cn-hangzhou.aliyuncs.com/?Action=DescribeAdvisorChecks
&Language=zh
&Product=ecs
&公共请求参数

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

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

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

{
  "Code" : "200",
  "RequestId" : "566331F9-5AB3-550F-B745-A730331F97A9",
  "Data" : [ {
    "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 性能负载巡检"
  } ]
}

错误码

HttpCode	错误码	错误信息	描述
403	Forbidden.RAM	User not authorized to operate on the specified resource, or this API doesn't support RAM.	未通过鉴权
500	InternalError	The request processing has failed due to some unknown error.	服务端错误。

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