tencent cloud

All product documents
APIs
DocumentationAPIsAPI GatewayService APIsDeleteService
DeleteService
Last updated: 2025-01-13 11:24:09
DeleteService
Last updated: 2025-01-13 11:24:09

1. API Description

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

This API is used to delete a service in API Gateway.

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: DeleteService.
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 ID of the service to be deleted.
SkipVerification No Integer A parameter used to set to skip the deletion precondition verification (only supported for services on dedicated instances).

3. Output Parameters

Parameter Name Type Description
Result Boolean Whether deletion succeeded.
Note: this field may return null, indicating that no valid values can be obtained.
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 a service

Input Example

https://apigateway.intl.tencentcloudapi.com/?Action=DeleteService
&ServiceId=service-kaghtzi4
&<common request parameters>

Output Example

{
    "Response": {
        "Result": true,
        "RequestId": "8ef5ccb0-4207-468b-bb07-a03e6a772caf"
    }
}

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.ServiceError Service error.
FailedOperation.ServiceInOperation The service is in use. Please try again later.
InternalError.ApigwException API Gateway internal request error. Please try again later. If the problem persists, please contact the smart customer service or submit a ticket.
InternalError.OssException OSS internal request error. Please try again. If the problem persists, please contact the smart customer service or submit a ticket.
InvalidParameter.FormatError Incorrect parameter format.
InvalidParameterValue.InvalidRegion Incorrect region.
ResourceNotFound.InvalidService The corresponding service is invisible.
UnsupportedOperation.ApiListNotEmpty
UnsupportedOperation.ExistingOnlineEnvironment
UnsupportedOperation.InvalidAction API error.
UnsupportedOperation.TagsNotEmpty
UnsupportedOperation.UnpackError
UnsupportedOperation.UnsupportedDeleteService This service is being used and cannot be deleted.
UnsupportedOperation.UsagePlanInUse The current plan is in use. Please unbind it and try again.
Was this page helpful?
You can also Contact Sales or Submit a Ticket for help.
Yes
No

Feedback

Contact Us

Contact our sales team or business advisors to help your business.

Contact Us
Technical Support

Open a ticket if you're looking for further assistance. Our Ticket is 7x24 avaliable.

Submit a Ticket
7x24 Phone Support