调用DescribeInstanceSecurityConfigs集群安全配置检测_云数据库 OceanBase 版(OceanBase)-阿里云帮助中心

集群安全配置检测。

调试

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

授权信息

当前API暂无授权信息透出。

请求参数

名称	类型	必填	描述	示例值
InstanceId	string	是	OceanBase 集群 ID。	ob317v4uif****
CheckId	string	否	检测的唯一标识	xxx

返回参数

名称	类型	描述	示例值
	object	请求的返回结果。
RequestId	string	请求 ID。	EE205C00-30E4-**-**-87E3A8A2AA0C
InstanceSecurityConfigs	object	请求的返回结果。
TotalCheckCount	integer	集群安全项检测总数。	5
TotalRiskCount	integer	集群安全项风险总数。	0
SecurityConfigs	array<object>	检测项目列表。
	object	请求的返回结果。
ConfigName	string	具体检测项名称。	xxx
Risk	boolean	是否存在风险。	true
RiskDescription	string	安全建议。	xxx
ConfigGroup	string	检测分组。	WHITELIST
ConfigDescription	string	检测项名称。	校验集群白名单范围是否过大
CheckTime	string	检查时间。	2023-08-07 15:30:00
InstanceId	string	Oceanbase 集群 ID。	ob317v4uif****
CheckId	string	检测的唯一标识。	xxx

示例

正常返回示例

JSON格式

{
  "RequestId": "EE205C00-30E4-****-****-87E3A8A2AA0C",
  "InstanceSecurityConfigs": {
    "TotalCheckCount": 5,
    "TotalRiskCount": 0,
    "SecurityConfigs": [
      {
        "ConfigName": "xxx",
        "Risk": true,
        "RiskDescription": "xxx",
        "ConfigGroup": "WHITELIST",
        "ConfigDescription": "校验集群白名单范围是否过大"
      }
    ],
    "CheckTime": "2023-08-07 15:30:00",
    "InstanceId": "ob317v4uif****",
    "CheckId": "xxx"
  }
}

错误码

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

变更历史

变更时间	变更内容概要	操作
2023-10-30	OpenAPI 入参发生变更、OpenAPI 返回结构发生变更	查看变更详情