更新时间:2026-05-08 GMT+08:00
分享

获取相关访问预览的信息 - ShowAccessPreview

功能介绍

获取相关访问预览的信息。

调试

您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。

授权信息

账号根用户具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备如下身份策略权限,更多的权限说明请参见权限和授权项

授权项

访问级别

资源类型(*为必须)

条件键

别名

依赖的授权项

AccessAnalyzer:analyzer:getPreview

Read

analyzer *

g:ResourceTag/<tag-key>

-

-

URI

GET /v5/analyzers/{analyzer_id}/access-previews/{access_preview_id}

表1 路径参数

参数

是否必选

参数类型

描述

analyzer_id

String

参数解释

分析器的唯一标识符。

您可以调用 ListAnalyzers API来获取分析器ID。该API的响应参数中会返回一个分析器列表,其中每个分析器对象的 id 字段即为分析器ID。

取值范围

最小长度为1,最大长度为36。仅支持包含字母、数字、下划线(_)及中划线(-)。

access_preview_id

String

参数解释

访问预览的唯一标识符。

您可以调用 ListAccessPreviews API来检索为指定分析器创建的所有访问预览列表。该API的响应中会包含一个访问预览列表,列表中的每个访问预览摘要对象都包含其唯一的access_preview_id字段,这就是预览访问分析ID。

取值范围

最小长度为1,最大长度为36。仅支持包含字母、数字、下划线(_)和中划线(-)。

请求参数

响应参数

状态码:200

表2 响应Body参数

参数

参数类型

描述

access_preview

AccessPreview object

参数解释

访问预览。

取值范围

不涉及。

表3 AccessPreview

参数

参数类型

描述

access_preview_id

String

参数解释

访问预览的唯一标识符。

取值范围

最小长度为1,最大长度为36。仅支持包含字母、数字、下划线(_)和中划线(-)。

analyzer_id

String

参数解释

分析器的唯一标识符。

取值范围

最小长度为1,最大长度为36。仅支持包含字母、数字、下划线(_)及中划线(-)。

configurations

Configuration object

参数解释

访问预览配置。

取值范围

不涉及。

created_at

String

参数解释

访问预览创建时间。使用UTC +0时间格式,格式为yyyy-MM-ddTHH:mm:ss.SSSZ。例如:2023-09-07T07:51:10.502Z。

取值范围

不涉及。

status

String

参数解释

访问预览的状态。

取值范围

  • creating:创建中

  • completed:创建成功

  • failed:创建失败

status_reason

PreviewStatusReason object

参数解释

提供有关访问预览当前状态的更多详细信息。

取值范围

不涉及

表4 Configuration

参数

参数类型

描述

iam_agency

IAMAgency object

参数解释

IAM信任委托。

约束限制

不涉及。

取值范围

不涉及。

默认取值

不涉及。

obs_bucket

OBSBucket object

参数解释

OBS桶。

约束限制

不涉及。

取值范围

不涉及。

默认取值

不涉及。

kms_cmk

KMSCmk object

参数解释

KMS密钥。

约束限制

不涉及。

取值范围

不涉及。

默认取值

不涉及。

表5 IAMAgency

参数

参数类型

描述

trust_policy

String

参数解释

该策略JSON格式策略文档。

约束限制

不涉及。

取值范围

最小长度为0,最大长度为131072。

默认取值

不涉及。

表6 OBSBucket

参数

参数类型

描述

bucket_acl

String

参数解释

桶ACL xml文件的string格式。

约束限制

不涉及。

取值范围

不涉及。

默认取值

不涉及。

bucket_policy

String

参数解释

该策略JSON格式策略文档。

约束限制

不涉及。

取值范围

最小长度为0,最大长度为131072。

默认取值

不涉及。

表7 KMSCmk

参数

参数类型

描述

grants

String

参数解释

用于加密密钥的授权。

约束限制

不涉及。

取值范围

不涉及。

默认取值

不涉及。

表8 PreviewStatusReason

参数

参数类型

描述

code

String

参数解释

访问预览当前状态的原因。

取值范围

  • internal_error: 内部错误

  • invalid_configuration: 配置无效

请求示例

获取相关访问预览的信息。

GET https://{hostname}/v5/analyzers/{analyzer_id}/access-previews/{access_preview_id}

响应示例

状态码:200

OK

{
  "access_preview" : {
    "analyzer_id" : "{analyzer_id}",
    "configurations" : {
      "iam_agency" : {
        "trust_policy" : "{\"Version\":\"5.0\",\"Statement\":[{\"Condition\":{\"StringMatch\":{\"g:PrincipalOrgId\":[\"org_id\"]}},\"Action\":[\"sts:agencies:assume\",\"sts::tagSession\",\"sts::setSourceIdentity\"],\"Effect\":\"Allow\",\"Principal\":{\"IAM\":[\"dd...\"]}}]}"
      }
    },
    "created_at" : "2023-09-07T07:26:23.440Z",
    "access_preview_id" : "{access_preview_id}",
    "status" : "completed"
  }
}

状态码

状态码

描述

200

OK

错误码

请参见错误码

相关文档