显示指定的分析器 - ShowAnalyzer
功能介绍
检索有关指定分析器的信息。
调试
您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。
授权信息
账号根用户具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备如下身份策略权限,更多的权限说明请参见权限和授权项。
| 授权项 | 访问级别 | 资源类型(*为必须) | 条件键 | 别名 | 依赖的授权项 |
|---|---|---|---|---|---|
| AccessAnalyzer:analyzer:get | Read | analyzer * | g:ResourceTag/<tag-key> | - | - |
URI
GET /v5/analyzers/{analyzer_id}
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| analyzer_id | 是 | String | 参数解释: 分析器的唯一标识符。 您可以调用 ListAnalyzers API来获取分析器ID。该API的响应参数中会返回一个分析器列表,其中每个分析器对象的 id 字段即为分析器ID。 取值范围: 最小长度为1,最大长度为36。仅支持包含字母、数字、下划线(_)及中划线(-)。 |
请求参数
无
响应参数
状态码:200
| 参数 | 参数类型 | 描述 |
|---|---|---|
| analyzer | AnalyzerSummary object | 参数解释: 包含有关分析器的信息。 取值范围: 不涉及。 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| configuration | AnalyzerConfiguration object | 参数解释: 分析器的配置项。 取值范围: 不涉及。 |
| created_at | String | 参数解释: 分析器创建的时间。使用UTC +0时间格式,格式为yyyy-MM-ddTHH:mm:ss.SSSZ。例如:2023-09-07T07:51:10.502Z。 取值范围: 不涉及。 |
| id | String | 参数解释: 分析器的唯一标识符。 取值范围: 最小长度为1,最大长度为36。仅支持包含字母、数字、下划线(_)及中划线(-)。 |
| last_analyzed_resource | String | 参数解释: 最近分析的资源的唯一资源标识符。 取值范围: 不涉及。 |
| last_resource_analyzed_at | String | 参数解释: 最近一次分析资源的时间。使用UTC +0时间格式,格式为yyyy-MM-ddTHH:mm:ss.SSSZ。例如:2023-09-07T07:51:10.502Z。 取值范围: 不涉及。 |
| last_all_analyzed_at | String | 参数解释: 最近一次分析全量资源的时间。使用UTC +0时间格式,格式为yyyy-MM-ddTHH:mm:ss.SSSZ。例如:2023-09-07T07:51:10.502Z。 取值范围: 不涉及。 |
| name | String | 参数解释: 分析器的名称。 取值范围: 最小长度为1,最大长度为255。仅支持包含字母、数字、下划线(_)、中划线(-)和点号(.)。 |
| organization_id | String | 参数解释: 组织ID。 取值范围: 最小长度为1,最大长度为35,格式为以 “ou-” 开头,后跟 8 到 32 位的小写字母或数字。 |
| status | String | 参数解释: 分析器的状态。 取值范围: |
| status_reason | StatusReason object | 参数解释: 提供有关分析器当前状态的更多详细信息。 取值范围: 不涉及。 |
| tags | Array of Tag objects | 参数解释: 自定义标签列表。 取值范围: 数组长度为1到20。 |
| type | String | 参数解释: 分析器的类型。 取值范围: |
| urn | String | 参数解释: 分析器的唯一资源标识符。 取值范围: 最大长度为1500。 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| unused_access | unused_access object | 参数解释: 未使用的访问分析器的配置项。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| unused_access_age | Integer | 参数解释: 生成分析结果的预设天数。 约束限制: 不涉及。 取值范围: 最小值为1,最大值为180。 默认取值: 90。 |
| unused_analysis_rule | UnusedAnalysisRule object | 参数解释: 未使用分析规则。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| exclusions | Array of UnusedAnalysisRuleCriteria objects | 参数解释: 排除规则。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| account_ids | Array of strings | 参数解释: 组织账号ID列表。创建组织级未使用的访问分析器时可选填,您指定的账号将不会生成分析结果。 您可以通过以下步骤在华为云控制台查看您的组织账号ID列表: 1.登录华为云控制台 。 2.打开页面左上方的服务列表,选择组织 Organizations。 3.单击左侧的账号管理即可看见该组织下的账号ID列表。 约束限制: 不涉及。 取值范围: 数组长度为1到2000。数组元素为字符串,最小长度为1,最大长度为36,仅支持包含字母、数字、下划线(_)及中划线(-)。 默认取值: 不涉及。 |
| resource_tags | Array of Tag objects | 参数解释: 资源标签列表。 约束限制: 不涉及。 取值范围: 数组长度为1到20。 默认取值: 不涉及。 |
请求示例
检索有关指定分析器的信息。
GET https://{hostname}/v5/analyzers/{analyzer_id} 响应示例
状态码:200
OK
{
"analyzer" : {
"created_at" : "2023-09-07T07:51:10.502Z",
"id" : "{analyzer_id}",
"last_analyzed_resource" : "iam::{domain_id}:agency:{agency_name}",
"last_resource_analyzed_at" : "2023-09-07T07:51:10.502Z",
"name" : "my-analyzer",
"status" : "active",
"tags" : [ {
"key" : "key-1",
"value" : "value-1"
} ],
"type" : "account",
"urn" : "AccessAnalyzer:{region_id}:{domain_id}:analyzer:{analyzer_id}"
}
} 状态码
| 状态码 | 描述 |
|---|---|
| 200 | OK |
错误码
请参见错误码。