列出策略 - ListPolicies
功能介绍
列出组织中的所有策略。如果指定了资源ID,例如组织单元ID或账号ID,则将获得该资源已绑定的策略列表。此操作只能由组织的管理账号或作为服务委托管理员的成员账号调用。
调试
您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权,具体权限要求请参见权限和授权项。
- 如果使用身份策略授权,需具备如下身份策略权限。
授权项
访问级别
资源类型(*为必须)
条件键
别名
依赖的授权项
organizations:policies:list
List
-
-
-
-
URI
GET /v1/organizations/policies
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| attached_entity_id | 否 | String | 参数解释: 根、组织单元或账号的唯一标识符(ID)。 约束限制: 不涉及 取值范围: 符合正则表达式:^(?:r-[0-9a-z]{4,32}|[\w-]+|ou-[0-9a-z]{8,32})$ 最大长度100。 默认取值: 无默认值 |
| limit | 否 | Integer | 参数解释: 页面中最大结果数量。当未指定 Limit 参数情况下,系统默认值为 1000。 约束限制: 不涉及 取值范围: 最小值1、最大值2000。 默认取值: 200 |
| marker | 否 | String | 参数解释: 分页标记。 约束限制: 不涉及 取值范围: 符合正则表达式:^[A-Za-z0-9+/=-_.]+$ 最小长度4、最大长度400。 默认取值: 无默认值 |
请求参数
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| X-Security-Token | 否 | String | 参数解释: 如果正在使用临时安全凭据,则此 header 是必需的,该值是临时安全凭据的安全令牌(会话令牌)。 约束限制: 不涉及 取值范围: 最小长度0、最大长度32768。 默认取值: 无默认值 |
| X-Language | 否 | String | 参数解释: 选择接口返回的信息的语言,默认为"zh-cn"中文,zh-cn中文,en-us英文 约束限制: 必填字段 取值范围: 无 默认取值: 无 |
响应参数
状态码:200
| 参数 | 参数类型 | 描述 |
|---|---|---|
| policies | Array of PolicySummaryDto objects | 参数解释: 组织中的策略列表。 约束限制: 必填字段 取值范围: 无 默认取值: 无 |
| page_info | PageInfoDto object | 参数解释: 分页信息。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 无默认值 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| is_builtin | Boolean | 参数解释: 一个布尔值,指示指定的策略是否为系统策略。如果为true,即为系统策略,则可以将策略附加到根、组织单元或账号,但不能编辑它。 约束限制: 必填字段 取值范围: 布尔值:true/false 默认取值: 无 |
| description | String | 参数解释: 策略说明。 约束限制: 必填字段 取值范围: 符合正则表达式:^[\s\S]*$ 最大长度512。 默认取值: 无默认值 |
| id | String | 参数解释: 策略的唯一标识符(ID)。 约束限制: 必填字段 取值范围: 符合正则表达式:^p-[0-9a-zA-Z_]{8,128}$ 最小长度1、最大长度130。 默认取值: 无默认值 |
| urn | String | 参数解释: 策略的统一资源名称。 约束限制: 必填字段 取值范围: 最小长度1、最大长度1500。 默认取值: 无默认值 |
| name | String | 参数解释: 策略的名称。 约束限制: 必填字段 取值范围: 符合正则表达式:^[\u4e00-\u9fa5a-zA-Z0-9_- ]+$ 最小长度1、最大长度64。 默认取值: 无默认值 |
| type | String | 参数解释: 策略的类型,service_control_policy:服务控制策略;tag_policy:标签策略。 约束限制: 必填字段 取值范围: 最小长度1、最大长度64。 默认取值: 无默认值 |
请求示例
列出策略
GET https://{endpoint}/v1/organizations/policies 响应示例
状态码:200
Successful.
{
"policies" : [ {
"is_builtin" : true,
"description" : "NFZ",
"id" : "p-M5lVaiMgFXD6Hmq6o4dvqbGk",
"urn" : "string",
"name" : "9`P41WII9Yn]",
"type" : "service_control_policy"
} ],
"page_info" : {
"next_marker" : "ou-taowxgy4xbme6m4x3c2iijbxw7yj8fcw",
"current_count" : 100
}
} 状态码
| 状态码 | 描述 |
|---|---|
| 200 | Successful. |
错误码
请参见错误码。