查询指定轻量应用服务器的防火墙规则。
接口说明
可您以通过此接口,查询指定轻量应用服务器的防火墙规则信息,包括端口范围、防火墙规则 ID、传输层协议等信息。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
|
操作 |
访问级别 |
资源类型 |
条件关键字 |
关联操作 |
|
swas-open:ListFirewallRules |
get |
FirewallRule
|
无 | 无 |
请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| InstanceId |
string |
是 |
指定的轻量应用服务器的实例 ID。 |
ace0706b2ac4454d984295a94213**** |
| RegionId |
string |
是 |
指定的轻量应用服务器所属的地域 ID。 |
cn-hangzhou |
| PageSize |
integer |
否 |
分页查询时设置的每页行数。 最大值:100。 默认值:10。 |
10 |
| PageNumber |
integer |
否 |
防火墙规则列表的页码。 起始值:1。 默认值:1。 |
1 |
| Tag |
array<object> |
否 |
防火墙规则的标签列表。 |
|
|
object |
否 |
标签。 |
||
| Key |
string |
否 |
防火墙规则的标签键。标签键长度的取值范围:1~64。N 的取值范围:1~20。 |
TestKey |
| Value |
string |
否 |
防火墙规则的标签值。标签值长度的取值范围:1~64。N 的取值范围:1~20。 |
TestValue |
| FirewallRuleId |
string |
否 |
防火墙规则 ID。 |
1a16263ab0f541288312a15fa64280de |
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
|||
| TotalCount |
integer |
防火墙规则的总条数。 |
4 |
| RequestId |
string |
请求 ID。 |
20758A-585D-4A41-A9B2-28DA8F4F534F |
| PageSize |
integer |
分页查询时设置的每页行数。 |
10 |
| PageNumber |
integer |
防火墙规则列表的页码。 |
1 |
| FirewallRules |
array<object> |
由防火墙规则信息组成的数组。 |
|
|
array<object> |
|||
| Remark |
string |
防火墙规则的备注。 |
test-MySQL服务器默认端口 |
| Port |
string |
端口范围。 |
3306 |
| RuleId |
string |
防火墙规则 ID。 |
eeea34d9867b4d55a4ff8d5fcfbd**** |
| RuleProtocol |
string |
传输层协议。可能值:
|
TCP |
| Policy |
string |
防火墙策略。
|
accept |
| Tags |
array<object> |
防火墙规则的标签列表。 |
|
|
object |
标签。 |
||
| Key |
string |
防火墙规则的标签键。 |
TestKey |
| Value |
string |
防火墙规则的标签值。 |
TestValue |
| SourceCidrIp |
string |
源 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",
"Tags": [
{
"Key": "TestKey",
"Value": "TestValue"
}
],
"SourceCidrIp": "0.0.0.0/0"
}
]
}
错误码
|
HTTP status code |
错误码 |
错误信息 |
描述 |
|---|---|---|---|
| 400 | RegionIdNotMatchHost | The parameter regionId does not match the endpoint host. | 传入的regionId和请求的地址不匹配。 |
| 500 | InternalError | An error occurred while processing your request. | 内部错误,请重试。如果多次尝试失败,请提交工单。 |
| 403 | InvalidParam | The specified parameter value is invalid. | 参数非法。 |
| 404 | InvalidInstanceId.NotFound | The specified InstanceId does not exist. | 指定的实例不存在,请您检查实例ID是否正确。 |
访问错误中心查看更多错误码。
变更历史
更多信息,参考变更详情。