获取所有访问预览 - ListAccessPreviews
功能介绍
获取所有访问预览。
调试
您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。
授权信息
账号根用户具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备如下身份策略权限,更多的权限说明请参见权限和授权项。
| 授权项 | 访问级别 | 资源类型(*为必须) | 条件键 | 别名 | 依赖的授权项 |
|---|---|---|---|---|---|
| AccessAnalyzer:analyzer:listPreviews | List | analyzer * | g:ResourceTag/<tag-key> | - | - |
URI
GET /v5/analyzers/{analyzer_id}/access-previews
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| analyzer_id | 是 | String | 参数解释: 分析器的唯一标识符。 您可以调用 ListAnalyzers API来获取分析器ID。该API的响应参数中会返回一个分析器列表,其中每个分析器对象的 id 字段即为分析器ID。 取值范围: 最小长度为1,最大长度为36。仅支持包含字母、数字、下划线(_)及中划线(-)。 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| limit | 否 | Integer | 参数解释: 单页最大结果数。 约束限制: 不涉及。 取值范围: 最小值为1,最大值为200。 默认取值: 100 |
| marker | 否 | String | 参数解释: 页面标记。 约束限制: 不涉及。 取值范围: 最小长度为4,最大长度为400。仅支持包含大小写字母、数字及特殊字符(+、/、=、-、_)。 默认取值: 不涉及。 |
请求参数
无
响应参数
状态码:200
| 参数 | 参数类型 | 描述 |
|---|---|---|
| access_previews | Array of AccessPreviewSummary objects | 参数解释: 访问预览列表。 取值范围: 不涉及。 |
| page_info | PageInfo object | 参数解释: 页面的信息。 取值范围: 不涉及。 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| access_preview_id | String | 参数解释: 访问预览的唯一标识符。 取值范围: 最小长度为1,最大长度为36。仅支持包含字母、数字、下划线(_)和中划线(-)。 |
| analyzer_id | String | 参数解释: 分析器的唯一标识符。 取值范围: 最小长度为1,最大长度为36。仅支持包含字母、数字、下划线(_)及中划线(-)。 |
| created_at | String | 参数解释: 访问预览创建时间。使用UTC +0时间格式,格式为yyyy-MM-ddTHH:mm:ss.SSSZ。例如:2023-09-07T07:51:10.502Z。 取值范围: 不涉及。 |
| status | String | 参数解释: 访问预览的状态。 取值范围: |
| status_reason | PreviewStatusReason object | 参数解释: 提供有关访问预览当前状态的更多详细信息。 取值范围: 不涉及 |
请求示例
获取所有的访问预览。
GET https://{hostname}/v5/analyzers/{analyzer_id}/access-previews 响应示例
状态码:200
OK
{
"access_previews" : [ {
"analyzer_id" : "{analyzer_id}",
"created_at" : "2023-09-07T08:35:41.997Z",
"access_preview_id" : "{access_preview_id}",
"status" : "completed"
} ],
"page_info" : {
"current_count" : 1,
"next_marker" : null
}
} 状态码
| 状态码 | 描述 |
|---|---|
| 200 | OK |
错误码
请参见错误码。