ListFlowRules - 获取流控规则列表 - 微服务引擎MSE

获取流控规则列表。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

mse:ListFlowRules

list

*全部资源

*

无

请求参数

名称	类型	必填	描述	示例值
Namespace	string	是	命名空间。	default
AppName	string	是	应用名称。	xx-demo
ResourceSearchKey	string	否	搜索关键字。	/a
AppId	string	否	应用 ID。	hkhon1po62@c3df23522******
Resource	string	否	资源名。	/a
PageIndex	integer	否	目标页号，默认为 1	1
PageSize	integer	否	分页，每页 N 个。	10
AcceptLanguage	string	否	返回信息的语言类型： zh：中文 en：英文	zh

返回参数

名称	类型	描述	示例值
	object
Code	integer	状态码。	200
Message	string	响应信息。	请求处理成功
RequestId	string	请求 ID。	316F5F64-F73D-42DC-8632-01E308B6****
Success	boolean	请求结果。枚举值： true : 请求成功 false : 请求失败	true
Data	object	节点数据。
Result	array<object>	返回集合。
	array<object>	数据结构。
Namespace	string	命名空间。	default
RuleId	integer	规则 ID	2
AppName	string	应用名。	finance
Resource	string	接口资源名	/a
ResourceType	integer	接口资源分类	1
ControlBehavior	integer	流控效果。枚举值： 0 : 快速失败 2 : 排队等待	0
MaxQueueingTimeMs	integer	流控效果为排队等待时对应的超时时间，单位毫秒。	500
Threshold	number	流控规则阈值。	10
Enable	boolean	规则启用状态。枚举值： true : 启用 false : 关闭	true
AppId	string	应用 ID。	hkhon1po62@5f1b08becb*****
RegionId	string	地域 ID。	cn-hangzhou
FallbackObject	string	流控行为。	"{\"appName\":\"spring-cloud-a\",\"fallbackBehavior\":{\"webFallbackMode\":0,\"webRespContentType\":0,\"webRespMessage\":\"Blocked\",\"webRespStatusCode\":429},\"id\":977,\"name\":\"Fallback\",\"namespace\":\"default\",\"resourceClassification\":1}"
MetricType	integer	统计维度，1 表示通过请求数。	1
TrafficTags	object	预留字段。	{\"origin\":\"default\"}
LimitApp	string	请求来源应用。	spring-cloud-a
PageNumber	integer	页码。	1
PageSize	integer	分页大小。	10
TotalSize	integer	总条数。	11
HttpStatusCode	integer	HTTP 状态码。	200

示例

正常返回示例

JSON格式

{
  "Code": 200,
  "Message": "请求处理成功",
  "RequestId": "316F5F64-F73D-42DC-8632-01E308B6****",
  "Success": true,
  "Data": {
    "Result": [
      {
        "Namespace": "default",
        "RuleId": 2,
        "AppName": "finance",
        "Resource": "/a",
        "ResourceType": 1,
        "ControlBehavior": 0,
        "MaxQueueingTimeMs": 500,
        "Threshold": 10,
        "Enable": true,
        "AppId": "hkhon1po62@5f1b08becb*****",
        "RegionId": "cn-hangzhou",
        "FallbackObject": "\"{\\\"appName\\\":\\\"spring-cloud-a\\\",\\\"fallbackBehavior\\\":{\\\"webFallbackMode\\\":0,\\\"webRespContentType\\\":0,\\\"webRespMessage\\\":\\\"Blocked\\\",\\\"webRespStatusCode\\\":429},\\\"id\\\":977,\\\"name\\\":\\\"Fallback\\\",\\\"namespace\\\":\\\"default\\\",\\\"resourceClassification\\\":1}\"",
        "MetricType": 1,
        "TrafficTags": {
          "test": "test",
          "test2": 1
        },
        "LimitApp": "spring-cloud-a"
      }
    ],
    "PageNumber": 1,
    "PageSize": 10,
    "TotalSize": 11
  },
  "HttpStatusCode": 200
}

错误码

HTTP status code	错误码	错误信息	描述
400	IllegalRequest	Invalid request:%s	非法请求： %s
400	InvalidParameter	Parameter error:%s	请求参数错误：%s
500	InternalError	Console error. Try again later:%s	控制台错误.稍后重试：%s
403	NoPermission	You are not authorized to perform this operation:%s	没有权限使用此接口：%s
404	NotFound	Not found:%s	资源不存在：%s

访问错误中心查看更多错误码。

变更历史

更多信息，参考变更详情。