DescribeInstanceSecurityConfigs - ApsaraDB for OceanBase

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

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
oceanbase:DescribeInstanceSecurityConfigs	get	All Resources *	none	none

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	array<object>	The list of check items.
SecurityConfigs	object	The name of the specific check item.
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	View Change Details