产品概述
实例类型对比
产品功能
应用场景
产品规格上限说明
Domain name for API request: gaap.intl.tencentcloudapi.com.
This API (SetAuthentication) is used for the advanced authentication configuration of connections, including authentication methods and their certificates. If only supports connections of version 3.0.
A maximum of 20 requests can be initiated per second for this API.
The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| Action | Yes | String | Common Params. The value used for this API: SetAuthentication. |
| Version | Yes | String | Common Params. The value used for this API: 2018-05-29. |
| Region | No | String | Common Params. This parameter is not required. |
| ListenerId | Yes | String | Listener ID. |
| Domain | Yes | String | The domain name requiring advanced configuration, i.e., the domain name of the listener's forwarding rules. |
| BasicAuth | No | Integer | Whether to enable the basic authentication: 0: disable basic authentication; 1: enable basic authentication. The default value is 0. |
| GaapAuth | No | Integer | Whether to enable the connection authentication, which is for the origin server to authenticate GAAP. 0: disable; 1: enable. The default value is 0. |
| RealServerAuth | No | Integer | Whether to enable the origin server authentication, which is for GAAP to authenticate the server. 0: disable; 1: enable. The default value is 0. |
| BasicAuthConfId | No | String | Basic authentication configuration ID, which is obtained from the certificate management page. |
| GaapCertificateId | No | String | Connection SSL certificate ID, which is obtained from the certificate management page. |
| RealServerCertificateId | No | String | CA certificate ID of the origin server, which is obtained from the certificate management page. When authenticating the origin server, enter this parameter or the RealServerCertificateIds parameter. |
| RealServerCertificateDomain | No | String | This field has been disused. Use ServerNameIndication instead. |
| PolyRealServerCertificateIds.N | No | Array of String | CA certificate IDs of multiple origin servers, which are obtained from the certificate management page. When authenticating the origin servers, enter this parameter or the RealServerCertificateId parameter. |
| Parameter Name | Type | Description |
|---|---|---|
| RequestId | String | The unique request ID, which is returned for each request. RequestId is required for locating a problem. |
POST / HTTP/1.1
Host: gaap.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: SetAuthentication
<Common request parameters>
{
"Domain": "a.a.com",
"GaapAuth": "1",
"GaapCertificateId": "xxx",
"ListenerId": "0",
"BasicAuthConfId": "xxx",
"BasicAuth": "1"
}{
"Response": {
"RequestId": "c7bfcad5-3f20-472f-9afc-13a66faebad8"
}
}TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.
| Error Code | Description |
|---|---|
| AuthFailure | CAM signature/authentication error. |
| AuthFailure.NotEnterpriseAuthorization | Not an organizational customer. |
| AuthFailure.UnauthorizedOperation | The sub-account is not authorized for this operation. |
| FailedOperation | Operation failed. |
| FailedOperation.ActionIsDoing | The operation is being performed. Do not perform it again. |
| FailedOperation.ListenerHasTask | The listener is in operation. Do not repeat the operation. |
| FailedOperation.ListenerStatusError | The listener does not support this operation in current status. |
| FailedOperation.NotSupportOldVersionProxy | Only connections of Version 2.0 are supported. |
| FailedOperation.ProxyVersionNotSupport | This version of connection is not supported. |
| FailedOperation.UserNotConfirmProtocol | Protocol not activated. |
| InternalError | Internal error. |
| InvalidParameter | Incorrect parameter. |
| InvalidParameterValue | Incorrect parameter value. |
| InvalidParameterValue.InvalidCertificateId | Certificate unavailable. |
| MissingParameter | Missing parameter. |
| ResourceNotFound | The resource does not exist. |
| ResourceUnavailable | The resource is unavailable. |
| ResourceUnavailable.AccountViolation | Restricted resources found in your account. Check your inbox and email for details. |
| UnauthorizedOperation | Unauthorized operation. |
| UnknownParameter | Unknown parameter. |
文档反馈