DescribeInstanceSecurityConfigs - ApsaraDB for OceanBase (Deprecated) - Alibaba Cloud ドキュメントセンター

このオペレーションを呼び出して、ApsaraDB for OceanBase クラスターのセキュリティチェック項目を照会できます。

今すぐお試しください

この API を OpenAPI Explorer でお試しください。手作業による署名は必要ありません。呼び出しに成功すると、入力したパラメーターに基づき、資格情報が組み込まれた SDK コードが自動的に生成されます。このコードをダウンロードしてローカルで使用できます。

テスト

RAM 認証

下表に、この API を呼び出すために必要な認証情報を示します。認証情報は、RAM (Resource Access Management) ポリシーを使用して定義できます。以下で各列名について説明します。

アクション：特定のリソースに対して実行可能な操作。ポリシー構文ではAction要素として指定します。
API：アクションを具体的に実行するための API。
アクセスレベル：各 API に対して事前定義されているアクセスの種類。有効な値：create、list、get、update、delete。
リソースタイプ：アクションが作用するリソースの種類。リソースレベルでの権限をサポートするかどうかを示すことができます。ポリシーの有効性を確保するため、アクションの対象として適切なリソースを指定してください。
- リソースレベルの権限を持つ API の場合、必要なリソースタイプはアスタリスク (*) でマークされます。ポリシーのResource要素で対応する ARN を指定してください。
- リソースレベルの権限を持たない API の場合、「すべてのリソース」と表示され、ポリシーのResource要素でアスタリスク (*) でマークされます。
条件キー：サービスによって定義された条件のキー。このキーにより、きめ細やかなアクセス制御が可能になります。この制御は、アクション単体に適用することも、特定のリソースに対するアクションに適用することもできます。Alibaba Cloud は、サービス固有の条件キーに加えて、すべての RAM 統合サービスに適用可能な一連の共通条件キーを提供しています。
依存アクション：ある特定のアクションを実行するために、前提として実行が必要となる他のアクション。依存アクションの権限も RAM ユーザーまたは RAM ロールに付与する必要があります。

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

oceanbase:DescribeInstanceSecurityConfigs

get

*All Resource

*

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
InstanceId	string	必須	ApsaraDB for 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	ApsaraDB for OceanBase クラスターの ID です。	ob317v4uif****
CheckId	string	チェックの一意の識別子です。	xxx

例

成功レスポンス

JSONJSON

{
  "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"
  }
}

エラーコード

完全なリストについては、「エラーコード」をご参照ください。

変更履歴

完全なリストについては、「変更履歴」をご参照ください。