Updated on 2023-12-18 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 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.

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.

Table 3 Request body parameters

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 Parameters

Status code: 200

Table 5 Response body parameters

Parameter

Type

Description

result

String

Result message.

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 Requests

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

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

Example Responses

Status code: 200

OK

{
  "result" : "string"
}

Status Codes

Status Code

Description

200

OK

400

Bad Request

Error Codes

See CSE Error Codes.