全球应用加速认证高级配置-API 文档-文档中心-腾讯云

1. 接口描述

接口请求域名： gaap.tencentcloudapi.com 。

本接口（SetAuthentication）用于通道的高级认证配置，包括认证方式选择，以及各种认证方式对应的证书选择。仅支持Version3.0的通道。

默认接口请求频率限制：20次/秒。

推荐使用 API Explorer

点击调试

API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见公共请求参数。

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：SetAuthentication。
Version	是	String	公共参数，本接口取值：2018-05-29。
Region	否	String	公共参数，此参数为可选参数。
ListenerId	是	String	监听器ID。示例值：0
Domain	是	String	需要进行高级配置的域名，该域名为监听器下的转发规则的域名。示例值：a.a.com
BasicAuth	否	Integer	基础认证开关，其中： 0，关闭基础认证； 1，开启基础认证。默认为0。示例值：1
GaapAuth	否	Integer	通道认证开关，用于源站对Gaap的认证，其中： 0，关闭通道认证； 1，开启通道认证。默认为0。示例值：1
RealServerAuth	否	Integer	源站认证开关，用于Gaap对服务器的认证，其中： 0，关闭源站认证； 1，开启源站认证。默认为0。示例值：0
BasicAuthConfId	否	String	基础认证配置ID，从证书管理页获取。示例值：xxx
GaapCertificateId	否	String	通道SSL证书ID，从证书管理页获取。示例值：xxx
RealServerCertificateId	否	String	源站CA证书ID，从证书管理页获取。源站认证时，填写该参数或RealServerCertificateId参数
RealServerCertificateDomain	否	String	该字段已废弃，请使用创建规则和修改规则中的SNI功能。
PolyRealServerCertificateIds.N	否	Array of String	多源站CA证书ID，从证书管理页获取。源站认证时，填写该参数或RealServerCertificateId参数示例值：[]
TLSSupportVersion.N	否	Array of String	TLS支持的版本支持TLSv1，TLSv1.1,TLSv1.2,TLSv1.3 示例值：['TLSv1', 'TLSv1.1']
TLSCiphers	否	String	支持的TLS密码套件，可选值为： [GAAP_TLS_CIPHERS_WIDE,GAAPTLS_CIPHERS_GENERAL,GAAPTLS_CIPHERS_STRICT] 示例值：GAAP_TLS_CIPHERS_WIDE

3. 输出参数

参数名称	类型	描述
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 认证高级配置

输入示例

POST / HTTP/1.1
Host: gaap.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: SetAuthentication
<公共请求参数>

{
    "Domain": "www.baidu.com",
    "GaapAuth": 1,
    "GaapCertificateId": "cert-ndqyqw8h",
    "ListenerId": "listener-0s9kb7qt",
    "BasicAuth": 0,
    "RealServerAuth": 0
}

输出示例

{
    "Response": {
        "RequestId": "c7bfcad5-3f20-472f-9afc-13a66faebad8"
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台，方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况，并自动生成各语言版本的 API 代码，也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集（SDK），支持多种编程语言，能更方便的调用 API。

Tencent Cloud SDK 3.0 for Python: GitHub Gitee
Tencent Cloud SDK 3.0 for Java: GitHub Gitee
Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
Tencent Cloud SDK 3.0 for Go: GitHub Gitee
Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
Tencent Cloud SDK 3.0 for C++: GitHub Gitee
Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee

命令行工具

Tencent Cloud CLI 3.0

6. 错误码

以下仅列出了接口业务逻辑相关的错误码，其他错误码详见公共错误码。

错误码	描述
AuthFailure	CAM签名/鉴权错误。
AuthFailure.NotEnterpriseAuthorization	非企业认证客户。
AuthFailure.UnauthorizedOperation	子账户未授权操作。
FailedOperation	操作失败。
FailedOperation.ActionIsDoing	操作正在执行中，请勿重复操作。
FailedOperation.ListenerHasTask	监听器正在操作中，请勿重复操作。
FailedOperation.ListenerStatusError	监听器当前状态无法支持该操作。
FailedOperation.NotSupportOldVersionProxy	仅支持Version2.0的通道。
FailedOperation.ProxyVersionNotSupport	不支持该版本通道。
FailedOperation.UserNotConfirmProtocol	未开通协议。
InternalError	内部错误。
InvalidParameter	参数错误。
InvalidParameterValue	参数取值错误。
InvalidParameterValue.InvalidCertificateId	证书不可用。
MissingParameter	缺少参数错误。
ResourceNotFound	资源不存在。
ResourceUnavailable	资源不可用。
ResourceUnavailable.AccountViolation	账号下存在违规资源，详情请查看站内信或邮件。
UnauthorizedOperation	未授权操作。
UnknownParameter	未知参数错误。

认证高级配置

本页目录：