Obtain information on security policy - DescribeSecurityPolicies

Overview

Obtain information of the security policy, the binding relationship can only obtain the binding relationship between the security policy and the traditional load balancer listener.

Definition

Public Parameters

Parameter Name	Type	Description Information	Required
Action	string	Corresponding API command name, the current API is `DescribeSecurityPolicies`.	Yes
PublicKey	string	The user's public key can be obtained from Console (opens in a new tab)	Yes
Signature	string	User signature generated based on public key and API command, see Signature Algorithm	Yes

Request Parameters

Parameter Name	Type	Description Information	Required
Region	string	Region. See List of Regions and Availability Zones	Yes
ProjectId	string	Project ID. If not filled in, the default project is used, sub-accounts must be filled in. Please refer to the GetProjectList interface.	Yes
SecurityPolicyId	string	Security Policy ID	No
Limit	int	Data Pagination Value	No
Offset	int	Data Offset	No

Response Field

Field Name	Type	Description Information	Required
RetCode	int	Return status code. If it is 0, it means successful return. If it is not 0, it means failure.	Yes
Action	string	Operation command name.	Yes
Message	string	Returns an error message, providing detailed description when `RetCode` is non-zero.	No
DataSet	array[SecurityPolicy]	Security policy list, each parameter is detailed in SecurityPolicy.	No
TotalCount	int	Total number of security policies that meet the conditions	No

Data Model

SecurityPolicy

Field Name	Type	Description Information	Required
SecurityPolicyId	string	Security Policy ID	Yes
SecurityPolicyName	string	Security Policy Name	Yes
TLSVersion	string	Minimum TLS Version	Yes
SSLCiphers	array[string]	Encryption Suite	Yes
SecurityPolicyType	int	Security policy type 0: Predefined 1: Custom	Yes
VServerSet	array[BindVServerInfo]	Associated Listener	Yes

BindVServerInfo

Field Name	Type	Description Information	Required
VServerId	string	Bound VServerId	Yes
VServerName	string	Bound VServer Name	Yes
Port	int	VServer Port	Yes
ULBId	string	ID of ULB	Yes

Example

Request Example

https://api.surfercloud.com/?Action=DescribeSecurityPolicies
&Region=cn-bj2
&ProjectId=project-XXXXX
&SecurityPolicyId=security-XXXXX
&Limit=2
&Offset=8

Response Example

{
  "Action": "DescribeSecurityPoliciesResponse",
  "DataSet": [
    {
      "SSLCiphers": [
        "ECDHE-ECDSA-AES128-SHA256"
      ],
      "SecurityPolicyId": "security-XXXXX",
      "SecurityPolicyName": "new-security",
      "SecurityPolicyType": 1,
      "TLSVersion": "TLSv1.2",
      "VServerSet": [
        {
          "Port": 443,
          "ULBId": "ulb-XXXXX",
          "VServerId": "vserver-XXXXX",
          "VServerName": "443"
        }
      ]
    }
  ],
  "RetCode": 0,
  "TotalCount": 1
}

DescribeSSL CreateSSL