文档

DescribeTenantSecurityConfigs - 租户安全配置检测

更新时间:

租户安全配置检测。

调试

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

授权信息

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

请求参数

名称类型必填描述示例值
InstanceIdstring

OceanBase 集群 ID。

ob317v4uif****
TenantIdstring

租户 ID。

t4louaeei****
CheckIdstring

安全检测的唯一标识。

****

返回参数

名称类型描述示例值
object

请求的返回结果。

RequestIdstring

请求 ID。

523E7183-1490-590D-BA03-12DFD316614B
Configsobject

配置列表。

TotalCheckCountinteger

安全配置总体检测项目。

4
TotalRiskCountinteger

检测出来的总体风险项目。

0
TenantSecurityConfigsarray<object>

检测结果。

object

请求的返回结果。

TenantIdstring

租户 ID。

xxx
TenantNamestring

租户名称。

xxx
RiskCountinteger

租户的风险条目。

0
SecurityConfigsarray<object>

风险列表。

object

请求的返回结果。

ConfigGroupstring

风险分组。

WHITELIST
ConfigNamestring

风险项目名称。

WHITELIST_RANGE_LARGE
Riskboolean

是否有风险。

true
RiskDescriptionstring

风险描述。

白名单开放过大,建议按需设置
ConfigDescriptionstring

检测项名称。

校验集群白名单范围是否过大
CheckIdstring

检测的唯一标识。

 xxx
InstanceIdstring

OceanBase 集群 ID。

ob317v4uif****
CheckTimestring

检测时间。

2023-08-07 15:30:00

示例

正常返回示例

JSON格式

{
  "RequestId": "523E7183-1490-590D-BA03-12DFD316614B",
  "Configs": {
    "TotalCheckCount": 4,
    "TotalRiskCount": 0,
    "TenantSecurityConfigs": [
      {
        "TenantId": "xxx",
        "TenantName": "xxx",
        "RiskCount": 0,
        "SecurityConfigs": [
          {
            "ConfigGroup": "WHITELIST",
            "ConfigName": "WHITELIST_RANGE_LARGE",
            "Risk": true,
            "RiskDescription": "白名单开放过大,建议按需设置",
            "ConfigDescription": "校验集群白名单范围是否过大"
          }
        ]
      }
    ],
    "CheckId": " xxx",
    "InstanceId": "ob317v4uif****",
    "CheckTime": "2023-08-07 15:30:00"
  }
}

错误码

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

变更历史

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