DescribeInstanceSecurityConfigs - 叢集安全配置檢測 - ApsaraDB for OceanBase (Deprecated)

叢集安全配置檢測。

調試

您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。

調試

授權資訊

下表是API對應的授權資訊，可以在RAM權限原則語句的Action元素中使用，用來給RAM使用者或RAM角色授予調用此API的許可權。具體說明如下：

操作：是指具體的許可權點。
存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。
資源類型：是指操作中支援授權的資源類型。具體說明如下：
- 對於必選的資源類型，用前面加 * 表示。
- 對於不支援資源級授權的操作，用全部資源表示。
條件關鍵字：是指雲產品自身定義的條件關鍵字。
關聯操作：是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權，操作才能成功。

操作

存取層級

資源類型

條件關鍵字

關聯操作

oceanbase:DescribeInstanceSecurityConfigs

get

*全部資源

*

無

請求參數

名稱	類型	必填	描述	樣本值
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"
  }
}

錯誤碼

訪問錯誤中心查看更多錯誤碼。

變更歷史

更多資訊，參考變更詳情。