立即开始扫描应用于指定资源的策略 - StartResourceScan
功能介绍
立即开始扫描应用于指定资源的策略。
调试
您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。
授权信息
账号根用户具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备如下身份策略权限,更多的权限说明请参见权限和授权项。
| 授权项 | 访问级别 | 资源类型(*为必须) | 条件键 | 别名 | 依赖的授权项 |
|---|---|---|---|---|---|
| AccessAnalyzer:analyzer:scan | Write | analyzer * | g:ResourceTag/<tag-key> | - | - |
URI
POST /v5/analyzers/{analyzer_id}/scan
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| analyzer_id | 是 | String | 参数解释: 分析器的唯一标识符。 您可以调用 ListAnalyzers API来获取分析器ID。该API的响应参数中会返回一个分析器列表,其中每个分析器对象的 id 字段即为分析器ID。 取值范围: 最小长度为1,最大长度为36。仅支持包含字母、数字、下划线(_)及中划线(-)。 |
请求参数
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| resource_id | 否 | String | 参数解释: 资源的唯一标识符。 约束限制: 不涉及。 取值范围: 最小长度为1,最大长度为36。仅支持包含字母、数字、下划线(_)及中划线(-)。 默认取值: 不涉及。 |
| resource_owner_account | 是 | String | 参数解释: 需要扫描资源的账号ID。 您可以调用 ListFindings API来检索指定分析器生成的分析结果列表。该API的响应中会包含一个分析结果列表,其中resource_owner_account字段即为需要扫描资源的账号ID。 约束限制: 不涉及。 取值范围: 最小长度为1,最大长度为36。仅支持包含字母、数字、下划线(_)及中划线(-)。 默认取值: 不涉及。 |
| resource_project_id | 否 | String | 参数解释: 资源所属的项目标识符。 约束限制: 不涉及。 取值范围: 最大长度为36。仅支持包含字母、数字、下划线(_)及中划线(-)。 默认取值: 不涉及。 |
| resource_urn | 是 | String | 参数解释: 资源的唯一资源标识符。 约束限制: 不涉及。 取值范围: 最大长度为1500。 默认取值: 不涉及。 |
| finding_type | 否 | String | 参数解释: 访问分析结果类型。 约束限制: 不涉及。 取值范围:
默认取值: 不涉及。 |
响应参数
状态码:200
OK
无
请求示例
立即开始扫描应用于指定资源的策略。
POST https://{hostname}/v5/analyzers/{analyzer_id}/scan
{
"resource_owner_account" : "{analyzer_id}",
"resource_urn" : "iam::{domain_id}:agency:{agency_name}",
"resource_id" : "{agency_id}"
} 响应示例
无
状态码
| 状态码 | 描述 |
|---|---|
| 200 | OK |
错误码
请参见错误码。