You need to enable JavaScript to run this app.
导航
DescribeControlPolicyByRuleId - 根据访问控制规则ID查询访问控制规则
最近更新时间:2024.07.15 11:06:25首次发布时间:2024.03.28 17:09:34

根据访问控制规则 ID 查询访问控制规则。

请求说明

  • 请求方式:POST
  • 请求地址:https://open.volcengineapi.com/?Action=DescribeControlPolicyByRuleId&Version=2021-09-06

调试

请求参数

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

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

DescribeControlPolicyByRuleId

要执行的操作,取值:DescribeControlPolicyByRuleId。

Version
String

2021-09-06

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

Direction
String

in

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

  • in:外对内流量访问控制
  • out:内对外流量访问控制
RuleIds
Array of String

["f04ac7ce-628b-4cb7-be61-310222b7****"]

访问控制策略唯一标识列表。

返回参数

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

参数
类型
示例值
描述
Data
Array of Object

参见结构示例值

返回的访问控制规则数据。

请求示例

POST /?Action=DescribeControlPolicyByRuleId&Version=2021-09-06 HTTP/1.1
Host: open.volcengineapi.com
Content-Type: application/json; charset=UTF-8
X-Date: 20240711T073849Z
X-Content-Sha256: 287e874e******d653b44d21e
Authorization: HMAC-SHA256 Credential=Adfks******wekfwe/20240711/cn-beijing/fw_center/request, SignedHeaders=host;x-content-sha256;x-date, Signature=47a7d934ff7b37c03938******cd7b8278a40a1057690c401e92246a0e41085f

{
  "Direction": "in",
  "RuleIds": [
  "fe6b5edc-8c54-40b6-9a85-*****"
  ]
}

返回示例

{
  "ResponseMetadata": {
    "RequestId": "20240711154056114218192215D28F74",
    "Action": "DescribeControlPolicyByRuleId",
    "Version": "2021-09-06",
    "Service": "fw_center",
    "Region": "cn-beijing"
  },
  "Result": {
    "Data": [
      {
        "AccountId": "*****",
        "Direction": "in",
        "RuleId": "fe6b5edc-8c54-40b6-9a85-*****",
        "Prio": 1,
        "Proto": "TCP",
        "Action": "monitor",
        "Status": true,
        "HitCnt": 2,
        "Description": "10087观察",
        "Source": "0.0.0.0/0",
        "SourceType": "net",
        "SourceGroupType": "",
        "Destination": "10.249.**.**",
        "DestinationType": "net",
        "DestinationGroupType": "",
        "DestPort": "10087",
        "DestPortType": "port",
        "DestPortGroupType": "",
        "SourceCidrList": [
          "0.0.0.0/0"
        ],
        "DestinationCidrList": [
          "10.249.**.**"
        ],
        "DestPortList": [
          "10087"
        ],
        "UseCount": 1
      }
    ]
  }
}

错误码

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

状态码
错误码
错误信息
说明
400
InvalidParameter
非法的参数。请检查%s。

请求中缺乏某个参数或者某个参数校验失败,请参考错误信息,根据 API 接口文档修改对应的参数。

400
BadRequest
错误的请求。请检查http请求或者联系管理员!

请求无法被正确地解析,请重新构建请求,或者通过工单联系相关人员进行处理。

500
InternalError
内部错误。请联系管理员!

请求过程中发生了一些非预期的错误,请通过工单联系相关人员进行处理。