SSL证书管理接口
上传SSL证书
接口方法:POST
url参数
参数名称 | 类型 | 是否必须 | 描述 |
Action | string | 是 | UploadCert |
Version | string | 是 | 2017-11-16 |
post body参数
参数名称 | 类型 | 是否必须 | 描述 |
CertName | string | 是 | 证书名称 |
Cert | string | 是 | 证书+证书链(pem) |
PrivateKey | string | 是 | 私钥 (pem) |
返回参数
参数名称 | 类型 | 是否必须 | 描述 |
RequestId | string | 是 | |
certId | string | 是 | |
请求示例
https://open.cn-east-1.163yun.com/ssl?Action=UploadCert&Version=2017-11-16
-d
'{
CertName: "xxx",
Cert: "xxx",
PrivateKey: "xxx"
}'
返回示例
{
"CertId": "2d5a2a60-c29c-11e7-972a-db3207c6f883",
"RequestId": "ae5772c0-9f2d-423c-8b85-267e4e40a583"
}
获取上传的证书
接口方法:GET
请求参数
参数名称 | 类型 | 是否必须 | 描述 |
Offset | integer | 是 | |
Limit | integer | 是 | |
Action | string | 是 | GetUploadedCertList |
Version | string | 是 | 2017-11-16 |
返回参数
参数名称 | 类型 | 是否必须 | 描述 |
total | integer | 是 | |
RequestId | string | 是 | |
certList | array | 是 | 详细信息见下表 |
certList
参数名称 | 类型 | 是否必须 | 描述 |
commonName | string | 是 | 通用名称,一般为域名 |
createTime | string | 是 | 证书订单的创建时间 |
certName | string | 是 | 证书名称 |
tenantId | string | 是 | 用户id |
updateTime | string | 是 | 更新时间 |
certId | string | 是 | 证书id |
fingerPrint | string | 是 | 证书指纹 |
issuer | string | 是 | 证书签发者 |
san | array | 是 | 多个域名的情况 |
notBefore | string | 是 | 证书生效时间 |
notAfter | string | 是 | 证书过期时间 |
请求示例
https://open.cn-east-1.163yun.com/ssl?Action=GetUploadedCertList&Version=2017-11-16&Offset=&Limit=
返回示例
{
"total": 1,
"certList": [{
"certId": "af407940-f3d2-11e8-9dcc-7ff49884dddc",
"tenantId": "3605e828cb52479d940b633865924f0e",
"certName": "nginx_xxx_com",
"commonName": "nginx.xxx.com",
"fingerPrint": "C8:EE:C4:58:B8:92:99:E8:0D:95:6D:7C:0C:43:5F:42:DE:37:18:61",
"issuer": "TrustAsia TLS RSA CA",
"san": [],
"notBefore": "2018-11-28T00:00:00Z",
"notAfter": "2019-11-28T12:00:00Z",
"createTime": "2018-11-29T12:31:24Z",
"updateTime": "2018-11-29T12:31:24Z"
}],
"RequestId": "4dfee4d8-6ac1-4213-9cf2-8f6ea9ee9700"
}
异常返回
- Offset, Limit非法字符: status 400, Code: InvalidFormat
- Offset, Limit超出范围: status 400, Code: InvalidParameterValue
删除(上传的)证书
接口方法:GET
请求参数
参数名称 | 类型 | 是否必须 | 描述 |
CertId | string | 是 | |
Action | string | 是 | DeleteCert |
Version | string | 是 | |
请求示例
https://open.cn-east-1.163yun.com/ssl?Action=DeleteCert&Version=2017-11-16&CertId=xxx
返回示例
{"Code":"Success","Message":"成功","RequestId":"e38e5436-1c18-4c0b-90cb-e5fc6dc419e9"}
异常返回
- CertId找不到: status 404, Code: ResourceNotFound
- 没有指定CertId: status 400, Code: MissingParameter
- 状态不匹配: status 400, Code: StateMismatch
获取预定义的cipher suite列表
接口方法:GET
请求参数
参数名称 | 类型 | 是否必须 | 描述 |
Offset | integer | 是 | |
Limit | integer | 是 | |
Action | string | 是 | GetPredefinedCipherList |
Version | string | 是 | 2017-11-16 |
返回参数
参数名称 | 类型 | 是否必须 | 描述 |
cipherList | array | 是 | 将Array中的参数自动创建为模型,需要核对参数是否正确并增加描述 |
total | integer | 是 | |
cipherList
参数名称 | 类型 | 是否必须 | 描述 |
versions | array | 是 | |
createTime | string | 是 | |
dhparam | object | 是 | 详细信息见下表 |
ciphers | string | 是 | |
cipherId | string | 是 | |
cipherName | string | 是 | |
dhparam
参数名称 | 类型 | 是否必须 | 描述 |
bits | integer | 是 | |
请求示例
https://open.cn-east-1.163yun.com/ssl?Action=GetPredefinedCipherList&Version=2017-11-16&Offset=&Limit=
返回示例
{
"Total": 3,
"CipherList": [
{
"CipherId": "uuid",
"CipherName": "2017-12-HIGH",
"Versions": ["sslv3", "tlsv1", "tlsv1.1", "tlsv1.2"],
"Ciphers": "ECDHE-ECDSA-AES256-GCM-SHA384:ECDHE-RSA-AES256-GCM-SHA384:ECDHE-ECDSA-AES128-GCM-SHA256:ECDHE-RSA-AES128-GCM-SHA256:ECDHE-ECDSA-AES256-SHA384:ECDHE-RSA-AES256-SHA384:ECDHE-ECDSA-AES128-SHA256:ECDHE-RSA-AES128-SHA256",
"Dhparam": {
"Bits": 2048
},
"CreateAt": "2017-10-17T14:38:08Z"
}
]
}
获取证书配额
接口方法:GET
请求参数
参数名称 | 类型 | 是否必须 | 描述 |
Action | string | 是 | GetCertQuota |
Version | string | 是 | 2017-11-16 |
返回参数
参数名称 | 类型 | 是否必须 | 描述 |
RequestId | string | 是 | |
cert | object | 是 | 自动创建的模型,需要核对参数是否正确并增加描述 |
order | object | 是 | 自动创建的模型,需要核对参数是否正确并增加描述 |
order
参数名称 | 类型 | 是否必须 | 描述 |
quota | integer | 是 | |
used | integer | 是 | |
cert
参数名称 | 类型 | 是否必须 | 描述 |
quota | integer | 是 | |
used | integer | 是 | |
请求示例
https://open.cn-east-1.163yun.com/ssl?Action=GetCertQuota&Version=2017-11-16
返回示例
{
"Order": {
"Quota": 50,
"Used": 13
},
"Cert": {
"Quota": 50,
"Used": 5
},
"RequestId": "2b2b7ffa-0a5d-4fbd-a72d-edf1454058c9"
}
获取购买的证书列表
接口方法:GET
请求参数
header
参数名称 | 类型 | 是否必须 | 描述 |
Accept-Language | string | 是 | |
query
参数名称 | 类型 | 是否必须 | 描述 |
Offset | integer | 是 | |
Limit | integer | 是 | |
Action | string | 是 | GetPurchasedCertList |
Version | string | 是 | 2017-11-16 |
返回参数
参数名称 | 类型 | 是否必须 | 描述 |
total | integer | 是 | |
RequestId | string | 是 | |
certList | array | 是 | 详细信息见下表 |
certList
参数名称 | 类型 | 是否必须 | 描述 |
commonName | string | 是 | 通用名称 ,一般为域名 |
isPaid | boolean | 是 | 是否为付费证书 |
certTypeName | string | 是 | 证书类型名 |
certBeginTime | string | 是 | 证书有效期的开始时间 |
certOrderState | string | 是 | 证书的订单状态 |
certExpireTime | string | 是 | 证书过期时间 |
certName | string | 是 | 证书名称,如企业型 OV |
certId | string | 是 | 证书id |
certCreateTime | string | 是 | 证书订单创建时间 |
certValidityPeriod | integer | 是 | 有效期 |
certBrand | string | 是 | 证书品牌 |
certOrderMemo | string | 是 | 证书订单的名称 |
category | string | 是 | 证书类别 |
certOrderMsg | string | 是 | 证书返回信息,一般为错误信息 |
san | array | 是 | 多域名情况下的其他域名 |
请求示例
https://open.cn-east-1.163yun.com/ssl?Action=GetPurchasedCertList&Version=2017-11-16&Offset=&Limit=
返回示例
{
"total": 1,
"certList": [{
"certId": "b2b33fa4-a9f0-438d-9ae0-6f18e72fd6a5",
"certOrderMemo": "netease_test",
"certTypeName": "TrustAsia DV G5",
"commonName": "www.hedustudy.com",
"san": [],
"certOrderState": "apply_verifing",
"certCreateTime": "2019-11-28T09:47:01Z",
"certBeginTime": "0000-00-00T00:00:00Z",
"certValidityPeriod": 12,
"certExpireTime": "0000-00-00T00:00:00Z",
"certBrand": "Symantec",
"isPaid": false,
"category": "DV",
"certOrderMsg": "",
"certName": "TrustAsia 域名型 SSL证书 (G5)"
}],
"RequestId": "40a00035-37c9-4389-a7b5-874581e60621"
}
获取购买的证书详情
接口方法:GET
请求参数
参数名称 | 类型 | 是否必须 | 描述 |
CertId | string | 是 | |
Action | string | 是 | GetPurchasedCertDetail |
Version | string | 是 | 2017-11-16 |
返回参数
参数名称 | 类型 | 是否必须 | 描述 |
RequestId | string | 是 | |
certInfo | object | 是 | 自动创建的模型,需要核对参数是否正确并增加描述 |
adminInfo | object | 是 | 自动创建的模型,需要核对参数是否正确并增加描述 |
orgInfo | object | 是 | 自动创建的模型,需要核对参数是否正确并增加描述 |
orgInfo
参数名称 | 类型 | 是否必须 | 描述 |
orgProvince | string | 是 | 公司所属省份 |
orgName | string | 是 | 公司名 |
orgCountryCode | string | 是 | 公司国家代码 |
orgUnit | string | 是 | 公司里的部门 |
orgCity | string | 是 | 公司所属城市 |
orgRegion | string | 是 | 公司所属区 |
orgAddress | string | 是 | 公司所属地址 |
orgPostalCode | string | 是 | 公司邮政编码 |
orgPhone | string | 是 | 公司电话 |
adminInfo
参数名称 | 类型 | 是否必须 | 描述 |
adminPhone | string | 是 | 证书关联的管理员手机号 |
adminFirstName | string | 是 | 证书关联的管理员姓 |
adminTitle | string | 是 | 证书关联的管理员职位 |
adminLastName | string | 是 | 证书关联的管理员名 |
adminEmail | string | 是 | 证书关联的管理员邮箱 |
certInfo
参数名称 | 类型 | 是否必须 | 描述 |
commonName | string | 是 | 通用名称,一般为主域名 |
san | array | 是 | 其他多个域名 |
certTypeName | string | 是 | 证书类型名 |
certBeginTime | string | 是 | 证书生效的开始时间 |
certOrderState | string | 是 | 证书订单的状态 |
certExpireTime | string | 是 | 证数的过期时间 |
certName | string | 是 | 证书名称比如OV |
certId | string | 是 | 证书id |
certCreateTime | string | 是 | 证书创建时间 |
certValidityPeriod | integer | 是 | 有效期 |
certBrand | string | 是 | 证书品牌 |
subCertOrderId | string | 是 | 子订单id |
subCertOrderMemo | string | 是 | 子订单名称 |
parCertOrderId | string | 是 | 父订单id |
parCertOrderMemo | string | 是 | 父订单名称 |
certOrderMemo | string | 是 | 证书名 |
isPaid | boolean | 是 | 是否为付费证书 |
请求示例
https://open.cn-east-1.163yun.com/ssl?Action=GetPurchasedCertDetail&Version=2017-11-16&Offset=&Limit=&CertId=xxx
返回示例
{
"CertInfo": {
"CertId": "244bc7f9-d159-4243-8d72-e0cccf045e73",
"CertName": "mycert",
"CertTypeName": "TrustAsiaDVG5",
"CommonName": "cc.sslmanager.top",
"San": ["bb.sslmanager.top", "cc.sslmanager.top"],
"CertState": "apply_failed",
"CertSubState": -1,
"CertCreateTime": "0000-00-00T00:00:00Z",
"CertBeginTime": "0000-00-00T00:00:00Z",
"CertValidityPeriod": 12,
"CertExpireTime": "0000-00-00T00:00:00Z",
"CertBrand": "Symantec"
},
"OrgInfo": {
"OrgName": "网易",
"OrgUnit": "IT部",
"OrgCountryCode": "CN",
"OrgProvince": "浙江省",
"OrgCity": "杭州",
"OrgRegion": "滨江区",
"OrgAddress": "长河街道网商路599号",
"OrgPostalCode": "310052",
"OrgPhone": "183232232323"
},
"AdminInfo": {
"AdminFirstName": "三",
"AdminLastName": "张",
"AdminPhone": "1888888888888",
"AdminEmail": "xx@163.com",
"AdminTitle": "IT"
},
"RequestId": "f223e824-c3be-4f56-ada4-18c9dfc6c3d8"
}
异常返回
- CertId没找到: status: 404, Code: ResourceNotFound
- 不是订单证书: status: 400, Code: NotCertOrder
- 没指定CertId: status: 400, Code: MissingParameter