文档首页/ 微服务引擎 CSE/ API参考/ CSE API/ 微服务治理/ 查询治理策略列表
更新时间：2024-12-12 GMT+08:00
查看PDF
分享

查询治理策略列表

功能介绍

查询治理策略列表。

调试

您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

租户子项目的唯一标识。字符长度为1~64。
表2 Query参数

参数

是否必选

参数类型

描述

environment

是

String

所属环境，填写all时表示查询所有环境。

app

否

String

所属应用。

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

Content-Type

是

String

该字段内容填为 "application/json;charset=UTF-8"。

X-Auth-Token

是

String

用户Token。

x-engine-id

是

String

微服务引擎专享版的实例ID。

X-Enterprise-Project-ID

是

String

企业项目ID。

响应参数

状态码： 200
表4 响应Body参数

参数

参数类型

描述

[数组元素]

Array of GovPolicyDetail objects

查询治理策略列表响应结构体。
表5 GovPolicyDetail

参数

参数类型

描述

matchGroup

CreateBussinessScene object

流量定义。

policies

Array of policies objects

治理策略定义。
表6 CreateBussinessScene

参数

参数类型

描述

name

String

流量名称。

status

String

启用状态，支持enabled和disabled。

缺省值：enabled

selector

GovSelector object

治理策略下发范围。

spec

spec object

流量特征描述。
表7 spec

参数

参数类型

描述

alias

String

特征名称。

matches

Array of matches objects

匹配条件定义。
表8 matches

参数

参数类型

描述

name

String

条件名称。

apiPath

Object

匹配的PATH。

headers

Object

匹配的Headers。

method

Array of strings

匹配的Method列表。

serviceName

String

匹配的微服务名称。
表9 policies

参数

参数类型

描述

id

String

治理策略ID。

name

String

治理策略名称。

kind

String

治理类型，支持填写retry、rate-limiting、loadbalance、circuit-breaker、instance-isolation、fault-injection和bulkhead。

status

String

启用状态，支持enabled和disabled。

selector

GovSelector object

治理策略下发范围。

spec

Object

治理策略定义内容。
表10 GovSelector

参数

参数类型

描述

environment

String

所属环境。

app

String

所属应用。

service

String

可选，治理下发到微服务级别。
状态码： 400
表11 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误信息。

detail

String

详细定位信息。

请求示例

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

响应示例

状态码： 200

查询治理策略列表响应结构体。

[ {
  "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" : { }
  } ]
} ]

状态码

状态码

描述

200

查询治理策略列表响应结构体。

400

错误的请求。

错误码

请参见CSE错误码。

父主题： 微服务治理

相关文档