Updated on 2025-08-22 GMT+08:00

Listing Governance Policies

Function

This API is used to list all preset governance policies of RGC.

URI

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

Table 1 Query Parameters

Parameter

Mandatory

Type

Description

limit

No

Integer

Maximum number of pages that can be displayed on at once.

marker

No

String

Page marker.

Request Parameters

None

Response Parameters

Status code: 200

Table 2 Response body parameters

Parameter

Type

Description

controls

Array of Control objects

Information about governance policies.

page_info

PageInfoDto object

Number of records displayed on the current page.

Table 3 Control

Parameter

Type

Description

identifier

String

Governance policy ID.

name

String

Name of a governance policy.

description

String

Description of a governance policy.

guidance

String

Necessity of a governance policy.

resource

Array of strings

Governed resources.

framework

Array of strings

Industry-standard compliance framework that the governance policy helps to enforce.

service

String

Service the governance policy applies to.

implementation

String

Policy type.

behavior

String

Type of a governance policy. A governance policy can be preventive, detective, or proactive.

owner

String

Source of a governance policy.

severity

String

Relative risk associated with any violation of the governance policy.

control_objective

String

Pre-defined objective that the governance policy helps you enforce.

version

String

Version of a governance policy.

release_date

String

Time when a governance policy is released.

Table 4 PageInfoDto

Parameter

Type

Description

next_marker

String

Used in the marker request parameter to get the next part of the output. Repeat this operation until the response element comes back as null. If present, more output is available than that included in the current response.

current_count

Integer

Number of records displayed on the current page.

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

Listing all preset governance policies of RGC

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

Example Responses

Status code: 200

Request succeeded.

{
  "controls" : [ {
    "identifier" : "string",
    "name" : "string",
    "description" : "Governance policy 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
  }
}

Status Codes

Status Code

Description

200

Request succeeded.

403

No permissions.

Error Codes

See Error Codes.