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

Creating a Governance Policy

Function

This API is used to create a governance policy.

URI

POST /v3/{project_id}/govern/governance/{kind}

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.

kind

Yes

String

Governance policy kind.

Request

Table 2 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.

x-environment

No

String

Environment.

Table 3 Request body parameter

Parameter

Mandatory

Type

Description

name

No

String

Governance policy name.

selector

No

GovSelector object

Governance policy delivery scope.

spec

No

Object

Governance policy definition content.

Table 4 GovSelector

Parameter

Mandatory

Type

Description

environment

No

String

Environment.

app

No

String

Application.

service

No

String

Optional. Governance is delivered to a microservice.

Response

Status code: 200

Table 5 Response body parameters

Parameter

Type

Description

result

String

Result.

Status code: 400

Table 6 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

detail

String

Location details.

Example Request

POST https://{endpoint}/v3/{project_id}/govern/governance/{kind}

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

Example Response

Status code: 200

Response structure for creating a governance policy.

{
  "result" : "string"
}

Status Code

Status Code

Description

200

OK

400

Bad Request

Error Code

See Error Codes.

We use cookies to improve our site and your experience. By continuing to browse our site you accept our cookie policy. Find out more