# 查询自定义安全策略列表 - ListSecurityPolicies #### 功能介绍 查询自定义安全策略列表。 #### 接口约束 - 分页查询使用的参数为marker、limit、page_reverse。 - marker和page_reverse只有和limit一起使用时才会生效，单独使用无效。 #### 调用方法 请参见[如何调用API](https://support.huaweicloud.com/api-elb/elb_dy_0000.html)。 #### 授权信息 账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。 - 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-elb/elb_sq_0001.html)。 - 如果使用身份策略授权，需具备如下身份策略权限。 | 授权项 | 访问级别 | 资源类型（\*为必须） | 条件键 | 别名 | 依赖的授权项 | |:---|:---|:---|:---|:---|:---| | elb:security-policies:list | List | securityPolicy \* | - | - | - | | elb:security-policies:list | List | - | g:EnterpriseProjectId | - | - | #### URI GET /v3/{project_id}/elb/security-policies 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | project_id | 是 | String | **参数解释** ：项目ID。获取方式请参见[获取项目ID](https://support.huaweicloud.com/api-elb/elb_fl_0008.html)。 **约束限制**：不涉及 **取值范围**：长度为32个字符，由小写字母和数字组成。 **默认取值**：不涉及 | 表2Query参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | marker | 否 | String | **参数解释**：上一页最后一条记录的ID。 **约束限制**： - 必须与limit一起使用。 - 不指定时表示查询第一页。 - 该字段不允许为空或无效的ID。 **取值范围**：不涉及 **默认取值**：不涉及 | | limit | 否 | Integer | **参数解释**：每页返回的个数。 **约束限制**：不涉及 **取值范围**：0-2000 **默认取值**：2000 | | page_reverse | 否 | Boolean | **参数解释**：是否反向查询。 **约束限制**： - 必须与limit一起使用。 - 当page_reverse=true时，若要查询上一页，marker取值为当前页返回值的previous_marker。 **取值范围**： - true：查询上一页。 - false：查询下一页。 **默认取值**：false | | id | 否 | Array of strings | **参数解释**：自定义安全策略的ID。 支持多值查询，查询条件格式：*id=xxx\&id=xxx*。 **约束限制**：不涉及 **取值范围**：不涉及 **默认取值**：不涉及 | | name | 否 | Array of strings | **参数解释**：自定义安全策略的名称。 支持多值查询，查询条件格式：*name=xxx\&name=xxx*。 **约束限制**：不涉及 **取值范围**：不涉及 **默认取值**：不涉及 | | description | 否 | Array of strings | **参数解释**：自定义安全策略的描述信息。 支持多值查询，查询条件格式：*description=xxx\&description=xxx*。 **约束限制**：不涉及 **取值范围**：不涉及 **默认取值**：不涉及 | | protocols | 否 | Array of strings | **参数解释**：空格分隔的自定义安全策略的TLS协议。 支持多值查询，查询条件格式：*protocols=xxx\&protocols=xxx*。 **约束限制**：不涉及 **取值范围**：不涉及 **默认取值**：不涉及 | | ciphers | 否 | Array of strings | **参数解释**：冒号分隔的自定义安全策略的加密套件。 支持多值查询，查询条件格式：*ciphers=xxx\&ciphers=xxx*。 **约束限制**：不涉及 **取值范围**：不涉及 **默认取值**：不涉及 | #### 请求参数 表3请求Header参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | X-Auth-Token | 是 | String | **参数解释**：IAM鉴权Token。 **约束限制**：不涉及 **取值范围**：不涉及 **默认取值**：不涉及 | #### 响应参数 **状态码：200** 表4响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | security_policies | Array of [SecurityPolicy] objects | **参数解释**：自定义安全策略列表返回对象。 | | request_id | String | **参数解释**：请求ID。 **取值范围**：由数字、小写字母和中划线（-）组成的字符串，自动生成。 | | page_info | [PageInfo] object | **参数解释**：分页信息。 | 表5SecurityPolicy | 参数 | 参数类型 | 描述 | |:---|:---|:---| | id | String | **参数解释**：自定义安全策略的ID。 **取值范围**：不涉及 | | project_id | String | **参数解释**：自定义安全策略的项目ID。 **取值范围**：不涉及 | | name | String | **参数解释**：自定义安全策略的名称。 **取值范围**：不涉及 | | description | String | **参数解释**：自定义安全策略的描述。 **取值范围**：不涉及 | | listeners | Array of [ListenerRef] objects | **参数解释**：关联的监听器。 | | protocols | Array of strings | **参数解释**：自定义安全策略的TLS协议列表。 **取值范围**：不涉及 | | ciphers | Array of strings | **参数解释**：自定义安全策略的加密套件列表。 **取值范围**：不涉及 | | enterprise_project_id | String | **参数解释**：资源所属的企业项目ID。 **取值范围**： - "0"：表示资源属于default企业项目。 - UUID格式的字符串，表示非默认企业项目。 | | created_at | String | **参数解释**：创建时间。 **取值范围**：格式：yyyy-MM-dd'T'HH:mm:ss'Z'，UTC时区。 | | updated_at | String | **参数解释**：更新时间。 **取值范围**：格式：yyyy-MM-dd'T'HH:mm:ss'Z'，UTC时区。 | 表6ListenerRef | 参数 | 参数类型 | 描述 | |:---|:---|:---| | id | String | **参数解释**：监听器ID。 **取值范围**：不涉及 | 表7PageInfo | 参数 | 参数类型 | 描述 | |:---|:---|:---| | previous_marker | String | **参数解释**：分页查询结果中第一条记录的ID。通常用于配合page_reverse=true查询上一页。 **取值范围**：不涉及 | | next_marker | String | **参数解释**：分页查询结果中最后一条记录的ID。通常用于查询下一页。 **取值范围**：不涉及 | | current_count | Integer | **参数解释**：当前页返回记录数。 **取值范围**：不涉及 | #### 请求示例 分页查询自定义安全策略列表 ``` GET https://{ELB_Endpoint}/v3/7a9941d34fc1497d8d0797429ecfd354/elb/security-policies?limit=2 ``` #### 响应示例 **状态码：200** 操作正常返回。 ``` { "request_id" : "88424a61-6fa1-4850-aa8b-ce31d78abcf2", "security_policies" : [ { "id" : "03cf511a-d130-445e-9b02-12d7049ddabf", "name" : "test_security_policy", "project_id" : "7a9941d34fc1497d8d0797429ecfd354", "description" : "", "protocols" : [ "TLSv1", "TLSv1.3" ], "ciphers" : [ "AES128-SHA", "TLS_AES_128_GCM_SHA256", "TLS_AES_256_GCM_SHA384", "TLS_CHACHA20_POLY1305_SHA256", "TLS_AES_128_CCM_SHA256", "TLS_AES_128_CCM_8_SHA256" ], "listeners" : [ { "id" : "6f7c0d75-81c4-4735-87a0-dc5df0f27f5a" } ], "created_at" : "2021-02-06T10:07:10Z", "updated_at" : "2021-02-06T10:07:10Z", "enterprise_project_id" : "0" }, { "id" : "04e5d426-628c-42db-867c-fcaefbed2cab", "name" : "update_securitypolicy", "project_id" : "7a9941d34fc1497d8d0797429ecfd354", "description" : "", "protocols" : [ "TLSv1.2", "TLSv1.1", "TLSv1.3" ], "ciphers" : [ "CAMELLIA128-SHA", "TLS_AES_256_GCM_SHA384", "TLS_CHACHA20_POLY1305_SHA256", "TLS_AES_128_CCM_SHA256", "TLS_AES_128_CCM_8_SHA256" ], "listeners" : [ { "id" : "e19b7379-807e-47fb-b53d-46aff540580c" } ], "created_at" : "2021-02-06T10:01:58Z", "updated_at" : "2021-03-20T07:18:59Z", "enterprise_project_id" : "0" } ], "page_info" : { "next_marker" : "04e5d426-628c-42db-867c-fcaefbed2cab", "previous_marker" : "03cf511a-d130-445e-9b02-12d7049ddabf", "current_count" : 2 } } ``` #### SDK代码示例 SDK代码示例如下。 - [Java] ``` 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.elb.v3.region.ElbRegion; import com.huaweicloud.sdk.elb.v3.*; import com.huaweicloud.sdk.elb.v3.model.*; public class ListSecurityPoliciesSolution { 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); ElbClient client = ElbClient.newBuilder() .withCredential(auth) .withRegion(ElbRegion.valueOf("")) .build(); ListSecurityPoliciesRequest request = new ListSecurityPoliciesRequest(); try { ListSecurityPoliciesResponse response = client.listSecurityPolicies(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()); } } } ``` - [Python] ``` # coding: utf-8 import os from huaweicloudsdkcore.auth.credentials import BasicCredentials from huaweicloudsdkelb.v3.region.elb_region import ElbRegion from huaweicloudsdkcore.exceptions import exceptions from huaweicloudsdkelb.v3 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 = ElbClient.new_builder() \ .with_credentials(credentials) \ .with_region(ElbRegion.value_of("")) \ .build() try: request = ListSecurityPoliciesRequest() response = client.list_security_policies(request) print(response) except exceptions.ClientRequestException as e: print(e.status_code) print(e.request_id) print(e.error_code) print(e.error_msg) ``` - [Go] ``` package main import ( "fmt" "github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic" elb "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/elb/v3" "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/elb/v3/model" region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/elb/v3/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 := elb.ElbClientBuilder(). WithRegion(region.ValueOf("")). WithCredential(auth). SafeBuild() if err != nil { fmt.Println(err) return } client := elb.NewElbClient(hcClient) request := &model.ListSecurityPoliciesRequest{} response, err := client.ListSecurityPolicies(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } ``` - [更多] 更多编程语言的SDK代码示例，请参见[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/ELB/sdk?api=ListSecurityPolicies&version=v3)的代码示例页签，可生成自动对应的SDK代码示例。 #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | 操作正常返回。 | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-elb/ErrorCode.html)。