tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

ModifyAliasDomain

Last updated: 2024-12-03 16:17:59

    1. API Description

    Domain name for API request: teo.intl.tencentcloudapi.com.

    This API is used to modify an alias domain name.

    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: ModifyAliasDomain.
    Version Yes String Common Params. The value used for this API: 2022-09-01.
    Region No String Common Params. This parameter is not required.
    ZoneId Yes String The site ID.
    AliasName Yes String The alias domain name.
    TargetName Yes String The target domain name.
    CertType No String Certificate configuration. Values:
  • none: Off
  • hosting: Managed SSL certificate
  • apply: Free certificate
    • The original configuration will apply if this field is not specified.
    CertId.N No Array of String The certificate ID. This field is required when CertType=hosting.

    3. Output Parameters

    Parameter Name Type Description
    RequestId String The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.

    4. Example

    Example1 Modifying an alias domain name

    Input Example

    POST / HTTP/1.1
Host: teo.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ModifyAliasDomain
<Common request parameters>

{
    "TargetName": "bbb.example.com",
    "AliasName": "eo.test.com",
    "CertType": "none",
    "ZoneId": "zone-28569s6od5na"
}

    Output Example

    {
    "Response": {
        "RequestId": "6d1efe51-b951-498e-9b10-755906835e87"
    }
}

    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
    FailedOperation Operation failed.
    InternalError Internal error.
    InvalidParameter.CertNotMatchDomain Invalid edge HTTPS certificate configuration. The certificate does not match the domain name.
    OperationDenied Operation denied.
    Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
    Privacy PolicyLegalCookie Policy