-
响应示例 返回状态码为200:接口调用成功,响应体参考QueryIpsecProfileResponse。 HTTP/1.1 200 OK
Date: Sun,11 May 2025 10:00:00 GMT
Server: example-server
Content-Type: application/json;charset=UTF-8
Content-Length: 250
Connection: keep-alive
{
"errcode" : "0",
"errmsg" : "",
"totalRecords" : 200,
"pageSize" : 20,
"pageIndex" : 1,
"data" : [
{
"id" : "fbb684c8-0d37-496f-bafa-4b06d5151e2e",
"name" : "Profile1",
"ikeVersion" : "V2",
"authenticationMode" : 0,
"authenticationAlgorithm" : "SHA2-256",
"preSharedKey" : "pwd",
"encryptionAlgorithm" : "AES-256",
"ikePrf" : "hmac-sha2-256",
"integrityAlgorithm" : "hmac-sha2-256",
"ikeSaDuration" : 86400,
"dhGroup" : "group14",
"exchangeMode" : "main",
"dpdEnable" : false,
"dpdType" : "periodic",
"dpdIdleTime" : 30,
"dpdTransmitInterval" : 15,
"enableLocalId" : false,
"localType" : "ip",
"localId" : "192.168.10.1",
"enableRemoteId" : false,
"remoteType" : "ip",
"remoteId" : "192.168.10.1",
"securityProtocol" : "ESP",
"ahAuthenticationAlgorithm" : "SHA2-256",
"espAuthenticationAlgorithm" : "SHA2-256",
"espEncryptionAlgorithm" : "AES-256",
"profilePfs" : "dh-group14",
"trfficBasedSaDuration" : 200000,
"timeBasedSaDuration" : 7200
}
]
} 返回状态码为400:校验异常。 HTTP/1.1 400 Bad Request
Date: Sun,11 May 2025 10:00:00 GMT
Server: example-server
Content-Type: application/json;charset=UTF-8
Content-Length: 250
Connection: keep-alive
返回状态码为500:内部错误。 HTTP/1.1 500 Internal Server Error
Date: Sun,11 May 2025 10:00:00 GMT
Server: example-server
Content-Type: application/json;charset=UTF-8
Content-Length: 250
Connection: keep-alive
-
URI /controller/campus/v1/sdwan/net/ipsecprofile/template 表1 query参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 id 否 uuid - - 模板id,UUID格式。 "fbb684c8-0d37-496f-bafa-4b06d5151e2e" name 否 string - - 模板名称。 "profile1" pageIndex 否 int32 - 1 当前页数,默认是1。 1 pageSize 否 int32 - 20 页大小,默认是20。 20
-
响应参数 返回状态码为200:接口调用成功,响应体参考QueryIpsecProfileResponse。 表2 QueryIpsecProfileResponse对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string - - 错误码。 "0" errmsg string - - 错误信息。 "" totalRecords int32 - - 总的数据条数。 200 pageSize int32 - - 分页数。 20 pageIndex int32 - - 当前页数 1 data ARRAY_REFERENCE 0-1000个列表项,详细请参见表5。 IPSEC Profile模板信息。 - 返回状态码为400:校验异常。 详细信息请参见实际响应消息体。 返回状态码为500:内部错误。 详细信息请参见实际响应消息体。
-
请求示例 HTTP的示例 GET /controller/campus/v1/sdwan/net/ipsecprofile/template?id=fbb684c8-0d37-496f-bafa-4b06d5151e2e&name=profile1&pageIndex=1&pageSize=20 HTTP/1.1
Host: 192.168.1.125:18002
Content-Type: application/json
Accept: application/json
Accept-Language: en-US
X-AC
CES S-TOKEN: x-yyyyyy
-
响应示例 返回状态码为201:接口调用成功,响应体参考IpsecProfileResponse。 HTTP/1.1 201 Created
Date: Sun,11 May 2025 10:00:00 GMT
Server: example-server
Content-Type: application/json;charset=UTF-8
Content-Length: 250
Connection: keep-alive
{
"errcode" : "0",
"errmsg" : "",
"success" : [
{
"id" : "fbb684c8-0d37-496f-bafa-4b06d5151e2e",
"name" : "Profile1",
"ikeVersion" : "V2",
"authenticationMode" : 0,
"authenticationAlgorithm" : "SHA2-256",
"preSharedKey" : "pwd",
"encryptionAlgorithm" : "AES-256",
"ikePrf" : "hmac-sha2-256",
"integrityAlgorithm" : "hmac-sha2-256",
"ikeSaDuration" : 86400,
"dhGroup" : "group14",
"exchangeMode" : "main",
"dpdEnable" : false,
"dpdType" : "periodic",
"dpdIdleTime" : 30,
"dpdTransmitInterval" : 15,
"enableLocalId" : false,
"localType" : "ip",
"localId" : "192.168.10.1",
"enableRemoteId" : false,
"remoteType" : "ip",
"remoteId" : "192.168.10.1",
"securityProtocol" : "ESP",
"ahAuthenticationAlgorithm" : "SHA2-256",
"espAuthenticationAlgorithm" : "SHA2-256",
"espEncryptionAlgorithm" : "AES-256",
"profilePfs" : "dh-group14",
"trfficBasedSaDuration" : 200000,
"timeBasedSaDuration" : 7200
}
],
"fail" : [
{
"errcode" : "0",
"errmsg" : "",
"data" : {
"id" : "fbb684c8-0d37-496f-bafa-4b06d5151e2e",
"name" : "Profile1",
"ikeVersion" : "V2",
"authenticationMode" : 0,
"authenticationAlgorithm" : "SHA2-256",
"preSharedKey" : "pwd",
"encryptionAlgorithm" : "AES-256",
"ikePrf" : "hmac-sha2-256",
"integrityAlgorithm" : "hmac-sha2-256",
"ikeSaDuration" : 86400,
"dhGroup" : "group14",
"exchangeMode" : "main",
"dpdEnable" : false,
"dpdType" : "periodic",
"dpdIdleTime" : 30,
"dpdTransmitInterval" : 15,
"enableLocalId" : false,
"localType" : "ip",
"localId" : "192.168.10.1",
"enableRemoteId" : false,
"remoteType" : "ip",
"remoteId" : "192.168.10.1",
"securityProtocol" : "ESP",
"ahAuthenticationAlgorithm" : "SHA2-256",
"espAuthenticationAlgorithm" : "SHA2-256",
"espEncryptionAlgorithm" : "AES-256",
"profilePfs" : "dh-group14",
"trfficBasedSaDuration" : 200000,
"timeBasedSaDuration" : 7200
}
}
]
} 返回状态码为400:校验异常。 HTTP/1.1 400 Bad Request
Date: Sun,11 May 2025 10:00:00 GMT
Server: example-server
Content-Type: application/json;charset=UTF-8
Content-Length: 250
Connection: keep-alive
返回状态码为500:内部错误。 HTTP/1.1 500 Internal Server Error
Date: Sun,11 May 2025 10:00:00 GMT
Server: example-server
Content-Type: application/json;charset=UTF-8
Content-Length: 250
Connection: keep-alive
-
响应参数 返回状态码为201:接口调用成功,响应体参考IpsecProfileResponse。 表4 IpsecProfileResponse对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string - - 错误码。 "0" errmsg string - - 错误信息。 "" success ARRAY_REFERENCE 0-100个列表项,详细请参见表5。 成功添加或更新的IPSEC Profile模板。 - fail ARRAY_REFERENCE 0-100个列表项,详细请参见表6。 添加或者更新失败的IPSEC Profile模板。 - 表5 IpsecProfileInfo对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 id uuid 0~36个字符。 - 模板ID,UUID格式,创建不要填写,更新,删除时必填。 "fbb684c8-0d37-496f-bafa-4b06d5151e2e" name string 1~15个字符。 - 长度为1-15的字符串,数字、字符均可,名称不能重复。创建时必填。 "Profile1" ikeVersion string 0~32个字符。 - IKE 版本,取值范围:V1,V2。 "V2" authenticationMode int32 [0-0] - 认证方式,当前只支持填写0,预共享密钥。 0 authenticationAlgorithm string 0~32个字符。 - 认证算法,可选范围:SHA1、SHA2-256、SHA2-384、SHA2-512、SM3,默认SHA2-256,大小写敏感。 "SHA2-256" preSharedKey string 0~128个字符。 - 该字段可能包含敏感信息和个人数据,请妥善做好保护。 预共享秘钥。创建时必填。 "pwd" encryptionAlgorithm string 0~32个字符。 - 加密算法,取值范围:AES-128、AES-192、AES-256、SM4,默认AES-256,大小写敏感。 "AES-256" ikePrf string 0~32个字符。 - 伪随机数算法,IKE版本为V2时配置,取值范围:aes-xcbc-128、hmac-md5、hmac-sha1、hmac-sha2-256、hmac-sha2-384、hmac-sha2-512,默认hmac-sha2-256。 "hmac-sha2-256" integrityAlgorithm string 0~32个字符。 - 完整性算法,IKE版本为V2时配置,取值范围:aes-xcbc-96、hmac-md5-96、hmac-sha1-96、hmac-sha2-256、hmac-sha2-384、hmac-sha2-512,默认hmac-sha2-256。 "hmac-sha2-256" ikeSaDuration integer [60-604800] 86400 SA硬生存周期,单位为秒,默认86400。 86400 dhGroup string 0~32个字符。 - dhGroup,取值范围:group1、group2、group5、group14、group19、group20、group21、group24,默认group14,大小写敏感。 "group14" exchangeMode string 0~32个字符。 - 协商模式, IKE版本为V1时配置,取值范围:main、aggressive,默认main。 "main" dpdEnable boolean true false false DPD使能开关。 false dpdType string 0~32个字符。 - DPD检测模式, 取值范围:on-demand、periodic。 "periodic" dpdIdleTime integer [10-3600] - DPD空闲时间,单位为秒。 30 dpdTransmitInterval integer [2-60] - DPD报文重传间隔,单位为秒。 15 enableLocalId boolean true false false LOCALID使能开关。 false localType string 0~32个字符。 - 本端类型, 取值范围:ip、fqdn、user-fqdn、ip-configurable。 "ip" localId string 0~255个字符。 - 本端ID, 字符串形式,可以输入长度范围为1~255个字符,不支持问号,区分大小写。 "192.168.10.1" enableRemoteId boolean true false false PEERID使能开关。 false remoteType string 0~32个字符。 - 对端类型, 取值范围:ip、fqdn、user-fqdn、dn、any、none。 "ip" remoteId string 0~255个字符。 - 对端ID, 字符串形式,可以输入长度范围为1~255个字符,不支持问号,区分大小写。 "192.168.10.1" securityProtocol string 0~128个字符。 - 安全协议,取值范围:AH、ESP、AH-ESP,默认ESP。 "ESP" ahAuthenticationAlgorithm string 0~32个字符。 - AH认证算法,SHA1、SHA2-256、SHA2-384、SHA2-512、SM3,默认SHA2-256,大小写敏感。 "SHA2-256" espAuthenticationAlgorithm string 0~32个字符。 - ESP认证算法,SHA1、SHA2-256、SHA2-384、SHA2-512、SM3,默认SHA2-256,大小写敏感。 "SHA2-256" espEncryptionAlgorithm string 0~32个字符。 - ESP加密算法, 取值范围:AES-128、AES-192、AES-256、SM4、NONE,默认AES-256,大小写敏感。 "AES-256" profilePfs string 0~32个字符。 - PFS, 取值范围:none、dh-group1、dh-group2、dh-group5、dh-group14、dh-group19、dh-group20、dh-group21、dh-group24,默认为none,表示不配置。 "dh-group14" trfficBasedSaDuration integer [0-200000000] - 以流量为基准的硬生存周期,取值范围:0,256-200000000,单位是千字节。 200000 timeBasedSaDuration integer [30-604800] - 以时间为基准的硬生存周期,单位是秒。 7200 表6 FailIpsecProfileInfo对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string - - 错误码。 "0" errmsg string - - 错误信息。 "" data REFERENCE 详细请参见表5。 IPSEC Profile模板。 - 返回状态码为400:校验异常。 详细信息请参见实际响应消息体。 返回状态码为500:内部错误。 详细信息请参见实际响应消息体。
-
请求示例 HTTP的示例 POST /controller/campus/v1/sdwan/net/ipsecprofile/template HTTP/1.1
Host: 192.168.1.125:18002
Content-Type: application/json
Accept: application/json
Accept-Language: en-US
X-ACCESS-TOKEN: x-yyyyyy
{
"IpsecProfileInfos" : [
{
"id" : "fbb684c8-0d37-496f-bafa-4b06d5151e2e",
"name" : "Profile1",
"ikeVersion" : "V2",
"authenticationMode" : 0,
"authenticationAlgorithm" : "SHA2-256",
"preSharedKey" : "pwd",
"encryptionAlgorithm" : "AES-256",
"ikePrf" : "hmac-sha2-256",
"integrityAlgorithm" : "hmac-sha2-256",
"ikeSaDuration" : 86400,
"dhGroup" : "group14",
"exchangeMode" : "main",
"dpdEnable" : false,
"dpdType" : "periodic",
"dpdIdleTime" : 30,
"dpdTransmitInterval" : 15,
"enableLocalId" : false,
"localType" : "ip",
"localId" : "192.168.10.1",
"enableRemoteId" : false,
"remoteType" : "ip",
"remoteId" : "192.168.10.1",
"securityProtocol" : "ESP",
"ahAuthenticationAlgorithm" : "SHA2-256",
"espAuthenticationAlgorithm" : "SHA2-256",
"espEncryptionAlgorithm" : "AES-256",
"profilePfs" : "dh-group14",
"trfficBasedSaDuration" : 200000,
"timeBasedSaDuration" : 7200
}
]
}
-
请求参数 表1 body参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 ipsecProfileInfos 是 REFERENCE 详细请参见表2。 创建IPSEC Profile模板请求数据。 - 表2 IpsecProfileInfoRequest对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 IpsecProfileInfos 否 ARRAY_REFERENCE 1-100个列表项,详细请参见表3。 IPSEC Profile模板列表。 - 表3 IpsecProfileInfo对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 id 否 uuid 0~36个字符。 - 模板ID,UUID格式,创建不要填写,更新,删除时必填。 "fbb684c8-0d37-496f-bafa-4b06d5151e2e" name 否 string 1~15个字符。 - 长度为1-15的字符串,数字、字符均可,名称不能重复。创建时必填。 "Profile1" ikeVersion 否 string 0~32个字符。 - IKE 版本,取值范围:V1,V2。 "V2" authenticationMode 否 int32 [0-0] - 认证方式,当前只支持填写0,预共享密钥。 0 authenticationAlgorithm 否 string 0~32个字符。 - 认证算法,可选范围:SHA1、SHA2-256、SHA2-384、SHA2-512、SM3,默认SHA2-256,大小写敏感。 "SHA2-256" preSharedKey 否 string 0~128个字符。 - 该字段可能包含敏感信息和个人数据,请妥善做好保护。 预共享秘钥。创建时必填。 "pwd" encryptionAlgorithm 否 string 0~32个字符。 - 加密算法,取值范围:AES-128、AES-192、AES-256、SM4,默认AES-256,大小写敏感。 "AES-256" ikePrf 否 string 0~32个字符。 - 伪随机数算法,IKE版本为V2时配置,取值范围:aes-xcbc-128、hmac-md5、hmac-sha1、hmac-sha2-256、hmac-sha2-384、hmac-sha2-512,默认hmac-sha2-256。 "hmac-sha2-256" integrityAlgorithm 否 string 0~32个字符。 - 完整性算法,IKE版本为V2时配置,取值范围:aes-xcbc-96、hmac-md5-96、hmac-sha1-96、hmac-sha2-256、hmac-sha2-384、hmac-sha2-512,默认hmac-sha2-256。 "hmac-sha2-256" ikeSaDuration 否 integer [60-604800] 86400 SA硬生存周期,单位为秒,默认86400。 86400 dhGroup 否 string 0~32个字符。 - dhGroup,取值范围:group1、group2、group5、group14、group19、group20、group21、group24,默认group14,大小写敏感。 "group14" exchangeMode 否 string 0~32个字符。 - 协商模式, IKE版本为V1时配置,取值范围:main、aggressive,默认main。 "main" dpdEnable 否 boolean true false false DPD使能开关。 false dpdType 否 string 0~32个字符。 - DPD检测模式, 取值范围:on-demand、periodic。 "periodic" dpdIdleTime 否 integer [10-3600] - DPD空闲时间,单位为秒。 30 dpdTransmitInterval 否 integer [2-60] - DPD报文重传间隔,单位为秒。 15 enableLocalId 否 boolean true false false LOCALID使能开关。 false localType 否 string 0~32个字符。 - 本端类型, 取值范围:ip、fqdn、user-fqdn、ip-configurable。 "ip" localId 否 string 0~255个字符。 - 本端ID, 字符串形式,可以输入长度范围为1~255个字符,不支持问号,区分大小写。 "192.168.10.1" enableRemoteId 否 boolean true false false PEERID使能开关。 false remoteType 否 string 0~32个字符。 - 对端类型, 取值范围:ip、fqdn、user-fqdn、dn、any、none。 "ip" remoteId 否 string 0~255个字符。 - 对端ID, 字符串形式,可以输入长度范围为1~255个字符,不支持问号,区分大小写。 "192.168.10.1" securityProtocol 否 string 0~128个字符。 - 安全协议,取值范围:AH、ESP、AH-ESP,默认ESP。 "ESP" ahAuthenticationAlgorithm 否 string 0~32个字符。 - AH认证算法,SHA1、SHA2-256、SHA2-384、SHA2-512、SM3,默认SHA2-256,大小写敏感。 "SHA2-256" espAuthenticationAlgorithm 否 string 0~32个字符。 - ESP认证算法,SHA1、SHA2-256、SHA2-384、SHA2-512、SM3,默认SHA2-256,大小写敏感。 "SHA2-256" espEncryptionAlgorithm 否 string 0~32个字符。 - ESP加密算法, 取值范围:AES-128、AES-192、AES-256、SM4、NONE,默认AES-256,大小写敏感。 "AES-256" profilePfs 否 string 0~32个字符。 - PFS, 取值范围:none、dh-group1、dh-group2、dh-group5、dh-group14、dh-group19、dh-group20、dh-group21、dh-group24,默认为none,表示不配置。 "dh-group14" trfficBasedSaDuration 否 integer [0-200000000] - 以流量为基准的硬生存周期,取值范围:0,256-200000000,单位是千字节。 200000 timeBasedSaDuration 否 integer [30-604800] - 以时间为基准的硬生存周期,单位是秒。 7200
-
请求示例 HTTP的示例 POST /controller/campus/v1/sdwan/net/ipsecprofile/template/action/batch-delete HTTP/1.1
Host: 192.168.1.125:18002
Content-Type: application/json
Accept: application/json
Accept-Language: en-US
X-ACCESS-TOKEN: x-yyyyyy
{
"IpsecProfileInfos" : [
{
"id" : "fbb684c8-0d37-496f-bafa-4b06d5151e2e",
"name" : "Profile1",
"ikeVersion" : "V2",
"authenticationMode" : 0,
"authenticationAlgorithm" : "SHA2-256",
"preSharedKey" : "pwd",
"encryptionAlgorithm" : "AES-256",
"ikePrf" : "hmac-sha2-256",
"integrityAlgorithm" : "hmac-sha2-256",
"ikeSaDuration" : 86400,
"dhGroup" : "group14",
"exchangeMode" : "main",
"dpdEnable" : false,
"dpdType" : "periodic",
"dpdIdleTime" : 30,
"dpdTransmitInterval" : 15,
"enableLocalId" : false,
"localType" : "ip",
"localId" : "192.168.10.1",
"enableRemoteId" : false,
"remoteType" : "ip",
"remoteId" : "192.168.10.1",
"securityProtocol" : "ESP",
"ahAuthenticationAlgorithm" : "SHA2-256",
"espAuthenticationAlgorithm" : "SHA2-256",
"espEncryptionAlgorithm" : "AES-256",
"profilePfs" : "dh-group14",
"trfficBasedSaDuration" : 200000,
"timeBasedSaDuration" : 7200
}
]
}
-
响应示例 返回状态码为200:正常响应返回体,返回的IPSEC Profile模板中仅包含对应的ID,响应体参考IpsecProfileResponse。 HTTP/1.1 200 OK
Date: Sun,11 May 2025 10:00:00 GMT
Server: example-server
Content-Type: application/json;charset=UTF-8
Content-Length: 250
Connection: keep-alive
{
"errcode" : "0",
"errmsg" : "",
"success" : [
{
"id" : "fbb684c8-0d37-496f-bafa-4b06d5151e2e",
"name" : "Profile1",
"ikeVersion" : "V2",
"authenticationMode" : 0,
"authenticationAlgorithm" : "SHA2-256",
"preSharedKey" : "pwd",
"encryptionAlgorithm" : "AES-256",
"ikePrf" : "hmac-sha2-256",
"integrityAlgorithm" : "hmac-sha2-256",
"ikeSaDuration" : 86400,
"dhGroup" : "group14",
"exchangeMode" : "main",
"dpdEnable" : false,
"dpdType" : "periodic",
"dpdIdleTime" : 30,
"dpdTransmitInterval" : 15,
"enableLocalId" : false,
"localType" : "ip",
"localId" : "192.168.10.1",
"enableRemoteId" : false,
"remoteType" : "ip",
"remoteId" : "192.168.10.1",
"securityProtocol" : "ESP",
"ahAuthenticationAlgorithm" : "SHA2-256",
"espAuthenticationAlgorithm" : "SHA2-256",
"espEncryptionAlgorithm" : "AES-256",
"profilePfs" : "dh-group14",
"trfficBasedSaDuration" : 200000,
"timeBasedSaDuration" : 7200
}
],
"fail" : [
{
"errcode" : "0",
"errmsg" : "",
"data" : {
"id" : "fbb684c8-0d37-496f-bafa-4b06d5151e2e",
"name" : "Profile1",
"ikeVersion" : "V2",
"authenticationMode" : 0,
"authenticationAlgorithm" : "SHA2-256",
"preSharedKey" : "pwd",
"encryptionAlgorithm" : "AES-256",
"ikePrf" : "hmac-sha2-256",
"integrityAlgorithm" : "hmac-sha2-256",
"ikeSaDuration" : 86400,
"dhGroup" : "group14",
"exchangeMode" : "main",
"dpdEnable" : false,
"dpdType" : "periodic",
"dpdIdleTime" : 30,
"dpdTransmitInterval" : 15,
"enableLocalId" : false,
"localType" : "ip",
"localId" : "192.168.10.1",
"enableRemoteId" : false,
"remoteType" : "ip",
"remoteId" : "192.168.10.1",
"securityProtocol" : "ESP",
"ahAuthenticationAlgorithm" : "SHA2-256",
"espAuthenticationAlgorithm" : "SHA2-256",
"espEncryptionAlgorithm" : "AES-256",
"profilePfs" : "dh-group14",
"trfficBasedSaDuration" : 200000,
"timeBasedSaDuration" : 7200
}
}
]
} 返回状态码为400:校验异常。 HTTP/1.1 400 Bad Request
Date: Sun,11 May 2025 10:00:00 GMT
Server: example-server
Content-Type: application/json;charset=UTF-8
Content-Length: 250
Connection: keep-alive
返回状态码为500:内部错误。 HTTP/1.1 500 Internal Server Error
Date: Sun,11 May 2025 10:00:00 GMT
Server: example-server
Content-Type: application/json;charset=UTF-8
Content-Length: 250
Connection: keep-alive