DescribeInstanceSecurityConfigs - ApsaraDB for OceanBase

You can call this operation to query security check items of an OceanBase cluster.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Debug

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

Parameter	Type	Required	Description	Example
InstanceId	string	Yes	The ID of the OceanBase cluster.	ob317v4uif****
CheckId	string	No	The unique identifier of the check.	xxx

Response parameters

Parameter	Type	Description	Example
	object	The return result of the request.
RequestId	string	The ID of the request.	EE205C00-30E4-**-**-87E3A8A2AA0C
InstanceSecurityConfigs	object	The return result of the request.
TotalCheckCount	integer	The total number of security check items for the cluster.	5
TotalRiskCount	integer	The total number of detected cluster security risks.	0
SecurityConfigs	object []	The list of check items.
ConfigName	string	The name of the specific check item.	xxx
Risk	boolean	Specifies whether a risk is detected.	true
RiskDescription	string	Security recommendations.	xxx
ConfigGroup	string	The group of the check.	WHITELIST
ConfigDescription	string	The name of the check item.	Check whether the scope of the cluster allowlist is too big
CheckTime	string	The time when the check was performed.	2023-08-07 15:30:00
InstanceId	string	The ID of the OceanBase cluster.	ob317v4uif****
CheckId	string	The unique identifier of the check.	xxx

Examples

Sample success responses

JSONformat

{
  "RequestId": "EE205C00-30E4-****-****-87E3A8A2AA0C",
  "InstanceSecurityConfigs": {
    "TotalCheckCount": 5,
    "TotalRiskCount": 0,
    "SecurityConfigs": [
      {
        "ConfigName": "xxx",
        "Risk": true,
        "RiskDescription": "xxx",
        "ConfigGroup": "WHITELIST",
        "ConfigDescription": "Check whether the scope of the cluster allowlist is too big"
      }
    ],
    "CheckTime": "2023-08-07 15:30:00",
    "InstanceId": "ob317v4uif****",
    "CheckId": "xxx"
  }
}

Error codes

For a list of error codes, visit the Service error codes.

Change history

Change time

Summary of changes

Operation

2023-10-30

The request parameters of the API has changed. The response structure of the API has changed

see changesets

Change item	Change content
Input Parameters	The request parameters of the API has changed.
	Added Input Parameters: CheckId
Output Parameters	The response structure of the API has changed.