You need to enable JavaScript to run this app.
导航

DescribeControlPolicy - 查询互联网边界流量控制网关策略

最近更新时间2024.03.28 17:09:34

首次发布时间2024.03.28 17:09:34

查询互联网边界流量控制网关策略

调试

请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数

参数
类型
是否必填
示例值
描述
Action
String

DescribeControlPolicy

要执行的操作,取值:DescribeControlPolicy

Version
String

2021-09-06

API的版本,取值:2021-09-06

PageSize
Integer

10

分页大小

PageNumber
Integer

1

当前页码

Direction
String

in

访问控制策略的流量方向。取值:

  • in:外对内流量访问控制
  • out:内对外流量访问控制
Source
String

192.168.0.1/32

访问控制策略的源地址,支持模糊查询

Destination
String

192.168.0.2/32

访问控制策略的目的地址,支持模糊查询

Proto
Array of String

["ICMP"]

协议

Action
Array of String

["accept"]

访问控制策略的动作

Status
Array of Boolean

[false]

访问控制策略的状态

RuleId
String

f04ac7ce-628b-4cb7-be61-310222b7****

规则ID

Description
String

test

描述信息

返回参数

下表仅列出本接口特有的返回参数。更多信息请参见返回结构

参数
类型
示例值
描述
TotalCount
Integer

1

返回数据总数量
当查询数据为空时,且使用python SDK调用时此项为None

PageSize
Integer

1

返回数据的分页大小

PageNumber
Integer

1

返回数据的当前页码

Count
Integer

1

返回数据的实际数量
当查询数据为空时,且使用python SDK调用时此项为None

Data
Array of DescribeControlPolicyStructure

返回的访问控制规则数据

请求示例

POST /DescribeControlPolicy HTTP/1.1

{
  "Direction": "in",
  "PageSize": 10,
  "PageNumber": 1,
  "Source": "192.168.3.1/32",
  "Destination": "192.168.3.2/32",
  "Proto": [
    "UDP"
  ],
  "Action": [
    "accept"
  ]
}

返回示例

{
    "ResponseMetadata":{
        "RequestID":"202310091*****",
        "Service":"",
        "Region":"",
        "Action":"DescribeControlPolicy",
        "Version":"2021-09-06"
    },
    "Result":{
        "TotalCount":1,
        "PageSize":10,
        "PageNumber":1,
        "Count":1,
        "Data":[
            {
                "AccountId":"21**********",
                "Direction":"in",
                "RuleId":"518a4d41-*****",
                "Prio":1,
                "Proto":"UDP",
                "Action":"accept",
                "Status":false,
                "HitCnt":0,
                "Description":"test",
                "Source":"192.168.3.1/32",
                "SourceType":"net",
                "SourceGroupType":"",
                "Destination":"192.168.3.2/32",
                "DestinationType":"net",
                "DestinationGroupType":"",
                "DestPort":"22",
                "DestPortType":"port",
                "DestPortGroupType":"",
                "SourceCidrList":[
                    "192.168.3.1/32"
                ],
                "DestinationCidrList":[
                    "192.168.3.2/32"
                ],
                "DestPortList":[
                    "22"
                ],
                "UseCount":1
            }
        ]
    }
}

错误码

下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。

状态码
错误码
错误信息
说明
400
InvalidParameter
Invalid Parameter

无效的参数

400
QueryDbFailed
Query configuration failed

查询数据库失败

400
BadRequest
The http request is bad due to some reason: %s.

由于某些原因,http请求不正确

400
MissingParameter
The required parameter %s is missing.

缺少所需的参数

500
InternalError
Internal service error. %s

内部服务错误