通过身份策略ID获取身份策略
功能介绍
该接口可以用于通过身份策略ID获取身份策略信息。
调试
您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。
URI
GET /v5/policies/{policy_id}
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
policy_id |
是 |
String |
身份策略ID，长度为1到64个字符，只包含字母、数字和"-"的字符串。 |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
X-Language |
否 |
String |
选择接口返回的信息的语言，可以为中文（"zh-cn"）或英文（"en-us"），默认为中文。 缺省值：zh-cn |
响应参数
状态码：200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
policy |
Policy object |
身份策略。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
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
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
错误码。 |
|
error_msg |
String |
错误信息。 |
|
request_id |
String |
请求ID。 |
|
encoded_authorization_message |
String |
加密后的认证失败信息，可以通过STS5解密接口进行解密。 |
状态码：404
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
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 |
未找到相应的资源。 |
错误码
请参见错误码。
