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.
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). |
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. |
https://apigateway.tencentcloudapi.com/?Action=DeleteServiceSubDomainMapping
&ServiceId=service-19c5fnhy
&SubDomain=xxxxxxx
&Environment=test
&<Common request parameters>
{
"Response": {
"Result": true,
"RequestId": "1ab681ab-545a-4e71-91f1-8f1ea8ef13ad"
}
}
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
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. |
Was this page helpful?