Help Center/ Cloud Service Engine/ API Reference/ CSE API/ Microservice Governance/ Querying Governance Policy Details
Updated on 2023-12-18 GMT+08:00
View PDF
Share

Querying Governance Policy Details

Function

This API is used to query governance policy details.

URI

GET /v3/{project_id}/govern/governance/{kind}/{policy_id}

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Unique ID of a tenant's sub-project. The value contains 1 to 64 characters.

kind

Yes

String

Governance policy kind.

policy_id

Yes

String

Governance policy ID.

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

Content-Type

Yes

String

Enter 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.

x-environment

No

String

Environment.

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

name

String

Governance policy name.

selector

GovSelector object

Governance policy delivery scope.

spec

Object

Governance policy definition content.
Table 4 GovSelector

Parameter

Type

Description

environment

String

Environment.

app

String

Application.

service

String

Optional. Governance is delivered to a microservice.

Status code: 400

Table 5 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

detail

String

Location details.

Example Requests

GET https://{endpoint}/v3/{project_id}/govern/governance/{kind}/{policy_id}

Example Responses

Status code: 200

OK

{
  "name" : "string",
  "selector" : {
    "environment" : "string",
    "app" : "string",
    "service" : "string"
  },
  "spec" : { }
}

Status Codes

Status Code

Description

200

OK

400

Bad Request

Error Codes

See CSE Error Codes.

Parent topic: Microservice Governance