Querying a Governance Policy

Function

This API is used to query details about a preset governance policy.

URI

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

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
control_id	Yes	String	Governance policy ID.

Request Parameters

None

Response Parameters

Status code: 200

**Table 2** Response body parameters
Parameter	Type	Description
identifier	String	Governance policy ID.
implementation	String	Policy type.
guidance	String	Implementation recommendation.
resource	Array of strings	Governed resources.
service	String	Service the governance policy applies to.
behavior	String	Type of a governance policy. A governance policy can be preventive, detective, or proactive.
control_objective	String	Pre-defined objective that the governance policy helps you enforce.
framework	Array of strings	Industry-standard compliance framework that the governance policy helps to enforce.
artifacts	Array of Artifact objects	Content of a governance policy.
aliases	Array of strings	Alias of a governance policy.
owner	String	Source of a governance policy.
severity	String	Relative risk associated with any violation of the governance policy.
version	String	Version of a governance policy.
release_date	String	Time when a governance policy is released.

**Table 3** Artifact
Parameter	Type	Description
content	Content object	Content of a governance policy.
type	String	Type of a governance policy.

**Table 4** Content
Parameter	Type	Description
en	String	Policy content in English.
ch	String	Policy content in Chinese.

Status code: 403

**Table 5** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.
request_id	String	Unique ID of the request.
encoded_authorization_message	String	Encrypted error message.
details	Array of ForbiddenErrorDetail objects	Error message indicating no permissions for cross-service invoking.

**Table 6** ForbiddenErrorDetail
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.

Example Requests

Querying details about a preset governance policy

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

Example Responses

Status code: 200

Request succeeded.

{
  "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"
}