查詢指定輕量應用伺服器的防火牆規則。
介面說明
您可以透過此介面,查詢指定輕量應用伺服器的防火牆規則資訊,包括連接埠範圍、防火牆規則 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 server default port |
| 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 |
| InstanceId |
string |
樣本
正常返回樣本
JSON格式
{
"TotalCount": 4,
"RequestId": "20758A-585D-4A41-A9B2-28DA8F4F534F",
"PageSize": 10,
"PageNumber": 1,
"FirewallRules": [
{
"Remark": "Test - MySQL server default port",
"Port": "3306",
"RuleId": "eeea34d9867b4d55a4ff8d5fcfbd****",
"RuleProtocol": "TCP",
"Policy": "accept",
"Tags": [
{
"Key": "TestKey",
"Value": "TestValue"
}
],
"SourceCidrIp": "0.0.0.0/0",
"InstanceId": ""
}
]
}
錯誤碼
|
HTTP status code |
錯誤碼 |
錯誤資訊 |
描述 |
|---|---|---|---|
| 400 | RegionIdNotMatchHost | The parameter regionId does not match the endpoint host. | |
| 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. |
訪問錯誤中心查看更多錯誤碼。
變更歷史
更多資訊,參考變更詳情。