调用UploadServerCertificate接口上传服务器证书。

使用说明

  • 一次只能上传一份服务器证书和对应的私钥。
  • 上传成功后,返回该用户的所有服务器证书列表的指纹信息。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

名称 类型 是否必选 示例值 描述
Action String UploadServerCertificate

系统规定参数。取值:UploadServerCertificate

RegionId String cn-hangzhou

服务器证书的地域ID。

您可以通过调用DescribeRegions接口查询地域ID。

AliCloudCertificateId String 1321932713******_17f1b4b696b_1114720822_-1671******

阿里云的云上证书ID。

说明 如果使用阿里云的云上证书,该参数必选。
AliCloudCertificateName String cloudcertificate

阿里云的云上证书名称。

说明 如果使用阿里云的云上证书,该参数必选。
AliCloudCertificateRegionId String cn-hangzhou

阿里云的云上证书所在的地域ID。

ServerCertificate String -----BEGIN CERTIFICATE----- MIIGDTCC****** -----END CERTIFICATE-----

需要上传的公钥证书。

说明 如果不使用阿里云的云上证书,该参数必选。
PrivateKey String -----BEGIN RSA PRIVATE KEY----- MIIEogIB****** -----END RSA PRIVATE KEY-----

需要上传的私钥。

说明 如果不使用阿里云的云上证书,该参数必选。
ServerCertificateName String mycert01

要上传的服务器证书的名称。长度为1~80 个英文或中文字符,必须以大小写字母或中文开头,可包含数字、半角句号(.),下划线(_)和短划线(-)。

ResourceGroupId String rg-atstuj3rto****

资源组ID。

返回数据

名称 类型 示例值 描述
AliCloudCertificateName String cloudcertificate****

阿里云证书服务中的服务器证书名称。

CreateTimeStamp Long 1504147745000

证书创建的时间戳。

ExpireTime String 2022-10-18T23:59:59Z

证书过期时间。

CreateTime String 2022-02-21T02:49:05Z

证书创建时间。

ServerCertificateId String 1321932713******_17f1b4b696b_1114720822_-1671******

服务器证书ID。

ExpireTimeStamp Long 1504147745000

证书过期的时间戳。

RegionId String cn-hangzhou

证书所属的地域ID。

RequestId String 365F4154-92F6-4AE4-92F8-7FF34B540710

请求ID。

Fingerprint String 8f:7d:cb:e5:f8:c8:33:9c:17:65:c1:92:30:9e:45:55:9c:3a:85:60

服务器证书的指纹。

ServerCertificateName String mycert01

服务器证书名称。

CommonName String example.com

域名,对应证书的Common Name字段。

ResourceGroupId String rg-atstuj3rt****

资源组ID。

AliCloudCertificateId String 1321932713******_17f1b4b696b_1114720822_-1671******

阿里云证书服务中的服务器证书ID。

IsAliCloudCertificate Integer 0

是否为阿里云证书服务中的证书。

  • 0:不是阿里云证书。
  • 1:是阿里云证书。
SubjectAlternativeNames Array of String ["example.com","www.example.com"]

数组格式,返回证书的备用域名列表,对应证书的Subject Alternative Name字段。

示例

请求示例

http(s)://[Endpoint]/?Action=UploadServerCertificate
&RegionId=cn-hangzhou
&AliCloudCertificateId=1321932713******_17f1b4b696b_1114720822_-1671******
&AliCloudCertificateName=cloudcertificate****
&AliCloudCertificateRegionId=cn-hangzhou
&ServerCertificate=-----BEGIN CERTIFICATE----- MIIGDTCC****** -----END CERTIFICATE-----
&PrivateKey=-----BEGIN RSA PRIVATE KEY----- MIIEogIB****** -----END RSA PRIVATE KEY-----
&ServerCertificateName=mycert01
&ResourceGroupId=rg-atstuj3rto****
&公共请求参数

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<UploadServerCertificateResponse>
    <AliCloudCertificateName>cloudcertificate****</AliCloudCertificateName>
    <CreateTimeStamp>1504147745000</CreateTimeStamp>
    <ExpireTime>2022-10-18T23:59:59Z</ExpireTime>
    <CreateTime>2022-02-21T02:49:05Z</CreateTime>
    <ServerCertificateId>1321932713******_17f1b4b696b_1114720822_-1671******</ServerCertificateId>
    <ExpireTimeStamp>1504147745000</ExpireTimeStamp>
    <RegionId>cn-hangzhou</RegionId>
    <RequestId>365F4154-92F6-4AE4-92F8-7FF34B540710</RequestId>
    <Fingerprint>8f:7d:cb:e5:f8:c8:33:9c:17:65:c1:92:30:9e:45:55:9c:3a:85:60</Fingerprint>
    <ServerCertificateName>mycert01</ServerCertificateName>
    <CommonName>example.com</CommonName>
    <ResourceGroupId>rg-atstuj3rt****</ResourceGroupId>
    <AliCloudCertificateId>1321932713******_17f1b4b696b_1114720822_-1671******</AliCloudCertificateId>
    <IsAliCloudCertificate>0</IsAliCloudCertificate>
    <SubjectAlternativeNames>["example.com","www.example.com"]</SubjectAlternativeNames>
</UploadServerCertificateResponse>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

{
  "AliCloudCertificateName" : "cloudcertificate****",
  "CreateTimeStamp" : 1504147745000,
  "ExpireTime" : "2022-10-18T23:59:59Z",
  "CreateTime" : "2022-02-21T02:49:05Z",
  "ServerCertificateId" : "1321932713******_17f1b4b696b_1114720822_-1671******",
  "ExpireTimeStamp" : 1504147745000,
  "RegionId" : "cn-hangzhou",
  "RequestId" : "365F4154-92F6-4AE4-92F8-7FF34B540710",
  "Fingerprint" : "8f:7d:cb:e5:f8:c8:33:9c:17:65:c1:92:30:9e:45:55:9c:3a:85:60",
  "ServerCertificateName" : "mycert01",
  "CommonName" : "example.com",
  "ResourceGroupId" : "rg-atstuj3rt****",
  "AliCloudCertificateId" : "1321932713******_17f1b4b696b_1114720822_-1671******",
  "IsAliCloudCertificate" : 0,
  "SubjectAlternativeNames" : [ "[\"example.com\",\"www.example.com\"]" ]
}

错误码

HttpCode 错误码 错误信息 描述
400 IllegalParam.ServerCertificate The specified server certificate is illegal. 指定的ServerCertificate无效。请检查参数约束,并在修改后重试。
400 InvalidParameter The specified ServerCertificate and PrivateKey fail to validate. 指定的证书和私钥校验失败。
400 ServerCertificate.NotSupport The specified Region Not support ServerCertificate. 指定地域不支持服务器证书。
400 InvalidParameter.AliCloudCertificateId The specified AliCloudCertificateId is invalid. 指定的AliCloudCertificateId无效。请检查参数约束,并在修改后重试。

访问错误中心查看更多错误码。