文档

ListFirewallRules - 获取实例的防火墙规则

更新时间:

查询指定轻量应用服务器的防火墙规则。

接口说明

可您以通过此接口,查询指定轻量应用服务器的防火墙规则信息,包括端口范围、防火墙规则 ID、传输层协议等信息。

QPS 限制

本接口的单用户 QPS 限制为 10 次/分钟。超过限制,API 调用会被限流,这可能会影响您的业务,请合理调用。更多信息,请参见 QPS 限制

调试

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

授权信息

当前API暂无授权信息透出。

请求参数

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

指定的轻量应用服务器的实例 ID。

ace0706b2ac4454d984295a94213****
RegionIdstring

指定的轻量应用服务器所属的地域 ID。

cn-hangzhou
PageSizeinteger

分页查询时设置的每页行数。

最大值:100。

默认值:10。

10
PageNumberinteger

防火墙规则列表的页码。

起始值:1。

默认值:1。

1

返回参数

名称类型描述示例值
object
TotalCountinteger

防火墙规则的总条数。

4
RequestIdstring

请求 ID。

20758A-585D-4A41-A9B2-28DA8F4F534F
PageSizeinteger

分页查询时设置的每页行数。

10
PageNumberinteger

防火墙规则列表的页码。

1
FirewallRulesobject []

由防火墙规则信息组成的数组。

Remarkstring

防火墙规则的备注。

test-MySQL服务器默认端口
Portstring

端口范围。

3306
RuleIdstring

防火墙规则 ID。

eeea34d9867b4d55a4ff8d5fcfbd****
RuleProtocolstring

传输层协议。可能值:

  • TCP:TCP 协议。
  • UDP:UDP 协议。
  • TCP+UDP:TCP 和 UDP 协议。
TCP
Policystring

防火墙策略。

  • accept:允许。

  • drop:拒绝。

accept
SourceCidrIpstring

源 IP 段。

0.0.0.0/0

示例

正常返回示例

JSON格式

{
  "TotalCount": 4,
  "RequestId": "20758A-585D-4A41-A9B2-28DA8F4F534F",
  "PageSize": 10,
  "PageNumber": 1,
  "FirewallRules": [
    {
      "Remark": "test-MySQL服务器默认端口",
      "Port": "3306",
      "RuleId": "eeea34d9867b4d55a4ff8d5fcfbd****",
      "RuleProtocol": "TCP",
      "Policy": "accept",
      "SourceCidrIp": "0.0.0.0/0"
    }
  ]
}

错误码

HTTP status code错误码错误信息描述
400RegionIdNotMatchHostThe parameter regionId does not match the endpoint host.传入的regionId和请求的地址不匹配。
403InvalidParamThe specified parameter value is invalid.参数非法。
404InvalidInstanceId.NotFoundThe specified InstanceId does not exist.指定的实例不存在,请您检查实例ID是否正确。
500InternalErrorAn error occurred while processing your request.内部错误,请重试。如果多次尝试失败,请提交工单。

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

变更历史

变更时间变更内容概要操作
2023-05-25OpenAPI 描述信息更新、OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更看变更集
变更项变更内容
API 描述OpenAPI 描述信息更新
错误码OpenAPI 错误码发生变更
    删除错误码:400
    删除错误码:403
    删除错误码:404
    删除错误码:500
出参OpenAPI 返回结构发生变更
  • 本页导读 (1)
文档反馈