tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Global Application Acceleration Platform
    Documentation
    Download PDF

    SetAuthentication

    Last updated: 2023-07-13 15:25:25
    Download PDF

    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.

    We recommend you to use API Explorer
    Try it
    API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

    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 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.

    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

    POST / HTTP/1.1
Host: gaap.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"
}

    Output Example

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

    5. Developer Resources

    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
    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.
    Contact Us

    Contact our sales team or business advisors to help your business.

    Contact Us
    Technical Support

    Open a ticket if you're looking for further assistance. Our Ticket is 7x24 avaliable.

    Submit a Ticket
    7x24 Phone Support
    Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
    Privacy PolicyLegalCookie Policy