SetDomainCertificate_API 网关_API文档

插件下载了解更多
VS Code 插件
安装插件之前,确保已安装 VS Code安装插件之前,确保已安装 VS Code
Alibaba Cloud Developer Toolkit is a collection of extensions that can help access Alibaba Cloud services in Visual Studio Code.
JetBrains 插件
安装插件之前,确保已安装 JetBrains IDE安装插件之前,确保已安装 JetBrains IDE
The Alibaba Cloud Developer Toolkit for JetBrains makes it easier to access Alibaba Cloud services.

接口说明

  • 此功能面向 API 提供者。
  • SSL 证书必须与域名匹配。
  • 绑定 SSL 证书后,可提供基于 HTTPS 的 API 服务。
  • HTTPS 双向认证场景才需要填写根证书,一般情况不需要填写。

流控信息

当前云产品API请求速率暂未透出。

授权信息

如下是此API对应的授权信息,用于RAM权限策略语句的Action元素中,为RAM用户或RAM角色授予调用此API的权限。请通过 RAM 访问控制设置,使用方法可参考访问控制帮助文档

具体说明如下:展开详情

操作访问级别资源类型条件关键字关联操作
apigateway:SetDomainCertificate
Update
ApiGroup
acs:apigateway:{#regionId}:{#accountId}:apigroup/{#GroupId}

请求参数

字段名称字段详情
GroupIdstring

API 分组 ID,系统生成,全局唯一

示例值:927d50c0f2e54b359919923d908bb015参考取值来源:
    ModifyApiGroup
    CreateApiGroup
    DescribeApiGroups
DomainNamestring

自定义域名

示例值:api.demo.com参考取值来源:
    SetDomain
CertificateNamestring

SSL 证书名称

示例值:test_cert
CertificateBodystring

证书内容

示例值:请参见如下请求示例 -----BEGIN RSA PRIVATE KEY----- MIIEpAIBAAKCAQEA8GjIleJ7rlo86mtbwcDnUfqzTQAm4b3zZEo1aKsfAuwcvCud .... -----END RSA PRIVATE KEY-----
CertificatePrivateKeystring

证书私钥

示例值:请参见如下请求示例 -----BEGIN RSA PRIVATE KEY----- MIIEpAIBAAKCAQEA8GjIleJ7rlo86mtbwcDnUfqzTQAm4b3zZEo1aKsfAuwcvCud .... -----END RSA PRIVATE KEY-----
CaCertificateBodystring

CA 证书内容展开详情

示例值:CA证书的编码内容
SslVerifyDepthstring

证书验证深度展开详情

示例值:2
SslOcspEnableboolean

是否支持 OCSP 验证展开详情

示例值:True
ClientCertSDnPassThroughboolean

将证书中 ssl_client_s_dn 的值通过 Header 'X-Client-S-Dn' 传输给后端服务展开详情

示例值:True

返回参数

字段名称字段详情
RequestIdstring

请求唯一标识

示例值:6EF60BEC-0242-43AF-BB20-270359FB54A7

返回示例

变更历史

相关示例

2024年08月20日