DescribeProducts - 查询云产品保护评分

查询云产品的数据保护评分状态。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
bdrc:DescribeProductsnone
  • 全部资源
    *

请求语法

GET /api/v1/products HTTP/1.1

请求参数

名称类型必填描述示例值
当前API无需请求参数

返回参数

名称类型描述示例值
object

BaseResponse<ListResult>

Dataobject

返回数据

Contentarray<object>

本次请求所返回的记录集合

Contentobject
ProductTypestring

云产品类型,如 ecs,oss 等

oss
EnableCheckboolean

是否开启数据保护评分评估

true
ProtectionScoreinteger

数据保护评分(0 - 100 分)

90
ProtectionScoreUpdatedTimelong

数据保护评分更新时间(UNIX 时间)

1726036498
TotalResourceCountlong

资源总数

100
RiskyResourceCountlong

有风险的资源数

1
CheckFailedResourceCountlong

检查失败的资源数

1
DisableCheckResourceCountlong

关闭检查的资源数

1
RiskCountlong

有风险的检查项目数

1
CheckFailedCountlong

失败的检查项个数

1
ProtectionScoreDistributionarray<object>

不同分数段资源个数分布

ProtectionScoreDistributionobject
Rangeobject

区间

Frominteger

下限(包含边界)

0
Tointeger

上限(包含边界)

60
Countlong

区间内的个数

5
NextTokenstring

用来表示当前调用返回读取到的位置,空代表数据已经读取完毕

b4fd3cffcacafd65e3818a0b9b2ff9a2
MaxResultsinteger

本次请求所返回的最大记录条数

10
TotalCountlong

本次请求条件下的数据总量,此参数为可选参数,默认可不返回

50
RequestIdstring

请求的唯一标识

30FB202A-1D22-5394-AB02-4477CDFCF51F

示例

正常返回示例

JSON格式

{
  "Data": {
    "Content": [
      {
        "ProductType": "oss",
        "EnableCheck": true,
        "ProtectionScore": 90,
        "ProtectionScoreUpdatedTime": 1726036498,
        "TotalResourceCount": 100,
        "RiskyResourceCount": 1,
        "CheckFailedResourceCount": 1,
        "DisableCheckResourceCount": 1,
        "RiskCount": 1,
        "CheckFailedCount": 1,
        "ProtectionScoreDistribution": [
          {
            "Range": {
              "From": 0,
              "To": 60
            },
            "Count": 5
          }
        ]
      }
    ],
    "NextToken": "b4fd3cffcacafd65e3818a0b9b2ff9a2",
    "MaxResults": 10,
    "TotalCount": 50
  },
  "RequestId": "30FB202A-1D22-5394-AB02-4477CDFCF51F"
}

错误码

访问错误中心查看更多错误码。