第 17 章 合规结果统计信息服务
17.1. 合规结果统计信息服务 复制链接链接已复制到粘贴板!
17.1.1. GetComplianceClusterScanStats 复制链接链接已复制到粘贴板!
GET /v2/compliance/stats/configurations/clusters/{clusterId}
GetComplianceClusterScanStats 列出了每个扫描配置的集群的当前扫描统计
17.1.1.1. 描述 复制链接链接已复制到粘贴板!
17.1.1.2. 参数 复制链接链接已复制到粘贴板!
17.1.1.2.1. 路径参数 复制链接链接已复制到粘贴板!
| Name | 描述 | 必填 | default | pattern |
|---|---|---|---|---|
| clusterId | X | null |
17.1.1.2.2. 查询参数 复制链接链接已复制到粘贴板!
| Name | 描述 | 必填 | default | pattern |
|---|---|---|---|---|
| query.query | - | null | ||
| query.pagination.limit | - | null | ||
| query.pagination.offset | - | null | ||
| query.pagination.sortOption.field | - | null | ||
| query.pagination.sortOption.reversed | - | null | ||
| query.pagination.sortOption.aggregateBy.aggrFunc | - | UNSET | ||
| query.pagination.sortOption.aggregateBy.distinct | - | null |
17.1.1.3. 返回类型 复制链接链接已复制到粘贴板!
17.1.1.4. 内容类型 复制链接链接已复制到粘贴板!
- application/json
17.1.1.5. 响应 复制链接链接已复制到粘贴板!
| 代码 | 消息 | datatype |
|---|---|---|
| 200 | 成功响应。 | |
| 0 | 意外错误响应。 |
17.1.1.6. Samples 复制链接链接已复制到粘贴板!
17.1.2. GetComplianceClusterStats 复制链接链接已复制到粘贴板!
GET /v2/compliance/scan/stats/profiles/{profileName}/clusters
17.1.2.1. 描述 复制链接链接已复制到粘贴板!
17.1.2.2. 参数 复制链接链接已复制到粘贴板!
17.1.2.2.1. 路径参数 复制链接链接已复制到粘贴板!
| Name | 描述 | 必填 | default | pattern |
|---|---|---|---|---|
| profileName | X | null |
17.1.2.2.2. 查询参数 复制链接链接已复制到粘贴板!
| Name | 描述 | 必填 | default | pattern |
|---|---|---|---|---|
| query.query | - | null | ||
| query.pagination.limit | - | null | ||
| query.pagination.offset | - | null | ||
| query.pagination.sortOption.field | - | null | ||
| query.pagination.sortOption.reversed | - | null | ||
| query.pagination.sortOption.aggregateBy.aggrFunc | - | UNSET | ||
| query.pagination.sortOption.aggregateBy.distinct | - | null |
17.1.2.3. 返回类型 复制链接链接已复制到粘贴板!
17.1.2.4. 内容类型 复制链接链接已复制到粘贴板!
- application/json
17.1.2.5. 响应 复制链接链接已复制到粘贴板!
| 代码 | 消息 | datatype |
|---|---|---|
| 200 | 成功响应。 | |
| 0 | 意外错误响应。 |
17.1.2.6. Samples 复制链接链接已复制到粘贴板!
17.1.3. GetComplianceOverallClusterStats 复制链接链接已复制到粘贴板!
GET /v2/compliance/scan/stats/overall/cluster
已弃用,使用 GetComplianceClusterStats
17.1.3.1. 描述 复制链接链接已复制到粘贴板!
17.1.3.2. 参数 复制链接链接已复制到粘贴板!
17.1.3.2.1. 查询参数 复制链接链接已复制到粘贴板!
| Name | 描述 | 必填 | default | pattern |
|---|---|---|---|---|
| query | - | null | ||
| pagination.limit | - | null | ||
| pagination.offset | - | null | ||
| pagination.sortOption.field | - | null | ||
| pagination.sortOption.reversed | - | null | ||
| pagination.sortOption.aggregateBy.aggrFunc | - | UNSET | ||
| pagination.sortOption.aggregateBy.distinct | - | null |
17.1.3.3. 返回类型 复制链接链接已复制到粘贴板!
17.1.3.4. 内容类型 复制链接链接已复制到粘贴板!
- application/json
17.1.3.5. 响应 复制链接链接已复制到粘贴板!
| 代码 | 消息 | datatype |
|---|---|---|
| 200 | 成功响应。 | |
| 0 | 意外错误响应。 |
17.1.3.6. Samples 复制链接链接已复制到粘贴板!
17.1.4. GetComplianceProfileCheckStats 复制链接链接已复制到粘贴板!
GET /v2/compliance/scan/stats/profiles/{profileName}/checks/{checkName}
GetComplianceProfileCheckStats 列出特定集群检查的当前统计信息
17.1.4.1. 描述 复制链接链接已复制到粘贴板!
17.1.4.2. 参数 复制链接链接已复制到粘贴板!
17.1.4.2.1. 路径参数 复制链接链接已复制到粘贴板!
| Name | 描述 | 必填 | default | pattern |
|---|---|---|---|---|
| profileName | X | null | ||
| checkName | X | null |
17.1.4.2.2. 查询参数 复制链接链接已复制到粘贴板!
| Name | 描述 | 必填 | default | pattern |
|---|---|---|---|---|
| query.query | - | null | ||
| query.pagination.limit | - | null | ||
| query.pagination.offset | - | null | ||
| query.pagination.sortOption.field | - | null | ||
| query.pagination.sortOption.reversed | - | null | ||
| query.pagination.sortOption.aggregateBy.aggrFunc | - | UNSET | ||
| query.pagination.sortOption.aggregateBy.distinct | - | null |
17.1.4.3. 返回类型 复制链接链接已复制到粘贴板!
17.1.4.4. 内容类型 复制链接链接已复制到粘贴板!
- application/json
17.1.4.5. 响应 复制链接链接已复制到粘贴板!
| 代码 | 消息 | datatype |
|---|---|---|
| 200 | 成功响应。 | |
| 0 | 意外错误响应。 |
17.1.4.6. Samples 复制链接链接已复制到粘贴板!
17.1.5. GetComplianceProfileStats 复制链接链接已复制到粘贴板!
GET /v2/compliance/scan/stats/profiles/{profileName}
GetComplianceProfileStats 列出了按配置集 Optional RawQuery 查询字段分组的当前扫描统计信息。常用的工具包括但不仅限于 - 扫描:合规性扫描的 id: cluster: id (s)- profile: id (s)
17.1.5.1. 描述 复制链接链接已复制到粘贴板!
17.1.5.2. 参数 复制链接链接已复制到粘贴板!
17.1.5.2.1. 路径参数 复制链接链接已复制到粘贴板!
| Name | 描述 | 必填 | default | pattern |
|---|---|---|---|---|
| profileName | X | null |
17.1.5.2.2. 查询参数 复制链接链接已复制到粘贴板!
| Name | 描述 | 必填 | default | pattern |
|---|---|---|---|---|
| query.query | - | null | ||
| query.pagination.limit | - | null | ||
| query.pagination.offset | - | null | ||
| query.pagination.sortOption.field | - | null | ||
| query.pagination.sortOption.reversed | - | null | ||
| query.pagination.sortOption.aggregateBy.aggrFunc | - | UNSET | ||
| query.pagination.sortOption.aggregateBy.distinct | - | null |
17.1.5.3. 返回类型 复制链接链接已复制到粘贴板!
17.1.5.4. 内容类型 复制链接链接已复制到粘贴板!
- application/json
17.1.5.5. 响应 复制链接链接已复制到粘贴板!
| 代码 | 消息 | datatype |
|---|---|---|
| 200 | 成功响应。 | |
| 0 | 意外错误响应。 |
17.1.5.6. Samples 复制链接链接已复制到粘贴板!
17.1.6. GetComplianceProfilesClusterStats 复制链接链接已复制到粘贴板!
GET /v2/compliance/scan/stats/profiles/clusters/{clusterId}
GetComplianceProfilesClusterStats 列出按配置集分组的集群统计
17.1.6.1. 描述 复制链接链接已复制到粘贴板!
17.1.6.2. 参数 复制链接链接已复制到粘贴板!
17.1.6.2.1. 路径参数 复制链接链接已复制到粘贴板!
| Name | 描述 | 必填 | default | pattern |
|---|---|---|---|---|
| clusterId | X | null |
17.1.6.2.2. 查询参数 复制链接链接已复制到粘贴板!
| Name | 描述 | 必填 | default | pattern |
|---|---|---|---|---|
| query.query | - | null | ||
| query.pagination.limit | - | null | ||
| query.pagination.offset | - | null | ||
| query.pagination.sortOption.field | - | null | ||
| query.pagination.sortOption.reversed | - | null | ||
| query.pagination.sortOption.aggregateBy.aggrFunc | - | UNSET | ||
| query.pagination.sortOption.aggregateBy.distinct | - | null |
17.1.6.3. 返回类型 复制链接链接已复制到粘贴板!
17.1.6.4. 内容类型 复制链接链接已复制到粘贴板!
- application/json
17.1.6.5. 响应 复制链接链接已复制到粘贴板!
| 代码 | 消息 | datatype |
|---|---|---|
| 200 | 成功响应。 | |
| 0 | 意外错误响应。 |
17.1.6.6. Samples 复制链接链接已复制到粘贴板!
17.1.7. GetComplianceProfilesStats 复制链接链接已复制到粘贴板!
GET /v2/compliance/scan/stats/profiles
GetComplianceProfileScanStats 列出按配置集(可选 RawQuery 查询字段)分组的当前扫描统计。常用的工具包括但不仅限于 - 扫描:合规性扫描的 id: cluster: id (s)- profile: id (s)
17.1.7.1. 描述 复制链接链接已复制到粘贴板!
17.1.7.2. 参数 复制链接链接已复制到粘贴板!
17.1.7.2.1. 查询参数 复制链接链接已复制到粘贴板!
| Name | 描述 | 必填 | default | pattern |
|---|---|---|---|---|
| query | - | null | ||
| pagination.limit | - | null | ||
| pagination.offset | - | null | ||
| pagination.sortOption.field | - | null | ||
| pagination.sortOption.reversed | - | null | ||
| pagination.sortOption.aggregateBy.aggrFunc | - | UNSET | ||
| pagination.sortOption.aggregateBy.distinct | - | null |
17.1.7.3. 返回类型 复制链接链接已复制到粘贴板!
17.1.7.4. 内容类型 复制链接链接已复制到粘贴板!
- application/json
17.1.7.5. 响应 复制链接链接已复制到粘贴板!
| 代码 | 消息 | datatype |
|---|---|---|
| 200 | 成功响应。 | |
| 0 | 意外错误响应。 |