GetOverviewCard - 获取卡片概览--多云安全平台-火山引擎

文档中心

立即注册

导航

GetOverviewCard - 获取卡片概览

最近更新时间：2024.11.06 17:01:32首次发布时间：2024.11.06 17:01:32

获取火山引擎控制台中多云安全卡片的概况信息。

请求说明

请求方式: GET
请求地址: https://open.volcengineapi.com/?Action=GetOverviewCard&Version=2023-05-01

请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。

参数	类型	是否必填	示例值	描述
Action	String	是	GetOverviewCard	要执行的操作，取值：GetOverviewCard。
Version	String	是	2023-05-01	API的版本，取值：2023-05-01。

返回参数

下表仅列出本接口特有的返回参数。更多信息请参见返回结构。

参数	类型	示例值	描述
StyleType	Long	1	安全卡片风格类型
SecurityScore	Double	32.35	安全态势评分
RiskyResourceCnt	Long	1041	风险资产数量
MCStrategyRiskCnt	Long	2762	云配置风险数量
MCStrategyRiskStat	Array of Object	--	云配置风险统计情况
MCStrategyRiskList	Array of Object	--	云配置风险列表

请求示例

GET /?Action=GetOverviewCard&Version=2023-05-01 HTTP/1.1
Host: open.volcengineapi.com
X-Date: 20241105T034632Z
Authorization: HMAC-SHA256 Credential=Adfks******wekfwe/20241105/cn-beijing/mcs/request, SignedHeaders=host;x-date, Signature=47a7d934ff7b37c03938******cd7b8278a40a1057690c401e92246a0e41085f

返回示例

{
  "ResponseMetadata": {
    "RequestId": "20241105114639144006146091B9C6C1",
    "Action": "GetOverviewCard",
    "Version": "2023-05-01",
    "Service": "mcs",
    "Region": "cn-beijing"
  },
  "Result": {
    "StyleType": 1,
    "SecurityScore": 32.35,
    "RiskyResourceCnt": 1041,
    "MCStrategyRiskCnt": 2762,
    "MCStrategyRiskStat": [
      {
        "RiskType": "storage",
        "Count": 424
      }
    ],
    "MCStrategyRiskList": [
      {
        "RiskID": "uniform_risk_xxxxxxxxxxxx",
        "RiskName": "应启用SLB访问日志",
        "ResourceType": "NetworkSlb",
        "ResourceCnt": 37,
        "RiskLevel": "300-mid",
        "RiskOccurTimeMilli": 1729177226088
      }
    ]
  }
}

错误码

下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。

状态码	错误码	错误信息	说明
400	InvalidParameter	The specified parameter %s is invalid.	无效参数
400	OperationDenied	Operation is denied because the specified resource is in use.	操作被拒绝
400	MissingParameter	The required parameter %s is missing.	缺失参数
500	InternalError	The request has failed due to an unknown error.	内部错误