文档

GetCheckConfig - 云平台配置检查获取检查配置项

更新时间:

获取云平台配置检查配置项。

调试

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

授权信息

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

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
yundun-sas:GetCheckConfigRead
  • 全部资源
    *

请求参数

名称类型必填描述示例值
当前API无需请求参数

返回参数

名称类型描述示例值
object

GetCheckConfigResponse

CycleDaysarray

周期检测时间。

integer

周期执行时间点,取值表示每周周几。

[1, 2, 3, 4, 5]
StartTimeinteger

检查时间段开始时间,表示每天几点。

0
EndTimeinteger

检查时间段结束时间,表示每天几点。 查询的开始时间和结束只能在以下时间区间中选择。

  • 0~6当开始时间为 0 时,结束时间需要设置为当日 6 时。
  • 6~12 当开始时间为 6 时,结束时间需要设置为当日 12 时。
  • 12~18 当开始时间为 12 时,结束时间需要设置为当日 18 时。
  • 18~24当开始时间为 18 时,结束时间需要设置为当日 24 时。
6
Standardsobject []

检测项信息列表。

Idlong

检测项编号。

1
ShowNamestring

检测项名称。

云产品配置管理
Typestring

检测项类型。可取值:

  • RISK: 云产品配置管理
  • IDENTITY_PERMISSION: 身份权限管理
  • COMPLIANCE: 合规
RISK
Statusstring

检测项开启状态。可取值:

  • ON: 开启
  • OFF: 关闭
ON
RequestIdstring

本次调用请求的 ID,是由阿里云为该请求生成的唯一标识符,可用于排查和定位问题。

5A3D5C8F-2A42-5477-BDD8-27E64B5F1739
EnableAutoCheckboolean

是否开启自动周期检测。可取值:

  • true: 开启
  • false: 关闭
true
EnableAddCheckboolean

当所选条例中有新增检查项时,是否默认检查。可取值:

  • true: 开启
  • false: 关闭
false
SelectedChecksobject []

策略中选择的检查项。

CheckIdlong

检查项 ID。

3
SectionIdlong

检查项的章节 ID。

69

示例

正常返回示例

JSON格式

{
  "CycleDays": [
    0
  ],
  "StartTime": 0,
  "EndTime": 6,
  "Standards": [
    {
      "Id": 1,
      "ShowName": "云产品配置管理",
      "Type": "RISK",
      "Status": "ON"
    }
  ],
  "RequestId": "5A3D5C8F-2A42-5477-BDD8-27E64B5F1739",
  "EnableAutoCheck": true,
  "EnableAddCheck": false,
  "SelectedChecks": [
    {
      "CheckId": 3,
      "SectionId": 69
    }
  ]
}

错误码

HTTP status code错误码错误信息描述
400IllegalParamIllegal param无效参数
403NoPermissioncaller has no permission当前操作未被授权,请联系主账号在RAM控制台进行授权后再执行操作。
500ServerErrorServerError服务故障,请稍后重试!

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

变更历史

变更时间变更内容概要操作
2023-07-17OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:400
出参OpenAPI 返回结构发生变更
2023-01-11OpenAPI 描述信息更新、OpenAPI 错误码发生变更、OpenAPI 入参发生变更看变更集
变更项变更内容
API 描述OpenAPI 描述信息更新
错误码OpenAPI 错误码发生变更
    删除错误码:400
入参OpenAPI 入参发生变更
    新增入参:CheckGroupId
    删除入参:Lang
  • 本页导读 (1)
文档反馈