Querying Custom Security Policies

Function

This API is used to query custom security policies.

Constraints

This API has the following constraints:

Parameters marker, limit, and page_reverse are used for pagination query.
Parameters marker and page_reverse take effect only when they are used together with parameter limit.

Calling Method

For details, see Calling APIs.

URI

GET /v3/{project_id}/elb/security-policies

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Definition: Specifies the project ID. For details about how to obtain a project ID, see Obtaining a Project ID. Constraints: N/A Range: The value can contain a maximum of 32 characters, including digits and lowercase letters. Default value: N/A

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
marker	No	String	Definition: Specifies the ID of the last record on the previous page. Constraints: This parameter must be used together with limit. If the parameter is not specified, only resources on the first page are queried. This parameter cannot be left blank or set to an invalid ID. Range: N/A Default value: N/A
limit	No	Integer	Definition: Specifies the number of records returned on each page. Constraints: N/A Range: 0 to 2000 Default value: 2000
page_reverse	No	Boolean	Definition: Specifies whether to use reverse query. Constraints: This parameter must be used together with limit. If page_reverse is set to true and you want to query the resources on the previous page, set the value of marker to the value of previous_marker. Range: true: Query resources on the previous page. false: Query resources on the next page. Default value: false
id	No	Array of strings	Definition: Specifies the ID of the custom security policy. Multiple IDs can be used for query in the format of id=xxx&id=xxx. Constraints: N/A Range: N/A Default value: N/A
name	No	Array of strings	Definition: Specifies the name of the custom security policy. Multiple names can be used for query in the format of name=xxx&name=xxx. Constraints: N/A Range: N/A Default value: N/A
description	No	Array of strings	Definition: Specifies the description of the custom security policy. Multiple descriptions can be used for query in the format of description=xxx&description=xxx. Constraints: N/A Range: N/A Default value: N/A
protocols	No	Array of strings	Definition: Specifies the TLS protocols of the custom security policy. Multiple protocols are separated by spaces. Multiple protocols can be used for query in the format of protocols=xxx&protocols=xxx. Constraints: N/A Range: N/A Default value: N/A
ciphers	No	Array of strings	Specifies the cipher suites supported by the custom security policy. Multiple cipher suites are separated using colons. Multiple cipher suites can be used for query in the format of ciphers=xxx&ciphers=xxx. Constraints: N/A Range: N/A Default value: N/A

Request Parameters

**Table 3** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	Definition: Specifies the token used for IAM authentication. Constraints: N/A Range: N/A Default value: N/A

Response Parameters

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
security_policies	Array of SecurityPolicy objects	Definition: Lists the security policies.
request_id	String	Definition: Specifies the request ID. Range: The value is automatically generated, and can contain characters including digits, lowercase letters, and hyphens (-).
page_info	PageInfo object	Definition: Specifies the pagination information.

**Table 5** SecurityPolicy
Parameter	Type	Description
id	String	Definition: Specifies the ID of the custom security policy. Range: N/A
project_id	String	Definition: Specifies the project ID of the custom security policy. Range: N/A
name	String	Definition: Specifies the name of the custom security policy. Range: N/A
description	String	Definition: Provides supplementary information about the custom security policy. Range: N/A
listeners	Array of ListenerRef objects	Definition: Specifies the listeners that use the custom security policies.
protocols	Array of strings	Definition: Lists the TLS protocols supported by the custom security policy. Range: N/A
ciphers	Array of strings	Definition: Lists the cipher suites supported by the custom security policy. Range: N/A
created_at	String	Definition: Specifies the creation time. Range: The value must be a UTC time in the yyyy-MM-dd'T'HH:mm:ss'Z' format.
updated_at	String	Definition: Specifies the update time. Range: The value must be a UTC time in the yyyy-MM-dd'T'HH:mm:ss'Z' format.

**Table 6** ListenerRef
Parameter	Type	Description
id	String	Definition: Specifies the listener ID. Range: N/A

**Table 7** PageInfo
Parameter	Type	Description
previous_marker	String	Definition: Specifies the ID of the first record in the pagination query result. If page_reverse is set to true, this parameter is used together to query resources on the previous page. Range: N/A
next_marker	String	Definition: Specifies the ID of the last record in the pagination query result. It is usually used to query resources on the next page. Range: N/A
current_count	Integer	Definition: Specifies the number of records returned on the current page. Range: N/A

Example Requests

Querying custom security policies on each page

GET https://{ELB_Endpoint}/v3/7a9941d34fc1497d8d0797429ecfd354/elb/security-policies?limit=2

Example Responses

Status code: 200

Successful request.

{
  "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"
  }, {
    "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"
  } ],
  "page_info" : {
    "next_marker" : "04e5d426-628c-42db-867c-fcaefbed2cab",
    "previous_marker" : "03cf511a-d130-445e-9b02-12d7049ddabf",
    "current_count" : 2
  }
}