SSL证书管理接口

上传SSL证书

接口方法:POST

url参数

参数名称类型是否必须描述
ActionstringUploadCert
Versionstring2017-11-16

post body参数

参数名称类型是否必须描述
CertNamestring证书名称
Certstring证书+证书链(pem)
PrivateKeystring私钥 (pem)

返回参数

参数名称类型是否必须描述
RequestIdstring
certIdstring

请求示例

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

请求参数

参数名称类型是否必须描述
Offsetinteger
Limitinteger
ActionstringGetUploadedCertList
Versionstring2017-11-16

返回参数

参数名称类型是否必须描述
totalinteger
RequestIdstring
certListarray详细信息见下表

certList

参数名称类型是否必须描述
commonNamestring通用名称,一般为域名
createTimestring证书订单的创建时间
certNamestring证书名称
tenantIdstring用户id
updateTimestring更新时间
certIdstring证书id
fingerPrintstring证书指纹
issuerstring证书签发者
sanarray多个域名的情况
notBeforestring证书生效时间
notAfterstring证书过期时间

请求示例

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"
}

异常返回

  1. Offset, Limit非法字符: status 400, Code: InvalidFormat
  2. Offset, Limit超出范围: status 400, Code: InvalidParameterValue

删除(上传的)证书

接口方法:GET

请求参数

参数名称类型是否必须描述
CertIdstring
ActionstringDeleteCert
Versionstring

请求示例

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"}

异常返回

  1. CertId找不到: status 404, Code: ResourceNotFound
  2. 没有指定CertId: status 400, Code: MissingParameter
  3. 状态不匹配: status 400, Code: StateMismatch

获取预定义的cipher suite列表

接口方法:GET

请求参数

参数名称类型是否必须描述
Offsetinteger
Limitinteger
ActionstringGetPredefinedCipherList
Versionstring2017-11-16

返回参数

参数名称类型是否必须描述
cipherListarray将Array中的参数自动创建为模型,需要核对参数是否正确并增加描述
totalinteger

cipherList

参数名称类型是否必须描述
versionsarray
createTimestring
dhparamobject详细信息见下表
ciphersstring
cipherIdstring
cipherNamestring

dhparam

参数名称类型是否必须描述
bitsinteger

请求示例

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

请求参数

参数名称类型是否必须描述
ActionstringGetCertQuota
Versionstring2017-11-16

返回参数

参数名称类型是否必须描述
RequestIdstring
certobject自动创建的模型,需要核对参数是否正确并增加描述
orderobject自动创建的模型,需要核对参数是否正确并增加描述

order

参数名称类型是否必须描述
quotainteger
usedinteger

cert

参数名称类型是否必须描述
quotainteger
usedinteger

请求示例

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-Languagestring

query

参数名称类型是否必须描述
Offsetinteger
Limitinteger
ActionstringGetPurchasedCertList
Versionstring2017-11-16

返回参数

参数名称类型是否必须描述
totalinteger
RequestIdstring
certListarray详细信息见下表

certList

参数名称类型是否必须描述
commonNamestring通用名称 ,一般为域名
isPaidboolean是否为付费证书
certTypeNamestring证书类型名
certBeginTimestring证书有效期的开始时间
certOrderStatestring证书的订单状态
certExpireTimestring证书过期时间
certNamestring证书名称,如企业型 OV
certIdstring证书id
certCreateTimestring证书订单创建时间
certValidityPeriodinteger有效期
certBrandstring证书品牌
certOrderMemostring证书订单的名称
categorystring证书类别
certOrderMsgstring证书返回信息,一般为错误信息
sanarray多域名情况下的其他域名

请求示例

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

请求参数

参数名称类型是否必须描述
CertIdstring
ActionstringGetPurchasedCertDetail
Versionstring2017-11-16

返回参数

参数名称类型是否必须描述
RequestIdstring
certInfoobject自动创建的模型,需要核对参数是否正确并增加描述
adminInfoobject自动创建的模型,需要核对参数是否正确并增加描述
orgInfoobject自动创建的模型,需要核对参数是否正确并增加描述

orgInfo

参数名称类型是否必须描述
orgProvincestring公司所属省份
orgNamestring公司名
orgCountryCodestring公司国家代码
orgUnitstring公司里的部门
orgCitystring公司所属城市
orgRegionstring公司所属区
orgAddressstring公司所属地址
orgPostalCodestring公司邮政编码
orgPhonestring公司电话

adminInfo

参数名称类型是否必须描述
adminPhonestring证书关联的管理员手机号
adminFirstNamestring证书关联的管理员姓
adminTitlestring证书关联的管理员职位
adminLastNamestring证书关联的管理员名
adminEmailstring证书关联的管理员邮箱

certInfo

参数名称类型是否必须描述
commonNamestring通用名称,一般为主域名
sanarray其他多个域名
certTypeNamestring证书类型名
certBeginTimestring证书生效的开始时间
certOrderStatestring证书订单的状态
certExpireTimestring证数的过期时间
certNamestring证书名称比如OV
certIdstring证书id
certCreateTimestring证书创建时间
certValidityPeriodinteger有效期
certBrandstring证书品牌
subCertOrderIdstring子订单id
subCertOrderMemostring子订单名称
parCertOrderIdstring父订单id
parCertOrderMemostring父订单名称
certOrderMemostring证书名
isPaidboolean是否为付费证书

请求示例

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"
}

异常返回

  1. CertId没找到: status: 404, Code: ResourceNotFound
  2. 不是订单证书: status: 400, Code: NotCertOrder
  3. 没指定CertId: status: 400, Code: MissingParameter