查询IPS白名单列表详情 - ListIpsWhitelists
功能介绍
查询IPS白名单列表详情
调用方法
请参见如何调用API。
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权,具体权限要求请参见权限和授权项。
- 如果使用身份策略授权,当前API调用无需身份策略权限。
URI
GET /v1/{project_id}/cfw/{fw_instance_id}/ips/whitelist
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| project_id | 是 | String | 参数解释: 项目ID,用于明确项目归属,配置后可通过该ID查询项目下资产,可以从调API处获取,也可以从控制台获取。项目ID获取方式 约束限制: 不涉及 取值范围: 32位UUID 默认取值: 不涉及 |
| fw_instance_id | 是 | String | 参数解释: 防火墙ID,用户创建防火墙实例后产生的唯一ID,配置后可区分不同防火墙,可通过防火墙ID获取方式获取 约束限制: 不涉及 取值范围: 36位UUID 默认取值: 不涉及 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| source_address | 否 | String | 参数解释: 白名单源地址 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
| dest_address | 否 | String | 参数解释: 目的地址 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
| name | 否 | String | 参数解释: 白名单名称 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
| limit | 是 | Integer | 参数解释: 每页大小 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
| offset | 是 | Integer | 参数解释: 偏移量 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
请求参数
无
响应参数
状态码:200
| 参数 | 参数类型 | 描述 |
|---|---|---|
| data | ListIpsWhiteListsVO object | 参数解释: IPS白名单响应体 取值范围: 不涉及 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| limit | Integer | 参数解释: 每页数量 取值范围: 不涉及 |
| offset | Integer | 参数解释: 偏移量 取值范围: 不涉及 |
| total | Long | 参数解释: 总数 取值范围: 不涉及 |
| records | Array of IpsWhiteListVO objects | 参数解释: IPS白名单列表 取值范围: 不涉及 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| source_address | String | 参数解释: 白名单源地址 取值范围: 不涉及 |
| dest_address | String | 参数解释: 目的地址 取值范围: 不涉及 |
| name | String | 参数解释: 白名单名称 取值范围: 不涉及 |
| list_id | String | 参数解释: IPS白名单ID 取值范围: 不涉及 |
| effective_scopes | Array of strings | 参数解释: 生效范围:NAT EIP VPC HCS场景中还有VGW信息 取值范围: 不涉及 |
| ips_id | String | 参数解释: 生效范围:IPS规则ID,all代表所有IPS 取值范围: 不涉及 |
| ip_version | Integer | 参数解释: IP类型 取值范围: 4:表示IP类型为IPv4 6:表示IP类型为IPv6 |
| description | String | 参数解释: 白名单描述 取值范围: 不涉及 |
状态码:400
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 参数解释: 错误码 取值范围: 不涉及 |
| error_msg | String | 参数解释: 错误描述 取值范围: 不涉及 |
请求示例
查询项目ID为eefb11b22d5944f2aa067954516df1cf,防火墙实例ID为175572ed-67e8-4837-9776-e2e07080ea45的IPS白名单列表
https://{Endpoint}/v1/eefb11b22d5944f2aa067954516df1cf/cfw/175572ed-67e8-4837-9776-e2e07080ea45/ips/whitelist?limit=1024&offset=0 响应示例
状态码:200
返回值
{
"data" : {
"limit" : 1024,
"offset" : 0,
"total" : 2,
"records" : [ {
"source_address" : "0.0.0.0/0",
"dest_address" : "0.0.0.0/0",
"name" : "test-001",
"list_id" : "76fad07b-8304-486f-b802-943be05a3122",
"effective_scopes" : [ "EIP" ],
"ip_version" : 4
}, {
"source_address" : "8.8.8.0/32",
"dest_address" : "8.8.8.0/32",
"name" : "test-002",
"list_id" : "4bf99009-e595-4cd4-bde1-e88c18861ec5",
"effective_scopes" : [ "EIP" ],
"ip_version" : 4
} ]
}
} SDK代码示例
SDK代码示例如下。
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 | package com.huaweicloud.sdk.test; import com.huaweicloud.sdk.core.auth.ICredential; import com.huaweicloud.sdk.core.auth.BasicCredentials; import com.huaweicloud.sdk.core.exception.ConnectionException; import com.huaweicloud.sdk.core.exception.RequestTimeoutException; import com.huaweicloud.sdk.core.exception.ServiceResponseException; import com.huaweicloud.sdk.cfw.v1.region.CfwRegion; import com.huaweicloud.sdk.cfw.v1.*; import com.huaweicloud.sdk.cfw.v1.model.*; public class ListIpsWhitelistsSolution { public static void main(String[] args) { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment String ak = System.getenv("CLOUD_SDK_AK"); String sk = System.getenv("CLOUD_SDK_SK"); String projectId = "{project_id}"; ICredential auth = new BasicCredentials() .withProjectId(projectId) .withAk(ak) .withSk(sk); CfwClient client = CfwClient.newBuilder() .withCredential(auth) .withRegion(CfwRegion.valueOf("<YOUR REGION>")) .build(); ListIpsWhitelistsRequest request = new ListIpsWhitelistsRequest(); request.withFwInstanceId("{fw_instance_id}"); try { ListIpsWhitelistsResponse response = client.listIpsWhitelists(request); System.out.println(response.toString()); } catch (ConnectionException e) { e.printStackTrace(); } catch (RequestTimeoutException e) { e.printStackTrace(); } catch (ServiceResponseException e) { e.printStackTrace(); System.out.println(e.getHttpStatusCode()); System.out.println(e.getRequestId()); System.out.println(e.getErrorCode()); System.out.println(e.getErrorMsg()); } } } |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 | # coding: utf-8 import os from huaweicloudsdkcore.auth.credentials import BasicCredentials from huaweicloudsdkcfw.v1.region.cfw_region import CfwRegion from huaweicloudsdkcore.exceptions import exceptions from huaweicloudsdkcfw.v1 import * if __name__ == "__main__": # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak = os.environ["CLOUD_SDK_AK"] sk = os.environ["CLOUD_SDK_SK"] projectId = "{project_id}" credentials = BasicCredentials(ak, sk, projectId) client = CfwClient.new_builder() \ .with_credentials(credentials) \ .with_region(CfwRegion.value_of("<YOUR REGION>")) \ .build() try: request = ListIpsWhitelistsRequest() request.fw_instance_id = "{fw_instance_id}" response = client.list_ips_whitelists(request) print(response) except exceptions.ClientRequestException as e: print(e.status_code) print(e.request_id) print(e.error_code) print(e.error_msg) |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 | package main import ( "fmt" "github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic" cfw "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/cfw/v1" "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/cfw/v1/model" region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/cfw/v1/region" ) func main() { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak := os.Getenv("CLOUD_SDK_AK") sk := os.Getenv("CLOUD_SDK_SK") projectId := "{project_id}" auth, err := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). WithProjectId(projectId). SafeBuild() if err != nil { fmt.Println(err) return } hcClient, err := cfw.CfwClientBuilder(). WithRegion(region.ValueOf("<YOUR REGION>")). WithCredential(auth). SafeBuild() if err != nil { fmt.Println(err) return } client := cfw.NewCfwClient(hcClient) request := &model.ListIpsWhitelistsRequest{} request.FwInstanceId = "{fw_instance_id}" response, err := client.ListIpsWhitelists(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。
状态码
| 状态码 | 描述 |
|---|---|
| 200 | 返回值 |
| 400 | Bad Request |
错误码
请参见错误码。