为指定自定义域名上传SSL证书。
接口说明
- 此功能面向 API 提供者。
- SSL 证书必须与域名匹配。
- 绑定 SSL 证书后，可提供基于 HTTPS 的 API 服务。
- HTTPS 双向认证场景才需要填写根证书，一般情况不需要填写。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：
- 操作：是指具体的权限点。
- 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
- 资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用
全部资源表示。
- 条件关键字：是指云产品自身定义的条件关键字。
- 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
| 操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
|---|---|---|---|---|
| apigateway:SetDomainCertificate | update | *ApiGroup acs:apigateway:{#regionId}:{#accountId}:apigroup/{#GroupId} |
| 无 |
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| GroupId | string | 是 | API 分组 ID，系统生成，全局唯一 | 927d50c0f2e54b359919923d908bb015 |
| DomainName | string | 是 | 自定义域名 | api.demo.com |
| CertificateName | string | 是 | SSL 证书名称 | test_cert |
| CertificateBody | string | 否 | 证书内容 | 请参见如下请求示例 -----BEGIN RSA PRIVATE KEY----- MIIEpAIBAAKCAQEA8GjIleJ7rlo86mtbwcDnUfqzTQAm4b3zZEo1aKsfAuwcvCud .... -----END RSA PRIVATE KEY----- |
| CertificatePrivateKey | string | 否 | 证书私钥 | 请参见如下请求示例 -----BEGIN RSA PRIVATE KEY----- MIIEpAIBAAKCAQEA8GjIleJ7rlo86mtbwcDnUfqzTQAm4b3zZEo1aKsfAuwcvCud .... -----END RSA PRIVATE KEY----- |
| CaCertificateBody | string | 否 | CA 证书内容 说明
（ HTTPS 双向认证场景使用）。
| CA证书的编码内容 |
| SslVerifyDepth | string | 否 | 证书验证深度 说明
（ HTTPS 双向认证场景使用）。
| 2 |
| SslOcspEnable | boolean | 否 | 是否支持 OCSP 验证 说明
（ HTTPS 双向认证场景使用）。
| True |
| ClientCertSDnPassThrough | boolean | 否 | 将证书中 ssl_client_s_dn 的值通过 Header 'X-Client-S-Dn' 传输给后端服务 说明
（ HTTPS 双向认证场景使用）。
| True |
返回参数
示例
正常返回示例
JSON格式
{
"RequestId": "6EF60BEC-0242-43AF-BB20-270359FB54A7"
}错误码
访问错误中心查看更多错误码。
变更历史
| 变更时间 | 变更内容概要 | 操作 |
|---|---|---|
| 2024-11-14 | OpenAPI 描述信息更新 | 查看变更详情 |
| 2024-10-21 | OpenAPI 入参发生变更 | 查看变更详情 |
| 2024-02-19 | API 内部配置变更，不影响调用 | 查看变更详情 |