j9九游会登录/ 统一身份认证服务 iam_统一身份认证服务（新版）/ api参考/ / / / 通过身份策略id获取身份策略 - getpolicyv5
更新时间：2025-12-25 gmt 08:00
查看pdf

通过身份策略id获取身份策略 -j9九游会登录

功能介绍

该接口可以用于通过身份策略id获取身份策略信息。

调试

您可以在中调试该接口，支持自动认证鉴权。api explorer可以自动生成sdk代码示例，并提供sdk代码示例调试功能。

授权信息

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

授权项

访问级别

资源类型（*为必须）

条件键

别名

依赖的授权项

iam:policies:getv5

read

policy *

-

-

-

uri

get /v5/policies/{policy_id}

表1 路径参数

参数

是否必选

参数类型

描述

policy_id

是

string

身份策略id，长度为1到64个字符，只包含字母、数字和"-"的字符串。

请求参数

表2 请求header参数

参数

是否必选

参数类型

描述

x-language

否

string

选择接口返回的信息的语言，可以为中文（"zh-cn"）或英文（"en-us"），默认为中文。

缺省值：zh-cn

响应参数

状态码：200

表3 响应body参数

参数

参数类型

描述

policy

policy object

身份策略。
表4 policy

参数

参数类型

描述

policy_type

string

身份策略类型，可以为“自定义”（custom）或“系统预置”（system）。

policy_name

string

身份策略名称，长度为1到128个字符，只包含字母、数字、"_"、" "、"="、"."、"@"和"-"的字符串。

policy_id

string

身份策略id，长度为1到64个字符，只包含字母、数字和"-"的字符串。

urn

string

统一资源名称。

path

string

资源路径，默认为空串。由若干段字符串拼接而成，每段先包含一个或多个字母、数字、"."、","、" "、"@"、"="、"_"或"-"，并以"/"结尾，例如"foo/bar/"。

default_version_id

string

默认版本号。

attachment_count

integer

附加了本身份策略的实体数量。

description

string

身份策略描述。

created_at

string

身份策略创建时间。

updated_at

string

身份策略默认版本最近一次的更新时间。

状态码：403

表5 响应body参数

参数

参数类型

描述

error_code

string

错误码。

error_msg

string

错误信息。

request_id

string

请求id。

encoded_authorization_message

string

加密后的认证失败信息，可以通过sts5解密接口进行解密。

状态码：404

表6 响应body参数

参数

参数类型

描述

error_code

string

错误码。

error_msg

string

错误信息。

request_id

string

请求id。

请求示例

通过身份策略id获取身份策略信息。

get https://{endpoint}/v5/policies/{policy_id}

响应示例

状态码：200

请求成功。

{
  "policy" : {
    "policy_type" : "custom",
    "policy_name" : "name",
    "policy_id" : "string",
    "urn" : "iam::accountid:policy:name",
    "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

未找到相应的资源。

错误码

请参见错误码。

父主题：

相关文档

网站地图