International
中国站
Console
PrevNext
search by keyword

Recent Pages

Documentation
Global Application Acceleration Platform
    Documentation
    Download PDF

    ModifyDomain

    Last updated: 2020-09-25 14:26:26
    Download PDF

    1. API Description

    Domain name for API request: gaap.tencentcloudapi.com.

    This API (ModifyDomain) is used to modify domain names of listeners. For connections of version 3.0, it supports modifying certificates of the domain names.

    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 parameter. The value used for this API: ModifyDomain.
    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 Layer-7 listener ID
    OldDomain Yes String Original domain name information
    NewDomain Yes String New domain name information
    CertificateId No String Server SSL certificate ID. It's only applicable to the connections of version 3.0:
    If this field is not passed in, the original certificate will be used;
    If this field is passed in, and CertificateId=default, the listener certificate will be used;
    For other cases, the certificate specified by CertificateId will be used.
    ClientCertificateId No String Client CA certificate ID. It's only applicable to the connections of version 3.0:
    If this field is not passed in, the original certificate will be used;
    If this field is passed in, and ClientCertificateId=default, the listener certificate will be used;
    For other cases, the certificate specified by ClientCertificateId will be used.
    PolyClientCertificateIds.N No Array of String Client CA certificate ID. It is only applicable to connections on version 3.0, where:
    If this field and ClientCertificateId are not included, the original certificate will be used;
    If this field is included, and ClientCertificateId=default, then the listener certificate will be used;
    In other cases, the certificate specified by ClientCertificateId or PolyClientCertificateIds will be used.

    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 Modifying the Forwarding Rule Domain Name of a Layer-7 Listener

    Modify the forwarding rule domain name of a layer-7 listener.

    Input Example

    https://gaap.tencentcloudapi.com/?Action=ModifyDomain
&ListenerId=0
&OldDomain=a.a.com
&NewDomain=b.b.com
&CertificateId=default
&<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.DomainAlreadyExisted The domain name is used by a listener.
    FailedOperation.InstanceStatusNotInRuning Unable to operate: the connection is not running.
    FailedOperation.InvalidListenerProtocol Invalid listener protocol.
    FailedOperation.ListenerHasTask The listener is in operation. Do not repeat the operation.
    InternalError Internal error.
    InvalidParameter Incorrect parameter.
    InvalidParameterValue Incorrect parameter value.
    ResourceNotFound The resource does not exist.
    UnauthorizedOperation Unauthorized operation.
    tencent
    Copyright © 2013-2021 Tencent Cloud. All Rights Reserved.
    Privacy PolicyLegalCookie Policy