Skip to main content
API Explorer|API Explorer
Resource Center/Network Service/Network Service Operations/IPsec Operations
POSTIPsec OperationsSince 2.3SynchronousAuth Required

CreateIPsecConnection

CreateIPsecConnection

Execution Availability

Try It Out

Submit a mock request using the current auth context and example-driven inputs.

Request Inputs

Body Fields

  • paramsObjectRequired

    Request body parameter object.

    • nameStringRequired

      The resource name.

    • descriptionString

      Optional. The detailed description of the resource.

    • peerAddressStringRequired

      The remote network address.

    • authModeString

      Optional. The authentication mode.

    • authKeyStringRequired

      The authentication key.

    • idTypeString

      The ID configuration method.

    • vipUuidStringRequired

      The VIP UUID.

    • localIdString

      Optional. The local ID.

    • remoteIdString

      Optional. The remote ID.

    • peerCidrsList

      Optional. The detination network Cidrs.

    • ikeVersionString

      Optional. The IKE version.

    • ikeAuthAlgorithmString

      Optional. The IKE authentication algorithm.

    • ikeEncryptionAlgorithmString

      Optional. The IKE encryption algorithm.

    • ikeDhGroupint

      Optional. The IKE DH Group.

    • ikeLifeTimeint

      Optional. The IKE lifetime.

    • policyAuthAlgorithmString

      Optional. The ESP authentication algorithm.

    • policyEncryptionAlgorithmString

      Optional. The ESP encryption algorithm.

    • pfsString

      Optional. The perfect forward secrecy.

    • policyModeString

      Optional. The policy mode.

    • transformProtocolString

      Optional. The transform protocol.

    • resourceUuidString

      Optional. The resource UUID.

    • tagUuidsList

      Optional. The tag UUID list.

  • l3NetworkUuidString

    Optional. The L3 network UUID.

  • systemTagsList

    Optional. The system tags.

  • userTagsList

    Optional. The user tags.

Responses

200 OK

On success, this API returns the following response structure.

  • successbooleanRequired

    操作是否成功。

  • errorErrorCodeRequired

    The error code. If not null, the operation fails, or vice versa. For more information, see error.

    • codeStringRequired

      The error code, which is a numbered or alphanumeric code that specifies an error. For example, SYS.1000, HOST.1001.

    • descriptionStringRequired

      The brief description of the error.

    • detailsStringRequired

      The details about the error.

    • elaborationStringRequired

      The reserved field. Default value: null.

    • opaqueLinkedHashMapRequired

      The reserved field. Default value: null.

    • causeErrorCodeRequired

      The root error, which is the associated root cause of the current error. If no root error exists, this parameter is null.

  • inventoryIPsecConnectionInventoryRequired

    See inventory.

    • uuidStringRequired

      The resource UUID.

    • nameStringRequired

      The resource name.

    • descriptionStringRequired

      The detailed description of the resource.

    • peerAddressStringRequired

      The remote network address.

    • authModeStringRequired

      The authentication mode.

    • authKeyStringRequired

      The authentication key.

    • vipUuidStringRequired

      The VIP UUID.

    • ikeAuthAlgorithmStringRequired

      The IKE authentication algorithm.

    • ikeEncryptionAlgorithmStringRequired

      The IKE encryption algorithm.

    • ikeDhGroupIntegerRequired

      The IKE DH group.

    • policyAuthAlgorithmStringRequired

      The ESP authentication algorithm.

    • policyEncryptionAlgorithmStringRequired

      The ESP encryption algorithm.

    • pfsStringRequired

      The PFS DH group.

    • policyModeStringRequired

      The encryption mode.

    • transformProtocolStringRequired

      The security protocol.

    • ikeVersionStringRequired

      The IKE version.

    • idTypeStringRequired

      The ID configuration method.

    • localIdStringRequired

      The local ID.

    • remoteIdStringRequired

      The remote ID.

    • stateStringRequired

      The running state.

    • statusStringRequired

      The ready status.

    • ikeLifeTimeintRequired

      The IKE lifetime.

    • lifeTimeintRequired

      The IPsec lifetime.

    • createDateTimestampRequired

      The creation date.

    • lastOpDateTimestampRequired

      The last operation date.

    • peerCidrsListRequired

      See peerCidrs.

      • uuidStringRequired

        The resource UUID.

      • cidrStringRequired

        No description provided.

      • connectionUuidStringRequired

        连接UUID。

      • createDateTimestampRequired

        The creation date.

      • lastOpDateTimestampRequired

        The last operation date.

    • l3NetworkRefsListRequired

      See l3NetworkRefs.

      • uuidStringRequired

        The resource UUID.

      • connectionUuidStringRequired

        连接UUID。

      • l3NetworkUuidStringRequired

        The L3 network UUID.

      • createDateTimestampRequired

        The creation date.

      • lastOpDateTimestampRequired

        The last operation date.

Endpoint

POST/zstack/v1/ipsec

/zstack/v1/ipsec

Operation ID

CreateIPsecConnection

Permalink

Request Example

curl -X POST 'http://{host}/zstack/v1/ipsec' -H 'Authorization: OAuth {sessionUuid}' -H 'Content-Type: application/json;charset=UTF-8' -d '{"params":{"name":"<name>","description":"<description>","peerAddress":"<peerAddress>","authMode":"<authMode>","authKey":"<authKey>","idType":"<idType>","vipUuid":"<vipUuid>","localId":"<localId>","remoteId":"<remoteId>","peerCidrs":["<peerCidrs>"],"ikeVersion":"<ikeVersion>","ikeAuthAlgorithm":"<ikeAuthAlgorithm>","ikeEncryptionAlgorithm":"<ikeEncryptionAlgorithm>","ikeDhGroup":1,"ikeLifeTime":1,"policyAuthAlgorithm":"<policyAuthAlgorithm>","policyEncryptionAlgorithm":"<policyEncryptionAlgorithm>","pfs":"<pfs>","policyMode":"<policyMode>","transformProtocol":"<transformProtocol>","resourceUuid":"<resourceUuid>","tagUuids":["<tagUuids>"]},"l3NetworkUuid":"<l3NetworkUuid>","systemTags":["<systemTags>"],"userTags":["<userTags>"]}'

Response Example

200
{ "inventory": { "name": "Test-IPSec", "peerAddress": "100.64.10.10", "authKey": "auth", "vipUuid": "6a33d0d912263fd7a47d036eead9a27f", "status": "Connecting", "ikeLifeTime": 0.0, "lifeTime": 0.0, "peerCidrs": [ { "uuid": "199b04405d1e3fef83fd67a7a1f77bb3", "cidr": "192.168.100.0/24", "connectionUuid": "6deaa1c0ffd43f8eb3ebe2e8e7e66811", "createDate": "Nov 14, 2017 10:20:57 PM", "lastOpDate": "Nov 14, 2017 10:20:57 PM" } ], "l3NetworkRefs": [ {} ] } }

Change History

This API has no change history records yet.

View all change history