文档

ListFlowRules - 获取流控规则列表

更新时间:

获取流控规则列表。

调试

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

授权信息

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

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
mse:ListFlowRulesList
  • 全部资源
    *

请求参数

名称类型必填描述示例值
Namespacestring

命名空间。

default
AppNamestring

应用名称。

xx-demo
ResourceSearchKeystring

搜索关键字。

/a
AppIdstring

应用 ID。

hkhon1po62@c3df23522******
Resourcestring

资源名。

/a
PageIndexinteger

目标页号,默认为 1

1
PageSizeinteger

分页,每页 N 个。

10
AcceptLanguagestring

返回信息的语言类型:

  • zh:中文
  • en:英文
zh

返回参数

名称类型描述示例值
object
Codeinteger

状态码。

200
Messagestring

响应信息。

请求处理成功
RequestIdstring

请求 ID。

316F5F64-F73D-42DC-8632-01E308B6****
Successboolean

请求结果。

枚举值:
  • true请求成功
  • false请求失败
true
Dataobject

节点数据。

Resultobject []

返回集合。

Namespacestring

命名空间。

default
RuleIdlong

规则 ID

2
AppNamestring

应用名。

finance
Resourcestring

接口资源名

/a
ControlBehaviorinteger

流控效果。

枚举值:
  • 0快速失败
  • 2排队等待
0
MaxQueueingTimeMsinteger

流控效果为排队等待时对应的超时时间,单位毫秒。

500
Thresholdfloat

流控规则阈值。

10
Enableboolean

规则启用状态。

枚举值:
  • true启用
  • false关闭
true
AppIdstring

应用 ID。

hkhon1po62@5f1b08becb*****
RegionIdstring

地域 ID。

cn-hangzhou
FallbackObjectstring

流控行为。

"{\"appName\":\"spring-cloud-a\",\"fallbackBehavior\":{\"webFallbackMode\":0,\"webRespContentType\":0,\"webRespMessage\":\"Blocked\",\"webRespStatusCode\":429},\"id\":977,\"name\":\"Fallback\",\"namespace\":\"default\",\"resourceClassification\":1}"
MetricTypeinteger

统计维度,1 表示通过请求数。

1
TrafficTagsobject

预留字段。

{\"origin\":\"default\"}
PageNumberinteger

页码。

1
PageSizeinteger

分页大小。

10
TotalSizeinteger

总条数。

11
HttpStatusCodeinteger

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": 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错误码错误信息描述
400IllegalRequestInvalid request:%s非法请求: %s
400InvalidParameterParameter error:%s请求参数错误:%s
403NoPermissionYou are not authorized to perform this operation:%s没有权限使用此接口:%s
404NotFoundNot found:%s资源不存在:%s
500InternalErrorConsole error. Try again later:%s控制台错误.稍后重试:%s

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

变更历史

变更时间变更内容概要操作
2023-12-19OpenAPI 返回结构发生变更看变更集
变更项变更内容
出参OpenAPI 返回结构发生变更
  • 本页导读 (1)
文档反馈