查询指定类型治理策略列表
功能介绍
查询指定类型治理策略列表。
调试
您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。
URI
GET /v3/{project_id}/govern/governance/{kind}
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
project_id |
是 |
String |
租户子项目的唯一标识。字符长度为1~64。 |
kind |
是 |
String |
治理策略类型。 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
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
参数 |
参数类型 |
描述 |
|---|---|---|
[数组元素] |
Array of GovPolicyDetail objects |
查询治理策略列表响应结构体。 |
参数 |
参数类型 |
描述 |
|---|---|---|
matchGroup |
CreateBussinessScene object |
流量定义。 |
policies |
Array of policies objects |
治理策略定义。 |
参数 |
参数类型 |
描述 |
|---|---|---|
name |
String |
流量名称。 |
status |
String |
启用状态，支持enabled和disabled。 缺省值：enabled |
selector |
GovSelector object |
治理策略下发范围。 |
spec |
spec object |
流量特征描述。 |
参数 |
参数类型 |
描述 |
|---|---|---|
name |
String |
条件名称。 |
apiPath |
Object |
匹配的PATH。 |
headers |
Object |
匹配的Headers。 |
method |
Array of strings |
匹配的Method列表。 |
serviceName |
String |
匹配的微服务名称。 |
参数 |
参数类型 |
描述 |
|---|---|---|
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 |
治理策略定义内容。 |
状态码： 400
参数 |
参数类型 |
描述 |
|---|---|---|
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" : { }
} ]
} ]
状态码
状态码 |
描述 |
|---|---|
200 |
查询指定类型治理策略列表响应结构体。 |
400 |
错误的请求。 |
错误码
请参见错误码。
