tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

DeleteServiceSubDomainMapping

Last updated: 2024-10-10 21:41:10

    1. API Description

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

    This API is used to delete a custom domain name mapping in a service environment.
    You can use this API if you use a custom domain name and custom mapping. Please note that if you delete all mappings in all environments, a failure will be returned when this API is called.

    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: DeleteServiceSubDomainMapping.
    Version Yes String Common Params. The value used for this API: 2018-08-08.
    Region Yes String Common Params. For more information, please see the list of regions supported by the product.
    ServiceId Yes String Unique service ID.
    SubDomain Yes String Custom domain name bound to service.
    Environment Yes String Name of the environment whose mapping is to be deleted. Valid values: test (test environment), prepub (pre-release environment), release (release environment).

    3. Output Parameters

    Parameter Name Type Description
    Result Boolean Whether the path mapping of the custom domain name is successfully deleted.
    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 Deleting the path mapping of a custom domain name

    Input Example

    https://apigateway.tencentcloudapi.com/?Action=DeleteServiceSubDomainMapping
&ServiceId=service-19c5fnhy
&SubDomain=xxxxxxx
&Environment=test
&<Common request parameters>

    Output Example

    {
    "Response": {
        "Result": true,
        "RequestId": "1ab681ab-545a-4e71-91f1-8f1ea8ef13ad"
    }
}

    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.DeletePathMappingSetError An error occurred while deleting the custom domain name.
    FailedOperation.ServiceNotExist The service does not exist.
    InternalError Internal error.
    InvalidParameter.FormatError Incorrect parameter format.
    UnsupportedOperation.InvalidServiceTrade The service is currently isolated and therefore the operation is not supported.
    Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
    Privacy PolicyLegalCookie Policy