DescribeRules - 查询数据保护评分规则列表

查询数据保护规则列表。

调试

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

授权信息

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

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

请求语法

GET /api/v1/rules HTTP/1.1

请求参数

名称类型必填描述示例值
ResourceTypestring

资源类型

ACS::ECS::Instance
NextTokenstring

是否拥有下一次查询的令牌(Token)。取值:如果 NextToken 为空表示没有下一次查询。 如果 NextToken 有返回值,该取值表示下一次查询开始的令牌。

cae**********699
MaxResultsinteger

分页查询时每页的最大条目数。最大值为 50。默认值为 10。

10

返回参数

名称类型描述示例值
object

BaseResponse<ListResult>

Dataobject

返回数据

Contentarray<object>

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

Contentobject
RuleIdstring

规则的唯一标识

rule-bp11ggd8wr762
ProductTypestring

适用的产品类型

ecs
ResourceTypestring

适用的资源类型

ACS::ECS::Instance
RuleTemplatestring

规则模板

ecs-backup
CheckStatusstring

检查状态 (NOT_CHECKED: 未检查, PASSED: 检查通过, FAILED: 检查未通过, CHECKING: 检查中, CHECK_FAILED: 检查失败)

PASSED
CheckTimelong

检查时间

1704157635
TotalResourceCountlong

检查的总资源数

1
RiskyResourceCountlong

有风险的资源数

0
CheckFailedResourceCountlong

检查失败的资源数

0
NextTokenstring

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

0975951c75d7b41464c8d08ae17043ca
MaxResultsinteger

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

10
TotalCountlong

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

42
RequestIdstring

请求的唯一标识

86DEBAC9-AB6A-59AB-9E5C-A540E579ECC9

示例

正常返回示例

JSON格式

{
  "Data": {
    "Content": [
      {
        "RuleId": "rule-bp11ggd8wr762",
        "ProductType": "ecs",
        "ResourceType": "ACS::ECS::Instance",
        "RuleTemplate": "ecs-backup",
        "CheckStatus": "PASSED",
        "CheckTime": 1704157635,
        "TotalResourceCount": 1,
        "RiskyResourceCount": 0,
        "CheckFailedResourceCount": 0
      }
    ],
    "NextToken": "0975951c75d7b41464c8d08ae17043ca",
    "MaxResults": 10,
    "TotalCount": 42
  },
  "RequestId": "86DEBAC9-AB6A-59AB-9E5C-A540E579ECC9"
}

错误码

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