DeleteApi

Last updated: 2021-08-17 15:23:13

1. API Description

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

This API is used to delete a created API.

A maximum of 20 requests can be initiated per second for this API.

Note: This API supports Finance regions. If the common parameter Region is a Finance region, a domain name with the Finance region needs to be specified, for example: apigateway.ap-shanghai-fsi.tencentcloudapi.com

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 parameter. The value used for this API: DeleteApi.
Version Yes String Common parameter. The value used for this API: 2018-08-08.
Region Yes String Common parameter. For more information, please see the list of regions supported by the product.
ServiceId Yes String Unique service ID of API.
ApiId Yes String Unique API ID.

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, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 DeleteApi

Input Example

https://apigateway.tencentcloudapi.com/?Action=DeleteApi
&ServiceId=service-ody35h5e
&ApiId=api-e92i2jds
&<Common request parameters>

Output Example

{
  "Response": {
    "Result": true,
    "RequestId": "7787aa0e-be74-43c0-b6f6-7bf56995ce2d"
  }
}

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
AuthFailure Error with CAM signature/authentication.
DryRunOperation DryRun Operation. It means that the request would have succeeded, but the DryRun parameter was used.
FailedOperation Operation failed.
FailedOperation.ApiBindEnvironmen This API has been bound with a usage plan.
FailedOperation.ServiceInOperation The service is in use. Please try again later.
InternalError Internal error.
InvalidParameter Incorrect parameter.
InvalidParameter.FormatError Incorrect parameter format.
InvalidParameterValue.InvalidRegion Incorrect region.
LimitExceeded The quota limit is exceeded.
MissingParameter Missing parameter.
OperationDenied Operation denied.
RequestLimitExceeded The number of requests exceeds the frequency limit.
ResourceInUse The resource is in use.
ResourceInsufficient Insufficient resource.
ResourceNotFound The resource does not exist.
ResourceNotFound.InvalidApi Incorrect ApiId.
ResourceNotFound.InvalidService The corresponding service is invisible.
ResourceUnavailable The resource is unavailable.
ResourcesSoldOut The resources have been sold out.
UnauthorizedOperation The operation is unauthorized.
UnsupportedOperation.InvalidAction API error.
UnsupportedOperation.InvalidServiceTrade The service is currently isolated and therefore the operation is not supported.
UnsupportedOperation.UnsupportedDeleteApi The current API has already been bound to a business API. Please unbind it and try again.