機能説明
このAPIは、クラスタのセキュリティ設定を検査し、クラスタレベルのセキュリティ設定検査結果およびリスク項目を返します。
呼び出し説明
API制約
呼び出し元はマルチクラウドAPIにアクセスするためのキーを保有している必要があります。AccessKey IDとAccessKey Secretの取得方法については、アクセスキーの管理を参照してください。
リクエストパス
GET /api/v2/instances/{instanceId}/security/securityConfig
リクエストパラメータ
Path
名前 |
型 |
必須 |
説明 |
サンプル値 |
|---|---|---|---|---|
| instanceId | String | はい | OceanBaseクラウドデータベースインスタンスID | obcluster-***** |
Query
名前 |
型 |
必須 |
説明 |
サンプル値 |
|---|---|---|---|---|
| checkId | String | いいえ | 検査の一意の識別子 | xxx |
| requestId | String | はい | リクエストID。追跡に使用されます | dc302d76-66b5-48d8-ab53-a035******** |
戻り値
名前 |
型 |
説明 |
サンプル値 |
|---|---|---|---|
| requestId | String | リクエストID | EE205C00-30E4---87E3A8A2AA0C |
| data | Object | クラスタのセキュリティ設定検査結果 | - |
| data.totalCheckCount | Integer | クラスタのセキュリティ項目検査総数 | 5 |
| data.totalRiskCount | Integer | クラスタのセキュリティ項目リスク総数 | 0 |
| data.securityConfigs | Array | 検査項目リスト | - |
| data.securityConfigs[].configName | String | 具体的な検査項目名 | xxx |
| data.securityConfigs[].risk | Boolean | リスクが存在するかどうか | true |
| data.securityConfigs[].riskDescription | String | セキュリティ推奨事項 | xxx |
| data.securityConfigs[].configGroup | String | チェックグループ | WHITELIST |
| data.securityConfigs[].configDescription | String | チェック項目名 | クラスタのホワイトリスト範囲が広すぎないか検証 |
| data.checkTime | String | チェック時間 | 2023-08-07 15:30:00 |
| data.instanceId | String | OceanBase CloudインスタンスID | ob317v4uif**** |
| data.checkId | String | チェックの一意の識別子 | xxx |
| success | Boolean | 成功したかどうか | true |
例
リクエスト例
curl --digest -u '<Your AccessKey ID:AccessKey Secret>' \
-X GET \
'https://api-cloud.oceanbase.com/api/v2/instances/{instanceId}/security/securityConfig?requestId={requestId}'
レスポンス例
JSON形式
{
"data": {
"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"
},
"requestId": "EE205C00-30E4-****-****-87E3A8A2AA0C",
"success": true
}