查询流量规则
接口功能介绍
查询流量规则
接口约束
无
URI
GET /v4/ec/traffic-rule/list
路径参数
无
Query参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| policyID | 是 | String | 流量策略ID | 25420584-fe8f-49b0-9e09-ef915caeee10 | |
| ipProtocol | 否 | Integer | 协议类型，取值如下： 0:"全部协议" 1:"ICMP" 2:"IGMP" 6:"TCP" 17:"UDP" |
6 |
请求参数
请求头header参数
无
请求body参数
无
响应参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| statusCode | 否 | Integer | 返回状态码 取值范围: 800:成功 900:失败 |
800 | |
| errorCode | 否 | String | 业务细分码，为product.module.code三段式码 | ||
| message | 否 | String | 失败时的错误描述，一般为英文描述 | ||
| description | 否 | String | 失败时的错误描述，一般为中文描述 | ||
| traceID | 否 | String | 链路追踪ID | 74cb2e66-1f95-45da-aac5-ee013470fd96 | |
| returnObj | 否 | Object | 返回参数 | returnObj |
表returnObj
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| currentCount | 否 | Integer | 当前页记录数 | 3 | |
| totalPage | 否 | Integer | 总页数 | 1 | |
| totalCount | 否 | Integer | 查询的总记录数 | 3 | |
| results | 否 | Array of Objects | 返回查询结果，Json数组 | results |
表results
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| ruleID | 否 | String | 流量规则ID | 25420584-fe8f-49b0-9e09-ef915caeee10 | |
| ruleName | 否 | String | 流量规则名字 | rule-23idc4 | |
| policyID | 否 | String | 流量策略ID | 55450584-fe8f-49b0-9e09-ef915caeee10 | |
| policyName | 否 | String | 流量策略名称 | policy-93da33 | |
| weights | 否 | Integer | 权重值 | 100 | |
| srcIpCidr | 否 | String | 流量报文源网段 | 192.168.2.0/24 | |
| dstIpCidr | 否 | String | 流量报文目的网段 | 192.168.1.0/24 | |
| srcPort | 否 | String | 流量报文源端口 输入格式说明如下： 1/200：代表源端口范围1至200 80/80：代表源端口80 -1/-1：代表匹配任意源端口 -1不支持单独设置，仅支持设置为-1/-1 |
1/200 | |
| dstPort | 否 | String | 流量报文目的端口 输入格式说明如下： 1/200：代表源端口范围1至200 80/80：代表源端口80 -1/-1：代表匹配任意源端口 -1不支持单独设置，仅支持设置为-1/-1 |
1/200 | |
| ipProtocol | 否 | Integer | 标识数据携带的数据是何种协议，标识传输层地址或协议号，如1代表ICMP，6代表TCP，17代表UDP | 6 | |
| ruleDescription | 否 | String | 描述信息 | test | |
| createDate | 否 | String | 创建时间 | 2019-08-30 16:57:47 | |
| status | 否 | String | 状态，取值范围： running:正常 |
running |
请求示例
请求url
v4/ec/traffic-rule/list?policyID=82c40584-fe8f-49b0-9e09-ef915caeee10
请求头header
无
请求体body
无
响应示例
{
"description":"",
"errorCode":"",
"message":"",
"statusCode":800,
"traceID":"2062f2ab-6722-4273-9850-997b4398ddb5",
"returnObj":{
"totalCount":1,
"totalPage":1,
"currentCount":1,
"results":[
{
"ruleID": "25420584-fe8f-49b0-9e09-ef915caeee10",
"ruleName": "rule-23idc4",
"policyID": "55450584-fe8f-49b0-9e09-ef915caeee10",
"policyName": "policy-93da33",
"weights": 100,
"srcIpCidr": "192.168.2.0/24",
"dstIpCidr": "192.168.1.0/24",
"srcPort": "1/200",
"dstPort": "1/200",
"ipProtocol": 6,
"ruleDescription": "test",
"createDate": "2019-08-30 16:57:47",
"status": "running"
}
]
}
}
状态码
| 状态码 | 含义 |
|---|---|
| 200 | 请求成功 |
错误码
| errorCode | 含义 |
|---|---|
| Openapi.PatternCheck.NotValid | 请求参数无效 |
| Openapi.TrafficRuleEc.AccessFailed | 内部错误，请重试。如果多次尝试失败，请提交工单 |
