获取流控规则列表。
调试
您可以在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 |
返回参数
示例
正常返回示例
JSON
格式
{
"Code": 200,
"Message": "请求处理成功",
"RequestId": "316F5F64-F73D-42DC-8632-01E308B6****",
"Success": true,
"Data": {
"Result": [
{
"Namespace": "default",
"RuleId": 2,
"AppName": "finance",
"Resource": "/a",
"ResourceType": 0,
"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
}
}
],
"PageNumber": 1,
"PageSize": 10,
"TotalSize": 11
},
"HttpStatusCode": 200
}
错误码
HTTP status code | 错误码 | 错误信息 | 描述 |
---|---|---|---|
400 | IllegalRequest | Invalid request:%s | 非法请求: %s |
400 | InvalidParameter | Parameter error:%s | 请求参数错误:%s |
403 | NoPermission | You are not authorized to perform this operation:%s | 没有权限使用此接口:%s |
404 | NotFound | Not found:%s | 资源不存在:%s |
500 | InternalError | Console error. Try again later:%s | 控制台错误.稍后重试:%s |
访问错误中心查看更多错误码。
变更历史
变更时间 | 变更内容概要 | 操作 |
---|---|---|
2023-12-19 | OpenAPI 返回结构发生变更 | 查看变更详情 |