列出控制策略 - ListControls

功能介绍

列出RGC服务里所有的预置控制策略。

授权信息

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

授权项	访问级别	资源类型（*为必须）	条件键	别名	依赖的授权项
rgc:control:list	List	-	-	-	-

URI

GET /v1/governance/controls

表1 Query参数
参数	是否必选	参数类型	描述
limit	否	Integer	分页页面的最大值。
marker	否	String	页面标记。

请求参数

无

响应参数

状态码：200

表2 响应Body参数
参数	参数类型	描述
controls	Array of Control objects	控制策略信息。
page_info	PageInfoDto object	本页返回条目数量。

表3 Control
参数	参数类型	描述
identifier	String	控制策略ID。
name	String	控制策略名称。
description	String	控制策略描述。
guidance	String	控制策略必须性。
resource	Array of strings	治理资源。
framework	Array of strings	治理策略来自的框架。
service	String	控制策略所属服务。
implementation	String	策略类别。
behavior	String	控制策略类型。包括主动性控制策略Proactive、检测性控制策略Detective、预防性控制策略Preventive。
owner	String	控制策略来源。
severity	String	控制策略严重性。
control_objective	String	控制策略目标。
version	String	控制策略版本。
release_date	String	控制策略发布时间。

表4 PageInfoDto
参数	参数类型	描述
next_marker	String	在标签请求参数中使用以获取输出的下一部分。重复此操作，直到响应元素返回null。如果存在，则表示可用的输出比当前响应中包含的输出多。
current_count	Integer	本页返回条目数量。

状态码：403

表5 响应Body参数
参数	参数类型	描述
error_code	String	错误码
error_msg	String	错误信息
request_id	String	请求唯一标识
encoded_authorization_message	String	加密的错误信息
details	Array of ForbiddenErrorDetail objects	跨服务调用无权限错误信息

表6 ForbiddenErrorDetail
参数	参数类型	描述
error_code	String	错误码
error_msg	String	错误信息

请求示例

列出RGC服务里所有的预置控制策略。

GET https://{endpoint}/v1/governance/controls

响应示例

状态码：200

请求成功。

{
  "controls" : [ {
    "identifier" : "string",
    "name" : "string",
    "description" : "控制策略ID。",
    "guidance" : "string",
    "resource" : [ "string" ],
    "framework" : [ "string" ],
    "service" : "string",
    "implementation" : "string",
    "behavior" : "string",
    "owner" : "string",
    "severity" : "string",
    "control_objective" : "string",
    "version" : "string",
    "release_date" : "2023-11-21T06:54:43.941Z"
  } ],
  "page_info" : {
    "next_marker" : "string",
    "current_count" : 0
  }
}