You need to enable JavaScript to run this app.
文档中心
VPN连接

VPN连接

复制全文
下载 pdf
SSL客户端证书
CreateSslVpnClientCert-创建SSL客户端证书
复制全文
下载 pdf
CreateSslVpnClientCert-创建SSL客户端证书
调用CreateSslVpnClientCert创建SSL客户端证书。​
使用说明​
SSL客户端证书为SSL服务端的子资源。新创建SSL客户端证书与创建时选择的SSL服务端属于同一项目,仅可跟随SSL服务端进行项目的迁移,不可单独对SSL客户端证书进行项目迁移。更多项目介绍,请参见项目管理。​
调试​
API Explorer
您可以通过 API Explorer 在线发起调用,无需关注签名生成过程,快速获取调用结果。
​
请求参数​
下方仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。​
Action String 必选 示例值:CreateSslVpnClientCert​
要执行的操作,取值:CreateSslVpnClientCert。​
​
Version String 必选 示例值:2020-04-01​
API版本信息。​
​
SslVpnServerId String 必选 示例值:vss-zm55pqtvk17oq32zd****​
创建SSL客户端证书使用的SSL服务端的ID。您可调用 DescribeSslVpnServers查询SSL服务端的ID信息。​
​
SslVpnClientCertName String 可选 示例值:Ssl_VpnClient​
SSL客户端证书的名称。​
  • 以中文、字母、数字开头,只能包含中文、字母、数字、点号(.)、下划线(_)和短划线(-)。​
  • 长度限制为1 ~ 128个字符。​
  • 不填默认为SSL客户端证书的ID。​
​
Description String 可选 示例值:This is a sample description​
SSL客户端证书的描述信息。​
  • 以中文、字母、数字开头,只能包含中文、字母、数字、点号(.)、空格( )、下划线(_)、中划线(-)、等号(=)、英文逗号(,)、中文逗号(,)、中文句号(。)。​
  • 长度限制为0 ~ 255个字符。​
  • 不填默认为空字符串。​
​
ClientToken String 可选 示例值:123e4567-e89b-12d3-a456-42665544****​
客户端Token,用于保证请求幂等性。​
  • 由客户端自动生成一个参数值,确保不同请求间该参数值唯一,避免当调用API超时或服务器内部错误时,客户端多次重试导致重复性操作。​
  • 仅支持ASCII字符,且不能超过64个字符。​
  • 若不传入ClientToken,则此次API调用不进行幂等校验。​
​
Tags.N.Key String 可选 示例值:key1​
SSL客户端证书标签的标签键(Key)。​
  • 参数 - N :表示标签键的序号,取值范围:1~20。​
  • 多个标签键之间用&分隔。​
命名规则如下:​
  • 不能以volc:或sys:的任意大小写组合开头。​
  • 只能包含语言字符、数字、空格和英文符号“_”、“.”、“:”、“/”、“=”、“+”、“-”、“@”。​
  • 长度限制在1~128个字符之间。​
说明:同一资源的标签键不允许重复。​
​
Tags.N.Value String 可选 示例值:value1​
SSL客户端证书标签的标签值(Value)。​
  • 参数 - N:表示标签值的序号,取值范围:1~20。​
  • 多个标签值之间用&分隔。​
命名规则如下:​
  • 只能包含语言字符、数字、空格和英文符号“_”、“.”、“:”、“/”、“=”、“+”、“-”、“@”。​
  • 允许为空,长度限制在0~256个字符之间。​
  • 大小写敏感,不能以空格开头或结尾。​
说明:传入Tags.N.Value则必须传入Tags.N.Key。​
​
​
返回参数​
下方仅列出本接口特有的返回参数。更多信息请参见返回结构。​
RequestId String 可选 示例值:0ED8D006-F706-4D23-88ED-E11ED28****​
请求ID。​
​
SslVpnClientCertId String 可选 示例值:vsc-zm55pqtvk17oq32zd****​
新创建的SSL客户端的ID。​
​
​
请求示例​
​
GET /?Action=CreateSslVpnClientCert&Version=2020-04-01&SslVpnServerId=vss-imwoo6i1dfk08gbssxfj****&SslVpnClientCertName=test-cicd&Description=abc&ClientToken=abc HTTP/1.1​
Host: vpn.cn-beijing.volcengineapi.com​
X-Date: 20251029T033538Z​
Authorization: HMAC-SHA256 Credential=Adfks******wekfwe/20251029/cn-beijing/vpn/request, SignedHeaders=host;x-date, Signature=47a7d934ff7b37c03938******cd7b8278a40a1057690c401e92246a0e41085f​
​
返回示例​
​
{​
"ResponseMetadata": {​
"RequestId": "20230727195508EA4507984CE7A7F9ED0D",​
"Action": "CreateSslVpnClientCert",​
"Version": "2020-04-01",​
"Service": "vpn",​
"Region": "cn-beijing"​
},​
"Result": {​
"RequestId": "20230727195508EA4507984CE7A7F9****",​
"SslVpnClientCertId": "vsc-12ads0g2fsmps17q7y2w8****"​
}​
}​
​
错误码​
下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。​
​
状态码​
错误码​
错误信息​
说明​
400​
IdempotentParameterMismatch​
Arguments on this idempotent request are inconsistent with arguments used in previous request(s).​
此幂等请求的参数与前一个请求中使用的参数不一致。​
400​
InvalidDescription.Malformed​
The specified description is malformed. Ensure the maximum length of description is 255.​
指定的描述格式不合法。描述长度不能超过255个字符。​
400​
InvalidDescription.Malformed​
The specified description is malformed.​
指定的描述格式不合法。请修复描述格式后重试。​
400​
InvalidName.Malformed​
The specified name is malformed. Ensure the maximum length of name is 128.​
指定的名称格式不合法。名称长度不能超过128个字符。​
400​
InvalidName.Malformed​
The specified name is malformed.​
指定的名称格式不合法。请修复名称格式后重试。​
400​
InvalidParameter.ClientTokenMalformed​
The specified parameter ClientToken is malformed.​
指定的参数ClientToken格式不合法,长度不能超过64个ASCII字符。​
400​
InvalidSslVpnServer.InvalidStatus​
The specified SSL server is not in the correct status for the request.​
指定的SSL服务端所处的状态无法响应该请求。​
400​
QuotaExceeded.SSLClientCert​
You've reached the limit on the number of SSL client certificates per SSL server that you can create.​
已达到每个SSL服务端可创建的SSL客户端证书的数量上限。​
400​
InvalidTag.Disorder​
The specified index order of tag is malformed.​
指定标签的索引顺序参数格式不合法。​
400​
InvalidTagKey.Malformed​
The specified parameter tag key is invalid.​
标签键不合法。​
400​
InvalidTagValue.Malformed​
The specified parameter tag value is invalid.​
标签值不合法。​
400​
LimitExceeded.Tags​
You've reached the limit on the number of tags that you can operate at one time.​
已达到单次可操作标签数量的上限。​
404​
InvalidSslVpnServer.NotFound​
The specified SSL server does not exist.​
指定的SSL服务端不存在。​
404​
InvalidVpnGateway.NotFound​
The specified VPN gateway does not exist.​
指定的VPN网关不存在。​
404​
InvalidProject.NotFound​
The specified Project does not exist.​
指定的项目不存在。​
412​
IdempotentProcessing​
The request uses the same client token as a previous one that is still in process.​
幂等请求处理中。​
412​
InvalidVpnGateway.Expired​
The specified VPN gateway has expired.​
指定的VPN网关已过期。​
​
最近更新时间:2026.02.02 11:15:04
这个页面对您有帮助吗?
有用
有用
无用
无用