機能説明
このAPIは、テナントのセキュリティ設定を検査し、各テナントのセキュリティ設定検査結果およびリスク項目を返します。
呼び出し説明
インターフェース制約
呼び出し元はマルチクラウドAPIにアクセスするためのキーを保有している必要があります。AccessKey IDとAccessKey Secretの取得方法については、アクセスキーの管理をご参照ください。
リクエストパス
GET /api/v2/instances/{instanceId}/security/tenantSecurityConfig
リクエストパラメータ
Path
名前 |
型 |
必須 |
説明 |
例値 |
|---|---|---|---|---|
| instanceId | String | はい | OceanBase CloudデータベースインスタンスID | ob317v4uif**** |
Query
名前 |
型 |
必須 |
説明 |
例値 |
|---|---|---|---|---|
| tenantId | String | いいえ | テナントID | t4louaeei**** |
| checkId | String | いいえ | セキュリティ検査の一意の識別子 | **** |
| requestId | String | はい | トレース用のリクエストID | dc302d76-66b5-48d8-ab53-a035******** |
戻り値
名前 |
型 |
説明 |
例値 |
|---|---|---|---|
| requestId | String | リクエストID | 523E7183-1490-590D-BA03-12DFD316614B |
| data | Object | 設定検査結果 | - |
| data.totalCheckCount | Integer | セキュリティ設定の総検査項目数 | 4 |
| data.totalRiskCount | Integer | 検出された総リスク項目数 | 0 |
| data.tenantSecurityConfigs | Array | 各テナントの検査結果リスト | - |
| data.tenantSecurityConfigs[].tenantId | String | テナントID | xxx |
| data.tenantSecurityConfigs[].tenantName | String | テナント名 | xxx |
| data.tenantSecurityConfigs[].riskCount | Integer | テナントのリスクエントリ数 | 0 |
| data.tenantSecurityConfigs[].securityConfigs | Array | テナントのリスク詳細リスト | - |
| data.tenantSecurityConfigs[].securityConfigs[].configGroup | String | リスクグループ | WHITELIST |
| data.tenantSecurityConfigs[].securityConfigs[].configName | String | リスク項目名 | WHITELIST_RANGE_LARGE |
| data.tenantSecurityConfigs[].securityConfigs[].risk | Boolean | リスクの有無 | true |
| data.tenantSecurityConfigs[].securityConfigs[].riskDescription | String | リスク説明 | ホワイトリストが広範囲に開放されています。必要に応じて設定を調整することを推奨します |
| data.tenantSecurityConfigs[].securityConfigs[].configDescription | String | チェック項目名 | クラスタのホワイトリスト範囲が広すぎないか検証します |
| data.checkId | String | チェックの一意の識別子 | xxx |
| data.instanceId | String | OceanBase CloudインスタンスID | ob317v4uif**** |
| data.checkTime | String | チェック時間 | 2023-08-07 15:30:00 |
| success | Boolean | 成功したかどうか | true |
例
リクエスト例
curl --digest -u '<Your AK:SK>' \
-X GET \
'https://api-cloud.oceanbase.com/api/v2/instances/{instanceId}/security/tenantSecurityConfig?requestId={requestId}'
レスポンス例
JSON形式
{
"data": {
"totalCheckCount": 4,
"totalRiskCount": 0,
"tenantSecurityConfigs": [
{
"tenantId": "xxx",
"tenantName": "xxx",
"riskCount": 0,
"securityConfigs": [
{
"configGroup": "WHITELIST",
"configName": "WHITELIST_RANGE_LARGE",
"risk": true,
"riskDescription": "ホワイトリストが広範囲に開放されています。必要に応じて設定を調整することを推奨します",
"configDescription": "クラスタのホワイトリスト範囲が広すぎないか検証します"
}
]
}
],
"checkId": "xxx",
"instanceId": "ob317v4uif****",
"checkTime": "2023-08-07 15:30:00"
},
"requestId": "523E7183-1490-590D-BA03-12DFD316614B",
"success": true
}