Querying the Governance Policy List

Updated on 2025-04-25 GMT+08:00

View PDF

Function

This API is used to query the governance policy list.

URI

GET /v3/{project_id}/govern/governance/display

**Table 1** Path parameter
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID, which must be unique. The value contains 1 to 64 characters.

**Table 2** Query parameters
Parameter	Mandatory	Type	Description
environment	Yes	String	Environment. all indicates to query all environments.
app	No	String	Application.

Request

**Table 3** Request header parameters
Parameter	Mandatory	Type	Description
Content-Type	Yes	String	Set it to application/json;charset=UTF-8.
X-Auth-Token	Yes	String	User token.
x-engine-id	Yes	String	Instance ID of an exclusive microservice engine.
X-Enterprise-Project-ID	Yes	String	Enterprise project ID.

Response

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
[Array]	Array of GovPolicyDetail objects	Response structure for querying the governance policy list.

**Table 5** GovPolicyDetail
Parameter	Type	Description
matchGroup	CreateBussinessScene object	Traffic definition.
policies	Array of policies objects	Governance policy definition.

**Table 6** CreateBussinessScene
Parameter	Type	Description
name	String	Traffic name.
status	String	Enabling status. Value: enabled or disabled. Default value: enabled
selector	GovSelector object	Governance policy delivery scope.
spec	spec object	Traffic feature description.

**Table 7** spec
Parameter	Type	Description
alias	String	Feature name.
matches	Array of matches objects	Matching condition definition.

**Table 8** matches
Parameter	Type	Description
name	String	Condition name.
apiPath	Object	Matched PATH.
headers	Object	Matched Headers.
method	Array of strings	List of matched Method.
serviceName	String	Matched microservice name.

**Table 9** policies
Parameter	Type	Description
id	String	Governance policy ID.
name	String	Governance policy name.
kind	String	Governance kind. Value: retry, rate-limiting, loadbalance, circuit-breaker, instance-isolation, fault-injection, or bulkhead.
status	String	Enabling status. Value: enabled or disabled.
selector	GovSelector object	Governance policy delivery scope.
spec	Object	Governance policy definition content.

**Table 10** GovSelector
Parameter	Type	Description
environment	String	Environment.
app	String	Application.
service	String	Optional. Governance is delivered to a microservice.

Status code: 400

**Table 11** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.
detail	String	Location details.

Example Request

GET https://{endpoint}/v3/{project_id}/govern/governance/display

Example Response

Status code: 200

Response structure for querying the governance policy list.

[ {
  "matchGroup" : {
    "name" : "",
    "status" : "enabled",
    "selector" : {
      "environment" : "string",
      "app" : "string",
      "service" : "string"
    },
    "spec" : {
      "alias" : "string",
      "matches" : [ {
        "name" : "string",
        "apiPath" : { },
        "headers" : { },
        "method" : [ "string" ],
        "serviceName" : "string"
      } ]
    }
  },
  "policies" : [ {
    "id" : "string",
    "name" : "string",
    "kind" : "string",
    "status" : "string",
    "selector" : {
      "environment" : "string",
      "app" : "string",
      "service" : "string"
    },
    "spec" : { }
  } ]
} ]