# 通过身份策略ID获取身份策略 - GetPolicyV5 #### 功能介绍 该接口可以用于通过身份策略ID获取身份策略信息。 #### 调试 您可以在[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/IAM/doc?api=GetPolicyV5&version=v5)中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。 #### 授权信息 账号根用户具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备如下身份策略权限，更多的权限说明请参见[权限和授权项](https://support.huaweicloud.com/api-iam5/iam_02_1124.html)。 | 授权项 | 访问级别 | 资源类型（\*为必须） | 条件键 | 别名 | 依赖的授权项 | |:---|:---|:---|:---|:---|:---| | iam:policies:getV5 | Read | policy \* | - | - | - | #### URI GET /v5/policies/{policy_id} 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | policy_id | 是 | String | **参数解释**： 身份策略ID。获取方式请参见查询身份策略列表接口（ListPoliciesV5）获取或在IAM控制台的身份策略列表页查看。 **约束限制**： 不涉及。 **取值范围**： 长度为1到64个字符，只包含字母、数字和"-"的字符串。 **默认取值**： 不涉及。 | #### 请求参数 表2请求Header参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | X-Language | 否 | String | **参数解释**： 选择接口返回的信息的语言。 **约束限制**： 不涉及。 **取值范围**： 中文（"zh-cn"）或英文（"en-us"）。 **默认取值**： 默认为中文（"zh-cn"）。 | #### 响应参数 **状态码：200** 表3响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | policy | [policy] object | **参数解释**： 身份策略。 **取值范围**： 不涉及。 | 表4policy | 参数 | 参数类型 | 描述 | |:---|:---|:---| | policy_type | String | **参数解释**： 身份策略类型。 **取值范围**： "自定义"（custom）或"系统预置"（system）。 | | policy_name | String | **参数解释**： 身份策略名称。 **取值范围**： 长度为1到128个字符，只包含字母、数字、"_"、"+"、"="、"."、"@"和"-"的字符串。 | | policy_id | String | **参数解释**： 身份策略ID。获取方式请参见调用查询身份策略列表接口（ListPoliciesV5）获取或在IAM控制台的身份策略列表页查看。 **取值范围**： 长度为1到64个字符，只包含字母、数字和"-"的字符串。 | | urn | String | **参数解释**： URN(Uniform Resource Name)统一资源名称, [参考链接](https://support.huaweicloud.com/usermanual-iam5/iam_01_1275.html)。 **取值范围**： 不涉及。 | | path | String | **参数解释**： 资源路径，用于组织和分类资源的层级路径，类似于文件系统中的目录结构。 **取值范围**： 由若干段字符串拼接而成，长度为0\~512个字符，每段先包含一个或多个字母、数字、"."、","、"+"、"@"、"="、"_"或"-"，并以"/"结尾，例如"foo/bar/"。 | | default_version_id | String | **参数解释**： 默认版本号，表示当前生效的策略版本号。 **取值范围**： 不涉及。 | | attachment_count | Integer | **参数解释**： 附加了本身份策略的实体数量。 **取值范围**： 不涉及。 | | description | String | **参数解释**： 身份策略描述。 **取值范围**： 长度范围为\[0,1000\]。 | | created_at | String | **参数解释**： 身份策略创建时间。使用UTC+0时间格式，格式为yyyy-MM-ddTHH:mm:ss.SSSZ，例如2023-09-13T06:51:20.550Z。 **取值范围**： 不涉及。 | | updated_at | String | **参数解释**： 身份策略最近一次的更新时间。使用UTC+0时间格式，格式为yyyy-MM-ddTHH:mm:ss.SSSZ，例如2023-09-13T06:51:20.550Z。 **取值范围**： 不涉及。 | **状态码：403** 表5响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | **参数解释**： 错误码，请参见[错误码](https://support.huaweicloud.com/api-iam5/ErrorCode.html)。 **取值范围**： 格式为PAP5.XXXX，例如PAP5.0012。 | | error_msg | String | **参数解释**： 错误信息，请参见[错误信息](https://support.huaweicloud.com/api-iam5/ErrorCode.html)。 **取值范围**： 不涉及。 | | request_id | String | **参数解释**： API请求的唯一标识，用于排查接口调用异常。 **取值范围**： 不涉及。 | | encoded_authorization_message | String | **参数解释**： 认证失败时返回的加密详细信息，用于定位认证问题。 可以通过STS5解密接口进行解密，请参见[接口链接](https://support.huaweicloud.com/api-iam5/DecodeAuthorizationMessage.html)。 **取值范围**： 不涉及。 | **状态码：404** 表6响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | **参数解释**： 错误码，请参见[错误码](https://support.huaweicloud.com/api-iam5/ErrorCode.html)。 **取值范围**： 格式为PAP5.XXXX，例如 PAP5.0012。 | | error_msg | String | **参数解释**： 错误信息，请参见[错误信息](https://support.huaweicloud.com/api-iam5/ErrorCode.html)。 **取值范围**： 不涉及。 | | request_id | String | **参数解释**： API 请求的唯一标识，用于排查接口调用异常。 **取值范围**： 不涉及。 | #### 请求示例 通过身份策略ID获取身份策略信息。 ``` GET https://{endpoint}/v5/policies/{policy_id} ``` #### 响应示例 **状态码：200** ``` { "policy" : { "policy_type" : "custom", "policy_name" : "name", "policy_id" : "string", "urn" : "iam::123456789012:policy:example-policy", "path" : "", "default_version_id" : "v1", "attachment_count" : 0, "description" : "description", "created_at" : "2023-09-25T07:49:11.582Z", "updated_at" : "2023-09-25T07:49:11.582Z" } } ``` #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | 请求成功。 | | 403 | 没有操作权限。 | | 404 | 未找到相应的资源。 | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-iam5/ErrorCode.html)。