为加速域名配置证书接口

最近更新时间:2020-10-30 19:42:07

查看PDF

ConfigCertificate

描述

本接口用于为单个或多个加速域名配置服务证书。此接口支持形如:*.a.com的泛域名证书配置服务。

请求语法

本接口请求需要包含指定目录/2016-09-01/cert/ConfigCertificate、公共请求header和该接口所特有的请求参数,具体请求语句参照下文请求示例。

请求参数

参数名 必选 **类型及范围 ** 说明
Enable String 开启、关闭设置服务证书,取值:on:开启,off:关闭,默认为off。当选择开启时,以下为必填 ;当选择关闭时,联动关闭 HTTP 2.0 和强制跳转
DomainIds String 域名ID
CertificateId String 金山云生成的安全证书唯一性ID,若输入证书ID,则以下内容可不填写,若无证书ID,则以下内容为必填
CertificateName String 安全证书名称
ServerCertificate String 域名对应的安全证书内容
PrivateKey String 安全证书对应的私钥内容

注: CertificateId有值时,忽略CertificateName、ServerCertificate和Privatekey的值。

错误码

ErrorCode错误码 ** Message 错误信息** ** HTTP 状态** ** 语义**
InvalidEnable.ValueNotSupported The specified value of parameter Enable is not supported. 400 Enable的值不合法
ServerCertificate.MissingParameter An input parameter ServerCertificate that is mandatory for processing the request is not supplied. 400 ServerCertificate参数缺失
PrivateKey.MissingParameter An input parameter PrivateKey that is mandatory for processing the request is not supplied. 400 PrivateKey参数缺失
InvalidServerCertificate The ServerCertificate you provided is malformed! 400 证书内容不合法
InvalidPrivateKey The Private Key you provided is malformed! 400 私钥内容不合法
ServerCertificate.MissMatch The Private Key does not math the specified ServerCertificate! 400 证书和私钥不匹配
InvalidServerCertificate.TooLong The ServerCertificate you provided is over the max length! 400 证书私钥内容超过长度限制(16K)
InvalidServerCertificateName.TooLong The ServerCertificate name you provided is over the max length 128! 400 证书名称不能超过128个字符
Certificate.Duplicated The Certificate name is duplicated. 400 证书名称重复
Certificate.CertNull The Certificate is not null. 400 证书不能为空
Certificate.FormatError The Certificate format is error. 400 证书格式错误
Certificate.KeyNull The private key is not null. 400 私钥不能为空
Key.Malformed The private key format is error. 400 私钥格式错误
ServerCertificateName.NameNull The ServerCertificateName 400 证书名称不能为空

示例

请求示例

POST方式:

POST /2016-09-01/cert/ConfigCertificate
Host: cdn.api.ksyun.com
X-Amz-Date: date
Authorization:authorization string
x-action: ConfigCertificate
x-version: 2016-09-01
Content-Type: application/json

{
    {
    "Enable":"on",
    "DomainIds":"2D08BS7",
    "CertificateName":"test",
    "ServerCertificate":"-----BEGIN CERTIFICATE-----\nMIIC2jCCAcKgAwIBAgIUUF4UPAJvGsvsrSmS4gjXfoyKWY8wDQYJKoZIhvcNAQEL\nBQAwGDEWMBQGA1UEAwwNZHlsYW5mZW5nLmNvbTAeFw0yMDEwMjkxMTU0MTBaFw0z\nMTA4MDIwMDAwMDBaMCExHzAdBgNVBAMMFnl1a2kuMTAzMC5rc2MtdGVzdC5jb20w\nggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQDFBLkHpEGo5d8AdfMQzEls\nciXNv10gilLPFK+vDG/IItbdsttyA8J+s+HJtkZJatrzYFm2UPv/t6RB+gtCXi/c\nPOwRlb8H4J3t+a4ARJZZ2M8HxsRpwBllOvPrmwHMBnsq0iQVU7Mud2J1DSQJjDZt\nCrkpv0PtYg6tt704n/\nl7jc1Sac0RV8/n4Yia15cMlnxwIl1zTtIhL13cCXjWDAz1\n+lCL+puwhq6s42sLTF7g9wLFm9H9h7Wa+JLSKa63iPgW7ziDTudn1yX9fjyZScAi\nt+VzADo7FKGZl6WkfREKLYT9Dks1TLVEdF2sTxfvmq2h5H6A4FgfpW8aCJ3/WfdF\nAgMBAAGjEzARMA8GA1UdEwEB/\nwQFMAMBAf8wDQYJKoZIhvcNAQELBQADggEBAKrn\nsqWg6N2KC3d6C2VE5/pJAwzQTmUla8Jq+aMwnTkS38y8PN5XGlnI4glYmY1UOimH\n0zc867Fl2KnuUxhTDykpmt5Dwa2OPtXS8hVP0PPb/sY1f4LsIh0tBfYsqs7YeMCr\nE01R7lX7kDO05k+FUZHWNcEKkjEIxS\n+8DL6s4GwezJUyB6HbH3TP7TPNE5+Ba0z0\nqHbs97MGHdOTfBG+Brcka3tiQeIJR+DTv4GLBuhJ1HK8LC3EJgFX1vv06G+yiH5z\ntLjQuOFaweaJrWo/yWpx+HPER06rCQsekxZ66bkCkIwgGXN9xSVk+5gkeP07Vu+u\nfE2Dkofso83el6Oeoi8=\n-----END CERTIFICATE-----",
    "PrivateKey":"-----BEGIN PRIVATE KEY-----\nMIIEvQIBADANBgkqhkiG9w0BAQEFAASCBKcwggSjAgEAAoIBAQDFBLkHpEGo5d8A\ndfMQzElsciXNv10gilLPFK+vDG/IItbdsttyA8J+s+HJtkZJatrzYFm2UPv/t6RB\n+gtCXi/cPOwRlb8H4J3t+a4ARJZZ2M8HxsRpwBllOvPrmwHMBnsq0iQVU7Mud2J1\nDSQJjDZtCrkpv0PtYg6tt704n/l7jc1Sac0RV8/n4Yia15cMlnxwIl1zTtIhL13c\nCXjWDAz1+lCL+puwhq6s42sLTF7g9wLFm9H9h7Wa+JLSKa63iPgW7ziDTudn1yX9\nfjyZScAit+VzADo7FKGZl6WkfREKLYT9Dks1TLVEdF2sTxfvmq2h5H6A4FgfpW8a\nCJ3/WfdFAgMBAAECggEAeiqpiWGDDXYsx55b8GichtBpPKGS36CmJJ5RKhxuHA3u\nal6D0LkgG2zzbx7FirTlu9BdEL465KA9DGQ+IxNAXjKwt17Bq+LOS0htauEc0e2s\nwsev91sU5D6gDdJ6VMcYDL9tfIQAMan5tVdGp1z4SrlBg++D8WjCbVnnzXr1OnTk\n9Xd3wv6v/zz5NOvSdfN2la3DfsCsuA1wgXqL5m1HO2345wToZJGjNCy676ysmIVl\nxVaokrwm0ZnFv1Oyo2/Xp4e4ZFILFCQpwFRHGhi8j4hvq8HCku0fv1Y8pAKkVaLT\nBz/UTqhixsMxL7SjmCWCI5/WIpfs9en86mnLeFrxwQKBgQD9Y0Uws/AtF7+5BkH9\nU3nfGSAfJnkBMlsYatZeCbQJuLguckcJjNkiS2B9mUWPvNtN1YjuHpSmhFUDdD32\nZAset9g65YdUyAjN3XtUVoL5ndrnvbUZ+kipHQqRo8pHYO2lbK+xTO0jERyUNASV\nljay7pP20o7TkfQKv6vdA0zNjQKBgQDHDK9hrPPOhQKtAmDqSGa0ysd5WT6EfWyX\nFz+YIJyEDCb67HjZtIqjSYK7RgILhU9V+WG8SdxB6h9s45Mvzu8bjuT/h/fHzbv8\n9ItiOtcP1/+BPbG+PaYebpQvI7c1NG+7nk+vzUF89sRT/aC6lhxqOFXfnptmwfxQ\nNF8pNy0WmQKBgQC61ylc2UH/riRkRZYBOz2BYaCK966AUGZVoeoCG3uTM480SHXT\nN/WgUR6MXqmpbKP1R8CZfRk1lByv2FYcSfbdJskd3MQmov3C908KiGQ5tcmF2iAh\nUKmlcdGqRLFSYsm5kmQXA9dUZTjCm3zJ5KLe3AdlGCvTHCtshZsv9E/8vQKBgEfe\nlaiP2QwVTI0JUdLlx2e52+I9zevqmX3IYCbeh4TKGnz5Sv1YScKBdVmHApAEV0v0\nmkxw4r1N+oDHfsqBTiZGJvr4rgePijPgXD9gfWx0EgYpL3dALS3JwWlv3OOyBjHZ\nDG6ujtm/A85Lwm/8aVAU/TSbwQKOQjr3XfC0wmvpAoGANKx56eIwMJwh+dqpzW8+\nXgCFqO+FIzrwCHafqgAzEgTREzLXJ4rR2SC/bbYhtCb+4Xb4gzS8bQ/ca5kSotX/\n5vBYfTfjVG36VZFLuPA8K5zYqlSqqH96LpZJdI1ZgODK9u6bzovwvguXpzBD/Prm\nqQFaxxzO8P2F6DBSeNJxPT8=\n-----END PRIVATE KEY-----"
}
}

返回示例

{
    "CertificateId": "6145"
}

文档内容是否对您有帮助?

根本没帮助
文档较差
文档一般
文档不错
文档很好

在文档使用中是否遇到以下问题

内容不全,不深入
内容更新不及时
描述不清晰,比较混乱
系统或功能太复杂,缺乏足够的引导
内容冗长

更多建议

0/200

评价建议不能为空

提交成功!

非常感谢您的反馈,我们会继续努力做到更好!

问题反馈