Queries custom security policies.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes ListSecurityPolicies

The operation that you want to perform. Set the value to ListSecurityPolicies.

ResourceGroupId String No rg-atstuj3rtop****

The ID of the resource group.

NextToken String No caeba0bbb2be03f84eb48b699f0a****

The position where the query starts. If this parameter is left empty, the query starts from the beginning.

MaxResults Integer No 50

The maximum number of entries to return. Valid values: 1 to 100. If you do not set this parameter, the default value 20 is used.

SecurityPolicyNames Array of String No test-secrity

Enter the names of security policies that you want to query. You can enter at most 10 names.

SecurityPolicyIds Array of String No scp-bp1bpn0kn9****

Enter the IDs of security policies that you want to query. You can enter at most 20 IDs.

Response parameters

Parameter Type Example Description
MaxResults Integer 50

The maximum number of entries returned.

NextToken String FFmyTO7****

The position where the query stopped. If the response does not contain this parameter, all data has been queried.

RequestId String 593B0448-D13E-4C56-AC0D-FDF0FDE0E9A3

The ID of the request.

SecurityPolicies Array of SecurityPolicy

The list of supported security policies.

Ciphers Array of String ECDHE-ECDSA-AES128-SHA

The supported cipher suites, which are determined by the TLS protocol version.

The specified cipher suites must be supported by at least one TLS protocol version that you select. For example, if you set the TLSVersions parameter to TLSv1.3, you can specify only cipher suites that are supported by this protocol version.

  • TLSv1.0 and TLSv1.1 support the following cipher suites:
    • ECDHE-ECDSA-AES128-SHA
    • ECDHE-ECDSA-AES256-SHA
    • ECDHE-RSA-AES128-SHA
    • ECDHE-RSA-AES256-SHA
    • AES128-SHA
    • AES256-SHA
    • DES-CBC3-SHA
  • TLSv1.2 supports the following cipher suites:
    • ECDHE-ECDSA-AES128-SHA
    • ECDHE-ECDSA-AES256-SHA
    • ECDHE-RSA-AES128-SHA
    • ECDHE-RSA-AES256-SHA
    • AES128-SHA
    • AES256-SHA
    • DES-CBC3-SHA
    • ECDHE-ECDSA-AES128-GCM-SHA256
    • ECDHE-ECDSA-AES256-GCM-SHA384
    • ECDHE-ECDSA-AES128-SHA256
    • ECDHE-ECDSA-AES256-SHA384
    • ECDHE-RSA-AES128-GCM-SHA256
    • ECDHE-RSA-AES256-GCM-SHA384
    • ECDHE-RSA-AES128-SHA256
    • ECDHE-RSA-AES256-SHA384
    • AES128-GCM-SHA256
    • AES256-GCM-SHA384
    • AES128-SHA256
    • AES256-SHA256
  • TLSv1.3 supports the following cipher suites:
    • 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
ResourceGroupId String rg-atstuj3rtop****

The ID of the resource group.

SecurityPolicyId String rg-atstuj3rtop****

The ID of the security policy.

SecurityPolicyName String test-secrity

The name of the security policy.

The name must be 2 to 128 characters in length and must start with a letter. It can contain digits, periods (.), underscores (_), and hyphens (-).

SecurityPolicyStatus String Available

The state of the security policy. Valid values:

  • Configuring: The security policy is being configured.
  • Available: The security policy is available.
TLSVersions Array of String TLSv1.1

The TLS protocol versions that are supported. Valid values: TLSv1.0, TLSv1.1, TLSv1.2 and TLSv1.3.

TotalCount Integer 1000

The total number of entries returned.

Examples

Sample requests

http(s)://[Endpoint]/?Action=ListSecurityPolicies
&ResourceGroupId=rg-atstuj3rtop****
&NextToken=caeba0bbb2be03f84eb48b699f0a****
&MaxResults=50
&SecurityPolicyNames=["test-secrity"]
&SecurityPolicyIds=["scp-bp1bpn0kn9****"]
&Common request parameters

Sample success responses

XML format

HTTP/1.1 200 OK
Content-Type:application/xml

<ListSecurityPoliciesResponse>
    <MaxResults>50</MaxResults>
    <NextToken>FFmyTO7****</NextToken>
    <RequestId>593B0448-D13E-4C56-AC0D-FDF0FDE0E9A3</RequestId>
    <SecurityPolicies>
        <Ciphers>ECDHE-ECDSA-AES128-SHA</Ciphers>
        <ResourceGroupId>rg-atstuj3rtop****</ResourceGroupId>
        <SecurityPolicyId>rg-atstuj3rtop****</SecurityPolicyId>
        <SecurityPolicyName>test-secrity</SecurityPolicyName>
        <SecurityPolicyStatus>Available</SecurityPolicyStatus>
        <TLSVersions>TLSv1.1</TLSVersions>
    </SecurityPolicies>
    <TotalCount>1000</TotalCount>
</ListSecurityPoliciesResponse>

JSON format

HTTP/1.1 200 OK
Content-Type:application/json

{
  "MaxResults" : 50,
  "NextToken" : "FFmyTO7****",
  "RequestId" : "593B0448-D13E-4C56-AC0D-FDF0FDE0E9A3",
  "SecurityPolicies" : [ {
    "Ciphers" : [ "ECDHE-ECDSA-AES128-SHA" ],
    "ResourceGroupId" : "rg-atstuj3rtop****",
    "SecurityPolicyId" : "rg-atstuj3rtop****",
    "SecurityPolicyName" : "test-secrity",
    "SecurityPolicyStatus" : "Available",
    "TLSVersions" : [ "TLSv1.1" ]
  } ],
  "TotalCount" : 1000
}

Error codes

For a list of error codes, visit the API Error Center.