可根据多个维度获取用户最新的巡检结果,全量返回。
接口说明
不兼容 Go SDK,如需要 Go SDK 请使用 DescribeAdvicesFlatPage API。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
|
操作 |
访问级别 |
资源类型 |
条件关键字 |
关联操作 |
|
advisor:DescribeAdvices |
none |
*全部资源
|
无 | 无 |
请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| AdviceId |
integer |
否 |
巡检结果 ID。 |
40200899 |
| CheckId |
string |
否 |
巡检项 Code。 |
EcsHighCpuUtilization |
| ResourceId |
string |
否 |
资源/实例 ID。 |
i-2zecnwitr2s7aca6**** |
| Language |
string |
否 |
请求使用的语言。 |
zh |
| ExcludeAdviceId |
integer |
否 |
不包含的巡检结果 ID。 |
40200889 |
| Product |
string |
否 |
云产品 Code。 |
ecs |
| CheckPlanId |
integer |
否 |
巡检方案 ID(不填则默认为系统方案) |
111 |
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
|||
| RequestId |
string |
请求 ID。 |
566331F9-5AB3-550F-B745-A730331F97A9 |
| Data |
object |
||
| Advice |
array<object> |
查询结果。 |
|
|
object |
查询结果对象体。 |
||
| Severity |
integer |
严重级别:
|
1 |
| Product |
string |
云产品 Code。 |
ecs |
| GmtModified |
string |
巡检项结果更新时间,格式为 yyyy-mm-dd hh:mm:ss。 |
2023-07-01 00:00:00 |
| IsExpired |
boolean |
是否已过期:
|
false |
| GmtCreated |
string |
巡检项结果创建时间,格式为 yyyy-mm-dd hh:mm:ss。 |
2023-07-01 00:00:00 |
| Resource |
string |
资源详情 Json,具体请参考各个云产品实例详情查询相关 api 文档。 |
{"resourceId": "i-2zecnwitr2s7aca6****","resourceName": "ecs-20230701","regionId": "cn-hangzhou",...} |
| Description |
string |
巡检项描述,推荐操作和操作说明。 |
CPU负载,公网带宽负载,内存负载百分比算法超过标准值过高 |
| CheckId |
string |
巡检项 Code。 |
EcsHighCpuUtilization |
| AliyunId |
integer |
阿里云用户 ID。 |
192895059480**** |
| ResourceId |
string |
资源/实例 ID。 |
i-2zecnwitr2s7aca6**** |
| Content |
string |
结果 Json 详情,与控制台配置的展示列格式保持一致。 |
[{"key":"EcsHighCpuUtilization_xxxx", "value":"xxx"}, {"key":"EcsHighCpuUtilization_xxxx", "value":"xxx"}, {"key":"EcsHighCpuUtilization_xxxx", "value":"xxx"}] |
| Id |
integer |
巡检结果 ID。 |
40200899 |
| CheckName |
string |
巡检项名称。 |
ECS 性能负载巡检 |
| CheckPlanId |
integer |
巡检方案 ID |
111 |
示例
正常返回示例
JSON格式
{
"RequestId": "566331F9-5AB3-550F-B745-A730331F97A9",
"Data": {
"Advice": [
{
"Severity": 1,
"Product": "ecs",
"GmtModified": "2023-07-01 00:00:00",
"IsExpired": false,
"GmtCreated": "2023-07-01 00:00:00",
"Resource": "{\"resourceId\": \"i-2zecnwitr2s7aca6****\",\"resourceName\": \"ecs-20230701\",\"regionId\": \"cn-hangzhou\",...}",
"Description": "CPU负载,公网带宽负载,内存负载百分比算法超过标准值过高",
"CheckId": "EcsHighCpuUtilization",
"AliyunId": 0,
"ResourceId": "i-2zecnwitr2s7aca6****",
"Content": "[{\"key\":\"EcsHighCpuUtilization_xxxx\", \"value\":\"xxx\"}, {\"key\":\"EcsHighCpuUtilization_xxxx\", \"value\":\"xxx\"}, {\"key\":\"EcsHighCpuUtilization_xxxx\", \"value\":\"xxx\"}]",
"Id": 40200899,
"CheckName": "ECS 性能负载巡检\n",
"CheckPlanId": 111
}
]
}
}
错误码
|
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 | Rd.NoMasterRole | Login account is not RD management or co-management role. | 登录账号不是RD管理或协管角色 |
| 403 | Rd.NoManagePermission | The RD management account does not have the specified member account management permission. | RD管理账号没有指定成员账号管理权限 |
| 403 | Forbidden.NotActivated | User has not activated Advisor Service. | 用户未开通Advisor产品。 |
访问错误中心查看更多错误码。
变更历史
更多信息,参考变更详情。