查询控制策略详细信息 - ShowControl

功能介绍

查询单个预置的控制策略详细信息。

授权信息

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

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

URI

GET /v1/governance/controls/{control_id}

表1 路径参数
参数	是否必选	参数类型	描述
control_id	是	String	控制策略ID。

请求参数

无

响应参数

状态码：200

表2 响应Body参数
参数	参数类型	描述
identifier	String	控制策略ID。
implementation	String	策略类别。
guidance	String	实施建议。
resource	Array of strings	治理资源。
service	String	控制策略所属服务。
behavior	String	控制策略类型。包括主动性控制策略Proactive、检测性控制策略Detective、预防性控制策略Preventive。
control_objective	String	控制策略目标。
framework	Array of strings	治理策略来自的框架。
artifacts	Array of Artifact objects	控制策略内容。
aliases	Array of strings	控制策略别名。
owner	String	控制策略来源。
severity	String	控制策略严重性。
version	String	控制策略版本。
release_date	String	控制策略发布时间。

表3 Artifact
参数	参数类型	描述
content	Content object	控制策略内容。
type	String	策略类型。

表4 Content
参数	参数类型	描述
en	String	英文策略内容。
ch	String	中文策略内容。

状态码：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	错误信息

请求示例

查询单个预置的控制策略详细信息。

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

响应示例

状态码：200

请求成功。

{
  "identifier" : "string",
  "implementation" : "string",
  "guidance" : "string",
  "resource" : [ "string" ],
  "service" : "string",
  "behavior" : "string",
  "control_objective" : "string",
  "framework" : [ "string" ],
  "artifacts" : [ {
    "content" : {
      "en" : "string",
      "ch" : "string"
    },
    "type" : "string"
  } ],
  "aliases" : [ "string" ],
  "owner" : "string",
  "severity" : "string",
  "version" : "string",
  "release_date" : "2023-11-21T06:55:57.419Z"
}