查询数据保护规则列表。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
|
操作 |
访问级别 |
资源类型 |
条件关键字 |
关联操作 |
|
bdrc:DescribeRules |
none |
*全部资源
|
无 | 无 |
请求语法
GET /api/v1/rules HTTP/1.1请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| ResourceType |
string |
否 |
资源类型 |
ACS::ECS::Instance |
| NextToken |
string |
否 |
是否拥有下一次查询的令牌（Token）。取值：如果 NextToken 为空表示没有下一次查询。 如果 NextToken 有返回值，该取值表示下一次查询开始的令牌。 |
cae**********699 |
| MaxResults |
integer |
否 |
分页查询时每页的最大条目数。最大值为 50。默认值为 10。 |
10 |
| ResourceCategoryId |
string |
否 |
资源分类 ID |
rc-000***123 |
| ResourceRegionId |
string |
否 |
资源所在地域 ID。 |
cn-hangzhou |
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
BaseResponse<ListResult |
||
| Data |
object |
返回数据 |
|
| Content |
array<object> |
本次请求所返回的记录集合 |
|
|
object |
|||
| RuleId |
string |
规则的唯一标识 |
rule-bp11ggd8wr762 |
| ProductType |
string |
适用的产品类型 |
ecs |
| ResourceType |
string |
适用的资源类型 |
ACS::ECS::Instance |
| RuleTemplate |
string |
规则模板 |
ecs-backup |
| CheckStatus |
string |
检查状态 (NOT_CHECKED: 未检查, PASSED: 检查通过, FAILED: 检查未通过, CHECKING: 检查中, CHECK_FAILED: 检查失败) |
PASSED |
| CheckTime |
integer |
检查时间 |
1704157635 |
| TotalResourceCount |
integer |
检查的总资源数 |
1 |
| RiskyResourceCount |
integer |
有风险的资源数 |
0 |
| CheckFailedResourceCount |
integer |
检查失败的资源数 |
0 |
| NextToken |
string |
用来表示当前调用返回读取到的位置，空代表数据已经读取完毕 |
0975951c75d7b41464c8d08ae17043ca |
| MaxResults |
integer |
本次请求所返回的最大记录条数 |
10 |
| TotalCount |
integer |
本次请求条件下的数据总量，此参数为可选参数，默认可不返回 |
42 |
| RequestId |
string |
请求的唯一标识 |
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"
}错误码
访问错误中心查看更多错误码。
变更历史
更多信息，参考变更详情。