查询指定类型治理策略列表 - QuerySpecifiedKindGovernancePolicyList

功能介绍

查询指定类型治理策略列表。

调试

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

授权信息

账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。

如果使用角色与策略授权，具体权限要求请参见权限和授权项。
如果使用身份策略授权，需具备如下身份策略权限。
授权项
访问级别
资源类型（*为必须）
条件键
别名
依赖的授权项
cse:policy:list
list
-
-
cse:governance:get
-

授权项	访问级别	资源类型（*为必须）	条件键	别名	依赖的授权项
cse:policy:list	list	-	-	cse:governance:get	-

URI

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

表1 路径参数
参数	是否必选	参数类型	描述
project_id	是	String	租户子项目的唯一标识。字符长度为1~64。
kind	是	String	治理策略类型。

请求参数

表2 请求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。
x-environment	否	String	所属环境。

响应参数

状态码： 200

表3 响应Body参数
参数	参数类型	描述
[数组元素]	Array of GovPolicyDetail objects	查询治理策略列表响应结构体。

表4 GovPolicyDetail
参数	参数类型	描述
matchGroup	CreateBussinessScene object	流量定义。
policies	Array of policies objects	治理策略定义。

表5 CreateBusinessScene
参数	参数类型	描述
name	String	流量名称。
status	String	启用状态。取值范围： enabled：启用流量。 disabled：禁用流量。
selector	GovSelector object	治理策略下发范围。
spec	spec object	流量特征描述。

表6 spec
参数	参数类型	描述
alias	String	特征名称。
matches	Array of matches objects	匹配条件定义。

表7 matches
参数	参数类型	描述
name	String	条件名称。
apiPath	Object	匹配的PATH。
headers	Object	匹配的Headers。
method	Array of strings	匹配的Method列表。
serviceName	String	匹配的微服务名称。

表8 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	治理策略定义内容。

表9 GovSelector
参数	参数类型	描述
environment	String	所属环境。
app	String	所属应用。
service	String	可选，治理下发到微服务级别。

状态码： 400

**表10** 响应Body参数
参数	参数类型	描述
error_code	String	错误码。
error_msg	String	错误信息。
detail	String	详细定位信息。

请求示例

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

响应示例

状态码： 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" : { }
  } ]
} ]