SetAuthentication

Last updated: 2020-01-13 15:52:41

1. API Description

Domain name for API request: gaap.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.

2. Input Parameters

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 parameter. The value used for this API: SetAuthentication
Version Yes String Common parameter. The value used for this API: 2018-05-29
Region No String Common parameter. This parameter is not required for this API.
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 Domain name of the origin server certificate.
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.

3. Output Parameters

Parameter Name Type Description
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Advanced Authentication Configuration

Input Example

https://gaap.tencentcloudapi.com/?Action=SetAuthentication
&ListenerId=0
&Domain=a.a.com
&BasicAuth=1
&BasicAuthConfId=xxx
&GaapAuth=1
&GaapCertificateId=xxx
&<Common request parameters>

Output Example

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

5. Developer Resources

API Explorer

This tool allows online call, signature authentication, SDK code generation and quick search of APIs to greatly improve the efficiency of using TencentCloud APIs.

SDK

TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

Command Line Interface

6. Error Code

The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.

Error Code Description
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.
InternalError Internal error
InvalidParameter Parameter error
InvalidParameterValue Parameter value error
InvalidParameterValue.InvalidCertificateId Certificate unavailable.
MissingParameter Parameter missing
ResourceNotFound Resource does not exist
ResourceUnavailable Resource is unavailable
UnauthorizedOperation Unauthorized operation
UnknownParameter Unknown parameter error