Help Center/ Virtual Private Network/ API Reference (ME-Abu Dhabi Region)/ API/ S2C VPN APIs/ VPN Connection/ Querying the CIDR Block Negotiation Information of a VPN Connection
Updated on 2026-06-11 GMT+08:00

Querying the CIDR Block Negotiation Information of a VPN Connection

Function

This API is used to query the CIDR block negotiation information of a VPN connection based on the specified connection ID.

Calling Method

For details, see Calling APIs.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.

  • If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.
  • If you are using identity policy-based authorization, the following identity policy-based permissions are required.

Action

Access Level

Resource Type (*: required)

Condition Key

Alias

Dependencies

vpn:vpnConnections:listIpsecSa

read

vpnConnections

  • g:EnterpriseProjectId
  • g:ResourceTag/<tag-key>

-

-

URI

GET /v5/{project_id}/vpn-connection/{vpn_connection_id}/ipsec-sa

Table 1 Parameter description

Parameter

Type

Mandatory

Description

project_id

String

Yes

Specifies a project ID. You can obtain the project ID by referring to Obtaining the Project ID.

vpn_connection_id

String

Yes

Specifies a VPN connection ID.

Request

  • Request parameters

    None

  • Example request
    GET https://{Endpoint}/v5/{project_id}/vpn-connection/{vpn_connection_id}/ipsec-sa

Response

  • Response parameters

    Returned status code 200: successful operation

    Table 2 Parameters in the response body

    Parameter

    Type

    Description

    request_id

    String

    Specifies a request ID.

    sa_infos

    Array of SaInfo objects

    Specifies the SaInfo object.

    Table 3 SaInfo

    Parameter

    Type

    Description

    id

    String

    Specifies the CIDR block negotiation ID.

    source_ip_cidr

    String

    Specifies the source CIDR block.

    dest_ip_cidr

    String

    Specifies the destination CIDR block.

    packets_sent

    Integer

    Specifies the number of packets sent.

    packets_recv

    Integer

    Specifies the number of packets received.

    traffic_sent

    Integer

    Specifies the number of bytes sent.

    traffic_recv

    Integer

    Specifies the number of bytes received.

    collected_at

    String

    • Specifies the data collection time.
    • The UTC time format is yyyy-MM-ddTHH:mm:ss.SSSZ.
  • Example response
    {
        "sa_infos": [
            {
                "id": "4f43df63-9263-4895-ba15-e9aae9c9fa68",
                "source_ip_cidr": "0.0.0.0/0",
                "dest_ip_cidr": "0.0.0.0/0",
                "packets_sent": 15516,
                "packets_recv": 15513,
                "traffic_sent": 1295454,
                "traffic_recv": 1294979,
                "collected_at": "2026-04-09T03:28:33.351Z"
            }
        ],
        "request_id": "61593611ee016546ba0a61992083d80b"
    }

Status Codes

For details, see Status Codes.