Help & DocumentationAPIsAPI GatewayService APIsDelete path mapping for custom domain names

Delete path mapping for custom domain names

Last updated: 2020-02-21 16:18:47

Interface description

This API (DeleteServiceSubDomainMapping) is used to delete the custom domain name mapping of an environment in the service.
This interface can be used when a user uses a custom domain name and uses a custom mapping. Note, however, that calling this API will return a failure if the mappings for all environments are removed.

Input Parameter

The following request parameter list only lists the API request parameters. For other parameters, please see Common Request Parameters .

Parameter name Required Type Description
ServiceId Yes String Service unique ID
SubDomain Yes String Custom domain name bound to the service
Environment Yes String Environment name of the mapping to be deleted

Output Parameter

Parameter name Type Description
Code Int Common error code, 0 indicates success, other values indicate failure. For more information, please see the error code page Common error code
CodeDesc String Error code on the business side. Return the specific cause of the business error when a Success, error is returned on success.

Example

https://apigateway.api.qcloud.com/v2/index.php?
&<Common request parameters>
&Action=DeleteServiceSubDomainMapping
&serviceId=service-XXXX
&subDomain=www.qq.com
&environment=test

The returned results are as below:

{
    "code": "0",
    "message": "",
    "codeDesc": "Success"
}