查询执行了基线检查的服务器的信息,包含服务器的ID、检测到的风险项统计数据和风险项状态等信息。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用背景高亮的方式表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
yundun-sas:DescribeWarningMachines | get | *全部资源 * |
| 无 |
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
SourceIp | string | 否 | 访问源的 IP 地址。 | 1.2.XX.XX |
Lang | string | 否 | 设置请求和接收消息的语言类型,默认为 zh。取值:
| zh |
MachineName | string | 否 | 执行基线检查的服务器的名称。 | oracle-win-001**** |
Uuids | string | 否 | 执行基线检查的服务器 ID。多个 ID 之间使用半角逗号(,)分隔。 | 9888955c-0076-49da-bd9c-34f5492b**** |
RiskId | long | 是 | 风险项的 ID。 说明
您可调用 DescribeCheckWarningSummary 接口获取风险项 ID。
| 196 |
StrategyId | long | 否 | 基线检查策略的 ID。 | 16 |
PageSize | integer | 否 | 设置分页查询时,每页显示的服务器信息的数量。默认值为 10,表示每页显示 10 条服务器信息,最大不超过 100。 | 10 |
CurrentPage | integer | 否 | 设置从返回结果的第几页开始显示查询结果。默认值为 1,表示从第 1 页开始显示。 | 1 |
ClusterId | string | 否 | 指定要查询的容器集群的 ID。 说明
您可以调用 DescribeGroupedContainerInstances 接口获取该参数。
| c7e3c5b420a7947c2933303144688**** |
ContainerFieldName | string | 否 | 容器检索字段。取值:
| containerId |
ContainerFieldValue | string | 否 | 查询容器检索的值。 | c8bb3ef0f5ccf45508f0fd1ffc200**** |
TargetType | string | 否 | 查询类型。取值:
| uuid |
HaveRisk | integer | 否 | 是否存在风险。取值:
| 1 |
GroupId | long | 否 | 要查询的资产分组 ID。 说明
您可以调用 DescribeAllGroups 接口获取该参数。
| 123 |
返回参数
示例
正常返回示例
JSON
格式
{
"CurrentPage": 1,
"PageSize": 10,
"RequestId": "6E4CBE87-E887-5AF1-86D2-78EB4AA3E771",
"TotalCount": 1,
"Count": 10,
"WarningMachines": [
{
"Status": 1,
"InternetIp": "1.2.XX.XX",
"InstanceId": "i-m5ee8b9nr3h30mhb****",
"HighWarningCount": 10,
"IntranetIp": "1.2.XX.XX",
"RegionId": "cn-qingdao",
"LowWarningCount": 3,
"PortOpen": true,
"Uuid": "9888955c-0076-49da-bd9c-34f5492b****",
"MediumWarningCount": 2,
"PassCount": 10,
"InstanceName": "oracle-win-00****",
"Bind": true,
"AuthVersion": 7,
"ContainerId": "48a6d9a92435a13ad573372c3f3c63b7e04d106458141df9f92155709d******",
"ContainerName": "redis"
}
]
}
错误码
HTTP status code | 错误码 | 错误信息 | 描述 |
---|---|---|---|
400 | ConsoleError | The error message is %s %s. | 错误信息为%s %s。 |
403 | NoPermission | caller has no permission | 当前操作未被授权,请联系主账号在RAM控制台进行授权后再执行操作。 |
500 | ServerError | ServerError | 服务故障,请稍后重试! |
访问错误中心查看更多错误码。
变更历史
变更时间 | 变更内容概要 | 操作 |
---|---|---|
2023-03-22 | OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更 | 查看变更详情 |