跳转到主要内容
API Explorer|API Explorer
资源中心/网络服务/网络服务相关接口/IPsec相关接口
PUTIPsec Operations起始版本 2.3同步需要认证

更改IPsec连接状态

更改IPsec连接状态

调试可用性

在线调试

使用当前认证信息和示例参数提交 Mock 请求。

路径参数

请求参数

路径参数

  • uuidString必填

    资源的UUID，唯一标示该资源

请求体字段

  • changeipsecconnectionstateObject必填

    changeipsecconnectionstate 请求体结构

    • stateEventString必填

      状态事件。

  • systemTagsList

    系统标签

  • userTagsList

    用户标签

响应状态

200 OK

该 API 成功时返回以下响应结构。

  • successboolean必填

    操作是否成功。

  • errorErrorCode必填

    错误码，若不为null，则表示操作失败, 操作成功时该字段为null。 详情参考error

    • codeString必填

      错误码号，错误的全局唯一标识，例如SYS.1000, HOST.1001

    • descriptionString必填

      错误的概要描述

    • detailsString必填

      错误的详细信息

    • elaborationString必填

      保留字段，默认为null

    • opaqueLinkedHashMap必填

      保留字段，默认为null

    • causeErrorCode必填

      根错误，引发当前错误的源错误，若无原错误，该字段为null

  • inventoryIPsecConnectionInventory必填

    详情参考inventory

    • uuidString必填

      资源的UUID，唯一标示该资源

    • nameString必填

      资源名称

    • descriptionString必填

      资源的详细描述

    • peerAddressString必填

      远端网络地址

    • authModeString必填

      认证模式

    • authKeyString必填

      认证密钥

    • vipUuidString必填

      暂无描述。

    • ikeAuthAlgorithmString必填

      IKE验证算法

    • ikeEncryptionAlgorithmString必填

      IKE加密算法

    • ikeDhGroupInteger必填

      IKE DH组

    • policyAuthAlgorithmString必填

      ESP认证算法

    • policyEncryptionAlgorithmString必填

      ESP加密算法

    • pfsString必填

      PFS DH组

    • policyModeString必填

      封装模式

    • transformProtocolString必填

      安全协议

    • ikeVersionString必填

      IKE版本

    • idTypeString必填

      ID配置方法

    • localIdString必填

      本端ID

    • remoteIdString必填

      对端ID

    • stateString必填

      启用状态

    • statusString必填

      就绪状态

    • ikeLifeTimeint必填

      IKE存活时间

    • lifeTimeint必填

      IPSec存活时间

    • createDateTimestamp必填

      创建时间

    • lastOpDateTimestamp必填

      最后一次修改时间

    • peerCidrsList必填

      详情参考peerCidrs

      • uuidString必填

        资源的UUID，唯一标示该资源

      • cidrString必填

        暂无描述。

      • connectionUuidString必填

        连接UUID。

      • createDateTimestamp必填

        创建时间

      • lastOpDateTimestamp必填

        最后一次修改时间

    • l3NetworkRefsList必填

      详情参考l3NetworkRefs

      • uuidString必填

        资源的UUID,唯一标示该资源

      • connectionUuidString必填

        连接UUID。

      • l3NetworkUuidString必填

        三层网络UUID

      • createDateTimestamp必填

        创建时间

      • lastOpDateTimestamp必填

        最后一次修改时间

请求地址

PUT/zstack/v1/ipsec/{uuid}/actions

/zstack/v1/ipsec/{uuid}/actions

操作 ID

ChangeIPSecConnectionState

永久链接

请求示例

curl -X PUT 'http://{host}/zstack/v1/ipsec/{uuid}/actions' -H 'Authorization: OAuth {sessionUuid}' -H 'Content-Type: application/json;charset=UTF-8' -d '{"changeipsecconnectionstate":{"stateEvent":"<stateEvent>"},"systemTags":["<systemTags>"],"userTags":["<userTags>"]}'

响应示例

200
{ "inventory": { "uuid": "13b5a2cd8c5c30a9a47ba95802cf4e1a", "name": "IPSec-1", "state": "Enabled", "ikeLifeTime": 0.0, "lifeTime": 0.0 } }

变更历史

此 API 暂无变更历史记录。

查看全部变更历史